aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRapptz <[email protected]>2021-04-28 01:37:26 -0400
committerRapptz <[email protected]>2021-05-27 00:53:14 -0400
commiteda668037718e9ee8a99ea9f5773149c22fedce2 (patch)
tree5bd92e3355d99916b8513a1ecfac8ef4dbdbe4d0
parentProperly guard for DMs in interaction creation (diff)
downloaddiscord.py-eda668037718e9ee8a99ea9f5773149c22fedce2.tar.xz
discord.py-eda668037718e9ee8a99ea9f5773149c22fedce2.zip
Rename enums to use official API naming
-rw-r--r--discord/enums.py14
-rw-r--r--discord/ui/button.py2
-rw-r--r--discord/ui/view.py2
-rw-r--r--docs/api.rst29
4 files changed, 24 insertions, 23 deletions
diff --git a/discord/enums.py b/discord/enums.py
index a06e473e..b7e4ee30 100644
--- a/discord/enums.py
+++ b/discord/enums.py
@@ -445,7 +445,7 @@ class InteractionResponseType(Enum):
# channel_message = 3 (deprecated)
channel_message = 4 # (with source)
deferred_channel_message = 5 # (with source)
- ack = 6 # for components?
+ deferred_message_update = 6 # for components
class VideoQualityMode(Enum):
auto = 1
@@ -455,18 +455,18 @@ class VideoQualityMode(Enum):
return self.value
class ComponentType(Enum):
- group = 1
+ action_row = 1
button = 2
def __int__(self):
return self.value
class ButtonStyle(Enum):
- blurple = 1
- grey = 2
- green = 3
- red = 4
- hyperlink = 5
+ primary = 1
+ secondary = 2
+ success = 3
+ danger = 4
+ link = 5
def __int__(self):
return self.value
diff --git a/discord/ui/button.py b/discord/ui/button.py
index 0d156a96..b81266aa 100644
--- a/discord/ui/button.py
+++ b/discord/ui/button.py
@@ -222,7 +222,7 @@ def button(
*,
custom_id: Optional[str] = None,
disabled: bool = False,
- style: ButtonStyle = ButtonStyle.grey,
+ style: ButtonStyle = ButtonStyle.secondary,
emoji: Optional[Union[str, PartialEmoji]] = None,
group: Optional[int] = None,
) -> Callable[[ItemCallbackType], ItemCallbackType]:
diff --git a/discord/ui/view.py b/discord/ui/view.py
index 712f787a..d263da09 100644
--- a/discord/ui/view.py
+++ b/discord/ui/view.py
@@ -51,7 +51,7 @@ if TYPE_CHECKING:
def _walk_all_components(components: List[Component]) -> Iterator[Component]:
for item in components:
- if item.type is ComponentType.group:
+ if item.type is ComponentType.action_row:
yield from item.children
else:
yield item
diff --git a/docs/api.rst b/docs/api.rst
index 5c869822..41eabc3c 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1194,9 +1194,10 @@ of :class:`enum.Enum`.
.. attribute:: deferred_channel_message
Responds to a slash command with a message at a later time.
- .. attribute:: ack
+ .. attribute:: deferred_message_update
- Acknowledges the component interaction.
+ Acknowledges the component interaction with a promise that
+ the message will update later (though there is no need to actually update the message).
.. class:: ComponentType
@@ -1204,9 +1205,9 @@ of :class:`enum.Enum`.
.. versionadded:: 2.0
- .. attribute:: group
+ .. attribute:: action_row
- Represents the group component which holds different components.
+ Represents the group component which holds different components in a row.
.. attribute:: button
Represents a button component.
@@ -1217,21 +1218,21 @@ of :class:`enum.Enum`.
.. versionadded:: 2.0
- .. attribute:: blurple::
+ .. attribute:: primary::
- Represents a blurple button.
- .. attribute:: grey::
+ Represents a blurple button for the primary action.
+ .. attribute:: secondary::
- Represents a grey button.
- .. attribute:: green::
+ Represents a grey button for the secondary action.
+ .. attribute:: success::
- Represents a green button.
- .. attribute:: red::
+ Represents a green button for a successful action.
+ .. attribute:: danger::
- Represents a red button.
- .. attribute:: hyperlink::
+ Represents a red button for a dangerous action.
+ .. attribute:: link::
- Represents a hyperlink button.
+ Represents a link button.
.. class:: VoiceRegion