/ SDKs / Android

SDKs

Overview
- Getting started
- Send first message
- Kotlin extension (KTX)
- Migration guide
- Collection 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 messages
  - Retrieve a list of messages
  - Retrieve a message
- - Searching messages in a group channel
  - Search messages by a keyword
- - Managing scheduled messages in group channel
  - Create a scheduled message
  - Retrieve a scheduled message
  - Update a scheduled message
  - Cancel a scheduled message
  - Send a scheduled message immediately
  - List all scheduled messages
  - Retrieve the total number of scheduled messages
- - Managing pinned messages in group channels
  - Pin a message
  - Unpin a message
  - List pinned messages
- - 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
- Push notifications
- Overview
- - Marking push notifications as delivered
  - Mark push notifications as delivered
- - 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
Migrating to Sendbird
Deprecated
Error codes
Logger

Chat SDKs Android v4

Chat SDKs Android

Chat SDKs

Android

Version 4

/

/

/

/

Overview

Before starting to build a chat service, it's important to understand the core functionalities of your Sendbird application. By learning how to manage connections with the Sendbird server, authenticate users, and understand how rate limits work, you can build a chat in your app that ensures optimal performance and stability.

Functionalities by topic

The following is a list of basic functionalities for application management that our Chat SDK provides.

Authenticating a user

Functionality	Description	Open channel	Group channel
Initialize the Chat SDK with APP_ID	Initializes the Chat SDK by passing `APP_ID` of your Sendbird application as an argument to a parameter in `SendbirdChat.init()`.
Connect to the Sendbird server with a user ID	Authenticates a user using a unique user ID and connect to the Sendbird server.
Connect to the Sendbird server with a user ID and a token	Authenticates a user using a unique user ID and a token and connect to the Sendbird server.
Set a session handler	Sets a session handler to automatically refresh a user's session token when it's expired.
Disconnect from the Sendbird server	Disconnects a user from the Sendbird server when they no longer need to receive messages from an online state.
Disconnect the WebSocket only	Disconnects only the WebSocket, keeping all locally cached data.

Understanding rate limits

Functionality	Description	Open Channel	Group channel
Default settings	Sendbird applications have default limits on the number of messages per second that a user can send.
Rate-limited methods	Rate limits are applied to SDK methods that are associated with objects such as channel, user, and message.
Rate-limited real-time events	Some real-time events taking place in client apps are rate-limited.
Error responses	When a request is rate-limited, two types of errors are returned.

On this page

Functionalities by topic

Sample app