Exclude robot members
Only include robot members
Speech-to-text conversion status
Not converted
Converting
Conversion succeeded
Conversion failed
Translation mode
Mechanical translation
Intelligent translation
Translation status
Not translated
Translating
Translation succeeded
Translation failed
Auto-translation strategy for a conversation
Follow the user-level setting (default)
Enable auto-translation
Disable auto-translation
Area code enum value
China (Beijing) data center
Default value: Singapore data center
North America data center
Regional data center (enum identifier SOUTH_AMERICA; confirm with your deployment docs)
Oman data center
Do-not-disturb level for a specific channel. Controls which messages trigger push notifications.
Receive notifications for all messages
Default notification level (follow global settings)
Only receive notifications for mentioned messages (all mention types)
Only receive notifications when specific users are mentioned
Only receive notifications when all members are mentioned
Mute all notifications
Channel type enum
Direct channel
Group channel
Open channel
System channel
Community channel
Type of a community sub-channel.
Public sub-channel, visible and joinable by all community members
Private sub-channel, only visible and joinable by invited members
Log level
Direction of a message, indicating whether it was sent or received.
Message sent by the current user
Message received from another user
Read receipt response status for a message.
The user has responded to the read receipt request
The user has not yet responded to the read receipt request
Built-in message type identifiers. Each value corresponds to a registered message object type name.
Plain text message
High-definition voice message
Image message
GIF image message
Short video message
Location message
File message
Reference (reply/quote) message
Combined/forwarded message
Stream message (for real-time AI streaming responses)
Do-not-disturb time period level. Controls notification behavior during quiet hours.
Default level (follow global settings)
Only allow mentioned message notifications during quiet hours
Mute all notifications during quiet hours
Action type for open channel member changes (enter/exit).
Member exited the open channel
Member entered the open channel
Multi-device sync status for open channel membership.
Exited the open channel on another device
Entered the open channel on another device
Reason why a user exited an open channel.
User voluntarily exited the channel
User was kicked out by login on another device
Mute operation type for open channel members.
Unmute specific users
Mute specific users
Unmute all users
Mute all users
Remove users from the allow list
Add users to the allow list
Unmute the entire channel globally
Mute the entire channel globally
Ban operation type for open channel members.
Unban the member
Ban the member
Whether an @mention targets everyone in the channel or specific users.
Mention all participants
Mention listed user IDs only
Source of text passed to translation APIs (message body vs custom string).
Translate content attached to a chat message
Translate arbitrary user-entered text
Helpers that construct media SendFileMessageParams, SendImageMessageParams,
SendGIFMessageParams, and SendHDVoiceMessageParams from browser {@link File} objects.
On success, pass result.data to BaseChannel.sendMediaMessage.
Builds file message send parameters from a local file (name, size, and inferred file type suffix).
The file to upload and send
A result containing SendFileMessageParams with file set, or an error if validation fails
Builds GIF message send parameters by loading the image to read width and height.
The GIF file to upload and send
A result containing SendGIFMessageParams with file set, or an error if the GIF cannot be loaded
Builds HD voice message send parameters by decoding audio to obtain duration, sample rate, and channel count (expects 16 kHz decode context).
The audio file to upload and send
A result containing SendHDVoiceMessageParams with file set, or an error if decoding fails
Builds image message send parameters by drawing a scaled thumbnail (max 160px) and JPEG base64 payload within size limits.
The image file to upload and send
A result containing SendImageMessageParams with file set, or an error if the image cannot be loaded
Data structure of an individual message within a combined (forwarded) message
User ID of the message sender
Conversation target ID
Message send time
Message type identifier
Message content
Error keys information
Array of keys that failed to update
Read receipt user information
User ID
The time the user read the message. 0 indicates the user has not sent a read receipt.
Whether the user was mentioned in the message
Same fields as GetSubscribeEventParams; used when unsubscribing from those users and type.
Do-not-disturb level type for a specific channel.
Community sub-channel type.
Log level
Message direction type.
Message read receipt status type.
Built-in message type.
Do-not-disturb time period level type.
Open channel member action type.
Open channel sync status type.
Open channel exit reason type.
Open channel member mute operation type.
Open channel member ban type.
Payload when a member's group-related attributes change.
Payload when group favorites (follows) sync across devices.
Subscription relationship change as synced from the server (e.g. another device).
Installs an engine plugin after the SDK is initialized. Returns null if {@link init} has not been called.
Engine plugin factory ({@link IPluginGenerator})
Options passed to the plugin factory
The plugin instance, or null when the global context is unavailable
Include all members, including robots