From 0a068679f4c82a66c514c69ab1a7a569a736ed0f Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Mon, 12 Dec 2022 18:11:20 +0000 Subject: Deploying to docs from @ python-discord/bot-core@9c728dff2351a0170b372fec76e2b5e15f8846f3 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.utils.interactions.html | 44 ++++++++++++++------------ 1 file changed, 23 insertions(+), 21 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 2d61decf..1b560000 100644 --- a/main/output/pydis_core.utils.interactions.html +++ b/main/output/pydis_core.utils.interactions.html @@ -5,14 +5,14 @@ - - interactions - Pydis Core Latest (9.1.1) + + interactions - Pydis Core Latest (9.2.0) - + - + @@ -127,7 +127,7 @@
-
Pydis Core Latest (9.1.1)
 +
Pydis Core Latest (9.2.0)
@@ -153,10 +153,10 @@
- Pydis Core Latest (9.1.1) + Pydis Core Latest (9.2.0) @@ -209,6 +209,10 @@ main +
  • + v9.1.1 +
    • +
  • v9.0.0
    • @@ -352,8 +356,8 @@

    interactions#

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

    Bases: Button

    +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.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -367,12 +371,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:
    @@ -385,8 +389,8 @@
    -class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]#
    -

    Bases: View

    +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:
    @@ -395,23 +399,23 @@

  • 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 +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • -__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:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    @@ -421,7 +425,7 @@ If None
    -async on_timeout()[source]#
    +async on_timeout()[source]#

    Remove the view from self.message if set.

    Return type:
    @@ -471,9 +475,7 @@ If None
    -
    - -
    +
    -- cgit v1.2.3