Class TeamMemberStore

Mobx 可观察对象,负责管理群组成员的子 store

Hierarchy

  • TeamMemberStore

Constructors

Properties

teamMembers: Map<string, Map<string, TeamMember>> = ...

Methods

  • TeamMemberStore添加群成员处理函数(TeamMemberStore内部使用,外层不太推荐直接使用)

    Parameters

    • teamId: string

      群id

    • members: TeamMember[]

      群成员

    Returns void

  • 拉人入群

    Parameters

    • options: AddTeamMembersOptions

      options.teamId - 群id
      options.accounts - 要拉进群的成员的帐号列表
      options.ps - 附言, 选填, 开发者也可以使用JSON格式的字符串来扩展此内容
      options.ext - 附言, 自定义扩展字段

    Returns Promise<void>

  • 销毁TeamMemberStore,会取消相关事件监听

    Returns void

  • 从内存中获取 teamMembers

    Parameters

    • teamId: string

      群id

    • Optional accounts: string[]

      群成员数组

    Returns TeamMember[]

  • 获取群成员

    Parameters

    • teamId: string

      群id

    Returns Promise<TeamMember[]>

  • TeamMemberStore移除群成员处理函数(TeamMemberStore内部使用,外层不太推荐直接使用)

    Parameters

    • teamId: string

      群id

    • Optional accounts: string[]

      群成员数组

    Returns void

  • 踢人出群

    Parameters

    • options: RemoveTeamMembersOptions

      options.teamId - 群id
      options.accounts - 要拉进群的成员的帐号列表

    Returns Promise<void>

  • 更新我在群中的信息

    Parameters

    • options: UpdateMyMemberInfoOptions

      options.teamId - 群id
      options.nickInTeam - 群昵称
      options.muteTeam - 是否关闭此群的消息提醒, true表示关闭提醒, 但是SDK仍然会收到这个群的消息, SDK只是记录这个设置, 具体根据这个设置要执行的操作由第三方APP决定
      options.bitConfigMask - 提醒策略: 0 开启提醒;1 关闭消息提醒;2 只接受管理员的消息的提醒
      options.ext - 扩展字段

    Returns Promise<void>

  • TeamMemberStore移除群成员处理函数(TeamMemberStore内部使用,外层不太推荐直接使用)

    Parameters

    • teamId: string

      群id

    • members: Partial<TeamMember>[]

      群成员

    Returns void

Generated using TypeDoc