Enum
ZIMConnectionState
Connection state.
Details
Connection state.
Declared in ZIMDefines.ts
Properties
Disconnected
Disconnected=(0)Unconnected state, enter this state before logging in and after logging out.
Connecting
Connecting=(1)The state that the connection is being requested. It will enter this state after successful execution login function.
Connected
Connected=(2)The state that is successfully connected.
Reconnecting
Reconnecting=(3)The connection is being reconnected.
ZIMConnectionEvent
The event that caused the connection status to change.
Details
The event that caused the connection status to change.
Declared in ZIMDefines.ts
Properties
Success
Success=(0)Success.
ActiveLogin
ActiveLogin=(1)The user actively logs in.
LoginTimeout
LoginTimeout=(2)Connection timed out.
LoginInterrupted
LoginInterrupted=(3)The network connection is temporarily interrupted.
KickedOut
KickedOut=(4)Being kicked out.
TokenExpired
TokenExpired=(5)Detail description: Disconnected due to expired login token.
Unregistered
Unregistered=(6)The user account was unregistered.
ZIMConversationEvent
conversation changed event.
Details
conversation changed event.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)A new conversation was added.
Updated
Updated=(1)The conversation was updated.
Disabled
Disabled=(2)The conversation was disabled.
Deleted
Deleted=(3)The conversation was deleted.
ZIMConversationListChangeAction
Conversation list change action.
Details
Conversation list change action.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)A conversation was added to the list.
Deleted
Deleted=(1)A conversation was deleted from the list.
Updated
Updated=(2)A conversation in the list was updated.
ZIMConversationNotificationStatus
Enumeration of conversation notification status.
Details
Enumeration of conversation notification status.
Declared in ZIMDefines.ts
Properties
Notify
Notify=(1)Message notifications are enabled.
DoNotDisturb
DoNotDisturb=(2)Do not disturb mode is enabled.
ZIMConversationType
Conversation type.
Details
Conversation type.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown conversation type.
Peer
Peer=(0)Conversation type peer.
Room
Room=(1)Conversation type room.
Group
Group=(2)Conversation type group.
CommunityChannel
CommunityChannel=(3)Community channel conversation type.
ZIMConversationSyncState
Identifies the SDK's state in syncing conversation list from server.
Details
Identifies the SDK's state in syncing conversation list from server.
Declared in ZIMDefines.ts
Properties
Started
Started=(0)Conversation list synchronization start status
Finished
Finished=(1)Conversation list synchronization completion status
Failed
Failed=(2)The synchronization of the conversation list failed. The synchronization failure may be caused by network reasons.
ZIMConversationPinnedFilter
When a user queries the session list, it serves as a filter item for the top session of the query.
Details
When a user queries the session list, it serves as a filter item for the top session of the query.
Declared in ZIMDefines.ts
Properties
All
All=(0)Both pinned and unpinned conversations can be queried.
OnlyPinned
OnlyPinned=(1)Only pinned conversations can be queried.
OnlyUnpinned
OnlyUnpinned=(2)Only unpinned conversations can be queried.
ZIMConversationSearchMode
Conversational search mode.
Details
Conversational search mode.
Declared in ZIMDefines.ts
Properties
MatchMessage
MatchMessage=(0)Query the corresponding conversation by searching for messages that meet the criteria.
MatchConversationName
MatchConversationName=(1)Query the corresponding conversation by searching for the conversation name.
ZIMMediaFileType
Media file type
Details
Media file type
Declared in ZIMDefines.ts
Properties
OriginalFile
OriginalFile=(1)Original file type, suitable for original images, audio files, and video files. After calling [downloadMediaFile], the SDK will update the fileLocalPath property in ZIMFileMessage.
LargeImage
LargeImage=(2)Large image type. After calling [downloadMediaFile], the SDK will update the largeImageLocalPath property in [ZIMImageMessage].
Thumbnail
Thumbnail=(3)Image thumbnail type. After calling [downloadMediaFile], the SDK will update the thumbnailLocalPath property in [ZIMImageMessage].
VideoFirstFrame
VideoFirstFrame=(4)The type of the first frame of the video. After calling [downloadMediaFile], the SDK will update the videoFirstFrameLocalPath property in [ZIMVideoMessage].
ZIMMessageDirection
the direction of the message.
Details
the direction of the message.
Declared in ZIMDefines.ts
Properties
Send
Send=(0)The message was sent by the local user.
Receive
Receive=(1)The message was received by the local user.
ZIMMessageOrder
Message order.
Details
Message order.
Declared in ZIMDefines.ts
Properties
Descending
Descending=(0)Represents message list in descending order (message list order is from new to old).
Ascending
Ascending=(1)Represents message list in ascending order (message list order is from old to new).
ZIMMessagePriority
The priority of the message.
Details
The priority of the message.
Declared in ZIMDefines.ts
Properties
Low
Low=(1)Low priority.
Medium
Medium=(2)Medium priority.
High
High=(3)High priority.
ZIMMessageQueryMode
.
Details
.
Declared in ZIMDefines.ts
Properties
General
General=(0)General mode. In this mode, the SDK automatically determines whether it needs to request merged message data from the server. This mode is recommended for most common scenarios.
PreferServer
PreferServer=(1)Server-priority query mode.
OnlyLocal
OnlyLocal=(2)Local-messages-only query mode.
ZIMMessageReceiptStatus
The status of the receipt
Details
The status of the receipt
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown receipt status.
None
None=(0)Not a receipt.
Processing
Processing=(1)Receipt in progress.
Done
Done=(2)Receipt completed.
Expired
Expired=(3)Receipt has expired.
Failed
Failed=(4)Receipt failed.
Delivered
Delivered=(5)Receipt delivered.
ZIMMessageReceiptFilterType
Filter type for the message receipt member list.
Details
Filter type for the message receipt member list.
Declared in ZIMDefines.ts
Properties
Read
Read=(0)Read members.
Unread
Unread=(1)Unread members.
Delivered
Delivered=(2)Delivered members.
ZIMMessageRevokeStatus
Message revoke status
Details
Message revoke status
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown revoke status.
SelfRevoke
SelfRevoke=(0)The message was revoked by the sender.
SystemRevoke
SystemRevoke=(1)The message was revoked by the system.
ServerApiRevoke
ServerApiRevoke=(2)The message was revoked via the server API.
GroupAdminRevoke
GroupAdminRevoke=(3)The message was revoked by a group administrator.
GroupOwnerRevoke
GroupOwnerRevoke=(4)The message was revoked by the group owner.
AuditRejectRevoke
AuditRejectRevoke=(5)Revoked for audit reject.
ZIMMessageSentStatus
The status of the message being sent.
Details
The status of the message being sent.
Declared in ZIMDefines.ts
Properties
Sending
Sending=(0)The message is being sent.
Success
Success=(1)The message was sent successfully.
Failed
Failed=(2)The message failed to send.
ZIMMessageType
The type of the message.
Details
The type of the message.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(0)Unknown message.
Text
Text=(1)Normal text message.
Command
Command=(2)Custom binary message.
Multiple
Multiple=(10)Multiple messages can be used to send multiple messages of text, rich media files, and custom messages.
Image
Image=(11)Image message.
File
File=(12)File message.
Audio
Audio=(13)Audio message.
Video
Video=(14)Video message.
Barrage
Barrage=(20)Barrage message.
Revoke
Revoke=(31)Reovked message.
Tips
Tips=(32)Tips message.
Combine
Combine=(100)Combined message.
Custom
Custom=(200)Custom message.
ZIMRevokeType
The type of the revoke message.
Details
The type of the revoke message.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown revoke type.
TwoWay
TwoWay=(0)Two-way revoke: the message is deleted for both sender and recipient.
OneWay
OneWay=(1)One-way revoke: the message is deleted for the sender only.
ZIMTipsMessageEvent
Event of tips message.
Details
Event of tips message.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(0)Unknown tips message event.
GroupCreated
GroupCreated=(1)The group was created.
GroupDismissed
GroupDismissed=(2)The group was dismissed.
GroupJoined
GroupJoined=(3)A member joined the group.
GroupInvited
GroupInvited=(4)A member was invited to join the group.
GroupLeft
GroupLeft=(5)A member left the group.
GroupKickedOut
GroupKickedOut=(6)A member was kicked out of the group.
GroupInfoChanged
GroupInfoChanged=(7)The group information was changed.
GroupMemberInfoChanged
GroupMemberInfoChanged=(8)The group member information was changed.
GroupMessagePinned
GroupMessagePinned=(9)A group message was pinned.
CommunityCreated
CommunityCreated=(101)The community was created.
CommunityJoined
CommunityJoined=(103)A member joined the community.
CommunityInvited
CommunityInvited=(104)A member was invited to join the community.
CommunityChannelCreated
CommunityChannelCreated=(151)A community channel was created.
ZIMTipsMessageChangeInfoType
Type of additional information for tips messages.
Details
Type of additional information for tips messages.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(0)Unknown change info type.
GroupDataChanged
GroupDataChanged=(1)Group name, group avatar, and group notice have multiple changes.
GroupNoticeChanged
GroupNoticeChanged=(2)Group notice change event.
GroupNameChanged
GroupNameChanged=(3)Group name change event.
GroupAvatarUrlChanged
GroupAvatarUrlChanged=(4)Group avatar change event.
GroupMuteChanged
GroupMuteChanged=(5)Group mute info change event.
GroupOwnerTransferred
GroupOwnerTransferred=(10)Group owner transfer event.
GroupMemberRoleChanged
GroupMemberRoleChanged=(11)Group member role change event.
GroupMemberMuteChanged
GroupMemberMuteChanged=(12)The group member mute status changed.
GroupMessagePinInfoChanged
GroupMessagePinInfoChanged=(21)Group messages are pinned or unpinned event.
ZIMMessageMentionedType
The type of the revoke message.
Details
The type of the revoke message.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(0)Unknown mention type.
MentionMe
MentionMe=(1)mention me
MentionAll
MentionAll=(2)mention all user
MentionAllAndMe
MentionAllAndMe=(3)mention all user and mention me
ZIMMessageDeleteType
Message deleted type
Details
Message deleted type
Declared in ZIMDefines.ts
Properties
MessageListDeleted
MessageListDeleted=(0)User-initiated message deletion event.
ConversationAllMessagesDeleted
ConversationAllMessagesDeleted=(1)User-initiated event for deleting all messages in a conversation.
AllConversationMessagesDeleted
AllConversationMessagesDeleted=(2)User-initiated event for deleting all messages across all conversations.
MessagesDestructed
MessagesDestructed=(3)Message deletion event triggered by scheduled message self-destruction.
ZIMMessageRepliedInfoState
The state of the source message to be replied.
Details
The state of the source message to be replied.
Declared in ZIMDefines.ts
Properties
Normal
Normal=(0)normal state.
Deleted
Deleted=(1)deleted state.
NotFound
NotFound=(2)Not found. The original message may have expired on the server or is not visible to the current user.
ZIMMessagePinStatus
Enumeration of message pinned status.
Details
Enumeration of message pinned status.
Declared in ZIMDefines.ts
Properties
NotPinned
NotPinned=(0)The message is not pinned.
Pinned
Pinned=(1)The message is pinned.
Updated
Updated=(2)The message pin status was updated.
ZIMMessageReactionUserChangeAction
User operation action for message reactions.
Details
User operation action for message reactions.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)Add message reaction.
Deleted
Deleted=(1)Delete message reaction.
ZIMRoomEvent
The event that caused the room connection status to change.
Details
The event that caused the room connection status to change.
Declared in ZIMDefines.ts
Properties
Success
Success=(0)Success.
NetworkInterrupted
NetworkInterrupted=(1)The network in the room is temporarily interrupted.
NetworkDisconnected
NetworkDisconnected=(2)The network in the room is disconnected.
RoomNotExist
RoomNotExist=(3)The room not exist.
ActiveCreate
ActiveCreate=(4)The user actively creates a room.
CreateFailed
CreateFailed=(5)Failed to create room.
ActiveEnter
ActiveEnter=(6)The user starts to enter the room.
EnterFailed
EnterFailed=(7)user failed to enter the room.
KickedOut
KickedOut=(8)user was kicked out of the room.
ConnectTimeout
ConnectTimeout=(9)The connection to the room timed out.
KickedOutByOtherDevice
KickedOutByOtherDevice=(10)Multi-device logins into the same room will result in the user being kicked out of the room.
ActiveSwitch
ActiveSwitch=(11)Switch room.
SwitchFailed
SwitchFailed=(12)Switch room failed.
ZIMRoomState
Used to indicate the user's connection status to the room.
Details
Used to indicate the user's connection status to the room.
Declared in ZIMDefines.ts
Properties
Disconnected
Disconnected=(0)Indicates that the connection to the room is interrupted, and the [createRoom], [joinRoom], and [enterRoom] fails. If the network is disconnected for a long time, the heartbeat of the room times out, the background notifies the user that he has been kicked out of the room, or the logout will throw this status.
Connecting
Connecting=(1)connecting indicates that the connection between a room and a room is in the connecting state. When the create, join, or enter room connection is not returned, this state is thrown when the network is disconnected.
Connected
Connected=(2)connected indicates that the device is properly connected to the room. If create, join, or enter room succeeds, the state will be thrown if the network is disconnected and the room heartbeat does not time out.
ZIMRoomAttributesUpdateAction
Room attributes update action.
Details
Room attributes update action.
Declared in ZIMDefines.ts
Properties
Set
Set=(0)Set action.
Delete
Delete=(1)Delete the room attributes.
ZIMRoomMemberAttributesUpdateAction
The action type for room member attribute updates.
Details
The action type for room member attribute updates.
Declared in ZIMDefines.ts
Properties
Set
Set=(0)Set the room member attributes.
ZIMGroupState
group status.
Details
group status.
Declared in ZIMDefines.ts
Properties
Quit
Quit=(0)The local user has left the group.
Enter
Enter=(1)The local user has entered the group.
ZIMGroupEvent
Group events.
Details
Group events.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown event.
Created
Created=(1)The group was created.
Dismissed
Dismissed=(2)The group was dismissed.
Joined
Joined=(3)A member joined the group.
Invited
Invited=(4)A member was invited to join the group.
Left
Left=(5)A member left the group.
KickedOut
KickedOut=(6)A member was kicked out of the group.
ZIMGroupMemberEvent
Group member events.
Details
Group member events.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown event.
Joined
Joined=(1)A member joined the group.
Left
Left=(2)A member left the group.
KickedOut
KickedOut=(4)A member was kicked out of the group.
Invited
Invited=(5)A member was invited to join the group.
ZIMGroupMemberState
group membership status.
Details
group membership status.
Declared in ZIMDefines.ts
Properties
Quit
Quit=(0)The member has left the group.
Enter
Enter=(1)The member has entered the group.
ZIMGroupMessageNotificationStatus
Enumeration of group notification status.
Details
Enumeration of group notification status.
Declared in ZIMDefines.ts
Properties
Notify
Notify=(1)Message notifications are enabled.
DoNotDisturb
DoNotDisturb=(2)Do not disturb mode is enabled.
ZIMGroupAttributesUpdateAction
Group attributes update action.
Details
Group attributes update action.
Declared in ZIMDefines.ts
Properties
Set
Set=(0)Set action.
Delete
Delete=(1)Delete the group attributes.
ZIMGroupMuteMode
Group mute mode.
Details
Group mute mode.
Declared in ZIMDefines.ts
Properties
None
None=(0)Unmute.
Normal
Normal=(1)Group normal members mute mode.
All
All=(2)Group all members mute mode.
Custom
Custom=(3)Customize group mute mode
ZIMGroupJoinMode
Verification mode for joining the group.
Details
Verification mode for joining the group.
Declared in ZIMDefines.ts
Properties
Any
Any=(0)Anyone can join the group directly.
Auth
Auth=(1)Requires group owner or administrator approval.
Forbid
Forbid=(2)Joining the group is prohibited.
ZIMGroupInviteMode
Verification mode for invite to the group.
Details
Verification mode for invite to the group.
Declared in ZIMDefines.ts
Properties
Any
Any=(0)Everyone in the group can invite.
Admin
Admin=(1)Only group owners or administrators can invite.
ZIMGroupBeInviteMode
Verification mode for being invited to the group.
Details
Verification mode for being invited to the group.
Declared in ZIMDefines.ts
Properties
None
None=(0)The invitees enter the group directly.
Auth
Auth=(1)The invitee's consent is required to join the group.
ZIMGroupEnterType
Group enter type.
Details
Group enter type.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(0)Unknown enter type.
Created
Created=(1)The user created the group.
JoinApply
JoinApply=(2)The user joined the group via an application.
Joined
Joined=(3)The user actively joined the group.
Invited
Invited=(4)The user was invited to join the group.
InviteApply
InviteApply=(5)The user joined the group via invitation application.
ZIMGroupApplicationType
Group application type.
Details
Group application type.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown group application type.
None
None=(0)None.
Join
Join=(1)Join type.
Invite
Invite=(2)Invite type.
BeInvite
BeInvite=(3)Be invite type.
ZIMGroupApplicationState
Group application state.
Details
Group application state.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown group application state.
Waiting
Waiting=(1)Awaiting response.
Accepted
Accepted=(2)Accepted.
Rejected
Rejected=(3)Rejected.
Expired
Expired=(4)Expired.
Disabled
Disabled=(5)Disabled
ZIMGroupApplicationListChangeAction
Group application list update action.
Details
Group application list update action.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)Add action.
ZIMCallInvitationMode
Call invitation mode.
Details
Call invitation mode.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown type, as a guaranteed enumeration value.
General
General=(0)general.
Advanced
Advanced=(1)advanced
ZIMCallState
call status.
Details
call status.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown call state.
Started
Started=(1)The call has started.
Ended
Ended=(2)The call has ended.
ZIMCallUserState
Call user status.
Details
Call user status.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)unknown
Inviting
Inviting=(0)inviting.
Accepted
Accepted=(1)accepted.
Rejected
Rejected=(2)rejected.
Cancelled
Cancelled=(3)cancelled.
Received
Received=(5)received.
Timeout
Timeout=(6)timeout.
Quit
Quit=(7)quit.
Ended
Ended=(8)ended.
NotYetReceived
NotYetReceived=(9)Not received.
BeCancelled
BeCancelled=(10)Be cancelled.
ZIMUserInfoType
User type.
Details
User type.
Declared in ZIMDefines.ts
Properties
BasicUser
BasicUser=(1)Basic user type.
RoomMember
RoomMember=(2)Room member type.
GroupMember
GroupMember=(3)Group member type.
GroupSimpleMember
GroupSimpleMember=(4)Group member brief info type.
Friend
Friend=(5)Friend type.
CommunityMember
CommunityMember=(6)Community member type.
CommunitySimpleMember
CommunitySimpleMember=(7)Community member brief info type.
ZIMFriendListChangeAction
friend list update action.
Details
friend list update action.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)Add action.
Deleted
Deleted=(1)Delete action.
ZIMFriendApplicationListChangeAction
friend application list update action.
Details
friend application list update action.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)Add action.
Deleted
Deleted=(1)Delete action.
ZIMFriendApplicationType
Friend application type.
Details
Friend application type.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown friend application type.
None
None=(0)Friend application type none.
Received
Received=(1)Applications received.
Sent
Sent=(2)Application sent.
Both
Both=(3)Both parties sent friend applications to each other.
ZIMFriendApplicationState
Friend application state.
Details
Friend application state.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown friend application state.
Waiting
Waiting=(1)Awaiting response.
Accepted
Accepted=(2)Accepted.
Rejected
Rejected=(3)Rejected.
Expired
Expired=(4)The friend application has expired.
Disabled
Disabled=(5)The friend application is disabled.
ZIMFriendRelationCheckType
Check the friend relationship type.
Details
Check the friend relationship type.
Declared in ZIMDefines.ts
Properties
Both
Both=(0)Check the friend relationship from both sides.
Single
Single=(1)Check the friend relationship from one side only.
ZIMFriendDeleteType
Delete friend type.
Details
Delete friend type.
Declared in ZIMDefines.ts
Properties
Both
Both=(0)Delete the friend from both sides.
Single
Single=(1)Delete the friend from one side only.
ZIMUserRelationType
Friend relationship type.
Details
Friend relationship type.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(0)Unknown relation type.
SingleNo
SingleNo=(1)No friendship from the user's perspective.
SingleHave
SingleHave=(2)Friendship exists from the user's perspective.
BothAllNo
BothAllNo=(3)No friendship from either side.
BothSelfHave
BothSelfHave=(4)The user has added the other as a friend, but not vice versa.
BothOtherHave
BothOtherHave=(5)The other party has added the user as a friend, but not vice versa.
BothAllHave
BothAllHave=(6)Both parties are friends with each other.
ZIMBlacklistChangeAction
blacklist update action.
Details
blacklist update action.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)Add action.
Removed
Removed=(1)Removed action.
ZIMCXHandleType
Type of contact information for the VoIP initiator.
Details
Type of contact information for the VoIP initiator.
Declared in ZIMDefines.ts
Properties
Generic
Generic=(1)Generic handle type.
PhoneNumber
PhoneNumber=(2)Phone number handle type.
EmailAddress
EmailAddress=(3)Email address handle type.
ZIMGeofencingType
Geofencing type.
Details
Geofencing type.
Declared in ZIMDefines.ts
Properties
None
None=(0)The default type.
Include
Include=(1)Federated mode.
Exclude
Exclude=(2)Exclusion mode.
ZIMPlatformType
Platform on which the SDK runs.
Details
Platform on which the SDK runs.
Declared in ZIMDefines.ts
Properties
Win
Win=(1)Windows.
IPhoneOS
IPhoneOS=(2)iOS.
Android
Android=(3)Android.
MacOS
MacOS=(4)MacOS.
Linux
Linux=(5)Linux.
Web
Web=(6)Web.
MiniProgram
MiniProgram=(7)Mini program.
IPadOS
IPadOS=(9)iPad.
OHOS
OHOS=(10)HarmonyOS (OHOS) platform.
Unknown
Unknown=(32)Platforms not mentioned above.
ZIMUserOnlineStatus
User online status.
Details
User online status.
Declared in ZIMDefines.ts
Properties
Online
Online=(0)Online. The user is in this state when the user is logged in and the network status is good.
Offline
Offline=(1)Offline. The user does not call logout to actively logout because the network is disconnected, the app is killed, the background is withdrawn, and the screen is locked. The user will be in this state after the long background link is disconnected.
Logout
Logout=(2)Log out. User active logout will be in this state.
Unknown
Unknown=(99)Unknown status. Guaranteed enumeration.
ZIMListChangeAction
The action type for list changes.
Details
The action type for list changes.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)An item was added.
Deleted
Deleted=(1)An item was deleted.
ZIMCommunityListChangeAction
The action type for community list changes.
Details
The action type for community list changes.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)A community was added.
Deleted
Deleted=(1)A community was deleted.
Updated
Updated=(2)A community was updated.
ZIMCommunityMemberEnterType
The enter type for community members.
Details
The enter type for community members.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(0)Unknown enter type.
CommunityCreated
CommunityCreated=(1)The member joined when the community was created.
CommunityJoined
CommunityJoined=(2)The member actively joined the community.
CommunityInvited
CommunityInvited=(3)The member was invited to join the community.
ZIMCommunityMemberChangeState
The state change type for community members.
Details
The state change type for community members.
Declared in ZIMDefines.ts
Properties
Exited
Exited=(0)The member exited the community.
Entered
Entered=(1)The member entered the community.
ZIMCommunityMemberChangeAction
The action type for community member status changes.
Details
The action type for community member status changes.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(0)Unknown action.
Joined
Joined=(1)The member actively joined the community.
Invited
Invited=(2)The member was invited to join the community.
Left
Left=(3)The member actively left the community.
KickedOut
KickedOut=(4)The member was kicked out of the community.
ZIMCommunityChannelType
The type of community channel.
Details
The type of community channel.
Declared in ZIMDefines.ts
Properties
Unknown
Unknown=(-1)Unknown channel.
General
General=(0)Default channel, automatically created when the community is created.
Public
Public=(1)Public channel, visible to all members of the community.
Private
Private=(2)Private channel, visible only to specific members.
ZIMCommunityChannelListChangeAction
The action type for community channel list changes.
Details
The action type for community channel list changes.
Declared in ZIMDefines.ts
Properties
Added
Added=(0)A community channel was added.
Deleted
Deleted=(1)A community channel was deleted.
Updated
Updated=(2)A community channel was updated.
ZIMCommunityChannelMuteMode
The mute mode for community channels.
Details
The mute mode for community channels.
Declared in ZIMDefines.ts
Properties
None
None=(0)No mute mode.
Normal
Normal=(1)Normal mute mode; only administrators and the owner can speak.
All
All=(2)All members are muted.
Custom
Custom=(3)Custom mute mode.
ZIMCommunityMemberMuteType
The mute type for community members.
Details
The mute type for community members.
Declared in ZIMDefines.ts
Properties
None
None=(0)Not muted.
Community
Community=(1)Muted at the community level.
Channel
Channel=(2)Muted at the community channel level.
ZIMCommunityMessageNotificationStatus
The notification status for community messages.
Details
The notification status for community messages.
Declared in ZIMDefines.ts
Properties
Notify
Notify=(1)Message notifications are enabled.
DoNotDisturb
DoNotDisturb=(2)Do not disturb mode is enabled.
ZIMCommunityMemberRole
Community member role
Details
Community member role
Declared in ZIMDefines.ts
Properties
Owner
Owner=(1)Community Owner.
Admin
Admin=(2)Community Admin.
Member
Member=(3)Community Member.