yuyo.components#

Execute this component.

Parameters:

• ctx (Context) –

  The context to execute this with.

Raises:

• ExecutorClosed –

  If the executor is closed.

Initialise an action column executor.

Parameters:

• authors (typing.Optional[abc.Iterable[hikari.SnowflakeishOr[hikari.User]]], default: None ) –

  Users who are allowed to use the components this represents.

  If no users are provided then the components will be public (meaning that anybody can use it).

• ephemeral_default (bool, default: False ) –

  Whether or not the responses made on contexts spawned from this executor should default to ephemeral (meaning only the author can see them) unless flags is specified on the response method.

• id_metadata (typing.Optional[abc.Mapping[str, str]], default: None ) –

  Mapping of metadata to append to the custom IDs in this column.

  The keys in this can either be the match part of component custom IDs or the names of the component's callback when it was added using one of the as_ class descriptors.

Add a raw component builder to this action column.

This is mostly for adding components where the custom ID is already registered as a separate constant executor.

Parameters:

• builder (ComponentBuilder) –

  The component builder to add to the column.

Add a channel select menu to this action column.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• channel_types (typing.Optional[abc.Sequence[typing.Union[ChannelType, type[hikari.PartialChannel]]]], default: None ) –

  Sequence of the types of channels this select menu should show as options.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• Self –

  The action column to enable chained calls.

Add an interactive button to this action column.

Either emoji xor label must be provided to be the button's displayed label.

Parameters:

• style (InteractiveButtonTypesT) –

  The button's style.

• callback (CallbackSig) –

  The button's execution callback.

• custom_id (typing.Optional[str], default: None ) –

  The button's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• emoji (typing.Union[Snowflakeish, Emoji, str, UndefinedType], default: UNDEFINED ) –

  The button's emoji.

• label (hikari.UndefinedOr[str], default: UNDEFINED ) –

  The button's label.

• is_disabled (bool, default: False ) –

  Whether the button should be marked as disabled.

Returns:

• Self –

  The action column to enable chained calls.

Add a link button to this action column.

Either emoji xor label must be provided to be the button's displayed label.

Parameters:

• url (str) –

  The button's url.

• emoji (typing.Union[Snowflakeish, Emoji, str, UndefinedType], default: UNDEFINED ) –

  The button's emoji.

• label (hikari.UndefinedOr[str], default: UNDEFINED ) –

  The button's label.

• is_disabled (bool, default: False ) –

  Whether the button should be marked as disabled.

Returns:

• Self –

  The action column to enable chained calls.

Add a mentionable select menu to this action column.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• Self –

  The action column to enable chained calls.

Add a role select menu to this action column.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• Self –

  The action column to enable chained calls.

Add a select menu to this action column.

The following methods should be used instead:

• .add_channel_menu
• .add_mentionable_menu
• .add_role_menu
• .add_text_menu
• .add_user_menu

Add a raw component builder to all subclasses and instances of this column.

This is mostly for adding components where the custom ID is already registered as a separate constant executor.

Parameters:

• builder (ComponentBuilder) –

  The component builder to add to the column class.

Add a channel select menu to all subclasses and instances of this action column class.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• channel_types (typing.Optional[abc.Sequence[typing.Union[ChannelType, type[hikari.PartialChannel]]]], default: None ) –

  Sequence of the types of channels this select menu should show as options.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• type[Self] –

  The action column class to enable chained calls.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add an interactive button to all subclasses and instances of this action column class.

Either emoji xor label must be provided to be the button's displayed label.

Parameters:

• style (InteractiveButtonTypesT) –

  The button's style.

• callback (CallbackSig) –

  The button's execution callback.

• custom_id (typing.Optional[str], default: None ) –

  The button's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• emoji (typing.Union[Snowflakeish, Emoji, str, UndefinedType], default: UNDEFINED ) –

  The button's emoji.

• label (hikari.UndefinedOr[str], default: UNDEFINED ) –

  The button's label.

• is_disabled (bool, default: False ) –

  Whether the button should be marked as disabled.

Returns:

• type[Self] –

  The action column class to enable chained calls.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a link button to all subclasses and instances of this action column class.

Either emoji xor label must be provided to be the button's displayed label.

Parameters:

• url (str) –

  The button's url.

• emoji (typing.Union[Snowflakeish, Emoji, str, UndefinedType], default: UNDEFINED ) –

  The button's emoji.

• label (hikari.UndefinedOr[str], default: UNDEFINED ) –

  The button's label.

• is_disabled (bool, default: False ) –

  Whether the button should be marked as disabled.

Returns:

• type[Self] –

  The action column class to enable chained calls.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a mentionable select menu to all subclasses and instances of this action column class.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• type[Self] –

  The action column class to enable chained calls.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a role select menu to all subclasses and instances of this action column class.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• type[Self] –

  The action column class to enable chained calls.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a select menu to all subclasses and instances of this action column class.

The following class methods should be used instead:

• .add_static_channel_menu
• .add_static_mentionable_menu
• .add_static_role_menu
• .add_static_text_menu
• .add_static_user_menu

Add a text select menu to all subclasses and instances of this action column class.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• options (abc.Sequence[hikari.api.SelectOptionBuilder], default: () ) –

  The text select's options.

  These can also be added by calling TextSelectMenuBuilder.add_option.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• TextSelectMenuBuilder –

  Builder for the added text select menu.

  TextSelectMenuBuilder.add_option should be used to add options to this select menu.

  And the parent action column can be accessed by calling TextSelectMenuBuilder.parent.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a user select menu to all subclasses and instances of this action column class.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• type[Self] –

  The action column class to enable chained calls.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a text select menu to this action column.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• options (abc.Sequence[hikari.api.SelectOptionBuilder], default: () ) –

  The text select's options.

  These can also be added by calling TextSelectMenuBuilder.add_option.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• TextSelectMenuBuilder –

  Builder for the added text select menu.

  TextSelectMenuBuilder.add_option should be used to add options to this select menu.

  And the parent action column can be accessed by calling TextSelectMenuBuilder.parent.

Add a user select menu to this action column.

Parameters:

• callback (CallbackSig) –

  Callback which is called when this select menu is used.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Returns:

• Self –

  The action column to enable chained calls.

Add a channel select menu to this action column through a decorator call.

Parameters:

• channel_types (typing.Optional[abc.Sequence[typing.Union[ChannelType, type[hikari.PartialChannel]]]], default: None ) –

  Sequence of the types of channels this select menu should show as options.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Add an interactive button to this action column through a decorator call.

Either emoji xor label must be provided to be the button's displayed label.

Parameters:

• style (InteractiveButtonTypesT) –

  The button's style.

• custom_id (typing.Optional[str], default: None ) –

  The button's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• emoji (typing.Union[Snowflakeish, Emoji, str, UndefinedType], default: UNDEFINED ) –

  The button's emoji.

• label (hikari.UndefinedOr[str], default: UNDEFINED ) –

  The button's label.

• is_disabled (bool, default: False ) –

  Whether the button should be marked as disabled.

Add a mentionable select menu to this action column through a decorator call.

Parameters:

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Add a role select menu to this action column through a decorator call.

Parameters:

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Add a channel select menu to this action column class through a decorator call.

Parameters:

• channel_types (typing.Optional[abc.Sequence[typing.Union[ChannelType, type[hikari.PartialChannel]]]], default: None ) –

  Sequence of the types of channels this select menu should show as options.

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a static interactive button to this action column class through a decorator call.

Either emoji xor label must be provided to be the button's displayed label.

Parameters:

• style (InteractiveButtonTypesT) –

  The button's style.

• custom_id (typing.Optional[str], default: None ) –

  The button's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• emoji (typing.Union[Snowflakeish, Emoji, str, UndefinedType], default: UNDEFINED ) –

  The button's emoji.

• label (hikari.UndefinedOr[str], default: UNDEFINED ) –

  The button's label.

• is_disabled (bool, default: False ) –

  Whether the button should be marked as disabled.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a static mentionable select menu to this action column class through a decorator call.

Parameters:

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a static role select menu to this action column class through a decorator call.

Parameters:

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a text select menu to this action column class through a decorator call.

Parameters:

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• options (abc.Sequence[hikari.api.SelectOptionBuilder], default: () ) –

  The text select's options.

  These can also be added using [yuyo.components.with_option].

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a static user select menu to this action column class through a decorator call.

Parameters:

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Raises:

• RuntimeError –

  When called directly on ActionColumnExecutor (rather than on a subclass).

Add a text select menu to this action column through a decorator callback.

Parameters:

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• options (abc.Sequence[hikari.api.SelectOptionBuilder], default: () ) –

  The text select's options.

  These can also be added using components.with_option.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Add a user select menu to this action column through a decorator call.

Parameters:

• custom_id (typing.Optional[str], default: None ) –

  The select menu's custom ID.

  Defaults to a UUID and cannot be longer than 100 characters.

  Only custom_id.split(":", 1)[0] will be used to match against interactions. Anything after ":" is metadata.

• placeholder (hikari.UndefinedOr[str], default: UNDEFINED ) –

  Placeholder text to show when no entries have been selected.

• min_values (int, default: 0 ) –

  The minimum amount of entries which need to be selected.

• max_values (int, default: 1 ) –

  The maximum amount of entries which can be selected.

• is_disabled (bool, default: False ) –

  Whether this select menu should be marked as disabled.

Create a followup response for this context.

Parameters:

• content (hikari.UndefinedOr[typing.Any], default: UNDEFINED ) –

  If provided, the message content to send.

  If this is a hikari.Embed and no embed nor embeds kwarg is provided, then this will instead be treated as an embed. This allows for simpler syntax when sending an embed alone.

  Likewise, if this is a hikari.Resource, then the content is instead treated as an attachment if no attachment and no attachments kwargs are provided.

• delete_after (typing.Union[timedelta, float, int, None], default: None ) –

  If provided, the seconds after which the response message should be deleted.

  Interaction responses can only be deleted within 15 minutes of the interaction being received.

• ephemeral (typing.Optional[bool], default: None ) –

  Whether the deferred response should be ephemeral. Passing True here is a shorthand for including 1 << 64 in the passed flags.

• attachment (hikari.UndefinedOr[hikari.Resourceish], default: UNDEFINED ) –

  If provided, the message attachment. This can be a resource, or string of a path on your computer or a URL.

• attachments (hikari.UndefinedOr[abc.Sequence[hikari.Resourceish]], default: UNDEFINED ) –

  If provided, the message attachments. These can be resources, or strings consisting of paths on your computer or URLs.

• component (hikari.UndefinedOr[hikari.api.ComponentBuilder], default: UNDEFINED ) –

  If provided, builder object of the component to include in this message.

• components (hikari.UndefinedOr[abc.Sequence[hikari.api.ComponentBuilder]], default: UNDEFINED ) –

  If provided, a sequence of the component builder objects to include in this message.

• embed (hikari.UndefinedOr[hikari.Embed], default: UNDEFINED ) –

  If provided, the message embed.

• embeds (hikari.UndefinedOr[abc.Sequence[hikari.Embed]], default: UNDEFINED ) –

  If provided, the message embeds.

• mentions_everyone (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message should parse @everyone/@here mentions.

• user_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialUser], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialUser derivatives to enforce mentioning specific users.

• role_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialRole], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialRole derivatives to enforce mentioning specific roles.

• tts (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message will be sent as a TTS message.

• flags (typing.Union[UndefinedType, int, MessageFlag], default: UNDEFINED ) –

  The flags to set for this response.

  As of writing this can only flag which can be provided is EPHEMERAL, other flags are just ignored.

Returns:

• Message –

  The created message object.

Raises:

• NotFoundError –

  If the current interaction is not found or it hasn't had an initial response yet.

• BadRequestError –

  This can be raised if the file is too large; if the embed exceeds the defined limits; if the message content is specified only and empty or greater than 2000 characters; if neither content, file or embeds are specified. If any invalid snowflake IDs are passed; a snowflake may be invalid due to it being outside of the range of a 64 bit integer.

• ValueError –

  If more than 100 unique objects/entities are passed for role_mentions or `user_mentions.

  If the interaction will have expired before delete_after is reached.

  If both attachment and attachments are passed or both component and components are passed or both embed and embeds are passed.

Create the initial response for this context.

Parameters:

• content (hikari.UndefinedOr[typing.Any], default: UNDEFINED ) –

  If provided, the message content to respond with.

  If this is a hikari.Embed and no embed nor embeds kwarg is provided, then this will instead be treated as an embed. This allows for simpler syntax when sending an embed alone.

  Likewise, if this is a hikari.Resource, then the content is instead treated as an attachment if no attachment and no attachments kwargs are provided.

• response_type (MessageResponseTypesT, default: MESSAGE_CREATE ) –

  The type of message response to give.

• delete_after (typing.Union[timedelta, float, int, None], default: None ) –

  If provided, the seconds after which the response message should be deleted.

  Interaction responses can only be deleted within 15 minutes of the interaction being received.

• ephemeral (typing.Optional[bool], default: None ) –

  Whether the deferred response should be ephemeral.

  Passing True here is a shorthand for including 1 << 64 in the passed flags.

• attachment (hikari.UndefinedOr[hikari.Resourceish], default: UNDEFINED ) –

  If provided, the message attachment. This can be a resource, or string of a path on your computer or a URL.

• attachments (hikari.UndefinedOr[abc.Sequence[hikari.Resourceish]], default: UNDEFINED ) –

  If provided, the message attachments. These can be resources, or strings consisting of paths on your computer or URLs.

• component (hikari.UndefinedOr[hikari.api.ComponentBuilder], default: UNDEFINED ) –

  If provided, builder object of the component to include in this message.

• components (hikari.UndefinedOr[abc.Sequence[hikari.api.ComponentBuilder]], default: UNDEFINED ) –

  If provided, a sequence of the component builder objects to include in this message.

• embed (hikari.UndefinedOr[hikari.Embed], default: UNDEFINED ) –

  If provided, the message embed.

• embeds (hikari.UndefinedOr[abc.Sequence[hikari.Embed]], default: UNDEFINED ) –

  If provided, the message embeds.

• flags (typing.Union[int, MessageFlag, UndefinedType], default: UNDEFINED ) –

  If provided, the message flags this response should have.

  As of writing the only message flag which can be set here is MessageFlag.EPHEMERAL.

• tts (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message will be read out by a screen reader using Discord's TTS (text-to-speech) system.

• mentions_everyone (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message should parse @everyone/@here mentions.

• user_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialUser], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialUser derivatives to enforce mentioning specific users.

• role_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialRole], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialRole derivatives to enforce mentioning specific roles.

Raises:

• ValueError –

  If more than 100 unique objects/entities are passed for role_mentions or user_mentions.

  If the interaction will have expired before delete_after is reached.

  If both attachment and attachments are passed or both component and components are passed or both embed and embeds are passed.

• BadRequestError –

  This may be raised in several discrete situations, such as messages being empty with no embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; invalid image URLs in embeds.

• UnauthorizedError –

  If you are unauthorized to make the request (invalid/missing token).

• NotFoundError –

  If the interaction is not found or if the interaction's initial response has already been created.

• RateLimitTooLongError –

  Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

• InternalServerError –

  If an internal error occurs on Discord while handling the request.

Defer the initial response for this context.

Parameters:

• defer_type (DeferredResponseTypesT, default: DEFERRED_MESSAGE_CREATE ) –

  The type of deferral this should be.

  This may any of the following:

  • ResponseType.DEFERRED_MESSAGE_CREATE to indicate that the following up call to BaseContext.edit_initial_response or BaseContext.respond should create a new message.
  • ResponseType.DEFERRED_MESSAGE_UPDATE to indicate that the following call to the aforementioned methods should update the existing message.
• ephemeral (typing.Optional[bool], default: None ) –

  Whether the deferred response should be ephemeral.

  Passing True here is a shorthand for including 1 << 64 in the passed flags.

• flags (typing.Union[UndefinedType, int, MessageFlag], default: UNDEFINED ) –

  The flags to use for the initial response.

Delete the initial response after invoking this context.

Raises:

• (LookupError, NotFoundError) –

  The last context has no initial response.

Delete the last response after invoking this context.

Raises:

• (LookupError, NotFoundError) –

  The last context has no responses.

Edit the initial response for this context.

Parameters:

• content (hikari.UndefinedOr[typing.Any], default: UNDEFINED ) –

  If provided, the message content to edit the initial response with.

  If this is a hikari.Embed and no embed nor embeds kwarg is provided, then this will instead update the embed. This allows for simpler syntax when sending an embed alone.

  Likewise, if this is a hikari.Resource, then the content is instead treated as an attachment if no attachment and no attachments kwargs are provided.

• delete_after (typing.Union[timedelta, float, int, None], default: None ) –

  If provided, the seconds after which the response message should be deleted.

  Interaction responses can only be deleted within 15 minutes of the interaction being received.

• attachment (hikari.UndefinedNoneOr[hikari.Resourceish], default: UNDEFINED ) –

  A singular attachment to edit the initial response with.

• attachments (hikari.UndefinedNoneOr[abc.Sequence[hikari.Resourceish]], default: UNDEFINED ) –

  A sequence of attachments to edit the initial response with.

• component (hikari.UndefinedNoneOr[hikari.api.ComponentBuilder], default: UNDEFINED ) –

  If provided, builder object of the component to set for this message. This component will replace any previously set components and passing None will remove all components.

• components (hikari.UndefinedNoneOr[abc.Sequence[hikari.api.ComponentBuilder]], default: UNDEFINED ) –

  If provided, a sequence of the component builder objects set for this message. These components will replace any previously set components and passing None or an empty sequence will remove all components.

• embed (hikari.UndefinedNoneOr[hikari.Embed], default: UNDEFINED ) –

  An embed to replace the initial response with.

• embeds (hikari.UndefinedNoneOr[abc.Sequence[hikari.Embed]], default: UNDEFINED ) –

  A sequence of embeds to replace the initial response with.

• mentions_everyone (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message should parse @everyone/@here mentions.

• user_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialUser], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialUser derivatives to enforce mentioning specific users.

• role_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialRole], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialRole derivatives to enforce mentioning specific roles.

Returns:

• Message –

  The message that has been edited.

Raises:

• ValueError –

  If more than 100 unique objects/entities are passed for role_mentions or user_mentions.

  If delete_after would be more than 15 minutes after the interaction was received.

  If both attachment and attachments are passed or both component and components are passed or both embed and embeds are passed.

• BadRequestError –

  This may be raised in several discrete situations, such as messages being empty with no attachments or embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; too many attachments; attachments that are too large; invalid image URLs in embeds; too many components.

• UnauthorizedError –

  If you are unauthorized to make the request (invalid/missing token).

• ForbiddenError –

  If you are missing the SEND_MESSAGES in the channel or the person you are trying to message has the DM's disabled.

• NotFoundError –

  If the channel is not found.

• RateLimitTooLongError –

  Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

• InternalServerError –

  If an internal error occurs on Discord while handling the request.

Edit the last response for this context.

Parameters:

• content (hikari.UndefinedOr[typing.Any], default: UNDEFINED ) –

  If provided, the content to edit the last response with.

  If this is a hikari.Embed and no embed nor embeds kwarg is provided, then this will instead update the embed. This allows for simpler syntax when sending an embed alone.

  Likewise, if this is a hikari.Resource, then the content is instead treated as an attachment if no attachment and no attachments kwargs are provided.

• delete_after (typing.Union[timedelta, float, int, None], default: None ) –

  If provided, the seconds after which the response message should be deleted.

  Interaction responses can only be deleted within 15 minutes of the interaction being received.

• attachment (hikari.UndefinedNoneOr[hikari.Resourceish], default: UNDEFINED ) –

  A singular attachment to edit the last response with.

• attachments (hikari.UndefinedNoneOr[abc.Sequence[hikari.Resourceish]], default: UNDEFINED ) –

  A sequence of attachments to edit the last response with.

• component (hikari.UndefinedNoneOr[hikari.api.ComponentBuilder], default: UNDEFINED ) –

  If provided, builder object of the component to set for this message. This component will replace any previously set components and passing None will remove all components.

• components (hikari.UndefinedNoneOr[abc.Sequence[hikari.api.ComponentBuilder]], default: UNDEFINED ) –

  If provided, a sequence of the component builder objects set for this message. These components will replace any previously set components and passing None or an empty sequence will remove all components.

• embed (hikari.UndefinedNoneOr[hikari.Embed], default: UNDEFINED ) –

  An embed to replace the last response with.

• embeds (hikari.UndefinedNoneOr[abc.Sequence[hikari.Embed]], default: UNDEFINED ) –

  A sequence of embeds to replace the last response with.

• mentions_everyone (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message should parse @everyone/@here mentions.

• user_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialUser], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialUser derivatives to enforce mentioning specific users.

• role_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialRole], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialRole derivatives to enforce mentioning specific roles.

Returns:

• Message –

  The message that has been edited.

Raises:

• ValueError –

  If more than 100 unique objects/entities are passed for role_mentions or user_mentions.

  If delete_after would be more than 15 minutes after the slash interaction was received.

  If both attachment and attachments are passed or both component and components are passed or both embed and embeds are passed.

• BadRequestError –

  This may be raised in several discrete situations, such as messages being empty with no attachments or embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; too many attachments; attachments that are too large; invalid image URLs in embeds; too many components.

• UnauthorizedError –

  If you are unauthorized to make the request (invalid/missing token).

• ForbiddenError –

  If you are missing the SEND_MESSAGES in the channel or the person you are trying to message has the DM's disabled.

• NotFoundError –

  If the channel is not found.

• RateLimitTooLongError –

  Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

• InternalServerError –

  If an internal error occurs on Discord while handling the request.

Fetch the initial response for this context.

Returns:

• Message –

  The initial response's message object.

Raises:

• (LookupError, NotFoundError) –

  The response was not found.

Fetch the last response for this context.

Returns:

• Message –

  The most response response's message object.

Raises:

• (LookupError, NotFoundError) –

  The response was not found.

Respond to this context.

Parameters:

• content (hikari.UndefinedOr[typing.Any], default: UNDEFINED ) –

  If provided, the message content to respond with.

  If this is a hikari.Embed and no embed nor embeds kwarg is provided, then this will instead be treated as an embed. This allows for simpler syntax when sending an embed alone.

  Likewise, if this is a hikari.Resource, then the content is instead treated as an attachment if no attachment and no attachments kwargs are provided.

• ensure_result (bool, default: False ) –

  Ensure that this call will always return a message object.

  If True then this will always return hikari.Message, otherwise this will return hikari.Message | None.

  It's worth noting that this may lead to an extre request being made under certain scenarios.

• delete_after (typing.Union[timedelta, float, int, None], default: None ) –

  If provided, the seconds after which the response message should be deleted.

  Interaction responses can only be deleted within 15 minutes of the interaction being received.

• attachment (hikari.UndefinedOr[hikari.Resourceish], default: UNDEFINED ) –

  If provided, the message attachment. This can be a resource, or string of a path on your computer or a URL.

• attachments (hikari.UndefinedOr[abc.Sequence[hikari.Resourceish]], default: UNDEFINED ) –

  If provided, the message attachments. These can be resources, or strings consisting of paths on your computer or URLs.

• component (hikari.UndefinedOr[hikari.api.ComponentBuilder], default: UNDEFINED ) –

  If provided, builder object of the component to include in this response.

• components (hikari.UndefinedOr[abc.Sequence[hikari.api.ComponentBuilder]], default: UNDEFINED ) –

  If provided, a sequence of the component builder objects to include in this response.

• embed (hikari.UndefinedOr[hikari.Embed], default: UNDEFINED ) –

  An embed to respond with.

• embeds (hikari.UndefinedOr[abc.Sequence[hikari.Embed]], default: UNDEFINED ) –

  A sequence of embeds to respond with.

• mentions_everyone (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message should parse @everyone/@here mentions.

• user_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialUser], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialUser derivatives to enforce mentioning specific users.

• role_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialRole], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialRole derivatives to enforce mentioning specific roles.

Returns:

• Message | None –

  The message that has been created if it was immedieatly available or ensure_result was set to True, else None.

Raises:

• ValueError –

  If more than 100 unique objects/entities are passed for role_mentions or user_mentions.

  If delete_after would be more than 15 minutes after the interaction was received.

  If both attachment and attachments are passed or both component and components are passed or both embed and embeds are passed.

• BadRequestError –

  This may be raised in several discrete situations, such as messages being empty with no attachments or embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; too many attachments; attachments that are too large; invalid image URLs in embeds; too many components.

• UnauthorizedError –

  If you are unauthorized to make the request (invalid/missing token).

• ForbiddenError –

  If you are missing the SEND_MESSAGES in the channel or the person you are trying to message has the DM's disabled.

• NotFoundError –

  If the channel is not found.

• RateLimitTooLongError –

  Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

• InternalServerError –

  If an internal error occurs on Discord while handling the request.

Set the ephemeral default state for this context.

Parameters:

• state (bool) –

  The new ephemeral default state.

  If this is True then all calls to the response creating methods on this context will default to being ephemeral.

Initialise a component client.

This sets ComponentClient as a type dependency when alluka isn't passed.

Parameters:

• alluka (typing.Optional[alluka.abc.Client], default: None ) –

  The Alluka client to use for callback dependency injection in this client.

  If not provided then this will initialise its own Alluka client.

• event_manager (typing.Optional[hikari.api.EventManager], default: None ) –

  The event manager this client should listen to dispatched component interactions from if applicable.

• event_managed (typing.Optional[bool], default: None ) –

  Whether this client should be automatically opened and closed based on the lifetime events dispatched by event_manager.

  Defaults to True if an event manager is passed.

• server (typing.Optional[hikari.api.InteractionServer], default: None ) –

  The server this client should listen to component interactions from if applicable.

Raises:

• ValueError –

  If event_managed is passed as True when event_manager is None.

Close the component client.

Remove a component executor by its custom IDs.

Parameters:

• executor (AbstractComponentExecutor) –

  The executor to remove.

Returns:

• Self –

  The component client to allow chaining.

Raises:

• KeyError –

  If the executor isn't registered.

Remove a component executor by its message.

Parameters:

• message (hikari.SnowflakeishOr[hikari.Message]) –

  The message to remove the executor for.

Returns:

• Self –

  The component client to allow chaining.

Raises:

• KeyError –

  If the message is not registered.

Build a component client from a Gateway Bot.

This sets ComponentClient as a type dependency when alluka isn't passed.

Parameters:

• bot (_GatewayBotProto) –

  The Gateway bot this component client should be bound to.

• alluka (typing.Optional[alluka.abc.Client], default: None ) –

  The Alluka client to use for callback dependency injection in this client.

  If not provided then this will initialise its own Alluka client.

• event_managed (bool, default: True ) –

  Whether the component client should be automatically opened and closed based on the lifetime events dispatched by bot.

Returns:

• ComponentClient –

  The initialised component client.

Build a component client from a REST Bot.

This sets ComponentClient as a type dependency when alluka isn't passed.

Parameters:

• bot (RESTBotAware) –

  The REST bot this component client should be bound to.

• alluka (typing.Optional[alluka.abc.Client], default: None ) –

  The Alluka client to use for callback dependency injection in this client.

  If not provided then this will initialise its own Alluka client.

• bot_managed (bool, default: False ) –

  Whether the component client should be automatically opened and closed based on the Bot's startup and shutdown callbacks.

Returns:

• ComponentClient –

  The initialised component client.

Build a component client from a Tanjun client.

This will use the Tanjun client's alluka client and registers ComponentClient as a type dependency on Tanjun.

Parameters:

• tanjun_client (Client) –

  The Tanjun client this component client should be bound to.

• tanjun_managed (bool, default: True ) –

  Whether the component client should be automatically opened and closed based on the Tanjun client's lifetime client callback.

Returns:

• ComponentClient –

  The initialised component client.

Get the component executor registered for a custom ID.

Parameters:

• custom_id (str) –

  The custom ID to get the executor for.

Returns:

• AbstractComponentExecutor | None –

  The executor set for the custom ID or None if none is set.

Get the component executor registered for a message.

Parameters:

• message (hikari.SnowflakeishOr[hikari.Message]) –

  The message to get the executor for.

Returns:

• AbstractComponentExecutor | None –

  The executor set for the message or None if none is set.

Process an interaction create gateway event.

Parameters:

• event (InteractionCreateEvent) –

  The interaction create gateway event to process.

Process a component interaction REST request.

Parameters:

• interaction (ComponentInteraction) –

  The interaction to process.

Returns:

• ResponseT –

  The REST response.

Startup the component client.

Add an executor to this client.

Parameters:

• executor (AbstractComponentExecutor) –

  The executor to register.

• message (typing.Optional[hikari.SnowflakeishOr[hikari.Message]], default: None ) –

  The message to register this executor for.

  If this is left as None then this executor will be registered globally for its custom IDs.

• timeout (typing.Union[AbstractTimeout, None, NoDefault], default: NO_DEFAULT ) –

  The executor's timeout.

  This defaults to a 30 second sliding timeout.

Returns:

• Self –

  The component client to allow chaining.

Raises:

• ValueError –

  If message is already registered when it's passed.

  If any of the executor's custom IDs are already registered when message wasn't passed.

Create a followup response for this context.

Parameters:

• content (hikari.UndefinedOr[typing.Any], default: UNDEFINED ) –

  If provided, the message content to send.

  If this is a hikari.Embed and no embed nor embeds kwarg is provided, then this will instead be treated as an embed. This allows for simpler syntax when sending an embed alone.

  Likewise, if this is a hikari.Resource, then the content is instead treated as an attachment if no attachment and no attachments kwargs are provided.

• delete_after (typing.Union[timedelta, float, int, None], default: None ) –

  If provided, the seconds after which the response message should be deleted.

  Interaction responses can only be deleted within 15 minutes of the interaction being received.

• ephemeral (typing.Optional[bool], default: None ) –

  Whether the deferred response should be ephemeral. Passing True here is a shorthand for including 1 << 64 in the passed flags.

• attachment (hikari.UndefinedOr[hikari.Resourceish], default: UNDEFINED ) –

  If provided, the message attachment. This can be a resource, or string of a path on your computer or a URL.

• attachments (hikari.UndefinedOr[abc.Sequence[hikari.Resourceish]], default: UNDEFINED ) –

  If provided, the message attachments. These can be resources, or strings consisting of paths on your computer or URLs.

• component (hikari.UndefinedOr[hikari.api.ComponentBuilder], default: UNDEFINED ) –

  If provided, builder object of the component to include in this message.

• components (hikari.UndefinedOr[abc.Sequence[hikari.api.ComponentBuilder]], default: UNDEFINED ) –

  If provided, a sequence of the component builder objects to include in this message.

• embed (hikari.UndefinedOr[hikari.Embed], default: UNDEFINED ) –

  If provided, the message embed.

• embeds (hikari.UndefinedOr[abc.Sequence[hikari.Embed]], default: UNDEFINED ) –

  If provided, the message embeds.

• mentions_everyone (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message should parse @everyone/@here mentions.

• user_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialUser], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialUser derivatives to enforce mentioning specific users.

• role_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialRole], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialRole derivatives to enforce mentioning specific roles.

• tts (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message will be sent as a TTS message.

• flags (typing.Union[UndefinedType, int, MessageFlag], default: UNDEFINED ) –

  The flags to set for this response.

  As of writing this can only flag which can be provided is EPHEMERAL, other flags are just ignored.

Returns:

• Message –

  The created message object.

Raises:

• NotFoundError –

  If the current interaction is not found or it hasn't had an initial response yet.

• BadRequestError –

  This can be raised if the file is too large; if the embed exceeds the defined limits; if the message content is specified only and empty or greater than 2000 characters; if neither content, file or embeds are specified. If any invalid snowflake IDs are passed; a snowflake may be invalid due to it being outside of the range of a 64 bit integer.

• ValueError –

  If more than 100 unique objects/entities are passed for role_mentions or `user_mentions.

  If the interaction will have expired before delete_after is reached.

  If both attachment and attachments are passed or both component and components are passed or both embed and embeds are passed.

Create the initial response for this context.

Parameters:

• content (hikari.UndefinedOr[typing.Any], default: UNDEFINED ) –

  If provided, the message content to respond with.

  If this is a hikari.Embed and no embed nor embeds kwarg is provided, then this will instead be treated as an embed. This allows for simpler syntax when sending an embed alone.

  Likewise, if this is a hikari.Resource, then the content is instead treated as an attachment if no attachment and no attachments kwargs are provided.

• response_type (MessageResponseTypesT, default: MESSAGE_CREATE ) –

  The type of message response to give.

• delete_after (typing.Union[timedelta, float, int, None], default: None ) –

  If provided, the seconds after which the response message should be deleted.

  Interaction responses can only be deleted within 15 minutes of the interaction being received.

• ephemeral (typing.Optional[bool], default: None ) –

  Whether the deferred response should be ephemeral.

  Passing True here is a shorthand for including 1 << 64 in the passed flags.

• attachment (hikari.UndefinedOr[hikari.Resourceish], default: UNDEFINED ) –

  If provided, the message attachment. This can be a resource, or string of a path on your computer or a URL.

• attachments (hikari.UndefinedOr[abc.Sequence[hikari.Resourceish]], default: UNDEFINED ) –

  If provided, the message attachments. These can be resources, or strings consisting of paths on your computer or URLs.

• component (hikari.UndefinedOr[hikari.api.ComponentBuilder], default: UNDEFINED ) –

  If provided, builder object of the component to include in this message.

• components (hikari.UndefinedOr[abc.Sequence[hikari.api.ComponentBuilder]], default: UNDEFINED ) –

  If provided, a sequence of the component builder objects to include in this message.

• embed (hikari.UndefinedOr[hikari.Embed], default: UNDEFINED ) –

  If provided, the message embed.

• embeds (hikari.UndefinedOr[abc.Sequence[hikari.Embed]], default: UNDEFINED ) –

  If provided, the message embeds.

• flags (typing.Union[int, MessageFlag, UndefinedType], default: UNDEFINED ) –

  If provided, the message flags this response should have.

  As of writing the only message flag which can be set here is MessageFlag.EPHEMERAL.

• tts (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message will be read out by a screen reader using Discord's TTS (text-to-speech) system.

• mentions_everyone (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message should parse @everyone/@here mentions.

• user_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialUser], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialUser derivatives to enforce mentioning specific users.

• role_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialRole], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialRole derivatives to enforce mentioning specific roles.

Raises:

• ValueError –

  If more than 100 unique objects/entities are passed for role_mentions or user_mentions.

  If the interaction will have expired before delete_after is reached.

  If both attachment and attachments are passed or both component and components are passed or both embed and embeds are passed.

• BadRequestError –

  This may be raised in several discrete situations, such as messages being empty with no embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; invalid image URLs in embeds.

• UnauthorizedError –

  If you are unauthorized to make the request (invalid/missing token).

• NotFoundError –

  If the interaction is not found or if the interaction's initial response has already been created.

• RateLimitTooLongError –

  Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

• InternalServerError –

  If an internal error occurs on Discord while handling the request.

Send a modal as the initial response for this context.

Parameters:

• title (str) –

  The title that will show up in the modal.

• custom_id (str) –

  Developer set custom ID used for identifying interactions with this modal.

  Yuyo's Component client will only match against custom_id.split(":", 1)[0], allowing metadata to be put after ":".

• component (hikari.UndefinedOr[hikari.api.ComponentBuilder], default: UNDEFINED ) –

  A component builder to send in this modal.

• components (hikari.UndefinedOr[abc.Sequence[hikari.api.ComponentBuilder]], default: UNDEFINED ) –

  A sequence of component builders to send in this modal.

Raises:

• ValueError –

  If both component and components are specified or if none are specified.

• BadRequestError –

  When the requests' data is outside Discord's accept ranges/validation.

• UnauthorizedError –

  If you are unauthorized to make the request (invalid/missing token).

• NotFoundError –

  If the interaction is not found or if the interaction's initial response has already been created or deferred.

• RateLimitTooLongError –

  Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

• InternalServerError –

  If an internal error occurs on Discord while handling the request.

Defer the initial response for this context.

Parameters:

• defer_type (DeferredResponseTypesT, default: DEFERRED_MESSAGE_CREATE ) –

  The type of deferral this should be.

  This may any of the following:

  • ResponseType.DEFERRED_MESSAGE_CREATE to indicate that the following up call to BaseContext.edit_initial_response or BaseContext.respond should create a new message.
  • ResponseType.DEFERRED_MESSAGE_UPDATE to indicate that the following call to the aforementioned methods should update the existing message.
• ephemeral (typing.Optional[bool], default: None ) –

  Whether the deferred response should be ephemeral.

  Passing True here is a shorthand for including 1 << 64 in the passed flags.

• flags (typing.Union[UndefinedType, int, MessageFlag], default: UNDEFINED ) –

  The flags to use for the initial response.

Delete the initial response after invoking this context.

Raises:

• (LookupError, NotFoundError) –

  The last context has no initial response.

Delete the last response after invoking this context.

Raises:

• (LookupError, NotFoundError) –

  The last context has no responses.

Edit the initial response for this context.

Parameters:

• content (hikari.UndefinedOr[typing.Any], default: UNDEFINED ) –

  If provided, the message content to edit the initial response with.

  If this is a hikari.Embed and no embed nor embeds kwarg is provided, then this will instead update the embed. This allows for simpler syntax when sending an embed alone.

  Likewise, if this is a hikari.Resource, then the content is instead treated as an attachment if no attachment and no attachments kwargs are provided.

• delete_after (typing.Union[timedelta, float, int, None], default: None ) –

  If provided, the seconds after which the response message should be deleted.

  Interaction responses can only be deleted within 15 minutes of the interaction being received.

• attachment (hikari.UndefinedNoneOr[hikari.Resourceish], default: UNDEFINED ) –

  A singular attachment to edit the initial response with.

• attachments (hikari.UndefinedNoneOr[abc.Sequence[hikari.Resourceish]], default: UNDEFINED ) –

  A sequence of attachments to edit the initial response with.

• component (hikari.UndefinedNoneOr[hikari.api.ComponentBuilder], default: UNDEFINED ) –

  If provided, builder object of the component to set for this message. This component will replace any previously set components and passing None will remove all components.

• components (hikari.UndefinedNoneOr[abc.Sequence[hikari.api.ComponentBuilder]], default: UNDEFINED ) –

  If provided, a sequence of the component builder objects set for this message. These components will replace any previously set components and passing None or an empty sequence will remove all components.

• embed (hikari.UndefinedNoneOr[hikari.Embed], default: UNDEFINED ) –

  An embed to replace the initial response with.

• embeds (hikari.UndefinedNoneOr[abc.Sequence[hikari.Embed]], default: UNDEFINED ) –

  A sequence of embeds to replace the initial response with.

• mentions_everyone (hikari.UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message should parse @everyone/@here mentions.

• user_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialUser], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialUser derivatives to enforce mentioning specific users.

• role_mentions (typing.Union[hikari.SnowflakeishSequence[hikari.PartialRole], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialRole derivatives to enforce mentioning specific roles.