Protected
Optional
_eventProtected
Static
TAGStatic
eventGets the chat manager class.
This method can be called only after the chat client is initialized.
The chat manager class.
获取联系人管理器类。
该方法只能在 Chat 客户端初始化之后调用。
联系人管理器类。
当前登录用户的用户 ID。
获取群组管理器类。
该方法只能在 Chat 客户端初始化之后调用。
群组管理器类。
获取 SDK 配置项。
SDK 选项必填,在初始化时设置。详见 ChatOptions。
SDK 配置信息。
获取在线状态管理器类。
该方法只能在 Chat 客户端初始化之后调用。
在线状态管理器类。
获取推送管理器类。
该方法只能在 Chat 客户端初始化之后调用。
推送管理器类。
获取聊天室管理器类。
该方法只能在 Chat 客户端初始化之后调用。
聊天室管理器类。
获取用户信息管理器类。
该方法只能在 Chat 客户端初始化之后调用。
用户信息管理器类。
设置连接状态监听器。
要添加的连接状态监听器。
添加自定义监听器,接收 Android 或者 iOS 设备发到 React Native 层的数据。
要添加的自定义监听器。
Add error listener.
Monitor SDK internal errors.
添加多设备监听器。
要添加的多设备监听器。
修改 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。
注册新用户(开放注册)。
注意
注册新用户有两种方式:
开放注册:客户端直接注册新用户,不建议在正式环境使用。 如调用失败可联系商务申请使用该接口。
授权注册:可调用 REST API 注册新用户,然后保存到服务器或者发送到客户端使用。
用户 ID。 该参数必填。用户 ID 不能超过 64 个字符,支持以下类型的字符: - 26 个小写英文字母 a-z - 26 个大写英文字母 A-Z - 10 个数字 0-9 - "_", "-", "."
用户 ID 不区分大小写,大写字母会自动转换为小写字母。
用户的电子邮件地址和 UUID 不能作为用户 ID。
可通过以下格式的正则表达式设置用户 ID:^[a-zA-Z0-9_-]+$。
密码,长度不超过 64 个字符。该参数必填。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
获取登录 token。
登录 token。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
当前登录用户的用户 ID。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
获取指定账号下登录的在线设备列表。
用户 ID。
Optional
isPassword: boolean登录的在线设备列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
初始化 SDK。
注意
SDK 初始化选项,必填,详见 ChatOptions。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
检查 SDK 是否连接到 Chat 服务器。
SDK 是否连接到 Chat 服务器。
- true
:是。
- false
:否。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
检查当前用户是否登录。
注意
在初始化之后和登录之前调用该方法。
当前用户是否登录。
- true
:已登录。自动登录时,成功登录前返回 true
,其他情况下返回 false
。
- false
:未登录。非自动登录时,返回 false
。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
将指定账号登录的所有设备都踢下线。
用户 ID。
Optional
isPassword: boolean如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
将特定账号登录的指定设备下线。
关于如何获取设备 ID,详见 ChatDeviceInfo#resource。
用户 ID。
密码或 token。
设备 ID,详见 ChatDeviceInfo#resource。
Optional
isPassword: boolean是否使用密码登录设备:
true
:使用密码;false
:使用用户 token。如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
通过密码或环信 token 登录 Chat 服务器。
注意
如果利用环信 token 登录,可通过以下方式获取 token:
Token 过期提醒通过 ChatConnectEventListener.onTokenWillExpire 和 ChatConnectEventListener.onTokenDidExpire 通知。
用户 ID。详见 createAccount。
密码或环信 token,详见 createAccount 或者 getAccessToken。
是否通过 token 登录。
- true
: 通过 token 登录。
- (默认)false
: 通过密码登录。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
用户 ID,详见 createAccount。
声网 token。
退出登录。
登出时是否解绑 token。该参数仅对移动平台有效。
true
:是。false
:否。如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
移除连接状态监听器。
要移除的连接状态监听器。
移除自定义监听,不再接收 Android 或者 iOS 设备发到 React Native 层的数据。
要移除的自定义监听器。
Remove error listener.
移除指定多设备监听器。
要移除的多设备监听器。
更新声网 token。
注意
当用户利用声网 token 登录的情况下在 ChatConnectEventListener 实现类中收到 token 即将过期事件的回调通知时,可以调用该方法更新 token,避免因 token 失效产生的未知问题。
新的声网 token。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
更新推送设置。
注意 对于 iOS 设备需在初始化 SDK 时录入设备 ID,否则设置不会成功,详见 ChatClient#init。
推送设置,详见 ChatPushConfig。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
Protected
Static
_callProtected
Static
checkStatic
getProtected
Static
handleOptional
callback: ChatGroupFileStatusCallbackProtected
Static
handleOptional
callback: ChatMessageStatusCallback
Chat 客户端类。该类是 Chat SDK 的入口,负责登录、登出及管理 SDK 与 chat 服务器之间的连接。