Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SuperTeamInterface

超级群服务 API 定义

注：超级群需要额外开通

Hierarchy

  • SuperTeamInterface

Implemented by

Index

Methods

Methods

acceptSuperTeamInvite

  • acceptSuperTeamInvite(options: { from: string; idServer: string; teamId: string; done?: any }): void

  • 同意入群邀请 SuperTeamInterface.addSuperTeamMembers

    群主和管理员邀请成员加入群(addSuperTeamMembers), 被邀请的人收到类型为superTeamInvite的系统通知

    • 若接受入群邀请, 该群所有成员收到类型为 acceptSuperTeamInvite 的群通知消息，通知消息具体内容见下文
    • 若拒绝入群邀请, 邀请你的人会收到类型为 rejectSuperTeamInvite 的系统通知, 此系统通知的 from 字段的值为拒绝入群邀请的人的帐号, to 字段的值为对应的 群ID

    用户接受入群邀请后：

    1. 所有群成员收到群通知消息: onmsg:
      • msg.type: 'notification'
      • msg.from: 邀请人账号
      • msg.to: 群id
      • msg.attach.type: 'acceptSuperTeamInvite'
      • msg.attach.team: 群信息
      • msg.attach.members: 接收入群邀请的群成员列表
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onAddSuperTeamMembers
    4. 函数调用者触发 onupdatesysmsg

    关联函数

    Parameters

    • options: { from: string; idServer: string; teamId: string; done?: any }
      • from: string

        申请者的 accountId

      • idServer: string

        管理员邀请此用户进群的系统通知的 idServer

      • teamId: string
      • done?:function

    Returns void

addSuperTeamManagers

  • addSuperTeamManagers(options: { accounts: string[]; teamId: string; done?: any }): void

  • 添加超级群管理员

    添加管理员后:

    1. 所有群成员收到群通知消息 onmsg:
      • msg.type: 'notification'
      • msg.from: 添加管理员的操作者
      • msg.to: 群id
      • msg.attach.type: 'addSuperTeamManagers'
      • msg.attach.accounts: 被加为管理员的账号列表
      • msg.attach.members: 被加为管理员的群成员详细信息列表
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onUpdateSuperTeamManagers

    Parameters

    Returns void

addSuperTeamMembers

  • addSuperTeamMembers(options: { accounts: string[]; custom?: string; ps?: string; teamId: string; done?: any }): void

  • 添加超级群成员

    • 如果 inviteMode: 'noVerify':
    1. 被邀请人直接进群，所有群成员触发 onmsg:
      • msg.type: 'notification'
      • msg.from: 邀请人账号
      • msg.to: 群id
      • msg.attach.type: 'addSuperTeamMembers'
      • msg.attach.team: 群详细信息
      • msg.attach.members: 被邀请入群成员详细信息列表
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onAddSuperTeamMembers
    • 如果 inviteMode: 'needVerify'
    1. 被邀请者触发 onsysmsg，其 type 为 'superTeamInvite'。被邀请者通过 acceptSuperTeamInvite 或者 rejectSuperTeamInvite回应入群邀请

    Parameters

    • options: { accounts: string[]; custom?: string; ps?: string; teamId: string; done?: any }
      • accounts: string[]

        要加入的用户账号列表

      • Optional custom?: string

        附加字段，推荐使用 JSON 序列化字符串

      • Optional ps?: string

        附言，长度不得大于 5000 字符，开发者可以使用 JSON 序列化字符串填充

      • teamId: string
      • done?:function

    Returns void

applySuperTeam

  • applySuperTeam(options: { ps?: string; teamId: string; done?: any }): void

  • 用户主动申请加入超级群。根据 joinMode 不同，SDK 有不同的行为

    • 如果 joinMode: 'noVerify':
    1. 所有群成员触发 onmsg:
      • msg.type: 'notification'
      • msg.from: 申请人账号
      • msg.to: 群id
      • msg.attach.type: 'passSuperTeamApply'
      • msg.attach.account: 申请人账号
      • msg.attach.members: 被通过申请的群成员列表
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onAddSuperTeamMembers
    • 如果 joinMode: 'needVerify'
    1. 管理员触发 onsysmsg，其 type 为 'applySuperTeam'。管理员通过 passSuperTeamApply 或者 rejectSuperTeamApply回应入群申请
    • 如果 joinMode: 'rejectAll'
    1. 收到申请入群失败的error信息

    Parameters

    Returns void

getAllSuperTeamMembers

  • getAllSuperTeamMembers(options: { teamId: string; done?: any }): void

getMutedSuperTeamMembers

  • getMutedSuperTeamMembers(options: { joinTime?: number; limit?: number; reverse?: boolean; teamId: string; done?: any }): void

  • 获取群禁言成员列表。该函数结果受 SuperTeamInterface.updateSuperTeamMembersMute 影响

    Parameters

    • options: { joinTime?: number; limit?: number; reverse?: boolean; teamId: string; done?: any }
      • Optional joinTime?: number

        加入时间.

        注: 如果传入这个参数, 获取在这个时间之后加入的成员, 不传则不限制

      • Optional limit?: number

        分页限制, 默认 100, 返回 100 条数据

      • Optional reverse?: boolean

        查询顺序。默认 false

        false 即查询 joinTime 之后加入的成员

        true 即查询 joinTime 之前加入的成员

      • teamId: string
      • done?:function

    Returns void

getMySuperTeamMembers

  • getMySuperTeamMembers(options: { teamIds: string[]; done: any }): void

getSuperTeam

  • getSuperTeam(options: { teamId: string; done: any }): void

getSuperTeamMembersByAccounts

  • getSuperTeamMembersByAccounts(options: { accounts: string[]; teamId: string; done?: any }): void

  • 查询超级群内，若干个账号的详细信息

    Parameters

    • options: { accounts: string[]; teamId: string; done?: any }
      • accounts: string[]

        待查询 account ID 列表

      • teamId: string
      • done?:function

        • Parameters

          Returns void

    Returns void

getSuperTeamMembersByJoinTime

  • getSuperTeamMembersByJoinTime(options: { joinTime?: number; limit?: number; reverse?: boolean; teamId: string; done?: any }): void

  • 根据进群时间，分页获取超大群成员

    Parameters

    • options: { joinTime?: number; limit?: number; reverse?: boolean; teamId: string; done?: any }
      • Optional joinTime?: number

        加入时间.

        注: 如果传入这个参数, 获取在这个时间之后加入的成员, 不传则不限制

      • Optional limit?: number

        分页限制, 默认 100, 返回 100 条数据

      • Optional reverse?: boolean

        查询顺序。默认 false

        false 即查询 joinTime 之后加入的成员

        true 即查询 joinTime 之前加入的成员

      • teamId: string
      • done?:function

    Returns void

getSuperTeams

  • getSuperTeams(options: { done?: any }): void

  • 获取超级群列表。如果开发者在初始化SDK的时候设置了syncSuperTeams为false, 那么就收不到onSuperTeams回调, 可以调用此接口来获取超大群列表

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

    Parameters

    Returns void

leaveSuperTeam

  • leaveSuperTeam(options: { teamId: string; done?: any }): void

passSuperTeamApply

  • passSuperTeamApply(options: { from: string; idServer: string; teamId: string; done?: any }): void

  • （管理员）通过超级群申请

    通过入群申请后：

    1. 所有群成员触发 onmsg:
      • msg.type: 'notification'
      • msg.from: 操作者账号
      • msg.to: 群id
      • msg.attach.type: 'passSuperTeamApply'
      • msg.attach.account: 申请方账号
      • msg.attach.members: 被通过申请的群成员列表
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onAddSuperTeamMembers
    4. 函数调用者触发 onupdatesysmsg

    Parameters

    • options: { from: string; idServer: string; teamId: string; done?: any }

    Returns void

rejectSuperTeamApply

  • rejectSuperTeamApply(options: { from: string; idServer: string; ps?: string; teamId: string; done?: any }): void

  • 管理员拒绝超级群申请

    拒绝群申请后 :

    • 申请者会收到系统通知 onsysmsg
      • from: 拒绝方的账号
      • to: 群id
      • attach: 群信息
    • 函数调用者触发 onupdatesysmsg

    Parameters

    • options: { from: string; idServer: string; ps?: string; teamId: string; done?: any }
      • from: string

        申请者的 accountId

      • idServer: string

        用户申请进群的系统通知的 idServer

      • Optional ps?: string

        附加信息

      • teamId: string
      • done?:function

    Returns void

rejectSuperTeamInvite

  • rejectSuperTeamInvite(options: { from: string; idServer: string; ps?: string; teamId: string; done?: any }): void

  • 拒绝入群邀请

    用户拒绝群邀请后:

    • 邀请者会收到系统通知 onsysmsg
      • type: 'rejectSuperTeamInvite'
      • from: 拒绝入群邀请的账号
      • to: 群id
    • 函数调用者触发 onupdatesysmsg

    Parameters

    • options: { from: string; idServer: string; ps?: string; teamId: string; done?: any }
      • from: string

        申请者的 accountId

      • idServer: string

        管理员邀请此用户进群的系统通知的 idServer

      • Optional ps?: string

        附加信息

      • teamId: string
      • done?:function

    Returns void

removeSuperTeamManagers

  • removeSuperTeamManagers(options: { accounts: string[]; teamId: string; done?: any }): void

  • 移除超级群管理员

    添加管理员后:

    1. 所有群成员触发 onmsg:
      • msg.type: 'notification'
      • msg.from: 移除者账号
      • msg.to: 群id
      • msg.attach.type: 'removeSuperTeamManagers'
      • msg.attach.accounts: 被移除的管理员的帐号列表
      • msg.attach.members: 被移除管理员的群成员列表
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onUpdateSuperTeamManagers

    Parameters

    Returns void

removeSuperTeamMembers

  • removeSuperTeamMembers(options: { accounts: string[]; teamId: string; done?: any }): void

  • 踢人出超级群

    1. 所有群成员触发 onmsg:
      • msg.type: 'notification'
      • msg.from: 操作者账号
      • msg.to: 群id
      • msg.attach.type: 'removeSuperTeamMembers'
      • msg.attach.team: 群详情
      • msg.attach.accounts: 被踢人的账号数组
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onRemoveSuperTeamMembers

    Parameters

    • options: { accounts: string[]; teamId: string; done?: any }

    Returns void

transferSuperTeam

  • transferSuperTeam(options: { account: string; leave: boolean; teamId: string; done?: any }): void

  • 转让超级群, 群主可操作

    • 转让超级群相关通知
    1. 所有群成员触发 onmsg:
      • msg.type: 'notification'
      • msg.from: 转让者账号
      • msg.to: 群id
      • msg.attach.type: 'transferSuperTeam'
      • msg.attach.team: 群详情
      • msg.attach.account: 新群主账号
      • msg.attach.members: 新旧群主成员详情列表
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onTransferSuperTeam
    • 如果转让群的同时离开群, 那么相当于调用主动退群来离开群
    1. 所有群成员触发 onmsg:
      • msg.type: 'notification'
      • msg.attach.type: 'leaveSuperTeam'
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onRemoveSuperTeamMembers

    Parameters

    • options: { account: string; leave: boolean; teamId: string; done?: any }

    Returns void

updateInfoInSuperTeam

  • updateInfoInSuperTeam(options: { custom?: string; muteNotiType?: string; muteTeam?: boolean; nickInTeam?: string; teamId: string; done?: any }): void

  • 修改自己在超级群里的信息

    Parameters

    • options: { custom?: string; muteNotiType?: string; muteTeam?: boolean; nickInTeam?: string; teamId: string; done?: any }
      • Optional custom?: string

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

      • Optional muteNotiType?: string

        提醒策略

        "0" 开启提醒 "1" 关闭消息提醒 "2" 只接受管理员的消息的提醒

      • Optional muteTeam?: boolean
        deprecated

        use "muteNotiType" instead

        是否关闭此群的消息提醒, 默认 false.

        注: 为 true 表示关闭提醒, 但是 SDK 仍然会收到这个群的消息. 因为 SDK 只是记录这个设置, 具体根据这个设置要执行的操作由开发者决定

      • Optional nickInTeam?: string

        在群里的昵称

        注: 更新昵称后, 所有其它在线的群成员会收到 onUpdateSuperTeamMember 。

      • teamId: string
      • done?:function

    Returns void

updateNickInSuperTeam

  • updateNickInSuperTeam(options: { account: string; nickInTeam: string; teamId: string; done?: any }): void

updateSuperTeam

  • updateSuperTeam(options: { announcement?: string; antiSpamBusinessId?: string; avatar?: string; beInviteMode?: "noVerify" | "needVerify"; custom?: string; intro?: string; inviteMode?: "manager" | "all"; joinMode?: "noVerify" | "needVerify" | "rejectAll"; name: string; teamId: string; updateCustomMode?: "manager" | "all"; updateTeamMode?: "manager" | "all"; done?: any }): void

  • 更新超级群属性

    1. 所有群成员触发 onmsg:
      • msg.type: 'notification'
      • msg.from: 操作者账号
      • msg.to: 群id
      • msg.attach.type: 'updateSuperTeam'
      • msg.attach.team: 群详情
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onUpdateSuperTeam

    Parameters

    • options: { announcement?: string; antiSpamBusinessId?: string; avatar?: string; beInviteMode?: "noVerify" | "needVerify"; custom?: string; intro?: string; inviteMode?: "manager" | "all"; joinMode?: "noVerify" | "needVerify" | "rejectAll"; name: string; teamId: string; updateCustomMode?: "manager" | "all"; updateTeamMode?: "manager" | "all"; done?: any }
      • Optional announcement?: string

        群公告

      • Optional antiSpamBusinessId?: string

        对某些资料内容进行反垃圾处理的业务 ID, 在云信控制台里配置.

      • Optional avatar?: string

        群头像

      • Optional beInviteMode?: "noVerify" | "needVerify"

        群被邀请模式

      • Optional custom?: string

        扩展字段

      • Optional intro?: string

        群简介

      • Optional inviteMode?: "manager" | "all"

        群邀请模式

      • Optional joinMode?: "noVerify" | "needVerify" | "rejectAll"

        群加入方式

      • name: string

        群名

      • teamId: string

        群 ID

      • Optional updateCustomMode?: "manager" | "all"

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

      • Optional updateTeamMode?: "manager" | "all"

        群信息修改权限

      • done?:function

    Returns void

updateSuperTeamMembersMute

  • updateSuperTeamMembersMute(options: { account: string; mute: boolean; teamId: string; done?: any }): void

  • 更新超级群成员禁言状态

    1. 所有群成员触发 onmsg:

      • msg.type: 'notification'
      • msg.from: 操作方
      • msg.to: 群id
      • msg.attach.type: 'updateSuperTeamMembersMute'
      • msg.attach.team: 群详情
      • msg.attach.account: 被禁言的帐号
      • msg.attach.members: 被禁言的群成员列表

    2. 所有群成员触发 onupdatesessions

    3. 所有群成员触发 onUpdateSuperTeamMembersMute

    Parameters

    • options: { account: string; mute: boolean; teamId: string; done?: any }

    Returns void

updateSuperTeamMute

  • updateSuperTeamMute(options: { mute: boolean; teamId: string; done?: any }): void

  • 超级群全体禁言

    1. 所有群成员触发 onmsg:
      • msg.type: 'notification'
      • msg.from: 操作者账号
      • msg.to: 群id
      • msg.attach.type: 'updateSuperTeam'
      • msg.attach.team: 群详情
    2. 所有群成员触发 onupdatesessions
    3. 所有群成员触发 onUpdateSuperTeam

    Parameters

    Returns void