Protected Optional_StaticeventProtected StaticTAG当前登录用户的用户 ID。
添加自定义监听器,接收 Android 或者 iOS 设备发到 React Native 层的数据。
要添加的自定义监听器。
绑定设备的推送 token。
参数。
deviceToken:平台推送服务上报的推送 token。notifierName:平台的推送证书名称。Android 平台必填,iOS 平台忽略该参数。
appId#appKey。该参数不能为空,否则原生 SDK 会返回参数无效错误。如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
绑定 Apple PushKit token,用于 VoIP 推送通知。
注意 该方法仅在 iOS 平台可用,在其他平台调用不会有任何效果。
deviceToken: PKPushRegistry 上报的 PushKit token,为十六进制字符串。
注意 初始化 SDK 时必须通过 ChatOptions.pushKitCertName 设置 PushKit 证书名称,因为证书名称在 App 运行期间不可更改。
注意 native SDK 会在绑定前缓存该 token:如果当前用户尚未登录,本次调用会抛出 ChatError 失败,但 token 仍会被缓存,并在下次登录成功后自动绑定。ChatClient.logout 的 unbindDeviceToken 设为 true 时也会解绑 PushKit token。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
修改 App Key。
App Key 是用户访问 chat 服务时的唯一标识符。
注意
App Key 用于控制对你的 app 的 Chat 服务的访问,只有在未登录状态才能修改 App Key。
修改 App Key 是为了方便你切换到其他 App Key。
你可以在 Console 上获取 App Key。
你也可以用 ChatOptions#appKey 设置 App Key。
新的 App Key,必填。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
压缩日志文件。
注意
强烈建议方法完成之后删除该压缩文件。
压缩后的日志文件路径。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
获取指定账号下登录的在线设备列表。
用户 ID。
用户 token,详见 getAccessToken。
登录的在线设备列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
根据频道名称(channelName)获取与 Agora Chat 用户 ID 匹配的声网 RTC token、token 过期时间和 RTC UID。
调用此 API 之前必须启用声网 RTC 功能。
如果频道名称设置为 null,将生成对所有频道有效的 RTC token。
这是一个异步方法。
声网 RTC 频道名称。
RTC token 信息。详见 ChatRTCTokenInfo。
异常描述。详见 ChatError。
获取与声网 RTC UID 匹配的 Agora Chat 用户 ID。
声网 RTC UID 列表。
声网 RTC UID 和 Agora Chat 用户 ID 的映射关系。
异常描述。详见 ChatError。
初始化 SDK。
注意
SDK 初始化选项,必填,详见 ChatOptions。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
检查 SDK 是否连接到 Chat 服务器。
SDK 是否连接到 Chat 服务器。
- true:是。
- false:否。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
将指定账号登录的所有设备都踢下线。
用户 ID。
用户 token,详见 getAccessToken。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
将特定账号登录的指定设备下线。
关于如何获取设备 ID,详见 ChatDeviceInfo#resource。
用户 ID。
用户 token,详见 getAccessToken。
设备 ID,详见 ChatDeviceInfo#resource。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
通过用户ID和token登录。
请关注token过期回调通知: ChatConnectEventListener.onTokenWillExpire 和 ChatConnectEventListener.onTokenDidExpire.
用户ID.
用户token.
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
退出登录。
登出时是否解绑 token。该参数仅对移动平台有效。
true:是。false:否。如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
移除所有连接状态监听器。
移除所有自定义监听器。
移除所有错误监听器。
移除所有多设备监听器。
移除自定义监听,不再接收 Android 或者 iOS 设备发到 React Native 层的数据。
要移除的自定义监听器。
更新 token。
注意
使用 token 登录时,如果通过 ChatConnectEventListener 回调收到 token 即将过期的通知,可以调用该方法更新 token,避免 token 失效导致异常。
新 token。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
解绑通过 ChatClient.bindPushKitToken 绑定的 Apple PushKit token。
注意 该方法仅在 iOS 平台可用,在其他平台调用不会有任何效果。
ChatClient.logout 的 unbindDeviceToken 设为 true 时已经会解绑 PushKit token,因此只有在需要保持当前用户登录状态的同时解绑 token 时,才调用该方法。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
Protected Static_Protected StaticcheckStaticgetProtected StatichandleOptionalcallback: ChatGroupFileStatusCallbackProtected StatichandleOptionalcallback: ChatMessageStatusCallback
Chat 客户端类。该类是 Chat SDK 的入口,负责登录、登出及管理 SDK 与 chat 服务器之间的连接。