All Implemented Interfaces:


public class BaseChannel

Base class for all channel types.

Contains common channel properties and methods for message querying, unread count management, and channel operations.

Inheritance hierarchy:

BaseChannel
├── DirectChannel   (1:1 private chat)
├── GroupChannel     (group chat)
├── SystemChannel    (system notifications)
├── OpenChannel      (open channel)
└── CommunityChannel (community)

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`BaseChannel.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`channelId`
`private final ChannelType`	`channelType`
`private final Integer`	`unreadCount`
`private final Boolean`	`isPinned`
`private final Long`	`operationTime`
`private final String`	`draft`
`private final Message`	`latestMessage`
`private final Integer`	`mentionedCount`
`private final Integer`	`mentionedMeCount`
`private final ChannelNoDisturbLevel`	`noDisturbLevel`
`private final TranslateStrategy`	`translateStrategy`
`private final Boolean`	`includeRobot`
`private final EditedMessageDraft`	`editedMessageDraft`
`public final static BaseChannel.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getChannelId()`	Channel unique identifier
`final ChannelType`	`getChannelType()`	Channel type
`final Integer`	`getUnreadCount()`	Unread message count.
`final Boolean`	`isPinned()`	Whether this channel is pinned to the top.
`final Long`	`getOperationTime()`	Channel operation timestamp in milliseconds.
`final String`	`getDraft()`	Text message draft content for this channel.
`final Message`	`getLatestMessage()`	The latest message in this channel.
`final Integer`	`getMentionedCount()`	Unread count of mentioned messages (including @all).
`final Integer`	`getMentionedMeCount()`	Unread count of messages that specifically mention the current user.
`final ChannelNoDisturbLevel`	`getNoDisturbLevel()`	Channel message push notification level.
`final TranslateStrategy`	`getTranslateStrategy()`	Channel translation strategy.
`final Boolean`	`getIncludeRobot()`	Whether this channel contains a robot/bot user.
`final EditedMessageDraft`	`getEditedMessageDraft()`	Draft info for an edited message.
`Unit`	`pin(PinParams params, OperationHandler<Boolean> handler)`	Pins this channel to the top of the channel list.
`Unit`	`unpin(OperationHandler<Boolean> handler)`	Unpins this channel from the top of the channel list.
`final Unit`	`delete(OperationHandler<Boolean> handler)`	Deletes this channel locally.
`final Unit`	`setNoDisturbLevel(ChannelNoDisturbLevel level, ErrorHandler handler)`	Sets the notification (do-not-disturb) level for this channel.
`Unit`	`clearUnreadCount(OperationHandler<Boolean> handler)`	Clears the unread message count for this channel.
`final Unit`	`getFirstUnreadMessage(OperationHandler<Message> handler)`	Gets the first unread message in this channel.
`Unit`	`getUnreadMentionedMessages(OperationHandler<List<Message>> handler)`	Gets unread mentioned messages in this channel.
`final Unit`	`getTags(OperationHandler<List<ChannelTagInfo>> handler)`	Gets all tags associated with this channel.
`final Unit`	`deleteTags(List<String> tagIds, ErrorHandler handler)`	Removes tags from this channel.
`final Unit`	`saveDraft(String draft, OperationHandler<Boolean> handler)`	Saves a text message draft for this channel.
`final Unit`	`clearDraft(OperationHandler<Boolean> handler)`	Clears the text message draft for this channel.
`final Unit`	`sendMessage(SendMessageParams params, SendMessageHandler handler)`	Sends a non-media message in this channel (e.g., text, location).
`final Unit`	`sendMediaMessage(SendMediaMessageParams params, SendMediaMessageHandler handler)`	Sends a media message in this channel (e.g., image, video, file).
`final Unit`	`insertMessages(List<InsertMessageItem> params, OperationHandler<Boolean> handler)`	Batch inserts messages into the local database.
`final Unit`	`modifyMessage(ModifyMessageParams params, OperationHandler<Message> handler)`	Modifies a sent message.
`final Unit`	`deleteMessagesForMe(List<Message> messages, ErrorHandler handler)`	Deletes messages locally (for the current user only).
`final Unit`	`deleteLocalMessages(List<String> messageClientIds, OperationHandler<Boolean> handler)`	Deletes local messages by their client IDs.
`final Unit`	`deleteMessageForAll(Message message, OperationHandler<Message> handler)`	Deletes a message for all users (recall).
`Unit`	`deleteMessagesForMeByTimestamp(DeleteMessagesForMeByTimestampParams params, ErrorHandler handler)`	Deletes messages before the specified timestamp (for the current user).
`final Unit`	`getMessagesAroundTime(GetMessagesAroundTimeParams params, OperationHandler<List<Message>> handler)`	Gets messages around a given sent timestamp.
`final Unit`	`sendReadReceiptResponse(List<String> messageIds, ErrorHandler handler)`	Sends a read receipt response for the specified messages.
`final Unit`	`getMessageReadReceiptInfo(List<String> messageIds, OperationHandler<List<ReadReceiptInfo>> handler)`	Gets read receipt info for the specified messages.
`final Unit`	`getMessagesReadReceiptByUsers(GetMessagesReadReceiptByUsersParams params, OperationHandler<ReadReceiptUsersResult> handler)`	Gets read receipt details grouped by users.
`final Unit`	`reload(OperationHandler<BaseChannel> handler)`	Reloads channel data from the local database.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getChannelId
```
 final String getChannelId()
```
    Channel unique identifier
  - getChannelType
```
 final ChannelType getChannelType()
```
    Channel type
  - getUnreadCount
```
 final Integer getUnreadCount()
```
    Unread message count.
  - isPinned
```
 final Boolean isPinned()
```
    Whether this channel is pinned to the top.
  - getOperationTime
```
 final Long getOperationTime()
```
    Channel operation timestamp in milliseconds.
    Initially equals the latest message's sent time. Operations such as pinning will update this timestamp. Used as the cursor for paginated channel list queries.
  - getDraft
```
 final String getDraft()
```
    Text message draft content for this channel.
  - getLatestMessage
```
 final Message getLatestMessage()
```
    The latest message in this channel.
    Contains full message details including content, sender, and sent time.
  - getMentionedCount
```
 final Integer getMentionedCount()
```
    Unread count of mentioned messages (including @all).
  - getMentionedMeCount
```
 final Integer getMentionedMeCount()
```
    Unread count of messages that specifically mention the current user.
  - getNoDisturbLevel
```
 final ChannelNoDisturbLevel getNoDisturbLevel()
```
    Channel message push notification level.
  - getTranslateStrategy
```
 final TranslateStrategy getTranslateStrategy()
```
    Channel translation strategy.
  - getIncludeRobot
```
 final Boolean getIncludeRobot()
```
    Whether this channel contains a robot/bot user.
  - getEditedMessageDraft
```
 final EditedMessageDraft getEditedMessageDraft()
```
    Draft info for an edited message.
    Stores the draft content when the user is editing a previously sent message.
  - pin
```
 Unit pin(PinParams params, OperationHandler<Boolean> handler)
```
    Pins this channel to the top of the channel list.
    
    Parameters:
    
    params - Pin parameters
    
    handler - Callback returning the operation result
  - unpin
```
 Unit unpin(OperationHandler<Boolean> handler)
```
    Unpins this channel from the top of the channel list.
    
    Parameters:
    
    handler - Callback returning the operation result
  - delete
```
 final Unit delete(OperationHandler<Boolean> handler)
```
    Deletes this channel locally.
    This does not delete messages within the channel. If new messages arrive, the channel will reappear in the list.
    
    Parameters:
    
    handler - Callback returning the operation result
  - setNoDisturbLevel
```
 final Unit setNoDisturbLevel(ChannelNoDisturbLevel level, ErrorHandler handler)
```
    Sets the notification (do-not-disturb) level for this channel.
    
    Parameters:
    
    level - The notification level to set
    
    handler - Error callback; null error indicates success
  - clearUnreadCount
```
 Unit clearUnreadCount(OperationHandler<Boolean> handler)
```
    Clears the unread message count for this channel.
    
    Parameters:
    
    handler - Callback returning the operation result
  - getFirstUnreadMessage
```
 final Unit getFirstUnreadMessage(OperationHandler<Message> handler)
```
    Gets the first unread message in this channel.
    
    Parameters:
    
    handler - Callback returning the first unread message on success
  - getUnreadMentionedMessages
```
 Unit getUnreadMentionedMessages(OperationHandler<List<Message>> handler)
```
    Gets unread mentioned messages in this channel.
    
    Parameters:
    
    handler - Callback returning the list of unread mentioned messages on success
  - getTags
```
 final Unit getTags(OperationHandler<List<ChannelTagInfo>> handler)
```
    Gets all tags associated with this channel.
    
    Parameters:
    
    handler - Callback returning the list of channel tag info on success
  - deleteTags
```
 final Unit deleteTags(List<String> tagIds, ErrorHandler handler)
```
    Removes tags from this channel.
    
    Parameters:
    
    tagIds - List of tag IDs to remove
    
    handler - Error callback; null error indicates success
  - saveDraft
```
 final Unit saveDraft(String draft, OperationHandler<Boolean> handler)
```
    Saves a text message draft for this channel.
    
    Parameters:
    
    draft - The draft content to save
    
    handler - Callback returning the operation result
  - clearDraft
```
 final Unit clearDraft(OperationHandler<Boolean> handler)
```
    Clears the text message draft for this channel.
    
    Parameters:
    
    handler - Callback returning the operation result
  - sendMessage
```
 final Unit sendMessage(SendMessageParams params, SendMessageHandler handler)
```
    Sends a non-media message in this channel (e.g., text, location).
    Note: Cannot send more than 5 messages per second.
    
    Parameters:
    
    params - Send message parameters containing the message and optional push config
    
    handler - Callback for tracking the message sending lifecycle
  - sendMediaMessage
```
 final Unit sendMediaMessage(SendMediaMessageParams params, SendMediaMessageHandler handler)
```
    Sends a media message in this channel (e.g., image, video, file).
    
    Parameters:
    
    params - Send media message parameters containing the message and optional push config
    
    handler - Callback for tracking the media message sending lifecycle, including upload progress
  - insertMessages
```
 final Unit insertMessages(List<InsertMessageItem> params, OperationHandler<Boolean> handler)
```
    Batch inserts messages into the local database.
    Messages are inserted locally only and are not sent to the server. The channel info (channelType, channelId) is taken from this channel instance.
    
    Parameters:
    
    params - List of message items to insert
    
    handler - Callback returning true on success
  - modifyMessage
```
 final Unit modifyMessage(ModifyMessageParams params, OperationHandler<Message> handler)
```
    Modifies a sent message.
    
    Parameters:
    
    params - Modify message parameters
    
    handler - Callback returning the updated message on success
  - deleteMessagesForMe
```
 final Unit deleteMessagesForMe(List<Message> messages, ErrorHandler handler)
```
    Deletes messages locally (for the current user only).
    
    Parameters:
    
    messages - List of messages to delete
    
    handler - Error callback; null error indicates success
  - deleteLocalMessages
```
 final Unit deleteLocalMessages(List<String> messageClientIds, OperationHandler<Boolean> handler)
```
    Deletes local messages by their client IDs.
    
    Parameters:
    
    messageClientIds - List of message client IDs to delete
    
    handler - Callback returning true on success
  - deleteMessageForAll
```
 final Unit deleteMessageForAll(Message message, OperationHandler<Message> handler)
```
    Deletes a message for all users (recall).
    
    Parameters:
    
    message - The message to recall
    
    handler - Callback returning the recalled message on success
  - deleteMessagesForMeByTimestamp
```
 Unit deleteMessagesForMeByTimestamp(DeleteMessagesForMeByTimestampParams params, ErrorHandler handler)
```
    Deletes messages before the specified timestamp (for the current user).
    The operation policy determines whether messages are deleted locally only or both locally and remotely.
    
    Parameters:
    
    params - Parameters including the timestamp and operation policy
    
    handler - Error callback; null error indicates success
  - getMessagesAroundTime
```
 final Unit getMessagesAroundTime(GetMessagesAroundTimeParams params, OperationHandler<List<Message>> handler)
```
    Gets messages around a given sent timestamp.
    Returns messages both before and after the specified time, sorted chronologically.
    
    Parameters:
    
    params - Parameters including the sent time and the count of messages before/after
    
    handler - Callback returning the message list on success
  - sendReadReceiptResponse
```
 final Unit sendReadReceiptResponse(List<String> messageIds, ErrorHandler handler)
```
    Sends a read receipt response for the specified messages.
    
    Parameters:
    
    messageIds - List of message IDs to acknowledge
    
    handler - Error callback; null error indicates success
  - getMessageReadReceiptInfo
```
 final Unit getMessageReadReceiptInfo(List<String> messageIds, OperationHandler<List<ReadReceiptInfo>> handler)
```
    Gets read receipt info for the specified messages.
    
    Parameters:
    
    messageIds - List of message IDs to query
    
    handler - Callback returning the read receipt info list on success
  - getMessagesReadReceiptByUsers
```
 final Unit getMessagesReadReceiptByUsers(GetMessagesReadReceiptByUsersParams params, OperationHandler<ReadReceiptUsersResult> handler)
```
    Gets read receipt details grouped by users.
    
    Parameters:
    
    params - Query parameters including message ID and user ID list
    
    handler - Callback returning the read receipt users result on success
  - reload
```
 final Unit reload(OperationHandler<BaseChannel> handler)
```
    Reloads channel data from the local database.
    Fetches the latest information for this channel and returns a new BaseChannel object.
    
    Parameters:
    
    handler - Callback returning the latest channel object on success
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```

Class BaseChannel

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getChannelId

getChannelType

getUnreadCount

isPinned

getOperationTime

getDraft

getLatestMessage

getMentionedCount

getMentionedMeCount

getNoDisturbLevel

getTranslateStrategy

getIncludeRobot

getEditedMessageDraft

pin

unpin

delete

setNoDisturbLevel

clearUnreadCount

getFirstUnreadMessage

getUnreadMentionedMessages

getTags

deleteTags

saveDraft

clearDraft

sendMessage

sendMediaMessage

insertMessages

modifyMessage

deleteMessagesForMe

deleteLocalMessages

deleteMessageForAll

deleteMessagesForMeByTimestamp

getMessagesAroundTime

sendReadReceiptResponse

getMessageReadReceiptInfo

getMessagesReadReceiptByUsers

reload

equals

hashCode

toString