EMClient class Null safety

The EMClient class, which is the entry point of the Chat SDK. With this class, you can log in, log out, and access other functionalities such as group and chatroom.

Properties

chatManager EMChatManager
Gets the EMChatManager class. Make sure to call it after EMClient has been initialized. [...]
read-only
chatRoomManager EMChatRoomManager
Gets the ChatRoomManager class. Make sure to call it after the EMClient has been initialized. [...]
read-only
contactManager EMContactManager
Gets the EMContactManager class. Make sure to call it after the EMClient has been initialized. [...]
read-only
currentUsername String?
Gets the current logged-in username.
read-only
groupManager EMGroupManager
Gets the EMGroupManager class. Make sure to call it after the EMClient has been initialized. [...]
read-only
hashCode int
The hash code for this object. [...]
read-only, inherited
options EMOptions?
Gets the configurations.
read-only
pushManager EMPushManager
Gets the EMPushManager class. Make sure to call it after the EMClient has been initialized. [...]
read-only
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
userInfoManager EMUserInfoManager
Gets the EMUserInfoManager class. Make sure to call it after the EMClient has been initialized. [...]
read-only

Methods

addConnectionListener(EMConnectionListener listener) → void
Adds the connection listener of chat server. [...]
addCustomListener(EMCustomListener listener) → void
Adds a custom listener to receive data from iOS or Android devices. [...]
addMultiDeviceListener(EMMultiDeviceListener listener) → void
Adds the multi-device listener. [...]
changeAppKey({required String newAppKey}) Future<bool>
Updates the App Key, which is the unique identifier to access Agora Chat. [...]
compressLogs() Future<String>
Compresses the debug log into a gzip archive. [...]
createAccount(String username, String password) Future<void>
Register a new user. [...]
getAccessToken() Future<String>
Gets the token of the current logged-in user.
getCurrentUsername() Future<String?>
getLoggedInDevicesFromServer({required String username, required String password}) Future<List<EMDeviceInfo>>
Gets all the information about the logged in devices under the specified account. [...]
init(EMOptions options) Future<void>
Initializes the SDK. [...]
isConnected() Future<bool>
isLoginBefore() Future<bool>
kickAllDevices({required String username, required String password}) Future<void>
Kicks out all the devices logged in under the specified account. [...]
kickDevice({required String username, required String password, required String resource}) Future<bool>
Forces the specified account to log out from the specified device. [...]
login(String username, String pwdOrToken, [bool isPassword = true]) Future<void>
An app user logs in to the chat server with a password or token. [...]
loginWithAgoraToken(String username, String agoraToken) Future<void>
An app user logs in to the chat server by username and Agora token. This method supports automatic login. [...]
logout([bool unbindDeviceToken = true]) Future<void>
An app user logs out. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
removeConnectionListener(EMConnectionListener listener) → void
Removes the chat server connection listener. [...]
removeCustomListener(EMCustomListener listener) → void
Removes the custom listener. [...]
removeMultiDeviceListener(EMMultiDeviceListener listener) → void
Removes the multi-device listener. [...]
renewAgoraToken(String agoraToken) Future<void>
Renews the Agora token. [...]
toString() String
A string representation of this object. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited

Static Properties

getInstance EMClient
read-only