Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInitOption

初始化参数配置

Hierarchy

  • IInitOption

Index

Properties

Methods

Properties

Optional navi

navi?: string

私有云部署导航地址，公有云可传空

Optional api

api?: string

私有云部署 API 地址，公有云可传空

Optional connectionType

connectionType?: "websocket" | "comet"

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

deprecated

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

Optional logLevel

logLevel?: LogLevel

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

deprecated

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

Optional logOutputLevel

logOutputLevel?: EnableLogL

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

Optional debug

debug?: boolean

调试模式，开启后 SDK 自动向控制台输出日志

deprecated

Optional detect

detect?: { url: string; intervalTime: number }

网络嗅探配置，SDK 自动重连时通过此配置进行网络探测

deprecated

Type declaration

  • url: string

    网络嗅探地址。默认嗅探地址仅为测试 http 请求是否可以正常发送，并非真实地址，返回 404 属于正常情况

    default

    https://cdn.ronghub.com/im_detecting

  • intervalTime: number

    网络嗅探间隔时间，单位：毫秒

    default

    1500

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 protobuf

protobuf?: string
deprecated

该参数已废弃

Optional dbPath

dbPath?: string
deprecated

Optional typingExpireTime

typingExpireTime?: number

typing 过期时间

Optional indexDBSwitch

indexDBSwitch?: boolean
deprecate

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

Optional checkCA

checkCA?: boolean
deprecated

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

Optional readReceiptTimeout

readReceiptTimeout?: number

群聊天回执超时时间, 最大值15天，最小1天，单位：天

default

1

Optional logExpireTime

logExpireTime?: number

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

Methods

Optional logStdout

  • logStdout(logLevel: LogLevel, content: string): void
  • deprecated
    • 配置已废弃

    Parameters

    Returns void