Optionalon成功连接到 chat 服务器时触发的回调。
Optionalon本地数据库打开时触发。
数据库的打开过程独立于登录流程。依赖本地数据库的 SDK 方法只能在该回调触发后调用。
已打开数据库所绑定的用户 ID。
数据库打开结果的错误码。0 表示成功。
OptionalonSDK 完成从服务器同步指定类型的数据时触发。
已同步的数据类型,是 ChatDataSyncType 的位掩码。
同步结果的错误码。0 表示成功。
OptionalonSDK 开始从服务器同步指定类型的数据时触发。
要同步的数据类型,是 ChatDataSyncType 的位掩码。
OptionalonSDK 与 chat 服务器断开连接时触发。
errorCode 由原生 SDK 原样传递,分为两类(详见 ChatDisconnectErrorCode):
USER_LOGIN_FROM_OTHER_DEVICE):本地登录状态不再有效,应返回登录页面并重新登录。NETWORK_ERROR、SERVER_NOT_REACHABLE):用户仍保持登录状态,但连接已断开,SDK 会自动重连;收到这些错误码时不要返回登录页面。未在 ChatDisconnectErrorCode 中列出的错误码(包括未来原生 SDK 版本新增的错误码)也会原样传递; 除非原生 SDK 文档另有说明,否则应将其视为连接原因。
如果没有 errorCode,表示平台未提供断开原因(例如 iOS 上的网络断开);也应将其视为连接事件。
注意:token 过期导致的登出不会触发该回调,详见 ChatConnectEventListener.onTokenDidExpire。 需要同时处理这两个回调,才能覆盖所有登出场景。
OptionalerrorCode: number
断开连接的原因,详见 ChatDisconnectErrorCode。
Optionalinfo: { deviceName?: string; ext?: string }
仅当 errorCode 为 ChatDisconnectErrorCode.USER_LOGIN_FROM_OTHER_DEVICE 时存在:deviceName 为发起登录的设备名称,ext 为该设备的扩展信息。详见 ChatOptions.loginExtraInfo。
Optionalon结束接收离线消息的时候触发。
Optionalon开始接收离线消息的时候触发。
OptionalonAgora token 已过期时触发。
OptionalonAgora token 即将过期时触发。
连接事件监听器。
在不稳定的网络环境中断开连接时,使用该 SDK 的应用会收到
onDisconnected回调。无需手动重连,Chat SDK 会自动处理重连。
包含以下两个连接相关回调:
onConnected:连接建立时触发。onDisconnected:连接断开时触发,并携带表示断开原因的错误码,详见 ChatDisconnectErrorCode。添加连接事件监听器:
移除连接事件监听器: