Skip to content

hikari.events.reaction_events#

Events that fire if messages are reacted to.

DMReactionAddEvent #

Bases: DMReactionEvent, ReactionAddEvent

Event fired when a reaction is added to a private message.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

burst_colors class-attribute instance-attribute #

burst_colors: Sequence[Color] = attrs.field()

The colours used for the super reaction animation, empty if this is not a super reaction.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute #

emoji_id: Snowflake | None = attrs.field()

ID of the emoji which was added if it is custom, else None.

emoji_name class-attribute instance-attribute #

emoji_name: str | UnicodeEmoji | None = attrs.field()

Name of the emoji which was added if known.

This can either be the string name of the custom emoji which was added, the object of the hikari.emojis.UnicodeEmoji which was added or None when the relevant custom emoji's data is not available (e.g. the emoji has been deleted).

is_animated class-attribute instance-attribute #

is_animated: bool = attrs.field()

Whether the emoji which was added is animated.

is_burst class-attribute instance-attribute #

is_burst: bool = attrs.field()

Whether the reaction which was added is a super reaction.

message_id class-attribute instance-attribute #

message_id: Snowflake = attrs.field()

ID of the message that this event concerns.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

user_id class-attribute instance-attribute #

user_id: Snowflake = attrs.field()

ID of the user that added this reaction.

DMReactionDeleteAllEvent #

Bases: DMReactionEvent, ReactionDeleteAllEvent

Event fired when all of a private message's reactions are removed.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field()

ID of the channel that this event concerns.

message_id class-attribute instance-attribute #

message_id: Snowflake = attrs.field()

ID of the message that this event concerns.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

DMReactionDeleteEmojiEvent #

Bases: DMReactionEvent, ReactionDeleteEmojiEvent

Event fired when all reactions of a certain emoji is removed from a private message.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute #

emoji_id: Snowflake | None = attrs.field()

ID of the emoji which was added if it is custom, else None.

emoji_name class-attribute instance-attribute #

emoji_name: str | UnicodeEmoji | None = attrs.field()

Name of the emoji which was removed.

Either the string name of the custom emoji which was removed, the object of the hikari.emojis.UnicodeEmoji which was removed or None when the relevant custom emoji's data is not available (e.g. the emoji has been deleted).

message_id class-attribute instance-attribute #

message_id: Snowflake = attrs.field()

ID of the message that this event concerns.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

DMReactionDeleteEvent #

Bases: DMReactionEvent, ReactionDeleteEvent

Event fired when a reaction is removed from a private message.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute #

emoji_id: Snowflake | None = attrs.field()

ID of the emoji which was added if it is custom, else None.

emoji_name class-attribute instance-attribute #

emoji_name: str | UnicodeEmoji | None = attrs.field()

Name of the emoji which was removed.

Either the string name of the custom emoji which was removed, the object of the hikari.emojis.UnicodeEmoji which was removed or None when the relevant custom emoji's data is not available (e.g. the emoji has been deleted).

is_burst class-attribute instance-attribute #

is_burst: bool = attrs.field()

Whether the reaction which was removed was a super reaction.

message_id class-attribute instance-attribute #

message_id: Snowflake = attrs.field()

ID of the message that this event concerns.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

user_id class-attribute instance-attribute #

user_id: Snowflake = attrs.field()

User ID for the user that added this reaction initially.

DMReactionEvent #

Bases: ReactionEvent, ABC

Event base for any reaction-bound event in private messages.

GuildReactionAddEvent #

Bases: GuildReactionEvent, ReactionAddEvent

Event fired when a reaction is added to a guild message.

app property #

app: RESTAware

App instance for this application.

burst_colors class-attribute instance-attribute #

burst_colors: Sequence[Color] = attrs.field()

The colours used for the super reaction animation, empty if this is not a super reaction.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute #

emoji_id: Snowflake | None = attrs.field()

ID of the emoji which was added if it is custom, else None.

emoji_name class-attribute instance-attribute #

emoji_name: str | UnicodeEmoji | None = attrs.field()

Name of the emoji which was added if known.

This can either be the string name of the custom emoji which was added, the object of the hikari.emojis.UnicodeEmoji which was added or None when the relevant custom emoji's data is not available (e.g. the emoji has been deleted).

guild_id property #

guild_id: Snowflake

ID of the guild that this event concerns.

is_animated class-attribute instance-attribute #

is_animated: bool = attrs.field()

Whether the emoji which was added is animated.

is_burst class-attribute instance-attribute #

is_burst: bool = attrs.field()

Whether the reaction which was added is a super reaction.

member class-attribute instance-attribute #

member: Member = attrs.field()

Member that added the reaction.

message_id class-attribute instance-attribute #

message_id: Snowflake = attrs.field()

ID of the message that this event concerns.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

user_id property #

user_id: Snowflake

ID of the user that added this reaction.

GuildReactionDeleteAllEvent #

Bases: GuildReactionEvent, ReactionDeleteAllEvent

Event fired when all of a guild message's reactions are removed.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field()

ID of the channel that this event concerns.

guild_id class-attribute instance-attribute #

guild_id: Snowflake = attrs.field()

ID of the guild that this event concerns.

message_id class-attribute instance-attribute #

message_id: Snowflake = attrs.field()

ID of the message that this event concerns.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

GuildReactionDeleteEmojiEvent #

Bases: GuildReactionEvent, ReactionDeleteEmojiEvent

Event fired when all reactions of a certain emoji is removed from a guild message.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute #

emoji_id: Snowflake | None = attrs.field()

ID of the emoji which was added if it is custom, else None.

emoji_name class-attribute instance-attribute #

emoji_name: str | UnicodeEmoji | None = attrs.field()

Name of the emoji which was removed.

Either the string name of the custom emoji which was removed, the object of the hikari.emojis.UnicodeEmoji which was removed or None when the relevant custom emoji's data is not available (e.g. the emoji has been deleted).

guild_id class-attribute instance-attribute #

guild_id: Snowflake = attrs.field()

ID of the guild that this event concerns.

message_id class-attribute instance-attribute #

message_id: Snowflake = attrs.field()

ID of the message that this event concerns.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

GuildReactionDeleteEvent #

Bases: GuildReactionEvent, ReactionDeleteEvent

Event fired when a reaction is removed from a guild message.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute #

emoji_id: Snowflake | None = attrs.field()

ID of the emoji which was added if it is custom, else None.

emoji_name class-attribute instance-attribute #

emoji_name: str | UnicodeEmoji | None = attrs.field()

Name of the emoji which was removed.

Either the string name of the custom emoji which was removed, the object of the hikari.emojis.UnicodeEmoji which was removed or None when the relevant custom emoji's data is not available (e.g. the emoji has been deleted).

guild_id class-attribute instance-attribute #

guild_id: Snowflake = attrs.field()

ID of the guild that this event concerns.

is_burst class-attribute instance-attribute #

is_burst: bool = attrs.field()

Whether the reaction which was removed was a super reaction.

message_id class-attribute instance-attribute #

message_id: Snowflake = attrs.field()

ID of the message that this event concerns.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

user_id class-attribute instance-attribute #

user_id: Snowflake = attrs.field()

User ID for the user that added this reaction initially.

GuildReactionEvent #

Bases: ReactionEvent, ABC

Event base for any reaction-bound event in guild messages.

guild_id abstractmethod property #

guild_id: Snowflake

ID of the guild that this event concerns.

ReactionAddEvent #

Bases: ReactionEvent, ABC

Event base for any reaction that is added to a message.

burst_colors abstractmethod property #

burst_colors: Sequence[Color]

The colours used for the super reaction animation, empty if this is not a super reaction.

burst_colours property #

burst_colours: Sequence[Colour]

Alias for the burst_colors property.

emoji_id abstractmethod property #

emoji_id: Snowflake | None

ID of the emoji which was added if it is custom, else None.

emoji_name abstractmethod property #

emoji_name: UnicodeEmoji | str | None

Name of the emoji which was added if known.

This can either be the string name of the custom emoji which was added, the object of the hikari.emojis.UnicodeEmoji which was added or None when the relevant custom emoji's data is not available (e.g. the emoji has been deleted).

is_animated abstractmethod property #

is_animated: bool

Whether the emoji which was added is animated.

is_burst abstractmethod property #

is_burst: bool

Whether the reaction which was added is a super reaction.

user_id abstractmethod property #

user_id: Snowflake

ID of the user that added this reaction.

is_for_emoji #

is_for_emoji(emoji: Emoji | str) -> bool

Get whether the reaction event is for a specific emoji.

PARAMETER DESCRIPTION
emoji

The emoji to check.

Passing str here indicates a unicode emoji.

TYPE: Emoji | str

RETURNS DESCRIPTION
bool

Whether the emoji is the one which was added.

ReactionDeleteAllEvent #

Bases: ReactionEvent, ABC

Event base fired when all reactions are removed from a message.

ReactionDeleteEmojiEvent #

Bases: ReactionEvent, ABC

Event base fired when all reactions are removed for one emoji.

emoji_id abstractmethod property #

emoji_id: Snowflake | None

ID of the emoji which was added if it is custom, else None.

emoji_name abstractmethod property #

emoji_name: UnicodeEmoji | str | None

Name of the emoji which was removed.

Either the string name of the custom emoji which was removed, the object of the hikari.emojis.UnicodeEmoji which was removed or None when the relevant custom emoji's data is not available (e.g. the emoji has been deleted).

is_for_emoji #

is_for_emoji(emoji: Emoji | str) -> bool

Get whether the reaction event is for a specific emoji.

PARAMETER DESCRIPTION
emoji

The emoji to check.

Passing str here indicates a unicode emoji.

TYPE: Emoji | str

RETURNS DESCRIPTION
bool

Whether the emoji is the one which was removed.

ReactionDeleteEvent #

Bases: ReactionEvent, ABC

Event base for any single reaction that is removed from a message.

emoji_id abstractmethod property #

emoji_id: Snowflake | None

ID of the emoji which was added if it is custom, else None.

emoji_name abstractmethod property #

emoji_name: UnicodeEmoji | str | None

Name of the emoji which was removed.

Either the string name of the custom emoji which was removed, the object of the hikari.emojis.UnicodeEmoji which was removed or None when the relevant custom emoji's data is not available (e.g. the emoji has been deleted).

is_burst abstractmethod property #

is_burst: bool

Whether the reaction which was removed was a super reaction.

user_id abstractmethod property #

user_id: Snowflake

User ID for the user that added this reaction initially.

is_for_emoji #

is_for_emoji(emoji: Emoji | str) -> bool

Get whether the reaction event is for a specific emoji.

PARAMETER DESCRIPTION
emoji

The emoji to check.

Passing str here indicates a unicode emoji.

TYPE: Emoji | str

RETURNS DESCRIPTION
bool

Whether the emoji is the one which was removed.

ReactionEvent #

Bases: ShardEvent, ABC

Event base for any message reaction event.

channel_id abstractmethod property #

channel_id: Snowflake

ID of the channel that this event concerns.

message_id abstractmethod property #

message_id: Snowflake

ID of the message that this event concerns.