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
- - 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
- - 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.

Retrieve the total number of scheduled messages

Use the getTotalScheduledMessageCount() method to retrieve the total number of scheduled messages a user has. The properties of TotalScheduledMessageCountParams are optional to set as a filter. If not set, the number of all scheduled messages that a user has will be retrieved.

Kotlin

// Retrieves the total number of scheduled messages.
val params = TotalScheduledMessageCountParams(
    channelUrl = null,
    scheduledStatus = null,
    messageTypeFilter = MessageTypeFilter.ALL
)
SendbirdChat.getTotalScheduledMessageCount(params) { count, e ->
    if (e != null) {
        // Handle error.
    }

    // `count` contains the number of scheduled messages.
}

TotalScheduledMessageCountParams

Parameter name	Type	Description
channelUrl	string	Specifies the URL of the channel. (Default: `null`)
scheduledStatus	list	Specifies list of `ScheduledStatus` where scheduled messages with only given `ScheduledStatus` are retrieved. (Default: `null`)
messageTypeFilter	enum	Specifies the message type to filter the messages with the corresponding type. Acceptable values are `ALL`, `USER`, `FILE`, and `ADMIN`. (Default: `ALL`)

Sample app