即时通讯
当前页

Enum

2026-07-06
ZIMConnectionStateZIMConnectionEvent
ZIMConversationEventZIMConversationListChangeAction
ZIMConversationNotificationStatusZIMConversationType
ZIMConversationSyncStateZIMConversationPinnedFilter
ZIMConversationSearchModeZIMMediaFileType
ZIMMessageDirectionZIMMessageOrder
ZIMMessagePriorityZIMMessageQueryMode
ZIMMessageReceiptStatusZIMMessageRevokeStatus
ZIMMessageSentStatusZIMMessageType
ZIMRevokeTypeZIMTipsMessageEvent
ZIMTipsMessageChangeInfoTypeZIMMessageMentionedType
ZIMMessageDeleteTypeZIMMessageRepliedInfoState
ZIMMessagePinStatusZIMMessageReactionUserChangeAction
ZIMRoomEventZIMRoomState
ZIMRoomAttributesUpdateActionZIMRoomMemberAttributesUpdateAction
ZIMGroupStateZIMGroupEvent
ZIMGroupMemberEventZIMGroupMemberState
ZIMGroupMessageNotificationStatusZIMGroupAttributesUpdateAction
ZIMGroupMuteModeZIMGroupJoinMode
ZIMGroupInviteModeZIMGroupBeInviteMode
ZIMGroupEnterTypeZIMGroupApplicationType
ZIMGroupApplicationStateZIMGroupApplicationListChangeAction
ZIMCallInvitationModeZIMCallState
ZIMCallUserStateZIMUserInfoType
ZIMFriendListChangeActionZIMFriendApplicationListChangeAction
ZIMFriendApplicationTypeZIMFriendApplicationState
ZIMFriendRelationCheckTypeZIMFriendDeleteType
ZIMUserRelationTypeZIMBlacklistChangeAction
ZIMCXHandleTypeZIMGeofencingType
ZIMPlatformTypeZIMUserOnlineStatus
ZIMListChangeActionZIMCommunityListChangeAction
ZIMCommunityMemberEnterTypeZIMCommunityMemberChangeState
ZIMCommunityMemberChangeActionZIMCommunityChannelType
ZIMCommunityChannelListChangeActionZIMCommunityChannelMuteMode
ZIMCommunityMemberMuteTypeZIMCommunityMessageNotificationStatus
ZIMCommunityMemberRole

ZIMConnectionState

连接状态。

详情

连接状态。

Declared in ZIMDefines.ts

属性

Disconnected

Disconnected
Disconnected=(0)

未连接状态,在登录前和登出之后进入该状态。

Connecting

Connecting
Connecting=(1)

正在请求连接状态,登录动作执行成功后会进入此状态。

Connected

Connected
Connected=(2)

连接成功状态。

Reconnecting

Reconnecting
Reconnecting=(3)

正在进行重新连接状态。

ZIMConnectionEvent

导致连接状态发生变更的事件。

详情

导致连接状态发生变更的事件。

Declared in ZIMDefines.ts

属性

Success

Success
Success=(0)

成功。

ActiveLogin

ActiveLogin
ActiveLogin=(1)

用户主动登录。

LoginTimeout

LoginTimeout
LoginTimeout=(2)

连接超时。

LoginInterrupted

LoginInterrupted
LoginInterrupted=(3)

网络连接临时中断。

KickedOut

KickedOut
KickedOut=(4)

用户被踢出。

TokenExpired

TokenExpired
TokenExpired=(5)

Token已经过期。

Unregistered

Unregistered
Unregistered=(6)

用户被注销。

ZIMConversationEvent

会话改变事件。

详情

会话改变事件。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

会话新增事件。

Updated

Updated
Updated=(1)

会话更新事件。

Disabled

Disabled
Disabled=(2)

会话不可用事件。

Deleted

Deleted
Deleted=(3)

会话删除事件。

ZIMConversationListChangeAction

会话列表变动事件。

详情

会话列表变动事件。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

会话列表新增事件。

Deleted

Deleted
Deleted=(1)

会话列表删除事件。

Updated

Updated
Updated=(2)

会话列表更新事件。

ZIMConversationNotificationStatus

会话通知状态枚举。

详情

会话通知状态枚举。

Declared in ZIMDefines.ts

属性

Notify

Notify
Notify=(1)

会话通知为开。

DoNotDisturb

DoNotDisturb
DoNotDisturb=(2)

会话通知为关。

ZIMConversationType

会话类型。

详情

会话类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知。

Peer

Peer
Peer=(0)

单聊会话。

Room

Room
Room=(1)

房间会话。

Group

Group
Group=(2)

群聊会话。

CommunityChannel

CommunityChannel
CommunityChannel=(3)

社群频道会话。

ZIMConversationSyncState

标识了 SDK 从后台同步会话列表的状态。

详情

标识了 SDK 从后台同步会话列表的状态。

Declared in ZIMDefines.ts

属性

Started

Started
Started=(0)

会话列表同步开始状态

Finished

Finished
Finished=(1)

会话列表同步完成状态

Failed

Failed
Failed=(2)

会话列表同步失败状态,可能由于网络原因导致同步失败

ZIMConversationPinnedFilter

用户查询会话列表时,作为查询置顶会话的过滤项。

详情

用户查询会话列表时,作为查询置顶会话的过滤项。

Declared in ZIMDefines.ts

属性

All

All
All=(0)

既能查询到置顶会话也能查询到非置顶会会话。

OnlyPinned

OnlyPinned
OnlyPinned=(1)

仅能查询到置顶会话。

OnlyUnpinned

OnlyUnpinned
OnlyUnpinned=(2)

仅能查询到非置顶会话。

ZIMConversationSearchMode

会话搜索模式。

详情

会话搜索模式。

Declared in ZIMDefines.ts

属性

MatchMessage

MatchMessage
MatchMessage=(0)

通过搜索符合条件的消息来搜索到对应会话。

MatchConversationName

MatchConversationName
MatchConversationName=(1)

通过搜索会话名来搜索到对应会话。

ZIMMediaFileType

媒体文件类型。

详情

媒体文件类型。

Declared in ZIMDefines.ts

属性

OriginalFile

OriginalFile
OriginalFile=(1)

原始文件类型,适用于图片原图、音频文件以及视频文件。当调用 [downloadMediaFile] 后,SDK 将更新 ZIMFileMessage 里的 fileLocalPath 属性。

LargeImage

LargeImage
LargeImage=(2)

图片大图类型。当调用 [downloadMediaFile] 后,SDK 将更新 ZIMImageMessage 里的 largeImageLocalPath 属性。

Thumbnail

Thumbnail
Thumbnail=(3)

图片缩略图类型。当调用 [downloadMediaFile] 后,SDK 将更新 ZIMImageMessage 里的 thumbnailLocalPath 属性。

VideoFirstFrame

VideoFirstFrame
VideoFirstFrame=(4)

视频首帧图类型。当调用 [downloadMediaFile] 后,SDK 将更新 ZIMImageMessage 里的 thumbnailLocalPath 属性。

ZIMMessageDirection

消息的方向。

详情

消息的方向。

Declared in ZIMDefines.ts

属性

Send

Send
Send=(0)

消息已发送。

Receive

Receive
Receive=(1)

消息已接受。

ZIMMessageOrder

消息顺序。

详情

消息顺序。

Declared in ZIMDefines.ts

属性

Descending

Descending
Descending=(0)

代表消息列表降序 (消息列表顺序从新到旧)。

Ascending

Ascending
Ascending=(1)

代表消息列表升序 (消息列表顺序从旧到新)。

ZIMMessagePriority

消息的优先级。

详情

消息的优先级。

Declared in ZIMDefines.ts

属性

Low

Low
Low=(1)

低优先级。

Medium

Medium
Medium=(2)

中优先级。

High

High
High=(3)

高优先级。

ZIMMessageQueryMode

消息查询模式。

详情

消息查询模式。

Declared in ZIMDefines.ts

属性

General

General
General=(0)

普通模式。SDK 会默认在此模式下自动判断是否需要向服务端请求合并消息数据。建议一般场景情况下都选用该模式。

PreferServer

PreferServer
PreferServer=(1)

优先向服务端查询模式。

OnlyLocal

OnlyLocal
OnlyLocal=(2)

仅查询本地消息模式。

ZIMMessageReceiptStatus

回执状态

详情

回执状态

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知状态。

None

None
None=(0)

不是回执。

Processing

Processing
Processing=(1)

回执进行中。

Done

Done
Done=(2)

回执已完成。

Expired

Expired
Expired=(3)

回执已过期。

Failed

Failed
Failed=(4)

回执已失败。

ZIMMessageRevokeStatus

消息撤回状态。

详情

消息撤回状态。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知状态。

SelfRevoke

SelfRevoke
SelfRevoke=(0)

主动撤回。

SystemRevoke

SystemRevoke
SystemRevoke=(1)

系统撤回。

ServerApiRevoke

ServerApiRevoke
ServerApiRevoke=(2)

服务端 API 撤回。

GroupAdminRevoke

GroupAdminRevoke
GroupAdminRevoke=(3)

群管理员撤回。

GroupOwnerRevoke

GroupOwnerRevoke
GroupOwnerRevoke=(4)

群主撤回。

AuditRejectRevoke

AuditRejectRevoke
AuditRejectRevoke=(5)

因审核拒绝而被撤回。

ZIMMessageSentStatus

消息发送的情况。

详情

消息发送的情况。

Declared in ZIMDefines.ts

属性

Sending

Sending
Sending=(0)

发送中。

Success

Success
Success=(1)

发送成功。

Failed

Failed
Failed=(2)

发送失败。

ZIMMessageType

消息类型。

详情

消息类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(0)

未知类型,收到未知类型的消息,表明发送方可能发送了该用户不支持的消息类型,需要建议用户更新版本。

Text

Text
Text=(1)

普通文本消息,可用于传递普通文本消息。

Command

Command
Command=(2)

自定义二进制消息,可用于传递自定义的二进制消息。该消息类型不支持离线消息和本地存储。

Multiple

Multiple
Multiple=(10)

组合消息,可用于发送组合消息。

Image

Image
Image=(11)

图片消息,可用于发送图片消息,仅支持 ".jpg", ".jpeg", ".png", ".bmp", ".gif", ".tiff" 图片类型。发送图片后,服务端将会生成原图的大图和缩略图。

File

File
File=(12)

文件消息,用于发送文件消息,无文件类型限制。

Audio

Audio
Audio=(13)

音频消息,用于发送音频消息,仅支持 ".mp3" 音频类型。

Video

Video
Video=(14)

视频消息,用于发送视频消息,仅支持 ".mp4", ".mov" 视频类型。发送视频消息后,服务端将会生成该视频文件的首帧图。

Barrage

Barrage
Barrage=(20)

弹幕消息,可用于直播间发送的弹幕。该消息类型不支持离线消息和本地存储。

Revoke

Revoke
Revoke=(31)

撤回消息。

Tips

Tips
Tips=(32)

Tips 消息。

Combine

Combine
Combine=(100)

合并消息。

Custom

Custom
Custom=(200)

自定义消息。

ZIMRevokeType

消息撤回类型。

详情

消息撤回类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知类型。

TwoWay

TwoWay
TwoWay=(0)

双边撤回。

OneWay

OneWay
OneWay=(1)

单边撤回。

ZIMTipsMessageEvent

Tips 消息产生事件

详情

Tips 消息产生事件

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(0)

未知事件。

GroupCreated

GroupCreated
GroupCreated=(1)

群组已创建。

GroupDismissed

GroupDismissed
GroupDismissed=(2)

群组已解散。

GroupJoined

GroupJoined
GroupJoined=(3)

成员已加入群组。

GroupInvited

GroupInvited
GroupInvited=(4)

成员已被邀请加入群组。

GroupLeft

GroupLeft
GroupLeft=(5)

成员已离开群组。

GroupKickedOut

GroupKickedOut
GroupKickedOut=(6)

成员已被踢出群组。

GroupInfoChanged

GroupInfoChanged
GroupInfoChanged=(7)

群组信息已变更。

GroupMemberInfoChanged

GroupMemberInfoChanged
GroupMemberInfoChanged=(8)

群成员信息已变更。

GroupMessagePinned

GroupMessagePinned
GroupMessagePinned=(9)

群消息已置顶。

CommunityCreated

CommunityCreated
CommunityCreated=(101)

社群已创建。

CommunityJoined

CommunityJoined
CommunityJoined=(103)

成员已加入社群。

CommunityInvited

CommunityInvited
CommunityInvited=(104)

成员已被邀请加入社群。

CommunityChannelCreated

CommunityChannelCreated
CommunityChannelCreated=(151)

社群频道已创建。

ZIMTipsMessageChangeInfoType

Tips 消息附加信息的类型。

详情

Tips 消息附加信息的类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(0)

未知类型。

GroupDataChanged

GroupDataChanged
GroupDataChanged=(1)

群名、群头像、群公告存在复数变更事件。

GroupNoticeChanged

GroupNoticeChanged
GroupNoticeChanged=(2)

群公告变更事件。

GroupNameChanged

GroupNameChanged
GroupNameChanged=(3)

群名变更事件。

GroupAvatarUrlChanged

GroupAvatarUrlChanged
GroupAvatarUrlChanged=(4)

群头像变更事件。

GroupMuteChanged

GroupMuteChanged
GroupMuteChanged=(5)

群禁言状态变更事件。

GroupOwnerTransferred

GroupOwnerTransferred
GroupOwnerTransferred=(10)

群主转移事件。

GroupMemberRoleChanged

GroupMemberRoleChanged
GroupMemberRoleChanged=(11)

群成员角色变更事件。

GroupMemberMuteChanged

GroupMemberMuteChanged
GroupMemberMuteChanged=(12)

群成员禁言状态发生变更。

GroupMessagePinInfoChanged

GroupMessagePinInfoChanged
GroupMessagePinInfoChanged=(21)

群消息置顶或取消置顶事件。

ZIMMessageMentionedType

消息提及 (at) 类型。

详情

消息提及 (at) 类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(0)

未知提及类型。

MentionMe

MentionMe
MentionMe=(1)

提醒我

MentionAll

MentionAll
MentionAll=(2)

提醒所有人

MentionAllAndMe

MentionAllAndMe
MentionAllAndMe=(3)

提醒所有人且提醒我

ZIMMessageDeleteType

消息被删除的类型。

详情

消息被删除的类型。

Declared in ZIMDefines.ts

属性

MessageListDeleted

MessageListDeleted
MessageListDeleted=(0)

删除指定的消息列表。

ConversationAllMessagesDeleted

ConversationAllMessagesDeleted
ConversationAllMessagesDeleted=(1)

删除会话中的所有消息。

AllConversationMessagesDeleted

AllConversationMessagesDeleted
AllConversationMessagesDeleted=(2)

删除所有会话中的所有消息。

ZIMMessageRepliedInfoState

回复消息所引用的源消息状态。

详情

回复消息所引用的源消息状态。

Declared in ZIMDefines.ts

属性

Normal

Normal
Normal=(0)

正常状态。

Deleted

Deleted
Deleted=(1)

已删除。

NotFound

NotFound
NotFound=(2)

未找到。可能是源消息在服务端已过期或者该源消息对当前用户不可见。

ZIMMessagePinStatus

消息置顶状态枚举。

详情

消息置顶状态枚举。

Declared in ZIMDefines.ts

属性

NotPinned

NotPinned
NotPinned=(0)

取消置顶

Pinned

Pinned
Pinned=(1)

置顶

Updated

Updated
Updated=(2)

置顶信息更新

ZIMMessageReactionUserChangeAction

消息表态的用户操作行为。

详情

消息表态的用户操作行为。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

添加消息表态。

Deleted

Deleted
Deleted=(1)

删除消息表态。

ZIMRoomEvent

导致房间连接状态发生变更的事件。

详情

导致房间连接状态发生变更的事件。

Declared in ZIMDefines.ts

属性

Success

Success
Success=(0)

成功。

NetworkInterrupted

NetworkInterrupted
NetworkInterrupted=(1)

房间网络临时中断。

NetworkDisconnected

NetworkDisconnected
NetworkDisconnected=(2)

房间网络断开。

RoomNotExist

RoomNotExist
RoomNotExist=(3)

房间不存在。

ActiveCreate

ActiveCreate
ActiveCreate=(4)

用户开始创建房间。

CreateFailed

CreateFailed
CreateFailed=(5)

创建房间失败。

ActiveEnter

ActiveEnter
ActiveEnter=(6)

用户开始进入房间。

EnterFailed

EnterFailed
EnterFailed=(7)

用户进入房间失败。

KickedOut

KickedOut
KickedOut=(8)

用户被踢出房间。

ConnectTimeout

ConnectTimeout
ConnectTimeout=(9)

链接超时。

KickedOutByOtherDevice

KickedOutByOtherDevice
KickedOutByOtherDevice=(10)

多端登录进入相同房间导致用户被踢出房间。

ActiveSwitch

ActiveSwitch
ActiveSwitch=(11)

用户开始切换房间。

SwitchFailed

SwitchFailed
SwitchFailed=(12)

用户切换房间失败。

ZIMRoomState

详情描述:描述用户与房间的连接状态。

详情

详情描述:描述用户与房间的连接状态。

Declared in ZIMDefines.ts

属性

Disconnected

Disconnected
Disconnected=(0)

代表与房间的连接中断,[createRoom]、[joinRoom]、[enterRoom] 调用失败,断网时间过长导致房间心跳超时、后台通知该用户已被踢出房间、登出会抛这个状态。

Connecting

Connecting
Connecting=(1)

connecting 代表与房间的连接状态处于连接中,[createRoom]、[joinRoom]、[enterRoom] 调用后,后台未回包,网络断开会抛出这个状态。

Connected

Connected
Connected=(2)

connected 代表与房间连接正常。[createRoom]、[joinRoom]、[enterRoom] 调用成功,断网重连且房间心跳未超时、会抛出这个状态。

ZIMRoomAttributesUpdateAction

房间属性变更行为。

详情

房间属性变更行为。

Declared in ZIMDefines.ts

属性

Set

Set
Set=(0)

设置行为。

Delete

Delete
Delete=(1)

删除行为。

ZIMRoomMemberAttributesUpdateAction

房间用户属性变更行为。

详情

房间用户属性变更行为。

Declared in ZIMDefines.ts

属性

Set

Set
Set=(0)

因设置了新属性而发生变更。

ZIMGroupState

群状态。

详情

群状态。

Declared in ZIMDefines.ts

属性

Quit

Quit
Quit=(0)

已退出该群。

Enter

Enter
Enter=(1)

已进入该群。

ZIMGroupEvent

群组事件。

详情

群组事件。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知事件。

Created

Created
Created=(1)

创建群。

Dismissed

Dismissed
Dismissed=(2)

解散群。

Joined

Joined
Joined=(3)

加入群。

Invited

Invited
Invited=(4)

邀请入群。

Left

Left
Left=(5)

离开群。

KickedOut

KickedOut
KickedOut=(6)

踢出群。

ZIMGroupMemberEvent

群成员事件。

详情

群成员事件。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知事件。

Joined

Joined
Joined=(1)

已加入。

Left

Left
Left=(2)

离开。

KickedOut

KickedOut
KickedOut=(4)

被踢出。

Invited

Invited
Invited=(5)

被邀请。

ZIMGroupMemberState

群成员进出状态。

详情

群成员进出状态。

Declared in ZIMDefines.ts

属性

Quit

Quit
Quit=(0)

已退出。

Enter

Enter
Enter=(1)

已进入。

ZIMGroupMessageNotificationStatus

群组消息通知状态。

详情

群组消息通知状态。

Declared in ZIMDefines.ts

属性

Notify

Notify
Notify=(1)

群组消息正常通知。

DoNotDisturb

DoNotDisturb
DoNotDisturb=(2)

群组消息免打扰。

ZIMGroupAttributesUpdateAction

群组属性变更行为。

详情

群组属性变更行为。

Declared in ZIMDefines.ts

属性

Set

Set
Set=(0)

设置行为。

Delete

Delete
Delete=(1)

删除行为。

ZIMGroupMuteMode

群组禁言模式。

详情

群组禁言模式。

Declared in ZIMDefines.ts

属性

None

None
None=(0)

无禁言。

Normal

Normal
Normal=(1)

仅普通成员被禁言。

All

All
All=(2)

全员禁言。

Custom

Custom
Custom=(3)

自定义角色禁言。

ZIMGroupJoinMode

群组加入模式。

详情

群组加入模式。

Declared in ZIMDefines.ts

属性

Any

Any
Any=(0)

所有人都可以自由加入。

Auth

Auth
Auth=(1)

需要群主或群管理员审核通过才能加入。

Forbid

Forbid
Forbid=(2)

不可自行加入。

ZIMGroupInviteMode

群组邀请模式。

详情

群组邀请模式。

Declared in ZIMDefines.ts

属性

Any

Any
Any=(0)

群内所有人都可邀请用户入群。

Admin

Admin
Admin=(1)

仅群主或群管理员可以邀请用户入群。

ZIMGroupBeInviteMode

邀请目标验证模式。

详情

邀请目标验证模式。

Declared in ZIMDefines.ts

属性

None

None
None=(0)

邀请用户进群时,无需用户同意即入群。

Auth

Auth
Auth=(1)

邀请用户进群时,需要用户同意才可入群。

ZIMGroupEnterType

加入群组的类型。

详情

加入群组的类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(0)

未知类型。

Created

Created
Created=(1)

群组创建时进入到群。

JoinApply

JoinApply
JoinApply=(2)

通过主动发起申请进入到群。

Joined

Joined
Joined=(3)

直接加入到群。

Invited

Invited
Invited=(4)

被群内用户直接邀请进入到群。

InviteApply

InviteApply
InviteApply=(5)

被群内用户通过邀请的申请而进入到群。

ZIMGroupApplicationType

群组申请的类型。

详情

群组申请的类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知类型。

None

None
None=(0)

无类型的申请。

Join

Join
Join=(1)

用户入群的申请。

Invite

Invite
Invite=(2)

邀请用户的申请。

BeInvite

BeInvite
BeInvite=(3)

受邀申请。

ZIMGroupApplicationState

群组申请的状态。

详情

群组申请的状态。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知状态。

Waiting

Waiting
Waiting=(1)

等待响应。

Accepted

Accepted
Accepted=(2)

已接受该申请。

Rejected

Rejected
Rejected=(3)

已拒绝该申请。

Expired

Expired
Expired=(4)

该申请已超时。

Disabled

Disabled
Disabled=(5)

该申请已无效。

ZIMGroupApplicationListChangeAction

群组申请列表变更动作。

详情

群组申请列表变更动作。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

新增群组申请。

ZIMCallInvitationMode

呼叫邀请模式。

详情

呼叫邀请模式。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知类型,做为保底枚举值。

General

General
General=(0)

普通模式。

Advanced

Advanced
Advanced=(1)

进阶模式。

ZIMCallState

呼叫状态。

详情

呼叫状态。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知类型,做为保底枚举值。

Started

Started
Started=(1)

已发起。

Ended

Ended
Ended=(2)

已结束。

ZIMCallUserState

呼叫用户状态。

详情

呼叫用户状态。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知。

Inviting

Inviting
Inviting=(0)

邀请中。

Accepted

Accepted
Accepted=(1)

已接受。

Rejected

Rejected
Rejected=(2)

已拒绝。

Cancelled

Cancelled
Cancelled=(3)

已取消。

Received

Received
Received=(5)

已接收。

Timeout

Timeout
Timeout=(6)

超时。

Quit

Quit
Quit=(7)

退出。

Ended

Ended
Ended=(8)

结束。

NotYetReceived

NotYetReceived
NotYetReceived=(9)

未收到。

BeCancelled

BeCancelled
BeCancelled=(10)

被取消。

ZIMUserInfoType

用户类型。

详情

用户类型。

Declared in ZIMDefines.ts

属性

BasicUser

BasicUser
BasicUser=(1)

基础用户类型。

RoomMember

RoomMember
RoomMember=(2)

房间成员类型。

GroupMember

GroupMember
GroupMember=(3)

群成员类型。

GroupSimpleMember

GroupSimpleMember
GroupSimpleMember=(4)

群成员简要信息类型。

Friend

Friend
Friend=(5)

好友类型。

CommunityMember

CommunityMember
CommunityMember=(6)

社群成员类型。

CommunitySimpleMember

CommunitySimpleMember
CommunitySimpleMember=(7)

社群成员简要信息类型。

ZIMFriendListChangeAction

好友列表更新动作。

详情

好友列表更新动作。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

新增好友。

Deleted

Deleted
Deleted=(1)

删除好友。

ZIMFriendApplicationListChangeAction

好友申请列表更新动作。

详情

好友申请列表更新动作。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

新增好友申请。

Deleted

Deleted
Deleted=(1)

删除好友申请。

ZIMFriendApplicationType

好友申请类型。

详情

好友申请类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知类型,做为保底枚举值。

None

None
None=(0)

无特定类型的好友申请。

Received

Received
Received=(1)

收到其他人的好友申请。

Sent

Sent
Sent=(2)

自己发送的好友申请。

Both

Both
Both=(3)

双方都向对方发送了的好友申请。

ZIMFriendApplicationState

好友申请状态。

详情

好友申请状态。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知状态。

Waiting

Waiting
Waiting=(1)

等待响应。

Accepted

Accepted
Accepted=(2)

已接受的申请。

Rejected

Rejected
Rejected=(3)

已拒绝的申请。

Expired

Expired
Expired=(4)

好友申请已过期。

Disabled

Disabled
Disabled=(5)

好友申请已失效。

ZIMFriendRelationCheckType

好友关系检查类型。

详情

好友关系检查类型。

Declared in ZIMDefines.ts

属性

Both

Both
Both=(0)

进行双向好友检查。

Single

Single
Single=(1)

仅进行单向好友检查。

ZIMFriendDeleteType

好友删除类型。

详情

好友删除类型。

Declared in ZIMDefines.ts

属性

Both

Both
Both=(0)

双向删除好友,删除成功后双方好友列表都会移除对方好友信息。

Single

Single
Single=(1)

单向删除好友,删除成功后仅自己的好友列表会移除对方的好友信息。

ZIMUserRelationType

好友关系类型。

详情

好友关系类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(0)

未知类型。

SingleNo

SingleNo
SingleNo=(1)

单方向无好友关系。

SingleHave

SingleHave
SingleHave=(2)

单方向存在好友关系。

BothAllNo

BothAllNo
BothAllNo=(3)

双方均无好友关系。

BothSelfHave

BothSelfHave
BothSelfHave=(4)

本方已添加对方为好友,对方未添加本方。

BothOtherHave

BothOtherHave
BothOtherHave=(5)

对方已添加本方为好友,本方未添加对方。

BothAllHave

BothAllHave
BothAllHave=(6)

双方互为好友。

ZIMBlacklistChangeAction

黑名单列表更新动作。

详情

黑名单列表更新动作。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

新增黑名单。

Removed

Removed
Removed=(1)

删除黑名单。

ZIMCXHandleType

VoIP 发起方联系信息类型。

详情

VoIP 发起方联系信息类型。

Declared in ZIMDefines.ts

属性

Generic

Generic
Generic=(1)

一个电话号码。

PhoneNumber

PhoneNumber
PhoneNumber=(2)

一个电子邮件地址。

EmailAddress

EmailAddress
EmailAddress=(3)

未指定的句柄类型。

ZIMGeofencingType

地理围栏设置类型。

详情

地理围栏设置类型。

Declared in ZIMDefines.ts

属性

None

None
None=(0)

不设置地理围栏。

Include

Include
Include=(1)

地理围栏类型包含待传入的区域值

Exclude

Exclude
Exclude=(2)

地理围栏类型除外待传入的区域值

ZIMPlatformType

SDK 运行的平台

详情

SDK 运行的平台

Declared in ZIMDefines.ts

属性

Win

Win
Win=(1)

Windows 平台。

IPhoneOS

IPhoneOS
IPhoneOS=(2)

iOS 平台。

Android

Android
Android=(3)

Android 平台。

MacOS

MacOS
MacOS=(4)

MacOS 平台。

Linux

Linux
Linux=(5)

Linux 平台。

Web

Web
Web=(6)

Web 平台。

MiniProgram

MiniProgram
MiniProgram=(7)

小程序平台。

IPadOS

IPadOS
IPadOS=(9)

iPad 平台。

OHOS

OHOS
OHOS=(10)

鸿蒙(OHOS)平台。

Unknown

Unknown
Unknown=(32)

不属于上述平台的平台。

ZIMUserOnlineStatus

用户在线状态。

详情

用户在线状态。

Declared in ZIMDefines.ts

属性

Online

Online
Online=(0)

在线。用户已登录且网络状态良好的情况下会处于该状态。

Offline

Offline
Offline=(1)

离线。用户未调用 logout 主动登出,因为网络断开、app 被杀、退后台、锁屏等原因于后台的长链接断开后,将处于该状态。

Logout

Logout
Logout=(2)

登出。用户主动登出会处于该状态。

Unknown

Unknown
Unknown=(99)

未知状态。保底枚举。

ZIMListChangeAction

列表变动事件。

详情

列表变动事件。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

列表新增事件。

Deleted

Deleted
Deleted=(1)

列表删除事件。

ZIMCommunityListChangeAction

社群列表变动事件。

详情

社群列表变动事件。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

社群列表新增事件。

Deleted

Deleted
Deleted=(1)

社群列表删除事件。

Updated

Updated
Updated=(2)

社群列表更新事件。

ZIMCommunityMemberEnterType

社群成员进入类型。

详情

社群成员进入类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(0)

未知事件。

CommunityCreated

CommunityCreated
CommunityCreated=(1)

因社群创建而进入社群。

CommunityJoined

CommunityJoined
CommunityJoined=(2)

因成员主动加入而进入社群。

CommunityInvited

CommunityInvited
CommunityInvited=(3)

因被其他成员邀请而进入社群。

ZIMCommunityMemberChangeState

社群成员状态。

详情

社群成员状态。

Declared in ZIMDefines.ts

属性

Exited

Exited
Exited=(0)

社群成员退出社群。

Entered

Entered
Entered=(1)

社群成员进入社群。

ZIMCommunityMemberChangeAction

社群成员状态变更动作。

详情

社群成员状态变更动作。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(0)

未知动作。

Joined

Joined
Joined=(1)

社群成员主动加入。

Invited

Invited
Invited=(2)

社群成员被邀请加入。

Left

Left
Left=(3)

社群成员主动离开。

KickedOut

KickedOut
KickedOut=(4)

社群成员被踢出。

ZIMCommunityChannelType

社群频道类型。

详情

社群频道类型。

Declared in ZIMDefines.ts

属性

Unknown

Unknown
Unknown=(-1)

未知频道。

General

General
General=(0)

默认频道。创建社群时就会存在

Public

Public
Public=(1)

公开频道。对所有进入了社群的成员都可见

Private

Private
Private=(2)

私密频道。仅对部分成员可见

ZIMCommunityChannelListChangeAction

社群列表频道变动事件。

详情

社群列表频道变动事件。

Declared in ZIMDefines.ts

属性

Added

Added
Added=(0)

社群频道列表新增事件。

Deleted

Deleted
Deleted=(1)

社群频道列表删除事件。

Updated

Updated
Updated=(2)

社群频道列表更新事件。

ZIMCommunityChannelMuteMode

社群频道禁言模式。

详情

社群频道禁言模式。

Declared in ZIMDefines.ts

属性

None

None
None=(0)

无禁言。

Normal

Normal
Normal=(1)

仅对社群频道内的非群主和管理员的其他所有成员禁言。

All

All
All=(2)

社群频道全员禁言,包括群主和管理员都不能发言。

Custom

Custom
Custom=(3)

自定义禁言模式,可以指定仅哪些角色不能发言。

ZIMCommunityMemberMuteType

社群成员禁言类型。

详情

社群成员禁言类型。

Declared in ZIMDefines.ts

属性

None

None
None=(0)

无禁言。

Community

Community
Community=(1)

社群维度禁言。

Channel

Channel
Channel=(2)

社群频道维度禁言。

ZIMCommunityMessageNotificationStatus

社群全局免打扰类型。

详情

社群全局免打扰类型。

Declared in ZIMDefines.ts

属性

Notify

Notify
Notify=(1)

社群全局通知,即非免打扰。

DoNotDisturb

DoNotDisturb
DoNotDisturb=(2)

社群全局免打扰。

ZIMCommunityMemberRole

社群成员角色。

详情

社群成员角色。

Declared in ZIMDefines.ts

属性

Owner

Owner
Owner=(1)

社群所有者。

Admin

Admin
Admin=(2)

社群管理员。

Member

Member
Member=(3)

普通成员。

上一篇

Interface

下一篇

功能总览

当前页

返回到顶部