EMClient class
~english 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. ~end
~chinese 该类是 Chat SDK 的入口，负责登录、退出及连接管理等，由此可以获得其他模块的入口。 ~end
Properties
- chatManager → EMChatManager
-
final
- chatRoomManager → EMChatRoomManager
-
final
- chatThreadManager → EMChatThreadManager
-
final
- contactManager → EMContactManager
-
final
- currentUserId → String?
-
no setter
- groupManager → EMGroupManager
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- options → EMOptions?
-
no setter
- presenceManager → EMPresenceManager
-
final
- pushManager → EMPushManager
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- userInfoManager → EMUserInfoManager
-
final
Methods
-
addConnectionEventHandler(
String identifier, EMConnectionEventHandler handler) → void - ~english Adds the connection event handler. After calling this method, you can handle new connection events when they arrive.
-
addMultiDeviceEventHandler(
String identifier, EMMultiDeviceEventHandler handler) → void - ~english Adds the multi-device event handler. After calling this method, you can handle for new multi-device events when they arrive.
-
changeAppId(
{required String newAppId}) → Future< bool> - ~english Updates the App Id, which is the unique identifier to access Agora Chat.
-
changeAppKey(
{required String newAppKey}) → Future< bool> - ~english Updates the App Key, which is the unique identifier to access Agora Chat.
-
clearConnectionEventHandlers(
) → void - ~english Clears all connection event handlers. ~end
-
clearMultiDeviceEventHandlers(
) → 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< EMDeviceInfo> > - ~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) → EMConnectionEventHandler? - ~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< EMDeviceInfo> > - ~english Gets the list of currently logged-in devices of a specified account.
-
getMultiDeviceEventHandler(
String identifier) → EMMultiDeviceEventHandler? - ~english Gets the multi-device event handler.
-
init(
EMOptions 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 → EMClient
-
no setter