From 3eb5ff4e3f0a841d28d8c742eba2e562f9fc2231 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Mon, 4 Mar 2024 14:53:52 +0000 Subject: Deploying to docs from @ python-discord/bot-core@c72b515aec03b1d9df49a3d58bfa90a3d864160e πŸš€ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.utils.interactions.html | 102 +++---------------------- 1 file changed, 11 insertions(+), 91 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 d1eee3ff..84ad48ca 100644 --- a/main/output/pydis_core.utils.interactions.html +++ b/main/output/pydis_core.utils.interactions.html @@ -279,86 +279,6 @@ v9.0.0 -
  • - v8.3.0-beta -
    • - -
  • - v8.2.1 -
    • - -
  • - v8.2.0 -
    • - -
  • - v8.1.0 -
    • - -
  • - v8.0.0-beta.4 -
    • - -
  • - v8.0.0-beta.3 -
    • - -
  • - v8.0.0-beta.2 -
    • - -
  • - v8.0.0-beta.1 -
    • - -
  • - v8.0.0 -
    • - -
  • - v7.5.0 -
    • - -
  • - v7.4.0-beta1 -
    • - -
  • - v7.4.0 -
    • - -
  • - v7.3.1 -
    • - -
  • - v7.3.0 -
    • - -
  • - v7.2.2 -
    • - -
  • - v7.2.1 -
    • - -
  • - v7.2.0 -
    • - -
  • - v7.1.3 -
    • - -
  • - v7.1.2 -
    • - -
  • - v7.1.1 -
    • -
  • v10.7.0
    • @@ -454,7 +374,7 @@

    interactions#

    -class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]#
    +class DeleteMessageButton(*, style=('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.

    @@ -469,12 +389,12 @@
    -__init__(*, style=('secondary', 2), label='Delete', **kwargs)[source]#
    +__init__(*, style=('secondary', 2), label='Delete', **kwargs)[source]#
    -async callback(interaction)[source]#
    +async callback(interaction)[source]#

    Delete the original message on button click.

    Return type:
    @@ -487,7 +407,7 @@
    -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.

    @@ -495,21 +415,21 @@

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

    • timeout (float | None) – 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 (Message | None) – 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:
    @@ -523,7 +443,7 @@ If None
    -async on_timeout()[source]#
    +async on_timeout()[source]#

    Remove the view from self.message if set.

    Return type:
    @@ -534,7 +454,7 @@ If None
    -stop()[source]#
    +stop()[source]#

    Stop listening for interactions, and remove the view from self.message if set.

    Return type:
    @@ -547,7 +467,7 @@ If None
    -user_has_access(user, *, allowed_users=(), allowed_roles=())[source]#
    +user_has_access(user, *, allowed_users=(), allowed_roles=())[source]#

    Return whether the user is in the allowed_users list, or has a role from allowed_roles.

    Parameters:
    -- cgit v1.2.3