Enum
ZIMConnectionState
Connection state.
Details
Connection state.
Declared in ZIMDefines.h
Properties
ZIM_CONNECTION_STATE_DISCONNECTED
ZIM_CONNECTION_STATE_DISCONNECTED=(0)Unconnected state, enter this state before logging in and after logging out.
ZIM_CONNECTION_STATE_CONNECTING
ZIM_CONNECTION_STATE_CONNECTING=(1)The state that the connection is being requested. It will enter this state after successful execution login function.
ZIM_CONNECTION_STATE_CONNECTED
ZIM_CONNECTION_STATE_CONNECTED=(2)The state that is successfully connected.
ZIM_CONNECTION_STATE_RECONNECTING
ZIM_CONNECTION_STATE_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.h
Properties
ZIM_CONNECTION_EVENT_SUCCESS
ZIM_CONNECTION_EVENT_SUCCESS=(0)Success.
ZIM_CONNECTION_EVENT_ACTIVE_LOGIN
ZIM_CONNECTION_EVENT_ACTIVE_LOGIN=(1)The user actively logs in.
ZIM_CONNECTION_EVENT_LOGIN_TIMEOUT
ZIM_CONNECTION_EVENT_LOGIN_TIMEOUT=(2)Connection timed out.
ZIM_CONNECTION_EVENT_LOGIN_INTERRUPTED
ZIM_CONNECTION_EVENT_LOGIN_INTERRUPTED=(3)The network connection is temporarily interrupted.
ZIM_CONNECTION_EVENT_KICKED_OUT
ZIM_CONNECTION_EVENT_KICKED_OUT=(4)Being kicked out.
ZIM_CONNECTION_EVENT_TOKEN_EXPIRED
ZIM_CONNECTION_EVENT_TOKEN_EXPIRED=(5)Detail description: Disconnected due to expired login token.
ZIM_CONNECTION_EVENT_UNREGISTERED
ZIM_CONNECTION_EVENT_UNREGISTERED=(6)The user account was unregistered.
ZIMConversationEvent
conversation changed event.
Details
conversation changed event.
Declared in ZIMDefines.h
Properties
ZIM_CONVERSATION_EVENT_ADDED
ZIM_CONVERSATION_EVENT_ADDED=(0)A new conversation was added.
ZIM_CONVERSATION_EVENT_UPDATED
ZIM_CONVERSATION_EVENT_UPDATED=(1)The conversation was updated.
ZIM_CONVERSATION_EVENT_DISABLED
ZIM_CONVERSATION_EVENT_DISABLED=(2)The conversation was disabled.
ZIM_CONVERSATION_EVENT_DELETED
ZIM_CONVERSATION_EVENT_DELETED=(3)The conversation was deleted.
ZIMConversationListChangeAction
Conversation list change action.
Details
Conversation list change action.
Declared in ZIMDefines.h
Properties
ZIM_CONVERSATION_LIST_CHANGE_ACTION_ADDED
ZIM_CONVERSATION_LIST_CHANGE_ACTION_ADDED=(0)A conversation was added to the list.
ZIM_CONVERSATION_LIST_CHANGE_ACTION_DELETED
ZIM_CONVERSATION_LIST_CHANGE_ACTION_DELETED=(1)A conversation was deleted from the list.
ZIM_CONVERSATION_LIST_CHANGE_ACTION_UPDATED
ZIM_CONVERSATION_LIST_CHANGE_ACTION_UPDATED=(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
ZIM_CONVERSATION_NOTIFICATION_STATUS_NOTIFY
ZIM_CONVERSATION_NOTIFICATION_STATUS_NOTIFY=(1)Message notifications are enabled.
ZIM_CONVERSATION_NOTIFICATION_STATUS_DO_NOT_DISTURB
ZIM_CONVERSATION_NOTIFICATION_STATUS_DO_NOT_DISTURB=(2)Do not disturb mode is enabled.
ZIMConversationType
Conversation type.
Details
Conversation type.
Declared in ZIMDefines.h
Properties
ZIM_CONVERSATION_TYPE_UNKNOWN
ZIM_CONVERSATION_TYPE_UNKNOWN=(-1)Unknown conversation type.
ZIM_CONVERSATION_TYPE_PEER
ZIM_CONVERSATION_TYPE_PEER=(0)Conversation type peer.
ZIM_CONVERSATION_TYPE_ROOM
ZIM_CONVERSATION_TYPE_ROOM=(1)Conversation type room.
ZIM_CONVERSATION_TYPE_GROUP
ZIM_CONVERSATION_TYPE_GROUP=(2)Conversation type group.
ZIM_CONVERSATION_TYPE_COMMUNITY_CHANNEL
ZIM_CONVERSATION_TYPE_COMMUNITY_CHANNEL=(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
ZIM_CONVERSATION_SYNC_STATE_STARTED
ZIM_CONVERSATION_SYNC_STATE_STARTED=(0)Conversation list synchronization start status
ZIM_CONVERSATION_SYNC_STATE_FINISHED
ZIM_CONVERSATION_SYNC_STATE_FINISHED=(1)Conversation list synchronization completion status
ZIM_CONVERSATION_SYNC_STATE_FAILED
ZIM_CONVERSATION_SYNC_STATE_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.h
Properties
ZIM_CONVERSATION_PINNED_FILTER_ALL
ZIM_CONVERSATION_PINNED_FILTER_ALL=(0)Both pinned and unpinned conversations can be queried.
ZIM_CONVERSATION_PINNED_FILTER_ONLY_PINNED
ZIM_CONVERSATION_PINNED_FILTER_ONLY_PINNED=(1)Only pinned conversations can be queried.
ZIM_CONVERSATION_PINNED_FILTER_ONLY_UNPINNED
ZIM_CONVERSATION_PINNED_FILTER_ONLY_UNPINNED=(2)Only unpinned conversations can be queried.
ZIMConversationSearchMode
Conversational search mode.
Details
Conversational search mode.
Declared in ZIMDefines.h
Properties
ZIM_CONVERSATION_SEARCH_MODE_MATCH_MESSAGE
ZIM_CONVERSATION_SEARCH_MODE_MATCH_MESSAGE=(0)Query the corresponding conversation by searching for messages that meet the criteria.
ZIM_CONVERSATION_SEARCH_MODE_MATCH_CONVERSATION_NAME
ZIM_CONVERSATION_SEARCH_MODE_MATCH_CONVERSATION_NAME=(1)Query the corresponding conversation by searching for the conversation name.
ZIMMediaFileType
Media file type
Details
Media file type
Declared in ZIMDefines.h
Properties
ZIM_MEDIA_FILE_TYPE_ORIGINAL_FILE
ZIM_MEDIA_FILE_TYPE_ORIGINAL_FILE=(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.
ZIM_MEDIA_FILE_TYPE_LARGE_IMAGE
ZIM_MEDIA_FILE_TYPE_LARGE_IMAGE=(2)Large image type. After calling [downloadMediaFile], the SDK will update the largeImageLocalPath property in [ZIMImageMessage].
ZIM_MEDIA_FILE_TYPE_THUMBNAIL
ZIM_MEDIA_FILE_TYPE_THUMBNAIL=(3)Image thumbnail type. After calling [downloadMediaFile], the SDK will update the thumbnailLocalPath property in [ZIMImageMessage].
ZIM_MEDIA_FILE_TYPE_VIDEO_FIRST_FRAME
ZIM_MEDIA_FILE_TYPE_VIDEO_FIRST_FRAME=(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
ZIM_MESSAGE_DIRECTION_SEND
ZIM_MESSAGE_DIRECTION_SEND=(0)The message was sent by the local user.
ZIM_MESSAGE_DIRECTION_RECEIVE
ZIM_MESSAGE_DIRECTION_RECEIVE=(1)The message was received by the local user.
ZIMMessageOrder
Message order.
Details
Message order.
Declared in ZIMDefines.h
Properties
ZIM_MESSAGE_ORDER_DESCENDING
ZIM_MESSAGE_ORDER_DESCENDING=(0)Represents message list in descending order (message list order is from new to old).
ZIM_MESSAGE_ORDER_ASCENDING
ZIM_MESSAGE_ORDER_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.h
Properties
ZIM_MESSAGE_PRIORITY_LOW
ZIM_MESSAGE_PRIORITY_LOW=(1)Low priority.
ZIM_MESSAGE_PRIORITY_MEDIUM
ZIM_MESSAGE_PRIORITY_MEDIUM=(2)Medium priority.
ZIM_MESSAGE_PRIORITY_HIGH
ZIM_MESSAGE_PRIORITY_HIGH=(3)High priority.
ZIMMessageQueryMode
.
Details
.
Declared in ZIMDefines.h
Properties
ZIM_MESSAGE_QUERY_MODE_GENERAL
ZIM_MESSAGE_QUERY_MODE_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.
ZIM_MESSAGE_QUERY_MODE_PREFER_SERVER
ZIM_MESSAGE_QUERY_MODE_PREFER_SERVER=(1)Server-priority query mode.
ZIM_MESSAGE_QUERY_MODE_ONLY_LOCAL
ZIM_MESSAGE_QUERY_MODE_ONLY_LOCAL=(2)Local-messages-only query mode.
ZIMMessageReceiptStatus
The status of the receipt
Details
The status of the receipt
Declared in ZIMDefines.h
Properties
ZIM_MESSAGE_RECEIPT_STATUS_UNKNOWN
ZIM_MESSAGE_RECEIPT_STATUS_UNKNOWN=(-1)Unknown receipt status.
ZIM_MESSAGE_RECEIPT_STATUS_NONE
ZIM_MESSAGE_RECEIPT_STATUS_NONE=(0)Not a receipt.
ZIM_MESSAGE_RECEIPT_STATUS_PROCESSING
ZIM_MESSAGE_RECEIPT_STATUS_PROCESSING=(1)Receipt in progress.
ZIM_MESSAGE_RECEIPT_STATUS_DONE
ZIM_MESSAGE_RECEIPT_STATUS_DONE=(2)Receipt completed.
ZIM_MESSAGE_RECEIPT_STATUS_EXPIRED
ZIM_MESSAGE_RECEIPT_STATUS_EXPIRED=(3)Receipt has expired.
ZIM_MESSAGE_RECEIPT_STATUS_FAILED
ZIM_MESSAGE_RECEIPT_STATUS_FAILED=(4)Receipt failed.
ZIM_MESSAGE_RECEIPT_STATUS_DELIVERED
ZIM_MESSAGE_RECEIPT_STATUS_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.h
Properties
ZIM_MESSAGE_RECEIPT_FILTER_TYPE_READ
ZIM_MESSAGE_RECEIPT_FILTER_TYPE_READ=(0)Read members.
ZIM_MESSAGE_RECEIPT_FILTER_TYPE_UNREAD
ZIM_MESSAGE_RECEIPT_FILTER_TYPE_UNREAD=(1)Unread members.
ZIM_MESSAGE_RECEIPT_FILTER_TYPE_DELIVERED
ZIM_MESSAGE_RECEIPT_FILTER_TYPE_DELIVERED=(2)Delivered members.
ZIMMessageRevokeStatus
Message revoke status
Details
Message revoke status
Declared in ZIMDefines.h
Properties
ZIM_MESSAGE_REVOKE_STATUS_UNKNOWN
ZIM_MESSAGE_REVOKE_STATUS_UNKNOWN=(-1)Unknown revoke status.
ZIM_MESSAGE_REVOKE_STATUS_SELF_REVOKE
ZIM_MESSAGE_REVOKE_STATUS_SELF_REVOKE=(0)The message was revoked by the sender.
ZIM_MESSAGE_REVOKE_STATUS_SYSTEM_REVOKE
ZIM_MESSAGE_REVOKE_STATUS_SYSTEM_REVOKE=(1)The message was revoked by the system.
ZIM_MESSAGE_REVOKE_STATUS_SERVER_API_REVOKE
ZIM_MESSAGE_REVOKE_STATUS_SERVER_API_REVOKE=(2)The message was revoked via the server API.
ZIM_MESSAGE_REVOKE_STATUS_GROUP_ADMIN_REVOKE
ZIM_MESSAGE_REVOKE_STATUS_GROUP_ADMIN_REVOKE=(3)The message was revoked by a group administrator.
ZIM_MESSAGE_REVOKE_STATUS_GROUP_OWNER_REVOKE
ZIM_MESSAGE_REVOKE_STATUS_GROUP_OWNER_REVOKE=(4)The message was revoked by the group owner.
ZIM_MESSAGE_REVOKE_STATUS_AUDIT_REJECT_REVOKE
ZIM_MESSAGE_REVOKE_STATUS_AUDIT_REJECT_REVOKE=(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
ZIM_MESSAGE_SENT_STATUS_SENDING
ZIM_MESSAGE_SENT_STATUS_SENDING=(0)The message is being sent.
ZIM_MESSAGE_SENT_STATUS_SUCCESS
ZIM_MESSAGE_SENT_STATUS_SUCCESS=(1)The message was sent successfully.
ZIM_MESSAGE_SENT_STATUS_FAILED
ZIM_MESSAGE_SENT_STATUS_FAILED=(2)The message failed to send.
ZIMMessageType
The type of the message.
Details
The type of the message.
Declared in ZIMDefines.h
Properties
ZIM_MESSAGE_TYPE_UNKNOWN
ZIM_MESSAGE_TYPE_UNKNOWN=(0)Unknown message.
ZIM_MESSAGE_TYPE_TEXT
ZIM_MESSAGE_TYPE_TEXT=(1)Normal text message.
ZIM_MESSAGE_TYPE_COMMAND
ZIM_MESSAGE_TYPE_COMMAND=(2)Custom binary message.
ZIM_MESSAGE_TYPE_MULTIPLE
ZIM_MESSAGE_TYPE_MULTIPLE=(10)Multiple messages can be used to send multiple messages of text, rich media files, and custom messages.
ZIM_MESSAGE_TYPE_IMAGE
ZIM_MESSAGE_TYPE_IMAGE=(11)Image message.
ZIM_MESSAGE_TYPE_FILE
ZIM_MESSAGE_TYPE_FILE=(12)File message.
ZIM_MESSAGE_TYPE_AUDIO
ZIM_MESSAGE_TYPE_AUDIO=(13)Audio message.
ZIM_MESSAGE_TYPE_VIDEO
ZIM_MESSAGE_TYPE_VIDEO=(14)Video message.
ZIM_MESSAGE_TYPE_BARRAGE
ZIM_MESSAGE_TYPE_BARRAGE=(20)Barrage message.
ZIM_MESSAGE_TYPE_REVOKE
ZIM_MESSAGE_TYPE_REVOKE=(31)Reovked message.
ZIM_MESSAGE_TYPE_TIPS
ZIM_MESSAGE_TYPE_TIPS=(32)Tips message.
ZIM_MESSAGE_TYPE_COMBINE
ZIM_MESSAGE_TYPE_COMBINE=(100)Combined message.
ZIM_MESSAGE_TYPE_CUSTOM
ZIM_MESSAGE_TYPE_CUSTOM=(200)Custom message.
ZIMRevokeType
The type of the revoke message.
Details
The type of the revoke message.
Declared in ZIMDefines.h
Properties
ZIM_REVOKE_TYPE_UNKNOWN
ZIM_REVOKE_TYPE_UNKNOWN=(-1)Unknown revoke type.
ZIM_REVOKE_TYPE_TWO_WAY
ZIM_REVOKE_TYPE_TWO_WAY=(0)Two-way revoke: the message is deleted for both sender and recipient.
ZIM_REVOKE_TYPE_ONE_WAY
ZIM_REVOKE_TYPE_ONE_WAY=(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
ZIM_TIPS_MESSAGE_EVENT_UNKNOWN
ZIM_TIPS_MESSAGE_EVENT_UNKNOWN=(0)Unknown tips message event.
ZIM_TIPS_MESSAGE_EVENT_GROUP_CREATED
ZIM_TIPS_MESSAGE_EVENT_GROUP_CREATED=(1)The group was created.
ZIM_TIPS_MESSAGE_EVENT_GROUP_DISMISSED
ZIM_TIPS_MESSAGE_EVENT_GROUP_DISMISSED=(2)The group was dismissed.
ZIM_TIPS_MESSAGE_EVENT_GROUP_JOINED
ZIM_TIPS_MESSAGE_EVENT_GROUP_JOINED=(3)A member joined the group.
ZIM_TIPS_MESSAGE_EVENT_GROUP_INVITED
ZIM_TIPS_MESSAGE_EVENT_GROUP_INVITED=(4)A member was invited to join the group.
ZIM_TIPS_MESSAGE_EVENT_GROUP_LEFT
ZIM_TIPS_MESSAGE_EVENT_GROUP_LEFT=(5)A member left the group.
ZIM_TIPS_MESSAGE_EVENT_GROUP_KICKED_OUT
ZIM_TIPS_MESSAGE_EVENT_GROUP_KICKED_OUT=(6)A member was kicked out of the group.
ZIM_TIPS_MESSAGE_EVENT_GROUP_INFO_CHANGED
ZIM_TIPS_MESSAGE_EVENT_GROUP_INFO_CHANGED=(7)The group information was changed.
ZIM_TIPS_MESSAGE_EVENT_GROUP_MEMBER_INFO_CHANGED
ZIM_TIPS_MESSAGE_EVENT_GROUP_MEMBER_INFO_CHANGED=(8)The group member information was changed.
ZIM_TIPS_MESSAGE_EVENT_GROUP_MESSAGE_PINNED
ZIM_TIPS_MESSAGE_EVENT_GROUP_MESSAGE_PINNED=(9)A group message was pinned.
ZIM_TIPS_MESSAGE_EVENT_COMMUNITY_CREATED
ZIM_TIPS_MESSAGE_EVENT_COMMUNITY_CREATED=(101)The community was created.
ZIM_TIPS_MESSAGE_EVENT_COMMUNITY_JOINED
ZIM_TIPS_MESSAGE_EVENT_COMMUNITY_JOINED=(103)A member joined the community.
ZIM_TIPS_MESSAGE_EVENT_COMMUNITY_INVITED
ZIM_TIPS_MESSAGE_EVENT_COMMUNITY_INVITED=(104)A member was invited to join the community.
ZIM_TIPS_MESSAGE_EVENT_COMMUNITY_CHANNEL_CREATED
ZIM_TIPS_MESSAGE_EVENT_COMMUNITY_CHANNEL_CREATED=(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
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_UNKNOWN
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_UNKNOWN=(0)Unknown change info type.
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_DATA_CHANGED
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_DATA_CHANGED=(1)Group name, group avatar, and group notice have multiple changes.
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_NOTICE_CHANGED
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_NOTICE_CHANGED=(2)Group notice change event.
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_NAME_CHANGED
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_NAME_CHANGED=(3)Group name change event.
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_AVATAR_URL_CHANGED
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_AVATAR_URL_CHANGED=(4)Group avatar change event.
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_MUTE_CHANGED
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_MUTE_CHANGED=(5)Group mute info change event.
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_OWNER_TRANSFERRED
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_OWNER_TRANSFERRED=(10)Group owner transfer event.
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_MEMBER_ROLE_CHANGED
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_MEMBER_ROLE_CHANGED=(11)Group member role change event.
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_MEMBER_MUTE_CHANGED
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_MEMBER_MUTE_CHANGED=(12)The group member mute status changed.
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_MESSAGE_PIN_INFO_CHANGED
ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_MESSAGE_PIN_INFO_CHANGED=(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
ZIM_MESSAGE_MENTIONED_TYPE_UNKNOWN
ZIM_MESSAGE_MENTIONED_TYPE_UNKNOWN=(0)Unknown mention type.
ZIM_MESSAGE_MENTIONED_TYPE_MENTION_ME
ZIM_MESSAGE_MENTIONED_TYPE_MENTION_ME=(1)mention me
ZIM_MESSAGE_MENTIONED_TYPE_MENTION_ALL
ZIM_MESSAGE_MENTIONED_TYPE_MENTION_ALL=(2)mention all user
ZIM_MESSAGE_MENTIONED_TYPE_MENTION_ALL_AND_ME
ZIM_MESSAGE_MENTIONED_TYPE_MENTION_ALL_AND_ME=(3)mention all user and mention me
ZIMMessageDeleteType
Message deleted type
Details
Message deleted type
Declared in ZIMDefines.h
Properties
ZIM_MESSAGE_DELETE_TYPE_MESSAGE_LIST_DELETED
ZIM_MESSAGE_DELETE_TYPE_MESSAGE_LIST_DELETED=(0)User-initiated message deletion event.
ZIM_MESSAGE_DELETE_TYPE_CONVERSATION_ALL_MESSAGES_DELETED
ZIM_MESSAGE_DELETE_TYPE_CONVERSATION_ALL_MESSAGES_DELETED=(1)User-initiated event for deleting all messages in a conversation.
ZIM_MESSAGE_DELETE_TYPE_ALL_CONVERSATION_MESSAGES_DELETED
ZIM_MESSAGE_DELETE_TYPE_ALL_CONVERSATION_MESSAGES_DELETED=(2)User-initiated event for deleting all messages across all conversations.
ZIM_MESSAGE_DELETE_TYPE_MESSAGES_DESTRUCTED
ZIM_MESSAGE_DELETE_TYPE_MESSAGES_DESTRUCTED=(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
ZIM_MESSAGE_REPLIED_INFO_STATE_NORMAL
ZIM_MESSAGE_REPLIED_INFO_STATE_NORMAL=(0)normal state.
ZIM_MESSAGE_REPLIED_INFO_STATE_DELETED
ZIM_MESSAGE_REPLIED_INFO_STATE_DELETED=(1)deleted state.
ZIM_MESSAGE_REPLIED_INFO_STATE_NOT_FOUND
ZIM_MESSAGE_REPLIED_INFO_STATE_NOT_FOUND=(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
ZIM_MESSAGE_PIN_STATUS_NOT_PINNED
ZIM_MESSAGE_PIN_STATUS_NOT_PINNED=(0)The message is not pinned.
ZIM_MESSAGE_PIN_STATUS_PINNED
ZIM_MESSAGE_PIN_STATUS_PINNED=(1)The message is pinned.
ZIM_MESSAGE_PIN_STATUS_UPDATED
ZIM_MESSAGE_PIN_STATUS_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.h
Properties
ZIM_MESSAGE_REACTION_USER_CHANGE_ACTION_ADDED
ZIM_MESSAGE_REACTION_USER_CHANGE_ACTION_ADDED=(0)Add message reaction.
ZIM_MESSAGE_REACTION_USER_CHANGE_ACTION_DELETED
ZIM_MESSAGE_REACTION_USER_CHANGE_ACTION_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.h
Properties
ZIM_ROOM_EVENT_SUCCESS
ZIM_ROOM_EVENT_SUCCESS=(0)Success.
ZIM_ROOM_EVENT_NETWORK_INTERRUPTED
ZIM_ROOM_EVENT_NETWORK_INTERRUPTED=(1)The network in the room is temporarily interrupted.
ZIM_ROOM_EVENT_NETWORK_DISCONNECTED
ZIM_ROOM_EVENT_NETWORK_DISCONNECTED=(2)The network in the room is disconnected.
ZIM_ROOM_EVENT_ROOM_NOT_EXIST
ZIM_ROOM_EVENT_ROOM_NOT_EXIST=(3)The room not exist.
ZIM_ROOM_EVENT_ACTIVE_CREATE
ZIM_ROOM_EVENT_ACTIVE_CREATE=(4)The user actively creates a room.
ZIM_ROOM_EVENT_CREATE_FAILED
ZIM_ROOM_EVENT_CREATE_FAILED=(5)Failed to create room.
ZIM_ROOM_EVENT_ACTIVE_ENTER
ZIM_ROOM_EVENT_ACTIVE_ENTER=(6)The user starts to enter the room.
ZIM_ROOM_EVENT_ENTER_FAILED
ZIM_ROOM_EVENT_ENTER_FAILED=(7)user failed to enter the room.
ZIM_ROOM_EVENT_KICKED_OUT
ZIM_ROOM_EVENT_KICKED_OUT=(8)user was kicked out of the room.
ZIM_ROOM_EVENT_CONNECT_TIMEOUT
ZIM_ROOM_EVENT_CONNECT_TIMEOUT=(9)The connection to the room timed out.
ZIM_ROOM_EVENT_KICKED_OUT_BY_OTHER_DEVICE
ZIM_ROOM_EVENT_KICKED_OUT_BY_OTHER_DEVICE=(10)Multi-device logins into the same room will result in the user being kicked out of the room.
ZIM_ROOM_EVENT_ACTIVE_SWITCH
ZIM_ROOM_EVENT_ACTIVE_SWITCH=(11)Switch room.
ZIM_ROOM_EVENT_SWITCH_FAILED
ZIM_ROOM_EVENT_SWITCH_FAILED=(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
ZIM_ROOM_STATE_DISCONNECTED
ZIM_ROOM_STATE_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.
ZIM_ROOM_STATE_CONNECTING
ZIM_ROOM_STATE_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.
ZIM_ROOM_STATE_CONNECTED
ZIM_ROOM_STATE_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.h
Properties
ZIM_ROOM_ATTRIBUTES_UPDATE_ACTION_SET
ZIM_ROOM_ATTRIBUTES_UPDATE_ACTION_SET=(0)Set action.
ZIM_ROOM_ATTRIBUTES_UPDATE_ACTION_DELETE
ZIM_ROOM_ATTRIBUTES_UPDATE_ACTION_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.h
Properties
ZIM_ROOM_MEMBER_ATTRIBUTES_UPDATE_ACTION_SET
ZIM_ROOM_MEMBER_ATTRIBUTES_UPDATE_ACTION_SET=(0)Set the room member attributes.
ZIMGroupState
group status.
Details
group status.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_STATE_QUIT
ZIM_GROUP_STATE_QUIT=(0)The local user has left the group.
ZIM_GROUP_STATE_ENTER
ZIM_GROUP_STATE_ENTER=(1)The local user has entered the group.
ZIMGroupEvent
Group events.
Details
Group events.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_EVENT_UNKNOWN
ZIM_GROUP_EVENT_UNKNOWN=(-1)Unknown event.
ZIM_GROUP_EVENT_CREATED
ZIM_GROUP_EVENT_CREATED=(1)The group was created.
ZIM_GROUP_EVENT_DISMISSED
ZIM_GROUP_EVENT_DISMISSED=(2)The group was dismissed.
ZIM_GROUP_EVENT_JOINED
ZIM_GROUP_EVENT_JOINED=(3)A member joined the group.
ZIM_GROUP_EVENT_INVITED
ZIM_GROUP_EVENT_INVITED=(4)A member was invited to join the group.
ZIM_GROUP_EVENT_LEFT
ZIM_GROUP_EVENT_LEFT=(5)A member left the group.
ZIM_GROUP_EVENT_KICKED_OUT
ZIM_GROUP_EVENT_KICKED_OUT=(6)A member was kicked out of the group.
ZIMGroupMemberEvent
Group member events.
Details
Group member events.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_MEMBER_EVENT_UNKNOWN
ZIM_GROUP_MEMBER_EVENT_UNKNOWN=(-1)Unknown event.
ZIM_GROUP_MEMBER_EVENT_JOINED
ZIM_GROUP_MEMBER_EVENT_JOINED=(1)A member joined the group.
ZIM_GROUP_MEMBER_EVENT_LEFT
ZIM_GROUP_MEMBER_EVENT_LEFT=(2)A member left the group.
ZIM_GROUP_MEMBER_EVENT_KICKED_OUT
ZIM_GROUP_MEMBER_EVENT_KICKED_OUT=(4)A member was kicked out of the group.
ZIM_GROUP_MEMBER_EVENT_INVITED
ZIM_GROUP_MEMBER_EVENT_INVITED=(5)A member was invited to join the group.
ZIMGroupMemberState
group membership status.
Details
group membership status.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_MEMBER_STATE_QUIT
ZIM_GROUP_MEMBER_STATE_QUIT=(0)The member has left the group.
ZIM_GROUP_MEMBER_STATE_ENTER
ZIM_GROUP_MEMBER_STATE_ENTER=(1)The member has entered the group.
ZIMGroupMessageNotificationStatus
Enumeration of group notification status.
Details
Enumeration of group notification status.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_MESSAGE_NOTIFICATION_STATUS_NOTIFY
ZIM_GROUP_MESSAGE_NOTIFICATION_STATUS_NOTIFY=(1)Message notifications are enabled.
ZIM_GROUP_MESSAGE_NOTIFICATION_STATUS_DO_NOT_DISTURB
ZIM_GROUP_MESSAGE_NOTIFICATION_STATUS_DO_NOT_DISTURB=(2)Do not disturb mode is enabled.
ZIMGroupAttributesUpdateAction
Group attributes update action.
Details
Group attributes update action.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_ATTRIBUTES_UPDATE_ACTION_SET
ZIM_GROUP_ATTRIBUTES_UPDATE_ACTION_SET=(0)Set action.
ZIM_GROUP_ATTRIBUTES_UPDATE_ACTION_DELETE
ZIM_GROUP_ATTRIBUTES_UPDATE_ACTION_DELETE=(1)Delete the group attributes.
ZIMGroupMuteMode
Group mute mode.
Details
Group mute mode.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_MUTE_MODE_NONE
ZIM_GROUP_MUTE_MODE_NONE=(0)Unmute.
ZIM_GROUP_MUTE_MODE_NORMAL
ZIM_GROUP_MUTE_MODE_NORMAL=(1)Group normal members mute mode.
ZIM_GROUP_MUTE_MODE_ALL
ZIM_GROUP_MUTE_MODE_ALL=(2)Group all members mute mode.
ZIM_GROUP_MUTE_MODE_CUSTOM
ZIM_GROUP_MUTE_MODE_CUSTOM=(3)Customize group mute mode
ZIMGroupJoinMode
Verification mode for joining the group.
Details
Verification mode for joining the group.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_JOIN_MODE_ANY
ZIM_GROUP_JOIN_MODE_ANY=(0)Anyone can join the group directly.
ZIM_GROUP_JOIN_MODE_AUTH
ZIM_GROUP_JOIN_MODE_AUTH=(1)Requires group owner or administrator approval.
ZIM_GROUP_JOIN_MODE_FORBID
ZIM_GROUP_JOIN_MODE_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.h
Properties
ZIM_GROUP_INVITE_MODE_ANY
ZIM_GROUP_INVITE_MODE_ANY=(0)Everyone in the group can invite.
ZIM_GROUP_INVITE_MODE_ADMIN
ZIM_GROUP_INVITE_MODE_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.h
Properties
ZIM_GROUP_BE_INVITE_MODE_NONE
ZIM_GROUP_BE_INVITE_MODE_NONE=(0)The invitees enter the group directly.
ZIM_GROUP_BE_INVITE_MODE_AUTH
ZIM_GROUP_BE_INVITE_MODE_AUTH=(1)The invitee's consent is required to join the group.
ZIMGroupEnterType
Group enter type.
Details
Group enter type.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_ENTER_TYPE_UNKNOWN
ZIM_GROUP_ENTER_TYPE_UNKNOWN=(0)Unknown enter type.
ZIM_GROUP_ENTER_TYPE_CREATED
ZIM_GROUP_ENTER_TYPE_CREATED=(1)The user created the group.
ZIM_GROUP_ENTER_TYPE_JOIN_APPLY
ZIM_GROUP_ENTER_TYPE_JOIN_APPLY=(2)The user joined the group via an application.
ZIM_GROUP_ENTER_TYPE_JOINED
ZIM_GROUP_ENTER_TYPE_JOINED=(3)The user actively joined the group.
ZIM_GROUP_ENTER_TYPE_INVITED
ZIM_GROUP_ENTER_TYPE_INVITED=(4)The user was invited to join the group.
ZIM_GROUP_ENTER_TYPE_INVITE_APPLY
ZIM_GROUP_ENTER_TYPE_INVITE_APPLY=(5)The user joined the group via invitation application.
ZIMGroupApplicationType
Group application type.
Details
Group application type.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_APPLICATION_TYPE_UNKNOWN
ZIM_GROUP_APPLICATION_TYPE_UNKNOWN=(-1)Unknown group application type.
ZIM_GROUP_APPLICATION_TYPE_NONE
ZIM_GROUP_APPLICATION_TYPE_NONE=(0)None.
ZIM_GROUP_APPLICATION_TYPE_JOIN
ZIM_GROUP_APPLICATION_TYPE_JOIN=(1)Join type.
ZIM_GROUP_APPLICATION_TYPE_INVITE
ZIM_GROUP_APPLICATION_TYPE_INVITE=(2)Invite type.
ZIM_GROUP_APPLICATION_TYPE_BE_INVITE
ZIM_GROUP_APPLICATION_TYPE_BE_INVITE=(3)Be invite type.
ZIMGroupApplicationState
Group application state.
Details
Group application state.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_APPLICATION_STATE_UNKNOWN
ZIM_GROUP_APPLICATION_STATE_UNKNOWN=(-1)Unknown group application state.
ZIM_GROUP_APPLICATION_STATE_WAITING
ZIM_GROUP_APPLICATION_STATE_WAITING=(1)Awaiting response.
ZIM_GROUP_APPLICATION_STATE_ACCEPTED
ZIM_GROUP_APPLICATION_STATE_ACCEPTED=(2)Accepted.
ZIM_GROUP_APPLICATION_STATE_REJECTED
ZIM_GROUP_APPLICATION_STATE_REJECTED=(3)Rejected.
ZIM_GROUP_APPLICATION_STATE_EXPIRED
ZIM_GROUP_APPLICATION_STATE_EXPIRED=(4)Expired.
ZIM_GROUP_APPLICATION_STATE_DISABLED
ZIM_GROUP_APPLICATION_STATE_DISABLED=(5)Disabled
ZIMGroupApplicationListChangeAction
Group application list update action.
Details
Group application list update action.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_APPLICATION_LIST_CHANGE_ACTION_ADDED
ZIM_GROUP_APPLICATION_LIST_CHANGE_ACTION_ADDED=(0)Add action.
ZIMGroupMemberRole
Group member role
Details
Group member role
Declared in ZIMDefines.h
Properties
ZIM_GROUP_MEMBER_ROLE_OWNER
ZIM_GROUP_MEMBER_ROLE_OWNER=(1)Group Owner.
ZIM_GROUP_MEMBER_ROLE_ADMIN
ZIM_GROUP_MEMBER_ROLE_ADMIN=(2)Group Admin.
ZIM_GROUP_MEMBER_ROLE_MEMBER
ZIM_GROUP_MEMBER_ROLE_MEMBER=(3)Group Member.
ZIMGroupDataFlag
The flag type for group data fields.
Details
The flag type for group data fields.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_DATA_FLAG_NAME
ZIM_GROUP_DATA_FLAG_NAME=(1)Group name data flag.
ZIM_GROUP_DATA_FLAG_NOTICE
ZIM_GROUP_DATA_FLAG_NOTICE=(2)Group notice data flag.
ZIM_GROUP_DATA_FLAG_AVATAR_URL
ZIM_GROUP_DATA_FLAG_AVATAR_URL=(4)Group avatar URL data flag.
ZIMCallInvitationMode
Call invitation mode.
Details
Call invitation mode.
Declared in ZIMDefines.h
Properties
ZIM_CALL_INVITATION_MODE_UNKNOWN
ZIM_CALL_INVITATION_MODE_UNKNOWN=(-1)Unknown type, as a guaranteed enumeration value.
ZIM_CALL_INVITATION_MODE_GENERAL
ZIM_CALL_INVITATION_MODE_GENERAL=(0)general.
ZIM_CALL_INVITATION_MODE_ADVANCED
ZIM_CALL_INVITATION_MODE_ADVANCED=(1)advanced
ZIMCallState
call status.
Details
call status.
Declared in ZIMDefines.h
Properties
ZIM_CALL_STATE_UNKNOWN
ZIM_CALL_STATE_UNKNOWN=(-1)Unknown call state.
ZIM_CALL_STATE_STARTED
ZIM_CALL_STATE_STARTED=(1)The call has started.
ZIM_CALL_STATE_ENDED
ZIM_CALL_STATE_ENDED=(2)The call has ended.
ZIMCallUserState
Call user status.
Details
Call user status.
Declared in ZIMDefines.h
Properties
ZIM_CALL_USER_STATE_UNKNOWN
ZIM_CALL_USER_STATE_UNKNOWN=(-1)unknown
ZIM_CALL_USER_STATE_INVITING
ZIM_CALL_USER_STATE_INVITING=(0)inviting.
ZIM_CALL_USER_STATE_ACCEPTED
ZIM_CALL_USER_STATE_ACCEPTED=(1)accepted.
ZIM_CALL_USER_STATE_REJECTED
ZIM_CALL_USER_STATE_REJECTED=(2)rejected.
ZIM_CALL_USER_STATE_CANCELLED
ZIM_CALL_USER_STATE_CANCELLED=(3)cancelled.
ZIM_CALL_USER_STATE_RECEIVED
ZIM_CALL_USER_STATE_RECEIVED=(5)received.
ZIM_CALL_USER_STATE_TIMEOUT
ZIM_CALL_USER_STATE_TIMEOUT=(6)timeout.
ZIM_CALL_USER_STATE_QUIT
ZIM_CALL_USER_STATE_QUIT=(7)quit.
ZIM_CALL_USER_STATE_ENDED
ZIM_CALL_USER_STATE_ENDED=(8)ended.
ZIM_CALL_USER_STATE_NOT_YET_RECEIVED
ZIM_CALL_USER_STATE_NOT_YET_RECEIVED=(9)Not received.
ZIM_CALL_USER_STATE_BE_CANCELLED
ZIM_CALL_USER_STATE_BE_CANCELLED=(10)Be cancelled.
ZIMUserInfoType
User type.
Details
User type.
Declared in ZIMDefines.h
Properties
ZIM_USER_INFO_TYPE_BASIC_USER
ZIM_USER_INFO_TYPE_BASIC_USER=(1)Basic user type.
ZIM_USER_INFO_TYPE_ROOM_MEMBER
ZIM_USER_INFO_TYPE_ROOM_MEMBER=(2)Room member type.
ZIM_USER_INFO_TYPE_GROUP_MEMBER
ZIM_USER_INFO_TYPE_GROUP_MEMBER=(3)Group member type.
ZIM_USER_INFO_TYPE_GROUP_SIMPLE_MEMBER
ZIM_USER_INFO_TYPE_GROUP_SIMPLE_MEMBER=(4)Group member brief info type.
ZIM_USER_INFO_TYPE_FRIEND
ZIM_USER_INFO_TYPE_FRIEND=(5)Friend type.
ZIM_USER_INFO_TYPE_COMMUNITY_MEMBER
ZIM_USER_INFO_TYPE_COMMUNITY_MEMBER=(6)Community member type.
ZIM_USER_INFO_TYPE_COMMUNITY_SIMPLE_MEMBER
ZIM_USER_INFO_TYPE_COMMUNITY_SIMPLE_MEMBER=(7)Community member brief info type.
ZIMFriendListChangeAction
friend list update action.
Details
friend list update action.
Declared in ZIMDefines.h
Properties
ZIM_FRIEND_LIST_CHANGE_ACTION_ADDED
ZIM_FRIEND_LIST_CHANGE_ACTION_ADDED=(0)Add action.
ZIM_FRIEND_LIST_CHANGE_ACTION_DELETED
ZIM_FRIEND_LIST_CHANGE_ACTION_DELETED=(1)Delete action.
ZIMFriendApplicationListChangeAction
friend application list update action.
Details
friend application list update action.
Declared in ZIMDefines.h
Properties
ZIM_FRIEND_APPLICATION_LIST_CHANGE_ACTION_ADDED
ZIM_FRIEND_APPLICATION_LIST_CHANGE_ACTION_ADDED=(0)Add action.
ZIM_FRIEND_APPLICATION_LIST_CHANGE_ACTION_DELETED
ZIM_FRIEND_APPLICATION_LIST_CHANGE_ACTION_DELETED=(1)Delete action.
ZIMFriendApplicationType
Friend application type.
Details
Friend application type.
Declared in ZIMDefines.h
Properties
ZIM_FRIEND_APPLICATION_TYPE_UNKNOWN
ZIM_FRIEND_APPLICATION_TYPE_UNKNOWN=(-1)Unknown friend application type.
ZIM_FRIEND_APPLICATION_TYPE_NONE
ZIM_FRIEND_APPLICATION_TYPE_NONE=(0)Friend application type none.
ZIM_FRIEND_APPLICATION_TYPE_RECEIVED
ZIM_FRIEND_APPLICATION_TYPE_RECEIVED=(1)Applications received.
ZIM_FRIEND_APPLICATION_TYPE_SENT
ZIM_FRIEND_APPLICATION_TYPE_SENT=(2)Application sent.
ZIM_FRIEND_APPLICATION_TYPE_BOTH
ZIM_FRIEND_APPLICATION_TYPE_BOTH=(3)Both parties sent friend applications to each other.
ZIMFriendApplicationState
Friend application state.
Details
Friend application state.
Declared in ZIMDefines.h
Properties
ZIM_FRIEND_APPLICATION_STATE_UNKNOWN
ZIM_FRIEND_APPLICATION_STATE_UNKNOWN=(-1)Unknown friend application state.
ZIM_FRIEND_APPLICATION_STATE_WAITING
ZIM_FRIEND_APPLICATION_STATE_WAITING=(1)Awaiting response.
ZIM_FRIEND_APPLICATION_STATE_ACCEPTED
ZIM_FRIEND_APPLICATION_STATE_ACCEPTED=(2)Accepted.
ZIM_FRIEND_APPLICATION_STATE_REJECTED
ZIM_FRIEND_APPLICATION_STATE_REJECTED=(3)Rejected.
ZIM_FRIEND_APPLICATION_STATE_EXPIRED
ZIM_FRIEND_APPLICATION_STATE_EXPIRED=(4)The friend application has expired.
ZIM_FRIEND_APPLICATION_STATE_DISABLED
ZIM_FRIEND_APPLICATION_STATE_DISABLED=(5)The friend application is disabled.
ZIMFriendRelationCheckType
Check the friend relationship type.
Details
Check the friend relationship type.
Declared in ZIMDefines.h
Properties
ZIM_FRIEND_RELATION_CHECK_TYPE_BOTH
ZIM_FRIEND_RELATION_CHECK_TYPE_BOTH=(0)Check the friend relationship from both sides.
ZIM_FRIEND_RELATION_CHECK_TYPE_SINGLE
ZIM_FRIEND_RELATION_CHECK_TYPE_SINGLE=(1)Check the friend relationship from one side only.
ZIMFriendDeleteType
Delete friend type.
Details
Delete friend type.
Declared in ZIMDefines.h
Properties
ZIM_FRIEND_DELETE_TYPE_BOTH
ZIM_FRIEND_DELETE_TYPE_BOTH=(0)Delete the friend from both sides.
ZIM_FRIEND_DELETE_TYPE_SINGLE
ZIM_FRIEND_DELETE_TYPE_SINGLE=(1)Delete the friend from one side only.
ZIMUserRelationType
Friend relationship type.
Details
Friend relationship type.
Declared in ZIMDefines.h
Properties
ZIM_USER_RELATION_TYPE_UNKNOWN
ZIM_USER_RELATION_TYPE_UNKNOWN=(0)Unknown relation type.
ZIM_USER_RELATION_TYPE_SINGLE_NO
ZIM_USER_RELATION_TYPE_SINGLE_NO=(1)No friendship from the user's perspective.
ZIM_USER_RELATION_TYPE_SINGLE_HAVE
ZIM_USER_RELATION_TYPE_SINGLE_HAVE=(2)Friendship exists from the user's perspective.
ZIM_USER_RELATION_TYPE_BOTH_ALL_NO
ZIM_USER_RELATION_TYPE_BOTH_ALL_NO=(3)No friendship from either side.
ZIM_USER_RELATION_TYPE_BOTH_SELF_HAVE
ZIM_USER_RELATION_TYPE_BOTH_SELF_HAVE=(4)The user has added the other as a friend, but not vice versa.
ZIM_USER_RELATION_TYPE_BOTH_OTHER_HAVE
ZIM_USER_RELATION_TYPE_BOTH_OTHER_HAVE=(5)The other party has added the user as a friend, but not vice versa.
ZIM_USER_RELATION_TYPE_BOTH_ALL_HAVE
ZIM_USER_RELATION_TYPE_BOTH_ALL_HAVE=(6)Both parties are friends with each other.
ZIMBlacklistChangeAction
blacklist update action.
Details
blacklist update action.
Declared in ZIMDefines.h
Properties
ZIM_BLACKLIST_CHANGE_ACTION_ADDED
ZIM_BLACKLIST_CHANGE_ACTION_ADDED=(0)Add action.
ZIM_BLACKLIST_CHANGE_ACTION_REMOVED
ZIM_BLACKLIST_CHANGE_ACTION_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.h
Properties
ZIMCX_HANDLE_TYPE_GENERIC
ZIMCX_HANDLE_TYPE_GENERIC=(1)Generic handle type.
ZIMCX_HANDLE_TYPE_PHONE_NUMBER
ZIMCX_HANDLE_TYPE_PHONE_NUMBER=(2)Phone number handle type.
ZIMCX_HANDLE_TYPE_EMAIL_ADDRESS
ZIMCX_HANDLE_TYPE_EMAIL_ADDRESS=(3)Email address handle type.
ZIMGeofencingType
Geofencing type.
Details
Geofencing type.
Declared in ZIMDefines.h
Properties
ZIM_GEOFENCING_TYPE_NONE
ZIM_GEOFENCING_TYPE_NONE=(0)The default type.
ZIM_GEOFENCING_TYPE_INCLUDE
ZIM_GEOFENCING_TYPE_INCLUDE=(1)Federated mode.
ZIM_GEOFENCING_TYPE_EXCLUDE
ZIM_GEOFENCING_TYPE_EXCLUDE=(2)Exclusion mode.
ZIMGeofencingArea
Geofencing Area
Details
Geofencing Area
Declared in ZIMDefines.h
Properties
ZIM_GEOFENCING_AREA_CN
ZIM_GEOFENCING_AREA_CN=(2)China
ZIM_GEOFENCING_AREA_NA
ZIM_GEOFENCING_AREA_NA=(3)North America
ZIM_GEOFENCING_AREA_EU
ZIM_GEOFENCING_AREA_EU=(4)Europe
ZIM_GEOFENCING_AREA_AS
ZIM_GEOFENCING_AREA_AS=(5)Asia
ZIM_GEOFENCING_AREA_IN
ZIM_GEOFENCING_AREA_IN=(6)India
ZIMPlatformType
Platform on which the SDK runs.
Details
Platform on which the SDK runs.
Declared in ZIMDefines.h
Properties
ZIM_PLATFORM_TYPE_WIN
ZIM_PLATFORM_TYPE_WIN=(1)Windows.
ZIM_PLATFORM_TYPE_I_PHONE_OS
ZIM_PLATFORM_TYPE_I_PHONE_OS=(2)iOS.
ZIM_PLATFORM_TYPE_ANDROID
ZIM_PLATFORM_TYPE_ANDROID=(3)Android.
ZIM_PLATFORM_TYPE_MAC_OS
ZIM_PLATFORM_TYPE_MAC_OS=(4)MacOS.
ZIM_PLATFORM_TYPE_LINUX
ZIM_PLATFORM_TYPE_LINUX=(5)Linux.
ZIM_PLATFORM_TYPE_WEB
ZIM_PLATFORM_TYPE_WEB=(6)Web.
ZIM_PLATFORM_TYPE_MINI_PROGRAM
ZIM_PLATFORM_TYPE_MINI_PROGRAM=(7)Mini program.
ZIM_PLATFORM_TYPE_I_PAD_OS
ZIM_PLATFORM_TYPE_I_PAD_OS=(9)iPad.
ZIM_PLATFORM_TYPE_OHOS
ZIM_PLATFORM_TYPE_OHOS=(10)HarmonyOS (OHOS) platform.
ZIM_PLATFORM_TYPE_UNKNOWN
ZIM_PLATFORM_TYPE_UNKNOWN=(32)Platforms not mentioned above.
ZIMUserOnlineStatus
User online status.
Details
User online status.
Declared in ZIMDefines.h
Properties
ZIM_USER_ONLINE_STATUS_ONLINE
ZIM_USER_ONLINE_STATUS_ONLINE=(0)Online. The user is in this state when the user is logged in and the network status is good.
ZIM_USER_ONLINE_STATUS_OFFLINE
ZIM_USER_ONLINE_STATUS_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.
ZIM_USER_ONLINE_STATUS_LOGOUT
ZIM_USER_ONLINE_STATUS_LOGOUT=(2)Log out. User active logout will be in this state.
ZIM_USER_ONLINE_STATUS_UNKNOWN
ZIM_USER_ONLINE_STATUS_UNKNOWN=(99)Unknown status. Guaranteed enumeration.
ZIMListChangeAction
The action type for list changes.
Details
The action type for list changes.
Declared in ZIMDefines.h
Properties
ZIM_LIST_CHANGE_ACTION_ADDED
ZIM_LIST_CHANGE_ACTION_ADDED=(0)An item was added.
ZIM_LIST_CHANGE_ACTION_DELETED
ZIM_LIST_CHANGE_ACTION_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.h
Properties
ZIM_COMMUNITY_LIST_CHANGE_ACTION_ADDED
ZIM_COMMUNITY_LIST_CHANGE_ACTION_ADDED=(0)A community was added.
ZIM_COMMUNITY_LIST_CHANGE_ACTION_DELETED
ZIM_COMMUNITY_LIST_CHANGE_ACTION_DELETED=(1)A community was deleted.
ZIM_COMMUNITY_LIST_CHANGE_ACTION_UPDATED
ZIM_COMMUNITY_LIST_CHANGE_ACTION_UPDATED=(2)A community was updated.
ZIMCommunityMemberEnterType
The enter type for community members.
Details
The enter type for community members.
Declared in ZIMDefines.h
Properties
ZIM_COMMUNITY_MEMBER_ENTER_TYPE_UNKNOWN
ZIM_COMMUNITY_MEMBER_ENTER_TYPE_UNKNOWN=(0)Unknown enter type.
ZIM_COMMUNITY_MEMBER_ENTER_TYPE_COMMUNITY_CREATED
ZIM_COMMUNITY_MEMBER_ENTER_TYPE_COMMUNITY_CREATED=(1)The member joined when the community was created.
ZIM_COMMUNITY_MEMBER_ENTER_TYPE_COMMUNITY_JOINED
ZIM_COMMUNITY_MEMBER_ENTER_TYPE_COMMUNITY_JOINED=(2)The member actively joined the community.
ZIM_COMMUNITY_MEMBER_ENTER_TYPE_COMMUNITY_INVITED
ZIM_COMMUNITY_MEMBER_ENTER_TYPE_COMMUNITY_INVITED=(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
ZIM_COMMUNITY_MEMBER_CHANGE_STATE_EXITED
ZIM_COMMUNITY_MEMBER_CHANGE_STATE_EXITED=(0)The member exited the community.
ZIM_COMMUNITY_MEMBER_CHANGE_STATE_ENTERED
ZIM_COMMUNITY_MEMBER_CHANGE_STATE_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.h
Properties
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_UNKNOWN
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_UNKNOWN=(0)Unknown action.
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_JOINED
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_JOINED=(1)The member actively joined the community.
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_INVITED
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_INVITED=(2)The member was invited to join the community.
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_LEFT
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_LEFT=(3)The member actively left the community.
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_KICKED_OUT
ZIM_COMMUNITY_MEMBER_CHANGE_ACTION_KICKED_OUT=(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
ZIM_COMMUNITY_CHANNEL_TYPE_UNKNOWN
ZIM_COMMUNITY_CHANNEL_TYPE_UNKNOWN=(-1)Unknown channel.
ZIM_COMMUNITY_CHANNEL_TYPE_GENERAL
ZIM_COMMUNITY_CHANNEL_TYPE_GENERAL=(0)Default channel, automatically created when the community is created.
ZIM_COMMUNITY_CHANNEL_TYPE_PUBLIC
ZIM_COMMUNITY_CHANNEL_TYPE_PUBLIC=(1)Public channel, visible to all members of the community.
ZIM_COMMUNITY_CHANNEL_TYPE_PRIVATE
ZIM_COMMUNITY_CHANNEL_TYPE_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.h
Properties
ZIM_COMMUNITY_CHANNEL_LIST_CHANGE_ACTION_ADDED
ZIM_COMMUNITY_CHANNEL_LIST_CHANGE_ACTION_ADDED=(0)A community channel was added.
ZIM_COMMUNITY_CHANNEL_LIST_CHANGE_ACTION_DELETED
ZIM_COMMUNITY_CHANNEL_LIST_CHANGE_ACTION_DELETED=(1)A community channel was deleted.
ZIM_COMMUNITY_CHANNEL_LIST_CHANGE_ACTION_UPDATED
ZIM_COMMUNITY_CHANNEL_LIST_CHANGE_ACTION_UPDATED=(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
ZIM_COMMUNITY_CHANNEL_MUTE_MODE_NONE
ZIM_COMMUNITY_CHANNEL_MUTE_MODE_NONE=(0)No mute mode.
ZIM_COMMUNITY_CHANNEL_MUTE_MODE_NORMAL
ZIM_COMMUNITY_CHANNEL_MUTE_MODE_NORMAL=(1)Normal mute mode; only administrators and the owner can speak.
ZIM_COMMUNITY_CHANNEL_MUTE_MODE_ALL
ZIM_COMMUNITY_CHANNEL_MUTE_MODE_ALL=(2)All members are muted.
ZIM_COMMUNITY_CHANNEL_MUTE_MODE_CUSTOM
ZIM_COMMUNITY_CHANNEL_MUTE_MODE_CUSTOM=(3)Custom mute mode.
ZIMCommunityMemberMuteType
The mute type for community members.
Details
The mute type for community members.
Declared in ZIMDefines.h
Properties
ZIM_COMMUNITY_MEMBER_MUTE_TYPE_NONE
ZIM_COMMUNITY_MEMBER_MUTE_TYPE_NONE=(0)Not muted.
ZIM_COMMUNITY_MEMBER_MUTE_TYPE_COMMUNITY
ZIM_COMMUNITY_MEMBER_MUTE_TYPE_COMMUNITY=(1)Muted at the community level.
ZIM_COMMUNITY_MEMBER_MUTE_TYPE_CHANNEL
ZIM_COMMUNITY_MEMBER_MUTE_TYPE_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.h
Properties
ZIM_COMMUNITY_MESSAGE_NOTIFICATION_STATUS_NOTIFY
ZIM_COMMUNITY_MESSAGE_NOTIFICATION_STATUS_NOTIFY=(1)Message notifications are enabled.
ZIM_COMMUNITY_MESSAGE_NOTIFICATION_STATUS_DO_NOT_DISTURB
ZIM_COMMUNITY_MESSAGE_NOTIFICATION_STATUS_DO_NOT_DISTURB=(2)Do not disturb mode is enabled.
ZIMCommunityMemberRole
Community member role
Details
Community member role
Declared in ZIMDefines.h
Properties
ZIM_COMMUNITY_MEMBER_ROLE_OWNER
ZIM_COMMUNITY_MEMBER_ROLE_OWNER=(1)Community Owner.
ZIM_COMMUNITY_MEMBER_ROLE_ADMIN
ZIM_COMMUNITY_MEMBER_ROLE_ADMIN=(2)Community Admin.
ZIM_COMMUNITY_MEMBER_ROLE_MEMBER
ZIM_COMMUNITY_MEMBER_ROLE_MEMBER=(3)Community Member.