Options
All
  • Public
  • Public/Protected
  • All
Menu

@xkit-yx/im-store

Index

References

Renames and re-exports RootStore

Type Aliases

AcceptTeamInviteOptions: { from: string; teamId: string }

Type declaration

  • from: string
    multi_lang_tag
    locale

    cn 邀请者的 accountId

    locale
    locale

    en accountId of the inviter

    locale
  • teamId: string
ContactType: "blackList" | "groupList" | "friendList" | "msgList"
DeleteSelfMsgsResult: { deletedTime: number; from: string; idClient: string; idServer: string; scene: "p2p" | "team"; time: number; to: string }

Type declaration

  • deletedTime: number
    multi_lang_tag
    locale

    cn 删除时间

    locale
    locale

    en Deletion time

    locale
  • from: string
    multi_lang_tag
    locale

    cn 此消息的发送者

    locale
    locale

    en Sender of the message

    locale
  • idClient: string
    multi_lang_tag
    locale

    cn 此消息的 idClient

    locale
    locale

    en idClient of the message

    locale
  • idServer: string
    multi_lang_tag
    locale

    cn 此消息的 idServer

    locale
    locale

    en idServer of the message

    locale
  • scene: "p2p" | "team"
    multi_lang_tag
    locale

    cn 此消息的场景,只有 p2p, team ,超大群暂时不允许单向删除

    locale
    locale

    en The message is only allowed to be one-way deleted in one-to-one chat and group chat (normal group). One-way deletion is not allowed in super groups.

    locale
  • time: number
    multi_lang_tag
    locale

    cn 此消息的发送时间

    locale
    locale

    en When this message was sent

    locale
  • to: string
    multi_lang_tag
    locale

    cn 此消息的接收者

    locale
    locale

    en Recipient of this message

    locale
FriendProfile: { account: string; alias?: string; bitsExtension?: number; createTime: number; ext?: string; passRelationShip?: FriendProfilePassRelationShip; relationShip?: FriendProfileRelationShip; serverex?: string; source?: number; updateTime: number; valid: boolean }

Type declaration

  • account: string
    multi_lang_tag
    locale

    cn 账号 accid

    locale
    locale

    en Account (accid)

    locale
  • Optional alias?: string
    multi_lang_tag
    locale

    cn 备注

    locale
    locale

    en Alias

    locale
  • Optional bitsExtension?: number
    multi_lang_tag
    locale

    cn 位运算扩展

    locale
    locale

    en Bit operation extension

    locale
  • createTime: number
  • Optional ext?: string
    multi_lang_tag
    locale

    cn 扩展字段

    locale
    locale

    en Extension field

    locale
  • Optional passRelationShip?: FriendProfilePassRelationShip
    multi_lang_tag
    locale

    cn 被动好友关系(加此好友的验证类型)

    locale
    locale

    en Verification type for adding the person as a friend

    locale
  • Optional relationShip?: FriendProfileRelationShip
    multi_lang_tag
    locale

    cn 主动好友关系(好友状态)

    locale
    locale

    en Friend status

    locale
  • Optional serverex?: string
    multi_lang_tag
    locale

    cn 服务端扩展字段,此字段客户端 sdk 只读,服务端 api 读写

    locale
    locale

    en Server extension field. For the client SDK, the field is read-only; for the server APIs, the field can be read and written.

    locale
  • Optional source?: number
    multi_lang_tag
    locale

    cn 此好友来源,默认 0

    locale
    locale

    en This friend source, default 0

    locale
  • updateTime: number
  • valid: boolean
    multi_lang_tag
    locale

    cn 是否有效,默认 true。为 true 代表是双方是彼此的朋友

    locale
    locale

    en Whether it is valid. A value of true indicates the two accounts are friends to each other.

    locale
GetHistoryMsgsOptions: { asc?: boolean; beginTime?: number; endTime?: number; lastMsgId?: string; limit?: number; msgTypes?: TMsgType[]; reverse?: boolean; scene: TMsgScene; to: string }

Type declaration

  • Optional asc?: boolean
    multi_lang_tag
    locale

    cn 是否为升序排序

    false 表示返回的消息按时间降序排序; true 表示按时间升序排序

    locale
    locale

    en Whether to sort in ascending order

    false: the returned messages are sorted in descending order by time. true: the returned messages are sorted in ascending order by time.

    locale
  • Optional beginTime?: number
    multi_lang_tag
    locale

    cn 开始时间戳, 精确到 ms, 默认为 0

    locale
    locale

    en Start timestamp (accurate to ms). Default value: 0

    locale
  • Optional endTime?: number
    multi_lang_tag
    locale

    cn 结束时间戳, 精确到 ms, 默认为服务器的当前时间

    locale
    locale

    en End timestamp (accurate to ms). Defaults value: the server's current time

    locale
  • Optional lastMsgId?: string
    multi_lang_tag
    locale

    cn 上次查询的最后一条消息的 idServer, 第一次不填

    locale
    locale

    en Message ID (generated by the IM server) of the last message that was searched for. Not required for the first time.

    locale
  • Optional limit?: number
    multi_lang_tag
    locale

    cn 本次查询的消息数量限制, 最多 100 条, 默认 100 条

    locale
    locale

    en The limit (100) of the number of messages for the current query. The default value is also 100.

    locale
  • Optional msgTypes?: TMsgType[]
    multi_lang_tag
    locale

    cn 消息类型列表,默认全部消息类型

    locale
    locale

    en Message types. Default value: all message types

    locale
  • Optional reverse?: boolean
    multi_lang_tag
    locale

    cn 是否为反向查询,默认 false

    false 表示从 endTime 开始往前查找历史消息; true 表示从 beginTime 开始往后查找历史消息

    locale
    locale

    en Whether to sort in ascending order

    false: the returned messages are sorted in descending order by time. true: the returned messages are sorted in ascending order by time.

    locale
  • scene: TMsgScene
    multi_lang_tag
    locale

    cn 场景

    locale
    locale

    en Scenes

    locale
  • to: string
    multi_lang_tag
    locale

    cn 聊天对象, 账号或者群id

    locale
    locale

    en The person that the user chats with, account, or group ID

    locale
IMEventSyncFriendResult: { account?: string; friend?: FriendProfile; type: string }

Type declaration

  • Optional account?: string
  • Optional friend?: FriendProfile
  • type: string
IMMessage: { antiSpamInfo?: TMsgAntiSpamInfo; attach?: StrAnyObj; body: string; callbackExt?: string; ext?: string; feature: TMsgFeature; flow: "in" | "out"; from: string; fromClientType?: TClientType; fromDeviceId?: string; fromNick?: string; idClient: string; idServer?: string; pushInfo?: TMsgPushInfo; scene: TMsgScene; sessionId: string; setting?: TMsgSetting; status: TMsgStatus; subType?: number; target: string; teamSpecializationInfo?: TMsgTeamSpecializationInfo; threadMessageInfo?: TMsgThreadMsgInfo; time: number; to: string; type: TMsgType; userUpdateTime: number }

Type declaration

  • Optional antiSpamInfo?: TMsgAntiSpamInfo
    multi_lang_tag
    locale

    cn 反垃圾相关配置

    locale
    locale

    en Moderation configurations

    locale
  • Optional attach?: StrAnyObj
    multi_lang_tag
    locale

    cn 附加消息

    像是 file,geo 类型的消息,文本内容为空,在附加消息里会存在一个对象代表其内容

    locale
    locale

    en Additional message

    For file and geolocation messages, the text content is empty. Instead, there will be an object in the additional message to represent its content

    locale
  • body: string
    multi_lang_tag
    locale

    cn 消息的文本内容

    locale
    locale

    en Text content of the message

    locale
  • Optional callbackExt?: string
    multi_lang_tag
    locale

    cn 服务器第三方回调的扩展字段

    locale
    locale

    en Extension fields for server’s third-party callbacks

    locale
  • Optional ext?: string
    multi_lang_tag
    locale

    cn 扩展字段

    locale
    locale

    en Extension field

    locale
  • feature: TMsgFeature
    multi_lang_tag
    locale

    cn 通知属性

    locale
    locale

    en Notification attributes

    locale
  • flow: "in" | "out"
    multi_lang_tag
    locale

    cn 消息的流向

    in 表示此消息是收到的消息 out 表示此消息是发出的消息

    locale
    locale

    en The flow of messages

    in: The message is a received one. out: The message is an outgoing message. In other words, the message is sent out.

    locale
  • from: string
    multi_lang_tag
    locale

    cn 消息发送方, 帐号

    locale
    locale

    en Message sender: account

    locale
  • Optional fromClientType?: TClientType
    multi_lang_tag
    locale

    cn 发送方的设备类型

    locale
    locale

    en Sender's device type

    locale
  • Optional fromDeviceId?: string
    multi_lang_tag
    locale

    cn 发送端设备id

    locale
    locale

    en Sender device ID

    locale
  • Optional fromNick?: string
    multi_lang_tag
    locale

    cn 消息发送方的昵称

    locale
    locale

    en The nickname of the sender of the message

    locale
  • idClient: string
    multi_lang_tag
    locale

    cn sdk 端测唯一标识,可做主键使用

    locale
    locale

    en Unique identifier of the message on the client side

    locale
  • Optional idServer?: string
    multi_lang_tag
    locale

    cn 消息服务器测的标识

    它并不一定存在,故而这条消息的唯一标识请选用 idClient

    locale
    locale

    en Unique identifier of the message on the server side

    Because the identifier might not exist, please use idClient as the unique identifier of the message.

    locale
  • Optional pushInfo?: TMsgPushInfo
    multi_lang_tag
    locale

    cn 推送相关配置

    locale
    locale

    en Configurations related to push notifications

    locale
  • scene: TMsgScene
    multi_lang_tag
    locale

    cn 场景(会话类型)

    locale
    locale

    en Scenario (conversation type)

    locale
  • sessionId: string
    multi_lang_tag
    locale

    cn 消息所属的会话的ID

    locale
    locale

    en ID of the conversation to which the message belongs

    locale
  • Optional setting?: TMsgSetting
    multi_lang_tag
    locale

    cn 消息的杂项设置

    locale
    locale

    en Miscellaneous settings for messages

    locale
  • status: TMsgStatus
    multi_lang_tag
    locale

    cn 消息发送状态

    'sending' 发送中 'success' 发送成功 'fail' 发送失败

    locale
    locale

    en Message status

    'sending': The message is being sent... 'success’: The message is sent. 'fail’: The message failed to be sent.

    locale
  • Optional subType?: number
    multi_lang_tag
    locale

    cn 开发者自定义的消息子类型,格式为大于0的整数

    locale
    locale

    en Developer-defined message subtype (format: integer greater than 0)

    locale
  • target: string
    multi_lang_tag
    locale

    cn 聊天对象, 账号或者群id

    locale
    locale

    en The person that the user chats with, account, or group ID

    locale
  • Optional teamSpecializationInfo?: TMsgTeamSpecializationInfo
    multi_lang_tag
    locale

    cn 群组特化的杂项配置

    locale
    locale

    en Configuration available only when the “scene” field is set to team or superTeam

    locale
  • Optional threadMessageInfo?: TMsgThreadMsgInfo
    multi_lang_tag
    locale

    cn thread 消息的相关字段。 这里举例回复了多次的消息:消息C1 的 replyMsg 是消息B1,消息C1 的 threadMsg 是消息A

    消息A |
    消息B1 消息B2 | 消息C1

    locale
    locale

    en Fields related to threaded messages Here is an example of a message that has been replied to many times: replyMsg of message C1 is message B1, and threadMsg of message C1 is message A

    message A |
    message B1 message B2 | message C1

    locale
  • time: number
    multi_lang_tag
    locale

    cn 消息发送成功的时间戳(单位毫秒)

    locale
    locale

    en Timestamp when the message was sent successfully (unit: milliseconds)

    locale
  • to: string
    multi_lang_tag
    locale

    cn 消息接收方, 帐号或群id

    locale
    locale

    en Message recipient: account, or group ID

    locale
  • type: TMsgType
    multi_lang_tag
    locale

    cn 消息类型

    locale
    locale

    en Message type

    locale
  • userUpdateTime: number
    multi_lang_tag
    locale

    cn 用户最后更新时间

    locale
    locale

    en User’s last update time

    locale
MuteTeamOptions: { mute: boolean; teamId: string }

Type declaration

  • mute: boolean
    multi_lang_tag
    locale

    cn 是否禁言

    locale
    locale

    en Whether to mute

    locale
  • teamId: string
PassTeamApplyOptions: { from: string; teamId: string }

Type declaration

  • from: string
    multi_lang_tag
    locale

    cn 申请者的 accountId

    locale
    locale

    en Requester's accountId

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

Type declaration

  • from: string
    multi_lang_tag
    locale

    cn 申请者的 accountId

    locale
    locale

    en Requester's accountId

    locale
  • Optional ps?: string
    multi_lang_tag
    locale

    cn 附加信息

    locale
    locale

    en Additional information

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

Type declaration

  • from: string
    multi_lang_tag
    locale

    cn 邀请者的 accountId

    locale
    locale

    en accountId of the inviter

    locale
  • Optional ps?: string
    multi_lang_tag
    locale

    cn 附加信息

    locale
    locale

    en Additional information

    locale
  • teamId: string
Relation: "friend" | "stranger" | "blacklist" | "myself"
Relations: { blackList: MarkedUserInfo[]; muteList: MarkedUserInfo[] }

Type declaration

  • blackList: MarkedUserInfo[]
  • muteList: MarkedUserInfo[]
Session: { ack?: number; id: string; lastMsg?: IMMessage | null; msgReceiptTime?: number; scene: TMsgScene; stickTopInfo?: NIM_StickTopSessionInfo; to: string; unread: number; unreadMsgs?: IMMessage[]; updateTime: number }

Type declaration

  • Optional ack?: number
    multi_lang_tag
    locale

    cn 自己已读过的最近一条消息的时间

    用于判别自己已读到哪条消息了

    locale
    locale

    en The time when you read the last message

    Used to determine which message you have read

    locale
  • id: string
    multi_lang_tag
    locale

    cn sessionId

    例如 p2p-cs1、team-113879441

    locale
    locale

    en sessionId

    Example: p2p-cs1, team-113879441

    locale
  • Optional lastMsg?: IMMessage | null
    multi_lang_tag
    locale

    cn 上一条消息.

    若 lastMsg 为 undefined ,那么代表这个会话从没有过消息,导致会话不完整. sdk 将过滤掉此会话, 不会回调给上层的开发者

    若 lastMsg 为 null,lastMsg 为 null 则可能是撤回消息,也可能是清除了这个会话的历史消息

    locale
    locale

    en Previous message

    If lastMsg is undefined, it may have never received or sent messages and the conversation is incomplete. The sdk will filter out this session and will not call back to the upper developers

    If lastMsg is null, the message is recalled or the historical messages of this conversation are cleared.

    locale
  • Optional msgReceiptTime?: number
    multi_lang_tag
    locale

    cn 聊天对象所读过的最近一条消息的时间

    p2p 会话特有,与 msg.time 对比就能得知某条消息是否被对方已读

    被 API {@link MsgServiceInterface.sendMsgReceipt | sendMsgReceipt } 和 {@link MsgServiceInterface.sendTeamMsgReceipt | sendTeamMsgReceipt } 所更新

    locale
    locale

    en Time when the last message read by the user

    p2p chat specific properties,can compare it with msg.time to know whether a message has been read by the other party.

    locale
  • scene: TMsgScene
    multi_lang_tag
    locale

    cn 会话场景

    p2p 单聊

    team 群组

    superTeam 超大群

    locale
    locale

    en Conversation scene

    p2p: one-to-one chat

    team : group chat

    superTeam : supergroup chat

    locale
  • Optional stickTopInfo?: NIM_StickTopSessionInfo
    multi_lang_tag
    locale

    cn 云端置顶会话信息。若开通了云端置顶会话功能,且这个会话的确被设置为置顶会话,此对象存在。

    locale
    locale

    en The information about a pinned session. If the pinning session feature is enabled, and the session is pinned

    locale
  • to: string
    multi_lang_tag
    locale

    cn 聊天对象,

    若 scene 为 p2p 单聊,则 to 为聊天对象的账号

    若 scene 为 team 或者 superTeam,则 to 为 群ID

    locale
    locale

    en Chat object,

    If the scene is one-to-one chat, the “to” field represents the account of the person that the user chats with.

    If the scene is group chat or supergroup chat, the “to” field represents the group ID.

    locale
  • unread: number
    multi_lang_tag
    locale

    cn 未读数

    locale
    locale

    en Unread count

    locale
  • Optional unreadMsgs?: IMMessage[]
    multi_lang_tag
    locale

    cn 自己还没读过的此会话消息。此字段不希望开发者处理。

    locale
    locale

    en The conversation message that you haven't read yet

    locale
  • updateTime: number
    multi_lang_tag
    locale

    cn 更新时间

    locale
    locale

    en Update time

    locale
SystemMessage: { antiSpamInfo?: TSystemMessageAntiSpamInfo; attach?: StrAnyObj; callbackExt?: string; content?: string; feature: TSysMsgFeature; from: string; idServer: string; opeAccount?: string; pushInfo?: TSysMsgPushInfo; recallMessageInfo?: TSysMsgRecallMsgInfo; setting?: TSysMsgSetting; state?: TSystemMessageStatus; time: number; to: string; type: TSystemMessageType }

Type declaration

  • Optional antiSpamInfo?: TSystemMessageAntiSpamInfo
    multi_lang_tag
    locale

    cn 反垃圾设置

    locale
    locale

    en Anti-spam settings

    locale
  • Optional attach?: StrAnyObj
    multi_lang_tag
    locale

    cn 内建系统通知的附加信息

    locale
    locale

    en Additional information for built-in system notifications

    locale
  • Optional callbackExt?: string
    multi_lang_tag
    locale

    cn 服务器第三方回调的扩展字段

    locale
    locale

    en Extension fields for server’s third-party callbacks

    locale
  • Optional content?: string
    multi_lang_tag
    locale

    cn 内建系统通知的附言

    locale
    locale

    en Postscript for built-in system notifications

    locale
  • feature: TSysMsgFeature
    multi_lang_tag
    locale

    cn 通知属性

    locale
    locale

    en Notification attributes

    locale
  • from: string
    multi_lang_tag
    locale

    cn 系统通知的来源, 账号或者群ID

    locale
    locale

    en Source of the system notification: account or group ID

    locale
  • idServer: string
    multi_lang_tag
    locale

    cn 内建系统通知的 idServer

    locale
    locale

    en ID (generated by the IM server) of the built-in system notification

    locale
  • Optional opeAccount?: string
    multi_lang_tag
    locale

    cn 执行操作的账号,例如群管理员撤回消息,那就是管理员 accid

    locale
    locale

    en The account that operates. For example, if a group admin recalls the message, the account is the group admin’s accid.

    locale
  • Optional pushInfo?: TSysMsgPushInfo
    multi_lang_tag
    locale

    cn 推送设置

    locale
    locale

    en Push settings

    locale
  • Optional recallMessageInfo?: TSysMsgRecallMsgInfo
    multi_lang_tag
    locale

    cn 撤回消息的相关字段

    locale
    locale

    en Fields related to the recalled messages

    locale
  • Optional setting?: TSysMsgSetting
    multi_lang_tag
    locale

    cn 通知的其他相关字段

    locale
    locale

    en Other fields related to system notifications

    locale
  • Optional state?: TSystemMessageStatus
    multi_lang_tag
    locale

    cn 系统通知的状态

    locale
    locale

    en System notification status

    locale
  • time: number
    multi_lang_tag
    locale

    cn 时间戳

    locale
    locale

    en Timestamp

    locale
  • to: string
    multi_lang_tag
    locale

    cn 系统通知的目标, 账号或者群ID

    locale
    locale

    en Target of system notification: account or group ID

    locale
  • type: TSystemMessageType
    multi_lang_tag
    locale

    cn 系统通知类型

    群有关的如 teamInvite、rejectTeamInvite、applyTeam ... 好友的如 applyFriend、passFriendApply、rejectFriendApply.... 超大群的略 其他的撤回消息、自定义的系统通知等类型。

    locale
    locale

    en System notification type

    Group related: such as teamInvite, rejectTeamInvite, applyTeam... Friend related: such as applyFriend, passFriendApply, rejectFriendApply.... Recalled message, custom system notifications, etc.

    locale
TMsgScene: keyof typeof EMsgScene
TTransferTeamResult: { from: { account: string; id: string; type: TeamMemberType; updateTime: number }; team: Team; to: { account: string; id: string; type: TeamMemberType; updateTime: number } }

Type declaration

  • from: { account: string; id: string; type: TeamMemberType; updateTime: number }
    • account: string
    • id: string
    • type: TeamMemberType
    • updateTime: number
  • team: Team
  • to: { account: string; id: string; type: TeamMemberType; updateTime: number }
    • account: string
    • id: string
    • type: TeamMemberType
    • updateTime: number
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
    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
  • Optional 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
  • Optional 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 {@link Team.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
  • Optional 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
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
    multi_lang_tag
    locale

    cn 帐号

    locale
    locale

    en Account

    locale
  • active: boolean
    multi_lang_tag
    locale

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

    locale
    locale

    en When a person is invited to a normal group, the status of the invited person is inactivated. For a person in this status, the group in invisible. When someone chats in the group, the status of the invited person automatically turns activated, and then the invited person can see the group.

    locale
  • Optional bitConfigMask?: number
    multi_lang_tag
    locale

    cn 提醒策略

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

    locale
    locale

    en Notification strategy

    0: enable notification 1: disable notification 2: only notify group members of messages sent from group admins

    locale
  • Optional ext?: string
    multi_lang_tag
    locale

    cn 第三方扩展字段

    locale
    locale

    en Third-party extension fields

    locale
  • id: string
    multi_lang_tag
    locale

    cn 群成员的 id 标识(teamId + account)

    locale
    locale

    en The ID of the group member ( teamId + account)

    locale
  • joinTime: number
    multi_lang_tag
    locale

    cn 入群时间

    locale
    locale

    en Joining time

    locale
  • Optional mute?: boolean
    multi_lang_tag
    locale

    cn 是否被禁言

    locale
    locale

    en Whether the member is muted

    locale
  • Optional muteTeam?: boolean
    deprecated

    Use {@link TeamMember.bitConfigMask} instead.

    multi_lang_tag
    locale

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

    locale
    locale

    en Whether to mute notifications of messages of this group; “true” means to mute; if muted, the SDK still receives messages of this group, the SDK just records this mute setting. So you should determine what the corresponding UI display should be like.

    locale
  • nickInTeam: string
    multi_lang_tag
    locale

    cn 在群里面的昵称

    locale
    locale

    en Nickname in the group

    locale
  • teamId: string
    multi_lang_tag
    locale

    cn 群ID

    locale
    locale

    en Group ID

    locale
  • type: TeamMemberType
    multi_lang_tag
    locale

    cn 群成员类型

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

    locale
    locale

    en Group member type

    'normal' (regular member) 'owner' (group owner) 'manager' (admin)

    locale
  • updateTime: number
    multi_lang_tag
    locale

    cn 更新时间

    locale
    locale

    en Update time

    locale
  • valid: boolean
    multi_lang_tag
    locale

    cn 群成员是否有效

    locale
    locale

    en Whether the group members are valid

    locale
UpdateMyInfoOptions: { avatar?: string; birth?: string; email?: string; ext?: string; gender?: Gender; nick?: string; signature?: string; tel?: string }

Type declaration

  • Optional avatar?: string
    multi_lang_tag
    locale

    cn 头像

    locale
    locale

    en Avatar

    locale
  • Optional birth?: string
    multi_lang_tag
    locale

    cn 出生日期

    locale
    locale

    en Date of birth

    locale
  • Optional email?: string
    multi_lang_tag
    locale

    cn 邮箱

    locale
    locale

    en Email

    locale
  • Optional ext?: string
    multi_lang_tag
    locale

    cn 扩展字段

    locale
    locale

    en Extension field

    locale
  • Optional gender?: Gender
    multi_lang_tag
    locale

    cn 性别

    locale
    locale

    en Gender

    locale
  • Optional nick?: string
    multi_lang_tag
    locale

    cn 昵称

    locale
    locale

    en Nickname

    locale
  • Optional signature?: string
    multi_lang_tag
    locale

    cn 签名

    locale
    locale

    en Signature

    locale
  • Optional tel?: string
    multi_lang_tag
    locale

    cn 电话

    locale
    locale

    en Phone number

    locale
UpdateRelationsOptions: { account: string; isAdd: boolean }

Type declaration

  • account: string
  • isAdd: boolean
    multi_lang_tag
    locale

    cn isAdd 为 true 时, 会将 account 确定这么设置(黑名单,静音) 如果一个用户被加入了黑名单, 那么就不再会收到此用户发送的消息

    isAdd 为 false 时, 会将 account 取消设置 如果一个用户被从黑名单移除, 那么可以收到此用户发送的消息

    locale
    locale

    en When isAdd is set to true, the account will be added to the blocklist or list of muted members. If a user is added to the blacklist, you will no longer receive messages from this user.

    When isAdd is false, the account will be removed from the blacklist or mute list. If a user is removed from the blacklist, you can receive messages from this user.

    locale
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
    multi_lang_tag
    locale

    cn 群公告

    locale
    locale

    en Group announcement

    locale
  • Optional avatar?: string
    multi_lang_tag
    locale

    cn 群头像

    locale
    locale

    en Group avatar

    locale
  • Optional beInviteMode?: TeamBeInviteMode
    multi_lang_tag
    locale

    cn 群被邀请模式

    locale
    locale

    en Invitee verification mode

    locale
  • Optional ext?: string
    multi_lang_tag
    locale

    cn 扩展字段

    locale
    locale

    en Extension field

    locale
  • Optional intro?: string
    multi_lang_tag
    locale

    cn 群简介

    locale
    locale

    en Group introduction

    locale
  • Optional inviteMode?: TeamInviteMode
    multi_lang_tag
    locale

    cn 群邀请模式

    locale
    locale

    en Group invitation mode

    locale
  • Optional joinMode?: TeamJoinMode
    multi_lang_tag
    locale

    cn 群加入方式

    locale
    locale

    en Group joining method

    locale
  • Optional name?: string
    multi_lang_tag
    locale

    cn 群名

    locale
    locale

    en Group name

    locale
  • teamId: string
    multi_lang_tag
    locale

    cn 群 id

    locale
    locale

    en Group ID

    locale
  • Optional updateExtMode?: TeamUpdateExtMode
    multi_lang_tag
    locale

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

    locale
    locale

    en Permission for modifying group information custom field

    locale
  • Optional updateTeamMode?: TeamUpdateTeamMode
    multi_lang_tag
    locale

    cn 群信息修改权限

    locale
    locale

    en Group information modification permission

    locale
UserNameCard: { account: string; avatar?: string; birth?: string; createTime: number; email?: string; ext?: string; gender?: Gender; nick?: string; signature?: string; tel?: string; updateTime: number }

Type declaration

  • account: string
    multi_lang_tag
    locale

    cn accid

    locale
    locale

    en account ID

    locale
  • Optional avatar?: string
    multi_lang_tag
    locale

    cn 头像

    locale
    locale

    en Avatar

    locale
  • Optional birth?: string
    multi_lang_tag
    locale

    cn 出生日期

    locale
    locale

    en Date of birth

    locale
  • createTime: number
  • Optional email?: string
    multi_lang_tag
    locale

    cn 邮箱

    locale
    locale

    en Email

    locale
  • Optional ext?: string
    multi_lang_tag
    locale

    cn 扩展字段

    locale
    locale

    en Extension field

    locale
  • Optional gender?: Gender
    multi_lang_tag
    locale

    cn 性别

    locale
    locale

    en Gender

    locale
  • Optional nick?: string
    multi_lang_tag
    locale

    cn 昵称

    locale
    locale

    en Nickname

    locale
  • Optional signature?: string
    multi_lang_tag
    locale

    cn 签名

    locale
    locale

    en Signature

    locale
  • Optional tel?: string
    multi_lang_tag
    locale

    cn 电话

    locale
    locale

    en Phone number

    locale
  • updateTime: number

Generated using TypeDoc