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 instance for this application.
channel_id
class-attribute
instance-attribute
#
ID of the channel that this event concerns.
emoji_id
class-attribute
instance-attribute
#
ID of the emoji which was added if it is custom, else None
.
emoji_name
class-attribute
instance-attribute
#
emoji_name: Union[str, UnicodeEmoji, None] = 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
#
Whether the emoji which was added is animated.
message_id
class-attribute
instance-attribute
#
ID of the message that this event concerns.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
user_id
class-attribute
instance-attribute
#
ID of the user that added this reaction.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
is_for_emoji
#
DMReactionDeleteAllEvent
#
Bases: DMReactionEvent
, ReactionDeleteAllEvent
Event fired when all of a private message's reactions are removed.
app
class-attribute
instance-attribute
#
App instance for this application.
channel_id
class-attribute
instance-attribute
#
ID of the channel that this event concerns.
message_id
class-attribute
instance-attribute
#
ID of the message that this event concerns.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
DMReactionDeleteEmojiEvent
#
Bases: DMReactionEvent
, ReactionDeleteEmojiEvent
Event fired when an emoji is removed from a private message's reactions.
app
class-attribute
instance-attribute
#
App instance for this application.
channel_id
class-attribute
instance-attribute
#
ID of the channel that this event concerns.
emoji_id
class-attribute
instance-attribute
#
ID of the emoji which was added if it is custom, else None
.
emoji_name
class-attribute
instance-attribute
#
emoji_name: Union[str, UnicodeEmoji, None] = 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
#
ID of the message that this event concerns.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
is_for_emoji
#
DMReactionDeleteEvent
#
Bases: DMReactionEvent
, ReactionDeleteEvent
Event fired when a reaction is removed from a private message.
app
class-attribute
instance-attribute
#
App instance for this application.
channel_id
class-attribute
instance-attribute
#
ID of the channel that this event concerns.
emoji_id
class-attribute
instance-attribute
#
ID of the emoji which was added if it is custom, else None
.
emoji_name
class-attribute
instance-attribute
#
emoji_name: Union[str, UnicodeEmoji, None] = 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
#
ID of the message that this event concerns.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
user_id
class-attribute
instance-attribute
#
User ID for the user that added this reaction initially.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
is_for_emoji
#
DMReactionEvent
#
GuildReactionAddEvent
#
Bases: GuildReactionEvent
, ReactionAddEvent
Event fired when a reaction is added to a guild message.
channel_id
class-attribute
instance-attribute
#
ID of the channel that this event concerns.
emoji_id
class-attribute
instance-attribute
#
ID of the emoji which was added if it is custom, else None
.
emoji_name
class-attribute
instance-attribute
#
emoji_name: Union[str, UnicodeEmoji, None] = 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
#
Whether the emoji which was added is animated.
member
class-attribute
instance-attribute
#
Member that added the reaction.
message_id
class-attribute
instance-attribute
#
ID of the message that this event concerns.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
is_for_emoji
#
GuildReactionDeleteAllEvent
#
Bases: GuildReactionEvent
, ReactionDeleteAllEvent
Event fired when all of a guild message's reactions are removed.
app
class-attribute
instance-attribute
#
App instance for this application.
channel_id
class-attribute
instance-attribute
#
ID of the channel that this event concerns.
guild_id
class-attribute
instance-attribute
#
ID of the guild that this event concerns.
message_id
class-attribute
instance-attribute
#
ID of the message that this event concerns.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
GuildReactionDeleteEmojiEvent
#
Bases: GuildReactionEvent
, ReactionDeleteEmojiEvent
Event fired when an emoji is removed from a guild message's reactions.
app
class-attribute
instance-attribute
#
App instance for this application.
channel_id
class-attribute
instance-attribute
#
ID of the channel that this event concerns.
emoji_id
class-attribute
instance-attribute
#
ID of the emoji which was added if it is custom, else None
.
emoji_name
class-attribute
instance-attribute
#
emoji_name: Union[str, UnicodeEmoji, None] = 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
#
ID of the guild that this event concerns.
message_id
class-attribute
instance-attribute
#
ID of the message that this event concerns.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
is_for_emoji
#
GuildReactionDeleteEvent
#
Bases: GuildReactionEvent
, ReactionDeleteEvent
Event fired when a reaction is removed from a guild message.
app
class-attribute
instance-attribute
#
App instance for this application.
channel_id
class-attribute
instance-attribute
#
ID of the channel that this event concerns.
emoji_id
class-attribute
instance-attribute
#
ID of the emoji which was added if it is custom, else None
.
emoji_name
class-attribute
instance-attribute
#
emoji_name: Union[str, UnicodeEmoji, None] = 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
#
ID of the guild that this event concerns.
message_id
class-attribute
instance-attribute
#
ID of the message that this event concerns.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
user_id
class-attribute
instance-attribute
#
User ID for the user that added this reaction initially.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
is_for_emoji
#
GuildReactionEvent
#
ReactionAddEvent
#
Bases: ReactionEvent
, ABC
Event base for any reaction that is added to a message.
channel_id
abstractmethod
property
#
channel_id: Snowflake
ID of the channel that this event concerns.
emoji_name
abstractmethod
property
#
emoji_name: Union[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.
message_id
abstractmethod
property
#
message_id: Snowflake
ID of the message that this event concerns.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
is_for_emoji
#
ReactionDeleteAllEvent
#
ReactionDeleteEmojiEvent
#
Bases: ReactionEvent
, ABC
Event base fired when all reactions are removed for one emoji.
channel_id
abstractmethod
property
#
channel_id: Snowflake
ID of the channel that this event concerns.
emoji_name
abstractmethod
property
#
emoji_name: Union[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).
message_id
abstractmethod
property
#
message_id: Snowflake
ID of the message that this event concerns.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
is_for_emoji
#
ReactionDeleteEvent
#
Bases: ReactionEvent
, ABC
Event base for any single reaction that is removed from a message.
channel_id
abstractmethod
property
#
channel_id: Snowflake
ID of the channel that this event concerns.
emoji_name
abstractmethod
property
#
emoji_name: Union[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).
message_id
abstractmethod
property
#
message_id: Snowflake
ID of the message that this event concerns.
user_id
abstractmethod
property
#
user_id: Snowflake
User ID for the user that added this reaction initially.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.