Interface Team

Hierarchy

  • Team

Properties

announcement?: string

@Multi_Lang_Tag

Locale

cn 群公告

Locale

Locale

en Group announcement

Locale

avatar: string

@Multi_Lang_Tag

Locale

cn 群头像

Locale

Locale

en Group name

Locale

beInviteMode: TeamBeInviteMode

@Multi_Lang_Tag

Locale

cn 被邀请模式, 仅限高级群

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

Locale

Locale

en Invitee verification mode (only available for the advanced group)

noVerify: Verification not required. needVerify: After a group member invites a person to join the group, the person need to be verified by the group member before the person can join the group.

Locale

createTime: number

@Multi_Lang_Tag

Locale

cn 群创建时间戳

Locale

Locale

en Group creation timestamp

Locale

ext?: string

@Multi_Lang_Tag

Locale

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

Locale

Locale

en Third-party extension fields. You can extend by yourselves. It is recommended that you encapsulate them into JSON format strings.

Locale

intro?: string

@Multi_Lang_Tag

Locale

cn 群简介

Locale

Locale

en Group introduction

Locale

inviteMode: TeamInviteMode

@Multi_Lang_Tag

Locale

cn 群邀请模式, 仅限高级群

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

Locale

Locale

en Group invitation mode (only available for advanced groups)

manager: only group admins can invite people to join the group. all: everyone member can invite people to join the group.

Locale

joinMode: TeamJoinMode

@Multi_Lang_Tag

Locale

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

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

Locale

Locale

en Group joining method; only advanced groups have this attribute, normal groups (discussion groups) do not have this attribute

noVerify: Verification not required. needVerify: Verification is required before a person joins the group. rejectAll: rejects others to join the group.

Locale

level: number

@Multi_Lang_Tag

Locale

cn 群人数上限

Locale

Locale

en Maximum group size

Locale

memberNum: number

@Multi_Lang_Tag

Locale

cn 群成员数量

Locale

Locale

en Number of group members

Locale

memberUpdateTime: number

@Multi_Lang_Tag

Locale

cn 群成员最后更新时间戳

Locale

Locale

en Timestamp of the last update of group member

Locale

mute: boolean

Deprecated

Use muteType instead.

@Multi_Lang_Tag

Locale

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

Locale

Locale

en Whether to mute the group. If a group is muted, only group owners and admins can send messages.

Locale

muteType: string

@Multi_Lang_Tag

Locale

cn 禁言模式

none: 都不禁言;

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

all: 全体禁言,即所有成员均不能发消息禁言模式,包含群主

Locale

Locale

en Mute mode none: all members are unmuted. normal: ordinary members are muted. In other words, ordinary members cannot send messages. all: all members are muted. In other words, all members cannot send messages, including the group leader.

Locale

name: string

@Multi_Lang_Tag

Locale

cn 群名

Locale

Locale

en Group name

Locale

owner: string

@Multi_Lang_Tag

Locale

cn 群主

Locale

Locale

en Group owner

Locale

serverExt?: string

@Multi_Lang_Tag

Locale

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

Locale

Locale

en Third-party server extension fields. You can extend by yourselves. It is recommended that you encapsulate them into JSON format strings.

Locale

teamId: string

@Multi_Lang_Tag

Locale

cn 群Id

Locale

Locale

en Group ID

Locale

type: TeamType

@Multi_Lang_Tag

Locale

cn 群类型

normal 为普通群(讨论组) advanced 为 高级群

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

Locale

Locale

en Group type

normal: normal group (discussion group) advanced: advanced group

Note: Normal group has no attributes including group introduction, group announcement, group joining method, invitee verification mode, group invitation mode, group information modification permission, and the permission for modifying group information custom field.

Locale

updateExtMode: TeamUpdateExtMode

@Multi_Lang_Tag

Locale

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

manager 管理员 all 所有人

Locale

Locale

en Permission for modifying group information custom field (only available for advanced groups)

manager: only group admins can modify group information custom field. all: all members can modify group information custom field.

Locale

updateTeamMode: TeamUpdateTeamMode

@Multi_Lang_Tag

Locale

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

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

Locale

Locale

en Group information modification permission (only available for advanced groups)

manager: only group admins can modify group information all: all members can modify group information.

Locale

updateTime: number

@Multi_Lang_Tag

Locale

cn 群最后更新时间戳

Locale

Locale

en Timestamp of the last update of the group

Locale

valid: boolean

@Multi_Lang_Tag

Locale

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

Locale

Locale

en Whether it is valid or not, the group will be invalid after disbanding

Locale

validToCurrentUser: boolean

@Multi_Lang_Tag

Locale

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

Locale

Locale

en Whether the group is valid for the current user, if it is invalid, it means that the current user has been kicked

Locale

Generated using TypeDoc