Class ChatContactManager

export manager

Hierarchy

BaseManager
- ChatContactManager

Constructors

constructor

new ChatContactManager(): ChatContactManager

Overrides BaseManager.constructor
Returns ChatContactManager

Properties

Private _contactListeners

_contactListeners: Set<ChatContactEventListener>

Private _contactSubscriptions

_contactSubscriptions: Map<string, EmitterSubscription>

Protected Optional _eventEmitter

_eventEmitter?: NativeEventEmitter

Static Protected TAG

TAG: string = 'ChatContactManager'

Methods

acceptInvitation

acceptInvitation(userId: string): Promise<void>

Accepts a friend invitation。

throws
A description of the exception. See ChatError.

Parameters
- userId: string
  
  The user who sends the friend invitation.
Returns Promise<void>

addContact

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

Adds a new contact.

throws
A description of the exception. See ChatError.

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>

addContactListener

addContactListener(listener: ChatContactEventListener): void

Adds a contact listener.

Parameters
- listener: ChatContactEventListener
  
  The listener to add.
Returns void

addUserToBlockList

addUserToBlockList(userId: string): 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.

throws
A description of the exception. See ChatError.

Parameters
- userId: string
  
  The user ID of the contact to be added to the block list.
Returns Promise<void>

declineInvitation

declineInvitation(userId: string): Promise<void>

Declines a friend invitation.

throws
A description of the exception. See ChatError.

Parameters
- userId: string
  
  The user who sends the friend invitation.
Returns Promise<void>

deleteContact

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

Deletes a contact and all the related conversations.

throws
A description of the exception. See ChatError.

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>

getAllContactsFromDB

getAllContactsFromDB(): Promise<string[]>

Gets the contact list from the local database.

throws
A description of the exception. See ChatError.

Returns Promise<string[]>
The contact list.

getAllContactsFromServer

getAllContactsFromServer(): Promise<string[]>

Gets the contact list from the server.

throws
A description of the exception. See ChatError.

Returns Promise<string[]>
The list of contacts.

getBlockListFromDB

getBlockListFromDB(): Promise<string[]>

Gets the block list from the local database.

throws
A description of the exception. See ChatError.

Returns Promise<string[]>
The block list obtained from the local database.

getBlockListFromServer

getBlockListFromServer(): Promise<string[]>

Gets the block list from the server.

throws
A description of the exception. See ChatError.

Returns Promise<string[]>
The block list obtained from the server.

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}.

throws
A description of the exception. See ChatError.

Returns Promise<string[]>
The list of unique IDs of users on the other devices if the method succeeds.

Private invokeContactListener

invokeContactListener(params: any): void

Parameters
- params: any
Returns void

removeAllContactListener

removeAllContactListener(): void

Removes all contact listeners.

Returns void

removeContactListener

removeContactListener(listener: ChatContactEventListener): void

Removes the contact listener.

Parameters
- listener: ChatContactEventListener
  
  The listener to remove.
Returns void

removeUserFromBlockList

removeUserFromBlockList(userId: string): Promise<void>

Removes the contact from the block list.

throws
A description of the exception. See ChatError.

Parameters
- userId: string
  
  The user ID of the contact to be removed from the block list.
Returns Promise<void>

setNativeListener

setNativeListener(event: NativeEventEmitter): void

Overrides BaseManager.setNativeListener
Parameters
- event: NativeEventEmitter
Returns void

Static Protected _callMethod

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

Inherited from BaseManager._callMethod
Type Parameters
- T
Parameters
- method: string
- Optional args: {}
Returns Promise<T>

Static Protected checkErrorFromResult

checkErrorFromResult(result: any): void

Inherited from BaseManager.checkErrorFromResult
Parameters
- result: any
Returns void

Static Protected handleGroupFileCallback

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

Inherited from BaseManager.handleGroupFileCallback
Parameters
- methodName: string
- self: BaseManager
- groupId: string
- filePath: string
- Optional callback: ChatGroupFileStatusCallback
Returns void

Static Protected handleMessageCallback

handleMessageCallback(methodName: string, self: BaseManager, message: ChatMessage, callback?: ChatMessageStatusCallback): void

Inherited from BaseManager.handleMessageCallback
Parameters
- methodName: string
- self: BaseManager
- message: ChatMessage
- Optional callback: ChatMessageStatusCallback
Returns void

Generated using TypeDoc