Skip to main content

Chat / Android

Current version: v4

Switch versions

Overview
- Getting started
- Send first message
- Migration guide
- User
- Overview
- - Retrieving and updating user information
  - Retrieve the online status of a user
  - Update user profile
  - Retrieve the latest information on participants
- - Managing user metadata
  - Manage user metadata
- Channel
- Overview
- - Creating a channel
  - Create a channel
- - Managing operators
  - Register and remove operators
- - Joining and leaving a channel
  - Enter and exit an open channel
  - Join and leave a group channel
- - Retrieving channels
  - Retrieve a list of channels
  - Retrieve a channel by URL
- - Inviting users to a group channel
  - Invite users as members
  - Accept or decline an invitation
- - Categorizing channels
  - Categorize channels by custom type
- - Managing channels
  - Delete a channel
  - Hide or archive a group channel
  - Refresh all data related to a group channel
- - Moderating a channel
  - Freeze and unfreeze a channel
- - Managing channel metadata
  - Manage channel metadata
- - Managing channel metacounters
  - Manage channel metacounters
- Message
- Overview
- - Receiving messages through event handler
  - Receive messages in an open channel
  - Receive messages in a group channel
- - Using message threading
  - Create a message thread
  - List replies in a message thread
- - Retrieving a message
  - Retrieve a message
- - Searching messages in a group channel
  - Search messages by a keyword
- - Loading messages
  - Load previous messages
  - Load messages by timestamp or message ID
- - Listing changelogs
  - List changelogs of messages
- - Marking messages as read in a group channel
  - Mark messages as read
- - Marking messages as delivered in a group channel
  - Mark messages as delivered
- - Mentioning other users in a message
  - Mention other users in a message
- - Retrieving unread count in a group channel
  - Unread messages in a channel
  - Unread messages in all channels
  - Unread channels
  - Members who haven't received a message
  - Members who haven't read a message
  - Unread items
- - Categorizing messages
  - Categorize messages by custom type
- - Adding extra data to a message
  - Add extra data to a message
- - Translating messages
  - Auto-translate messages
  - Translate messages on-demand
  - Translation engine
- Application
- Overview
- - Authenticating a user
  - Authentication
- - Understanding rate limits
  - Rate limits
- Event handler
- Overview
- - Managing channel event handlers
  - Add or remove a channel event handler
- - Managing connection event handlers
  - Add or remove a connection event handler
- - Managing user event handlers
  - Add or remove a user event handler
- Notifications
- Overview
- - Multi-device support
  - Set up push notifications for FCM
  - Set up push notifications for HMS
- Report
- Overview
- - Creating a report
  - Report a message, user, or channel
- Local caching
- Overview
- - Using group channel collection
  - Group channel collection
- - Using message collection
  - Message collection
Deprecated
Error codes
Logger

Chat Android v4

Chat Android

Chat

Android

Home

/

Chat

/

Android

/

Message

This is the new Docs for Chat SDK v4 for Android. To see the previous Docs, click here.

Receive messages in an open channel

Users can receive messages from other participants through the onMessageReceived() method in the channel event handler. A BaseMessage object for each received message is one of the following message types.

Message type	Description
UserMessage	A text message sent by a user
FileMessage	A binary file message sent by a user
AdminMessage	A text message sent by an admin through the Chat API

To register multiple concurrent handlers, pass a UNIQUE_HANDLER_ID argument as a unique identifier into the SendbirdChat.addChannelHandler() method.

Kotlin

SendbirdChat.addChannelHandler(
    UNIQUE_HANDLER_ID,
    object : OpenChannelHandler() {
        override fun onMessageReceived(channel: BaseChannel, message: BaseMessage) {
            // You can customize how to display the different types of messages with the result object in the message parameter.
            when (message) {
                is UserMessage -> {}
                is FileMessage -> {}
                is AdminMessage -> {}
            }
        }
    }
)

When the UI isn't valid anymore, remove the channel event handler.

Kotlin

SendbirdChat.removeChannelHandler(UNIQUE_HANDLER_ID);

Event handler for message threading

Once a reply is created or deleted from a thread, the onThreadInfoUpdated() event handler is invoked. The method returns a ThreadInfoUpdateEvent object that has the latest information about the thread. This object needs to be applied to the parent message object.

Note: Like other messages, when a reply is created in a channel, the onMessageReceived() method of the channel event handler in client apps is called.

Kotlin

override fun onThreadInfoUpdated(channel: BaseChannel, threadInfoUpdateEvent: ThreadInfoUpdateEvent) {
    // Look for a message that has threadInfoUpdateEvent.targetMessageId
    // Apply the event to the message.
    parentMessage.applyThreadInfoUpdateEvent(threadInfoUpdateEvent)
}

List of parameters

Parameter name	Type	Description
channel	BaseChannel	Specifies the channel that has the message thread.
threadInfoUpdateEvent	ThreadInfoUpdateEvent	Specifies a `ThreadInfoUpdateEvent` object that has the latest information about the thread.

Sample app