ChatClient class

该类是 Chat SDK 的入口,负责登录、退出及连接管理等,由此可以获得其他模块的入口。

Properties

chatManager → ChatManager
no setter
chatRoomManager → ChatRoomManager
no setter
chatThreadManager → ChatThreadManager
no setter
contactManager → ChatContactManager
no setter
currentUserId → String?
no setter
customEventHandler ↔ void Function(Map map)?
getter/setter pair
groupManager → ChatGroupManager
no setter
hashCode → int
The hash code for this object.
no setterinherited
options → ChatOptions?
no setter
presenceManager → ChatPresenceManager
no setter
pushManager → ChatPushManager
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
userInfoManager → ChatUserInfoManager
no setter

Methods

addConnectionEventHandler(String identifier, ConnectionEventHandler handler) → void
添加连接状态监听事件。
addMultiDeviceEventHandler(String identifier, ChatMultiDeviceEventHandler handler) → void
添加多设备事件监听。
changeAppId({required String newAppId}) → Future<bool>
修改 App Id
changeAppKey({required String newAppKey}) → Future<bool>
修改 App Key。
clearConnectionEventHandlers() → void
清除所以连接状态监听。
clearMultiDeviceEventHandlers() → void
清除所有多设备事件监听。
compressLogs() → Future<String>
压缩 log 文件,并返回压缩后的文件路径。强烈建议方法完成之后删除该压缩文件。
fetchLoggedInDevices({required String userId, required String token}) → Future<List<ChatDeviceInfo>>
使用 Token 获取指定账号当前登录的设备列表。
getAccessToken() → Future<String>
获取当前登录账号的 Token。
getConnectionEventHandler(String identifier) → ConnectionEventHandler?
获取连接状态监听事件。
getCurrentDeviceId() → Future<String>
获取当前设备 ID。
getCurrentUserId() → Future<String?>
获取当前登录的用户 ID。
getMultiDeviceEventHandler(String identifier) → ChatMultiDeviceEventHandler?
获取多设备事件监听。
init(ChatOptions options) → Future<void>
初始化 SDK。
isConnected() → Future<bool>
检查 SDK 是否连接到 Chat 服务器。 Return SDK 是否连接到 Chat 服务器。
kickAllDevices({required String userId, required String token}) → Future<void>
使用 Token 将指定账号的全部设备踢下线。
kickDevice({required String userId, required String token, required String resource}) → Future<void>
使用 Token 将指定账号的一个设备踢下线。
loginWithToken(String userId, String token) → Future<void>
使用用户 ID 和 Token 登录聊天服务器。
logout([bool unbindDeviceToken = true]) → Future<void>
退出登录。
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeConnectionEventHandler(String identifier) → void
移除连接状态监听事件。
removeMultiDeviceEventHandler(String identifier) → void
移除多设备事件监听。
renewToken(String token) → Future<void>
更新当前登录会话的 Token。
startCallback() → Future<void>
开始回调通知。
toString() → String
A string representation of this object.
inherited
updateAutoAcceptFriendInvitationSetting(bool acceptInvitationAlways) → Future<void>
updateAutoAcceptGroupInvitationSetting(bool autoAcceptGroupInvitation) → Future<void>
updateAutoDownloadAttachmentThumbnailSetting(bool autoDownloadThumbnail) → Future<void>
updateDeleteMessagesWhenLeaveGroupSetting(bool deleteMessagesWhenLeaveGroup) → Future<void>
updateDeleteMessageWhenLeaveRoomSetting(bool deleteMessageWhenLeaveRoom) → Future<void>
updateDeliveryAckSetting(bool requireDeliveryAck) → Future<void>
updateLoginExtensionInfoSetting(String extension) → Future<void>
更新登录扩展信息。
updateMessagesReceiveCallbackIncludeSendSetting(bool includeSend) → Future<void>
updateRegradeMessagesAsReadSetting(bool isRead) → Future<void>
updateRoomOwnerCanLeaveSetting(bool roomOwnerCanLeave) → Future<void>
updateSortMessageByServerTimeSetting(bool sortMessageByServerTime) → Future<void>
updateUsingHttpsOnlySetting(bool usingHttpsOnly) → Future<void>

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

getInstance → ChatClient
no setter