From b9e8801ad4e80c2a0c823828d2d6515040bc4682 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sun, 4 Jun 2023 19:37:38 +0000 Subject: Deploying to docs from @ python-discord/bot-core@1a362c04eb4d5d8f3c531a590d73cf5d7300ace8 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.utils.interactions.html | 36 ++++++++++++++------------ 1 file changed, 20 insertions(+), 16 deletions(-) (limited to 'main/output/pydis_core.utils.interactions.html') diff --git a/main/output/pydis_core.utils.interactions.html b/main/output/pydis_core.utils.interactions.html index 7243b08a..3ed00940 100644 --- a/main/output/pydis_core.utils.interactions.html +++ b/main/output/pydis_core.utils.interactions.html @@ -2,17 +2,17 @@ - + - + interactions - Pydis Core Latest (9.6.0) - + - - + + @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis Core
      +
    • Pydis Core
      • Exts
        • -
      • Utils
          +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.6.0 +
            • +
          • v9.5.1
            • @@ -380,7 +384,7 @@

            interactions#

            -class DeleteMessageButton(*, style=<ButtonStyle.secondary: 2>, label='Delete', **kwargs)[source]#
            +class DeleteMessageButton(*, style=<ButtonStyle.secondary: 2>, label='Delete', **kwargs)[source]#

            Bases: Button

            A button that can be added to a view to delete the message containing the view on click.

            This button itself carries out no interaction checks, these should be done by the parent view.

            @@ -395,12 +399,12 @@
            -__init__(*, style=<ButtonStyle.secondary: 2>, label='Delete', **kwargs)[source]#
            +__init__(*, style=<ButtonStyle.secondary: 2>, label='Delete', **kwargs)[source]#
            -async callback(interaction)[source]#
            +async callback(interaction)[source]#

            Delete the original message on button click.

            Return type:
            @@ -413,14 +417,14 @@
            -class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]#
            +class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]#

            Bases: View

            A view that allows the original invoker and moderators to interact with it.

            Parameters:
              -

            • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

              • -

            • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

              • +

            • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

              • +

            • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

            • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

            • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with @@ -430,12 +434,12 @@ If None

              -__init__(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]#
              +__init__(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]#
              -async interaction_check(interaction)[source]#
              +async interaction_check(interaction)[source]#

              Ensure the user clicking the button is the view invoker, or a moderator.

              Parameters:
              @@ -449,7 +453,7 @@ If None
              -async on_timeout()[source]#
              +async on_timeout()[source]#

              Remove the view from self.message if set.

              Return type:
              -- cgit v1.2.3