Interface TeamServiceInterface

Hierarchy

TeamServiceInterface

Methods

acceptTeamInvite

acceptTeamInvite(options: AcceptTeamInviteOptions): Promise<void>

（用户）接受群邀请

Parameters
- options: AcceptTeamInviteOptions
Returns Promise<void>

addTeamManagers

addTeamManagers(options: AddTeamManagersOptions): Promise<void>

添加群管理员

添加群管理员后, 所有群成员会收到群通知，并触发事件 updateTeamManagers。

Parameters
- options: AddTeamManagersOptions
Returns Promise<void>

addTeamMembers

addTeamMembers(options: AddTeamMembersOptions): Promise<void>

添加群成员
普通群：
1. 拉人入群后, 所有群成员会收到通知并触发事件 addTeamMembers
2. 被邀请的群成员先收到通知并触发事件 addTeamMembers，接着在有人说话收到 teams 事件才能看得到群。
高级群：

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

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

如果用户拒绝群邀请后, 邀请者会收到系统通知，并触发事件 sysMsg，其 type 为 'rejectTeamInvite'
Parameters
- options: AddTeamMembersOptions
Returns Promise<void>

applyTeam

applyTeam(options: ApplyTeamOptions): Promise<Team>

申请入群

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

Parameters
- options: ApplyTeamOptions
Returns Promise<Team>

createTeam

createTeam(options: CreateTeamOptions): Promise<Team>

创建群

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

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

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

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

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

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

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

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

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

Parameters
- options: CreateTeamOptions
Returns Promise<Team>

dismissTeam

dismissTeam(options: { teamId: string }): Promise<void>

解散群，群主可操作

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

Parameters
- options: { teamId: string }
  - teamId: string
Returns Promise<void>

getMutedTeamMembers

getMutedTeamMembers(options: { teamId: string }): Promise<TeamMember[]>

获取被禁言的群成员

Parameters
- options: { teamId: string }
  - teamId: string
Returns Promise<TeamMember[]>

getTeamInfo

getTeamInfo(options: { teamId: string }): Promise<Team>

获取群信息

Parameters
- options: { teamId: string }
  - teamId: string
Returns Promise<Team>

getTeamMemberInvitorAccid

getTeamMemberInvitorAccid(options: GetTeamMemberInvitorAccidOptions): Promise<GetTeamMemberInvitorAccidResult>

获取若干群成员的邀请者 accountId

Parameters
- options: GetTeamMemberInvitorAccidOptions
Returns Promise<GetTeamMemberInvitorAccidResult>

getTeamMembers

getTeamMembers(options: GetTeamMembersOptions): Promise<TeamMember[]>

获取群成员.

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

Parameters
- options: GetTeamMembersOptions
Returns Promise<TeamMember[]>

getTeams

getTeams(): Promise<Team[]>

获取群列表

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

Returns Promise<Team[]>

getTeamsById

getTeamsById(options: { teamIds: string[] }): Promise<GetTeamsByIdResult>

根据群 ID 获取群列表

Parameters
- options: { teamIds: string[] }
  - teamIds: string[]
Returns Promise<GetTeamsByIdResult>

leaveTeam

leaveTeam(options: { teamId: string }): Promise<void>

主动退群

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

Parameters
- options: { teamId: string }
  - teamId: string
Returns Promise<void>

muteTeam

muteTeam(options: MuteTeamOptions): Promise<void>

群组全体禁言

Parameters
- options: MuteTeamOptions
Returns Promise<void>

muteTeamMember

muteTeamMember(options: MuteTeamMemberOptions): Promise<void>

更新群成员禁言状态

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

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

Parameters
- options: MuteTeamMemberOptions
Returns Promise<void>

passTeamApply

passTeamApply(options: PassTeamApplyOptions): Promise<void>

（管理员）通过群申请

Parameters
- options: PassTeamApplyOptions
Returns Promise<void>

rejectTeamApply

rejectTeamApply(options: RejectTeamApplyOptions): Promise<void>

（管理员）拒绝群申请

Parameters
- options: RejectTeamApplyOptions
Returns Promise<void>

rejectTeamInvite

rejectTeamInvite(options: RejectTeamInviteOptions): Promise<void>

（用户）拒绝群邀请

Parameters
- options: RejectTeamInviteOptions
Returns Promise<void>

removeTeamManagers

removeTeamManagers(options: RemmoveTeamManagersOptions): Promise<void>

移除群管理员

移除群管理员后, 所有群成员会收到群通知，并触发事件 updateTeamManagers。

Parameters
- options: RemmoveTeamManagersOptions
Returns Promise<void>

removeTeamMembers

removeTeamMembers(options: RemoveTeamMembersOptions): Promise<void>

踢人出群

踢人出群后, 所有群成员会收到群通知，并触发事件 removeTeamMembers

Parameters
- options: RemoveTeamMembersOptions
Returns Promise<void>

transferTeam

transferTeam(options: TransferTeamOptions): Promise<void>

转让群, 群主可操作

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

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

Parameters
- options: TransferTeamOptions
Returns Promise<void>

updateMemberNick

updateMemberNick(options: UpdateMemberNickOptions): Promise<TeamMember>

修改别人的群昵称

所有其它在线的群成员会收到事件 updateTeamMember 。

Parameters
- options: UpdateMemberNickOptions
Returns Promise<TeamMember>

updateMyMemberInfo

updateMyMemberInfo(options: UpdateMyMemberInfoOptions): Promise<TeamMember>

修改自己在群里的信息

Parameters
- options: UpdateMyMemberInfoOptions
Returns Promise<TeamMember>

updateTeamInfo

updateTeamInfo(options: UpdateTeamInfoOptions): Promise<Partial<Team>>

更新群

普通群不可以更新：

群加入方式

群被邀请模式

群邀请模式

群信息修改权限

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

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

Parameters
- options: UpdateTeamInfoOptions
Returns Promise<Partial<Team>>