Enum
ZIMAudioANSMode
Active Noise Suppression mode.
Properties
Soft
Soft=(0)Soft ANS. In most instances, the sound quality will not be damaged, but some noise will remain.
Medium
Medium=(1)Medium ANS. It may damage some sound quality, but it has a good noise reduction effect.
Aggressive
Aggressive=(2)Aggressive ANS. It may significantly impair the sound quality, but it has a good noise reduction effect.
Ai
Ai=(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.
AiBalanced
AiBalanced=(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.
Properties
Speaker
Speaker=(0)The speaker.
Receiver
Receiver=(1)The receiver.
ZIMBlacklistChangeAction
blacklist update action.
Details
blacklist update action.
Properties
Added
Added=(0)Add action.
Removed
Removed=(1)Removed action.
ZIMCXHandleType
Type of contact information for the VoIP initiator.
Properties
PhoneNumber
PhoneNumber=(2)A phone number.
EmailAddress
EmailAddress=(3)An email address.
Generic
Generic=(1)An unspecified type of handle.
ZIMCallInvitationMode
Call invitation mode.
Details
Call invitation mode.
Properties
General
General=(0)general.
Advanced
Advanced=(1)advanced
Unknown
Unknown=(-1)Unknown type, as a guaranteed enumeration value.
ZIMCallState
call status.
Details
call status.
Properties
Unknown
Unknown=(-1)unknown.
Started
Started=(1)started.
Ended
Ended=(2)ended.
ZIMCallUserState
Call user status.
Details
Call user status.
Properties
Inviting
Inviting=(0)inviting.
Accepted
Accepted=(1)accepted.
Rejected
Rejected=(2)rejected.
Cancelled
Cancelled=(3)cancelled.
Offline
Offline=(4)offline.
Received
Received=(5)received.
Timeout
Timeout=(6)timeout.
Quit
Quit=(7)quit.
Unknown
Unknown=(-1)unknown
Ended
Ended=(8)ended.
NotYetReceived
NotYetReceived=(9)Not received.
BeCancelled
BeCancelled=(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.
Properties
Success
Success=(0)Success.
ActiveLogin
ActiveLogin=(1)The user actively logs in.
LoginTimeout
LoginTimeout=(2)Connection timed out.
LoginInterrupted
LoginInterrupted=(3)The network connection is temporarily interrupted.
KickedOut
KickedOut=(4)Being kicked out.
TokenExpired
TokenExpired=(5)Detail description: Disconnected due to expired login token.
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.
Properties
Disconnected
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.
Connecting
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.
Connected
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.
Reconnecting
Reconnecting=(3)The connection is being reconnected.
- Use cases: In this state, you are logging in again.
ZIMConversationEvent
conversation changed event.
Properties
Added
Added=(0)Updated
Updated=(1)Disabled
Disabled=(2)Deleted
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.
Properties
Notify
Notify=(1)DoNotDisturb
DoNotDisturb=(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.
Properties
Started
Started =(0)Starting conversation list synchronization from server.
Finished
Finished =(1)Finished conversation list synchronization from server.
Failed
Failed =(2)Failed to synchronize the session list from the server.
ZIMConversationType
Conversation type.
Properties
Peer
Peer=(0)Conversation type peer.
Room
Room=(1)Conversation type room.
Group
Group=(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.
Properties
Success
Success=(0)Success without exception.
- Use cases: Used to indicate that the operation is executed correctly.
Failed
Failed=(1)Failed, the guarantee is wrong.
- Use cases: Used in the operation guarantee strategy.
CommonModuleParamInvalid
CommonModuleParamInvalid=(6000001)The incoming parameter is invalid.
Use case: Used to protect the bottom strategy when the interface call fails due to incorrect parameters.
CommonModuleNotInit
CommonModuleNotInit=(6000002)The SDK is not initialized.
Use case: Used for error return when the ZIM SDK is not initialized successfully.
CommonModuleInvalidAppID
CommonModuleInvalidAppID=(6000003)Invalid AppID.
Use case: Used for error return of failure due to invalid AppID.
CommonModuleTriggerSDKFrequencyLimit
CommonModuleTriggerSDKFrequencyLimit=(6000004)Trigger SDK internal frequency limit.
CommonModuleTriggerServerFrequencyLimit
CommonModuleTriggerServerFrequencyLimit=(600005)Trigger background service frequency limit.
CommonModuleSwitchServerError
CommonModuleSwitchServerError=(6000006)The Switch server reported an error.
CommonModuleIMServerError
CommonModuleIMServerError=(6000007)ZIM service internal error.
CommonModuleIMDatabaseError
CommonModuleIMDatabaseError=(6000008)ZIM internal database error.
CommonModuleIMServerDisconnect
CommonModuleIMServerDisconnect=(6000009)Disconnected while sending request.
CommonModuleUploadLogError
CommonModuleUploadLogError=(6000010)Failed to upload log.
NetworkModuleCommonError
NetworkModuleCommonError=(6000101)Login failed.
NetworkModuleServerError
NetworkModuleServerError=(6000102)Login failed due to internal reasons.
NetworkModuleTokenInvalid
NetworkModuleTokenInvalid=(6000103)Token is invalid.
NetworkModuleNetworkError
NetworkModuleNetworkError=(6000104)Network error.
NetworkModuleTokenExpired
NetworkModuleTokenExpired=(6000106)Token expired.
NetworkModuleTokenVersionError
NetworkModuleTokenVersionError=(6000107)Token version number is wrong.
NetworkModuleTokenTimeIsTooShort
NetworkModuleTokenTimeIsTooShort=(6000108)Token duration is too short.
NetworkModuleUserHasAlreadyLogged
NetworkModuleUserHasAlreadyLogged=(6000111)Logging in to multiple accounts on the current device.
NetworkModuleUserIsNotLogged
NetworkModuleUserIsNotLogged=(6000121)User is not logged.
MessageModuleCommonError
MessageModuleCommonError=(6000201)Internal error sending message.
MessageModuleServerError
MessageModuleServerError=(6000202)Error sending message background service.
MessageModuleSendMessageFailed
MessageModuleSendMessageFailed=(6000203)Message sending failed.
MessageModuleTargetDoesNotExist
MessageModuleTargetDoesNotExist=(6000204)The message target does not exist.
MessageModuleCallError
MessageModuleCallError=(6000270)MessageModuleCancelCallError
MessageModuleCancelCallError=(6000271)MessageModuleCallServerError
MessageModuleCallServerError=(6000272)MessageModuleIsNotInvitor
MessageModuleIsNotInvitor=(6000273)MessageModuleIsNotInvitee
MessageModuleIsNotInvitee=(6000274)MessageModuleCallAlreadyExists
MessageModuleCallAlreadyExists=(6000275)MessageModuleCallDoesNotExist
MessageModuleCallDoesNotExist=(6000276)RoomModuleCommonError
RoomModuleCommonError=(6000301)RoomModuleServerError
RoomModuleServerError=(6000302)RoomModuleCreateRoomError
RoomModuleCreateRoomError=(6000303)RoomModuleJoinRoomError
RoomModuleJoinRoomError=(6000304)RoomModuleLeaveRoomError
RoomModuleLeaveRoomError=(6000306)RoomModuleUserIsNotInTheRoom
RoomModuleUserIsNotInTheRoom=(6000321)RoomModuleTheRoomDoesNotExist
RoomModuleTheRoomDoesNotExist=(6000322)RoomModuleTheRoomAlreadyExists
RoomModuleTheRoomAlreadyExists=(6000323)RoomModuleTheNumberOfExistingRoomsHasReachedLimit
RoomModuleTheNumberOfExistingRoomsHasReachedLimit=(6000324)RoomModuleTheNumberOfJoinedRoomsHasReachedLimit
RoomModuleTheNumberOfJoinedRoomsHasReachedLimit=(6000325)RoomModuleRoomAttributesCommonError
RoomModuleRoomAttributesCommonError=(6000330)RoomModuleRoomAttributesOperationFailedCompletely
RoomModuleRoomAttributesOperationFailedCompletely=(6000331)RoomModuleRoomAttributesOperationFailedPartly
RoomModuleRoomAttributesOperationFailedPartly=(6000332)RoomModuleRoomAttributesQueryFailed
RoomModuleRoomAttributesQueryFailed=(6000333)RoomModuleTheNumberOfRoomAttributesExceedsLimit
RoomModuleTheNumberOfRoomAttributesExceedsLimit=(6000334)RoomModuleTheLengthOfRoomAttributeKeyExceedsLimit
RoomModuleTheLengthOfRoomAttributeKeyExceedsLimit=(6000335)RoomModuleTheLengthOfRoomAttributeValueExceedsLimit
RoomModuleTheLengthOfRoomAttributeValueExceedsLimit=(6000336)RoomModuleTheTotalLengthOfRoomAttributesValueExceedsLimit
RoomModuleTheTotalLengthOfRoomAttributesValueExceedsLimit=(6000337)GroupModuleCommonError
GroupModuleCommonError=(6000501)GroupModuleServerError
GroupModuleServerError=(6000502)GroupModuleCreateGroupError
GroupModuleCreateGroupError=(6000503)GroupModuleDismissGroupError
GroupModuleDismissGroupError=(6000504)GroupModuleJoinGroupError
GroupModuleJoinGroupError=(6000505)GroupModuleLeaveGroupError
GroupModuleLeaveGroupError=(6000506)GroupModuleKickoutGroupMemberError
GroupModuleKickoutGroupMemberError=(6000507)GroupModuleInviteUserIntoGroupError
GroupModuleInviteUserIntoGroupError=(6000508)GroupModuleTransferOwnerError
GroupModuleTransferOwnerError=(6000509)GroupModuleUpdateGroupInfoError
GroupModuleUpdateGroupInfoError=(6000510)GroupModuleQueryGroupInfoError
GroupModuleQueryGroupInfoError=(6000511)GroupModuleGroupAttributesOperationFailed
GroupModuleGroupAttributesOperationFailed=(6000512)GroupModuleGroupAttributesQueryFailed
GroupModuleGroupAttributesQueryFailed=(6000513)GroupModuleUpdateGroupMemberInfoError
GroupModuleUpdateGroupMemberInfoError=(6000514)GroupModuleQueryGroupMemberInfoError
GroupModuleQueryGroupMemberInfoError=(6000515)GroupModuleQueryGroupListError
GroupModuleQueryGroupListError=(6000516)GroupModuleQueryGroupMemberListError
GroupModuleQueryGroupMemberListError=(6000517)GroupModuleUserIsNotInTheGroup
GroupModuleUserIsNotInTheGroup=(6000521)GroupModuleMemberIsAlreadyInTheGroup
GroupModuleMemberIsAlreadyInTheGroup=(6000522)GroupModuleGroupDoesNotExist
GroupModuleGroupDoesNotExist=(6000523)GroupModuleGroupAlreadyExists
GroupModuleGroupAlreadyExists=(6000524)GroupModuleGroupMemberHasReachedLimit
GroupModuleGroupMemberHasReachedLimit=(6000525)GroupModuleGroupAttributeDoesNotExist
GroupModuleGroupAttributeDoesNotExist=(6000526)GroupModuleTheNumberOfGroupAttributesExceedsLimit
GroupModuleTheNumberOfGroupAttributesExceedsLimit=(6000531)GroupModuleTheLengthOfGroupAttributeKeyExceedsLimit
GroupModuleTheLengthOfGroupAttributeKeyExceedsLimit=(6000532)GroupModuleTheLengthOfGroupAttributeValueExceedsLimit
GroupModuleTheLengthOfGroupAttributeValueExceedsLimit=(6000533)GroupModuleTheTotalLengthOfGroupAttributesValueExceedsLimit
GroupModuleTheTotalLengthOfGroupAttributesValueExceedsLimit=(6000534)GroupModuleNoCorrespondingOperationAuthority
GroupModuleNoCorrespondingOperationAuthority=(6000541)GroupModuleGroupDatabaseError
GroupModuleGroupDatabaseError=(6000542)ConversationModuleCommonError
ConversationModuleCommonError=(6000601)ConversationModuleServerError
ConversationModuleServerError=(6000602)ConversationModuleConversationDoesNotExist
ConversationModuleConversationDoesNotExist=(6000603)MessageModuleFileNotExist
MessageModuleFileNotExist=(6000211)MessageModuleFileServerError
MessageModuleFileServerError=(6000212)MessageModuleFileTypeUnsupported
MessageModuleFileTypeUnsupported=(6000213)MessageModuleFileSizeInvalid
MessageModuleFileSizeInvalid=(6000214)MessageModuleFileDurationInvalid
MessageModuleFileDurationInvalid=(6000215)MessageModuleAuditRejected
MessageModuleAuditRejected=(6000221)MessageModuleAuditFailed
MessageModuleAuditFailed=(6000222)ZIMErrorCodeCommonModuleUserInfoQueriedLimit
ZIMErrorCodeCommonModuleUserInfoQueriedLimit=(6000012)ZIMErrorCodeCommonModuleUnsupportedRequest
ZIMErrorCodeCommonModuleUnsupportedRequest=(6000013)RoomModuleRoomMemberAttributesCommonError
RoomModuleRoomMemberAttributesCommonError=(6000350)RoomModuleTheTotalLengthOfRoomMemberAttributesExceedsLimit
RoomModuleTheTotalLengthOfRoomMemberAttributesExceedsLimit=(6000351)RoomModuleTheLengthOfRoomMemberAttributesKeyExceedsLimit
RoomModuleTheLengthOfRoomMemberAttributesKeyExceedsLimit=(6000352)RoomModuleTheLengthOfRoomMemberAttributesValueExceedsLimit
RoomModuleTheLengthOfRoomMemberAttributesValueExceedsLimit=(6000353)RoomModuleTheMemberNumberOfRoomMemberAttributesExceedsLimit
RoomModuleTheMemberNumberOfRoomMemberAttributesExceedsLimit=(6000357)MessageModuleReceiptReadError
MessageModuleReceiptReadError=(6000277)CommonModuleUserIsNotExist
CommonModuleUserIsNotExist=(6000011)MessageModuleMessageExceedsRevokeTime
MessageModuleMessageExceedsRevokeTime=(6000278)MessageModuleMessageHasBeenRevoked
MessageModuleMessageHasBeenRevoked=(6000279)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DURATION_INVALID
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DURATION_INVALID=(6000216)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_PERMISSION_DENIED
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_PERMISSION_DENIED=(6000217)ZIMErrorCodeMessageModuleFileDownloadLimit
ZIMErrorCodeMessageModuleFileDownloadLimit=(6000218)ZIMErrorCodeMessageModuleFileDownloadUrlNotFound
ZIMErrorCodeMessageModuleFileDownloadUrlNotFound=(6000219)ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_HTTP_REQUEST_SERVER_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_HTTP_REQUEST_SERVER_ERROR=(6000220)ZIMErrorCodeCommonModuleExceedDAULimit
ZIMErrorCodeCommonModuleExceedDAULimit=(6000015)ZIMErrorCodeCommonModuleExceedMAULimit
ZIMErrorCodeCommonModuleExceedMAULimit=(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.
MessageModuleMessageReactionTypeExisted
MessageModuleMessageReactionTypeExisted=(6000280)MessageModuleCallInviteUserDoesNotExist
MessageModuleCallInviteUserDoesNotExist=(6000281)MessageModuleMessageReceiptLimit
MessageModuleMessageReceiptLimit=(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.
MessageModuleUserAlreadyInTheCall
MessageModuleUserAlreadyInTheCall=(6000283)The device that invokes the callJoin interface is in advanced mode, calling and acting as the main device. No need to handle.
GroupModuleGroupWithDismissed
GroupModuleGroupWithDismissed=(6000527)Please use a different ID to create a group as the one you are using has already been destroyed.
MessageModuleTheCallIsNotAdvancedModeError
MessageModuleTheCallIsNotAdvancedModeError=(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.
Properties
Added
Added=(0)Add action.
Deleted
Deleted=(1)Delete action.
ZIMFriendApplicationState
Friend application state.
Properties
Waiting
Waiting=(1)Awaiting response.
Accepted
Accepted=(2)Accepted.
Rejected
Rejected=(3)Rejected.
Expired
Expired=(4)Expired.
Disabled
Disabled=(5)Disabled
ZIMFriendApplicationType
Friend application type.
Properties
None
None=(0)Friend application type none.
Received
Received=(1)Applications received.
Sent
Sent=(2)Application sent.
Both
Both=(3)Application initiated by both parties.
ZIMFriendDeleteType
Delete friend type.
Properties
Both
Both=(0)Delete in both directions.
Single
Single=(1)One-way deletion.
ZIMFriendListChangeAction
friend list update action.
Details
friend list update action.
Properties
Added
Added=(0)Add action.
Deleted
Deleted=(1)Delete action.
ZIMFriendRelationCheckType
Check the friend relationship type.
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.
Properties
None
None=(0)The default type.
Include
Include=(1)Federated mode.
Exclude
Exclude=(2)Exclusion mode.
ZIMGroupApplicationListChangeAction
Group application list update action.
Details
group application list update action.
Properties
Added
Added=(0)Add action.
ZIMGroupApplicationState
Group application state.
Properties
Waiting
Waiting=(1)Awaiting response.
Accepted
Accepted=(2)Accepted.
Rejected
Rejected=(3)Rejected.
Expired
Expired=(4)Expired.
Disabled
Disabled=(5)Disabled
ZIMGroupApplicationType
Group application type.
Properties
None
None=(0)None.
Join
Join=(1)Join type.
Invite
Invite=(2)Invite type.
BeInvite
BeInvite=(3)Be invite type.
ZIMGroupAttributesUpdateAction
Group attributes update action.
Details
Group attributes update action.
Properties
Set
Set=(0)Set action.
Delete
Delete=(1)Delete action.
ZIMGroupBeInviteMode
Verification mode for being invited to the group.
Properties
None
None=(0)The invitees enter the group directly.
Auth
Auth=(1)The invitee's consent is required to join the group.
ZIMGroupEnterType
Group enter type.
Details
Group enter type.
Properties
Unknown
Unknown=(0)Unknown.
Created
Created=(1)Join when creating a group.
JoinApply
JoinApply=(2)Join application to the group.
Joined
Joined=(3)Join the group.
Invited
Invited=(4)Invite to the group.
InviteApply
InviteApply=(5)Invite application to the group.
ZIMGroupEvent
Group events.
Details
Group events.
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.
KickedOut
KickedOut=(6)Kick out of the group.
ZIMGroupInviteMode
Verification mode for invite to the group.
Properties
Any
Any=(0)Everyone in the group can invite.
Admin
Admin=(1)Only group owners or administrators can invite.
ZIMGroupJoinMode
Verification mode for joining the group.
Properties
Any
Any=(0)Anyone can join the group directly.
Auth
Auth=(1)Requires group owner or administrator approval.
Forbid
Forbid=(2)Joining the group is prohibited.
ZIMGroupMemberEvent
Group member events.
Details
Group member events.
Properties
NONE
NONE=(0)None.
Joined
Joined=(1)Joined.
Left
Left=(2)left.
KickedOut
KickedOut=(4)kicked_out
Invited
Invited=(5)invited.
ZIMGroupMemberState
group membership status.
Details
group membership status.
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.
Properties
Notify
Notify=(1)Disturb
Disturb=(2)ZIMGroupMuteMode
Group mute mode.
Details
Group mute mode.
Properties
None
None=(0)Unmute.
Normal
Normal=(1)Group normal members mute mode.
All
All=(2)Group all members mute mode.
Custom
Custom=(3)Customize group mute mode
ZIMGroupState
group status.
Details
group status.
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.
Properties
OriginalFile
OriginalFile=(1)Original file type, suitable for original images, audio files, and video files. After calling [downloadMediaFile], the SDK will update the fileLocalPath property in ZIMFileMessage.
LargeImage
LargeImage=(2)Large image type. After calling [downloadMediaFile], the SDK will update the largeImageLocalPath property in [ZIMImageMessage].
Thumbnail
Thumbnail=(3)Image thumbnail type. After calling [downloadMediaFile], the SDK will update the thumbnailLocalPath property in [ZIMImageMessage].
VideoFirstFrame
VideoFirstFrame=(4)The type of the first frame of the video. After calling [downloadMediaFile], the SDK will update the videoFirstFrameLocalPath property in [ZIMVideoMessage].
ZIMMessageDirection
the direction of the message.
Details
Describes whether the current message was sent or received.
Properties
Send
Send=(0)Message has been sent.
Receive
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.
Properties
UNKNOWN
UNKNOWN=(-1)unknow type
MENTION_ME
MENTION_ME=(1)mention me
mention_all
mention_all=(2)mention all user
mention_all_and_me
mention_all_and_me=(3)mention all user and mention me
ZIMMessageOrder
Message order.
Details
Used to represent the order of the message list.
Properties
Descending
Descending=(0)Represents message list in descending order (message list order is from new to old).
Ascending
Ascending=(1)Represents message list in ascending order (message list order is from old to new).
ZIMMessagePinStatus
Enumeration of message pinned status.
Details
Message pinned status.
- Use cases: You can determine the pinned status of a message by enumeration.
Properties
NotPinned
NotPinned=(0)Pinned
Pinned=(1)Updated
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.
Properties
Low
Low=(1)Low priority.
- Use cases: Generally used to send unimportant messages such as barrage message in a room.
Medium
Medium=(2)Medium priority.
- Use cases: Generally used to send regular chat messages.
High
High=(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
Properties
None
None=(0)Not a receipt.
Processing
Processing=(1)Receipt in progress.
Done
Done=(2)Receipt completed.
Expired
Expired=(3)Receipt has expired.
Failed
Failed=(4)Receipt failed.
ZIMMessageRepliedInfoState
The state of the source message to be replied.
Properties
Normal
Normal=(0)normal state.
Deleted
Deleted=(1)deleted state.
NotFound
NotFound=(2)not found state.
ZIMMessageRevokeStatus
Message revoke status
Details
Identifies the status of current revoke message.
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.
AUDIT_REJECT_REVOKE
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.
Properties
Sending
Sending=(0)The message is being sent.
Success
Success=(1)Message sent successfully.
Failed
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.
Properties
Text
Text=(1)Normal text message.
- Use cases: Can be used to deliver ordinary text messages.
Command
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.
Unknown
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.
Barrage
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.
Image
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.
File
File=(12)File message.
- Use cases: For sending file messages, no file type restrictions.
Audio
Audio=(13)Audio message.
- Use cases: For sending audio messages, only ".mp3" audio type is supported.
Video
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.
System
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.
Revoke
Revoke=(31)Reovked message.
Combine
Combine=(100)Combined message.
Custom
Custom=(200)Custom message.
Tips
Tips=(32)Tips message.
Multiple
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.
Properties
Win
Win=(1)Windows.
IPhoneOS
IPhoneOS=(2)iOS.
Android
Android=(3)Android.
MacOS
MacOS=(4)MacOS.
Linux
Linux=(5)Linux.
Web
Web=(6)Web.
MiniProgram
MiniProgram=(7)Mini program.
IPadOS
IPadOS=(9)iPad.
Unknown
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.
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.
Properties
Set
Set=(0)Set action.
Delete
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.
Properties
Success
Success=(0)Success.
NetworkInterrupted
NetworkInterrupted=(1)The network in the room is temporarily interrupted.
NetworkDisconnected
NetworkDisconnected=(2)The network in the room is disconnected.
RoomNotExist
RoomNotExist=(3)The room not exist.
ActiveCreate
ActiveCreate=(4)The user actively creates a room.
CreateFailed
CreateFailed=(5)Failed to create room.
ActiveEnter
ActiveEnter=(6)The user starts to enter the room.
EnterFailed
EnterFailed=(7)user failed to enter the room.
KickedOut
KickedOut=(8)user was kicked out of the room.
ConnectTimeout
ConnectTimeout=(9)connect timeout.
KickedOutByOtherDevice
KickedOutByOtherDevice=(10)Multi-device logins into the same room will result in the user being kicked out of the room.
ActiveSwitch
ActiveSwitch=(11)Switch room.
SwitchFailed
SwitchFailed=(12)Switch room failed.
ZIMRoomState
Details
Used to indicate the user's connection status to the room.
- Caution: Please use with ZIMRoomEvent parameter.
Properties
Disconnected
Disconnected=(0)Indicates that the connection to the room is interrupted, and the [createRoom], [joinRoom], and [enterRoom] fails. If the network is disconnected for a long time, the heartbeat of the room times out, the background notifies the user that he has been kicked out of the room, or the logout will throw this status.
Connecting
Connecting=(1)connecting indicates that the connection between a room and a room is in the connecting state. When the create, join, or enter room connection is not returned, this state is thrown when the network is disconnected.
Connected
Connected=(2)connected indicates that the device is properly connected to the room. If create, join, or enter room succeeds, the state will be thrown if the network is disconnected and the room heartbeat does not time out.
ZIMTipsMessageChangeInfoType
Type of additional information for tips messages.
Details
Type of additional information for tips messages.
Properties
GroupDataChanged
GroupDataChanged=(1)Group name, group avatar, and group notice have multiple changes.
GroupNoticeChanged
GroupNoticeChanged=(2)Group notice change event.
GroupNameChanged
GroupNameChanged=(3)Group name change event.
GroupAvatarUrlChanged
GroupAvatarUrlChanged=(4)Group avatar change event.
GroupMuteChanged
GroupMuteChanged=(5)Group mute info change event.
GroupOwnerTransferred
GroupOwnerTransferred=(10)Group owner transfer event.
GroupMemberRoleChanged
GroupMemberRoleChanged=(11)Group member role change event.
GroupMemberMuteChanged
GroupMemberMuteChanged=(12)Group member mute info change event.
GroupMessagePinInfoChanged
GroupMessagePinInfoChanged=(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.
Properties
GroupCreated
GroupCreated=(1)GroupDismissed
GroupDismissed=(2)GroupJoined
GroupJoined=(3)GroupInvited
GroupInvited=(4)GroupLeft
GroupLeft=(5)GroupKickedOut
GroupKickedOut=(6)GroupInfoChanged
GroupInfoChanged=(7)GroupMemberInfoChanged
GroupMemberInfoChanged=(8)GroupMessagePinned
GroupMessagePinned=(9)ZIMUserOnlineStatus
User online status.
Details
User online status.
Properties
Online
Online=(0)Online. The user is in this state when the user is logged in and the network status is good.
Offline
Offline=(1)Offline. The user does not call logout to actively logout because the network is disconnected, the app is killed, the background is withdrawn, and the screen is locked. The user will be in this state after the long background link is disconnected.
Logout
Logout=(2)Log out. User active logout will be in this state.
ZIMUserOnlineStatusUnknown
ZIMUserOnlineStatusUnknown=(99)Unknown status. Guaranteed enumeration.
ZIMUserRelationType
Friend relationship type.
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.
ZPNsEnvironment
The current offline push environment of the APP. Set the certificate to development or description based on the certificate selected during iOS packaging.
Details
The current offline push environment of the APP. Set the certificate to development or description based on the certificate selected during iOS packaging.
Properties
Production
Production=(0)If the certificate is distribution, ZPNsEnvironment is Production.
Development
Development=(1)If the certificate used for packaging is development, ZPNsIOSEnvironment is Development.
ZPNsIOSEnvironment
The current offline push environment of the APP. Set the certificate to development or description based on the certificate selected during iOS packaging.
Details
The current offline push environment of the APP. Set the certificate to development or description based on the certificate selected during iOS packaging.
- Available since: 2.5.0 or later.
Properties
Production
Production=(0)If the certificate is distribution, ZPNsIOSEnvironment is Production.
Development
Development=(1)If the certificate used for packaging is development, ZPNsIOSEnvironment is Development.
Automatic
Automatic=(2)If you don't yet understand current of ZPNsIOSEnvironment, please fill ZPNsIOSEnvironment. Automatic. Automaic may be affected by the iOS system version. If the iOS system is updated in a major version, please pay attention to whether the ZPNs release log contains relevant update instructions.
ZPNsPushSourceType
Properties
APNs
APNs=(1)Apple APNs
FCM
FCM=(2)Google FCM
HuaWei
HuaWei=(3)HuaWei
XiaoMi
XiaoMi=(4)XiaoMi
Oppo
Oppo=(5)Oppo
Vivo
Vivo=(6)Vivo
HONOR
HONOR=(7)HONOR