Page Manager

This page shows you everything about PageManager.

PageManager

class discordSuperUtils.PageManager(ctx, messages, timeout=60, emojis=[⏪, ◀️, ▶️, ⏩], public=False, index=0)

Initializer of PageManager, represents a page manager that manages pages.

ctx

run

messages

timeout

emojis

public

index

Attributes

  • ctx (discord.ext.commands.Context)

    • The context used by PageManager.

    • Passed in initializer.

  • messages (list)

    • List of pages the paginator will use.

    • Passed in initializer.

  • timeout (int)

    • Duration of inactivity in seconds before page is locked.

    • Passed in initializer.

    • Defaults to 60.

  • emojis (list)

    • List of control emojis.

    • Passed in initializer.

    • Defaults to [⏪, ◀️, ▶️, ⏩].

    • Must be 4 emojis.

  • public (bool)

    • Sets if other users can use the paginator.

    • Passed in initializer.

    • Defaults to false.

  • index (int)

    • Sets the start index of the paginator.

    • Passed in initializer.

    • Defaults to 0.

    • Must be greater than -1 and smaller than number of pages, else, uses default value.

Methods

  • run() Runs the paginator. This method is a coroutine. Raises

    • EmojiError

      • Passed % emojis when 4 are needed.

Last updated