Enum
ZIMConnectionState
Connection state.
Details
Connection state.
Declared in ZIMDefines.h
Properties
ZIMConnectionStateDisconnected
ZIMConnectionStateDisconnected=(0)Unconnected state, enter this state before logging in and after logging out.
ZIMConnectionStateConnecting
ZIMConnectionStateConnecting=(1)The state that the connection is being requested. It will enter this state after successful execution login function.
ZIMConnectionStateConnected
ZIMConnectionStateConnected=(2)The state that is successfully connected.
ZIMConnectionStateReconnecting
ZIMConnectionStateReconnecting=(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.h
Properties
ZIMConnectionEventSuccess
ZIMConnectionEventSuccess=(0)Success.
ZIMConnectionEventActiveLogin
ZIMConnectionEventActiveLogin=(1)The user actively logs in.
ZIMConnectionEventLoginTimeout
ZIMConnectionEventLoginTimeout=(2)Connection timed out.
ZIMConnectionEventLoginInterrupted
ZIMConnectionEventLoginInterrupted=(3)The network connection is temporarily interrupted.
ZIMConnectionEventKickedOut
ZIMConnectionEventKickedOut=(4)Being kicked out.
ZIMConnectionEventTokenExpired
ZIMConnectionEventTokenExpired=(5)Detail description: Disconnected due to expired login token.
ZIMConnectionEventUnregistered
ZIMConnectionEventUnregistered=(6)The user account was unregistered.
ZIMConversationEvent
conversation changed event.
Details
conversation changed event.
Declared in ZIMDefines.h
Properties
ZIMConversationEventAdded
ZIMConversationEventAdded=(0)A new conversation was added.
ZIMConversationEventUpdated
ZIMConversationEventUpdated=(1)The conversation was updated.
ZIMConversationEventDisabled
ZIMConversationEventDisabled=(2)The conversation was disabled.
ZIMConversationEventDeleted
ZIMConversationEventDeleted=(3)The conversation was deleted.
ZIMConversationListChangeAction
Conversation list change action.
Details
Conversation list change action.
Declared in ZIMDefines.h
Properties
ZIMConversationListChangeActionAdded
ZIMConversationListChangeActionAdded=(0)A conversation was added to the list.
ZIMConversationListChangeActionDeleted
ZIMConversationListChangeActionDeleted=(1)A conversation was deleted from the list.
ZIMConversationListChangeActionUpdated
ZIMConversationListChangeActionUpdated=(2)A conversation in the list was updated.
ZIMConversationNotificationStatus
Enumeration of conversation notification status.
Details
Enumeration of conversation notification status.
Declared in ZIMDefines.h
Properties
ZIMConversationNotificationStatusNotify
ZIMConversationNotificationStatusNotify=(1)Message notifications are enabled.
ZIMConversationNotificationStatusDoNotDisturb
ZIMConversationNotificationStatusDoNotDisturb=(2)Do not disturb mode is enabled.
ZIMConversationType
Conversation type.
Details
Conversation type.
Declared in ZIMDefines.h
Properties
ZIMConversationTypeUnknown
ZIMConversationTypeUnknown=(-1)Unknown conversation type.
ZIMConversationTypePeer
ZIMConversationTypePeer=(0)Conversation type peer.
ZIMConversationTypeRoom
ZIMConversationTypeRoom=(1)Conversation type room.
ZIMConversationTypeGroup
ZIMConversationTypeGroup=(2)Conversation type group.
ZIMConversationTypeCommunityChannel
ZIMConversationTypeCommunityChannel=(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.h
Properties
ZIMConversationSyncStateStarted
ZIMConversationSyncStateStarted=(0)Conversation list synchronization start status
ZIMConversationSyncStateFinished
ZIMConversationSyncStateFinished=(1)Conversation list synchronization completion status
ZIMConversationSyncStateFailed
ZIMConversationSyncStateFailed=(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.h
Properties
ZIMConversationPinnedFilterAll
ZIMConversationPinnedFilterAll=(0)Both pinned and unpinned conversations can be queried.
ZIMConversationPinnedFilterOnlyPinned
ZIMConversationPinnedFilterOnlyPinned=(1)Only pinned conversations can be queried.
ZIMConversationPinnedFilterOnlyUnpinned
ZIMConversationPinnedFilterOnlyUnpinned=(2)Only unpinned conversations can be queried.
ZIMConversationSearchMode
Conversational search mode.
Details
Conversational search mode.
Declared in ZIMDefines.h
Properties
ZIMConversationSearchModeMatchMessage
ZIMConversationSearchModeMatchMessage=(0)Query the corresponding conversation by searching for messages that meet the criteria.
ZIMConversationSearchModeMatchConversationName
ZIMConversationSearchModeMatchConversationName=(1)Query the corresponding conversation by searching for the conversation name.
ZIMMediaFileType
Media file type
Details
Media file type
Declared in ZIMDefines.h
Properties
ZIMMediaFileTypeOriginalFile
ZIMMediaFileTypeOriginalFile=(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.
ZIMMediaFileTypeLargeImage
ZIMMediaFileTypeLargeImage=(2)Large image type. After calling [downloadMediaFile], the SDK will update the largeImageLocalPath property in [ZIMImageMessage].
ZIMMediaFileTypeThumbnail
ZIMMediaFileTypeThumbnail=(3)Image thumbnail type. After calling [downloadMediaFile], the SDK will update the thumbnailLocalPath property in [ZIMImageMessage].
ZIMMediaFileTypeVideoFirstFrame
ZIMMediaFileTypeVideoFirstFrame=(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.h
Properties
ZIMMessageDirectionSend
ZIMMessageDirectionSend=(0)The message was sent by the local user.
ZIMMessageDirectionReceive
ZIMMessageDirectionReceive=(1)The message was received by the local user.
ZIMMessageOrder
Message order.
Details
Message order.
Declared in ZIMDefines.h
Properties
ZIMMessageOrderDescending
ZIMMessageOrderDescending=(0)Represents message list in descending order (message list order is from new to old).
ZIMMessageOrderAscending
ZIMMessageOrderAscending=(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.h
Properties
ZIMMessagePriorityLow
ZIMMessagePriorityLow=(1)Low priority.
ZIMMessagePriorityMedium
ZIMMessagePriorityMedium=(2)Medium priority.
ZIMMessagePriorityHigh
ZIMMessagePriorityHigh=(3)High priority.
ZIMMessageQueryMode
.
Details
.
Declared in ZIMDefines.h
Properties
ZIMMessageQueryModeGeneral
ZIMMessageQueryModeGeneral=(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.
ZIMMessageQueryModePreferServer
ZIMMessageQueryModePreferServer=(1)Server-priority query mode.
ZIMMessageQueryModeOnlyLocal
ZIMMessageQueryModeOnlyLocal=(2)Local-messages-only query mode.
ZIMMessageReceiptStatus
The status of the receipt
Details
The status of the receipt
Declared in ZIMDefines.h
Properties
ZIMMessageReceiptStatusUnknown
ZIMMessageReceiptStatusUnknown=(-1)Unknown receipt status.
ZIMMessageReceiptStatusNone
ZIMMessageReceiptStatusNone=(0)Not a receipt.
ZIMMessageReceiptStatusProcessing
ZIMMessageReceiptStatusProcessing=(1)Receipt in progress.
ZIMMessageReceiptStatusDone
ZIMMessageReceiptStatusDone=(2)Receipt completed.
ZIMMessageReceiptStatusExpired
ZIMMessageReceiptStatusExpired=(3)Receipt has expired.
ZIMMessageReceiptStatusFailed
ZIMMessageReceiptStatusFailed=(4)Receipt failed.
ZIMMessageReceiptStatusDelivered
ZIMMessageReceiptStatusDelivered=(5)Receipt delivered.
ZIMMessageReceiptFilterType
Filter type for the message receipt member list.
Details
Filter type for the message receipt member list.
Declared in ZIMDefines.h
Properties
ZIMMessageReceiptFilterTypeRead
ZIMMessageReceiptFilterTypeRead=(0)Read members.
ZIMMessageReceiptFilterTypeUnread
ZIMMessageReceiptFilterTypeUnread=(1)Unread members.
ZIMMessageReceiptFilterTypeDelivered
ZIMMessageReceiptFilterTypeDelivered=(2)Delivered members.
ZIMMessageRevokeStatus
Message revoke status
Details
Message revoke status
Declared in ZIMDefines.h
Properties
ZIMMessageRevokeStatusUnknown
ZIMMessageRevokeStatusUnknown=(-1)Unknown revoke status.
ZIMMessageRevokeStatusSelfRevoke
ZIMMessageRevokeStatusSelfRevoke=(0)The message was revoked by the sender.
ZIMMessageRevokeStatusSystemRevoke
ZIMMessageRevokeStatusSystemRevoke=(1)The message was revoked by the system.
ZIMMessageRevokeStatusServerApiRevoke
ZIMMessageRevokeStatusServerApiRevoke=(2)The message was revoked via the server API.
ZIMMessageRevokeStatusGroupAdminRevoke
ZIMMessageRevokeStatusGroupAdminRevoke=(3)The message was revoked by a group administrator.
ZIMMessageRevokeStatusGroupOwnerRevoke
ZIMMessageRevokeStatusGroupOwnerRevoke=(4)The message was revoked by the group owner.
ZIMMessageRevokeStatusAuditRejectRevoke
ZIMMessageRevokeStatusAuditRejectRevoke=(5)Revoked for audit reject.
ZIMMessageSentStatus
The status of the message being sent.
Details
The status of the message being sent.
Declared in ZIMDefines.h
Properties
ZIMMessageSentStatusSending
ZIMMessageSentStatusSending=(0)The message is being sent.
ZIMMessageSentStatusSuccess
ZIMMessageSentStatusSuccess=(1)The message was sent successfully.
ZIMMessageSentStatusFailed
ZIMMessageSentStatusFailed=(2)The message failed to send.
ZIMMessageType
The type of the message.
Details
The type of the message.
Declared in ZIMDefines.h
Properties
ZIMMessageTypeUnknown
ZIMMessageTypeUnknown=(0)Unknown message.
ZIMMessageTypeText
ZIMMessageTypeText=(1)Normal text message.
ZIMMessageTypeCommand
ZIMMessageTypeCommand=(2)Custom binary message.
ZIMMessageTypeMultiple
ZIMMessageTypeMultiple=(10)Multiple messages can be used to send multiple messages of text, rich media files, and custom messages.
ZIMMessageTypeImage
ZIMMessageTypeImage=(11)Image message.
ZIMMessageTypeFile
ZIMMessageTypeFile=(12)File message.
ZIMMessageTypeAudio
ZIMMessageTypeAudio=(13)Audio message.
ZIMMessageTypeVideo
ZIMMessageTypeVideo=(14)Video message.
ZIMMessageTypeBarrage
ZIMMessageTypeBarrage=(20)Barrage message.
ZIMMessageTypeRevoke
ZIMMessageTypeRevoke=(31)Reovked message.
ZIMMessageTypeTips
ZIMMessageTypeTips=(32)Tips message.
ZIMMessageTypeCombine
ZIMMessageTypeCombine=(100)Combined message.
ZIMMessageTypeCustom
ZIMMessageTypeCustom=(200)Custom message.
ZIMRevokeType
The type of the revoke message.
Details
The type of the revoke message.
Declared in ZIMDefines.h
Properties
ZIMRevokeTypeUnknown
ZIMRevokeTypeUnknown=(-1)Unknown revoke type.
ZIMRevokeTypeTwoWay
ZIMRevokeTypeTwoWay=(0)Two-way revoke: the message is deleted for both sender and recipient.
ZIMRevokeTypeOneWay
ZIMRevokeTypeOneWay=(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.h
Properties
ZIMTipsMessageEventUnknown
ZIMTipsMessageEventUnknown=(0)Unknown tips message event.
ZIMTipsMessageEventGroupCreated
ZIMTipsMessageEventGroupCreated=(1)The group was created.
ZIMTipsMessageEventGroupDismissed
ZIMTipsMessageEventGroupDismissed=(2)The group was dismissed.
ZIMTipsMessageEventGroupJoined
ZIMTipsMessageEventGroupJoined=(3)A member joined the group.
ZIMTipsMessageEventGroupInvited
ZIMTipsMessageEventGroupInvited=(4)A member was invited to join the group.
ZIMTipsMessageEventGroupLeft
ZIMTipsMessageEventGroupLeft=(5)A member left the group.
ZIMTipsMessageEventGroupKickedOut
ZIMTipsMessageEventGroupKickedOut=(6)A member was kicked out of the group.
ZIMTipsMessageEventGroupInfoChanged
ZIMTipsMessageEventGroupInfoChanged=(7)The group information was changed.
ZIMTipsMessageEventGroupMemberInfoChanged
ZIMTipsMessageEventGroupMemberInfoChanged=(8)The group member information was changed.
ZIMTipsMessageEventGroupMessagePinned
ZIMTipsMessageEventGroupMessagePinned=(9)A group message was pinned.
ZIMTipsMessageEventCommunityCreated
ZIMTipsMessageEventCommunityCreated=(101)The community was created.
ZIMTipsMessageEventCommunityJoined
ZIMTipsMessageEventCommunityJoined=(103)A member joined the community.
ZIMTipsMessageEventCommunityInvited
ZIMTipsMessageEventCommunityInvited=(104)A member was invited to join the community.
ZIMTipsMessageEventCommunityChannelCreated
ZIMTipsMessageEventCommunityChannelCreated=(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.h
Properties
ZIMTipsMessageChangeInfoTypeUnknown
ZIMTipsMessageChangeInfoTypeUnknown=(0)Unknown change info type.
ZIMTipsMessageChangeInfoTypeGroupDataChanged
ZIMTipsMessageChangeInfoTypeGroupDataChanged=(1)Group name, group avatar, and group notice have multiple changes.
ZIMTipsMessageChangeInfoTypeGroupNoticeChanged
ZIMTipsMessageChangeInfoTypeGroupNoticeChanged=(2)Group notice change event.
ZIMTipsMessageChangeInfoTypeGroupNameChanged
ZIMTipsMessageChangeInfoTypeGroupNameChanged=(3)Group name change event.
ZIMTipsMessageChangeInfoTypeGroupAvatarUrlChanged
ZIMTipsMessageChangeInfoTypeGroupAvatarUrlChanged=(4)Group avatar change event.
ZIMTipsMessageChangeInfoTypeGroupMuteChanged
ZIMTipsMessageChangeInfoTypeGroupMuteChanged=(5)Group mute info change event.
ZIMTipsMessageChangeInfoTypeGroupOwnerTransferred
ZIMTipsMessageChangeInfoTypeGroupOwnerTransferred=(10)Group owner transfer event.
ZIMTipsMessageChangeInfoTypeGroupMemberRoleChanged
ZIMTipsMessageChangeInfoTypeGroupMemberRoleChanged=(11)Group member role change event.
ZIMTipsMessageChangeInfoTypeGroupMemberMuteChanged
ZIMTipsMessageChangeInfoTypeGroupMemberMuteChanged=(12)The group member mute status changed.
ZIMTipsMessageChangeInfoTypeGroupMessagePinInfoChanged
ZIMTipsMessageChangeInfoTypeGroupMessagePinInfoChanged=(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.h
Properties
ZIMMessageMentionedTypeUnknown
ZIMMessageMentionedTypeUnknown=(0)Unknown mention type.
ZIMMessageMentionedTypeMentionMe
ZIMMessageMentionedTypeMentionMe=(1)mention me
ZIMMessageMentionedTypeMentionAll
ZIMMessageMentionedTypeMentionAll=(2)mention all user
ZIMMessageMentionedTypeMentionAllAndMe
ZIMMessageMentionedTypeMentionAllAndMe=(3)mention all user and mention me
ZIMMessageDeleteType
Message deleted type
Details
Message deleted type
Declared in ZIMDefines.h
Properties
ZIMMessageDeleteTypeMessageListDeleted
ZIMMessageDeleteTypeMessageListDeleted=(0)User-initiated message deletion event.
ZIMMessageDeleteTypeConversationAllMessagesDeleted
ZIMMessageDeleteTypeConversationAllMessagesDeleted=(1)User-initiated event for deleting all messages in a conversation.
ZIMMessageDeleteTypeAllConversationMessagesDeleted
ZIMMessageDeleteTypeAllConversationMessagesDeleted=(2)User-initiated event for deleting all messages across all conversations.
ZIMMessageDeleteTypeMessagesDestructed
ZIMMessageDeleteTypeMessagesDestructed=(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.h
Properties
ZIMMessageRepliedInfoStateNormal
ZIMMessageRepliedInfoStateNormal=(0)normal state.
ZIMMessageRepliedInfoStateDeleted
ZIMMessageRepliedInfoStateDeleted=(1)deleted state.
ZIMMessageRepliedInfoStateNotFound
ZIMMessageRepliedInfoStateNotFound=(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.h
Properties
ZIMMessagePinStatusNotPinned
ZIMMessagePinStatusNotPinned=(0)The message is not pinned.
ZIMMessagePinStatusPinned
ZIMMessagePinStatusPinned=(1)The message is pinned.
ZIMMessagePinStatusUpdated
ZIMMessagePinStatusUpdated=(2)The message pin status was updated.
ZIMMessageReactionUserChangeAction
User operation action for message reactions.
Details
User operation action for message reactions.
Declared in ZIMDefines.h
Properties
ZIMMessageReactionUserChangeActionAdded
ZIMMessageReactionUserChangeActionAdded=(0)Add message reaction.
ZIMMessageReactionUserChangeActionDeleted
ZIMMessageReactionUserChangeActionDeleted=(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.h
Properties
ZIMRoomEventSuccess
ZIMRoomEventSuccess=(0)Success.
ZIMRoomEventNetworkInterrupted
ZIMRoomEventNetworkInterrupted=(1)The network in the room is temporarily interrupted.
ZIMRoomEventNetworkDisconnected
ZIMRoomEventNetworkDisconnected=(2)The network in the room is disconnected.
ZIMRoomEventRoomNotExist
ZIMRoomEventRoomNotExist=(3)The room not exist.
ZIMRoomEventActiveCreate
ZIMRoomEventActiveCreate=(4)The user actively creates a room.
ZIMRoomEventCreateFailed
ZIMRoomEventCreateFailed=(5)Failed to create room.
ZIMRoomEventActiveEnter
ZIMRoomEventActiveEnter=(6)The user starts to enter the room.
ZIMRoomEventEnterFailed
ZIMRoomEventEnterFailed=(7)user failed to enter the room.
ZIMRoomEventKickedOut
ZIMRoomEventKickedOut=(8)user was kicked out of the room.
ZIMRoomEventConnectTimeout
ZIMRoomEventConnectTimeout=(9)The connection to the room timed out.
ZIMRoomEventKickedOutByOtherDevice
ZIMRoomEventKickedOutByOtherDevice=(10)Multi-device logins into the same room will result in the user being kicked out of the room.
ZIMRoomEventActiveSwitch
ZIMRoomEventActiveSwitch=(11)Switch room.
ZIMRoomEventSwitchFailed
ZIMRoomEventSwitchFailed=(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.h
Properties
ZIMRoomStateDisconnected
ZIMRoomStateDisconnected=(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.
ZIMRoomStateConnecting
ZIMRoomStateConnecting=(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.
ZIMRoomStateConnected
ZIMRoomStateConnected=(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.h
Properties
ZIMRoomAttributesUpdateActionSet
ZIMRoomAttributesUpdateActionSet=(0)Set action.
ZIMRoomAttributesUpdateActionDelete
ZIMRoomAttributesUpdateActionDelete=(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.h
Properties
ZIMRoomMemberAttributesUpdateActionSet
ZIMRoomMemberAttributesUpdateActionSet=(0)Set the room member attributes.
ZIMGroupState
group status.
Details
group status.
Declared in ZIMDefines.h
Properties
ZIMGroupStateQuit
ZIMGroupStateQuit=(0)The local user has left the group.
ZIMGroupStateEnter
ZIMGroupStateEnter=(1)The local user has entered the group.
ZIMGroupEvent
Group events.
Details
Group events.
Declared in ZIMDefines.h
Properties
ZIMGroupEventUnknown
ZIMGroupEventUnknown=(-1)Unknown event.
ZIMGroupEventCreated
ZIMGroupEventCreated=(1)The group was created.
ZIMGroupEventDismissed
ZIMGroupEventDismissed=(2)The group was dismissed.
ZIMGroupEventJoined
ZIMGroupEventJoined=(3)A member joined the group.
ZIMGroupEventInvited
ZIMGroupEventInvited=(4)A member was invited to join the group.
ZIMGroupEventLeft
ZIMGroupEventLeft=(5)A member left the group.
ZIMGroupEventKickedOut
ZIMGroupEventKickedOut=(6)A member was kicked out of the group.
ZIMGroupMemberEvent
Group member events.
Details
Group member events.
Declared in ZIMDefines.h
Properties
ZIMGroupMemberEventUnknown
ZIMGroupMemberEventUnknown=(-1)Unknown event.
ZIMGroupMemberEventJoined
ZIMGroupMemberEventJoined=(1)A member joined the group.
ZIMGroupMemberEventLeft
ZIMGroupMemberEventLeft=(2)A member left the group.
ZIMGroupMemberEventKickedOut
ZIMGroupMemberEventKickedOut=(4)A member was kicked out of the group.
ZIMGroupMemberEventInvited
ZIMGroupMemberEventInvited=(5)A member was invited to join the group.
ZIMGroupMemberState
group membership status.
Details
group membership status.
Declared in ZIMDefines.h
Properties
ZIMGroupMemberStateQuit
ZIMGroupMemberStateQuit=(0)The member has left the group.
ZIMGroupMemberStateEnter
ZIMGroupMemberStateEnter=(1)The member has entered the group.
ZIMGroupMessageNotificationStatus
Enumeration of group notification status.
Details
Enumeration of group notification status.
Declared in ZIMDefines.h
Properties
ZIMGroupMessageNotificationStatusNotify
ZIMGroupMessageNotificationStatusNotify=(1)Message notifications are enabled.
ZIMGroupMessageNotificationStatusDoNotDisturb
ZIMGroupMessageNotificationStatusDoNotDisturb=(2)Do not disturb mode is enabled.
ZIMGroupAttributesUpdateAction
Group attributes update action.
Details
Group attributes update action.
Declared in ZIMDefines.h
Properties
ZIMGroupAttributesUpdateActionSet
ZIMGroupAttributesUpdateActionSet=(0)Set action.
ZIMGroupAttributesUpdateActionDelete
ZIMGroupAttributesUpdateActionDelete=(1)Delete the group attributes.
ZIMGroupMuteMode
Group mute mode.
Details
Group mute mode.
Declared in ZIMDefines.h
Properties
ZIMGroupMuteModeNone
ZIMGroupMuteModeNone=(0)Unmute.
ZIMGroupMuteModeNormal
ZIMGroupMuteModeNormal=(1)Group normal members mute mode.
ZIMGroupMuteModeAll
ZIMGroupMuteModeAll=(2)Group all members mute mode.
ZIMGroupMuteModeCustom
ZIMGroupMuteModeCustom=(3)Customize group mute mode
ZIMGroupJoinMode
Verification mode for joining the group.
Details
Verification mode for joining the group.
Declared in ZIMDefines.h
Properties
ZIMGroupJoinModeAny
ZIMGroupJoinModeAny=(0)Anyone can join the group directly.
ZIMGroupJoinModeAuth
ZIMGroupJoinModeAuth=(1)Requires group owner or administrator approval.
ZIMGroupJoinModeForbid
ZIMGroupJoinModeForbid=(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.h
Properties
ZIMGroupInviteModeAny
ZIMGroupInviteModeAny=(0)Everyone in the group can invite.
ZIMGroupInviteModeAdmin
ZIMGroupInviteModeAdmin=(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.h
Properties
ZIMGroupBeInviteModeNone
ZIMGroupBeInviteModeNone=(0)The invitees enter the group directly.
ZIMGroupBeInviteModeAuth
ZIMGroupBeInviteModeAuth=(1)The invitee's consent is required to join the group.
ZIMGroupEnterType
Group enter type.
Details
Group enter type.
Declared in ZIMDefines.h
Properties
ZIMGroupEnterTypeUnknown
ZIMGroupEnterTypeUnknown=(0)Unknown enter type.
ZIMGroupEnterTypeCreated
ZIMGroupEnterTypeCreated=(1)The user created the group.
ZIMGroupEnterTypeJoinApply
ZIMGroupEnterTypeJoinApply=(2)The user joined the group via an application.
ZIMGroupEnterTypeJoined
ZIMGroupEnterTypeJoined=(3)The user actively joined the group.
ZIMGroupEnterTypeInvited
ZIMGroupEnterTypeInvited=(4)The user was invited to join the group.
ZIMGroupEnterTypeInviteApply
ZIMGroupEnterTypeInviteApply=(5)The user joined the group via invitation application.
ZIMGroupApplicationType
Group application type.
Details
Group application type.
Declared in ZIMDefines.h
Properties
ZIMGroupApplicationTypeUnknown
ZIMGroupApplicationTypeUnknown=(-1)Unknown group application type.
ZIMGroupApplicationTypeNone
ZIMGroupApplicationTypeNone=(0)None.
ZIMGroupApplicationTypeJoin
ZIMGroupApplicationTypeJoin=(1)Join type.
ZIMGroupApplicationTypeInvite
ZIMGroupApplicationTypeInvite=(2)Invite type.
ZIMGroupApplicationTypeBeInvite
ZIMGroupApplicationTypeBeInvite=(3)Be invite type.
ZIMGroupApplicationState
Group application state.
Details
Group application state.
Declared in ZIMDefines.h
Properties
ZIMGroupApplicationStateUnknown
ZIMGroupApplicationStateUnknown=(-1)Unknown group application state.
ZIMGroupApplicationStateWaiting
ZIMGroupApplicationStateWaiting=(1)Awaiting response.
ZIMGroupApplicationStateAccepted
ZIMGroupApplicationStateAccepted=(2)Accepted.
ZIMGroupApplicationStateRejected
ZIMGroupApplicationStateRejected=(3)Rejected.
ZIMGroupApplicationStateExpired
ZIMGroupApplicationStateExpired=(4)Expired.
ZIMGroupApplicationStateDisabled
ZIMGroupApplicationStateDisabled=(5)Disabled
ZIMGroupApplicationListChangeAction
Group application list update action.
Details
Group application list update action.
Declared in ZIMDefines.h
Properties
ZIMGroupApplicationListChangeActionAdded
ZIMGroupApplicationListChangeActionAdded=(0)Add action.
ZIMGroupMemberRole
Group member role
Details
Group member role
Declared in ZIMDefines.h
Properties
ZIMGroupMemberRoleOwner
ZIMGroupMemberRoleOwner=(1)Group Owner.
ZIMGroupMemberRoleAdmin
ZIMGroupMemberRoleAdmin=(2)Group Admin.
ZIMGroupMemberRoleMember
ZIMGroupMemberRoleMember=(3)Group Member.
ZIMGroupDataFlag
The flag type for group data fields.
Details
The flag type for group data fields.
Declared in ZIMDefines.h
Properties
ZIMGroupDataFlagName
ZIMGroupDataFlagName=(1)Group name data flag.
ZIMGroupDataFlagNotice
ZIMGroupDataFlagNotice=(2)Group notice data flag.
ZIMGroupDataFlagAvatarUrl
ZIMGroupDataFlagAvatarUrl=(4)Group avatar URL data flag.
ZIMCallInvitationMode
Call invitation mode.
Details
Call invitation mode.
Declared in ZIMDefines.h
Properties
ZIMCallInvitationModeUnknown
ZIMCallInvitationModeUnknown=(-1)Unknown type, as a guaranteed enumeration value.
ZIMCallInvitationModeGeneral
ZIMCallInvitationModeGeneral=(0)general.
ZIMCallInvitationModeAdvanced
ZIMCallInvitationModeAdvanced=(1)advanced
ZIMCallState
call status.
Details
call status.
Declared in ZIMDefines.h
Properties
ZIMCallStateUnknown
ZIMCallStateUnknown=(-1)Unknown call state.
ZIMCallStateStarted
ZIMCallStateStarted=(1)The call has started.
ZIMCallStateEnded
ZIMCallStateEnded=(2)The call has ended.
ZIMCallUserState
Call user status.
Details
Call user status.
Declared in ZIMDefines.h
Properties
ZIMCallUserStateUnknown
ZIMCallUserStateUnknown=(-1)unknown
ZIMCallUserStateInviting
ZIMCallUserStateInviting=(0)inviting.
ZIMCallUserStateAccepted
ZIMCallUserStateAccepted=(1)accepted.
ZIMCallUserStateRejected
ZIMCallUserStateRejected=(2)rejected.
ZIMCallUserStateCancelled
ZIMCallUserStateCancelled=(3)cancelled.
ZIMCallUserStateReceived
ZIMCallUserStateReceived=(5)received.
ZIMCallUserStateTimeout
ZIMCallUserStateTimeout=(6)timeout.
ZIMCallUserStateQuit
ZIMCallUserStateQuit=(7)quit.
ZIMCallUserStateEnded
ZIMCallUserStateEnded=(8)ended.
ZIMCallUserStateNotYetReceived
ZIMCallUserStateNotYetReceived=(9)Not received.
ZIMCallUserStateBeCancelled
ZIMCallUserStateBeCancelled=(10)Be cancelled.
ZIMUserInfoType
User type.
Details
User type.
Declared in ZIMDefines.h
Properties
ZIMUserInfoTypeBasicUser
ZIMUserInfoTypeBasicUser=(1)Basic user type.
ZIMUserInfoTypeRoomMember
ZIMUserInfoTypeRoomMember=(2)Room member type.
ZIMUserInfoTypeGroupMember
ZIMUserInfoTypeGroupMember=(3)Group member type.
ZIMUserInfoTypeGroupSimpleMember
ZIMUserInfoTypeGroupSimpleMember=(4)Group member brief info type.
ZIMUserInfoTypeFriend
ZIMUserInfoTypeFriend=(5)Friend type.
ZIMUserInfoTypeCommunityMember
ZIMUserInfoTypeCommunityMember=(6)Community member type.
ZIMUserInfoTypeCommunitySimpleMember
ZIMUserInfoTypeCommunitySimpleMember=(7)Community member brief info type.
ZIMFriendListChangeAction
friend list update action.
Details
friend list update action.
Declared in ZIMDefines.h
Properties
ZIMFriendListChangeActionAdded
ZIMFriendListChangeActionAdded=(0)Add action.
ZIMFriendListChangeActionDeleted
ZIMFriendListChangeActionDeleted=(1)Delete action.
ZIMFriendApplicationListChangeAction
friend application list update action.
Details
friend application list update action.
Declared in ZIMDefines.h
Properties
ZIMFriendApplicationListChangeActionAdded
ZIMFriendApplicationListChangeActionAdded=(0)Add action.
ZIMFriendApplicationListChangeActionDeleted
ZIMFriendApplicationListChangeActionDeleted=(1)Delete action.
ZIMFriendApplicationType
Friend application type.
Details
Friend application type.
Declared in ZIMDefines.h
Properties
ZIMFriendApplicationTypeUnknown
ZIMFriendApplicationTypeUnknown=(-1)Unknown friend application type.
ZIMFriendApplicationTypeNone
ZIMFriendApplicationTypeNone=(0)Friend application type none.
ZIMFriendApplicationTypeReceived
ZIMFriendApplicationTypeReceived=(1)Applications received.
ZIMFriendApplicationTypeSent
ZIMFriendApplicationTypeSent=(2)Application sent.
ZIMFriendApplicationTypeBoth
ZIMFriendApplicationTypeBoth=(3)Both parties sent friend applications to each other.
ZIMFriendApplicationState
Friend application state.
Details
Friend application state.
Declared in ZIMDefines.h
Properties
ZIMFriendApplicationStateUnknown
ZIMFriendApplicationStateUnknown=(-1)Unknown friend application state.
ZIMFriendApplicationStateWaiting
ZIMFriendApplicationStateWaiting=(1)Awaiting response.
ZIMFriendApplicationStateAccepted
ZIMFriendApplicationStateAccepted=(2)Accepted.
ZIMFriendApplicationStateRejected
ZIMFriendApplicationStateRejected=(3)Rejected.
ZIMFriendApplicationStateExpired
ZIMFriendApplicationStateExpired=(4)The friend application has expired.
ZIMFriendApplicationStateDisabled
ZIMFriendApplicationStateDisabled=(5)The friend application is disabled.
ZIMFriendRelationCheckType
Check the friend relationship type.
Details
Check the friend relationship type.
Declared in ZIMDefines.h
Properties
ZIMFriendRelationCheckTypeBoth
ZIMFriendRelationCheckTypeBoth=(0)Check the friend relationship from both sides.
ZIMFriendRelationCheckTypeSingle
ZIMFriendRelationCheckTypeSingle=(1)Check the friend relationship from one side only.
ZIMFriendDeleteType
Delete friend type.
Details
Delete friend type.
Declared in ZIMDefines.h
Properties
ZIMFriendDeleteTypeBoth
ZIMFriendDeleteTypeBoth=(0)Delete the friend from both sides.
ZIMFriendDeleteTypeSingle
ZIMFriendDeleteTypeSingle=(1)Delete the friend from one side only.
ZIMUserRelationType
Friend relationship type.
Details
Friend relationship type.
Declared in ZIMDefines.h
Properties
ZIMUserRelationTypeUnknown
ZIMUserRelationTypeUnknown=(0)Unknown relation type.
ZIMUserRelationTypeSingleNo
ZIMUserRelationTypeSingleNo=(1)No friendship from the user's perspective.
ZIMUserRelationTypeSingleHave
ZIMUserRelationTypeSingleHave=(2)Friendship exists from the user's perspective.
ZIMUserRelationTypeBothAllNo
ZIMUserRelationTypeBothAllNo=(3)No friendship from either side.
ZIMUserRelationTypeBothSelfHave
ZIMUserRelationTypeBothSelfHave=(4)The user has added the other as a friend, but not vice versa.
ZIMUserRelationTypeBothOtherHave
ZIMUserRelationTypeBothOtherHave=(5)The other party has added the user as a friend, but not vice versa.
ZIMUserRelationTypeBothAllHave
ZIMUserRelationTypeBothAllHave=(6)Both parties are friends with each other.
ZIMBlacklistChangeAction
blacklist update action.
Details
blacklist update action.
Declared in ZIMDefines.h
Properties
ZIMBlacklistChangeActionAdded
ZIMBlacklistChangeActionAdded=(0)Add action.
ZIMBlacklistChangeActionRemoved
ZIMBlacklistChangeActionRemoved=(1)Removed action.
ZIMCXHandleType
Type of contact information for the VoIP initiator.
Details
Type of contact information for the VoIP initiator.
Declared in ZIMDefines.h
Properties
ZIMCXHandleTypeGeneric
ZIMCXHandleTypeGeneric=(1)Generic handle type.
ZIMCXHandleTypePhoneNumber
ZIMCXHandleTypePhoneNumber=(2)Phone number handle type.
ZIMCXHandleTypeEmailAddress
ZIMCXHandleTypeEmailAddress=(3)Email address handle type.
ZIMGeofencingType
Geofencing type.
Details
Geofencing type.
Declared in ZIMDefines.h
Properties
ZIMGeofencingTypeNone
ZIMGeofencingTypeNone=(0)The default type.
ZIMGeofencingTypeInclude
ZIMGeofencingTypeInclude=(1)Federated mode.
ZIMGeofencingTypeExclude
ZIMGeofencingTypeExclude=(2)Exclusion mode.
ZIMGeofencingArea
Geofencing Area
Details
Geofencing Area
Declared in ZIMDefines.h
Properties
ZIMGeofencingAreaCN
ZIMGeofencingAreaCN=(2)China
ZIMGeofencingAreaNA
ZIMGeofencingAreaNA=(3)North America
ZIMGeofencingAreaEU
ZIMGeofencingAreaEU=(4)Europe
ZIMGeofencingAreaAS
ZIMGeofencingAreaAS=(5)Asia
ZIMGeofencingAreaIN
ZIMGeofencingAreaIN=(6)India
ZIMPlatformType
Platform on which the SDK runs.
Details
Platform on which the SDK runs.
Declared in ZIMDefines.h
Properties
ZIMPlatformTypeWin
ZIMPlatformTypeWin=(1)Windows.
ZIMPlatformTypeIPhoneOS
ZIMPlatformTypeIPhoneOS=(2)iOS.
ZIMPlatformTypeAndroid
ZIMPlatformTypeAndroid=(3)Android.
ZIMPlatformTypeMacOS
ZIMPlatformTypeMacOS=(4)MacOS.
ZIMPlatformTypeLinux
ZIMPlatformTypeLinux=(5)Linux.
ZIMPlatformTypeWeb
ZIMPlatformTypeWeb=(6)Web.
ZIMPlatformTypeMiniProgram
ZIMPlatformTypeMiniProgram=(7)Mini program.
ZIMPlatformTypeIPadOS
ZIMPlatformTypeIPadOS=(9)iPad.
ZIMPlatformTypeOHOS
ZIMPlatformTypeOHOS=(10)HarmonyOS (OHOS) platform.
ZIMPlatformTypeUnknown
ZIMPlatformTypeUnknown=(32)Platforms not mentioned above.
ZIMUserOnlineStatus
User online status.
Details
User online status.
Declared in ZIMDefines.h
Properties
ZIMUserOnlineStatusOnline
ZIMUserOnlineStatusOnline=(0)Online. The user is in this state when the user is logged in and the network status is good.
ZIMUserOnlineStatusOffline
ZIMUserOnlineStatusOffline=(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.
ZIMUserOnlineStatusLogout
ZIMUserOnlineStatusLogout=(2)Log out. User active logout will be in this state.
ZIMUserOnlineStatusUnknown
ZIMUserOnlineStatusUnknown=(99)Unknown status. Guaranteed enumeration.
ZIMListChangeAction
The action type for list changes.
Details
The action type for list changes.
Declared in ZIMDefines.h
Properties
ZIMListChangeActionAdded
ZIMListChangeActionAdded=(0)An item was added.
ZIMListChangeActionDeleted
ZIMListChangeActionDeleted=(1)An item was deleted.
ZIMCommunityListChangeAction
The action type for community list changes.
Details
The action type for community list changes.
Declared in ZIMDefines.h
Properties
ZIMCommunityListChangeActionAdded
ZIMCommunityListChangeActionAdded=(0)A community was added.
ZIMCommunityListChangeActionDeleted
ZIMCommunityListChangeActionDeleted=(1)A community was deleted.
ZIMCommunityListChangeActionUpdated
ZIMCommunityListChangeActionUpdated=(2)A community was updated.
ZIMCommunityMemberEnterType
The enter type for community members.
Details
The enter type for community members.
Declared in ZIMDefines.h
Properties
ZIMCommunityMemberEnterTypeUnknown
ZIMCommunityMemberEnterTypeUnknown=(0)Unknown enter type.
ZIMCommunityMemberEnterTypeCommunityCreated
ZIMCommunityMemberEnterTypeCommunityCreated=(1)The member joined when the community was created.
ZIMCommunityMemberEnterTypeCommunityJoined
ZIMCommunityMemberEnterTypeCommunityJoined=(2)The member actively joined the community.
ZIMCommunityMemberEnterTypeCommunityInvited
ZIMCommunityMemberEnterTypeCommunityInvited=(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.h
Properties
ZIMCommunityMemberChangeStateExited
ZIMCommunityMemberChangeStateExited=(0)The member exited the community.
ZIMCommunityMemberChangeStateEntered
ZIMCommunityMemberChangeStateEntered=(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.h
Properties
ZIMCommunityMemberChangeActionUnknown
ZIMCommunityMemberChangeActionUnknown=(0)Unknown action.
ZIMCommunityMemberChangeActionJoined
ZIMCommunityMemberChangeActionJoined=(1)The member actively joined the community.
ZIMCommunityMemberChangeActionInvited
ZIMCommunityMemberChangeActionInvited=(2)The member was invited to join the community.
ZIMCommunityMemberChangeActionLeft
ZIMCommunityMemberChangeActionLeft=(3)The member actively left the community.
ZIMCommunityMemberChangeActionKickedOut
ZIMCommunityMemberChangeActionKickedOut=(4)The member was kicked out of the community.
ZIMCommunityChannelType
The type of community channel.
Details
The type of community channel.
Declared in ZIMDefines.h
Properties
ZIMCommunityChannelTypeUnknown
ZIMCommunityChannelTypeUnknown=(-1)Unknown channel.
ZIMCommunityChannelTypeGeneral
ZIMCommunityChannelTypeGeneral=(0)Default channel, automatically created when the community is created.
ZIMCommunityChannelTypePublic
ZIMCommunityChannelTypePublic=(1)Public channel, visible to all members of the community.
ZIMCommunityChannelTypePrivate
ZIMCommunityChannelTypePrivate=(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.h
Properties
ZIMCommunityChannelListChangeActionAdded
ZIMCommunityChannelListChangeActionAdded=(0)A community channel was added.
ZIMCommunityChannelListChangeActionDeleted
ZIMCommunityChannelListChangeActionDeleted=(1)A community channel was deleted.
ZIMCommunityChannelListChangeActionUpdated
ZIMCommunityChannelListChangeActionUpdated=(2)A community channel was updated.
ZIMCommunityChannelMuteMode
The mute mode for community channels.
Details
The mute mode for community channels.
Declared in ZIMDefines.h
Properties
ZIMCommunityChannelMuteModeNone
ZIMCommunityChannelMuteModeNone=(0)No mute mode.
ZIMCommunityChannelMuteModeNormal
ZIMCommunityChannelMuteModeNormal=(1)Normal mute mode; only administrators and the owner can speak.
ZIMCommunityChannelMuteModeAll
ZIMCommunityChannelMuteModeAll=(2)All members are muted.
ZIMCommunityChannelMuteModeCustom
ZIMCommunityChannelMuteModeCustom=(3)Custom mute mode.
ZIMCommunityMemberMuteType
The mute type for community members.
Details
The mute type for community members.
Declared in ZIMDefines.h
Properties
ZIMCommunityMemberMuteTypeNone
ZIMCommunityMemberMuteTypeNone=(0)Not muted.
ZIMCommunityMemberMuteTypeCommunity
ZIMCommunityMemberMuteTypeCommunity=(1)Muted at the community level.
ZIMCommunityMemberMuteTypeChannel
ZIMCommunityMemberMuteTypeChannel=(2)Muted at the community channel level.
ZIMCommunityMessageNotificationStatus
The notification status for community messages.
Details
The notification status for community messages.
Declared in ZIMDefines.h
Properties
ZIMCommunityMessageNotificationStatusNotify
ZIMCommunityMessageNotificationStatusNotify=(1)Message notifications are enabled.
ZIMCommunityMessageNotificationStatusDoNotDisturb
ZIMCommunityMessageNotificationStatusDoNotDisturb=(2)Do not disturb mode is enabled.
ZIMCommunityMemberRole
Community member role
Details
Community member role
Declared in ZIMDefines.h
Properties
ZIMCommunityMemberRoleOwner
ZIMCommunityMemberRoleOwner=(1)Community Owner.
ZIMCommunityMemberRoleAdmin
ZIMCommunityMemberRoleAdmin=(2)Community Admin.
ZIMCommunityMemberRoleMember
ZIMCommunityMemberRoleMember=(3)Community Member.