Class ChatClient

StaticeventType

chatManager

• get chatManager(): ChatManager

• Gets the chat manager class.

  This method can be called only after the chat client is initialized.

  Returns ChatManager

  The chat manager class.

contactManager

• get contactManager(): ChatContactManager

• Gets the contact manager class.

  This method can be called only after the chat client is initialized.

  Returns ChatContactManager

  The contact manager class.

currentUserName

• get currentUserName(): string

• Gets the current logged-in user ID.

  Note

  The user ID for successful login is valid.

  The user ID is obtained from the memory and updated in the case of login, logout, and reconnection upon disconnection. You can call getCurrentUsername to get the latest data from the server.

  Returns string

  The current logged-in user ID.

groupManager

• get groupManager(): ChatGroupManager

• Gets the chat group manager class.

  This method can be called only after the chat client is initialized.

  Returns ChatGroupManager

  The chat group manager class.

options

• get options(): undefined | ChatOptions

• Gets the SDK configurations.

  Ensure that you set the SDK options during initialization. See ChatOptions.

  Returns undefined | ChatOptions

  The SDK configurations.

presenceManager

• get presenceManager(): ChatPresenceManager

• Gets the presence manager class.

  This method can be called only after the chat client is initialized.

  Returns ChatPresenceManager

  The presence manager class.

pushManager

• get pushManager(): ChatPushManager

• Gets the push manager class.

  This method can be called only after the chat client is initialized.

  Returns ChatPushManager

  The push manager class.

roomManager

• get roomManager(): ChatRoomManager

• Gets the chat room manager class.

  This method can be called only after the chat client is initialized.

  Returns ChatRoomManager

  The chat room manager class.

userManager

• get userManager(): ChatUserInfoManager

• Gets the user information manager class.

  This method can be called only after the chat client is initialized.

  Returns ChatUserInfoManager

  The user information manager class.

version

• get version(): string

• Returns string

addConnectionListener

• addConnectionListener(listener): void

• Adds the connection status listener.

  Parameters

  • listener: ChatConnectEventListener

    The connection status listener to add.

  Returns void

addCustomListener

• addCustomListener(listener): void

• Adds a custom listener to receive data that the iOS or Android devices send to the React Native layer.

  Parameters

  • listener: ChatCustomEventListener

    The custom listener to add.

  Returns void

addExceptListener

• addExceptListener(listener): void

• Add error listener.

  Monitor SDK internal errors.

  Parameters

  • listener: ChatExceptionEventListener

  Returns void

addMultiDeviceListener

• addMultiDeviceListener(listener): void

• Adds the multi-device listener.

  Parameters

  • listener: ChatMultiDeviceEventListener

    The multi-device listener to add.

  Returns void

changeAppKey

• changeAppKey(newAppKey): Promise<void>

• Updates the App Key, which is the unique identifier used to access the chat service.

  Note

  • As this key controls access to the chat service for your app, you can only update the key when the current user is logged out.

  • Updating the App Key means to switch to a new App Key.

  • You can retrieve the new App Key from the Console.

  • You can also set an App Key by using the ChatOptions.appKey method when logged out.

  Parameters

  • newAppKey: string

    The new App Key. Ensure that you set this parameter.

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

compressLogs

• compressLogs(): Promise<undefined | string>

• Compresses the debug log file into a gzip archive.

  We strongly recommend that you delete this debug archive once it is no longer used.

  Returns Promise<undefined | string>

  The path of the compressed gzip file.

  Throws

  A description of the exception. See ChatError.

createAccount

• createAccount(userId, password): Promise<void>

• Creates a new user (open registration).

  Note

  There are two registration modes:

  • Open registration: This mode is for testing use, but not recommended in a formal environment; If a call failure occurs, you can contact our business manager.

  • Authorized registration: You can create a new user through a REST API, and then save it to your server or return it to the client.

  Parameters

  • userId: string

    The user ID. Ensure that you set this parameter. The user ID can be a maximum of 64 characters of the following types: - 26 English letters (a-z) - 10 numbers (0-9), - "", "-", "." The user ID is case-insensitive, so Aa and aa are the same user ID. The email address or the UUID of the user cannot be used as the user ID. You can also set this parameter with the regular expression ^[a-zA-Z0-9-]+$.
  • password: string

    The password. Ensure that you set this parameter. The password can contain a maximum of 64 characters.

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

getAccessToken

• getAccessToken(): Promise<string>

• Gets the token for login.

  Returns Promise<string>

  The token for login.

  Throws

  A description of the exception. See ChatError.

getCurrentUsername

• getCurrentUsername(): Promise<string>

• Gets the current logged-in user ID from the server.

  Note

  To get the current logged-in user ID from the memory, see currentUserName.

  Returns Promise<string>

  The logged-in user ID.

  Throws

  A description of the exception. See ChatError.

getEventEmitter

• getEventEmitter(): NativeEventEmitter

• Returns NativeEventEmitter

getLoggedInDevicesFromServer

• getLoggedInDevicesFromServer(userId, pwdOrToken, isPassword?): Promise<ChatDeviceInfo[]>

• Gets the list of online devices to which you have logged in with a specified account.

  Parameters

  • userId: string

    The user ID.
  • pwdOrToken: string

    The password or token.
  • OptionalisPassword: boolean

    If true, use password, otherwise use token. Default is true. See pwdOrToken

  Returns Promise<ChatDeviceInfo[]>

  The list of the online logged-in devices.

  Throws

  A description of the exception. See ChatError.

init

• init(options): Promise<void>

• Initializes the SDK.

  Note

  • Make sure to initialize the SDK in the main thread.
  • This method must be called before any other methods are called.

  Parameters

  • options: ChatOptions

    The options for SDK initialization. Ensure that you set the options. See ChatOptions.

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

isConnected

• isConnected(): Promise<boolean>

• Checks whether the SDK is connected to the chat server.

  Returns Promise<boolean>

  Whether the SDK is connected to the chat server. - true: Yes. - false: No.

  Throws

  A description of the exception. See ChatError.

isLoginBefore

• isLoginBefore(): Promise<boolean>

• Checks whether the current user is logged in to the app.

  Note

  This method needs to be called after initialization and before login.

  Returns Promise<boolean>

  Whether the user is logged in to the app: - true: The user is logged in to the app. In automatic login mode, the SDK returns true before successful login and false otherwise. - false: The user is not logged in to the app. In non-automatic login mode, the SDK returns false.

  Throws

  A description of the exception. See ChatError.

kickAllDevices

• kickAllDevices(userId, pwdOrToken, isPassword?): Promise<void>

• Logs out from a specified account on all devices.

  Parameters

  • userId: string

    The user ID.
  • pwdOrToken: string

    The password or token.
  • OptionalisPassword: boolean

    Whether the password or user token is used. See pwdOrToken.

    • （Default）true：The password is used.
    • false: The user token is used.

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

kickDevice

• kickDevice(userId, pwdOrToken, resource, isPassword?): Promise<void>

• Logs out from a specified account on a device.

  For how to get the device ID, see ChatDeviceInfo.resource.

  Parameters

  • userId: string

    The user ID.
  • pwdOrToken: string

    The password or token.
  • resource: string

    The device ID. See ChatDeviceInfo.resource.
  • OptionalisPassword: boolean

    Whether the password or user token is used. See pwdOrToken.

    • （Default）true：The password is used.
    • false: The user token is used.

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

login

• login(userId, pwdOrToken, isPassword?): Promise<void>

• Logs in to the chat server with a password or an Easemob token. An exception message is thrown if the login fails.

  Note

  If you use an Easemob token to log in to the server, you can get the token in either of the following ways:

  • Through an SDK API. See createAccount or getAccessToken.
  • Through the console.

  The token expiration reminder is returned by the two callback methods: ChatConnectEventListener.onTokenWillExpire and ChatConnectEventListener.onTokenDidExpire.

  Parameters

  • userId: string

    The user ID. See createAccount.
  • pwdOrToken: string

    The password or token. See createAccount or getAccessToken
  • isPassword: boolean = true

    Whether to log in with a password or a token. - true: A password is used. - (Default) false: A token is used.

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

  Deprecated

  Please use with loginWithToken instead.

loginWithAgoraToken

• loginWithAgoraToken(userId, agoraToken): Promise<void>

• Parameters

  • userId: string

    The user ID. See createAccount.
  • agoraToken: string

    The Agora token.

  Returns Promise<void>

  Deprecated

  2023-11-17 Use login instead.

  Logs in to the chat server with the user ID and an Agora token. An exception message is thrown if the login fails.

  Note

  The Agora token is different from token login.token provided by Easemob.

  This method supports automatic login.

  Throws

  A description of the exception. See ChatError.

loginWithToken

• loginWithToken(userId, token): Promise<void>

• Logs in to the chat server with a token. An exception message is thrown if the login fails.

  Note

  If you use a token to log in to the server, you can get the token in either of the following ways:

  • Through the console.

  The token expiration reminder is returned by the two callback methods: ChatConnectEventListener.onTokenWillExpire and ChatConnectEventListener.onTokenDidExpire.

  Parameters

  • userId: string

    The user ID.
  • token: string

    The token.

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

logout

• logout(unbindDeviceToken?): Promise<void>

• Logs out of the chat app. An exception message is thrown if the logout fails.

  Parameters

  • unbindDeviceToken: boolean = true

    Whether to unbind the token upon logout. This parameter is available only to mobile platforms.

    • (Default) true: Yes.
    • false: No.

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

removeAllConnectionListener

• removeAllConnectionListener(): void

• Removes all the connection status listeners for the chat server.

  Returns void

removeAllCustomListener

• removeAllCustomListener(): void

• Removes all the custom listeners.

  Returns void

removeAllExceptListener

• removeAllExceptListener(): void

• Remove all error listener.

  Returns void

removeAllMultiDeviceListener

• removeAllMultiDeviceListener(): void

• Removes all the multi-device listeners.

  Returns void

removeConnectionListener

• removeConnectionListener(listener): void

• Removes the connection status listener.

  Parameters

  • listener: ChatConnectEventListener

    The connection status listener to remove.

  Returns void

removeCustomListener

• removeCustomListener(listener): void

• Removes a custom listener to stop receiving data that the iOS or Android devices send to the React Native layer.

  Parameters

  • listener: ChatCustomEventListener

    The custom listener to remove.

  Returns void

removeExceptListener

• removeExceptListener(listener): void

• Remove error listener.

  Parameters

  • listener: ChatExceptionEventListener

  Returns void

removeMultiDeviceListener

• removeMultiDeviceListener(listener): void

• Removes the specified multi-device listener.

  Parameters

  • listener: ChatMultiDeviceEventListener

    The multi-device listener to remove.

  Returns void

renewAgoraToken

• renewAgoraToken(agoraToken): Promise<void>

• Renews the Agora token.

  Note

  If you log in with an Agora token and are notified by the callback method ChatConnectEventListener that the token is to expire, you can call this method to update the token to avoid unknown issues caused by an invalid token.

  Parameters

  • agoraToken: string

    The new Agora token.

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

setNativeListener

• setNativeListener(event): void

• Parameters

  • event: NativeEventEmitter

  Returns void

updatePushConfig

• updatePushConfig(config): Promise<void>

• Update push configurations.

  Note For the iOS platform, you need to pass the device ID during initialization. Otherwise, the push function cannot be used properly. See ChatClient.init

  Parameters

  • config: ChatPushConfig

    The push config, See ChatPushConfig

  Returns Promise<void>

  Throws

  A description of the exception. See ChatError.

StaticgetInstance

• getInstance(): ChatClient

• Returns ChatClient