Class ChatUserInfoManager

The user information manager for updating and getting user attributes.

Hierarchy

Native
- ChatUserInfoManager

Index

Constructors

Methods

fetchOwnInfo fetchUserInfoById updateOwnUserInfo _callMethod checkErrorFromResult

Constructors

constructor

new ChatUserInfoManager(): ChatUserInfoManager
Returns ChatUserInfoManager
Overrides Native.constructor

Methods

fetchOwnInfo

fetchOwnInfo(): Promise<ChatUserInfo | undefined>
Gets attributes of the current user from the server.

Returns Promise<ChatUserInfo | undefined>
The obtained user attributes. See ChatUserInfo.

Throws
A description of the exception. See ChatError.

fetchUserInfoById

fetchUserInfoById(userIds: string[]): Promise<Map<string, ChatUserInfo>>
Gets the user attributes of the specified users.
Parameters
- userIds: string[]
  The user ID array.
Returns Promise<Map<string, ChatUserInfo>>
A map that contains key-value pairs where the key is the user ID and the value is user attributes，see ChatUserInfo.

Throws
A description of the exception. See ChatError.

updateOwnUserInfo

updateOwnUserInfo(
    params: {
        avatarUrl?: string;
        birth?: string;
        ext?: string;
        gender?: number;
        mail?: string;
        nickName?: string;
        phone?: string;
        sign?: string;
    },
): Promise<void>
Modifies the user attributes of the current user.
Parameters
- params: {
      avatarUrl?: string;
      birth?: string;
      ext?: string;
      gender?: number;
      mail?: string;
      nickName?: string;
      phone?: string;
      sign?: string;
  }
Returns Promise<void>
Params
The parameter set.
- [nickName] The nickname of the user.
- [avatarUrl] The avatar URL of the user.
- [mail] The email address of the user.
- [phone] The phone number of the user.
- [gender] The gender of the user. The value can only be 0, 1, or 2. Other values are invalid.
  
  0: (Default) Unknown;
  
  1: Male;
  
  2: Female.
- [sign] The signature of the user.
- [birth] The birthday of the user.
- [ext] The custom extension information of the user. You can set it to an empty string or type custom information and encapsulate them as a JSON string.
Throws
A description of the exception. See ChatError.

`Protected` `Static`_callMethod

_callMethod<T>(method: string, args?: {}): Promise<T>
Type Parameters
- T
Parameters
- method: string
- Optionalargs: {}
Returns Promise<T>
Inherited from Native._callMethod

`Protected` `Static`checkErrorFromResult

checkErrorFromResult(result: any): void
Parameters
- result: any
Returns void
Inherited from Native.checkErrorFromResult