Enum

2026-01-23


ZIMAudioANSMode	ZIMAudioRouteType
ZIMBlacklistChangeAction	ZIMCallInvitationMode
ZIMCallState	ZIMCallUserState
ZIMConnectionEvent	ZIMConnectionState
ZIMConversationEvent	ZIMConversationNotificationStatus
ZIMConversationSyncState	ZIMConversationType
ZIMCXHandleType	ZIMErrorCode
ZIMFriendApplicationListChangeAction	ZIMFriendApplicationState
ZIMFriendApplicationType	ZIMFriendDeleteType
ZIMFriendListChangeAction	ZIMFriendRelationCheckType
ZIMGeofencingType	ZIMGroupApplicationListChangeAction
ZIMGroupApplicationState	ZIMGroupApplicationType
ZIMGroupAttributesUpdateAction	ZIMGroupBeInviteMode
ZIMGroupEnterType	ZIMGroupEvent
ZIMGroupInviteMode	ZIMGroupJoinMode
ZIMGroupMemberEvent	ZIMGroupMemberState
ZIMGroupMessageNotificationStatus	ZIMGroupMuteMode
ZIMGroupState	ZIMMediaFileType
ZIMMessageDirection	ZIMMessageMentionedType
ZIMMessageOrder	ZIMMessagePinStatus
ZIMMessagePriority	ZIMMessageReceiptStatus
ZIMMessageRepliedInfoState	ZIMMessageRevokeStatus
ZIMMessageSentStatus	ZIMMessageType
ZIMPlatformType	ZIMRevokeType
ZIMRoomAttributesUpdateAction	ZIMRoomEvent
ZIMRoomState	ZIMTipsMessageChangeInfoType
ZIMTipsMessageEvent	ZIMUserOnlineStatus
ZIMUserRelationType

ZIMAudioANSMode

Active Noise Suppression mode.

Declared in ZIMAudioDefines.h

Properties

ZIMAudioANSModeSoft

ZIMAudioANSModeSoft=(0)

Soft ANS. In most instances, the sound quality will not be damaged, but some noise will remain.

ZIMAudioANSModeMedium

ZIMAudioANSModeMedium=(1)

Medium ANS. It may damage some sound quality, but it has a good noise reduction effect.

ZIMAudioANSModeAggressive

ZIMAudioANSModeAggressive=(2)

Aggressive ANS. It may significantly impair the sound quality, but it has a good noise reduction effect.

ZIMAudioANSModeAI

ZIMAudioANSModeAI=(3)

AI mode ANS. It will cause great damage to music, so it can not be used for noise suppression of sound sources that need to collect background sound. Please contact ZEGO technical support before use.

ZIMAudioANSModeAIBalanced

ZIMAudioANSModeAIBalanced=(4)

Balanced AI mode ANS. It will cause great damage to music, so it can not be used for noise suppression of sound sources that need to collect background sound. Please contact ZEGO technical support before use.

ZIMAudioRouteType

The audio route type.

Declared in ZIMAudioDefines.h

Properties

ZIMAudioRouteTypeSpeaker

ZIMAudioRouteTypeSpeaker=(0)

The speaker.

ZIMAudioRouteTypeReceiver

ZIMAudioRouteTypeReceiver=(1)

The receiver.

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.

Declared in ZIMDefines.h

Properties

CXHandleTypePhoneNumber

CXHandleTypePhoneNumber=(2)

A phone number.

CXHandleTypeEmailAddress

CXHandleTypeEmailAddress=(3)

An email address.

CXHandleTypeGeneric

CXHandleTypeGeneric=(1)

An unspecified type of handle.

ZIMCallInvitationMode

Call invitation mode.

Details

Call invitation mode.

Declared in ZIMDefines.h

Properties

ZIMCallInvitationModeGeneral

ZIMCallInvitationModeGeneral=(0)

general.

ZIMCallInvitationModeAdvanced

ZIMCallInvitationModeAdvanced=(1)

advanced

ZIMCallInvitationModeUnknown

ZIMCallInvitationModeUnknown=(-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

ZIMCallUserStateInviting

ZIMCallUserStateInviting=(0)

inviting.

ZIMCallUserStateAccepted

ZIMCallUserStateAccepted=(1)

accepted.

ZIMCallUserStateRejected

ZIMCallUserStateRejected=(2)

rejected.

ZIMCallUserStateCancelled

ZIMCallUserStateCancelled=(3)

cancelled.

ZIMCallUserStateOffline

deprecated

ZIMCallUserStateOffline=(4)

offline.

Deprecated

The offline enumeration value has been discarded in ZIM 2.9.0 and later versions.

ZIMCallUserStateReceived

ZIMCallUserStateReceived=(5)

received.

ZIMCallUserStateTimeout

ZIMCallUserStateTimeout=(6)

timeout.

ZIMCallUserStateQuit

ZIMCallUserStateQuit=(7)

quit.

ZIMCallUserStateUnknown

ZIMCallUserStateUnknown=(-1)

unknown

ZIMCallUserStateEnded

ZIMCallUserStateEnded=(8)

ended.

ZIMCallUserStateNotYetReceived

ZIMCallUserStateNotYetReceived=(9)

Not received.

ZIMCallUserStateBeCancelled

ZIMCallUserStateBeCancelled=(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

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.

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

ZIMConnectionStateDisconnected

ZIMConnectionStateDisconnected=(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.

ZIMConnectionStateConnecting

ZIMConnectionStateConnecting=(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.

ZIMConnectionStateConnected

ZIMConnectionStateConnected=(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.

ZIMConnectionStateReconnecting

ZIMConnectionStateReconnecting=(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

ZIMConversationEventAdded

ZIMConversationEventAdded=(0)

ZIMConversationEventUpdated

ZIMConversationEventUpdated=(1)

ZIMConversationEventDisabled

ZIMConversationEventDisabled=(2)

ZIMConversationEventDeleted

ZIMConversationEventDeleted=(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

ZIMConversationSyncStateStarted

ZIMConversationSyncStateStarted=(0)

Starting conversation list synchronization from server.

ZIMConversationSyncStateFinished

ZIMConversationSyncStateFinished=(1)

Finished conversation list synchronization from server.

ZIMConversationSyncStateFailed

ZIMConversationSyncStateFailed=(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.

Unknown

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

ZIMErrorCodeSuccess

ZIMErrorCodeSuccess=(0)

Success without exception.

Use cases: Used to indicate that the operation is executed correctly.

ZIMErrorCodeFailed

ZIMErrorCodeFailed=(1)

Failed, the guarantee is wrong.

Use cases: Used in the operation guarantee strategy.

ZIMErrorCodeParamInvalid

ZIMErrorCodeParamInvalid=(6000001)

The incoming parameter is invalid.

Use case: Used to protect the bottom strategy when the interface call fails due to incorrect parameters.

ZIMErrorCodeNoInit

ZIMErrorCodeNoInit=(6000002)

The SDK is not initialized.

Use case: Used for error return when the ZIM SDK is not initialized successfully.

ZIMErrorCodeCommonModuleInvalidAppID

ZIMErrorCodeCommonModuleInvalidAppID=(6000003)

Invalid AppID.

Use case: Used for error return of failure due to invalid AppID.

ZIMErrorCodeCommonModuleTriggerSDKFrequencyLimit

ZIMErrorCodeCommonModuleTriggerSDKFrequencyLimit=(6000004)

Trigger SDK internal frequency limit.

ZIMErrorCodeCommonModuleTriggerServerFrequencyLimit

ZIMErrorCodeCommonModuleTriggerServerFrequencyLimit=(600005)

Trigger background service frequency limit.

ZIMErrorCodeCommonModuleSwitchServerError

ZIMErrorCodeCommonModuleSwitchServerError=(6000006)

The Switch server reported an error.

ZIMErrorCodeCommonModuleIMServerError

ZIMErrorCodeCommonModuleIMServerError=(6000007)

ZIM service internal error.

ZIMErrorCodeCommonModuleIMDataBaseError

ZIMErrorCodeCommonModuleIMDataBaseError=(6000008)

ZIM internal database error.

ZIMErrorCodeCommonModuleIMServerDisconnect

ZIMErrorCodeCommonModuleIMServerDisconnect=(6000009)

Disconnected while sending request.

ZIMErrorCodeCommonModuleUploadLogError

ZIMErrorCodeCommonModuleUploadLogError=(6000010)

Failed to upload log.

ZIMErrorCodeNetworkModuleCommonError

ZIMErrorCodeNetworkModuleCommonError=(6000101)

ZIMErrorCodeNetworkModuleServerError

ZIMErrorCodeNetworkModuleServerError=(6000102)

ZIMErrorCodeNetworkModuleTokenInvalid

ZIMErrorCodeNetworkModuleTokenInvalid=(6000103)

Token is invalid.

ZIMErrorCodeNetworkModuleNetworkError

ZIMErrorCodeNetworkModuleNetworkError=(6000104)

Network error.

ZIMErrorCodeNetworkModuleTokenExpired

ZIMErrorCodeNetworkModuleTokenExpired=(6000106)

Token expired.

ZIMErrorCodeNetworkModuleTokenVersionError

ZIMErrorCodeNetworkModuleTokenVersionError=(6000107)

Token version number is wrong.

ZIMErrorCodeNetworkModuleTokenTimeIsTooShort

ZIMErrorCodeNetworkModuleTokenTimeIsTooShort=(6000108)

Token duration is too short.

ZIMErrorCodeNetworkModuleUserHasAlreadyLogged

ZIMErrorCodeNetworkModuleUserHasAlreadyLogged=(6000111)

Logging in to multiple accounts on the current device.

ZIMErrorCodeNetworkModuleUserIsNotLogged

ZIMErrorCodeNetworkModuleUserIsNotLogged=(6000121)

User is not logged.

ZIMErrorCodeMessageModuleCommonError

ZIMErrorCodeMessageModuleCommonError=(6000201)

Internal error sending message.

ZIMErrorCodeMessageModuleServerError

ZIMErrorCodeMessageModuleServerError=(6000202)

Error sending message background service.

ZIMErrorCodeSendMessageFailed

ZIMErrorCodeSendMessageFailed=(6000203)

Message sending failed.

ZIMErrorCodeMessageModuleTargetDoseNotExist

ZIMErrorCodeMessageModuleTargetDoseNotExist=(6000204)

The message target does not exist.

ZIMErrorCodeMessageModuleCallError

ZIMErrorCodeMessageModuleCallError=(6000270)

ZIMErrorCodeMessageModuleCancelCallError

ZIMErrorCodeMessageModuleCancelCallError=(6000271)

ZIMErrorCodeMessageModuleCallServerError

ZIMErrorCodeMessageModuleCallServerError=(6000272)

ZIMErrorCodeMessageModuleIsNotInvitor

ZIMErrorCodeMessageModuleIsNotInvitor=(6000273)

ZIMErrorCodeMessageModuleIsNotInvitee

ZIMErrorCodeMessageModuleIsNotInvitee=(6000274)

ZIMErrorCodeMessageModuleCallAlreadyExists

ZIMErrorCodeMessageModuleCallAlreadyExists=(6000275)

ZIMErrorCodeMessageModuleCallDoseNotExist

ZIMErrorCodeMessageModuleCallDoseNotExist=(6000276)

ZIMErrorCodeRoomModuleCommonError

ZIMErrorCodeRoomModuleCommonError=(6000301)

ZIMErrorCodeRoomModuleServerError

ZIMErrorCodeRoomModuleServerError=(6000302)

ZIMErrorCodeRoomModuleCreateRoomError

ZIMErrorCodeRoomModuleCreateRoomError=(6000303)

ZIMErrorCodeRoomModuleJoinRoomError

ZIMErrorCodeRoomModuleJoinRoomError=(6000304)

ZIMErrorCodeRoomModuleLeaveRoomError

ZIMErrorCodeRoomModuleLeaveRoomError=(6000306)

ZIMErrorCodeRoomModuleUserIsNotInTheRoom

ZIMErrorCodeRoomModuleUserIsNotInTheRoom=(6000321)

ZIMErrorCodeRoomModuleTheRoomDoseNotExist

ZIMErrorCodeRoomModuleTheRoomDoseNotExist=(6000322)

ZIMErrorCodeRoomModuleTheRoomAlreadyExists

ZIMErrorCodeRoomModuleTheRoomAlreadyExists=(6000323)

ZIMErrorCodeRoomModuleTheNumberOfExistingRoomsHasReachedLimit

ZIMErrorCodeRoomModuleTheNumberOfExistingRoomsHasReachedLimit=(6000324)

ZIMErrorCodeRoomModuleTheNumberOfJoinedRoomsHasReachedLimit

ZIMErrorCodeRoomModuleTheNumberOfJoinedRoomsHasReachedLimit=(6000325)

ZIMErrorCodeRoomModuleRoomAttributesCommonError

ZIMErrorCodeRoomModuleRoomAttributesCommonError=(6000330)

ZIMErrorCodeRoomModuleRoomAttributesOperationFailedCompletely

ZIMErrorCodeRoomModuleRoomAttributesOperationFailedCompletely=(6000331)

ZIMErrorCodeRoomModuleRoomAttributesOperationFailedPartly

ZIMErrorCodeRoomModuleRoomAttributesOperationFailedPartly=(6000332)

ZIMErrorCodeRoomModuleRoomAttributesQueryFailed

ZIMErrorCodeRoomModuleRoomAttributesQueryFailed=(6000333)

ZIMErrorCodeRoomModuleTheNumberOfRoomAttributesExceedsLimit

ZIMErrorCodeRoomModuleTheNumberOfRoomAttributesExceedsLimit=(6000334)

ZIMErrorCodeRoomModuleTheLengthOfRoomAttributeKeyExceedsLimit

ZIMErrorCodeRoomModuleTheLengthOfRoomAttributeKeyExceedsLimit=(6000335)

ZIMErrorCodeRoomModuleTheLengthOfRoomAttributeValueExceedsLimit

ZIMErrorCodeRoomModuleTheLengthOfRoomAttributeValueExceedsLimit=(6000336)

ZIMErrorCodeRoomModuleTheTotalLengthOfRoomAttributesValueExceedsLimit

ZIMErrorCodeRoomModuleTheTotalLengthOfRoomAttributesValueExceedsLimit=(6000337)

ZIMErrorCodeZPNSModulePushIDInvalid

ZIMErrorCodeZPNSModulePushIDInvalid=(6000401)

ZIMErrorCodeGroupModuleCommonError

ZIMErrorCodeGroupModuleCommonError=(6000501)

ZIMErrorCodeGroupModuleServerError

ZIMErrorCodeGroupModuleServerError=(6000502)

ZIMErrorCodeGroupModuleCreateGroupError

ZIMErrorCodeGroupModuleCreateGroupError=(6000503)

ZIMErrorCodeGroupModuleDismissGroupError

ZIMErrorCodeGroupModuleDismissGroupError=(6000504)

ZIMErrorCodeGroupModuleJoinGroupError

ZIMErrorCodeGroupModuleJoinGroupError=(6000505)

ZIMErrorCodeGroupModuleLeaveGroupError

ZIMErrorCodeGroupModuleLeaveGroupError=(6000506)

ZIMErrorCodeGroupModuleKickoutGroupMemberError

ZIMErrorCodeGroupModuleKickoutGroupMemberError=(6000507)

ZIMErrorCodeGroupModuleInviteUserIntoGroupError

ZIMErrorCodeGroupModuleInviteUserIntoGroupError=(6000508)

ZIMErrorCodeGroupModuleTransferOwnerError

ZIMErrorCodeGroupModuleTransferOwnerError=(6000509)

ZIMErrorCodeGroupModuleUpdateGroupInfoError

ZIMErrorCodeGroupModuleUpdateGroupInfoError=(6000510)

ZIMErrorCodeGroupModuleQueryGroupInfoError

ZIMErrorCodeGroupModuleQueryGroupInfoError=(6000511)

ZIMErrorCodeGroupModuleGroupAttributesOperationFailed

ZIMErrorCodeGroupModuleGroupAttributesOperationFailed=(6000512)

ZIMErrorCodeGroupModuleGroupAttributesQueryFailed

ZIMErrorCodeGroupModuleGroupAttributesQueryFailed=(6000513)

ZIMErrorCodeGroupModuleUpdateGroupMemberInfoError

ZIMErrorCodeGroupModuleUpdateGroupMemberInfoError=(6000514)

ZIMErrorCodeGroupModuleQueryGroupMemberInfoError

ZIMErrorCodeGroupModuleQueryGroupMemberInfoError=(6000515)

ZIMErrorCodeGroupModuleQueryGroupListError

ZIMErrorCodeGroupModuleQueryGroupListError=(6000516)

ZIMErrorCodeGroupModuleQueryGroupMemberListError

ZIMErrorCodeGroupModuleQueryGroupMemberListError=(6000517)

ZIMErrorCodeGroupModuleUserIsNotInTheGroup

ZIMErrorCodeGroupModuleUserIsNotInTheGroup=(6000521)

ZIMErrorCodeGroupModuleMemberIsAlreadyInTheGroup

ZIMErrorCodeGroupModuleMemberIsAlreadyInTheGroup=(6000522)

ZIMErrorCodeGroupModuleGroupDoseNotExist

ZIMErrorCodeGroupModuleGroupDoseNotExist=(6000523)

ZIMErrorCodeGroupModuleGroupAlreadyExists

ZIMErrorCodeGroupModuleGroupAlreadyExists=(6000524)

ZIMErrorCodeGroupModuleGroupMemberHasReachedLimit

ZIMErrorCodeGroupModuleGroupMemberHasReachedLimit=(6000525)

ZIMErrorCodeGroupModuleGroupAttributeDoseNotExist

ZIMErrorCodeGroupModuleGroupAttributeDoseNotExist=(6000526)

ZIMErrorCodeGroupModuleTheNumberOfGroupAttributesExceedsLimit

ZIMErrorCodeGroupModuleTheNumberOfGroupAttributesExceedsLimit=(6000531)

ZIMErrorCodeGroupModuleTheLengthOfGroupAttributeKeyExceedsLimit

ZIMErrorCodeGroupModuleTheLengthOfGroupAttributeKeyExceedsLimit=(6000532)

ZIMErrorCodeGroupModuleTheLengthOfGroupAttributeValueExceedsLimit

ZIMErrorCodeGroupModuleTheLengthOfGroupAttributeValueExceedsLimit=(6000533)

ZIMErrorCodeGroupModuleTheTotalLengthOfGroupAttributeValueExceedsLimit

ZIMErrorCodeGroupModuleTheTotalLengthOfGroupAttributeValueExceedsLimit=(6000534)

ZIMErrorCodeGroupModuleNoCorrespondingOperationAuthority

ZIMErrorCodeGroupModuleNoCorrespondingOperationAuthority=(6000541)

ZIMErrorCodeGroupModuleGroupDataBaseError

ZIMErrorCodeGroupModuleGroupDataBaseError=(6000542)

ZIMErrorCodeConversationModuleCommonError

ZIMErrorCodeConversationModuleCommonError=(6000601)

ZIMErrorCodeConversationModuleServerError

ZIMErrorCodeConversationModuleServerError=(6000602)

ZIMErrorCodeConversationModuleConversationDoseNotExist

ZIMErrorCodeConversationModuleConversationDoseNotExist=(6000603)

ZIMErrorCodeMessageModuleFileNotExist

ZIMErrorCodeMessageModuleFileNotExist=(6000211)

ZIMErrorCodeMessageModuleFileServerError

ZIMErrorCodeMessageModuleFileServerError=(6000212)

ZIMErrorCodeMessageModuleFileTypeUnsupported

ZIMErrorCodeMessageModuleFileTypeUnsupported=(6000213)

ZIMErrorCodeMessageModuleFileSizeInvalid

ZIMErrorCodeMessageModuleFileSizeInvalid=(6000214)

ZIMErrorCodeMessageModuleFileDurationInvalid

ZIMErrorCodeMessageModuleFileDurationInvalid=(6000215)

ZIMErrorCodeMessageModuleAuditRejected

ZIMErrorCodeMessageModuleAuditRejected=(6000221)

ZIMErrorCodeMessageModuleAuditFailed

ZIMErrorCodeMessageModuleAuditFailed=(6000222)

ZIMErrorCodeCommonModuleUserInfoQueriedLimit

ZIMErrorCodeCommonModuleUserInfoQueriedLimit=(6000012)

ZIMErrorCodeCommonModuleUnsupportedRequest

ZIMErrorCodeCommonModuleUnsupportedRequest=(6000013)

ZIMErrorCodeRoomModuleRoomMemberAttributesCommonError

ZIMErrorCodeRoomModuleRoomMemberAttributesCommonError=(6000350)

ZIMErrorCodeRoomModuleTheTotalLengthOfRoomMemberAttributesExceedsLimit

ZIMErrorCodeRoomModuleTheTotalLengthOfRoomMemberAttributesExceedsLimit=(6000351)

ZIMErrorCodeRoomModuleTheLengthOfRoomMemberAttributesKeyExceedsLimit

ZIMErrorCodeRoomModuleTheLengthOfRoomMemberAttributesKeyExceedsLimit=(6000352)

ZIMErrorCodeRoomModuleTheLengthOfRoomMemberAttributesValueExceedsLimit

ZIMErrorCodeRoomModuleTheLengthOfRoomMemberAttributesValueExceedsLimit=(6000353)

ZIMErrorCodeRoomModuleTheMemberNumberOfRoomMemberAttributesExceedsLimit

ZIMErrorCodeRoomModuleTheMemberNumberOfRoomMemberAttributesExceedsLimit=(6000357)

ZIMErrorCodeMessageModuleReceiptReadError

ZIMErrorCodeMessageModuleReceiptReadError=(6000277)

ZIMErrorCodeCommonModuleUserIsNotExist

ZIMErrorCodeCommonModuleUserIsNotExist=(6000011)

ZIMErrorCodeMessageModuleMessageExceedsRevokeTime

ZIMErrorCodeMessageModuleMessageExceedsRevokeTime=(6000278)

ZIMErrorCodeMessageModuleMessageHasBeenRevoked

ZIMErrorCodeMessageModuleMessageHasBeenRevoked=(6000279)

ZIMErrorCodeRoomModuleUserIsAlreadyInTheRoom

ZIMErrorCodeRoomModuleUserIsAlreadyInTheRoom=(6000320)

ZIMErrorCodeNetworkModuleRequestTimeout

ZIMErrorCodeNetworkModuleRequestTimeout=(6000105)

ZIMErrorCodeMessageModuleFilePermissionDenied

ZIMErrorCodeMessageModuleFilePermissionDenied=(6000216)

ZIMErrorCodeMessageModuleFileDownloadFailed

ZIMErrorCodeMessageModuleFileDownloadFailed=(6000217)

ZIMErrorCodeMessageModuleFileDownloadLimit

ZIMErrorCodeMessageModuleFileDownloadLimit=(6000218)

ZIMErrorCodeMessageModuleFileDownloadUrlNotFound

ZIMErrorCodeMessageModuleFileDownloadUrlNotFound=(6000219)

ZIMErrorCodeMessageModuleFileDownloadHttpRequestServerError

ZIMErrorCodeMessageModuleFileDownloadHttpRequestServerError=(6000220)

ZIMErrorCodeCommonModuleExceedDAULimit

ZIMErrorCodeCommonModuleExceedDAULimit=(6000015)

ZIMErrorCodeCommonModuleExceedMAULimit

ZIMErrorCodeCommonModuleExceedMAULimit=(6000016)

ZIMErrorCodeRoomModuleTheRoomIsConnecting

ZIMErrorCodeRoomModuleTheRoomIsConnecting=(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.

ZIMErrorCodeMessageModuleMessageReactionTypeExisted

ZIMErrorCodeMessageModuleMessageReactionTypeExisted=(6000280)

ZIMErrorCodeMessageModuleCallInviteUserDoesNotExist

ZIMErrorCodeMessageModuleCallInviteUserDoesNotExist=(6000281)

ZIMErrorCodeMessageModuleMessageReceiptLimit

ZIMErrorCodeMessageModuleMessageReceiptLimit=(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.

ZIMErrorCodeMessageModuleUserAlreadyInTheCall

ZIMErrorCodeMessageModuleUserAlreadyInTheCall=(6000283)

The device that invokes the callJoin interface is in advanced mode, calling and acting as the main device. No need to handle.

ZIMErrorCodeGroupModuleGroupWithDismissed

ZIMErrorCodeGroupModuleGroupWithDismissed=(6000527)

Please use a different ID to create a group as the one you are using has already been destroyed.

ZIMErrorCodeMessageModuleTheCallIsNotAdvancedModeError

ZIMErrorCodeMessageModuleTheCallIsNotAdvancedModeError=(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

ZIMFriendApplicationListChangeActionAdded

ZIMFriendApplicationListChangeActionAdded=(0)

Add action.

ZIMFriendApplicationListChangeActionDeleted

ZIMFriendApplicationListChangeActionDeleted=(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

ZIMFriendApplicationTypeNone

ZIMFriendApplicationTypeNone=(0)

Friend application type none.

ZIMFriendApplicationTypeReceived

ZIMFriendApplicationTypeReceived=(1)

Applications received.

ZIMFriendApplicationTypeSent

ZIMFriendApplicationTypeSent=(2)

Application sent.

Both

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

ZIMFriendListChangeActionAdded

ZIMFriendListChangeActionAdded=(0)

Add action.

ZIMFriendListChangeActionDeleted

ZIMFriendListChangeActionDeleted=(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

ZIMGeofencingTypeNone

ZIMGeofencingTypeNone=(0)

The default type.

ZIMGeofencingTypeInclude

ZIMGeofencingTypeInclude=(1)

Federated mode.

ZIMGeofencingTypeExclude

ZIMGeofencingTypeExclude=(2)

Exclusion mode.

ZIMGroupApplicationListChangeAction

Group application list update action.

Details

group application list update action.

Declared in ZIMDefines.h

Properties

ZIMGroupApplicationListChangeActionAdded

ZIMGroupApplicationListChangeActionAdded=(0)

Add action.

ZIMGroupApplicationState

Group application state.

Declared in ZIMDefines.h

Properties

ZIMGroupApplicationStateWaiting

ZIMGroupApplicationStateWaiting=(1)

Awaiting response.

ZIMGroupApplicationStateAccepted

ZIMGroupApplicationStateAccepted=(2)

Accepted.

ZIMGroupApplicationStateRejected

ZIMGroupApplicationStateRejected=(3)

Rejected.

ZIMGroupApplicationStateExpired

ZIMGroupApplicationStateExpired=(4)

Expired.

ZIMGroupApplicationStateDisabled

ZIMGroupApplicationStateDisabled=(5)

Disabled

ZIMGroupApplicationType

Group application type.

Declared in ZIMDefines.h

Properties

ZIMGroupApplicationTypeNone

ZIMGroupApplicationTypeNone=(0)

None.

ZIMGroupApplicationTypeJoin

ZIMGroupApplicationTypeJoin=(1)

Join type.

ZIMGroupApplicationTypeInvite

ZIMGroupApplicationTypeInvite=(2)

Invite type.

ZIMGroupApplicationTypeBeInvite

ZIMGroupApplicationTypeBeInvite=(3)

Be invite type.

ZIMGroupAttributesUpdateAction

Group attributes update action.

Details

Group attributes update action.

Declared in ZIMDefines.h

Properties

ZIMGroupAttributesUpdateActionSet

ZIMGroupAttributesUpdateActionSet=(0)

Set action.

ZIMGroupAttributesUpdateActionDelete

ZIMGroupAttributesUpdateActionDelete =(1)

Delete action.

ZIMGroupBeInviteMode

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

UNKNOWN

UNKNOWN=(0)

Unknown.

CREATED

CREATED=(1)

Join when creating a group.

JOIN_APPLY

JOIN_APPLY=(2)

Join application to the group.

JOINED

JOINED=(3)

Join the group.

INVITED

INVITED=(4)

Invite to the group.

INVITE_APPLY

INVITE_APPLY=(5)

Invite application to the group.

ZIMGroupEvent

Group events.

Details

Group events.

Declared in ZIMDefines.h

Properties

NONE

NONE=(0)

None.

CREATED

CREATED=(1)

Create groups.

DISMISSED

DISMISSED=(2)

Disband the group.

JOINED

JOINED=(3)

Join the group.

INVITED

INVITED=(4)

Invite to the group.

LEFT

LEFT=(5)

Leave the group.

KICKED_OUT

KICKED_OUT=(6)

Kick out of the group.

ZIMGroupInviteMode

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.

ZIMGroupJoinMode

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.

ZIMGroupMemberEvent

Group member events.

Details

Group member events.

Declared in ZIMDefines.h

Properties

NONE

NONE=(0)

None.

JOINED

JOINED=(1)

Joined.

LEFT

LEFT=(2)

left.

KICKED_OUT

KICKED_OUT=(4)

kicked_out

INVITED

INVITED=(5)

invited.

ZIMGroupMemberState

group membership status.

Details

group membership status.

Declared in ZIMDefines.h

Properties

QUIT

QUIT=(0)

quit.

ENTER

ENTER=(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

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

ZIMGroupState

group status.

Details

group status.

Declared in ZIMDefines.h

Properties

QUIT

QUIT=(0)

quit.

ENTER

ENTER=(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

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

Describes whether the current message was sent or received.

Declared in ZIMDefines.h

Properties

ZIM_MESSAGE_DIRECTION_SEND

ZIM_MESSAGE_DIRECTION_SEND=(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

ZIMMessageMentionedTypeMentionMe

ZIMMessageMentionedTypeMentionMe=(1)

mention me

ZIMMessageMentionedTypeMentionAll

ZIMMessageMentionedTypeMentionAll=(2)

mention all user

ZIMMessageMentionedTypeMentionAllAndMe

ZIMMessageMentionedTypeMentionAllAndMe=(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

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).

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

ZIMMessagePinStatusNotPinned

ZIMMessagePinStatusNotPinned=(0)

ZIMMessagePinStatusPinned

ZIMMessagePinStatusPinned=(1)

ZIMMessagePinStatusUpdated

ZIMMessagePinStatusUpdated=(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

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.

ZIMMessageRepliedInfoState

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 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.

ZIMMessageRevokeStatusAuditRejectRevoke

ZIMMessageRevokeStatusAuditRejectRevoke=(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

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)

Message sent successfully.

ZIM_MESSAGE_SENT_STATUS_FAILED

ZIM_MESSAGE_SENT_STATUS_FAILED=(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

ZIMMessageTypeText

ZIMMessageTypeText=(1)

Normal text message.

Use cases: Can be used to deliver ordinary text messages.

ZIMMessageTypeCommand

ZIMMessageTypeCommand=(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.

ZIMMessageTypeUnknown

ZIMMessageTypeUnknown=(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.

ZIMMessageTypeBarrage

ZIMMessageTypeBarrage=(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.

ZIMMessageTypeImage

ZIMMessageTypeImage=(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.

ZIMMessageTypeFile

ZIMMessageTypeFile=(12)

File message.

Use cases: For sending file messages, no file type restrictions.

ZIMMessageTypeAudio

ZIMMessageTypeAudio=(13)

Audio message.

Use cases: For sending audio messages, only ".mp3" audio type is supported.

ZIMMessageTypeVideo

ZIMMessageTypeVideo=(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.

ZIMMessageTypeSystem

ZIMMessageTypeSystem=(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.

ZIMMessageTypeRevoke

ZIMMessageTypeRevoke=(31)

Reovked message.

ZIMMessageTypeCombine

ZIMMessageTypeCombine=(100)

Combined message.

ZIMMessageTypeCustom

ZIMMessageTypeCustom=(200)

Custom message.

ZIMMessageTypeTips

ZIMMessageTypeTips=(32)

Tips message.

ZIMMessageTypeMultiple

ZIMMessageTypeMultiple=(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

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.

ZIMPlatformTypeUnknown

ZIMPlatformTypeUnknown=(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

ZIMRoomAttributesUpdateActionSet

ZIMRoomAttributesUpdateActionSet=(0)

Set action.

ZIMRoomAttributesUpdateActionDelete

ZIMRoomAttributesUpdateActionDelete =(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

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.

ZIMRoomEventConnnectTimeout

ZIMRoomEventConnnectTimeout=(9)

connect timeout.

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

Details

Used to indicate the user's connection status to the room.

Caution: Please use with ZIMRoomEvent parameter.

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.

ZIMTipsMessageChangeInfoType

Type of additional information for tips messages.

Details

Type of additional information for tips messages.

Declared in ZIMDefines.h

Properties

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.

GROUP_MEMBER_MUTE_CHANGED

GROUP_MEMBER_MUTE_CHANGED=(12)

Group member mute info change event.

ZIMTipsMessageChangeInfoTypeGroupMessagePinInfoChanged

ZIMTipsMessageChangeInfoTypeGroupMessagePinInfoChanged=(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

ZIMTipsMessageEventGroupCreated

ZIMTipsMessageEventGroupCreated=(1)

ZIMTipsMessageEventGroupDismissed

ZIMTipsMessageEventGroupDismissed=(2)

ZIMTipsMessageEventGroupJoined

ZIMTipsMessageEventGroupJoined=(3)

ZIMTipsMessageEventGroupInvited

ZIMTipsMessageEventGroupInvited=(4)

ZIMTipsMessageEventGroupLeft

ZIMTipsMessageEventGroupLeft=(5)

ZIMTipsMessageEventGroupKickedOut

ZIMTipsMessageEventGroupKickedOut=(6)

ZIMTipsMessageEventGroupInfoChanged

ZIMTipsMessageEventGroupInfoChanged=(7)

ZIMTipsMessageEventGroupMemberInfoChanged

ZIMTipsMessageEventGroupMemberInfoChanged=(8)

ZIMTipsMessageEventGroupMessagePinned

ZIMTipsMessageEventGroupMessagePinned=(9)

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.

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.