Listener Enums
| Name | Description | Version |
|---|---|---|
| Event.STATE_CHANGED | Connection state listener. Used when configuring a connection listener. | 1.0.0 |
| Event.MESSAGE_RECEIVED | Message receive listener. Used when configuring a message listener. | 1.0.0 |
| Event.CONVERSATION_CHANGED | Conversation change listener. Used when configuring a conversation listener. | 1.0.0 |
Connection Enums
| Name | Description | Version |
|---|---|---|
| ConnectionState.CONNECTED | Connected successfully | 1.0.0 |
| ConnectionState.CONNECTING | Connecting | 1.0.0 |
| ConnectionState.DISCONNECTED | Disconnected. Once this state is reported, the connection is fully closed and the SDK will no longer retry. The application can notify the user that the connection is disconnected. | 1.0.0 |
| ConnectionState.DB_OPENED | Local database opened. Applies only to Electron. | 1.7.0 |
| ConnectionState.DB_CLOSED | Local database closed. Applies only to Electron. | 1.7.0 |
| ConnectionState.RECONNECTING | The SDK is reconnecting internally. By default, it sends a heartbeat every 30s; it reconnects after three consecutive heartbeats receive no server response. It also attempts reconnection when a request, such as sending a message, has no response after 10s. By default, up to 100 retries are made at intervals of 1s, 2s, 4s, 8s, 16s, and so on. | 1.7.0 |
Conversation Enums
| Name | Description | Version |
|---|---|---|
| ConversationType.PRIVATE | One-to-one conversation between two users | 1.0.0 |
| ConversationType.GROUP | Group conversation used for group communication | 1.0.0 |
| ConversationType.CHATROOM | Chatroom conversation, used for room-based communication scenarios such as live streams | 1.0.0 |
| ConversationOrder.FORWARD | Conversation retrieval direction. Conversation lists are sorted by time in descending order; retrieves older conversations. | 1.0.0 |
| ConversationOrder.BACKWARD | Conversation retrieval direction. Conversation lists are sorted by time in descending order; retrieves newer conversations. | 1.0.0 |
Message Enums
| Name | Description | Version |
|---|---|---|
| MessageType.TEXT | Text message | 1.0.0 |
| MessageType.IMAGE | Image message | 1.0.0 |
| MessageType.VOICE | Voice message | 1.0.0 |
| MessageType.VIDEO | Short video message | 1.0.0 |
| MessageType.FILE | File message | 1.0.0 |
| MessageType.RECALL | Recalled message | 1.0.0 |
| MessageType.READ_MSG | Message recall notification | 1.0.0 |
| MessageType.UPDATE_MSG | Message update notification | 1.0.0 |
| MessageOrder.FORWARD | Retrieves newer messages. Use when scrolling the message view toward the input box. | 1.0.0 |
| MessageOrder.BACKWARD | Retrieves older messages. Use when scrolling the message view toward the top. | 1.0.0 |
Status Code Enums
| Name | Description | Version |
|---|---|---|
| ErrorType | Status code enum. See status codes for details. | 1.0.0 |
Mention Message Enums
| Name | Description | Version |
|---|---|---|
| MentionType.ALL | members | 1.0.0 |
| MentionType.SOMEONE | members | 1.0.0 |
| MentionType.ALL_SOMEONE | @all members + @specified members | 1.0.0 |
Conversation Mute Notifications
| Name | Description | Version |
|---|---|---|
| UndisturbType.DISTURB | Mute Notifications | 1.0.0 |
| UndisturbType.UNDISTURB | Disable Mute Notifications | 1.0.0 |
Conversation Marker State
| Name | Description | Version |
|---|---|---|
| UnreadTag.UNREAD | Mark conversation as unread | 1.0.0 |
Message Send State
| Name | Description | Version |
|---|---|---|
| MESSAGE_SENT_STATE.NONE | Initial state | 1.0.0 |
| MESSAGE_SENT_STATE.SENDING | Message is being sent | 1.0.0 |
| MESSAGE_SENT_STATE.SUCCESS | Message sent successfully | 1.0.0 |
| MESSAGE_SENT_STATE.FAILED | Message failed to send | 1.0.0 |
| MESSAGE_SENT_STATE.UPLOADING | Uploading file, image, or other message content | 1.0.0 |
Mention Message Retrieval Direction
| Name | Description | Version |
|---|---|---|
| MENTION_ORDER.BACKWARD | Retrieves older messages. Use when scrolling the message view toward the top. | 1.0.0 |
| MENTION_ORDER.FORWARD | Retrieves newer messages. Use when scrolling the message view toward the input box. | 1.0.0 |
Moments Retrieval Direction
| Name | Description | Version |
|---|---|---|
| MOMENT_ORDER.ASC | Retrieve older Moments | 1.9.6 |
| MOMENT_ORDER.DESC | Retrieve newer Moments | 1.9.6 |
Moments Type Enums
| Name | Description | Version |
|---|---|---|
| MOMENT_TYPE.IMAGE | Image type | 1.9.6 |
| MOMENT_TYPE.VIDEO | Video type | 1.9.6 |
Comment Retrieval Direction
| Name | Description | Version |
|---|---|---|
| COMMENT_ORDER.ASC | Retrieve older comments | 1.9.6 |
| COMMENT_ORDER.DESC | Retrieve newer comments | 1.9.6 |