From 36568bc95c0b6b38ede6fde7adb7d4ee2863235f Mon Sep 17 00:00:00 2001 From: wookie184 Date: Tue, 11 Jun 2024 18:54:42 +0000 Subject: Deploying to docs from @ python-discord/bot-core@c17d29a38019ba05a65f1ba3cafa084d2dd76ec7 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.utils.interactions.html | 101 ++++++++++++++++++++----- 1 file changed, 82 insertions(+), 19 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 2465eaec..45cf6bc8 100644 --- a/main/output/pydis_core.utils.interactions.html +++ b/main/output/pydis_core.utils.interactions.html @@ -5,10 +5,10 @@ - + interactions - Pydis Core Latest (11.1.0) - + @@ -72,7 +72,7 @@ Light mode + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> @@ -87,7 +87,7 @@ Dark mode + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> @@ -95,7 +95,7 @@ Auto light/dark mode + stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> @@ -105,6 +105,60 @@ + + Auto light/dark, in light mode + + + + + + + + + + + + + + + Auto light/dark, in dark mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -116,6 +170,8 @@ + +
@@ -133,7 +189,8 @@
@@ -374,11 +431,17 @@ Back to top
- +
+ + + + +
@@ -388,12 +451,12 @@
-
+

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.

@@ -408,12 +471,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:
@@ -426,7 +489,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.

@@ -443,12 +506,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:
@@ -462,7 +525,7 @@ If None
-async on_timeout()[source]¶
+async on_timeout()[source]¶

Remove the view from self.message if set.

Return type:
@@ -473,7 +536,7 @@ If None
-stop()[source]¶
+stop()[source]¶

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

Return type:
@@ -486,7 +549,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:
@@ -587,7 +650,7 @@ If None - + \ No newline at end of file -- cgit v1.2.3