EmbedComponentPagination class
Paginator where each page is embed
- Inheritance
-
- Object
- IPagination<
IButtonInteractionEvent, ComponentMessageBuilder> - ComponentPaginationAbstract
- ComponentPaginationBase
- EmbedComponentPagination
Constructors
-
EmbedComponentPagination(IInteractions interactions, List<
EmbedBuilder> embeds, {String firstLabel = '<<', String prevLabel = '<', String nextLabel = '>', String lastLabel = '>>', IEmoji? firstEmoji, IEmoji? prevEmoji, IEmoji? nextEmoji, IEmoji? lastEmoji, Duration? timeout, IUser? user}) - Creates instance of EmbedComponentPagination
Properties
- builder ↔ ComponentMessageBuilder
-
Message builder used to create paginated messages
getter/setter pairinherited
- currentPage ↔ int
-
Current page that paginator is on
getter/setter pairinherited
- customPreId ↔ String
-
Custom id for this instance of paginator that different paginators could be recognized.
latefinalinherited
-
embeds
→ List<
EmbedBuilder> -
List of embeds to paginate with
final
- firstEmoji → IEmoji?
-
finalinherited
- firstLabel → String
-
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- interactions → IInteractions
-
Reference to
Interactions
finalinherited - lastEmoji → IEmoji?
-
finalinherited
- lastLabel → String
-
finalinherited
- maxPage → int
-
Number of pages
no setteroverride
- message ↔ IMessage?
-
getter/setter pairinherited
- nextEmoji → IEmoji?
-
finalinherited
- nextLabel → String
-
finalinherited
- prevEmoji → IEmoji?
-
finalinherited
- prevLabel → String
-
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- timeout → Duration?
-
A timeout after which pagination will be disabled for this message.
finalinherited
- user → IUser?
-
The user that can use the pagination.
finalinherited
Methods
-
getMessageBuilderForPage(
int page, ComponentMessageBuilder currentBuilder) → ComponentMessageBuilder -
Returns
MessageBuilder
forpage
number. Always modify builder passed incurrentBuilder
argument.override -
initHook(
ComponentMessageBuilder builder) → ComponentMessageBuilder -
Called after initializing basic components.
inherited
-
initMessageBuilder(
) → ComponentMessageBuilder -
Inits
ComponentMessageBuilder
with buttons needed for pagination. And hooks needed events.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onFirstPageButtonClicked(
) → void -
Invoked on first page button click
inherited
-
onLastPageButtonClicked(
) → void -
Invoked when last page button is clicked.
inherited
-
onNextPageButtonClicked(
) → void -
Invoked when next page button is clicked.
inherited
-
onPreviousPageButtonClicked(
) → void -
Invoked when previous page button is clicked.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updatePage(
int page, ComponentMessageBuilder currentBuilder, IButtonInteractionEvent target) → FutureOr< void> -
Invoked on each page update. Current page number is passed in
page
argument. Builder that message should be edited with is passed incurrentBuilder
argument.target
parameter is generic and allows customization of how message will be modified.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited