Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TeamServiceInterface

调用方式:

nim.team.getTeamInfo(options)

Hierarchy

  • TeamServiceInterface

Index

Methods

Methods

acceptTeamInvite

  • 同意入群邀请。

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

    影响范围:
    • 所有群成员触发 addTeamMembers 事件
    • 所有群成员收到群通知消息 msg
      • msg.type: 'notification'
      • msg.from: 被邀请人账号
      • msg.to: 群id
      • msg.attach.type: 'acceptTeamInvite'
      • msg.attach.account: 邀请者账号

    Parameters

    Returns Promise<void>

addTeamManagers

  • 添加群管理员。只有群主有权限操作

    影响范围:
    • 所有群成员收到更新群管理员事件回调 updateTeamManagers
    • 所有群成员收到通知消息msg:
      • msg.type: 'notification'
      • msg.from: 群主账号
      • msg.to: 群id
      • msg.attach.type: 'addTeamManagers'
      • msg.attach.accounts: 新增管理员账号

    Parameters

    Returns Promise<void>

addTeamMembers

  • 添加群成员

    普通群：

    • 拉人入群后, 所有群成员会收到通知并触发事件 addTeamMembers
    • 被邀请的群成员先只有在群内成员发送消息后，才能够感知到自己已经入群。

    高级群：

    • 如果 beInviteMode: noVerify:
      • 所有群成员收到 addTeamMembers 事件
      • 被邀请人直接入群，所有群成员触发通知消息msg:
        • msg.type: 'notification'
        • msg.from: 操作者
        • msg.to: 被邀请者
        • msg.attach.type: 'addTeamMembers'
        • msg.attach.accounts: 被邀请者账号
    • 如果 beInviteMode: 'needVerify':

    Parameters

    Returns Promise<void>

applyTeam

  • 申请入群。根据 joinMode 不同，SDK会有不同的行为。

    • 如果 joinMode: noVerify:
      • 所有群成员收到新增成员事件回调 addTeamMembers
      • 所有群成员收到通知消息msg:
        • msg.type: 'notification'
        • msg.from: 申请者账号
        • msg.to: 群id
        • msg.attach.type: 'passTeamApply'
        • msg.attach.account: 申请者账号
    • 如果 joinMode: 'needVerify':
    • 如果 joinMode: 'rejectAll':
      • 调用此函数会抛出全局异常

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

    Parameters

    Returns Promise<Team>

createTeam

dismissTeam

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

  • 解散群，群主可操作

    影响范围:
    • 所有群成员收到群解散事件: dismissTeam
    • 所有群成员会收到通知消息msg:
      • msg.type: 'notification'
      • msg.from: 群主账号
      • msg.to: 群id
      • msg.attach.type: 'dismissTeam'

    Parameters

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

    Returns Promise<void>

getMutedTeamMembers

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

getTeamInfo

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

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

    Parameters

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

    Returns Promise<Team>

getTeamMemberInvitorAccid

getTeamMembers

getTeams

  • getTeams(): Promise<Team[]>

  • 获取群列表

    Returns Promise<Team[]>

getTeamsById

  • 根据群 ID 获取群列表

    Parameters

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

    Returns Promise<GetTeamsByIdResult>

leaveTeam

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

  • 主动退群。注意群主不能主动退群。若群主要退群，请使用 TeamServiceInterface.transferTeam 转让群并退群。

    影响范围:
    • 群成员收到 removeTeamMembers 事件
    • 群成员收到通知消息msg:
      • msg.type: 'notification'
      • msg.from: 退群者账号
      • msg.to: 群id
      • msg.attach.type: 'leaveTeam'
      • msg.attach.users: 退群者信息详情

    Parameters

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

    Returns Promise<void>

muteTeam

  • 群组全体禁言，或者取消禁言。只有管理员有权限操作

    影响范围:
    • 所有群成员收到群更新事件回调 updateTeam
    • 所有群成员收到通知消息msg:
      • msg.type: 'notification'
      • msg.from: 操作者账号
      • msg.to: 群id
      • msg.attach.type: 'updateTeam'
      • msg.attach.team: 群部分信息。包括了禁言相关信息

    示例场景

    Parameters

    Returns Promise<void>

muteTeamMember

  • 更新群成员禁言状态。只能禁言比之前权限更低的用户。

    影响范围:
    • 所有群成员收到 updateTeamMembersMute 事件
    • 所有群成员收到通知消息msg:
      • msg.type: 'notification'
      • msg.from: 操作者账号
      • msg.to: 群id
      • msg.attach.type: 'updateTeamMemberMute'
      • msg.attach.account: 被禁言者账号
      • msg.attach.mute: 是否被禁言

    示例场景

    Parameters

    Returns Promise<void>

passTeamApply

  • （管理员）通过群申请

    影响范围:
    • 所有群成员收到 addTeamMembers 事件
    • 所有群成员收到群通知消息 msg
      • msg.type: 'notification'
      • msg.from: 通过申请者账号
      • msg.to: 群id
      • msg.attach.type: 'passTeamApply'
      • msg.attach.account: 申请者账号

    Parameters

    Returns Promise<void>

rejectTeamApply

  • （管理员）拒绝群申请

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

    影响范围:

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

    Parameters

    Returns Promise<void>

rejectTeamInvite

removeTeamManagers

  • 移除群管理员。只有群主有权限操作

    影响范围:
    • 所有群成员收到更新群管理员事件回调 updateTeamManagers
    • 所有群成员收到通知消息msg:
      • msg.type: 'notification'
      • msg.from: 群主账号
      • msg.to: 群id
      • msg.attach.type: 'removeTeamManagers'
      • msg.attach.accounts: 被移除管理员账号

    Parameters

    Returns Promise<void>

removeTeamMembers

  • 踢人出群

    影响范围:
    • 群成员收到 removeTeamMembers 事件
    • 群成员收到通知消息msg:
      • msg.type: 'notification'
      • msg.from: 踢人者id
      • msg.to: 群id
      • msg.attach.type: 'removeTeamMembers'
      • msg.attach.accounts: 被踢者账号

    Parameters

    Returns Promise<void>

transferTeam

  • 转让群, 群主可操作

    影响范围:
    • 所有群成员收到 transferTeam 事件
    • 所有群成员收到通知消息msg:
      • msg.type: 'notification'
      • msg.from: 原群主账号
      • msg.to: 群id
      • msg.attach.type: 'transferTeam'
      • msg.attach.account: 新群主账号

    若转让同时设置 leave 为 true，则相当于继续调用 TeamServiceInterface.leaveTeam 退群。

    Parameters

    Returns Promise<void>

updateMemberNick

updateMyMemberInfo

updateTeamInfo

  • 更新群基本信息，普通群不允许更新。具体字段的含义请参考 createTeam

    影响范围:
    • 所有群成员收到 updateTeam 事件
    • 所有群成员收到通知消息msg:
      • msg.type: 'notification'
      • msg.from: 操作者账号
      • msg.to: 群id
      • msg.attach.type: 'updateTeam'
      • msg.attach.team: 更新的群信息

    Parameters

    Returns Promise<Partial<Team>>