/ 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

/

/

/

/

Retrieve a poll option

You can retrieve a specific poll option by creating and passing a PollOptionRetrievalParams object as an argument to the PollOption.get() method.

KotlinKTX

val params = PollOptionRetrievalParams(pollId, pollOptionId, channel.channelType, channel.url)
PollOption.get(params) { option, e ->
    if (e != null) {
        // Handle error.
    }

    // The poll option has been successfully retrieved.
}

List of properties for poll option

Property name	Type	Description
pollId	long	Specifies the unique ID of a poll.
id	long	Specifies the unique ID of a poll option. This value is unique within a poll.
text	string	Specifies the text that describes an option.
createdBy	string	Specifies the unique ID of the user who created an option.
createdAt	long	Specifies the time when an option is created in Unix seconds.
voteCount	long	Specifies the number of votes casted on an option.
updatedAt	long	Specifies the time when an option is updated in Unix seconds.

PollOptionRetrievalParams

Parameter name	Type	Description
pollId	long	Specifies the unique ID of a poll.
pollOptionId	long	Specifies the unique ID of a poll option.
channelType	channelType	Specifies the type of the channel.
channelUrl	string	Specifies the URL of the channel.

PollOptionHandler

Through PollOptionHandler, the Sendbird server always notifies whether your poll option has been successfully retrieved.

Kotlin

fun interface PollOptionHandler {
    fun onResult(pollOption: PollOption?, e: SendbirdException?)
}

Sample app