Options
All
  • Public
  • Public/Protected
  • All
Menu

Module TeamServiceInterface

Index

Interfaces

Type Aliases

Type Aliases

AcceptTeamInviteOptions

AcceptTeamInviteOptions: { from: string; teamId: string }

Type declaration

  • from: string

    邀请者的 accountId

  • teamId: string

AddTeamManagersOptions

AddTeamManagersOptions: { accounts: string[]; teamId: string }

Type declaration

  • accounts: string[]
  • teamId: string

AddTeamMembersOptions

AddTeamMembersOptions: { accounts: string[]; ext?: string; ps?: string; teamId: string }

Type declaration

  • accounts: string[]
  • Optional ext?: string

    附加字段，推荐使用 JSON 格式字符串

  • Optional ps?: string

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

  • teamId: string

ApplyTeamOptions

ApplyTeamOptions: { ps?: string; teamId: string }

Type declaration

  • Optional ps?: string

    附言

  • teamId: string

CreateTeamOptions

CreateTeamOptions: { accounts?: string[]; announcement?: string; avatar?: string; beInviteMode?: TeamBeInviteMode; ext?: string; intro?: string; inviteMode?: TeamInviteMode; joinMode?: TeamJoinMode; level?: number; name: string; ps?: string; type: TeamType; updateExtMode?: TeamUpdateExtMode; updateTeamMode?: TeamUpdateTeamMode }

Type declaration

  • Optional accounts?: string[]

    要拉进群的成员的帐号列表

  • Optional announcement?: string

    群公告

  • Optional avatar?: string

    群头像

  • Optional beInviteMode?: TeamBeInviteMode

    群被邀请模式

  • Optional ext?: string

    扩展字段

  • Optional intro?: string

    群简介

  • Optional inviteMode?: TeamInviteMode

    群邀请模式

  • Optional joinMode?: TeamJoinMode

    群加入方式

  • Optional level?: number

    群等级，即人数上限

  • name: string

    群名

  • Optional ps?: string

    拉人附言

  • type: TeamType

    群类型

  • Optional updateExtMode?: TeamUpdateExtMode

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

  • Optional updateTeamMode?: TeamUpdateTeamMode

    群信息修改权限

GetTeamMemberInvitorAccidOptions

GetTeamMemberInvitorAccidOptions: { accounts: string[]; teamId: string }

Type declaration

  • accounts: string[]

    需要查询邀请者accid的群成员账号列表，一次最多查200个。

    当群成员数量小于等于200时为可选参数，不填默认查全部成员； 群成员数量大于200时，需要将成员列表分批多次调用此接口查询

  • teamId: string

GetTeamMemberInvitorAccidResult

GetTeamMemberInvitorAccidResult: {}

key 是群成员的 accid，value 是邀请者的 accid

Type declaration

  • [key: string]: string

GetTeamMembersOptions

GetTeamMembersOptions: { accounts?: string[]; teamId: string }

Type declaration

  • Optional accounts?: string[]
  • teamId: string

GetTeamsByIdResult

GetTeamsByIdResult: { teams: Team[]; tids: string[] }

Type declaration

  • teams: Team[]

    获取到的群

  • tids: string[]

    获取不到信息的群 id

MuteTeamMemberOptions

MuteTeamMemberOptions: { account: string; mute: boolean; teamId: string }

Type declaration

  • account: string
  • mute: boolean

    是否要禁言

  • teamId: string

MuteTeamOptions

MuteTeamOptions: { mute: boolean; teamId: string }

Type declaration

  • mute: boolean

    是否禁言

  • teamId: string

PassTeamApplyOptions

PassTeamApplyOptions: { from: string; teamId: string }

Type declaration

  • from: string

    申请者的 accountId

  • teamId: string

RejectTeamApplyOptions

RejectTeamApplyOptions: { from: string; ps?: string; teamId: string }

Type declaration

  • from: string

    申请者的 accountId

  • Optional ps?: string

    附加信息

  • teamId: string

RejectTeamInviteOptions

RejectTeamInviteOptions: { from: string; ps?: string; teamId: string }

Type declaration

  • from: string

    邀请者的 accountId

  • Optional ps?: string

    附加信息

  • teamId: string

RemmoveTeamManagersOptions

RemmoveTeamManagersOptions: { accounts: string[]; teamId: string }

Type declaration

  • accounts: string[]
  • teamId: string

RemoveTeamMembersOptions

RemoveTeamMembersOptions: { accounts: string[]; teamId: string }

Type declaration

  • accounts: string[]
  • teamId: string

Team

Team: { announcement?: string; avatar: string; beInviteMode: TeamBeInviteMode; createTime: number; ext?: string; intro?: string; inviteMode: TeamInviteMode; joinMode: TeamJoinMode; level: number; memberNum: number; memberUpdateTime: number; mute: boolean; muteType: string; name: string; owner: string; serverExt?: string; teamId: string; type: TeamType; updateExtMode: TeamUpdateExtMode; updateTeamMode: TeamUpdateTeamMode; updateTime: number; valid: boolean; validToCurrentUser: boolean }

Type declaration

  • Optional announcement?: string

    群公告

  • avatar: string

    群头像

  • beInviteMode: TeamBeInviteMode

    被邀请模式, 仅限高级群

    noVerify 不需要验证 needVerify 此群邀请某人，需要此人验证通过才能加入

  • createTime: number

    群创建时间戳

  • Optional ext?: string

    第三方扩展字段, 开发者可以自行扩展, 建议封装成JSON格式字符串 通 IM1 的 custom 字段。统一改叫 ext

  • Optional intro?: string

    群简介

  • inviteMode: TeamInviteMode

    群邀请模式, 仅限高级群

    manager 管理员。仅限管理员可以邀请人进群 all 所有人。所有人都可以邀请人进群

  • joinMode: TeamJoinMode

    群加入方式, 仅限高级群有此属性，普通群(讨论组)没有

    noVerify 不需要验证 needVerify 加此群需要相关人员的验证 rejectAll 拒绝其他人加入

  • level: number

    群人数上限

  • memberNum: number

    群成员数量

  • memberUpdateTime: number

    群成员最后更新时间戳

  • mute: boolean

    是否禁言, 禁言状态下普通成员不能发送消息, 创建者和管理员可以发送消息

  • muteType: string

    禁言模式

    none: 都不禁言;

    normal: 普通成员禁言，即普通成员不能发消息;

    all: 全体禁言，即所有成员均不能发消息禁言模式

  • name: string

    群名

  • owner: string

    群主

  • Optional serverExt?: string

    第三方服务器扩展字段, 开发者可以自行扩展, 建议封装成JSON格式字符串 通 IM1 的 serverCustom 字段。统一改叫 serverExt

  • teamId: string

    群Id

  • type: TeamType

    群类型

    normal 为普通群（讨论组） advanced 为 高级群

    注：普通群没有群简介/群公告/群加入方式/群被邀请模式/群邀请模式/群信息修改权限/群信息自定义字段修改权限

  • updateExtMode: TeamUpdateExtMode

    群信息自定义字段修改权限, 仅限高级群

    manager 管理员 all 所有人

  • updateTeamMode: TeamUpdateTeamMode

    群信息修改权限, 仅限高级群

    manager 管理员。仅限管理员可以修改群信息 all 所有人

  • updateTime: number

    群最后更新时间戳

  • valid: boolean

    是否有效, 解散后该群无效

  • validToCurrentUser: boolean

    该群是否对当前用户有效, 如果无效, 那么说明被踢了

TeamBeInviteMode

TeamBeInviteMode: "noVerify" | "needVerify"

被邀请模式, 仅限高级群

noVerify 不需要验证 needVerify 此群邀请某人，需要此人验证通过才能加入

TeamInviteMode

TeamInviteMode: "manager" | "all"

群邀请模式, 仅限高级群

manager 管理员。仅限管理员可以邀请人进群 all 所有人。所有人都可以邀请人进群

TeamJoinMode

TeamJoinMode: "noVerify" | "needVerify" | "rejectAll"

群加入方式, 仅限高级群有此属性，普通群(讨论组)没有

noVerify 不需要验证 needVerify 加此群需要相关人员的验证 rejectAll 拒绝其他人加入

TeamMember

TeamMember: { account: string; active: boolean; bitConfigMask?: number; ext?: string; id: string; joinTime: number; mute?: boolean; muteTeam?: boolean; nickInTeam: string; teamId: string; type: TeamMemberType; updateTime: number; valid: boolean }

Type declaration

  • account: string

    帐号

  • active: boolean

    普通群拉人进来的时候, 被拉的人处于未激活状态, 未激活状态下看不到这个群, 当有人说话后自动转为激活状态, 能看到该群

  • Optional bitConfigMask?: number

    提醒策略

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

  • Optional ext?: string

    第三方扩展字段

  • id: string

    群成员的 id 标识（teamId + account）

  • joinTime: number

    入群时间

  • Optional mute?: boolean

    是否被禁言

  • Optional muteTeam?: boolean

    是否关闭此群的消息提醒, true表示关闭提醒, 但是SDK仍然会收到这个群的消息, SDK只是记录这个设置, 具体根据这个设置要执行的操作由第三方APP决定

  • nickInTeam: string

    在群里面的昵称

  • teamId: string

    群ID

  • type: TeamMemberType

    群成员类型

    'normal' (普通成员) 'owner' (群主) 'manager' (管理员)

  • updateTime: number

    更新时间

  • valid: boolean

    群成员是否有效

TeamMemberType

TeamMemberType: "normal" | "owner" | "manager" | "apply" | "applyReject"

TeamType

TeamType: "normal" | "advanced"

群类型

normal 为普通群（讨论组） advanced 为 高级群

注：普通群没有群简介/群公告/群加入方式/群被邀请模式/群邀请模式/群信息修改权限/群信息自定义字段修改权限

TeamUpdateExtMode

TeamUpdateExtMode: "manager" | "all"

群信息自定义字段修改权限, 仅限高级群

manager 管理员 all 所有人

TeamUpdateTeamMode

TeamUpdateTeamMode: "manager" | "all"

群信息修改权限, 仅限高级群

manager 管理员。仅限管理员可以修改群信息 all 所有人

TransferTeamOptions

TransferTeamOptions: { account: string; leave: boolean; teamId: string }

Type declaration

  • account: string
  • leave: boolean

    转让群的同时是否离开群

  • teamId: string

UpdateMemberNickOptions

UpdateMemberNickOptions: { account: string; nickInTeam: string; teamId: string }

Type declaration

  • account: string
  • nickInTeam: string
  • teamId: string

UpdateMyMemberInfoOptions

UpdateMyMemberInfoOptions: { bitConfigMask?: number; ext?: string; muteTeam?: boolean; nickInTeam?: string; teamId: string }

Type declaration

  • Optional bitConfigMask?: number

    提醒策略

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

  • Optional ext?: string

    扩展字段

  • Optional muteTeam?: boolean

    是否关闭此群的消息提醒, true表示关闭提醒, 但是SDK仍然会收到这个群的消息, SDK只是记录这个设置, 具体根据这个设置要执行的操作由第三方APP决定

  • Optional nickInTeam?: string

    在群里的昵称

    注: 修改此字段后, 所有其它在线的群成员会收到事件 updateTeamMember 。

  • teamId: string

UpdateTeamInfoOptions

UpdateTeamInfoOptions: { announcement?: string; avatar?: string; beInviteMode?: TeamBeInviteMode; ext?: string; intro?: string; inviteMode?: TeamInviteMode; joinMode?: TeamJoinMode; name?: string; teamId: string; updateExtMode?: TeamUpdateExtMode; updateTeamMode?: TeamUpdateTeamMode }

Type declaration

  • Optional announcement?: string

    群公告

  • Optional avatar?: string

    群头像

  • Optional beInviteMode?: TeamBeInviteMode

    群被邀请模式

  • Optional ext?: string

    扩展字段

  • Optional intro?: string

    群简介

  • Optional inviteMode?: TeamInviteMode

    群邀请模式

  • Optional joinMode?: TeamJoinMode

    群加入方式

  • Optional name?: string

    群名

  • teamId: string

    群 id

  • Optional updateExtMode?: TeamUpdateExtMode

    群信息自定义字段修改权限 通 IM1 的 updateCustomMode

  • Optional updateTeamMode?: TeamUpdateTeamMode

    群信息修改权限