Pagination<T extends IPaginationHandler> class

Handles pagination interactivity. Allows to create paginated messages from List Factory constructors allows to create message from String directly.

Pagination is sent by paginate method. And returns Message instance of sent message.

var pagination = new Pagination(["This is simple paginated", "data. Use it if you", "want to partition text by yourself"], ctx,channel);
// It generated 2 equal (possibly) pages.
var paginatedMessage = new Pagination.fromStringEq("This is text for pagination", 2);

Constructors

Pagination(ITextChannel channel, T paginationHandler)

Properties

channel ↔ ITextChannel
Channel where message will be sent
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
paginationHandler ↔ T
IPaginationHandler which will handle generating messages.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
paginate(Nyxx client, {Duration timeout: const Duration(minutes: 2)}) Future<Message>
Paginates a list of Strings - each String is a different page.
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited