Interface SuperTeamServiceInterface

Hierarchy

SuperTeamServiceInterface

Methods

acceptSuperTeamInvite

acceptSuperTeamInvite(options: AcceptSuperTeamInviteOptions): Promise<void>

（用户）接受群邀请

Parameters
- options: AcceptSuperTeamInviteOptions
Returns Promise<void>

addSuperTeamManagers

addSuperTeamManagers(options: AddSuperTeamManagersOptions): Promise<void>

添加超级群管理员

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

Parameters
- options: AddSuperTeamManagersOptions
Returns Promise<void>

addSuperTeamMembers

addSuperTeamMembers(options: AddSuperTeamMembersOptions): Promise<void>

添加超级群成员

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

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

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

Parameters
- options: AddSuperTeamMembersOptions
Returns Promise<void>

applySuperTeam

applySuperTeam(options: ApplySuperTeamOptions): Promise<SuperTeam>

申请入群

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

Parameters
- options: ApplySuperTeamOptions
Returns Promise<SuperTeam>

getSuperTeamInfo

getSuperTeamInfo(options: { teamId: string }): Promise<SuperTeam>

获取超级群的信息，根据群ID

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

getSuperTeamMembers

getSuperTeamMembers(options: GetSuperTeamMembersOptions): Promise<SuperTeamMember[]>

获取超级群成员列表

Parameters
- options: GetSuperTeamMembersOptions
Returns Promise<SuperTeamMember[]>

getSuperTeamMembersByAccounts

getSuperTeamMembersByAccounts(options: GetSuperTeamMembersByAccountsOptions): Promise<SuperTeamMember[]>

按照某些账号获取超级群成员

Parameters
- options: GetSuperTeamMembersByAccountsOptions
Returns Promise<SuperTeamMember[]>

getSuperTeams

getSuperTeams(): Promise<SuperTeam[]>

获取超级群列表

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

Returns Promise<SuperTeam[]>

leaveSuperTeam

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

主动退群

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

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

muteSuperTeam

muteSuperTeam(options: MuteSuperTeamOptions): Promise<void>

超级群全体禁言

Parameters
- options: MuteSuperTeamOptions
Returns Promise<void>

muteSuperTeamMembers

muteSuperTeamMembers(options: MuteSuperTeamMembersOptions): Promise<void>

更新超级群成员禁言状态

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

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

Parameters
- options: MuteSuperTeamMembersOptions
Returns Promise<void>

passSuperTeamApply

passSuperTeamApply(options: PassSuperTeamApplyOptions): Promise<void>

（管理员）通过群申请

Parameters
- options: PassSuperTeamApplyOptions
Returns Promise<void>

queryMuteMembers

queryMuteMembers(options: QueryMuteMembersOptions): Promise<SuperTeamMember[]>

获取超级群的禁言成员列表

Parameters
- options: QueryMuteMembersOptions
Returns Promise<SuperTeamMember[]>

rejectSuperTeamApply

rejectSuperTeamApply(options: RejectSuperTeamApplyOptions): Promise<void>

（管理员）拒绝群申请

Parameters
- options: RejectSuperTeamApplyOptions
Returns Promise<void>

rejectSuperTeamInvite

rejectSuperTeamInvite(options: RejectSuperTeamInviteOptions): Promise<void>

（用户）拒绝群邀请

Parameters
- options: RejectSuperTeamInviteOptions
Returns Promise<void>

removeSuperTeamManagers

removeSuperTeamManagers(options: RemmoveSuperTeamManagersOptions): Promise<void>

移除超级群管理员

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

Parameters
- options: RemmoveSuperTeamManagersOptions
Returns Promise<void>

removeSuperTeamMembers

removeSuperTeamMembers(options: RemoveSuperTeamMembersOptions): Promise<void>

踢人出超级群

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

Parameters
- options: RemoveSuperTeamMembersOptions
Returns Promise<void>

transferSuperTeam

transferSuperTeam(options: TransferSuperTeamOptions): Promise<void>

转让群, 群主可操作

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

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

Parameters
- options: TransferSuperTeamOptions
Returns Promise<void>

updateMemberNick

updateMemberNick(options: UpdateMemberNickOptions): Promise<SuperTeamMember>

修改别人在此超级群的昵称

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

Parameters
- options: UpdateMemberNickOptions
Returns Promise<SuperTeamMember>

updateMyMemberInfo

updateMyMemberInfo(options: UpdateMyMemberInfoOptions): Promise<SuperTeamMember>

修改自己在超级群里的信息，通 IM1 的 updateInfoInSuperTeam
目前支持修改的属性有这些：
1. nickInTeam: 自己在群里面的群昵称。更新昵称后, 所有其它在线的群成员会收到事件 updateSuperTeamMember 。
2. muteTeam: 是否关闭此群的消息提醒。true 表示关闭提醒, 但是 SDK 仍然会收到这个群的消息, SDK 只是记录这个设置。
3. ext: 第三方扩展字段, 开发者可以自行扩展, 建议封装成 JSON 格式字符串
Parameters
- options: UpdateMyMemberInfoOptions
Returns Promise<SuperTeamMember>

updateSuperTeamInfo

updateSuperTeamInfo(options: UpdateSuperTeamInfoOptions): Promise<SuperTeam>

更新超级群

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

Parameters
- options: UpdateSuperTeamInfoOptions
Returns Promise<SuperTeam>