236 lines
9.0 KiB
Python
236 lines
9.0 KiB
Python
# SPDX-License-Identifier: MIT
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any, Dict, List, Optional, Sequence, Union
|
|
|
|
from ..components import VALID_ACTION_ROW_MESSAGE_COMPONENT_TYPES, ActionRowMessageComponent
|
|
from ..enums import ComponentType, try_enum
|
|
from ..message import Message
|
|
from ..ui.action_row import walk_components
|
|
from ..utils import cached_slot_property
|
|
from .base import ClientT, Interaction, InteractionDataResolved
|
|
|
|
__all__ = (
|
|
"MessageInteraction",
|
|
"MessageInteractionData",
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from ..abc import AnyChannel
|
|
from ..member import Member
|
|
from ..role import Role
|
|
from ..state import ConnectionState
|
|
from ..types.interactions import (
|
|
MessageComponentInteractionData as MessageComponentInteractionDataPayload,
|
|
MessageInteraction as MessageInteractionPayload,
|
|
)
|
|
from ..user import User
|
|
|
|
|
|
class MessageInteraction(Interaction[ClientT]):
|
|
"""Represents an interaction with a message component.
|
|
|
|
Current examples are buttons and dropdowns.
|
|
|
|
.. versionadded:: 2.1
|
|
|
|
Attributes
|
|
----------
|
|
id: :class:`int`
|
|
The interaction's ID.
|
|
type: :class:`InteractionType`
|
|
The interaction type.
|
|
application_id: :class:`int`
|
|
The application ID that the interaction was for.
|
|
token: :class:`str`
|
|
The token to continue the interaction. These are valid for 15 minutes.
|
|
guild_id: Optional[:class:`int`]
|
|
The guild ID the interaction was sent from.
|
|
channel: Union[:class:`abc.GuildChannel`, :class:`Thread`, :class:`abc.PrivateChannel`, :class:`PartialMessageable`]
|
|
The channel the interaction was sent from.
|
|
|
|
Note that due to a Discord limitation, DM channels
|
|
may not contain recipient information.
|
|
Unknown channel types will be :class:`PartialMessageable`.
|
|
|
|
.. versionchanged:: 2.10
|
|
If the interaction was sent from a thread and the bot cannot normally access the thread,
|
|
this is now a proper :class:`Thread` object.
|
|
Private channels are now proper :class:`DMChannel`/:class:`GroupChannel`
|
|
objects instead of :class:`PartialMessageable`.
|
|
|
|
.. note::
|
|
If you want to compute the interaction author's or bot's permissions in the channel,
|
|
consider using :attr:`permissions` or :attr:`app_permissions`.
|
|
|
|
author: Union[:class:`User`, :class:`Member`]
|
|
The user or member that sent the interaction.
|
|
|
|
.. note::
|
|
In scenarios where an interaction occurs in a guild but :attr:`.guild` is unavailable,
|
|
such as with user-installed applications in guilds, some attributes of :class:`Member`\\s
|
|
that depend on the guild/role cache will not work due to an API limitation.
|
|
This includes :attr:`~Member.roles`, :attr:`~Member.top_role`, :attr:`~Member.role_icon`,
|
|
and :attr:`~Member.guild_permissions`.
|
|
locale: :class:`Locale`
|
|
The selected language of the interaction's author.
|
|
|
|
.. versionadded:: 2.4
|
|
|
|
.. versionchanged:: 2.5
|
|
Changed to :class:`Locale` instead of :class:`str`.
|
|
|
|
guild_locale: Optional[:class:`Locale`]
|
|
The selected language of the interaction's guild.
|
|
This value is only meaningful in guilds with ``COMMUNITY`` feature and receives a default value otherwise.
|
|
If the interaction was in a DM, then this value is ``None``.
|
|
|
|
.. versionadded:: 2.4
|
|
|
|
.. versionchanged:: 2.5
|
|
Changed to :class:`Locale` instead of :class:`str`.
|
|
|
|
client: :class:`Client`
|
|
The interaction client.
|
|
entitlements: List[:class:`Entitlement`]
|
|
The entitlements for the invoking user and guild,
|
|
representing access to an application subscription.
|
|
|
|
.. versionadded:: 2.10
|
|
|
|
authorizing_integration_owners: :class:`AuthorizingIntegrationOwners`
|
|
Details about the authorizing user/guild for the application installation
|
|
related to the interaction.
|
|
|
|
.. versionadded:: 2.10
|
|
|
|
context: :class:`InteractionContextTypes`
|
|
The context where the interaction was triggered from.
|
|
|
|
This is a flag object, with exactly one of the flags set to ``True``.
|
|
To check whether an interaction originated from e.g. a :attr:`~InteractionContextTypes.guild`
|
|
context, you can use ``if interaction.context.guild:``.
|
|
|
|
.. versionadded:: 2.10
|
|
|
|
attachment_size_limit: :class:`int`
|
|
The maximum number of bytes files can have in responses to this interaction.
|
|
|
|
This may be higher than the default limit, depending on the guild's boost
|
|
status or the invoking user's nitro status.
|
|
|
|
.. versionadded:: 2.11
|
|
|
|
data: :class:`MessageInteractionData`
|
|
The wrapped interaction data.
|
|
message: Optional[:class:`Message`]
|
|
The message that this interaction's component is attached to.
|
|
"""
|
|
|
|
# FIXME(3.0): slots
|
|
|
|
def __init__(self, *, data: MessageInteractionPayload, state: ConnectionState) -> None:
|
|
super().__init__(data=data, state=state)
|
|
self.data: MessageInteractionData = MessageInteractionData(data=data["data"], parent=self)
|
|
self.message = Message(state=self._state, channel=self.channel, data=data["message"])
|
|
|
|
@property
|
|
def values(self) -> Optional[List[str]]:
|
|
"""Optional[List[:class:`str`]]: The values the user selected.
|
|
|
|
For select menus of type :attr:`~ComponentType.string_select`,
|
|
these are just the string values the user selected.
|
|
For other select menu types, these are the IDs of the selected entities.
|
|
|
|
See also :attr:`resolved_values`.
|
|
"""
|
|
return self.data.values
|
|
|
|
@cached_slot_property("_cs_resolved_values")
|
|
def resolved_values(
|
|
self,
|
|
) -> Optional[Sequence[Union[str, Member, User, Role, AnyChannel]]]:
|
|
"""Optional[Sequence[:class:`str`, :class:`Member`, :class:`User`, :class:`Role`, Union[:class:`abc.GuildChannel`, :class:`Thread`, :class:`PartialMessageable`]]]: The (resolved) values the user selected.
|
|
|
|
For select menus of type :attr:`~ComponentType.string_select`,
|
|
this is equivalent to :attr:`values`.
|
|
For other select menu types, these are full objects corresponding to the selected entities.
|
|
|
|
.. versionadded:: 2.7
|
|
"""
|
|
if self.data.values is None:
|
|
return None
|
|
|
|
component_type = self.data.component_type
|
|
# return values as-is if it's a string select
|
|
if component_type is ComponentType.string_select:
|
|
return self.data.values
|
|
|
|
resolved = self.data.resolved
|
|
values: List[Union[Member, User, Role, AnyChannel]] = []
|
|
for key in self.data.values:
|
|
# force upcast to avoid typing issues; we expect the api to only provide valid values
|
|
value: Any = resolved.get_with_type(key, component_type, key)
|
|
values.append(value)
|
|
return values
|
|
|
|
@cached_slot_property("_cs_component")
|
|
def component(self) -> ActionRowMessageComponent:
|
|
"""Union[:class:`Button`, :class:`BaseSelectMenu`]: The component the user interacted with."""
|
|
# FIXME(3.0?): introduce common base type for components with `custom_id`
|
|
for component in walk_components(self.message.components):
|
|
if (
|
|
isinstance(component, VALID_ACTION_ROW_MESSAGE_COMPONENT_TYPES)
|
|
and component.custom_id == self.data.custom_id
|
|
):
|
|
return component
|
|
|
|
raise Exception("MessageInteraction is malformed - no component found") # noqa: TRY002
|
|
|
|
|
|
class MessageInteractionData(Dict[str, Any]):
|
|
"""Represents the data of an interaction with a message component.
|
|
|
|
.. versionadded:: 2.1
|
|
|
|
Attributes
|
|
----------
|
|
custom_id: :class:`str`
|
|
The custom ID of the component.
|
|
component_type: :class:`ComponentType`
|
|
The type of the component.
|
|
values: Optional[List[:class:`str`]]
|
|
The values the user has selected in a select menu.
|
|
For non-string select menus, this contains IDs for use with :attr:`resolved`.
|
|
resolved: :class:`InteractionDataResolved`
|
|
All resolved objects related to this interaction.
|
|
|
|
.. versionadded:: 2.7
|
|
"""
|
|
|
|
__slots__ = ("custom_id", "component_type", "values", "resolved")
|
|
|
|
def __init__(
|
|
self,
|
|
*,
|
|
data: MessageComponentInteractionDataPayload,
|
|
parent: MessageInteraction[ClientT],
|
|
) -> None:
|
|
super().__init__(data)
|
|
self.custom_id: str = data["custom_id"]
|
|
self.component_type: ComponentType = try_enum(ComponentType, data["component_type"])
|
|
self.values: Optional[List[str]] = (
|
|
list(map(str, values)) if (values := data.get("values")) else None
|
|
)
|
|
|
|
self.resolved: InteractionDataResolved = InteractionDataResolved(
|
|
data=data.get("resolved", {}), parent=parent
|
|
)
|
|
|
|
def __repr__(self) -> str:
|
|
return (
|
|
f"<MessageInteractionData custom_id={self.custom_id!r} "
|
|
f"component_type={self.component_type!r} values={self.values!r}>"
|
|
)
|