ITUIChatEngine

ITUIChatEngine

Properties:
Name Type Description
EVENT Object

Chat SDK 定义的事件列表

TYPES Object

Chat SDK 定义的类型常量

Methods

login(options) → {Promise.<any>}

创建 Chat SDK 实例 & 登录 Chat SDK

Example
let promise = TUIChatEngine.login({
 SDKAppID: xxx,
 userID: 'xxx',
 userSig: 'xxx',
 useUploadPlugin: true, // 使用文件上传插件
});
promise.then(() => {
 // 登录成功后进行相关业务逻辑处理
})
Parameters:
Name Type Description
options LoginParams

登录参数
Returns:
Type
Promise.<any>

logout() → {Promise.<any>}

登出 Chat SDK

Example
let promise = TUIChatEngine.logout();
promise.then(() => {
 // 登出成功后进行相关业务逻辑处理
})
Returns:
Type
Promise.<any>

isReady() → {boolean}

Chat SDK 是否 ready。SDK ready 后，开发者可调用 SDK 发送消息等 API，使用 SDK 的各项功能。

Example
let isReady = TUIChatEngine.isReady();
Returns:
Type
boolean

destroy() → {Promise.<any>}

销毁 Chat SDK 实例，SDK 会先 logout，然后断开 WebSocket 长连接，并释放资源。

Example
let promise = TUIChatEngine.destroy();
Returns:
Type
Promise.<any>

setLogLevel(level) → {void}

设置 SDK 日志级别

Example
TUIChatEngine.setLogLevel(0)
Parameters:
Name Type Description
level number

日志级别

  • 0 普通级别，日志量较多，接入时建议使用
  • 1 release级别，SDK 输出关键信息，生产环境时建议使用
  • 2 告警级别，SDK 只输出告警和错误级别的日志
  • 3 错误级别，SDK 只输出错误级别的日志
  • 4 无日志级别，SDK 将不打印任何日志
Returns:
Type
void