Chat / JavaScript
Chat JavaScript v4
Chat JavaScript
Chat
JavaScript
Version 4
Home
/
Chat
/
JavaScript
/
Message

Retrieve a list of polls

Copy link

You can retrieve a list of polls in a channel using either the createPollListQuery() method or the sb.createPollListQuery() method.

// One way to retrieve a list of polls in a channel.
const query: PollListQuery = channel.createPollListQuery();
const polls: Poll[] = await query.next();

// Another way to retrieve a list of polls in a channel.
const params: PollListQueryParams = {
  channelUrl: channel.url,
  channelType: ChannelType.GROUP,
};
const query: PollListQuery = sb.createPollListQuery(params);
const polls: Poll[] = await query.next();

PollListQueryParams

Copy link
Parameter nameTypeDescription

channelType

ChannelType

Specifies the type of the channel.

channelUrl

string

Specifies the URL of the channel.

limit?

number

Specifies the number of results to retrieve per page. Acceptable values are 1 to 20, inclusive. (Default: 10)