ChatClient class - agora_chat_sdk library

Properties

chatManager → ChatManager: ~english Gets the ChatManager class. Make sure to call it after ChatClient has been initialized.
no setter
chatRoomManager → ChatRoomManager: ~english Gets the ChatRoomManager class. Make sure to call it after the ChatClient has been initialized.
no setter
chatThreadManager → ChatThreadManager: ~english Gets the ChatThreadManager class. Make sure to call it after the ChatClient has been initialized.
no setter
contactManager → ChatContactManager: ~english Gets the ChatContactManager class. Make sure to call it after the ChatClient has been initialized.
no setter
currentUserId → String?: ~english Gets the current logged-in user ID. ~end
no setter
customEventHandler ↔ (void Function(Map map)?): ~english Sets a custom event handler to receive data from iOS or Android devices.
getter/setter pair
groupManager → ChatGroupManager: ~english Gets the ChatGroupManager class. Make sure to call it after the ChatClient has been initialized.
no setter
hashCode → int: The hash code for this object.
no setterinherited
options → ChatOptions?: ~english Gets the configurations. ~end
no setter
presenceManager → ChatPresenceManager: ~english Gets the ChatPresenceManager class. Make sure to call it after the ChatClient has been initialized.
no setter
pushManager → ChatPushManager: ~english Gets the ChatPushManager class. Make sure to call it after the ChatClient has been initialized.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
userInfoManager → ChatUserInfoManager: ~english Gets the ChatUserInfoManager class. Make sure to call it after the ChatClient has been initialized.
no setter

Methods

addConnectionEventHandler(String identifier, ConnectionEventHandler handler) → void: ~english Adds the connection event handler. After calling this method, you can handle new connection events when they arrive.
addMultiDeviceEventHandler(String identifier, ChatMultiDeviceEventHandler handler) → void: ~english Adds the multi-device event handler. After calling this method, you can handle for new multi-device events when they arrive.
changeAppKey({required String newAppKey}) → Future<bool>: ~english Updates the App Key, which is the unique identifier to access Agora Chat.
clearConnectionEventHandles() → void: ~english Clears all connection event handlers. ~end
clearMultiDeviceEventHandles() → void: ~english Clears all multi-device event handlers. ~end
compressLogs() → Future<String>: ~english Compresses the debug log into a gzip archive.
createAccount(String userId, String password) → Future<void>: ~english Registers a new user.
fetchLoggedInDevices({required String userId, required String pwdOrToken, bool isPwd = true}) → Future<List<ChatDeviceInfo>>: ~english Gets the list of currently logged-in devices of a specified account.
getAccessToken() → Future<String>: ~english Gets the token of the current logged-in user. ~end
getConnectionEventHandler(String identifier) → ConnectionEventHandler?: ~english Gets the connection event handler.
getCurrentUserId() → Future<String?>: ~english Gets the current login user ID.
getLoggedInDevicesFromServer({required String userId, required String password}) → Future<List<ChatDeviceInfo>>: ~english Gets the list of currently logged-in devices of a specified account.
getMultiDeviceEventHandler(String identifier) → ChatMultiDeviceEventHandler?: ~english Gets the multi-device event handler.
init(ChatOptions options) → Future<void>: ~english Initializes the SDK.
isConnected() → Future<bool>: ~english Checks whether the SDK is connected to the chat server.
isLoginBefore() → Future<bool>: ~english Checks whether the user has logged in before and did not log out.
kickAllDevices({required String userId, required String pwdOrToken, bool isPwd = true}) → Future<void>: ~english Forces the specified account to log out from all devices.
kickDevice({required String userId, required String pwdOrToken, required String resource, bool isPwd = true}) → Future<void>: ~english Forces the specified account to log out from the specified device.
login(String userId, String pwdOrToken, [bool isPassword = true]) → Future<void>: ~english Logs in to the chat server with a password or token.
loginWithAgoraToken(String userId, String agoraToken) → Future<void>: ~english Logs in to the chat server by user ID and Agora token. This method supports automatic login.
loginWithPassword(String userId, String password) → Future<void>: ~english Logs in to the chat server with a password.
loginWithToken(String userId, String token) → Future<void>: ~english Logs in to the chat server with a token.
logout([bool unbindDeviceToken = true]) → Future<void>: ~english Logs out.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
removeConnectionEventHandler(String identifier) → void: ~english Removes the connection event handler.
removeMultiDeviceEventHandler(String identifier) → void: ~english Removes the multi-device event handler.
renewAgoraToken(String agoraToken) → Future<void>: ~english Renews the Agora token.
startCallback() → Future<void>: ~english Starts contact and group, chatroom callback.
toString() → String: A string representation of this object.
inherited

Operators

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

Static Properties

getInstance → ChatClient: ~english Gets the SDK instance. ~end
no setter