RongIMLib View Markdown
    Preparing search index...

    Interface IInitOption

    初始化配置项

    interface IInitOption {
        appkey: string;
        logLevel?: LogLevel;
        logOutputLevel?: EnableLogL;
        logStdout?: (logLevel: LogLevel, content: string) => void;
        navigators?: string[];
        connectType?: "websocket" | "comet";
        customCMP?: string[];
        indexDBSwitch?: boolean;
        checkCA?: boolean;
        uploadDomain?: string;
        httpInMainProcess?: boolean;
        logExpireTime?: number;
        areaCode?: AreaCode;
        logServerUrl?: string;
        environment?: string;
        eventLoopBlockingCheck?: boolean;
        enableReadReceiptStorage?: boolean;
        useNaviV2?: boolean;
        conversationCachePolicy?: IConversationCachePolicy;
    }
    Index
    appkey: string

    应用 appkey 标识

    logLevel?: LogLevel

    该配置已废弃,请使用 logOutputLevel 替代。

    修改 SDK 内部日志打印等级,默认为 LogLevel.WARN。

    logOutputLevel?: EnableLogL

    修改内部日志打印等级,默认输出 LogL.WARN 及以上级别

    logStdout?: (logLevel: LogLevel, content: string) => void

    配置已废弃

    navigators?: string[]

    自定义导航地址,公有云用户不推荐修改

    connectType?: "websocket" | "comet"

    连接方式,默认使用 'websocket'

    自 5.6.0 版本开始,不再支持 Comet 连接,该配置项失效。

    customCMP?: string[]

    小程序平台专属配置

    indexDBSwitch?: boolean

    是否打开 IndexDB 存储,默认为 true

    checkCA?: boolean

    已废弃,默认不再在 Electron 平台下校验导航服务的 CA 问题

    uploadDomain?: string

    七牛上传文件地址域名(仅私有云 RCX 服务支持),优先级高于 ossConfig 配置

    httpInMainProcess?: boolean

    开启后,SDK 内的 HTTP 请求将由 Electron 主进程内发送。

    5.6.0

    仅在 Electron 环境中搭配 @rongcloud/electron-renderer 与 @rongcloud/electron 包时有效。

    • 当值为 true 时,HTTP 请求由 Electron 主进程内发送,不受浏览器安全沙箱策略限制。
    • 当值为 false 时,保持使用 Chromium 的 XMLHttpRequest 发送 HTTP 协议请求, 请求由渲染进程内发出,受浏览器安全沙箱策略限制。

    false

    logExpireTime?: number

    IndexDB 数据库内的日志有效期,单位为小时,有效值为 24 - 168,默认 IndexDB 内日志数据有效期 168 小时

    areaCode?: AreaCode

    区域码

    5.7.9

    logServerUrl?: string

    日志上报服务地址

    5.7.7

    environment?: string

    私有云环境配置

    eventLoopBlockingCheck?: boolean

    启动事件循环阻塞检查;当值为 true 时,SDK 会启动事件循环阻塞检查,并在发现事件循环阻塞时记录日志。

    5.20.0

    enableReadReceiptStorage?: boolean

    开启已读回执信息本地存储

    需注意:Electron 平台离线量消息量大的情况下,登录连接后拉取大量离线,可能产生性能瓶颈

    • 公有云 SDK 默认开启,以保持向前兼容
    • 私有云 SDK 默认关闭

    5.22.0

    useNaviV2?: boolean

    启动导航服务 V2,默认关闭,仅私有云有效

    5.22.0

    conversationCachePolicy?: IConversationCachePolicy

    自定义会话列表缓存策略,该参数对 Electron 平台无效

    5.38.0