Class ChatUserInfoManager

用户信息管理类，负责更新及获取用户属性。

Hierarchy

  • Native
    • ChatUserInfoManager

Constructors

constructor

Properties

TAG

Methods

fetchOwnInfo fetchUserInfoById updateOwnUserInfo _callMethod checkErrorFromResult

Constructors

constructor

Properties

Static Private TAG

TAG: string = 'ChatUserInfoManager'

Methods

fetchOwnInfo

fetchUserInfoById

  • 获取指定用户的用户属性。

    Parameters

    • userIds: string[]

      要获取用户属性的用户 ID 列表。

    Returns Promise<Map<string, ChatUserInfo>>

    用户 ID 和用户属性的键值对，详见 ChatUserInfo。

    Throws

    如果有方法调用的异常会在这里抛出，可以看到具体错误原因。参见 ChatError。

updateOwnUserInfo

  • 修改当前用户的信息。

    Parameters

    • params: {
          avatarUrl?: string;
          birth?: string;
          ext?: string;
          gender?: number;
          mail?: string;
          nickName?: string;
          phone?: string;
          sign?: string;
      }

      参数。

      • [nickName] 用户昵称。
      • [avatarUrl] 用户头像。
      • [mail] 用户邮箱。
      • [phone] 用户手机号。
      • [gender] 用户性别。该参数的值可为 0、1 或 2。
        • 0：（默认）未知
        • 1：男
        • 2：女
      • [sign] 用户签名。
      • [birth] 用户的生日。
      • [ext] 用户的自定义属性字段。该字段可为空，或设置为自定义扩展信息，封装为 JSON 字符串。
      • Optional avatarUrl?: string
      • Optional birth?: string
      • Optional ext?: string
      • Optional gender?: number
      • Optional mail?: string
      • Optional nickName?: string
      • Optional phone?: string
      • Optional sign?: string

    Returns Promise<void>

    Throws

    如果有方法调用的异常会在这里抛出，可以看到具体错误原因。参见 ChatError。

Static Protected _callMethod

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

  • Type Parameters

    • T

    Parameters

    • method: string
    • Optional args: {}

      Returns Promise<T>

    Static Protected checkErrorFromResult

    • Parameters

      • result: any

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc