Class ChatContactManager

The contact manager class, which manages chat contacts such as adding, retrieving, modifying, and deleting contacts.

Hierarchy

  • BaseManager
    • ChatContactManager

Constructors

constructor

Properties

_eventEmitter? TAG

Methods

acceptInvitation addContact addContactListener addUserToBlockList declineInvitation deleteContact fetchAllContacts fetchContacts getAllContacts getAllContactsFromDB getAllContactsFromServer getBlockListFromDB getBlockListFromServer getContact getSelfIdsOnOtherPlatform removeAllContactListener removeContactListener removeUserFromBlockList setContactRemark setNativeListener _callMethod checkErrorFromResult handleGroupFileCallback handleMessageCallback

Constructors

constructor

Properties

Protected Optional_eventEmitter

_eventEmitter?: NativeEventEmitter

Protected StaticTAG

TAG: string = 'ChatContactManager'

Methods

acceptInvitation

  • acceptInvitation(userId): Promise<void>

  • Accepts a friend invitation。

    Parameters

    • userId: string

      The user who sends the friend invitation.

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

addContact

  • addContact(userId, reason?): Promise<void>

  • Adds a new contact.

    Parameters

    • userId: string

      The user ID of the contact to add.

    • reason: string = ''

      The reason for adding the contact. This parameter is optional and can be null or "".

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

addContactListener

  • addContactListener(listener): void

  • Adds a contact listener.

    Parameters

    Returns void

addUserToBlockList

  • addUserToBlockList(userId): Promise<void>

  • Adds a contact to the block list.

    You can send messages to the users on the block list, but cannot receive messages from them.

    Parameters

    • userId: string

      The user ID of the contact to be added to the block list.

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

declineInvitation

  • declineInvitation(userId): Promise<void>

  • Declines a friend invitation.

    Parameters

    • userId: string

      The user who sends the friend invitation.

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

deleteContact

  • deleteContact(userId, keepConversation?): Promise<void>

  • Deletes a contact and all the related conversations.

    Parameters

    • userId: string

      The user ID of the contact to delete.

    • keepConversation: boolean = false

      Whether to retain conversations of the contact to delete.

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

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

fetchAllContacts

  • fetchAllContacts(): Promise<ChatContact[]>

  • Gets all contacts from the server.

    Returns Promise<ChatContact[]>

    The list of contacts.

    Throws

    A description of the exception. See ChatError.

fetchContacts

  • fetchContacts(params): Promise<ChatCursorResult<ChatContact>>

  • Gets the contacts from the server.

    Parameters

    • params: {
          cursor?: string;
          pageSize?: number;
      }
      • Optionalcursor?: string
      • OptionalpageSize?: number

    Returns Promise<ChatCursorResult<ChatContact>>

    The list of contacts.

    Params

    params -

    • cursor: The cursor of the page to get. The first page is an empty string.
    • pageSize: The number of contacts to get. The default value is 20. [1-50]

    Throws

    A description of the exception. See ChatError.

getAllContacts

  • getAllContacts(): Promise<ChatContact[]>

  • Gets all contacts from the local database.

    Returns Promise<ChatContact[]>

    The list of contacts.

    Throws

    A description of the exception. See ChatError.

getAllContactsFromDB

  • getAllContactsFromDB(): Promise<string[]>

  • Gets the contact list from the local database.

    Returns Promise<string[]>

    The contact list.

    Throws

    A description of the exception. See ChatError.

getAllContactsFromServer

  • getAllContactsFromServer(): Promise<string[]>

  • Gets the contact list from the server.

    Returns Promise<string[]>

    The list of contacts.

    Throws

    A description of the exception. See ChatError.

getBlockListFromDB

  • getBlockListFromDB(): Promise<string[]>

  • Gets the block list from the local database.

    Returns Promise<string[]>

    The block list obtained from the local database.

    Throws

    A description of the exception. See ChatError.

getBlockListFromServer

  • getBlockListFromServer(): Promise<string[]>

  • Gets the block list from the server.

    Returns Promise<string[]>

    The block list obtained from the server.

    Throws

    A description of the exception. See ChatError.

getContact

  • getContact(userId): Promise<undefined | ChatContact>

  • Gets the contact by user ID from local database.

    Parameters

    • userId: string

      The user ID of the contact to get.

    Returns Promise<undefined | ChatContact>

    The contact.

    Throws

    A description of the exception. See ChatError.

getSelfIdsOnOtherPlatform

  • getSelfIdsOnOtherPlatform(): Promise<string[]>

  • Gets the unique IDs of the current user on the other devices. The ID is in the format of {user_ID} + "/" + {resource_ID}.

    Returns Promise<string[]>

    The list of unique IDs of users on the other devices if the method succeeds.

    Throws

    A description of the exception. See ChatError.

removeAllContactListener

  • removeAllContactListener(): void

  • Removes all contact listeners.

    Returns void

removeContactListener

  • removeContactListener(listener): void

  • Removes the contact listener.

    Parameters

    Returns void

removeUserFromBlockList

  • removeUserFromBlockList(userId): Promise<void>

  • Removes the contact from the block list.

    Parameters

    • userId: string

      The user ID of the contact to be removed from the block list.

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

setContactRemark

  • setContactRemark(contact): Promise<void>

  • Set the contact's remark.

    Parameters

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

setNativeListener

  • setNativeListener(event): void

  • Parameters

    • event: NativeEventEmitter

    Returns void

Protected Static_callMethod

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

  • Type Parameters

    • T

    Parameters

    • method: string
    • Optionalargs: {}

      Returns Promise<T>

    Protected StaticcheckErrorFromResult

    • checkErrorFromResult(result): void

    • Parameters

      • result: any

      Returns void

    Protected StatichandleGroupFileCallback

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

    • Parameters

      Returns void

    Protected StatichandleMessageCallback

    • handleMessageCallback(methodName, self, message, callback?): void

    • Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods