API reference

Method SendPaginatedMessageAsync

Namespace

DisCatSharp.Interactivity

Assembly

DisCatSharp.Interactivity.dll

SendPaginatedMessageAsync(DiscordChannel, DiscordUser, IEnumerable<Page>, PaginationButtons?, PaginationBehaviour?, ButtonPaginationBehavior?, CancellationToken)

Sends a paginated message with buttons.

public Task SendPaginatedMessageAsync(DiscordChannel channel, DiscordUser user, IEnumerable<Page> pages, PaginationButtons? buttons, PaginationBehaviour? behaviour = null, ButtonPaginationBehavior? deletion = null, CancellationToken token = default)

Parameters

channel DiscordChannel

The channel to send it on.

user DiscordUser

User to give control.

pages IEnumerable<Page>

The pages.

buttons PaginationButtons

Pagination buttons (pass null to use buttons defined in InteractivityConfiguration ).

behaviour PaginationBehaviour?

Pagination behaviour.

deletion ButtonPaginationBehavior?

Deletion behaviour.

token CancellationToken

A custom cancellation token that can be cancelled at any point.

Returns

Task

SendPaginatedMessageAsync(DiscordChannel, DiscordUser, IEnumerable<Page>, PaginationButtons?, TimeSpan?, PaginationBehaviour?, ButtonPaginationBehavior?)

Sends a paginated message with buttons.

public Task SendPaginatedMessageAsync(DiscordChannel channel, DiscordUser user, IEnumerable<Page> pages, PaginationButtons? buttons, TimeSpan? timeoutOverride, PaginationBehaviour? behaviour = null, ButtonPaginationBehavior? deletion = null)

Parameters

channel DiscordChannel

The channel to send it on.

user DiscordUser

User to give control.

pages IEnumerable<Page>

The pages.

buttons PaginationButtons

Pagination buttons (pass null to use buttons defined in InteractivityConfiguration ).

timeoutOverride TimeSpan?

Override timeout period.

behaviour PaginationBehaviour?

Pagination behaviour.

deletion ButtonPaginationBehavior?

Deletion behaviour.

Returns

Task

SendPaginatedMessageAsync(DiscordChannel, DiscordUser, IEnumerable<Page>, PaginationBehaviour?, ButtonPaginationBehavior?, CancellationToken)

Sends the paginated message.

public Task SendPaginatedMessageAsync(DiscordChannel channel, DiscordUser user, IEnumerable<Page> pages, PaginationBehaviour? behaviour = null, ButtonPaginationBehavior? deletion = null, CancellationToken token = default)

Parameters

channel DiscordChannel

The channel.

user DiscordUser

The user.

pages IEnumerable<Page>

The pages.

behaviour PaginationBehaviour?

The behaviour.

deletion ButtonPaginationBehavior?

The deletion.

token CancellationToken

The token.

Returns

Task

A Task.

SendPaginatedMessageAsync(DiscordChannel, DiscordUser, IEnumerable<Page>, TimeSpan?, PaginationBehaviour?, ButtonPaginationBehavior?)

Sends the paginated message.

public Task SendPaginatedMessageAsync(DiscordChannel channel, DiscordUser user, IEnumerable<Page> pages, TimeSpan? timeoutOverride, PaginationBehaviour? behaviour = null, ButtonPaginationBehavior? deletion = null)

Parameters

channel DiscordChannel

The channel.

user DiscordUser

The user.

pages IEnumerable<Page>

The pages.

timeoutOverride TimeSpan?

Override timeout period.

behaviour PaginationBehaviour?

The behaviour.

deletion ButtonPaginationBehavior?

The deletion.

Returns

Task

A Task.

SendPaginatedMessageAsync(DiscordChannel, DiscordUser, IEnumerable<Page>, PaginationEmojis?, PaginationBehaviour?, PaginationDeletion?, TimeSpan?, CancellationToken)

Sends a paginated message. For this Event you need the GuildMessageReactions intent specified in Intents

public Task SendPaginatedMessageAsync(DiscordChannel channel, DiscordUser user, IEnumerable<Page> pages, PaginationEmojis? emojis = null, PaginationBehaviour? behaviour = null, PaginationDeletion? deletion = null, TimeSpan? timeoutOverride = null, CancellationToken cancellationToken = default)

Parameters

channel DiscordChannel

Channel to send paginated message in.

user DiscordUser

User to give control.

pages IEnumerable<Page>

Pages.

emojis PaginationEmojis

Pagination emojis.

behaviour PaginationBehaviour?

Pagination behaviour (when hitting max and min indices).

deletion PaginationDeletion?

Deletion behaviour.

timeoutOverride TimeSpan?

Override timeout period.

cancellationToken CancellationToken

A cancellation token that can be used to cancel the pagination.

Returns

Task