Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TeamServiceInterface

Hierarchy

  • TeamServiceInterface

Index

Methods

  • 添加群成员

    普通群:

    1. 拉人入群后, 所有群成员会收到通知并触发事件 addTeamMembers

    2. 被邀请的群成员先收到通知 并触发事件 addTeamMembers,接着在有人说话收到 teams 事件才能看得到群。

    高级群:

    群主和管理员在邀请成员加入群(通过操作创建群或拉人入群)之后, 被邀请者会收到系统通知,并触发 sysMsg,其 type 为 'teamInvite',

    如果用户接受入群邀请, 那么该群的所有群成员会收到群通知消息,触发 addTeamMembers 事件。

    如果用户拒绝群邀请后, 邀请者会收到系统通知,并触发事件 sysMsg,其 type 为 'rejectTeamInvite'

    Parameters

    Returns Promise<void>

  • 申请入群

    用户可以主动申请加入高级群, 目标群的群主和管理员会收到系统通知,触发事件 sysMsg type 为 'applyTeam',

    Parameters

    Returns Promise<Team>

  • 创建群

    普通群不可以设置群加入方式

    高级群的群加入方式默认为'needVerify'

    高级群的群被邀请模式默认为'needVerify'

    高级群的群邀请模式默认为'manager'

    高级群的群信息修改权限默认为'manager'

    高级群的群信息自定义字段修改权限默认为'manager'

    被邀请的群成员,会先收到群通知,并触发 addTeamMembers 事件,接着在有人说话后才会看到该群,收到 teams 事件。

    用户接受群邀请后, 所有群成员会收到群通知,并触发 addTeamMembers 事件。

    用户拒绝群邀请后, 邀请者会收到系统通知,并触发事件 sysMsg,其 type 为 'rejectTeamInvite'

    Parameters

    Returns Promise<Team>

  • dismissTeam(options: { teamId: string }): Promise<void>
  • 解散群,群主可操作

    解散群后, 所有群成员会收到群通知,并触发 dismissTeam 事件。

    Parameters

    • options: { teamId: string }
      • teamId: string

    Returns Promise<void>

  • getMutedTeamMembers(options: { teamId: string }): Promise<TeamMember[]>
  • 获取被禁言的群成员

    Parameters

    • options: { teamId: string }
      • teamId: string

    Returns Promise<TeamMember[]>

  • getTeamInfo(options: { teamId: string }): Promise<Team>
  • 获取群信息

    Parameters

    • options: { teamId: string }
      • teamId: string

    Returns Promise<Team>

  • 获取群成员,通 IM1 的 getTeamMembers

    但参数允许传 accounts 用于过滤群成员的结果

    即也把 IM1 的 getTeamMemberByTeamIdAndAccount 接口的功能也做进来了

    Parameters

    Returns Promise<TeamMember[]>

  • getTeams(): Promise<Team[]>
  • 获取群列表

    没有本地 db 时,将会全量获取服务器的群列表

    Returns Promise<Team[]>

  • 根据群 ID 获取群列表

    Parameters

    • options: { teamIds: string[] }
      • teamIds: string[]

    Returns Promise<GetTeamsByIdResult>

  • leaveTeam(options: { teamId: string }): Promise<void>
  • 主动退群

    主动退群后, 所有群成员会收到群通知,并触发 removeTeamMembers 事件

    Parameters

    • options: { teamId: string }
      • teamId: string

    Returns Promise<void>

  • 群组全体禁言

    Parameters

    Returns Promise<void>

  • 更新群成员禁言状态

    更新群成员禁言状态后, 所有群成员会收到群通知消息,触发事件 updateTeamMembersMute 。。

    其 attach 有一个字段 team 值为对应的群对象,account 的值为被禁言的帐号, members 的值为被禁言的群成员列表。

    Parameters

    Returns Promise<void>

  • 转让群, 群主可操作

    转让群后, 所有群成员会收到群通知,并触发事件 transferTeam

    如果转让群的同时离开群, 那么相当于调用主动退群来离开群, 所有群成员会再收到群通知,并触发事件 removeTeamMembers

    Parameters

    Returns Promise<void>

  • 修改自己在群里的信息,通 IM1 的 updateInfoInTeam

    目前支持修改的属性有这些:

    1. nickInTeam: 自己在群里面的群昵称。更新昵称后, 所有其它在线的群成员会收到事件 updateTeamMember

    2. muteTeam: 是否关闭此群的消息提醒。true 表示关闭提醒, 但是 SDK 仍然会收到这个群的消息, SDK 只是记录这个设置。

    3. ext: 第三方扩展字段, 开发者可以自行扩展, 建议封装成 JSON 格式字符串

    Parameters

    Returns Promise<TeamMember>

  • 更新群

    普通群不可以更新:

    群加入方式

    群被邀请模式

    群邀请模式

    群信息修改权限

    群信息自定义字段修改权限

    更新群后, 所有群成员会收到群通知,并触发事件 updateTeam

    Parameters

    Returns Promise<Team>