Enum
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.
Declared in ZIMDefines.h
Properties
CXHandle_TYPE_PHONE_NUMBER
CXHandle_TYPE_PHONE_NUMBER=(2)A phone number.
ZIM_CX_HANDLE_TYPE_EMAIL_ADDRESS
ZIM_CX_HANDLE_TYPE_EMAIL_ADDRESS=(3)An email address.
ZIM_CX_HANDLE_TYPE_GENERIC
ZIM_CX_HANDLE_TYPE_GENERIC=(1)An unspecified type of handle.
ZIMCallInvitationMode
Call invitation mode.
Details
Call invitation mode.
Declared in ZIMDefines.h
Properties
ZIM_INVITATION_MODE_GENERAL
ZIM_INVITATION_MODE_GENERAL=(0)general.
ZIM_INVITATION_MODE_ADVANCED
ZIM_INVITATION_MODE_ADVANCED=(1)advanced
ZIM_INVITATION_MODE_UNKNOWN
ZIM_INVITATION_MODE_UNKNOWN=(-1)Unknown type, as a guaranteed enumeration value.
ZIMCallState
call status.
Details
call status.
Declared in ZIMDefines.h
Properties
Unknown
Unknown=(-1)unknown.
Started
Started=(1)started.
Ended
Ended=(2)ended.
ZIMCallUserState
Call user status.
Details
Call user status.
Declared in ZIMDefines.h
Properties
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_OFFLINE
ZIM_CALL_USER_STATE_OFFLINE=(4)offline.
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_UNKNOWN
ZIM_CALL_USER_STATE_UNKNOWN=(-1)unknown
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.
ZIMConnectionEvent
The event that caused the connection status to change.
Details
The reason for the change of the connection state.
- Use cases: It can be used to determine whether the login/logout is successful, and to handle abnormal situations such as network disconnection.
- Caution: Please use it with the connection state parameter.
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.
Business scenario: When the developer uses Token authentication to log in, and does not call [renewToken] to update the Token after the Token validity period expires, the connection will be disconnected.
ZIMConnectionState
Connection state.
Details
The state machine that identifies the current connection state.
- Use cases: It can be used to determine whether the login/logout is successful, and to handle abnormal situations such as network disconnection.
- Caution: Please use it with the connection event parameter.
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.
- Use cases: If there is a steady state abnormality in the process of logging in, such as AppID or Token are incorrect, or if the same user name is logged in elsewhere and the local end is kicked out, it will enter this state.
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.
- Use cases: The display of the UI is usually performed using this state. If the connection is interrupted due to poor network quality, the SDK will perform an internal retry and will return to this state.
ZIM_CONNECTION_STATE_CONNECTED
ZIM_CONNECTION_STATE_CONNECTED=(2)The state that is successfully connected.
- Use cases: Entering this state indicates that login successfully and the user can use the SDK functions normally.
ZIM_CONNECTION_STATE_RECONNECTING
ZIM_CONNECTION_STATE_RECONNECTING=(3)The connection is being reconnected.
- Use cases: In this state, you are logging in again.
ZIMConversationEvent
conversation changed event.
Declared in ZIMDefines.h
Properties
ZIM_CONVERSATION_EVENT_ADDED
ZIM_CONVERSATION_EVENT_ADDED=(0)ZIM_CONVERSATION_EVENT_UPDATED
ZIM_CONVERSATION_EVENT_UPDATED=(1)ZIM_CONVERSATION_EVENT_DISABLED
ZIM_CONVERSATION_EVENT_DISABLED=(2)ZIM_CONVERSATION_EVENT_DELETED
ZIM_CONVERSATION_EVENT_DELETED=(3)ZIMConversationNotificationStatus
Enumeration of conversation notification status.
Details
Conversation notification status.
- Use cases: You can determine the notification status of a conversation by modifying enumeration.
Declared in ZIMDefines.h
Properties
ZIMConversationNotificationStatusNotify
ZIMConversationNotificationStatusNotify=(1)ZIMConversationNotificationStatusDoNotDisturb
ZIMConversationNotificationStatusDoNotDisturb=(2)ZIMConversationSyncState
Identifies the SDK's state in syncing conversation list from server.
Details
Identifies the SDK's state in syncing conversation list from server, enabling the business layer to render different UI presentations based on this state.
Declared in ZIMDefines.h
Properties
ZIM_CONVERSATION_SYNC_STATE_STARTED
ZIM_CONVERSATION_SYNC_STATE_STARTED=(0)Starting conversation list synchronization from server.
ZIM_CONVERSATION_SYNC_STATE_FINISHED
ZIM_CONVERSATION_SYNC_STATE_FINISHED=(1)Finished conversation list synchronization from server.
ZIM_CONVERSATION_SYNC_STATE_FAILED
ZIM_CONVERSATION_SYNC_STATE_FAILED=(2)Failed to synchronize the session list from the server.
ZIMConversationType
Conversation type.
Declared in ZIMDefines.h
Properties
ZIMConversationTypePeer
ZIMConversationTypePeer=(0)Conversation type peer.
ZIMConversationTypeRoom
ZIMConversationTypeRoom=(1)Conversation type room.
ZIMConversationTypeGroup
ZIMConversationTypeGroup=(2)Conversation type group.
ZIM_CONVERSATION_TYPE_UNKNOWN
ZIM_CONVERSATION_TYPE_UNKNOWN=(3)Unknown.
ZIMErrorCode
The define of error code.
Details
Developers can find the details of the error code in the developer documentation website according to the error code.
- Use cases: It can be used to collect and record errors in the process of using the SDK.
Declared in ZIMErrorCode.h
Properties
ZIM_ERROR_CODE_SUCCESS
ZIM_ERROR_CODE_SUCCESS=(0)Success without exception.
- Use cases: Used to indicate that the operation is executed correctly.
ZIM_ERROR_CODE_FAILED
ZIM_ERROR_CODE_FAILED=(1)Failed, the guarantee is wrong.
- Use cases: Used in the operation guarantee strategy.
ZIM_ERROR_CODE_COMMON_MODULE_PARAMS_INVALID
ZIM_ERROR_CODE_COMMON_MODULE_PARAMS_INVALID=(6000001)The incoming parameter is invalid.
Use case: Used to protect the bottom strategy when the interface call fails due to incorrect parameters.
ZIM_ERROR_CODE_COMMON_MODULE_ENGINE_NOT_INIT
ZIM_ERROR_CODE_COMMON_MODULE_ENGINE_NOT_INIT=(6000002)The SDK is not initialized.
Use case: Used for error return when the ZIM SDK is not initialized successfully.
ZIM_ERROR_CODE_COMMON_MODULE_INVALID_APPID
ZIM_ERROR_CODE_COMMON_MODULE_INVALID_APPID=(6000003)Invalid AppID.
Use case: Used for error return of failure due to invalid AppID.
ZIM_ERROR_CODE_COMMON_MODULE_TRIGGER_SDK_FREQUENCY_LIMIT
ZIM_ERROR_CODE_COMMON_MODULE_TRIGGER_SDK_FREQUENCY_LIMIT=(6000004)Trigger SDK internal frequency limit.
ZIM_ERROR_CODE_COMMON_MODULE_TRIGGER_SERVER_FREQUENCY_LIMIT
ZIM_ERROR_CODE_COMMON_MODULE_TRIGGER_SERVER_FREQUENCY_LIMIT=(600005)Trigger background service frequency limit.
ZIM_ERROR_CODE_COMMON_MODULE_SWITCH_SERVER_ERROR
ZIM_ERROR_CODE_COMMON_MODULE_SWITCH_SERVER_ERROR=(6000006)The Switch server reported an error.
ZIM_ERROR_CODE_COMMON_MODULE_IM_SERVER_ERROR
ZIM_ERROR_CODE_COMMON_MODULE_IM_SERVER_ERROR=(6000007)ZIM service internal error.
ZIM_ERROR_CODE_COMMON_MODULE_IM_DATABASE_ERROR
ZIM_ERROR_CODE_COMMON_MODULE_IM_DATABASE_ERROR=(6000008)ZIM internal database error.
ZIM_ERROR_CODE_COMMON_MODULE_IM_SERVER_DISCONNECT
ZIM_ERROR_CODE_COMMON_MODULE_IM_SERVER_DISCONNECT=(6000009)Disconnected while sending request.
ZIM_ERROR_CODE_COMMON_MODULE_UPLOAD_LOG_ERROR
ZIM_ERROR_CODE_COMMON_MODULE_UPLOAD_LOG_ERROR=(6000010)Failed to upload log.
ZIM_ERROR_CODE_NETWORK_MODULE_COMMON_ERROR
ZIM_ERROR_CODE_NETWORK_MODULE_COMMON_ERROR=(6000101)Login failed.
ZIM_ERROR_CODE_NETWORK_MODULE_SERVER_ERROR
ZIM_ERROR_CODE_NETWORK_MODULE_SERVER_ERROR=(6000102)Login failed due to internal reasons.
ZIM_ERROR_CODE_NETWORK_MODULE_TOKEN_INVALID
ZIM_ERROR_CODE_NETWORK_MODULE_TOKEN_INVALID=(6000103)Token is invalid.
ZIM_ERROR_CODE_NETWORK_MODULE_NETWORK_ERROR
ZIM_ERROR_CODE_NETWORK_MODULE_NETWORK_ERROR=(6000104)Network error.
ZIM_ERROR_CODE_NETWORK_MODULE_TOKEN_EXPIRED
ZIM_ERROR_CODE_NETWORK_MODULE_TOKEN_EXPIRED=(6000106)Token expired.
ZIM_ERROR_CODE_NETWORK_MODULE_TOKEN_VERSION_ERROR
ZIM_ERROR_CODE_NETWORK_MODULE_TOKEN_VERSION_ERROR=(6000107)Token version number is wrong.
ZIM_ERROR_CODE_NETWORK_MODULE_TOKEN_TIME_IS_TOO_SHORT
ZIM_ERROR_CODE_NETWORK_MODULE_TOKEN_TIME_IS_TOO_SHORT=(6000108)Token duration is too short.
ZIM_ERROR_CODE_NETWORK_MODULE_USER_HAS_ALREADY_LOGGED
ZIM_ERROR_CODE_NETWORK_MODULE_USER_HAS_ALREADY_LOGGED=(6000111)Logging in to multiple accounts on the current device.
ZIM_ERROR_CODE_NETWORK_MODULE_USER_IS_NOT_LOGGED
ZIM_ERROR_CODE_NETWORK_MODULE_USER_IS_NOT_LOGGED=(6000121)User is not logged.
ZIM_ERROR_CODE_MESSAGE_MODULE_COMMON_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_COMMON_ERROR=(6000201)Internal error sending message.
ZIM_ERROR_CODE_MESSAGE_MODULE_SERVER_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_SERVER_ERROR=(6000202)Error sending message background service.
ZIM_ERROR_CODE_MESSAGE_MODULE_SEND_MESSAGE_FAILED
ZIM_ERROR_CODE_MESSAGE_MODULE_SEND_MESSAGE_FAILED=(6000203)Message sending failed.
ZIM_ERROR_CODE_MESSAGE_MODULE_TARGET_DOES_NOT_EXIST
ZIM_ERROR_CODE_MESSAGE_MODULE_TARGET_DOES_NOT_EXIST=(6000204)The message target does not exist.
ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_ERROR=(6000270)ZIM_ERROR_CODE_MESSAGE_MODULE_CANCEL_CALL_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_CANCEL_CALL_ERROR=(6000271)ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_SERVER_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_SERVER_ERROR=(6000272)ZIM_ERROR_CODE_MESSAGE_MODULE_IS_NOT_INVITOR
ZIM_ERROR_CODE_MESSAGE_MODULE_IS_NOT_INVITOR=(6000273)ZIM_ERROR_CODE_MESSAGE_MODULE_IS_NOT_INVITEE
ZIM_ERROR_CODE_MESSAGE_MODULE_IS_NOT_INVITEE=(6000274)ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_ALREADY_EXISTS
ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_ALREADY_EXISTS=(6000275)ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_DOES_NOT_EXIST
ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_DOES_NOT_EXIST=(6000276)ZIM_ERROR_CODE_ROOM_MODULE_COMMON_ERROR
ZIM_ERROR_CODE_ROOM_MODULE_COMMON_ERROR=(6000301)ZIM_ERROR_CODE_ROOM_MODULE_SERVER_ERROR
ZIM_ERROR_CODE_ROOM_MODULE_SERVER_ERROR=(6000302)ZIM_ERROR_CODE_ROOM_MODULE_CREATE_ROOM_ERROR
ZIM_ERROR_CODE_ROOM_MODULE_CREATE_ROOM_ERROR=(6000303)ZIM_ERROR_CODE_ROOM_MODULE_JOIN_ROOM_ERROR
ZIM_ERROR_CODE_ROOM_MODULE_JOIN_ROOM_ERROR=(6000304)ZIM_ERROR_CODE_ROOM_MODULE_LEAVE_ROOM_ERROR
ZIM_ERROR_CODE_ROOM_MODULE_LEAVE_ROOM_ERROR=(6000306)ZIM_ERROR_CODE_ROOM_MODULE_USER_IS_NOT_IN_THE_ROOM
ZIM_ERROR_CODE_ROOM_MODULE_USER_IS_NOT_IN_THE_ROOM=(6000321)ZIM_ERROR_CODE_ROOM_MODULE_THE_ROOM_DOES_NOT_EXIST
ZIM_ERROR_CODE_ROOM_MODULE_THE_ROOM_DOES_NOT_EXIST=(6000322)ZIM_ERROR_CODE_ROOM_MODULE_THE_ROOM_ALREADY_EXISTS
ZIM_ERROR_CODE_ROOM_MODULE_THE_ROOM_ALREADY_EXISTS=(6000323)ZIM_ERROR_CODE_ROOM_MODULE_THE_NUMBER_OF_EXISTING_ROOMS_HAS_REACHED_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_NUMBER_OF_EXISTING_ROOMS_HAS_REACHED_LIMIT=(6000324)ZIM_ERROR_CODE_ROOM_MODULE_THE_NUMBER_OF_JOINED_ROOMS_HAS_REACHED_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_NUMBER_OF_JOINED_ROOMS_HAS_REACHED_LIMIT=(6000325)ZIM_ERROR_CODE_ROOM_MODULE_ROOM_ATTRIBUTES_COMMON_ERROR
ZIM_ERROR_CODE_ROOM_MODULE_ROOM_ATTRIBUTES_COMMON_ERROR=(6000330)ZIM_ERROR_CODE_ROOM_MODULE_ROOM_ATTRIBUTES_OPERATION_FAILED_COMPLETELY
ZIM_ERROR_CODE_ROOM_MODULE_ROOM_ATTRIBUTES_OPERATION_FAILED_COMPLETELY=(6000331)ZIM_ERROR_CODE_ROOM_MODULE_ROOM_ATTRIBUTES_OPERATION_FAILED_PARTLY
ZIM_ERROR_CODE_ROOM_MODULE_ROOM_ATTRIBUTES_OPERATION_FAILED_PARTLY=(6000332)ZIM_ERROR_CODE_ROOM_MODULE_ROOM_ATTRIBUTES_QUERY_FAILED
ZIM_ERROR_CODE_ROOM_MODULE_ROOM_ATTRIBUTES_QUERY_FAILED=(6000333)ZIM_ERROR_CODE_ROOM_MODULE_THE_NUMBER_OF_ROOM_ATTRIBUTES_EXCEEDS_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_NUMBER_OF_ROOM_ATTRIBUTES_EXCEEDS_LIMIT=(6000334)ZIM_ERROR_CODE_ROOM_MODULE_THE_LENGTH_OF_ROOM_ATTRIBUTE_KEY_EXCEEDS_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_LENGTH_OF_ROOM_ATTRIBUTE_KEY_EXCEEDS_LIMIT=(6000335)ZIM_ERROR_CODE_ROOM_MODULE_THE_LENGTH_OF_ROOM_ATTRIBUTE_VALUE_EXCEEDS_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_LENGTH_OF_ROOM_ATTRIBUTE_VALUE_EXCEEDS_LIMIT=(6000336)ZIM_ERROR_CODE_ROOM_MODULE_THE_TOTAL_LENGTH_OF_ROOM_ATTRIBUTES_VALUE_EXCEEDS_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_TOTAL_LENGTH_OF_ROOM_ATTRIBUTES_VALUE_EXCEEDS_LIMIT=(6000337)ZIM_ERROR_CODE_ZPNS_MODULE_PUSH_ID_INVALID
ZIM_ERROR_CODE_ZPNS_MODULE_PUSH_ID_INVALID=(6000401)ZIM_ERROR_CODE_GROUP_MODULE_COMMON_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_COMMON_ERROR=(6000501)ZIM_ERROR_CODE_GROUP_MODULE_SERVER_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_SERVER_ERROR=(6000502)ZIM_ERROR_CODE_GROUP_MODULE_CREATE_GROUP_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_CREATE_GROUP_ERROR=(6000503)ZIM_ERROR_CODE_GROUP_MODULE_DISMISS_GROUP_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_DISMISS_GROUP_ERROR=(6000504)ZIM_ERROR_CODE_GROUP_MODULE_JOIN_GROUP_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_JOIN_GROUP_ERROR=(6000505)ZIM_ERROR_CODE_GROUP_MODULE_LEAVE_GROUP_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_LEAVE_GROUP_ERROR=(6000506)ZIM_ERROR_CODE_GROUP_MODULE_KICK_OUT_GROUP_MEMBER_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_KICK_OUT_GROUP_MEMBER_ERROR=(6000507)ZIM_ERROR_CODE_GROUP_MODULE_INVITE_USER_INTO_GROUP_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_INVITE_USER_INTO_GROUP_ERROR=(6000508)ZIM_ERROR_CODE_GROUP_MODULE_TRANSFER_OWNER_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_TRANSFER_OWNER_ERROR=(6000509)ZIM_ERROR_CODE_GROUP_MODULE_UPDATE_GROUP_INFO_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_UPDATE_GROUP_INFO_ERROR=(6000510)ZIM_ERROR_CODE_GROUP_MODULE_QUERY_GROUP_INFO_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_QUERY_GROUP_INFO_ERROR=(6000511)ZIM_ERROR_CODE_GROUP_MODULE_GROUP_ATTRIBUTES_OPERATION_FAILED
ZIM_ERROR_CODE_GROUP_MODULE_GROUP_ATTRIBUTES_OPERATION_FAILED=(6000512)ZIM_ERROR_CODE_GROUP_MODULE_GROUP_ATTRIBUTES_QUERY_FAILED
ZIM_ERROR_CODE_GROUP_MODULE_GROUP_ATTRIBUTES_QUERY_FAILED=(6000513)ZIM_ERROR_CODE_GROUP_MODULE_UPDATE_GROUP_MEMBER_INFO_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_UPDATE_GROUP_MEMBER_INFO_ERROR=(6000514)ZIM_ERROR_CODE_GROUP_MODULE_QUERY_GROUP_MEMBER_INFO_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_QUERY_GROUP_MEMBER_INFO_ERROR=(6000515)ZIM_ERROR_CODE_GROUP_MODULE_QUERY_GROUP_LIST_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_QUERY_GROUP_LIST_ERROR=(6000516)ZIM_ERROR_CODE_GROUP_MODULE_QUERY_GROUP_MEMBER_LIST_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_QUERY_GROUP_MEMBER_LIST_ERROR=(6000517)ZIM_ERROR_CODE_GROUP_MODULE_USER_IS_NOT_IN_THE_GROUP
ZIM_ERROR_CODE_GROUP_MODULE_USER_IS_NOT_IN_THE_GROUP=(6000521)ZIM_ERROR_CODE_GROUP_MODULE_MEMBER_IS_ALREADY_IN_THE_GROUP
ZIM_ERROR_CODE_GROUP_MODULE_MEMBER_IS_ALREADY_IN_THE_GROUP=(6000522)ZIM_ERROR_CODE_GROUP_MODULE_GROUP_DOES_NOT_EXIST
ZIM_ERROR_CODE_GROUP_MODULE_GROUP_DOES_NOT_EXIST=(6000523)ZIM_ERROR_CODE_GROUP_MODULE_GROUP_ALREADY_EXISTS
ZIM_ERROR_CODE_GROUP_MODULE_GROUP_ALREADY_EXISTS=(6000524)ZIM_ERROR_CODE_GROUP_MODULE_GROUP_MEMBER_HAS_REACHED_LIMIT
ZIM_ERROR_CODE_GROUP_MODULE_GROUP_MEMBER_HAS_REACHED_LIMIT=(6000525)ZIM_ERROR_CODE_GROUP_MODULE_GROUP_ATTRIBUTE_DOES_NOT_EXIST
ZIM_ERROR_CODE_GROUP_MODULE_GROUP_ATTRIBUTE_DOES_NOT_EXIST=(6000526)ZIM_ERROR_CODE_GROUP_MODULE_THE_NUMBER_OF_GROUP_ATTRIBUTES_EXCEEDS_LIMIT
ZIM_ERROR_CODE_GROUP_MODULE_THE_NUMBER_OF_GROUP_ATTRIBUTES_EXCEEDS_LIMIT=(6000531)ZIM_ERROR_CODE_GROUP_MODULE_THE_LENGTH_OF_GROUP_ATTRIBUTE_KEY_EXCEEDS_LIMIT
ZIM_ERROR_CODE_GROUP_MODULE_THE_LENGTH_OF_GROUP_ATTRIBUTE_KEY_EXCEEDS_LIMIT=(6000532)ZIM_ERROR_CODE_GROUP_MODULE_THE_LENGTH_OF_GROUP_ATTRIBUTE_VALUE_EXCEEDS_LIMIT
ZIM_ERROR_CODE_GROUP_MODULE_THE_LENGTH_OF_GROUP_ATTRIBUTE_VALUE_EXCEEDS_LIMIT=(6000533)ZIM_ERROR_CODE_GROUP_MODULE_THE_TOTAL_LENGTH_OF_GROUP_ATTRIBUTE_VALUE_EXCEEDS_LIMIT
ZIM_ERROR_CODE_GROUP_MODULE_THE_TOTAL_LENGTH_OF_GROUP_ATTRIBUTE_VALUE_EXCEEDS_LIMIT=(6000534)ZIM_ERROR_CODE_GROUP_MODULE_NO_CORRESPONDING_OPERATION_AUTHORITY
ZIM_ERROR_CODE_GROUP_MODULE_NO_CORRESPONDING_OPERATION_AUTHORITY=(6000541)ZIM_ERROR_CODE_GROUP_MODULE_GROUP_DATABASE_ERROR
ZIM_ERROR_CODE_GROUP_MODULE_GROUP_DATABASE_ERROR=(6000542)ZIM_ERROR_CODE_CONVERSATION_MODULE_COMMON_ERROR
ZIM_ERROR_CODE_CONVERSATION_MODULE_COMMON_ERROR=(6000601)ZIM_ERROR_CODE_CONVERSATION_MODULE_SERVER_ERROR
ZIM_ERROR_CODE_CONVERSATION_MODULE_SERVER_ERROR=(6000602)ZIM_ERROR_CODE_CONVERSATION_MODULE_CONVERSATION_DOES_NOT_EXIST
ZIM_ERROR_CODE_CONVERSATION_MODULE_CONVERSATION_DOES_NOT_EXIST=(6000603)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_NOT_EXIST
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_NOT_EXIST=(6000211)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_SERVER_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_SERVER_ERROR=(6000212)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_TYPE_UNSUPPORTED
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_TYPE_UNSUPPORTED=(6000213)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_SIZE_INVALID
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_SIZE_INVALID=(6000214)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DURATION_INVALID
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DURATION_INVALID=(6000215)ZIM_ERROR_CODE_MESSAGE_MODULE_AUDIT_REJECTED
ZIM_ERROR_CODE_MESSAGE_MODULE_AUDIT_REJECTED=(6000221)ZIM_ERROR_CODE_MESSAGE_MODULE_AUDIT_FAILED
ZIM_ERROR_CODE_MESSAGE_MODULE_AUDIT_FAILED=(6000222)ZIM_ERROR_CODE_COMMON_MODULE_USER_INFO_QUERIED_LIMIT
ZIM_ERROR_CODE_COMMON_MODULE_USER_INFO_QUERIED_LIMIT=(6000012)ZIM_ERROR_CODE_COMMON_MODULE_UNSUPPORTED_REQUEST
ZIM_ERROR_CODE_COMMON_MODULE_UNSUPPORTED_REQUEST=(6000013)ZIM_ERROR_CODE_ROOM_MODULE_ROOM_MEMBER_ATTRIBUTES_COMMON_ERROR
ZIM_ERROR_CODE_ROOM_MODULE_ROOM_MEMBER_ATTRIBUTES_COMMON_ERROR=(6000350)ZIM_ERROR_CODE_ROOM_MODULE_THE_TOTAL_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_EXCEEDS_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_TOTAL_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_EXCEEDS_LIMIT=(6000351)ZIM_ERROR_CODE_ROOM_MODULE_THE_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_KEY_EXCEEDS_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_KEY_EXCEEDS_LIMIT=(6000352)ZIM_ERROR_CODE_ROOM_MODULE_THE_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_VALUE_EXCEEDS_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_VALUE_EXCEEDS_LIMIT=(6000353)ZIM_ERROR_CODE_ROOM_MODULE_THE_MEMBER_NUMBER_OF_ROOM_MEMBER_ATTRIBUTES_EXCEEDS_LIMIT
ZIM_ERROR_CODE_ROOM_MODULE_THE_MEMBER_NUMBER_OF_ROOM_MEMBER_ATTRIBUTES_EXCEEDS_LIMIT=(6000357)ZIM_ERROR_CODE_MESSAGE_MODULE_RECEIPT_READ_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_RECEIPT_READ_ERROR=(6000277)ZIM_ERROR_CODE_COMMON_MODULE_USER_IS_NOT_EXIST
ZIM_ERROR_CODE_COMMON_MODULE_USER_IS_NOT_EXIST=(6000011)ZIM_ERROR_CODE_MESSAGE_MODULE_MESSAGE_EXCEEDS_REVOKE_TIME
ZIM_ERROR_CODE_MESSAGE_MODULE_MESSAGE_EXCEEDS_REVOKE_TIME=(6000278)ZIM_ERROR_CODE_MESSAGE_MODULE_MESSAGE_HAS_BEEN_REVOKED
ZIM_ERROR_CODE_MESSAGE_MODULE_MESSAGE_HAS_BEEN_REVOKED=(6000279)ZIM_ERROR_CODE_ROOM_MODULE_USER_IS_ALREADY_IN_THE_ROOM
ZIM_ERROR_CODE_ROOM_MODULE_USER_IS_ALREADY_IN_THE_ROOM=(6000320)ZIM_ERROR_CODE_NETWORK_MODULE_REQUEST_TIMEOUT
ZIM_ERROR_CODE_NETWORK_MODULE_REQUEST_TIMEOUT=(6000105)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_PERMISSION_DENIED
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_PERMISSION_DENIED=(6000216)ZIMErrorCodeMessageModuleFileDownloadFailed
ZIMErrorCodeMessageModuleFileDownloadFailed=(6000217)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_LIMIT
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_LIMIT=(6000218)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_URL_NOT_FOUND
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_URL_NOT_FOUND=(6000219)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_HTTP_REQUEST_SERVER_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_HTTP_REQUEST_SERVER_ERROR=(6000220)ZIM_ERROR_CODE_COMMON_MODULE_EXCEED_DAU_LIMIT
ZIM_ERROR_CODE_COMMON_MODULE_EXCEED_DAU_LIMIT =(6000015)ZIM_ERROR_CODE_COMMON_MODULE_EXCEED_MAU_LIMIT
ZIM_ERROR_CODE_COMMON_MODULE_EXCEED_MAU_LIMIT =(6000016)ZIM_ERROR_CODE_ROOM_MODULE_THE_ROOM_IS_CONNECTING
ZIM_ERROR_CODE_ROOM_MODULE_THE_ROOM_IS_CONNECTING=(6000326)Please wait for the return of the room connection result from onRoomStateChanged before attempting to repeatedly createRoom, joinRoom, enterRoom, or perform operations on a room that is currently connecting.
ZIM_ERROR_CODE_MESSAGE_MODULE_MESSAGE_REACTION_TYPE_EXISTED
ZIM_ERROR_CODE_MESSAGE_MODULE_MESSAGE_REACTION_TYPE_EXISTED=(6000280)ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_INVITE_USER_DOES_NOT_EXIST
ZIM_ERROR_CODE_MESSAGE_MODULE_CALL_INVITE_USER_DOES_NOT_EXIST=(6000281)ZIM_ERROR_CODE_MESSAGE_MODULE_MESSAGE_RECEIPT_LIMIT
ZIM_ERROR_CODE_MESSAGE_MODULE_MESSAGE_RECEIPT_LIMIT =(6000282)Call the sendMessageReceiptsRead API to mark more than 10 messages as read at once. Please reduce the number of incoming messages to 10 or less.
ZIM_ERROR_CODE_MESSAGE_MODULE_USER_ALREADY_IN_THE_CALL
ZIM_ERROR_CODE_MESSAGE_MODULE_USER_ALREADY_IN_THE_CALL=(6000283)The device that invokes the callJoin interface is in advanced mode, calling and acting as the main device. No need to handle.
ZIM_ERROR_CODE_GROUP_MODULE_GROUP_WITH_DISMISSED
ZIM_ERROR_CODE_GROUP_MODULE_GROUP_WITH_DISMISSED=(6000527)Please use a different ID to create a group as the one you are using has already been destroyed.
ZIM_ERROR_CODE_MESSAGE_MODULE_THE_CALL_IS_NOT_ADVANCED_MODE_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_THE_CALL_IS_NOT_ADVANCED_MODE_ERROR=(6000284)When calling advanced mode interfaces such as callJoin, callQuit, callEnd, callingInvite, and passing a regular mode call ID, please confirm the callID and its mode.
zim_error_code_network_module_user_id_error
zim_error_code_network_module_user_id_error=(6000124)zim_error_code_message_module_sender_in_blacklist
zim_error_code_message_module_sender_in_blacklist=(6000284)zim_error_code_friend_module_already_add_to_blacklist
zim_error_code_friend_module_already_add_to_blacklist=(6000804 )zim_error_code_friend_module_cannot_add_self_to_blacklist
zim_error_code_friend_module_cannot_add_self_to_blacklist=(6000805 )zim_error_code_friend_module_already_delete_from_blacklist
zim_error_code_friend_module_already_delete_from_blacklist=(6000806)zim_error_code_friend_module_user_not_in_blacklist
zim_error_code_friend_module_user_not_in_blacklist=(6000807)zim_error_code_friend_module_blacklist_list_quantity_limit
zim_error_code_friend_module_blacklist_list_quantity_limit=(6000808)zim_error_code_friend_module_add_blacklist_fail
zim_error_code_friend_module_add_blacklist_fail=(6000815 )zim_error_code_friend_module_del_blacklist_fail
zim_error_code_friend_module_del_blacklist_fail=(6000816)zim_error_code_room_module_room_member_query_failed_completely
zim_error_code_room_module_room_member_query_failed_completely=(6000311)Failed to batch query all room members
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.
ZIMFriendApplicationState
Friend application state.
Declared in ZIMDefines.h
Properties
ZIMFriendApplicationStateWaiting
ZIMFriendApplicationStateWaiting=(1)Awaiting response.
ZIMFriendApplicationStateAccepted
ZIMFriendApplicationStateAccepted=(2)Accepted.
ZIMFriendApplicationStateRejected
ZIMFriendApplicationStateRejected=(3)Rejected.
Expired
Expired=(4)Expired.
Disabled
Disabled=(5)Disabled
ZIMFriendApplicationType
Friend application type.
Declared in ZIMDefines.h
Properties
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)Application initiated by both parties.
ZIMFriendDeleteType
Delete friend type.
Declared in ZIMDefines.h
Properties
Both
Both=(0)Delete in both directions.
Single
Single=(1)One-way deletion.
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.
ZIMFriendRelationCheckType
Check the friend relationship type.
Declared in ZIMDefines.h
Properties
Both
Both=(0)Two-way inspection.
Single
Single=(1)One-way inspection.
ZIMGeofencingType
Geofencing type.
- Use cases: For example, if the specified geofenced area is Europe, the region where the App user resides is not distinguished, and the actual region accessed by the SDK is Europe.
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.
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.
ZIMGroupApplicationState
Group application state.
Declared in ZIMDefines.h
Properties
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
ZIMGroupApplicationType
Group application type.
Declared in ZIMDefines.h
Properties
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_BEINVITE
ZIM_GROUP_APPLICATION_TYPE_BEINVITE=(3)Be invite type.
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 action.
ZIMGroupBeInviteMode
Verification mode for being invited to the group.
Declared in ZIMDefines.h
Properties
ZIM_GROUP_BEINVITE_MODE_NONE
ZIM_GROUP_BEINVITE_MODE_NONE=(0)The invitees enter the group directly.
ZIM_GROUP_BEINVITE_MODE_AUTH
ZIM_GROUP_BEINVITE_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
ZIMGroupEnterTypeUnknown
ZIMGroupEnterTypeUnknown=(0)Unknown.
ZIMGroupEnterTypeCreated
ZIMGroupEnterTypeCreated=(1)Join when creating a group.
ZIMGroupEnterTypeJoinApply
ZIMGroupEnterTypeJoinApply=(2)Join application to the group.
ZIMGroupEnterTypeJoined
ZIMGroupEnterTypeJoined=(3)Join the group.
ZIMGroupEnterTypeInvited
ZIMGroupEnterTypeInvited=(4)Invite to the group.
ZIMGroupEnterTypeInviteApply
ZIMGroupEnterTypeInviteApply=(5)Invite application to the group.
ZIMGroupEvent
Group events.
Details
Group events.
Declared in ZIMDefines.h
Properties
ZIMGroupEventNone
ZIMGroupEventNone=(0)None.
ZIMGroupEventCreated
ZIMGroupEventCreated=(1)Create groups.
ZIMGroupEventDismissed
ZIMGroupEventDismissed=(2)Disband the group.
ZIMGroupEventJoined
ZIMGroupEventJoined=(3)Join the group.
ZIMGroupEventInvited
ZIMGroupEventInvited=(4)Invite to the group.
ZIMGroupEventLeft
ZIMGroupEventLeft=(5)Leave the group.
ZIMGroupEventKickedout
ZIMGroupEventKickedout=(6)Kick out of the group.
ZIMGroupInviteMode
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.
ZIMGroupJoinMode
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.
ZIMGroupMemberEvent
Group member events.
Details
Group member events.
Declared in ZIMDefines.h
Properties
ZIMGroupMemberEventNone
ZIMGroupMemberEventNone=(0)None.
ZIMGroupMemberEventJoin
ZIMGroupMemberEventJoin=(1)Joined.
ZIMGroupMemberEventLeave
ZIMGroupMemberEventLeave=(2)left.
ZIMGroupMemberEventKickout
ZIMGroupMemberEventKickout=(4)kicked_out
ZIMGroupMemberEventInvited
ZIMGroupMemberEventInvited=(5)invited.
ZIMGroupMemberState
group membership status.
Details
group membership status.
Declared in ZIMDefines.h
Properties
ZIMGroupMemberStateQuit
ZIMGroupMemberStateQuit=(0)quit.
ZIMGroupMemberStateEnter
ZIMGroupMemberStateEnter=(1)enter.
ZIMGroupMessageNotificationStatus
Enumeration of group notification status.
Details
Group notification status.
- Use cases: You can determine the notification status of a group by modifying enumeration.
Declared in ZIMDefines.h
Properties
ZIMGroupMessageNotificationStatusNotify
ZIMGroupMessageNotificationStatusNotify=(1)ZIMConversationNotificationStatusDisturb
ZIMConversationNotificationStatusDisturb=(2)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
ZIMGroupState
group status.
Details
group status.
Declared in ZIMDefines.h
Properties
ZIMGroupStateQuit
ZIMGroupStateQuit=(0)quit.
ZIMGroupStateEnter
ZIMGroupStateEnter=(1)enter.
ZIMMediaFileType
Media file type
Details
he types of media files that are allowed to be downloaded include original images, large images, thumbnails, general files, audio files, video files and their first frame images.
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
Describes whether the current message was sent or received.
Declared in ZIMDefines.h
Properties
ZIMMessageDirectionSend
ZIMMessageDirectionSend=(0)Message has been sent.
ZIM_MESSAGE_DIRECTION_RECEIVE
ZIM_MESSAGE_DIRECTION_RECEIVE=(1)Message accepted.
ZIMMessageMentionedType
The type of the revoke message.
Details
Identifies the type of current revoke message.
- Use cases: It can be used to determine what type of revoke message this message is.
Declared in ZIMDefines.h
Properties
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
ZIMMessageOrder
Message order.
Details
Used to represent the order of the message list.
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).
ZIMMessagePinStatus
Enumeration of message pinned status.
Details
Message pinned status.
- Use cases: You can determine the pinned status of a message by enumeration.
Declared in ZIMDefines.h
Properties
ZIM_MESSAGE_PIN_STATUS_NOT_PINNED
ZIM_MESSAGE_PIN_STATUS_NOT_PINNED=(0)ZIM_MESSAGE_PIN_STATUS_PINNED
ZIM_MESSAGE_PIN_STATUS_PINNED=(1)ZIM_MESSAGE_PIN_STATUS_UPDATED
ZIM_MESSAGE_PIN_STATUS_UPDATED=(2)ZIMMessagePriority
The priority of the message.
Details
Identifies the priority of a message.
- Use cases: It can be used to set the priority when a message is sent. The higher the priority, the higher the reliability. Low priority may be discarded due to weak network.
Declared in ZIMDefines.h
Properties
ZIMMessagePriorityLow
ZIMMessagePriorityLow=(1)Low priority.
- Use cases: Generally used to send unimportant messages such as barrage message in a room.
ZIMMessagePriorityMedium
ZIMMessagePriorityMedium=(2)Medium priority.
- Use cases: Generally used to send regular chat messages.
ZIMMessagePriorityHigh
ZIMMessagePriorityHigh=(3)High priority.
- Use cases: Generally used to send important information such as gifts and rewards in a room.
ZIMMessageReceiptStatus
Details
The status of the receipt
Declared in ZIMDefines.h
Properties
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.
ZIMMessageRepliedInfoState
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 state.
ZIMMessageRevokeStatus
Message revoke status
Details
Identifies the status of current revoke message.
Declared in ZIMDefines.h
Properties
UNKNOWN
UNKNOWN=(-1)Unknown status.
SELF_REVOKE
SELF_REVOKE=(0)Self revoke.
SYSTEM_REVOKE
SYSTEM_REVOKE=(1)System revoke.
API_REVOKE
API_REVOKE=(2)Service API revoke.
ADMIN_REVOKE
ADMIN_REVOKE=(3)Group admin revoke.
GROUP_OWNER_REVOKE
GROUP_OWNER_REVOKE=(4)group owner revoke.
ZIM_MESSAGE_REVOKE_STATUS_AUDIT_REJECT_REVOKE
ZIM_MESSAGE_REVOKE_STATUS_AUDIT_REJECT_REVOKE=(6)Revoked for audit reject.
ZIMMessageSentStatus
The status of the message being sent.
Details
Describes the condition of the currently sent message.
Declared in ZIMDefines.h
Properties
ZIMMessageSentStatusSending
ZIMMessageSentStatusSending=(0)The message is being sent.
ZIMMessageSentStatusSendSuccess
ZIMMessageSentStatusSendSuccess=(1)Message sent successfully.
ZIMMessageSentStatusSendFailed
ZIMMessageSentStatusSendFailed=(2)Message sending failed.
ZIMMessageType
The type of the message.
Details
Identifies the type of current message.
- Use cases: It can be used to determine what type of message this message is.
Declared in ZIMDefines.h
Properties
ZIM_MESSAGE_TYPE_TEXT
ZIM_MESSAGE_TYPE_TEXT=(1)Normal text message.
- Use cases: Can be used to deliver ordinary text messages.
ZIM_MESSAGE_TYPE_COMMAND
ZIM_MESSAGE_TYPE_COMMAND=(2)Custom binary message.
- Use cases: Can be used to transfer custom binary messages. This message type does not support offline messages and local storage.
ZIM_MESSAGE_TYPE_UNKNOWN
ZIM_MESSAGE_TYPE_UNKNOWN=(0)Unknown message.
- Use cases: A message of an unknown type is received, indicating that the sender may have sent a message type that the user does not support, and the user needs to be advised to update the version.
ZIM_MESSAGE_TYPE_BARRAGE
ZIM_MESSAGE_TYPE_BARRAGE=(20)Barrage message.
- Use cases: Can be used for the barrage sent by the live room. This message type does not support offline messages and local storage.
ZIM_MESSAGE_TYPE_IMAGE
ZIM_MESSAGE_TYPE_IMAGE=(11)Image message.
- Use cases: Can be used to send image messages, only ".jpg", ".jpeg", ".png", ".bmp", ".gif", ".tiff" image types are supported. After sending the image, the server will generate a large image and a thumbnail of the original image.
ZIM_MESSAGE_TYPE_FILE
ZIM_MESSAGE_TYPE_FILE=(12)File message.
- Use cases: For sending file messages, no file type restrictions.
ZIM_MESSAGE_TYPE_AUDIO
ZIM_MESSAGE_TYPE_AUDIO=(13)Audio message.
- Use cases: For sending audio messages, only ".mp3" audio type is supported.
ZIM_MESSAGE_TYPE_VIDEO
ZIM_MESSAGE_TYPE_VIDEO=(14)Video message.
- Use cases: For sending video messages, only ".mp4", ".mov" video types are supported. After sending the video message, the server will generate the first frame of the video file.
ZIM_MESSAGE_TYPE_SYSTEM
ZIM_MESSAGE_TYPE_SYSTEM=(30)Systemmessage.
- Use cases: It is often used for local messages that need to be customized in the business layer, and is usually used to insert local message interfaces.
ZIM_MESSAGE_TYPE_REVOKE
ZIM_MESSAGE_TYPE_REVOKE=(31)Reovked message.
ZIM_MESSAGE_TYPE_COMBINE
ZIM_MESSAGE_TYPE_COMBINE=(100)Combined message.
ZIM_MESSAGE_TYPE_CUSTOM
ZIM_MESSAGE_TYPE_CUSTOM=(200)Custom message.
ZIM_MESSAGE_TYPE_TIPS
ZIM_MESSAGE_TYPE_TIPS=(32)Tips 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.
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_IPHONE_OS
ZIM_PLATFORM_TYPE_IPHONE_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_IPAD_OS
ZIM_PLATFORM_TYPE_IPAD_OS=(9)iPad.
ZIM_PLATFORM_TYPE_UNKNOWN
ZIM_PLATFORM_TYPE_UNKNOWN=(32)Platforms not mentioned above.
ZIMRevokeType
The type of the revoke message.
Details
Identifies the type of current revoke message.
- Use cases: It can be used to determine what type of revoke message this message is.
Declared in ZIMDefines.h
Properties
TWO_WAY
TWO_WAY=(1)two way revoke.
ONE_WAY
ONE_WAY=(2)one way revoke.
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 action.
ZIMRoomEvent
The event that caused the room connection status to change.
Details
The reason for the change of the connection state.
- Use cases: It can be used to determine whether the login/logout is successful, and to handle abnormal situations such as network disconnection.
- Caution: Please use it with the connection state parameter.
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_CONNNECT_TIMEOUT
ZIM_ROOM_EVENT_CONNNECT_TIMEOUT=(9)connect timeout.
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
Details
Used to indicate the user's connection status to the room.
- Caution: Please use with ZIMRoomEvent parameter.
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.
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_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)Group member mute info change event.
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.
ZIMTipsMessageEvent
Event of tips message.
Details
Used to identify the event corresponding to the tips message, customers can read different fields through different enumerations.
Declared in ZIMDefines.h
Properties
ZIM_TIPS_MESSAGE_EVENT_GROUP_CREATED
ZIM_TIPS_MESSAGE_EVENT_GROUP_CREATED=(1)ZIM_TIPS_MESSAGE_EVENT_GROUP_DISMISSED
ZIM_TIPS_MESSAGE_EVENT_GROUP_DISMISSED=(2)ZIM_TIPS_MESSAGE_EVENT_GROUP_JOINED
ZIM_TIPS_MESSAGE_EVENT_GROUP_JOINED=(3)ZIM_TIPS_MESSAGE_EVENT_GROUP_INVITED
ZIM_TIPS_MESSAGE_EVENT_GROUP_INVITED=(4)ZIM_TIPS_MESSAGE_EVENT_GROUP_LEFT
ZIM_TIPS_MESSAGE_EVENT_GROUP_LEFT=(5)ZIM_TIPS_MESSAGE_EVENT_GROUP_KICKED_OUT
ZIM_TIPS_MESSAGE_EVENT_GROUP_KICKED_OUT=(6)ZIM_TIPS_MESSAGE_EVENT_GROUP_INFO_CHANGED
ZIM_TIPS_MESSAGE_EVENT_GROUP_INFO_CHANGED=(7)ZIM_TIPS_MESSAGE_EVENT_GROUP_MEMBER_INFO_CHANGED
ZIM_TIPS_MESSAGE_EVENT_GROUP_MEMBER_INFO_CHANGED=(8)ZIM_TIPS_MESSAGE_EVENT_GROUP_MESSAGE_PINNED
ZIM_TIPS_MESSAGE_EVENT_GROUP_MESSAGE_PINNED=(9)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.
ZIMUserRelationType
Friend relationship type.
Declared in ZIMDefines.h
Properties
SingleNo
SingleNo=(1)There is no B in A's friend list, but it is impossible to determine whether A is in B's friend list.
SingleHave
SingleHave=(2)A has B in its friend list, but it cannot be determined whether B has A in its friend list.
BothAllNo
BothAllNo=(3)There is no B in A's friend list, and there is no A in B's friend list.
BothSelfHave
BothSelfHave=(4)A has B in its friend list, but B does not have A in its friend list.
BothOtherHave
BothOtherHave=(5)A does not have B in his friend list, but B has A in his friend list.
BothAllHave
BothAllHave=(6)A's friend list contains B, and B's friend list also contains A.