node-nim/types/nim_def/global_def.d.ts

NetEase IM nodejs wrapper based on NetEase IM C++ SDK

import { NIMResCode } from './client_def';
/** @enum NIMSDKException 异常 */
export declare enum NIMSDKException {
    /** < 当前数据目录所在盘符空间紧张或用完, log: {"free_space" : %lf, "message":""}, free_space单位M*/
    kNIMSDKExceptionSpaceEmpty = 1
}
/** @enum NIMProxyDetectStep 代理测试步骤 */
export declare enum NIMProxyDetectStep {
    /** < 探测代理有效性结束*/
    kNIMProxyDetectStepAllComplete = 5
}
/** @enum NIMProxyType 代理类型 */
export declare enum NIMProxyType {
    /** < 不使用代理*/
    kNIMProxyNone = 0,
    /** < HTTP 1.1 Proxy（暂不支持）*/
    kNIMProxyHttp11 = 1,
    /** < Socks4 Proxy*/
    kNIMProxySocks4 = 4,
    /** < Socks4a Proxy*/
    kNIMProxySocks4a = 5,
    /** < Socks5 Proxy*/
    kNIMProxySocks5 = 6,
    /** < 云信音视频私有代理，只在nim_vchat_set_proxy中有效 */
    kNIMProxyNrtc = 10
}
/** @enum NIMCachedFileType 查询/删除SDK文件缓存信息文件类型 */
export declare enum NIMCachedFileType {
    /** < 杂项文件缓存 */
    RES = "res",
    /** < 图片消息缓存 */
    IMAGE = "image",
    /** < 语音消息缓存 */
    AUDIO = "audio",
    /** < 视频消息缓存 */
    VIDEO = "video"
}
/** @enum NIMDBOperation 对DB进行的操作类型 */
export declare enum NIMDBOperation {
    /** < 写操作*/
    kNIMDBOperationInsert = 1,
    /** < 读操作*/
    kNIMDBOperationRead = 2,
    /** < 更新操作*/
    kNIMDBOperationUpdate = 4,
    /** < 删除操作*/
    kNIMDBOperationDelete = 8
}
export interface CachedFileInfo {
    file_type_?: string;
    file_path_?: string;
    file_count_?: number;
    file_total_size_?: number;
}
export interface SDKDBErrorInfo {
    db_name_?: string;
    error_code_?: number;
    operation_?: NIMDBOperation;
    description_?: string;
    attach_?: string;
}
export type ExceptionCallback = (exception: NIMSDKException, log: string) => void;
export type SDKFeedbackCallback = (rescode: NIMResCode) => void;
export type DetectProxyCallback = (connect: boolean, step: NIMProxyDetectStep, jsonExtension: string) => void;
export type GetCachedFileInfoCallback = (rescode: NIMResCode, result: CachedFileInfo) => void;
export type DeleteCachedFileCallback = (rescode: NIMResCode) => void;
export type SDKDBErrorCallback = (result: SDKDBErrorInfo) => void;
export type UploadSDKLogCallback = (rescode: NIMResCode) => void;
export interface NIMGlobalAPI {
    InitEventHandlers(): void;
    SetExceptionReportCallback(jsonExtension: string, cb: ExceptionCallback | null): void;
    SetProxy(type: NIMProxyType, host: string, port: number, user: string, password: string): void;
    DetectProxy(type: NIMProxyType, host: string, port: number, user: string, password: string, cb: DetectProxyCallback | null): void;
    GetSDKCachedFileInfoAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: GetCachedFileInfoCallback | null): void;
    DeleteSDKCachedFileAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: DeleteCachedFileCallback | null): void;
    SDKFeedbackAsync(url: string, jsonExtension: string, cb: SDKFeedbackCallback | null): void;
    UploadSDKLog(feedbackStr: string, cb: UploadSDKLogCallback | null): void;
}