pylav.extension.red.ui.menus package¶
Submodules¶
pylav.extension.red.ui.menus.equalizer module¶
pylav.extension.red.ui.menus.generic module¶
- class pylav.extension.red.ui.menus.generic.BaseMenu(cog, bot, source, *, delete_after_timeout=True, timeout=120, message=None, starting_page=0, **kwargs)[source]¶
Bases:
View
- async interaction_check(interaction)[source]¶
Just extends the default reaction_check to use owner_ids
- async on_error(error, item, interaction)[source]¶
-
A callback that is called when an item’s callback or
interaction_check()
fails with an error.The default implementation logs to the library logger.
- Parameters:
interaction (
Interaction
) – The interaction that led to the failure.error (
Exception
) – The exception that was raised.item (
Item
) – The item that failed the dispatch.
- async on_timeout()[source]¶
-
A callback that is called when a view’s timeout elapses without being explicitly stopped.
- property source¶
- class pylav.extension.red.ui.menus.generic.EntryPickerMenu(cog, bot, source, selector_text, selector_cls, original_author, *, clear_buttons_after=False, delete_after_timeout=True, timeout=120, message=None, starting_page=0, **kwargs)[source]¶
Bases:
BaseMenu
- result¶
- property source¶
- class pylav.extension.red.ui.menus.generic.PaginatingMenu(cog, bot, source, original_author, *, clear_buttons_after=True, delete_after_timeout=False, timeout=120, message=None, starting_page=0, **kwargs)[source]¶
Bases:
BaseMenu
- class pylav.extension.red.ui.menus.generic.PromptYesOrNo(cog, initial_message, *, timeout=120)[source]¶
Bases:
View
- author¶
- ctx¶
- message¶
- async on_timeout()[source]¶
-
A callback that is called when a view’s timeout elapses without being explicitly stopped.
- response¶
pylav.extension.red.ui.menus.nodes module¶
- class pylav.extension.red.ui.menus.nodes.AddNodeFlow(cog, original_author)[source]¶
Bases:
View
- author¶
- ctx¶
- async interaction_check(interaction)[source]¶
Just extends the default reaction_check to use owner_ids
- message¶
- async on_timeout()[source]¶
-
A callback that is called when a view’s timeout elapses without being explicitly stopped.
- class pylav.extension.red.ui.menus.nodes.NodeManagerMenu(cog, bot, source, original_author, *, delete_after_timeout=True, timeout=120, message=None, starting_page=0, **kwargs)[source]¶
Bases:
BaseMenu
- async interaction_check(interaction)[source]¶
Just extends the default reaction_check to use owner_ids
- async on_timeout()[source]¶
-
A callback that is called when a view’s timeout elapses without being explicitly stopped.
- property source¶
pylav.extension.red.ui.menus.player module¶
pylav.extension.red.ui.menus.playlist module¶
- class pylav.extension.red.ui.menus.playlist.PlaylistCreationFlow(cog, original_author, *, timeout=120)[source]¶
Bases:
View
- author¶
- ctx¶
- async interaction_check(interaction)[source]¶
Just extends the default reaction_check to use owner_ids
- message¶
- name_prompt¶
- async on_timeout()[source]¶
-
A callback that is called when a view’s timeout elapses without being explicitly stopped.
- scope_prompt¶
- stop()[source]¶
Stops listening to interaction events from this view.
This operation cannot be undone.
- url_prompt¶
- class pylav.extension.red.ui.menus.playlist.PlaylistManageFlow(cog, original_author, playlist, *, timeout=120, manageable=True)[source]¶
Bases:
View
- author¶
- ctx¶
- async interaction_check(interaction)[source]¶
Just extends the default reaction_check to use owner_ids
- message¶
- name_prompt¶
- async on_timeout()[source]¶
-
A callback that is called when a view’s timeout elapses without being explicitly stopped.
- scope_prompt¶
- stop()[source]¶
Stops listening to interaction events from this view.
This operation cannot be undone.
- url_prompt¶
pylav.extension.red.ui.menus.queue module¶
- class pylav.extension.red.ui.menus.queue.QueueMenu(cog, bot, source, original_author, *, delete_after_timeout=True, timeout=600, message=None, starting_page=0, history=False, **kwargs)[source]¶
Bases:
BaseMenu
- property source¶