Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInitOption

初始化配置项

Hierarchy

  • IInitOption

Index

Properties

Methods

Properties

appkey

appkey: string

应用 appkey 标识

Optional logLevel

logLevel?: LogLevel

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

deprecated

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

Optional logOutputLevel

logOutputLevel?: EnableLogL

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

Optional navigators

navigators?: string[]

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

Optional connectType

connectType?: "websocket" | "comet"

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

deprecated

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

Optional customCMP

customCMP?: string[]

小程序平台专属配置

Optional indexDBSwitch

indexDBSwitch?: boolean
deprecated

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

Optional checkCA

checkCA?: boolean
deprecated

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

Optional uploadDomain

uploadDomain?: string

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

Optional httpInMainProcess

httpInMainProcess?: boolean

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

since

5.6.0

description

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

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

false

Optional logExpireTime

logExpireTime?: number

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

Optional areaCode

areaCode?: AreaCode

区域码

since

5.7.9

Optional logServerUrl

logServerUrl?: string

日志上报服务地址

since

5.7.7

Optional environment

environment?: string

私有云环境配置

Optional eventLoopBlockingCheck

eventLoopBlockingCheck?: boolean

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

since

5.20.0

Optional enableReadReceiptStorage

enableReadReceiptStorage?: boolean

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

description

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

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

5.22.0

Optional useNaviV2

useNaviV2?: boolean

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

since

5.22.0

Optional conversationCachePolicy

conversationCachePolicy?: IConversationCachePolicy

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

since

5.38.0

Methods

Optional logStdout

  • logStdout(logLevel: LogLevel, content: string): void
  • deprecated

    配置已废弃

    Parameters

    Returns void