Enum
PushSource
Enumeration of push sources.
Details
Enumeration of push sources.
Declared in ZPNs.java
Properties
ZEGO
ZEGO=(0)ZEGO
VIVO
VIVO=(1)VIVO
XIAOMI
XIAOMI=(2)XIAOMI
HUAWEI
HUAWEI=(3)HUAWEI
OPPO
OPPO=(4)OPPO
ZIMAudioANSMode
Active Noise Suppression mode.
Declared in ZIMAudioANSMode.java
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.
AI_BALANCED
AI_BALANCED=(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 ZIMAudioRouteType.java
Properties
SPEAKER
SPEAKER=(0)The speaker.
RECEIVER
RECEIVER=(1)The receiver.
ZIMBlacklistChangeAction
blacklist update action.
Details
blacklist update action.
Declared in enums/ZIMBlacklistChangeAction.java
Properties
ADDED
ADDED=(0)Add action.
REMOVED
REMOVED=(1)Removed action.
ZIMCXHandleType
Type of contact information for the VoIP initiator.
Declared in enums/ZIMMessageType.java
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.
Declared in enums/ZIMCallUserState.java
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.
Declared in enums/ZIMCallUserState.java
Properties
Unknown
Unknown=(-1)unknown.
Started
Started=(1)started.
Ended
Ended=(2)ended.
ZIMCallUserState
Call user status.
Details
Call user status.
Declared in enums/ZIMCallUserState.java
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.
QUITED
QUITED=(7)quit.
UNKNOWN
UNKNOWN=(-1)unknown
ENDED
ENDED=(8)ended.
NOT_YET_RECEIVED
NOT_YET_RECEIVED=(9)Not received.
BE_CANCELLED
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 enums/ZIMConnectionEvent.java
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 enums/ZIMConnectionState.java
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 enums/ZIMConversationEvent.java
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.
Declared in enums/ZIMConversationNotificationStatus.java
Properties
NOTIFY
NOTIFY=(1)DO_NOT_DISTURB
DO_NOT_DISTURB=(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 enum/ZIMConversationSyncState.java
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.
Declared in enums/ZIMConversationType.java
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.
Declared in enums/ZIMErrorCode.java
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.
PARAM_INVALID
PARAM_INVALID=(6000001)The incoming parameter is invalid.
Use case: Used to protect the bottom strategy when the interface call fails due to incorrect parameters.
NO_INIT
NO_INIT=(6000002)The SDK is not initialized.
Use case: Used for error return when the ZIM SDK is not initialized successfully.
INVALID_APPID
INVALID_APPID=(6000003)Invalid AppID.
Use case: Used for error return of failure due to invalid AppID.
TRIGGER_SDK_FREQUENCY_LIMIT
TRIGGER_SDK_FREQUENCY_LIMIT=(6000004)Trigger SDK internal frequency limit.
TRIGGER_SERVER_FREQUENCY_LIMIT
TRIGGER_SERVER_FREQUENCY_LIMIT=(600005)Trigger background service frequency limit.
SWITCH_SERVER_ERROR
SWITCH_SERVER_ERROR=(6000006)The Switch server reported an error.
IM_SERVER_ERROR
IM_SERVER_ERROR=(6000007)ZIM service internal error.
DATABASE_ERROR
DATABASE_ERROR=(6000008)ZIM internal database error.
IM_SERVER_DISCONNECT
IM_SERVER_DISCONNECT=(6000009)Disconnected while sending request.
UPLOAD_LOG_FAILED
UPLOAD_LOG_FAILED=(6000010)Failed to upload log.
NETWORK_COMMON_ERROR
NETWORK_COMMON_ERROR=(6000101)Login failed.
NETWORK_SERVER_ERROR
NETWORK_SERVER_ERROR=(6000102)Login failed due to internal reasons.
TOKEN_INVALID
TOKEN_INVALID=(6000103)Token is invalid.
NETWORK_ERROR
NETWORK_ERROR=(6000104)Network error.
TOKEN_EXPIRED
TOKEN_EXPIRED=(6000106)Token expired.
TOKEN_VERSION_ERROR
TOKEN_VERSION_ERROR=(6000107)Token version number is wrong.
TOKEN_TIME_IS_TOO_SHORT
TOKEN_TIME_IS_TOO_SHORT=(6000108)Token duration is too short.
USER_HAS_ALREADY_LOGGED
USER_HAS_ALREADY_LOGGED=(6000111)Logging in to multiple accounts on the current device.
USER_IS_NOT_LOGGED
USER_IS_NOT_LOGGED=(6000121)User is not logged.
MESSAGE_COMMON_ERROR
MESSAGE_COMMON_ERROR=(6000201)Internal error sending message.
MESSAGE_SERVER_ERROR
MESSAGE_SERVER_ERROR=(6000202)Error sending message background service.
SEND_MESSAGE_FAILED
SEND_MESSAGE_FAILED=(6000203)Message sending failed.
TARGET_DOES_NOT_EXIST
TARGET_DOES_NOT_EXIST=(6000204)The message target does not exist.
CALL_ERROR
CALL_ERROR=(6000270)CANCEL_CALL_ERROR
CANCEL_CALL_ERROR=(6000271)CALL_SERVER_ERROR
CALL_SERVER_ERROR=(6000272)NOT_INVITOR
NOT_INVITOR=(6000273)NOT_INVITEE
NOT_INVITEE=(6000274)CALL_ALREADY_EXISTS
CALL_ALREADY_EXISTS=(6000275)CALL_DOES_NOT_EXIST
CALL_DOES_NOT_EXIST=(6000276)ROOM_COMMON_ERROR
ROOM_COMMON_ERROR=(6000301)ROOM_SERVER_ERROR
ROOM_SERVER_ERROR=(6000302)CREATE_ROOM_ERROR
CREATE_ROOM_ERROR=(6000303)JOIN_ROOM_ERROR
JOIN_ROOM_ERROR=(6000304)LEAVE_ROOM_ERROR
LEAVE_ROOM_ERROR=(6000306)USER_IS_NOT_IN_THE_ROOM
USER_IS_NOT_IN_THE_ROOM=(6000321)ROOM_DOES_NOT_EXIST
ROOM_DOES_NOT_EXIST=(6000322)THE_ROOM_ALREADY_EXISTS
THE_ROOM_ALREADY_EXISTS=(6000323)THE_NUMBER_OF_EXISTING_ROOMS_HAS_REACHED_LIMIT
THE_NUMBER_OF_EXISTING_ROOMS_HAS_REACHED_LIMIT=(6000324)THE_NUMBER_OF_JOINED_ROOMS_HAS_REACHED_LIMIT
THE_NUMBER_OF_JOINED_ROOMS_HAS_REACHED_LIMIT=(6000325)ROOM_ATTRIBUTES_COMMON_ERROR
ROOM_ATTRIBUTES_COMMON_ERROR=(6000330)ROOM_ATTRIBUTES_OPERATION_FAILED_COMPLETELY
ROOM_ATTRIBUTES_OPERATION_FAILED_COMPLETELY=(6000331)ROOM_ATTRIBUTES_OPERATION_FAILED_PARTLY
ROOM_ATTRIBUTES_OPERATION_FAILED_PARTLY=(6000332)ROOM_ATTRIBUTES_QUERY_FAILED
ROOM_ATTRIBUTES_QUERY_FAILED=(6000333)THE_NUMBER_OF_ROOM_ATTRIBUTES_EXCEEDS_LIMIT
THE_NUMBER_OF_ROOM_ATTRIBUTES_EXCEEDS_LIMIT=(6000334)THE_LENGTH_OF_ROOM_ATTRIBUTE_KEY_EXCEEDS_LIMIT
THE_LENGTH_OF_ROOM_ATTRIBUTE_KEY_EXCEEDS_LIMIT=(6000335)THE_LENGTH_OF_ROOM_ATTRIBUTE_VALUE_EXCEEDS_LIMIT
THE_LENGTH_OF_ROOM_ATTRIBUTE_VALUE_EXCEEDS_LIMIT=(6000336)THE_TOTAL_LENGTH_OF_ROOM_ATTRIBUTES_VALUE_EXCEEDS_LIMIT
THE_TOTAL_LENGTH_OF_ROOM_ATTRIBUTES_VALUE_EXCEEDS_LIMIT=(6000337)PUSH_ID_INVALID
PUSH_ID_INVALID=(6000401)GROUP_COMMON_ERROR
GROUP_COMMON_ERROR=(6000501)GROUP_SERVER_ERROR
GROUP_SERVER_ERROR=(6000502)CREATE_GROUP_ERROR
CREATE_GROUP_ERROR=(6000503)DISMISS_GROUP_ERROR
DISMISS_GROUP_ERROR=(6000504)JOIN_GROUP_ERROR
JOIN_GROUP_ERROR=(6000505)LEAVE_GROUP_ERROR
LEAVE_GROUP_ERROR=(6000506)KICK_OUT_GROUP_MEMBER_ERROR
KICK_OUT_GROUP_MEMBER_ERROR=(6000507)INVITE_USER_INTO_GROUP_ERROR
INVITE_USER_INTO_GROUP_ERROR=(6000508)TRANSFER_OWNER_ERROR
TRANSFER_OWNER_ERROR=(6000509)UPDATE_GROUP_INFO_ERROR
UPDATE_GROUP_INFO_ERROR=(6000510)QUERY_GROUP_INFO_ERROR
QUERY_GROUP_INFO_ERROR=(6000511)GROUP_ATTRIBUTES_OPERATION_FAILED
GROUP_ATTRIBUTES_OPERATION_FAILED=(6000512)ATTRIBUTES_QUERY_FAILED
ATTRIBUTES_QUERY_FAILED=(6000513)UPDATE_GROUP_MEMBER_INFO_ERROR
UPDATE_GROUP_MEMBER_INFO_ERROR=(6000514)QUERY_GROUP_MEMBER_INFO_ERROR
QUERY_GROUP_MEMBER_INFO_ERROR=(6000515)QUERY_GROUP_LIST_ERROR
QUERY_GROUP_LIST_ERROR=(6000516)QUERY_GROUP_MEMBER_LIST_ERROR
QUERY_GROUP_MEMBER_LIST_ERROR=(6000517)USER_IS_NOT_IN_THE_GROUP
USER_IS_NOT_IN_THE_GROUP=(6000521)MEMBER_IS_ALREADY_IN_THE_GROUP
MEMBER_IS_ALREADY_IN_THE_GROUP=(6000522)DOES_NOT_EXIST
DOES_NOT_EXIST=(6000523)GROUP_ALREADY_EXISTS
GROUP_ALREADY_EXISTS=(6000524)GROUP_MEMBER_HAS_REACHED_LIMIT
GROUP_MEMBER_HAS_REACHED_LIMIT=(6000525)GROUP_ATTRIBUTE_DOES_NOT_EXIST
GROUP_ATTRIBUTE_DOES_NOT_EXIST=(6000526)THE_NUMBER_OF_GROUP_ATTRIBUTES_EXCEEDS_LIMIT
THE_NUMBER_OF_GROUP_ATTRIBUTES_EXCEEDS_LIMIT=(6000531)THE_LENGTH_OF_GROUP_ATTRIBUTE_KEY_EXCEEDS_LIMIT
THE_LENGTH_OF_GROUP_ATTRIBUTE_KEY_EXCEEDS_LIMIT=(6000532)THE_LENGTH_OF_GROUP_ATTRIBUTE_VALUE_EXCEEDS_LIMIT
THE_LENGTH_OF_GROUP_ATTRIBUTE_VALUE_EXCEEDS_LIMIT=(6000533)THE_TOTAL_LENGTH_OF_GROUP_ATTRIBUTE_VALUE_EXCEEDS_LIMIT
THE_TOTAL_LENGTH_OF_GROUP_ATTRIBUTE_VALUE_EXCEEDS_LIMIT=(6000534)NO_CORRESPONDING_OPERATION_AUTHORITY
NO_CORRESPONDING_OPERATION_AUTHORITY=(6000541)GROUP_DATABASE_ERROR
GROUP_DATABASE_ERROR=(6000542)CONVERSATION_COMMON_ERROR
CONVERSATION_COMMON_ERROR=(6000601)CONVERSATION_SERVER_ERROR
CONVERSATION_SERVER_ERROR=(6000602)CONVERSATION_DOES_NOT_EXIST
CONVERSATION_DOES_NOT_EXIST=(6000603)FILE_NOT_EXIST
FILE_NOT_EXIST=(6000211)FILE_SERVER_ERROR
FILE_SERVER_ERROR=(6000212)FILE_TYPE_UNSUPPORTED
FILE_TYPE_UNSUPPORTED=(6000213)FILE_SIZE_INVALID
FILE_SIZE_INVALID=(6000214)FILE_DURATION_INVALID
FILE_DURATION_INVALID=(6000215)AUDIT_REJECTED
AUDIT_REJECTED=(6000221)AUDIT_FAILED
AUDIT_FAILED=(6000222)USER_INFO_QUERIED_LIMIT
USER_INFO_QUERIED_LIMIT=(6000012)UNSUPPORTED_REQUEST
UNSUPPORTED_REQUEST=(6000013)ROOM_MEMBER_ATTRIBUTES_COMMON_ERROR
ROOM_MEMBER_ATTRIBUTES_COMMON_ERROR=(6000350)THE_TOTAL_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_EXCEEDS_LIMIT
THE_TOTAL_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_EXCEEDS_LIMIT=(6000351)THE_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_KEY_EXCEEDS_LIMIT
THE_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_KEY_EXCEEDS_LIMIT=(6000352)THE_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_VALUE_EXCEEDS_LIMIT
THE_LENGTH_OF_ROOM_MEMBER_ATTRIBUTES_VALUE_EXCEEDS_LIMIT=(6000353)THE_MEMBER_NUMBER_OF_ROOM_MEMBER_ATTRIBUTES_EXCEEDS_LIMIT
THE_MEMBER_NUMBER_OF_ROOM_MEMBER_ATTRIBUTES_EXCEEDS_LIMIT=(6000357)RECEIPT_READ_ERROR
RECEIPT_READ_ERROR=(6000277)USER_NOT_EXIST
USER_NOT_EXIST=(6000011)MESSAGE_EXCEEDS_REVOKE_TIME
MESSAGE_EXCEEDS_REVOKE_TIME=(6000278)MESSAGE_HAS_BEEN_REVOKED
MESSAGE_HAS_BEEN_REVOKED=(6000279)USER_IS_ALREADY_IN_THE_ROOM
USER_IS_ALREADY_IN_THE_ROOM=(6000320)NETWORK_SERVER_ERROR_REQUEST_TIMEOUT
NETWORK_SERVER_ERROR_REQUEST_TIMEOUT=(6000105)FILE_PERMISSION_DENIED
FILE_PERMISSION_DENIED=(6000216)FILE_DOWNLOAD_FAILED
FILE_DOWNLOAD_FAILED=(6000217)FILE_DOWNLOAD_LIMIT
FILE_DOWNLOAD_LIMIT=(6000218)FILE_DOWNLOAD_URL_NOT_FOUND
FILE_DOWNLOAD_URL_NOT_FOUND=(6000219)DOWNLOAD_HTTP_REQUEST_SERVER_ERROR
DOWNLOAD_HTTP_REQUEST_SERVER_ERROR=(6000220)EXCEED_DAU_LIMIT
EXCEED_DAU_LIMIT=(6000015)EXCEED_MAU_LIMIT
EXCEED_MAU_LIMIT=(6000016)THE_ROOM_IS_CONNECTING
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.
MESSAGE_REACTION_TYPE_EXISTED
MESSAGE_REACTION_TYPE_EXISTED=(6000280)CALL_INVITE_USER_DOES_NOT_EXIST
CALL_INVITE_USER_DOES_NOT_EXIST=(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.
Declared in enums/ZIMFriendApplicationListChangeAction.java
Properties
ADDED
ADDED=(0)Add action.
DELETED
DELETED=(1)Delete action.
ZIMFriendApplicationState
Friend application state.
Declared in enums/ZIMConversationType.java
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.
Declared in enums/ZIMFriendApplicationType.java
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.
Declared in enums/ZIMConversationType.java
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 enums/ZIMFriendListChangeAction.java
Properties
ADDED
ADDED=(0)Add action.
DELETED
DELETED=(1)Delete action.
ZIMFriendRelationCheckType
Check the friend relationship type.
Declared in enums/ZIMConversationType.java
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 enums/ZIMConversationType.java
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.
Declared in enums/ZIMGroupApplicationListChangeAction.java
Properties
ADDED
ADDED=(0)Add action.
ZIMGroupApplicationState
Group application state.
Declared in enums/ZIMGroupApplicationState.java
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.
Declared in enums/ZIMGroupApplicationType.java
Properties
NONE
NONE=(0)None.
JOIN
JOIN=(1)Join type.
INVITE
INVITE=(2)Invite type.
BE_INVITE
BE_INVITE=(3)Be invite type.
ZIMGroupAttributesUpdateAction
Group attributes update action.
Details
Group attributes update action.
Declared in enums/ZIMGroupAttributesUpdateAction.java
Properties
SET
SET=(0)Set action.
DELETE
DELETE=(1)Delete action.
ZIMGroupBeInviteMode
Verification mode for being invited to the group.
Declared in enums/ZIMGroupBeInviteMode.java
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.
Declared in enum/ZIMGroupEnterType.java
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 enum/ZIMGroupEvent.java
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 enums/ZIMGroupInviteMode.java
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.
Declared in enums/ZIMGroupJoinMode.java
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.
Declared in enum/ZIMGroupMemberEvent.java
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 enum/ZIMGroupMemberState.java
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 enums/ZIMGroupMessageNotificationStatus.java
Properties
NOTIFY
NOTIFY=(1)DISTURB
DISTURB=(2)ZIMGroupMuteMode
Group mute mode.
Details
Group mute mode.
Declared in enums/ZIMGroupMuteMode.java
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.
Declared in enum/ZIMGroupState.java
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 enums/ZIMMediaFileType.java
Properties
ORIGINAL_FILE
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.
LARGE_IMAGE
LARGE_IMAGE=(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].
VIDEO_FIRST_FRAME
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 entity/ZIMMessageDirection.java
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 enums/ZIMMessageMentionedType.java
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.
Declared in enums/ZIMMessageOrder.java
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.
Declared in enums/ZIMMessagePinStatus.java
Properties
NOT_PINNED
NOT_PINNED=(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.
Declared in enums/ZIMMessagePriority.java
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
Declared in entity/ZIMMessageReceiptStatus.java
Properties
UNKNOWN
UNKNOWN=(-1)Receipt unknown status.
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.
Declared in enums/ZIMMessageRepliedInfoState.java
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.
Declared in enums/ZIMMessageType.java
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.
Declared in entity/ZIMMessageSentStatus.java
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 enums/ZIMMessageType.java
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.
Declared in entity/ZIMPlatformType.java
Properties
WIN
WIN=(1)Windows.
IPHONE_OS
IPHONE_OS=(2)iOS.
ANDROID
ANDROID=(3)Android.
MAC_OS
MAC_OS=(4)MacOS.
LINUX
LINUX=(5)Linux.
WEB
WEB=(6)Web.
MINI_PROGRAM
MINI_PROGRAM=(7)Mini program.
IPAD_OS
IPAD_OS=(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.
Declared in enums/ZIMMessageType.java
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 enums/ZIMRoomAttributesUpdateAction.java
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.
Declared in enums/ZIMRoomEvent.java
Properties
SUCCESS
SUCCESS=(0)Success.
NETWORK_INTERRUPTED
NETWORK_INTERRUPTED=(1)The network in the room is temporarily interrupted.
NETWORK_DISCONNECTED
NETWORK_DISCONNECTED=(2)The network in the room is disconnected.
ROOM_NOT_EXIST
ROOM_NOT_EXIST=(3)The room not exist.
ACTIVE_CREATE
ACTIVE_CREATE=(4)The user actively creates a room.
CREATE_FAILED
CREATE_FAILED=(5)Failed to create room.
ACTIVE_ENTER
ACTIVE_ENTER=(6)The user starts to enter the room.
ENTER_FAILED
ENTER_FAILED=(7)user failed to enter the room.
KICKED_OUT
KICKED_OUT=(8)user was kicked out of the room.
CONNNECT_TIMEOUT
CONNNECT_TIMEOUT=(9)connect timeout.
KICKED_OUT_BY_OTHER_DEVICE
KICKED_OUT_BY_OTHER_DEVICE=(10)Multi-device logins into the same room will result in the user being kicked out of the room.
ACTIVE_SWITCH
ACTIVE_SWITCH=(11)Switch room.
SWITCH_FAILED
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 enums/ZIMRoomEvent.java
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.
Declared in enum/ZIMTipsMessageChangeInfoType.java
Properties
GROUP_DATA_CHANGED
GROUP_DATA_CHANGED=(1)Group name, group avatar, and group notice have multiple changes.
GROUP_NOTICE_CHANGED
GROUP_NOTICE_CHANGED=(2)Group notice change event.
GROUP_NAME_CHANGED
GROUP_NAME_CHANGED=(3)Group name change event.
GROUP_AVATAR_URL_CHANGED
GROUP_AVATAR_URL_CHANGED=(4)Group avatar change event.
GROUP_MUTE_CHANGED
GROUP_MUTE_CHANGED=(5)Group mute info change event.
GROUP_OWNER_TRANSFERRED
GROUP_OWNER_TRANSFERRED=(10)Group owner transfer event.
GROUP_MEMBER_ROLE_CHANGED
GROUP_MEMBER_ROLE_CHANGED=(11)Group member role change event.
GROUP_MEMBER_MUTE_CHANGED
GROUP_MEMBER_MUTE_CHANGED=(12)Group member mute info change event.
GROUP_MESSAGE_PIN_INFO_CHANGED
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 enum/ZIMTipsMessageEvent.java
Properties
GROUP_CREATED
GROUP_CREATED=(1)GROUP_DISMISSED
GROUP_DISMISSED=(2)GROUP_JOINED
GROUP_JOINED=(3)GROUP_INVITED
GROUP_INVITED=(4)GROUP_LEFT
GROUP_LEFT=(5)GROUP_KICKED_OUT
GROUP_KICKED_OUT=(6)GROUP_INFO_CHANGED
GROUP_INFO_CHANGED=(7)GROUP_MEMBER_INFO_CHANGED
GROUP_MEMBER_INFO_CHANGED=(8)GROUP_MESSAGE_PINNED
GROUP_MESSAGE_PINNED=(9)ZIMUserOnlineStatus
User online status.
Details
User online status.
Declared in ZIMUserOnlineStatus.java
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.
UNKNOWN
UNKNOWN=(99)Unknown status. Guaranteed enumeration.
ZIMUserRelationType
Friend relationship type.
Declared in enums/ZIMConversationType.java
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.
ZPNsErrorCode
Error code definition.
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 ZPNs.java
Properties
SUCCESS
SUCCESS=(0)Success.
CONNECT_FAILS
CONNECT_FAILS=(6000401)The connection failed. Try again when the network is in good condition.
APPID_KEY_ERROR
APPID_KEY_ERROR=(6000402)The AppID or AppKey is incorrect device provider.
OBTAIN_PUSH_ID_FAILS
OBTAIN_PUSH_ID_FAILS=(6000403)The vendor API reported an error when getting the PushID. Please handle the Error Message according to the content provided by the manufacturer.
REGISTER_FAILS
REGISTER_FAILS=(6000404)An exception occurred in registering Push or other failures occurred. Please handle according to the content provided by the Error Message.
UNREGISTER_FAILS
UNREGISTER_FAILS=(6000405)An exception occurs in the deregistered Push, or other failures occur. Please handle according to the content provided by the Error Message.
ZPNsType
ZPNs message type enumeration class.
Details
ZPNs message type enumeration class.
- Available since: 2.0.0 or later.
Declared in ZPNs.java
Properties
NOTIFICATION_THROUGH
NOTIFICATION_THROUGH=(1)Passthrough message.
NOTIFICATION_CLICK
NOTIFICATION_CLICK=(2)Notification message.
NOTIFICATION_ARRIVED
NOTIFICATION_ARRIVED=(3)