From cf16350107a4ffd6a48d258a47fffc0733c138b2 Mon Sep 17 00:00:00 2001 From: jb3 Date: Fri, 17 Oct 2025 18:04:11 +0000 Subject: Deploying to docs from @ python-discord/bot-core@9f0162c0869ee8e0ae158636c8f0eac96159a675 πŸš€ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v11.6.0/output/pydis_core.utils.interactions.html | 34 +++++++++++------------ 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'v11.6.0/output/pydis_core.utils.interactions.html') diff --git a/v11.6.0/output/pydis_core.utils.interactions.html b/v11.6.0/output/pydis_core.utils.interactions.html index 8acea6d2..f200d446 100644 --- a/v11.6.0/output/pydis_core.utils.interactions.html +++ b/v11.6.0/output/pydis_core.utils.interactions.html @@ -10,8 +10,8 @@ - + @@ -480,7 +480,7 @@
class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]ΒΆ
-

Bases: Button

+

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.

@@ -488,7 +488,7 @@
Parameters:

  • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

    • -

  • label (str) – The label of the button, set to β€œDelete” if not specified.

    • +

  • label (str) – The label of the button, set to β€œDelete” if not specified.

@@ -503,7 +503,7 @@

Delete the original message on button click.

Return type:
-

None

+

None

@@ -513,16 +513,16 @@
class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]ΒΆ
-

Bases: View

+

Bases: View

A view that allows only allows the specified users, or users with the specified roles, 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.

    • -

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. +

  • 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 (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – 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.

@@ -538,10 +538,10 @@ If None

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

+

bool

@@ -552,7 +552,7 @@ If None

Remove the view from self.message if set.

Return type:
-

None

+

None

@@ -563,7 +563,7 @@ If None

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

Return type:
-

None

+

None

@@ -577,13 +577,13 @@ If None
Parameters:
    -

  • user (User | Member) – The user to check

    • -

  • allowed_users (Sequence[int]) – A sequence of user ids that are allowed access

    • -

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed access

    • +

  • user (User | Member) – The user to check

    • +

  • allowed_users (Sequence[int]) – A sequence of user ids that are allowed access

    • +

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed access

Return type:
-

bool

+

bool

-- cgit v1.2.3