SuperTeamServiceInterface

调用方式:

nim.superTeam.getSuperTeamInfo(options)

Hierarchy

SuperTeamServiceInterface

Methods

acceptSuperTeamInvite

acceptSuperTeamInvite(options: AcceptSuperTeamInviteOptions): Promise<void>

同意入群邀请。
收到 type 为 'superTeamInvite' 的 sysMsg 后，调用此接口同意入群邀请。

影响范围:
- 所有群成员触发 addSuperTeamMembers 事件
- 所有群成员收到群通知消息 msg
  - msg.type: 'notification'
  - msg.from: 被邀请人账号
  - msg.to: 群id
  - msg.attach.type: 'acceptSuperTeamInvite'
  - msg.attach.account: 邀请者账号
Parameters
- options: AcceptSuperTeamInviteOptions
Returns Promise<void>

addSuperTeamManagers

addSuperTeamManagers(options: AddSuperTeamManagersOptions): Promise<void>

添加群管理员。只有群主有权限操作
影响范围:
- 所有群成员收到更新群管理员事件回调 updateSuperTeamManagers
- 所有群成员收到通知消息msg:
  - msg.type: 'notification'
  - msg.from: 群主账号
  - msg.to: 群id
  - msg.attach.type: 'addSuperTeamManagers'
  - msg.attach.accounts: 新增管理员账号
Parameters
- options: AddSuperTeamManagersOptions
Returns Promise<void>

addSuperTeamMembers

addSuperTeamMembers(options: AddSuperTeamMembersOptions): Promise<void>

添加超级群成员
- 如果 beInviteMode: noVerify:
  - 所有群成员收到 addSuperTeamMembers 事件
  - 被邀请人直接入群，所有群成员触发通知消息msg:
    
    msg.type: 'notification'
    
    msg.from: 操作者
    
    msg.to: 被邀请者
    
    msg.attach.type: 'addSuperTeamMembers'
    
    msg.attach.accounts: 被邀请者账号
- 如果 beInviteMode: 'needVerify':
  - 被邀请者触发 sysMsg，其 type 为 'superTeamInvite'
  - 被邀请者通过 SuperTeamServiceInterface.acceptSuperTeamInvite 或者 SuperTeamServiceInterface.rejectSuperTeamInvite 来处理邀请
Parameters
- options: AddSuperTeamMembersOptions
Returns Promise<void>

applySuperTeam

applySuperTeam(options: ApplySuperTeamOptions): Promise<SuperTeam>

申请入群。根据 joinMode 不同，SDK会有不同的行为。
- 如果 joinMode: noVerify:
  - 所有群成员收到新增成员事件回调 addSuperTeamMembers
  - 所有群成员收到通知消息msg:
    
    msg.type: 'notification'
    
    msg.from: 申请者账号
    
    msg.to: 群id
    
    msg.attach.type: 'passSuperTeamApply'
    
    msg.attach.account: 申请者账号
- 如果 joinMode: 'needVerify':
  - 管理员收到 sysMsg，其 type 为 'applySuperTeam'。管理员通过 SuperTeamServiceInterface.passSuperTeamApply 或者 SuperTeamServiceInterface.rejectSuperTeamApply 来处理申请
- 如果 joinMode: 'rejectAll':
  - 调用此函数会抛出全局异常
用户可以主动申请加入高级群, 目标群的群主和管理员会收到系统通知，触发事件 sysMsg type 为 'applySuperTeam'，
Parameters
- options: ApplySuperTeamOptions
Returns Promise<SuperTeam>

getSuperTeamInfo

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

获取群基本信息。除了创建群时的信息外，还包括 memberNum, muteType, owner 等字段

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[]>

获取超级群列表

Returns Promise<SuperTeam[]>

leaveSuperTeam

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

主动退群。注意群主不能主动退群。若群主要退群，请使用 SuperTeamServiceInterface.transferSuperTeam 转让群并退群。
影响范围:
- 群成员收到 removeSuperTeamMembers 事件
- 群成员收到通知消息msg:
  - msg.type: 'notification'
  - msg.from: 退群者账号
  - msg.to: 群id
  - msg.attach.type: 'leaveSuperTeam'
  - msg.attach.users: 退群者信息详情
Parameters
- options: { teamId: string }
  - teamId: string
Returns Promise<void>

muteSuperTeam

muteSuperTeam(options: MuteSuperTeamOptions): Promise<void>

群组全体禁言，或者取消禁言。只有管理员有权限操作
影响范围:
- 所有群成员收到群更新事件回调 updateSuperTeam
- 所有群成员收到通知消息msg:
  - msg.type: 'notification'
  - msg.from: 操作者账号
  - msg.to: 群id
  - msg.attach.type: 'updateSuperTeam'
  - msg.attach.team: 群部分信息。包括了禁言相关信息
Parameters
- options: MuteSuperTeamOptions
Returns Promise<void>

muteSuperTeamMembers

muteSuperTeamMembers(options: MuteSuperTeamMembersOptions): Promise<void>

更新群成员禁言状态。只能禁言比之前权限更低的用户。
影响范围:
- 所有群成员收到 updateSuperTeamMembersMute 事件
- 所有群成员收到通知消息msg:
  - msg.type: 'notification'
  - msg.from: 操作者账号
  - msg.to: 群id
  - msg.attach.type: 'updateSuperTeamMemberMute'
  - msg.attach.account: 被禁言者账号
  - msg.attach.mute: 是否被禁言
Parameters
- options: MuteSuperTeamMembersOptions
Returns Promise<void>

passSuperTeamApply

passSuperTeamApply(options: PassSuperTeamApplyOptions): Promise<void>

（管理员）通过群申请
影响范围:
- 所有群成员收到 addSuperTeamMembers 事件
- 所有群成员收到群通知消息 msg
  - msg.type: 'notification'
  - msg.from: 通过申请者账号
  - msg.to: 群id
  - msg.attach.type: 'passSuperTeamApply'
  - msg.attach.account: 申请者账号
Parameters
- options: PassSuperTeamApplyOptions
Returns Promise<void>

queryMuteMembers

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

获取被禁言的群成员
关联函数
- SuperTeamServiceInterface.muteSuperTeamMembers
Parameters
- options: QueryMuteMembersOptions
Returns Promise<SuperTeamMember[]>

rejectSuperTeamApply

rejectSuperTeamApply(options: RejectSuperTeamApplyOptions): Promise<void>

（管理员）拒绝群申请

管理员收到 type 为 applySuperTeam 的 sysMsg 后，调用此接口拒绝群申请。

影响范围:

拒绝群申请后，申请者收到 type 为 'rejectSuperTeamApply' sysMsg 系统通知

Parameters
- options: RejectSuperTeamApplyOptions
Returns Promise<void>

rejectSuperTeamInvite

rejectSuperTeamInvite(options: RejectSuperTeamInviteOptions): Promise<void>

拒绝入群邀请
收到 type 为 'superTeamInvite' 的 sysMsg 后，调用此接口拒绝入群邀请。

影响范围:
- 邀请者收到 type 为 'rejectSuperTeamInvite' sysMsg 系统通知
Parameters
- options: RejectSuperTeamInviteOptions
Returns Promise<void>

removeSuperTeamManagers

removeSuperTeamManagers(options: RemmoveSuperTeamManagersOptions): Promise<void>

移除群管理员。只有群主有权限操作
影响范围:
- 所有群成员收到更新群管理员事件回调 updateSuperTeamManagers
- 所有群成员收到通知消息msg:
  - msg.type: 'notification'
  - msg.from: 群主账号
  - msg.to: 群id
  - msg.attach.type: 'removeSuperTeamManagers'
  - msg.attach.accounts: 被移除管理员账号
Parameters
- options: RemmoveSuperTeamManagersOptions
Returns Promise<void>

removeSuperTeamMembers

removeSuperTeamMembers(options: RemoveSuperTeamMembersOptions): Promise<void>

踢人出超级群
影响范围:
- 群成员收到 removeSuperTeamMembers 事件
- 群成员收到通知消息msg:
  - msg.type: 'notification'
  - msg.from: 踢人者id
  - msg.to: 群id
  - msg.attach.type: 'removeSuperTeamMembers'
  - msg.attach.accounts: 被踢者账号
Parameters
- options: RemoveSuperTeamMembersOptions
Returns Promise<void>

transferSuperTeam

transferSuperTeam(options: TransferSuperTeamOptions): Promise<void>

转让群, 群主可操作
影响范围:
- 所有群成员收到 transferSuperTeam 事件
- 所有群成员收到通知消息msg:
  - msg.type: 'notification'
  - msg.from: 原群主账号
  - msg.to: 群id
  - msg.attach.type: 'transferSuperTeam'
  - msg.attach.account: 新群主账号
若转让同时设置 leave 为 true，则相当于继续调用 SuperTeamServiceInterface.leaveSuperTeam 退群。
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>

修改自己在群里的信息
影响范围:
- 所有群成员会收群成员信息变更 updateSuperTeamMember
Parameters
- options: UpdateMyMemberInfoOptions
Returns Promise<SuperTeamMember>

updateSuperTeamInfo

updateSuperTeamInfo(options: UpdateSuperTeamInfoOptions): Promise<SuperTeam>

更新群基本信息
影响范围:
- 所有群成员收到 updateSuperTeam 事件
- 所有群成员收到通知消息msg:
  - msg.type: 'notification'
  - msg.from: 操作者账号
  - msg.to: 群id
  - msg.attach.type: 'updateSuperTeam'
  - msg.attach.team: 更新的群信息
Parameters
- options: UpdateSuperTeamInfoOptions
Returns Promise<SuperTeam>

Hierarchy

Index

Methods

Methods

acceptSuperTeamInvite

影响范围:

Parameters

options: AcceptSuperTeamInviteOptions

Returns Promise<void>

addSuperTeamManagers

影响范围:

Parameters

options: AddSuperTeamManagersOptions

Returns Promise<void>

addSuperTeamMembers

Parameters

options: AddSuperTeamMembersOptions

Returns Promise<void>

applySuperTeam

Parameters

options: ApplySuperTeamOptions

Returns Promise<SuperTeam>

getSuperTeamInfo

Parameters

options: { teamId: string }

teamId: string

Returns Promise<SuperTeam>

getSuperTeamMembers

Parameters

options: GetSuperTeamMembersOptions

Returns Promise<SuperTeamMember[]>

getSuperTeamMembersByAccounts

Parameters

options: GetSuperTeamMembersByAccountsOptions

Returns Promise<SuperTeamMember[]>

getSuperTeams

Returns Promise<SuperTeam[]>

leaveSuperTeam

影响范围:

Parameters

options: { teamId: string }

teamId: string

Returns Promise<void>

muteSuperTeam

影响范围:

Parameters

options: MuteSuperTeamOptions

Returns Promise<void>

muteSuperTeamMembers

影响范围:

Parameters

options: MuteSuperTeamMembersOptions

Returns Promise<void>

passSuperTeamApply

影响范围:

Parameters

options: PassSuperTeamApplyOptions

Returns Promise<void>

queryMuteMembers

关联函数

Parameters

options: QueryMuteMembersOptions

Returns Promise<SuperTeamMember[]>

rejectSuperTeamApply

影响范围:

Parameters

options: RejectSuperTeamApplyOptions

Returns Promise<void>

rejectSuperTeamInvite

影响范围:

Parameters

options: RejectSuperTeamInviteOptions

Returns Promise<void>

removeSuperTeamManagers

影响范围:

Parameters

options: RemmoveSuperTeamManagersOptions

Returns Promise<void>

removeSuperTeamMembers

影响范围: