/ SDKs / JavaScript
SDKs
Chat SDKs JavaScript v4
Chat SDKs JavaScript
Chat SDKs
JavaScript
Version 4

Retrieve a poll option

Copy link

You can retrieve a specific poll option by creating and passing the PollOptionRetrievalParams properties in the sb.poll.getOption() method.

JavaScriptTypeScript
const params = {
  channelUrl: channel.url,
  channelType: channel.channelType,
  pollId: poll.id,
  pollOptionId: option.id,
};
const pollOption = await sb.poll.getOption(params);

List of properties for poll option

Copy link
Property nameTypeDescription

pollId

number

Specifies the unique ID of a poll.

id

number

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

number

Specifies the time when an option is created in Unix seconds.

voteCount

number

Specifies the number of votes casted on an option.

updatedAt

number

Specifies the time when an option is updated in Unix seconds.

PollOptionRetrievalParams

Copy link
Parameter nameTypeDescription

pollId

number

Specifies the unique ID of a poll.

pollOptionId

number

Specifies the unique ID of a poll option.

channelType

ChannelType

Specifies the type of the channel.

channelUrl

string

Specifies the URL of the channel.