Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChatClient

export manager

Hierarchy

  • BaseManager
    • ChatClient

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

  • Returns ChatClient

Properties

Private _chatManager

_chatManager: ChatManager

Private _chatRoomManager

_chatRoomManager: ChatRoomManager

Private _connectionListeners

_connectionListeners: Set<ChatConnectEventListener>

Private _connectionSubscriptions

_connectionSubscriptions: Map<string, EmitterSubscription>

Private _contactManager

_contactManager: ChatContactManager

Private _currentUsername

_currentUsername: string = ''

Private _customListeners

_customListeners: Set<ChatCustomEventListener>

Protected Optional _eventEmitter

_eventEmitter?: NativeEventEmitter

Private _groupManager

_groupManager: ChatGroupManager

Private _isInit

_isInit: boolean = false

Private _multiDeviceListeners

_multiDeviceListeners: Set<ChatMultiDeviceEventListener>

Private Optional _options

_options?: ChatOptions

Private _presenceManager

_presenceManager: ChatPresenceManager

Private _pushManager

_pushManager: ChatPushManager

Private Readonly _rnSdkVersion

_rnSdkVersion: string = '1.1.0'

Private Readonly _sdkVersion

_sdkVersion: string = '4.0.0'

Private _userInfoManager

_userInfoManager: ChatUserInfoManager

Static Protected TAG

TAG: string = 'ChatClient'

Static Private _instance

_instance: ChatClient

Static eventType

eventType: number = 2

Accessors

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

  • 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

  • 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

  • Gets the SDK configurations.

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

    Returns undefined | ChatOptions

    The SDK configurations.

presenceManager

  • Gets the presence manager class.

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

    Returns ChatPresenceManager

    The presence manager class.

pushManager

  • Gets the push manager class.

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

    Returns ChatPushManager

    The push manager class.

roomManager

  • 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

  • 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

Methods

addConnectionListener

  • Adds the connection status listener.

    Parameters

    Returns void

addCustomListener

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

    Parameters

    Returns void

addMultiDeviceListener

changeAppKey

  • changeAppKey(newAppKey: string): 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.

    throws

    A description of the exception. See ChatError.

    Parameters

    • newAppKey: string

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

    Returns Promise<void>

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.

    throws

    A description of the exception. See ChatError.

    Returns Promise<undefined | string>

    The path of the compressed gzip file.

createAccount

  • createAccount(userId: string, password: string): 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.

    throws

    A description of the exception. See ChatError.

    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>

getAccessToken

  • getAccessToken(): Promise<string>

  • Gets the token for login.

    throws

    A description of the exception. See ChatError.

    Returns Promise<string>

    The token for login.

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.

    throws

    A description of the exception. See ChatError.

    Returns Promise<string>

    The logged-in user ID.

getEventEmitter

  • getEventEmitter(): NativeEventEmitter

  • Returns NativeEventEmitter

getLoggedInDevicesFromServer

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

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

    throws

    A description of the exception. See ChatError.

    Parameters

    • userId: string

      The user ID.

    • pwdOrToken: string

      The password or token.

    • Optional isPassword: boolean

      If true, use password, otherwise use token. Default is true. See {@link pwdOrToken}

    Returns Promise<ChatDeviceInfo[]>

    The list of the online logged-in devices.

init

  • 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.
    throws

    A description of the exception. See ChatError.

    Parameters

    Returns Promise<void>

isConnected

  • isConnected(): Promise<boolean>

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

    throws

    A description of the exception. See ChatError.

    Returns Promise<boolean>

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

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.

    throws

    A description of the exception. See ChatError.

    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.

kickAllDevices

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

  • Logs out from a specified account on all devices.

    throws

    A description of the exception. See ChatError.

    Parameters

    • userId: string

      The user ID.

    • pwdOrToken: string

      The password or token.

    • Optional isPassword: boolean

      Whether the password or user token is used. See {@link pwdOrToken}.

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

    Returns Promise<void>

kickDevice

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

  • Logs out from a specified account on a device.

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

    throws

    A description of the exception. See ChatError.

    Parameters

    • userId: string

      The user ID.

    • pwdOrToken: string

      The password or token.

    • resource: string

      The device ID. See ChatDeviceInfo.resource.

    • Optional isPassword: boolean

      Whether the password or user token is used. See {@link pwdOrToken}.

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

    Returns Promise<void>

login

  • login(userId: string, pwdOrToken: string, isPassword?: boolean): 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:

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

    throws

    A description of the exception. See ChatError.

    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 token is used. - (Default) false: A password is used.

    Returns Promise<void>

loginWithAgoraToken

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

  • 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 {@link login.token} provided by Easemob.

    This method supports automatic login.

    throws

    A description of the exception. See ChatError.

    Parameters

    • userId: string

      The user ID. See createAccount.

    • agoraToken: string

      The Agora token.

    Returns Promise<void>

logout

  • logout(unbindDeviceToken?: boolean): Promise<void>

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

    throws

    A description of the exception. See ChatError.

    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>

Private onAppActiveNumberReachLimit

  • onAppActiveNumberReachLimit(): void

  • Returns void

Private onConnected

  • onConnected(): void

  • Returns void

Private onCustomEvent

  • onCustomEvent(params: any): void

  • Parameters

    • params: any

    Returns void

Private onDisconnected

  • onDisconnected(params?: any): void

  • Parameters

    • Optional params: any

    Returns void

Private onMultiDeviceEvent

  • onMultiDeviceEvent(params?: any): void

  • Parameters

    • Optional params: any

    Returns void

Private onTokenDidExpire

  • onTokenDidExpire(params?: any): void

  • Parameters

    • Optional params: any

    Returns void

Private onTokenWillExpire

  • onTokenWillExpire(params?: any): void

  • Parameters

    • Optional params: any

    Returns void

Private onUserAuthenticationFailed

  • onUserAuthenticationFailed(): void

  • Returns void

Private onUserDidChangePassword

  • onUserDidChangePassword(): void

  • Returns void

Private onUserDidForbidByServer

  • onUserDidForbidByServer(): void

  • Returns void

Private onUserDidLoginFromOtherDevice

  • onUserDidLoginFromOtherDevice(params: any): void

  • Parameters

    • params: any

    Returns void

Private onUserDidLoginTooManyDevice

  • onUserDidLoginTooManyDevice(): void

  • Returns void

Private onUserDidRemoveFromServer

  • onUserDidRemoveFromServer(): void

  • Returns void

Private onUserKickedByOtherDevice

  • onUserKickedByOtherDevice(): void

  • Returns void

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

removeAllMultiDeviceListener

  • removeAllMultiDeviceListener(): void

  • Removes all the multi-device listeners.

    Returns void

removeConnectionListener

  • Removes the connection status listener.

    Parameters

    Returns void

removeCustomListener

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

    Parameters

    Returns void

removeMultiDeviceListener

  • Removes the specified multi-device listener.

    Parameters

    Returns void

renewAgoraToken

  • renewAgoraToken(agoraToken: string): 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.

    throws

    A description of the exception. See ChatError.

    Parameters

    • agoraToken: string

      The new Agora token.

    Returns Promise<void>

Private reset

  • reset(): void

  • Returns void

Private setEventEmitter

  • setEventEmitter(): void

  • Returns void

setNativeListener

  • setNativeListener(event: NativeEventEmitter): void

  • Parameters

    • event: NativeEventEmitter

    Returns void

updatePushConfig

  • 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

    throws

    A description of the exception. See ChatError.

    Parameters

    Returns Promise<void>

Static Protected _callMethod

  • _callMethod<T>(method: string, args?: {}): Promise<T>

  • Type Parameters

    • T

    Parameters

    • method: string
    • Optional args: {}

      Returns Promise<T>

    Static Protected checkErrorFromResult

    • checkErrorFromResult(result: any): void

    • Parameters

      • result: any

      Returns void

    Static getInstance

    Static Protected handleGroupFileCallback

    • handleGroupFileCallback(methodName: string, self: BaseManager, groupId: string, filePath: string, callback?: ChatGroupFileStatusCallback): void

    • Parameters

      Returns void

    Static Protected handleMessageCallback

    Generated using TypeDoc