ClientDefault class
Constructors
Properties
- chatManager → ChatManager
-
no setterinherited
- chatRoomManager → ChatRoomManager
-
no setterinherited
- chatThreadManager → ChatThreadManager
-
no setterinherited
- contactManager → ContactManager
-
no setterinherited
- currentUserId → String?
-
no setterinherited
- customEventHandler ↔ void Function(Map map)?
-
getter/setter pairinherited
- groupManager → GroupManager
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- options → EMOptions?
-
no setterinherited
- presenceManager → PresenceManager
-
no setterinherited
- pushManager → PushManager
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- userInfoManager → UserInfoManager
-
no setterinherited
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.
inherited
-
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.
inherited
-
changeAppId(
{required String newAppId}) → Future< bool> -
~english
Updates the App Id, which is the unique identifier to access Agora Chat.
inherited
-
changeAppKey(
{required String newAppKey}) → Future< bool> -
~english
Updates the App Key, which is the unique identifier to access Agora Chat.
inherited
-
clearConnectionEventHandlers(
) → void -
~english
Clears all connection event handlers.
~end
inherited
-
clearMultiDeviceEventHandlers(
) → void -
~english
Clears all multi-device event handlers.
~end
inherited
-
compressLogs(
) → Future< String> -
~english
Compresses the debug log into a gzip archive.
inherited
-
createAccount(
String userId, String password) → Future< void> -
~english
Registers a new user.
inherited
-
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.
inherited
-
getAccessToken(
) → Future< String> -
~english
Gets the token of the current logged-in user.
~end
inherited
-
getConnectionEventHandler(
String identifier) → EMConnectionEventHandler? -
~english
Gets the connection event handler.
inherited
-
getCurrentUserId(
) → Future< String?> -
~english
Gets the current login user ID.
inherited
-
getLoggedInDevicesFromServer(
{required String userId, required String password}) → Future< List< EMDeviceInfo> > -
~english
Gets the list of currently logged-in devices of a specified account.
inherited
-
getMultiDeviceEventHandler(
String identifier) → EMMultiDeviceEventHandler? -
~english
Gets the multi-device event handler.
inherited
-
init(
EMOptions options) → Future< void> -
~english
Initializes the SDK.
inherited
-
initHandler(
) → void -
override
-
isConnected(
) → Future< bool> -
~english
Checks whether the SDK is connected to the chat server.
inherited
-
isLoginBefore(
) → Future< bool> -
~english
Checks whether the user has logged in before and did not log out.
inherited
-
kickAllDevices(
{required String userId, required String pwdOrToken, bool isPwd = true}) → Future< void> -
~english
Forces the specified account to log out from all devices.
inherited
-
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.
inherited
-
login(
String userId, String pwdOrToken, [bool isPassword = true]) → Future< void> -
~english
Logs in to the chat server with a password or token.
inherited
-
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.
inherited
-
loginWithPassword(
String userId, String password) → Future< void> -
~english
Logs in to the chat server with a password.
inherited
-
loginWithToken(
String userId, String token) → Future< void> -
~english
Logs in to the chat server with a token.
inherited
-
logout(
[bool unbindDeviceToken = true]) → Future< void> -
~english
Logs out.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeConnectionEventHandler(
String identifier) → void -
~english
Removes the connection event handler.
inherited
-
removeMultiDeviceEventHandler(
String identifier) → void -
~english
Removes the multi-device event handler.
inherited
-
renewAgoraToken(
String agoraToken) → Future< void> -
~english
Renews the Agora token.
inherited
-
startCallback(
) → Future< void> -
~english
Starts contact and group, chatroom callback.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateAutoAcceptFriendInvitationSetting(
bool acceptInvitationAlways) → Future< void> -
inherited
-
updateAutoAcceptGroupInvitationSetting(
bool autoAcceptGroupInvitation) → Future< void> -
inherited
-
updateAutoDownloadAttachmentThumbnailSetting(
bool autoDownloadThumbnail) → Future< void> -
inherited
-
updateDeleteMessagesWhenLeaveGroupSetting(
bool deleteMessagesWhenLeaveGroup) → Future< void> -
inherited
-
updateDeleteMessageWhenLeaveRoomSetting(
bool deleteMessageWhenLeaveRoom) → Future< void> -
inherited
-
updateDeliveryAckSetting(
bool requireDeliveryAck) → Future< void> -
inherited
-
updateLoginExtensionInfoSetting(
String extension) → Future< void> -
~english
inherited
-
updateMessagesReceiveCallbackIncludeSendSetting(
bool includeSend) → Future< void> -
inherited
-
updateRegradeMessagesAsReadSetting(
bool isRead) → Future< void> -
inherited
-
updateRequireAckSetting(
bool requireAck) → Future< void> -
inherited
-
updateRoomOwnerCanLeaveSetting(
bool roomOwnerCanLeave) → Future< void> -
inherited
-
updateSortMessageByServerTimeSetting(
bool sortMessageByServerTime) → Future< void> -
inherited
-
updateUsingHttpsOnlySetting(
bool usingHttpsOnly) → Future< void> -
~english
Whether only HTTPS is used for REST operations.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited