yuyo.interactions#

Initialise a base context.

Create a followup response for this context.

Parameters:

• content (UndefinedOr[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 (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 (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 (UndefinedOr[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 (UndefinedOr[Sequence[Resourceish]], default: UNDEFINED ) –

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

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

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

• components (UndefinedOr[Sequence[ComponentBuilder]], default: UNDEFINED ) –

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

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

  If provided, the message embed.

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

  If provided, the message embeds.

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

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

• user_mentions (Union[SnowflakeishSequence[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 (Union[SnowflakeishSequence[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 (UndefinedOr[bool], default: UNDEFINED ) –

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

• flags (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 (UndefinedOr[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 (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 (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 (UndefinedOr[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 (UndefinedOr[Sequence[Resourceish]], default: UNDEFINED ) –

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

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

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

• components (UndefinedOr[Sequence[ComponentBuilder]], default: UNDEFINED ) –

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

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

  If provided, the message embed.

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

  If provided, the message embeds.

• flags (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 (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 (UndefinedOr[bool], default: UNDEFINED ) –

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

• user_mentions (Union[SnowflakeishSequence[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 (Union[SnowflakeishSequence[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 (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 (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 (UndefinedOr[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 (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 (UndefinedNoneOr[Resourceish], default: UNDEFINED ) –

  A singular attachment to edit the initial response with.

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

  A sequence of attachments to edit the initial response with.

• component (UndefinedNoneOr[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 (UndefinedNoneOr[Sequence[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 (UndefinedNoneOr[Embed], default: UNDEFINED ) –

  An embed to replace the initial response with.

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

  A sequence of embeds to replace the initial response with.

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

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

• user_mentions (Union[SnowflakeishSequence[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 (Union[SnowflakeishSequence[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 (UndefinedOr[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 (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 (UndefinedNoneOr[Resourceish], default: UNDEFINED ) –

  A singular attachment to edit the last response with.

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

  A sequence of attachments to edit the last response with.

• component (UndefinedNoneOr[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 (UndefinedNoneOr[Sequence[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 (UndefinedNoneOr[Embed], default: UNDEFINED ) –

  An embed to replace the last response with.

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

  A sequence of embeds to replace the last response with.

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

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

• user_mentions (Union[SnowflakeishSequence[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 (Union[SnowflakeishSequence[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 (UndefinedOr[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 (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 (UndefinedOr[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 (UndefinedOr[Sequence[Resourceish]], default: UNDEFINED ) –

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

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

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

• components (UndefinedOr[Sequence[ComponentBuilder]], default: UNDEFINED ) –

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

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

  An embed to respond with.

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

  A sequence of embeds to respond with.

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

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

• user_mentions (Union[SnowflakeishSequence[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 (Union[SnowflakeishSequence[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 an interaction error.

Parameters:

• content (UndefinedOr[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.

• delete_after (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 (UndefinedOr[Resourceish], default: UNDEFINED ) –

  A singular attachment to respond with.

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

  A sequence of attachments to respond with.

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

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

• components (UndefinedOr[Sequence[ComponentBuilder]], default: UNDEFINED ) –

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

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

  An embed to respond with.

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

  A sequence of embeds to respond with.

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

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

• user_mentions (Union[SnowflakeishSequence[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 (Union[SnowflakeishSequence[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 –

  Raised for any of the following reasons:

  • When both attachment and attachments are provided.
  • When both component and components are passed.
  • When both embed and embeds are passed.
  • If more than 100 entries are passed for role_mentions.
  • If more than 100 entries are passed for user_mentions.

Send this error as an interaction response.

Parameters:

• ctx (Union[BaseContext[ComponentInteraction], BaseContext[ModalInteraction]]) –

  The interaction context to respond to.

• 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 extra request being made under certain scenarios.

Raises:

• ValueError –

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

• 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.