In-app Chat
On this page

Enum

2026-07-24
ZIMConnectionStateZIMConnectionEvent
ZIMConversationEventZIMConversationListChangeAction
ZIMConversationNotificationStatusZIMConversationType
ZIMConversationSyncStateZIMConversationPinnedFilter
ZIMConversationSearchModeZIMMediaFileType
ZIMMessageDirectionZIMMessageOrder
ZIMMessagePriorityZIMMessageQueryMode
ZIMMessageReceiptStatusZIMMessageReceiptFilterType
ZIMMessageRevokeStatusZIMMessageSentStatus
ZIMMessageTypeZIMRevokeType
ZIMTipsMessageEventZIMTipsMessageChangeInfoType
ZIMMessageMentionedTypeZIMMessageDeleteType
ZIMMessageRepliedInfoStateZIMMessagePinStatus
ZIMMessageReactionUserChangeActionZIMRoomEvent
ZIMRoomStateZIMRoomAttributesUpdateAction
ZIMRoomMemberAttributesUpdateActionZIMGroupState
ZIMGroupEventZIMGroupMemberEvent
ZIMGroupMemberStateZIMGroupMessageNotificationStatus
ZIMGroupAttributesUpdateActionZIMGroupMuteMode
ZIMGroupJoinModeZIMGroupInviteMode
ZIMGroupBeInviteModeZIMGroupEnterType
ZIMGroupApplicationTypeZIMGroupApplicationState
ZIMGroupApplicationListChangeActionZIMCallInvitationMode
ZIMCallStateZIMCallUserState
ZIMUserInfoTypeZIMFriendListChangeAction
ZIMFriendApplicationListChangeActionZIMFriendApplicationType
ZIMFriendApplicationStateZIMFriendRelationCheckType
ZIMFriendDeleteTypeZIMUserRelationType
ZIMBlacklistChangeActionZIMCXHandleType
ZIMGeofencingTypeZIMPlatformType
ZIMUserOnlineStatusZIMListChangeAction
ZIMCommunityListChangeActionZIMCommunityMemberEnterType
ZIMCommunityMemberChangeStateZIMCommunityMemberChangeAction
ZIMCommunityChannelTypeZIMCommunityChannelListChangeAction
ZIMCommunityChannelMuteModeZIMCommunityMemberMuteType
ZIMCommunityMessageNotificationStatus

ZIMConnectionState

Connection state.

Details

Connection state.

Declared in enums/ZIMConnectionState.java

Properties

DISCONNECTED

DISCONNECTED
DISCONNECTED=(0)

Unconnected state, enter this state before logging in and after logging out.

CONNECTING

CONNECTING
CONNECTING=(1)

The state that the connection is being requested. It will enter this state after successful execution login function.

CONNECTED

CONNECTED
CONNECTED=(2)

The state that is successfully connected.

RECONNECTING

RECONNECTING
RECONNECTING=(3)

The connection is being reconnected.

ZIMConnectionEvent

The event that caused the connection status to change.

Details

The event that caused the connection status to change.

Declared in enums/ZIMConnectionEvent.java

Properties

SUCCESS

SUCCESS
SUCCESS=(0)

Success.

ACTIVE_LOGIN

ACTIVE_LOGIN
ACTIVE_LOGIN=(1)

The user actively logs in.

LOGIN_TIMEOUT

LOGIN_TIMEOUT
LOGIN_TIMEOUT=(2)

Connection timed out.

LOGIN_INTERRUPTED

LOGIN_INTERRUPTED
LOGIN_INTERRUPTED=(3)

The network connection is temporarily interrupted.

KICKED_OUT

KICKED_OUT
KICKED_OUT=(4)

Being kicked out.

TOKEN_EXPIRED

TOKEN_EXPIRED
TOKEN_EXPIRED=(5)

Detail description: Disconnected due to expired login token.

UNREGISTERED

UNREGISTERED
UNREGISTERED=(6)

The user account was unregistered.

ZIMConversationEvent

conversation changed event.

Details

conversation changed event.

Declared in enums/ZIMConversationEvent.java

Properties

ADDED

ADDED
ADDED=(0)

A new conversation was added.

UPDATED

UPDATED
UPDATED=(1)

The conversation was updated.

DISABLED

DISABLED
DISABLED=(2)

The conversation was disabled.

DELETED

DELETED
DELETED=(3)

The conversation was deleted.

ZIMConversationListChangeAction

Conversation list change action.

Details

Conversation list change action.

Declared in enums/ZIMConversationListChangeAction.java

Properties

ADDED

ADDED
ADDED=(0)

A conversation was added to the list.

DELETED

DELETED
DELETED=(1)

A conversation was deleted from the list.

UPDATED

UPDATED
UPDATED=(2)

A conversation in the list was updated.

ZIMConversationNotificationStatus

Enumeration of conversation notification status.

Details

Enumeration of conversation notification status.

Declared in enums/ZIMConversationNotificationStatus.java

Properties

NOTIFY

NOTIFY
NOTIFY=(1)

Message notifications are enabled.

DO_NOT_DISTURB

DO_NOT_DISTURB
DO_NOT_DISTURB=(2)

Do not disturb mode is enabled.

ZIMConversationType

Conversation type.

Details

Conversation type.

Declared in enums/ZIMConversationType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown conversation type.

PEER

PEER
PEER=(0)

Conversation type peer.

ROOM

ROOM
ROOM=(1)

Conversation type room.

GROUP

GROUP
GROUP=(2)

Conversation type group.

COMMUNITY_CHANNEL

COMMUNITY_CHANNEL
COMMUNITY_CHANNEL=(3)

Community channel conversation type.

ZIMConversationSyncState

Identifies the SDK's state in syncing conversation list from server.

Details

Identifies the SDK's state in syncing conversation list from server.

Declared in enums/ZIMConversationSyncState.java

Properties

STARTED

STARTED
STARTED=(0)

Conversation list synchronization start status

FINISHED

FINISHED
FINISHED=(1)

Conversation list synchronization completion status

FAILED

FAILED
FAILED=(2)

The synchronization of the conversation list failed. The synchronization failure may be caused by network reasons.

ZIMConversationPinnedFilter

When a user queries the session list, it serves as a filter item for the top session of the query.

Details

When a user queries the session list, it serves as a filter item for the top session of the query.

Declared in enums/ZIMConversationPinnedFilter.java

Properties

ALL

ALL
ALL=(0)

Both pinned and unpinned conversations can be queried.

ONLY_PINNED

ONLY_PINNED
ONLY_PINNED=(1)

Only pinned conversations can be queried.

ONLY_UNPINNED

ONLY_UNPINNED
ONLY_UNPINNED=(2)

Only unpinned conversations can be queried.

ZIMConversationSearchMode

Conversational search mode.

Details

Conversational search mode.

Declared in enums/ZIMConversationSearchMode.java

Properties

MATCH_MESSAGE

MATCH_MESSAGE
MATCH_MESSAGE=(0)

Query the corresponding conversation by searching for messages that meet the criteria.

MATCH_CONVERSATION_NAME

MATCH_CONVERSATION_NAME
MATCH_CONVERSATION_NAME=(1)

Query the corresponding conversation by searching for the conversation name.

ZIMMediaFileType

Media file type

Details

Media file type

Declared in enums/ZIMMediaFileType.java

Properties

ORIGINAL_FILE

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
LARGE_IMAGE=(2)

Large image type. After calling [downloadMediaFile], the SDK will update the largeImageLocalPath property in [ZIMImageMessage].

THUMBNAIL

THUMBNAIL
THUMBNAIL=(3)

Image thumbnail type. After calling [downloadMediaFile], the SDK will update the thumbnailLocalPath property in [ZIMImageMessage].

VIDEO_FIRST_FRAME

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

the direction of the message.

Declared in enums/ZIMMessageDirection.java

Properties

SEND

SEND
SEND=(0)

The message was sent by the local user.

RECEIVE

RECEIVE
RECEIVE=(1)

The message was received by the local user.

ZIMMessageOrder

Message order.

Details

Message order.

Declared in enums/ZIMMessageOrder.java

Properties

DESCENDING

DESCENDING
DESCENDING=(0)

Represents message list in descending order (message list order is from new to old).

ASCENDING

ASCENDING
ASCENDING=(1)

Represents message list in ascending order (message list order is from old to new).

ZIMMessagePriority

The priority of the message.

Details

The priority of the message.

Declared in enums/ZIMMessagePriority.java

Properties

LOW

LOW
LOW=(1)

Low priority.

MEDIUM

MEDIUM
MEDIUM=(2)

Medium priority.

HIGH

HIGH
HIGH=(3)

High priority.

ZIMMessageQueryMode

.

Details

.

Declared in enums/ZIMMessageQueryMode.java

Properties

GENERAL

GENERAL
GENERAL=(0)

General mode. In this mode, the SDK automatically determines whether it needs to request merged message data from the server. This mode is recommended for most common scenarios.

PREFER_SERVER

PREFER_SERVER
PREFER_SERVER=(1)

Server-priority query mode.

ONLY_LOCAL

ONLY_LOCAL
ONLY_LOCAL=(2)

Local-messages-only query mode.

ZIMMessageReceiptStatus

The status of the receipt

Details

The status of the receipt

Declared in enums/ZIMMessageReceiptStatus.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown receipt status.

NONE

NONE
NONE=(0)

Not a receipt.

PROCESSING

PROCESSING
PROCESSING=(1)

Receipt in progress.

DONE

DONE
DONE=(2)

Receipt completed.

EXPIRED

EXPIRED
EXPIRED=(3)

Receipt has expired.

FAILED

FAILED
FAILED=(4)

Receipt failed.

DELIVERED

DELIVERED
DELIVERED=(5)

Receipt delivered.

ZIMMessageReceiptFilterType

Filter type for the message receipt member list.

Details

Filter type for the message receipt member list.

Declared in enums/ZIMMessageReceiptFilterType.java

Properties

READ

READ
READ=(0)

Read members.

UNREAD

UNREAD
UNREAD=(1)

Unread members.

DELIVERED

DELIVERED
DELIVERED=(2)

Delivered members.

ZIMMessageRevokeStatus

Message revoke status

Details

Message revoke status

Declared in enums/ZIMMessageRevokeStatus.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown revoke status.

SELF_REVOKE

SELF_REVOKE
SELF_REVOKE=(0)

The message was revoked by the sender.

SYSTEM_REVOKE

SYSTEM_REVOKE
SYSTEM_REVOKE=(1)

The message was revoked by the system.

SERVER_API_REVOKE

SERVER_API_REVOKE
SERVER_API_REVOKE=(2)

The message was revoked via the server API.

GROUP_ADMIN_REVOKE

GROUP_ADMIN_REVOKE
GROUP_ADMIN_REVOKE=(3)

The message was revoked by a group administrator.

GROUP_OWNER_REVOKE

GROUP_OWNER_REVOKE
GROUP_OWNER_REVOKE=(4)

The message was revoked by the group owner.

AUDIT_REJECT_REVOKE

AUDIT_REJECT_REVOKE
AUDIT_REJECT_REVOKE=(5)

Revoked for audit reject.

ZIMMessageSentStatus

The status of the message being sent.

Details

The status of the message being sent.

Declared in enums/ZIMMessageSentStatus.java

Properties

SENDING

SENDING
SENDING=(0)

The message is being sent.

SUCCESS

SUCCESS
SUCCESS=(1)

The message was sent successfully.

FAILED

FAILED
FAILED=(2)

The message failed to send.

ZIMMessageType

The type of the message.

Details

The type of the message.

Declared in enums/ZIMMessageType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(0)

Unknown message.

TEXT

TEXT
TEXT=(1)

Normal text message.

COMMAND

COMMAND
COMMAND=(2)

Custom binary message.

MULTIPLE

MULTIPLE
MULTIPLE=(10)

Multiple messages can be used to send multiple messages of text, rich media files, and custom messages.

IMAGE

IMAGE
IMAGE=(11)

Image message.

FILE

FILE
FILE=(12)

File message.

AUDIO

AUDIO
AUDIO=(13)

Audio message.

VIDEO

VIDEO
VIDEO=(14)

Video message.

BARRAGE

BARRAGE
BARRAGE=(20)

Barrage message.

REVOKE

REVOKE
REVOKE=(31)

Reovked message.

TIPS

TIPS
TIPS=(32)

Tips message.

COMBINE

COMBINE
COMBINE=(100)

Combined message.

CUSTOM

CUSTOM
CUSTOM=(200)

Custom message.

ZIMRevokeType

The type of the revoke message.

Details

The type of the revoke message.

Declared in enums/ZIMRevokeType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown revoke type.

TWO_WAY

TWO_WAY
TWO_WAY=(0)

Two-way revoke: the message is deleted for both sender and recipient.

ONE_WAY

ONE_WAY
ONE_WAY=(1)

One-way revoke: the message is deleted for the sender only.

ZIMTipsMessageEvent

Event of tips message.

Details

Event of tips message.

Declared in enums/ZIMTipsMessageEvent.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(0)

Unknown tips message event.

GROUP_CREATED

GROUP_CREATED
GROUP_CREATED=(1)

The group was created.

GROUP_DISMISSED

GROUP_DISMISSED
GROUP_DISMISSED=(2)

The group was dismissed.

GROUP_JOINED

GROUP_JOINED
GROUP_JOINED=(3)

A member joined the group.

GROUP_INVITED

GROUP_INVITED
GROUP_INVITED=(4)

A member was invited to join the group.

GROUP_LEFT

GROUP_LEFT
GROUP_LEFT=(5)

A member left the group.

GROUP_KICKED_OUT

GROUP_KICKED_OUT
GROUP_KICKED_OUT=(6)

A member was kicked out of the group.

GROUP_INFO_CHANGED

GROUP_INFO_CHANGED
GROUP_INFO_CHANGED=(7)

The group information was changed.

GROUP_MEMBER_INFO_CHANGED

GROUP_MEMBER_INFO_CHANGED
GROUP_MEMBER_INFO_CHANGED=(8)

The group member information was changed.

GROUP_MESSAGE_PINNED

GROUP_MESSAGE_PINNED
GROUP_MESSAGE_PINNED=(9)

A group message was pinned.

COMMUNITY_CREATED

COMMUNITY_CREATED
COMMUNITY_CREATED=(101)

The community was created.

COMMUNITY_JOINED

COMMUNITY_JOINED
COMMUNITY_JOINED=(103)

A member joined the community.

COMMUNITY_INVITED

COMMUNITY_INVITED
COMMUNITY_INVITED=(104)

A member was invited to join the community.

COMMUNITY_CHANNEL_CREATED

COMMUNITY_CHANNEL_CREATED
COMMUNITY_CHANNEL_CREATED=(151)

A community channel was created.

ZIMTipsMessageChangeInfoType

Type of additional information for tips messages.

Details

Type of additional information for tips messages.

Declared in enums/ZIMTipsMessageChangeInfoType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(0)

Unknown change info type.

GROUP_DATA_CHANGED

GROUP_DATA_CHANGED
GROUP_DATA_CHANGED=(1)

Group name, group avatar, and group notice have multiple changes.

GROUP_NOTICE_CHANGED

GROUP_NOTICE_CHANGED
GROUP_NOTICE_CHANGED=(2)

Group notice change event.

GROUP_NAME_CHANGED

GROUP_NAME_CHANGED
GROUP_NAME_CHANGED=(3)

Group name change event.

GROUP_AVATAR_URL_CHANGED

GROUP_AVATAR_URL_CHANGED
GROUP_AVATAR_URL_CHANGED=(4)

Group avatar change event.

GROUP_MUTE_CHANGED

GROUP_MUTE_CHANGED
GROUP_MUTE_CHANGED=(5)

Group mute info change event.

GROUP_OWNER_TRANSFERRED

GROUP_OWNER_TRANSFERRED
GROUP_OWNER_TRANSFERRED=(10)

Group owner transfer event.

GROUP_MEMBER_ROLE_CHANGED

GROUP_MEMBER_ROLE_CHANGED
GROUP_MEMBER_ROLE_CHANGED=(11)

Group member role change event.

GROUP_MEMBER_MUTE_CHANGED

GROUP_MEMBER_MUTE_CHANGED
GROUP_MEMBER_MUTE_CHANGED=(12)

The group member mute status changed.

GROUP_MESSAGE_PIN_INFO_CHANGED

GROUP_MESSAGE_PIN_INFO_CHANGED
GROUP_MESSAGE_PIN_INFO_CHANGED=(21)

Group messages are pinned or unpinned event.

ZIMMessageMentionedType

The type of the revoke message.

Details

The type of the revoke message.

Declared in enums/ZIMMessageMentionedType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(0)

Unknown mention type.

MENTION_ME

MENTION_ME
MENTION_ME=(1)

mention me

MENTION_ALL

MENTION_ALL
MENTION_ALL=(2)

mention all user

MENTION_ALL_AND_ME

MENTION_ALL_AND_ME
MENTION_ALL_AND_ME=(3)

mention all user and mention me

ZIMMessageDeleteType

Message deleted type

Details

Message deleted type

Declared in enums/ZIMMessageDeleteType.java

Properties

MESSAGE_LIST_DELETED

MESSAGE_LIST_DELETED
MESSAGE_LIST_DELETED=(0)

User-initiated message deletion event.

CONVERSATION_ALL_MESSAGES_DELETED

CONVERSATION_ALL_MESSAGES_DELETED
CONVERSATION_ALL_MESSAGES_DELETED=(1)

User-initiated event for deleting all messages in a conversation.

ALL_CONVERSATION_MESSAGES_DELETED

ALL_CONVERSATION_MESSAGES_DELETED
ALL_CONVERSATION_MESSAGES_DELETED=(2)

User-initiated event for deleting all messages across all conversations.

MESSAGES_DESTRUCTED

MESSAGES_DESTRUCTED
MESSAGES_DESTRUCTED=(3)

Message deletion event triggered by scheduled message self-destruction.

ZIMMessageRepliedInfoState

The state of the source message to be replied.

Details

The state of the source message to be replied.

Declared in enums/ZIMMessageRepliedInfoState.java

Properties

NORMAL

NORMAL
NORMAL=(0)

normal state.

DELETED

DELETED
DELETED=(1)

deleted state.

NOT_FOUND

NOT_FOUND
NOT_FOUND=(2)

Not found. The original message may have expired on the server or is not visible to the current user.

ZIMMessagePinStatus

Enumeration of message pinned status.

Details

Enumeration of message pinned status.

Declared in enums/ZIMMessagePinStatus.java

Properties

NOT_PINNED

NOT_PINNED
NOT_PINNED=(0)

The message is not pinned.

PINNED

PINNED
PINNED=(1)

The message is pinned.

UPDATED

UPDATED
UPDATED=(2)

The message pin status was updated.

ZIMMessageReactionUserChangeAction

User operation action for message reactions.

Details

User operation action for message reactions.

Declared in enums/ZIMMessageReactionUserChangeAction.java

Properties

ADDED

ADDED
ADDED=(0)

Add message reaction.

DELETED

DELETED
DELETED=(1)

Delete message reaction.

ZIMRoomEvent

The event that caused the room connection status to change.

Details

The event that caused the room connection status to change.

Declared in enums/ZIMRoomEvent.java

Properties

SUCCESS

SUCCESS
SUCCESS=(0)

Success.

NETWORK_INTERRUPTED

NETWORK_INTERRUPTED
NETWORK_INTERRUPTED=(1)

The network in the room is temporarily interrupted.

NETWORK_DISCONNECTED

NETWORK_DISCONNECTED
NETWORK_DISCONNECTED=(2)

The network in the room is disconnected.

ROOM_NOT_EXIST

ROOM_NOT_EXIST
ROOM_NOT_EXIST=(3)

The room not exist.

ACTIVE_CREATE

ACTIVE_CREATE
ACTIVE_CREATE=(4)

The user actively creates a room.

CREATE_FAILED

CREATE_FAILED
CREATE_FAILED=(5)

Failed to create room.

ACTIVE_ENTER

ACTIVE_ENTER
ACTIVE_ENTER=(6)

The user starts to enter the room.

ENTER_FAILED

ENTER_FAILED
ENTER_FAILED=(7)

user failed to enter the room.

KICKED_OUT

KICKED_OUT
KICKED_OUT=(8)

user was kicked out of the room.

CONNECT_TIMEOUT

CONNECT_TIMEOUT
CONNECT_TIMEOUT=(9)

The connection to the room timed out.

KICKED_OUT_BY_OTHER_DEVICE

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
ACTIVE_SWITCH=(11)

Switch room.

SWITCH_FAILED

SWITCH_FAILED
SWITCH_FAILED=(12)

Switch room failed.

ZIMRoomState

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

Details

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

Declared in enums/ZIMRoomState.java

Properties

DISCONNECTED

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
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
CONNECTED=(2)

connected indicates that the device is properly connected to the room. If create, join, or enter room succeeds, the state will be thrown if the network is disconnected and the room heartbeat does not time out.

ZIMRoomAttributesUpdateAction

Room attributes update action.

Details

Room attributes update action.

Declared in enums/ZIMRoomAttributesUpdateAction.java

Properties

SET

SET
SET=(0)

Set action.

DELETE

DELETE
DELETE=(1)

Delete the room attributes.

ZIMRoomMemberAttributesUpdateAction

The action type for room member attribute updates.

Details

The action type for room member attribute updates.

Declared in enums/ZIMRoomMemberAttributesUpdateAction.java

Properties

SET

SET
SET=(0)

Set the room member attributes.

ZIMGroupState

group status.

Details

group status.

Declared in enums/ZIMGroupState.java

Properties

QUIT

QUIT
QUIT=(0)

The local user has left the group.

ENTER

ENTER
ENTER=(1)

The local user has entered the group.

ZIMGroupEvent

Group events.

Details

Group events.

Declared in enums/ZIMGroupEvent.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown event.

CREATED

CREATED
CREATED=(1)

The group was created.

DISMISSED

DISMISSED
DISMISSED=(2)

The group was dismissed.

JOINED

JOINED
JOINED=(3)

A member joined the group.

INVITED

INVITED
INVITED=(4)

A member was invited to join the group.

LEFT

LEFT
LEFT=(5)

A member left the group.

KICKED_OUT

KICKED_OUT
KICKED_OUT=(6)

A member was kicked out of the group.

ZIMGroupMemberEvent

Group member events.

Details

Group member events.

Declared in enums/ZIMGroupMemberEvent.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown event.

JOINED

JOINED
JOINED=(1)

A member joined the group.

LEFT

LEFT
LEFT=(2)

A member left the group.

KICKED_OUT

KICKED_OUT
KICKED_OUT=(4)

A member was kicked out of the group.

INVITED

INVITED
INVITED=(5)

A member was invited to join the group.

ZIMGroupMemberState

group membership status.

Details

group membership status.

Declared in enums/ZIMGroupMemberState.java

Properties

QUIT

QUIT
QUIT=(0)

The member has left the group.

ENTER

ENTER
ENTER=(1)

The member has entered the group.

ZIMGroupMessageNotificationStatus

Enumeration of group notification status.

Details

Enumeration of group notification status.

Declared in enums/ZIMGroupMessageNotificationStatus.java

Properties

NOTIFY

NOTIFY
NOTIFY=(1)

Message notifications are enabled.

DO_NOT_DISTURB

DO_NOT_DISTURB
DO_NOT_DISTURB=(2)

Do not disturb mode is enabled.

ZIMGroupAttributesUpdateAction

Group attributes update action.

Details

Group attributes update action.

Declared in enums/ZIMGroupAttributesUpdateAction.java

Properties

SET

SET
SET=(0)

Set action.

DELETE

DELETE
DELETE=(1)

Delete the group attributes.

ZIMGroupMuteMode

Group mute mode.

Details

Group mute mode.

Declared in enums/ZIMGroupMuteMode.java

Properties

NONE

NONE
NONE=(0)

Unmute.

NORMAL

NORMAL
NORMAL=(1)

Group normal members mute mode.

ALL

ALL
ALL=(2)

Group all members mute mode.

CUSTOM

CUSTOM
CUSTOM=(3)

Customize group mute mode

ZIMGroupJoinMode

Verification mode for joining the group.

Details

Verification mode for joining the group.

Declared in enums/ZIMGroupJoinMode.java

Properties

ANY

ANY
ANY=(0)

Anyone can join the group directly.

AUTH

AUTH
AUTH=(1)

Requires group owner or administrator approval.

FORBID

FORBID
FORBID=(2)

Joining the group is prohibited.

ZIMGroupInviteMode

Verification mode for invite to the group.

Details

Verification mode for invite to the group.

Declared in enums/ZIMGroupInviteMode.java

Properties

ANY

ANY
ANY=(0)

Everyone in the group can invite.

ADMIN

ADMIN
ADMIN=(1)

Only group owners or administrators can invite.

ZIMGroupBeInviteMode

Verification mode for being invited to the group.

Details

Verification mode for being invited to the group.

Declared in enums/ZIMGroupBeInviteMode.java

Properties

NONE

NONE
NONE=(0)

The invitees enter the group directly.

AUTH

AUTH
AUTH=(1)

The invitee's consent is required to join the group.

ZIMGroupEnterType

Group enter type.

Details

Group enter type.

Declared in enums/ZIMGroupEnterType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(0)

Unknown enter type.

CREATED

CREATED
CREATED=(1)

The user created the group.

JOIN_APPLY

JOIN_APPLY
JOIN_APPLY=(2)

The user joined the group via an application.

JOINED

JOINED
JOINED=(3)

The user actively joined the group.

INVITED

INVITED
INVITED=(4)

The user was invited to join the group.

INVITE_APPLY

INVITE_APPLY
INVITE_APPLY=(5)

The user joined the group via invitation application.

ZIMGroupApplicationType

Group application type.

Details

Group application type.

Declared in enums/ZIMGroupApplicationType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown group application type.

NONE

NONE
NONE=(0)

None.

JOIN

JOIN
JOIN=(1)

Join type.

INVITE

INVITE
INVITE=(2)

Invite type.

BE_INVITE

BE_INVITE
BE_INVITE=(3)

Be invite type.

ZIMGroupApplicationState

Group application state.

Details

Group application state.

Declared in enums/ZIMGroupApplicationState.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown group application state.

WAITING

WAITING
WAITING=(1)

Awaiting response.

ACCEPTED

ACCEPTED
ACCEPTED=(2)

Accepted.

REJECTED

REJECTED
REJECTED=(3)

Rejected.

EXPIRED

EXPIRED
EXPIRED=(4)

Expired.

DISABLED

DISABLED
DISABLED=(5)

Disabled

ZIMGroupApplicationListChangeAction

Group application list update action.

Details

Group application list update action.

Declared in enums/ZIMGroupApplicationListChangeAction.java

Properties

ADDED

ADDED
ADDED=(0)

Add action.

ZIMCallInvitationMode

Call invitation mode.

Details

Call invitation mode.

Declared in enums/ZIMCallInvitationMode.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown type, as a guaranteed enumeration value.

GENERAL

GENERAL
GENERAL=(0)

general.

ADVANCED

ADVANCED
ADVANCED=(1)

advanced

ZIMCallState

call status.

Details

call status.

Declared in enums/ZIMCallState.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown call state.

STARTED

STARTED
STARTED=(1)

The call has started.

ENDED

ENDED
ENDED=(2)

The call has ended.

ZIMCallUserState

Call user status.

Details

Call user status.

Declared in enums/ZIMCallUserState.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

unknown

INVITING

INVITING
INVITING=(0)

inviting.

ACCEPTED

ACCEPTED
ACCEPTED=(1)

accepted.

REJECTED

REJECTED
REJECTED=(2)

rejected.

CANCELLED

CANCELLED
CANCELLED=(3)

cancelled.

RECEIVED

RECEIVED
RECEIVED=(5)

received.

TIMEOUT

TIMEOUT
TIMEOUT=(6)

timeout.

QUIT

QUIT
QUIT=(7)

quit.

ENDED

ENDED
ENDED=(8)

ended.

NOT_YET_RECEIVED

NOT_YET_RECEIVED
NOT_YET_RECEIVED=(9)

Not received.

BE_CANCELLED

BE_CANCELLED
BE_CANCELLED=(10)

Be cancelled.

ZIMUserInfoType

User type.

Details

User type.

Declared in enums/ZIMUserInfoType.java

Properties

BASIC_USER

BASIC_USER
BASIC_USER=(1)

Basic user type.

ROOM_MEMBER

ROOM_MEMBER
ROOM_MEMBER=(2)

Room member type.

GROUP_MEMBER

GROUP_MEMBER
GROUP_MEMBER=(3)

Group member type.

GROUP_SIMPLE_MEMBER

GROUP_SIMPLE_MEMBER
GROUP_SIMPLE_MEMBER=(4)

Group member brief info type.

FRIEND

FRIEND
FRIEND=(5)

Friend type.

COMMUNITY_MEMBER

COMMUNITY_MEMBER
COMMUNITY_MEMBER=(6)

Community member type.

COMMUNITY_SIMPLE_MEMBER

COMMUNITY_SIMPLE_MEMBER
COMMUNITY_SIMPLE_MEMBER=(7)

Community member brief info type.

ZIMFriendListChangeAction

friend list update action.

Details

friend list update action.

Declared in enums/ZIMFriendListChangeAction.java

Properties

ADDED

ADDED
ADDED=(0)

Add action.

DELETED

DELETED
DELETED=(1)

Delete action.

ZIMFriendApplicationListChangeAction

friend application list update action.

Details

friend application list update action.

Declared in enums/ZIMFriendApplicationListChangeAction.java

Properties

ADDED

ADDED
ADDED=(0)

Add action.

DELETED

DELETED
DELETED=(1)

Delete action.

ZIMFriendApplicationType

Friend application type.

Details

Friend application type.

Declared in enums/ZIMFriendApplicationType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown friend application type.

NONE

NONE
NONE=(0)

Friend application type none.

RECEIVED

RECEIVED
RECEIVED=(1)

Applications received.

SENT

SENT
SENT=(2)

Application sent.

BOTH

BOTH
BOTH=(3)

Both parties sent friend applications to each other.

ZIMFriendApplicationState

Friend application state.

Details

Friend application state.

Declared in enums/ZIMFriendApplicationState.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown friend application state.

WAITING

WAITING
WAITING=(1)

Awaiting response.

ACCEPTED

ACCEPTED
ACCEPTED=(2)

Accepted.

REJECTED

REJECTED
REJECTED=(3)

Rejected.

EXPIRED

EXPIRED
EXPIRED=(4)

The friend application has expired.

DISABLED

DISABLED
DISABLED=(5)

The friend application is disabled.

ZIMFriendRelationCheckType

Check the friend relationship type.

Details

Check the friend relationship type.

Declared in enums/ZIMFriendRelationCheckType.java

Properties

BOTH

BOTH
BOTH=(0)

Check the friend relationship from both sides.

SINGLE

SINGLE
SINGLE=(1)

Check the friend relationship from one side only.

ZIMFriendDeleteType

Delete friend type.

Details

Delete friend type.

Declared in enums/ZIMFriendDeleteType.java

Properties

BOTH

BOTH
BOTH=(0)

Delete the friend from both sides.

SINGLE

SINGLE
SINGLE=(1)

Delete the friend from one side only.

ZIMUserRelationType

Friend relationship type.

Details

Friend relationship type.

Declared in enums/ZIMUserRelationType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(0)

Unknown relation type.

SINGLE_NO

SINGLE_NO
SINGLE_NO=(1)

No friendship from the user's perspective.

SINGLE_HAVE

SINGLE_HAVE
SINGLE_HAVE=(2)

Friendship exists from the user's perspective.

BOTH_ALL_NO

BOTH_ALL_NO
BOTH_ALL_NO=(3)

No friendship from either side.

BOTH_SELF_HAVE

BOTH_SELF_HAVE
BOTH_SELF_HAVE=(4)

The user has added the other as a friend, but not vice versa.

BOTH_OTHER_HAVE

BOTH_OTHER_HAVE
BOTH_OTHER_HAVE=(5)

The other party has added the user as a friend, but not vice versa.

BOTH_ALL_HAVE

BOTH_ALL_HAVE
BOTH_ALL_HAVE=(6)

Both parties are friends with each other.

ZIMBlacklistChangeAction

blacklist update action.

Details

blacklist update action.

Declared in enums/ZIMBlacklistChangeAction.java

Properties

ADDED

ADDED
ADDED=(0)

Add action.

REMOVED

REMOVED
REMOVED=(1)

Removed action.

ZIMCXHandleType

Type of contact information for the VoIP initiator.

Details

Type of contact information for the VoIP initiator.

Declared in enums/ZIMCXHandleType.java

Properties

GENERIC

GENERIC
GENERIC=(1)

Generic handle type.

PHONE_NUMBER

PHONE_NUMBER
PHONE_NUMBER=(2)

Phone number handle type.

EMAIL_ADDRESS

EMAIL_ADDRESS
EMAIL_ADDRESS=(3)

Email address handle type.

ZIMGeofencingType

Geofencing type.

Details

Geofencing type.

Declared in enums/ZIMGeofencingType.java

Properties

NONE

NONE
NONE=(0)

The default type.

INCLUDE

INCLUDE
INCLUDE=(1)

Federated mode.

EXCLUDE

EXCLUDE
EXCLUDE=(2)

Exclusion mode.

ZIMPlatformType

Platform on which the SDK runs.

Details

Platform on which the SDK runs.

Declared in enums/ZIMPlatformType.java

Properties

WIN

WIN
WIN=(1)

Windows.

I_PHONE_O_S

I_PHONE_O_S
I_PHONE_O_S=(2)

iOS.

ANDROID

ANDROID
ANDROID=(3)

Android.

MAC_O_S

MAC_O_S
MAC_O_S=(4)

MacOS.

LINUX

LINUX
LINUX=(5)

Linux.

WEB

WEB
WEB=(6)

Web.

MINI_PROGRAM

MINI_PROGRAM
MINI_PROGRAM=(7)

Mini program.

I_PAD_O_S

I_PAD_O_S
I_PAD_O_S=(9)

iPad.

O_H_O_S

O_H_O_S
O_H_O_S=(10)

HarmonyOS (OHOS) platform.

UNKNOWN

UNKNOWN
UNKNOWN=(32)

Platforms not mentioned above.

ZIMUserOnlineStatus

User online status.

Details

User online status.

Declared in enums/ZIMUserOnlineStatus.java

Properties

ONLINE

ONLINE
ONLINE=(0)

Online. The user is in this state when the user is logged in and the network status is good.

OFFLINE

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
LOGOUT=(2)

Log out. User active logout will be in this state.

UNKNOWN

UNKNOWN
UNKNOWN=(99)

Unknown status. Guaranteed enumeration.

ZIMListChangeAction

The action type for list changes.

Details

The action type for list changes.

Declared in enums/ZIMListChangeAction.java

Properties

ADDED

ADDED
ADDED=(0)

An item was added.

DELETED

DELETED
DELETED=(1)

An item was deleted.

ZIMCommunityListChangeAction

The action type for community list changes.

Details

The action type for community list changes.

Declared in enums/ZIMCommunityListChangeAction.java

Properties

ADDED

ADDED
ADDED=(0)

A community was added.

DELETED

DELETED
DELETED=(1)

A community was deleted.

UPDATED

UPDATED
UPDATED=(2)

A community was updated.

ZIMCommunityMemberEnterType

The enter type for community members.

Details

The enter type for community members.

Declared in enums/ZIMCommunityMemberEnterType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(0)

Unknown enter type.

COMMUNITY_CREATED

COMMUNITY_CREATED
COMMUNITY_CREATED=(1)

The member joined when the community was created.

COMMUNITY_JOINED

COMMUNITY_JOINED
COMMUNITY_JOINED=(2)

The member actively joined the community.

COMMUNITY_INVITED

COMMUNITY_INVITED
COMMUNITY_INVITED=(3)

The member was invited to join the community.

ZIMCommunityMemberChangeState

The state change type for community members.

Details

The state change type for community members.

Declared in enums/ZIMCommunityMemberChangeState.java

Properties

EXITED

EXITED
EXITED=(0)

The member exited the community.

ENTERED

ENTERED
ENTERED=(1)

The member entered the community.

ZIMCommunityMemberChangeAction

The action type for community member status changes.

Details

The action type for community member status changes.

Declared in enums/ZIMCommunityMemberChangeAction.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(0)

Unknown action.

JOINED

JOINED
JOINED=(1)

The member actively joined the community.

INVITED

INVITED
INVITED=(2)

The member was invited to join the community.

LEFT

LEFT
LEFT=(3)

The member actively left the community.

KICKED_OUT

KICKED_OUT
KICKED_OUT=(4)

The member was kicked out of the community.

ZIMCommunityChannelType

The type of community channel.

Details

The type of community channel.

Declared in enums/ZIMCommunityChannelType.java

Properties

UNKNOWN

UNKNOWN
UNKNOWN=(-1)

Unknown channel.

GENERAL

GENERAL
GENERAL=(0)

Default channel, automatically created when the community is created.

PUBLIC

PUBLIC
PUBLIC=(1)

Public channel, visible to all members of the community.

PRIVATE

PRIVATE
PRIVATE=(2)

Private channel, visible only to specific members.

ZIMCommunityChannelListChangeAction

The action type for community channel list changes.

Details

The action type for community channel list changes.

Declared in enums/ZIMCommunityChannelListChangeAction.java

Properties

ADDED

ADDED
ADDED=(0)

A community channel was added.

DELETED

DELETED
DELETED=(1)

A community channel was deleted.

UPDATED

UPDATED
UPDATED=(2)

A community channel was updated.

ZIMCommunityChannelMuteMode

The mute mode for community channels.

Details

The mute mode for community channels.

Declared in enums/ZIMCommunityChannelMuteMode.java

Properties

NONE

NONE
NONE=(0)

No mute mode.

NORMAL

NORMAL
NORMAL=(1)

Normal mute mode; only administrators and the owner can speak.

ALL

ALL
ALL=(2)

All members are muted.

CUSTOM

CUSTOM
CUSTOM=(3)

Custom mute mode.

ZIMCommunityMemberMuteType

The mute type for community members.

Details

The mute type for community members.

Declared in enums/ZIMCommunityMemberMuteType.java

Properties

NONE

NONE
NONE=(0)

Not muted.

COMMUNITY

COMMUNITY
COMMUNITY=(1)

Muted at the community level.

CHANNEL

CHANNEL
CHANNEL=(2)

Muted at the community channel level.

ZIMCommunityMessageNotificationStatus

The notification status for community messages.

Details

The notification status for community messages.

Declared in enums/ZIMCommunityMessageNotificationStatus.java

Properties

NOTIFY

NOTIFY
NOTIFY=(1)

Message notifications are enabled.

DO_NOT_DISTURB

DO_NOT_DISTURB
DO_NOT_DISTURB=(2)

Do not disturb mode is enabled.

Previous

Struct

Next

Function Overview

On this page

Back to top