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 = field(metadata={SKIP_DEEP_COPY: True})

App instance for this application.

channel_id class-attribute instance-attribute

channel_id: Snowflake = field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute

emoji_id: Optional[Snowflake] = field()

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

is_animated: bool = field()

Whether the emoji which was added is animated.

message_id class-attribute instance-attribute

message_id: Snowflake = field()

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: Snowflake = field()

ID of the user that added this reaction.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

is_for_emoji

is_for_emoji(emoji: Union[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: Union[Emoji, str]

RETURNS	DESCRIPTION
bool	Whether the emoji is the one which was added.

DMReactionDeleteAllEvent

Bases: DMReactionEvent, ReactionDeleteAllEvent

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

app class-attribute instance-attribute

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

App instance for this application.

channel_id class-attribute instance-attribute

channel_id: Snowflake = field()

ID of the channel that this event concerns.

message_id class-attribute instance-attribute

message_id: Snowflake = field()

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.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

DMReactionDeleteEmojiEvent

Bases: DMReactionEvent, ReactionDeleteEmojiEvent

Event fired when an emoji is removed from a private message's reactions.

app class-attribute instance-attribute

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

App instance for this application.

channel_id class-attribute instance-attribute

channel_id: Snowflake = field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute

emoji_id: Optional[Snowflake] = field()

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

message_id: Snowflake = field()

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.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

is_for_emoji

is_for_emoji(emoji: Union[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: Union[Emoji, str]

RETURNS	DESCRIPTION
bool	Whether the emoji is the one which was removed.

DMReactionDeleteEvent

Bases: DMReactionEvent, ReactionDeleteEvent

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

app class-attribute instance-attribute

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

App instance for this application.

channel_id class-attribute instance-attribute

channel_id: Snowflake = field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute

emoji_id: Optional[Snowflake] = field()

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

message_id: Snowflake = field()

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: Snowflake = field()

User ID for the user that added this reaction initially.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

is_for_emoji

is_for_emoji(emoji: Union[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: Union[Emoji, str]

RETURNS	DESCRIPTION
bool	Whether the emoji is the one which was removed.

DMReactionEvent

Bases: ReactionEvent, ABC

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

app abstractmethod property

app: RESTAware

App instance for this application.

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.

shard abstractmethod property

shard: GatewayShard

Shard that received this event.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

GuildReactionAddEvent

Bases: GuildReactionEvent, ReactionAddEvent

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

app property

app: RESTAware

App instance for this application.

channel_id class-attribute instance-attribute

channel_id: Snowflake = field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute

emoji_id: Optional[Snowflake] = field()

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

guild_id property

guild_id: Snowflake

ID of the guild that this event concerns.

is_animated class-attribute instance-attribute

is_animated: bool = field()

Whether the emoji which was added is animated.

member class-attribute instance-attribute

member: Member = field()

Member that added the reaction.

message_id class-attribute instance-attribute

message_id: Snowflake = field()

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 property

user_id: Snowflake

ID of the user that added this reaction.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

is_for_emoji

is_for_emoji(emoji: Union[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: Union[Emoji, str]

RETURNS	DESCRIPTION
bool	Whether the emoji is the one which was added.

GuildReactionDeleteAllEvent

Bases: GuildReactionEvent, ReactionDeleteAllEvent

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

app class-attribute instance-attribute

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

App instance for this application.

channel_id class-attribute instance-attribute

channel_id: Snowflake = field()

ID of the channel that this event concerns.

guild_id class-attribute instance-attribute

guild_id: Snowflake = field()

ID of the guild that this event concerns.

message_id class-attribute instance-attribute

message_id: Snowflake = field()

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.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

GuildReactionDeleteEmojiEvent

Bases: GuildReactionEvent, ReactionDeleteEmojiEvent

Event fired when an emoji is removed from a guild message's reactions.

app class-attribute instance-attribute

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

App instance for this application.

channel_id class-attribute instance-attribute

channel_id: Snowflake = field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute

emoji_id: Optional[Snowflake] = field()

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

guild_id: Snowflake = field()

ID of the guild that this event concerns.

message_id class-attribute instance-attribute

message_id: Snowflake = field()

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.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

is_for_emoji

is_for_emoji(emoji: Union[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: Union[Emoji, str]

RETURNS	DESCRIPTION
bool	Whether the emoji is the one which was removed.

GuildReactionDeleteEvent

Bases: GuildReactionEvent, ReactionDeleteEvent

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

app class-attribute instance-attribute

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

App instance for this application.

channel_id class-attribute instance-attribute

channel_id: Snowflake = field()

ID of the channel that this event concerns.

emoji_id class-attribute instance-attribute

emoji_id: Optional[Snowflake] = field()

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

guild_id: Snowflake = field()

ID of the guild that this event concerns.

message_id class-attribute instance-attribute

message_id: Snowflake = field()

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: Snowflake = field()

User ID for the user that added this reaction initially.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

is_for_emoji

is_for_emoji(emoji: Union[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: Union[Emoji, str]

RETURNS	DESCRIPTION
bool	Whether the emoji is the one which was removed.

GuildReactionEvent

Bases: ReactionEvent, ABC

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

app abstractmethod property

app: RESTAware

App instance for this application.

channel_id abstractmethod property

channel_id: Snowflake

ID of the channel that this event concerns.

guild_id abstractmethod property

guild_id: Snowflake

ID of the guild that this event concerns.

message_id abstractmethod property

message_id: Snowflake

ID of the message that this event concerns.

shard abstractmethod property

shard: GatewayShard

Shard that received this event.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

ReactionAddEvent

Bases: ReactionEvent, ABC

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

app abstractmethod property

app: RESTAware

App instance for this application.

channel_id abstractmethod property

channel_id: Snowflake

ID of the channel that this event concerns.

emoji_id abstractmethod property

emoji_id: Optional[Snowflake]

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

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.

shard abstractmethod property

shard: GatewayShard

Shard that received this event.

user_id abstractmethod property

user_id: Snowflake

ID of the user that added this reaction.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

is_for_emoji

is_for_emoji(emoji: Union[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: Union[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.

app abstractmethod property

app: RESTAware

App instance for this application.

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.

shard abstractmethod property

shard: GatewayShard

Shard that received this event.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

ReactionDeleteEmojiEvent

Bases: ReactionEvent, ABC

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

app abstractmethod property

app: RESTAware

App instance for this application.

channel_id abstractmethod property

channel_id: Snowflake

ID of the channel that this event concerns.

emoji_id abstractmethod property

emoji_id: Optional[Snowflake]

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

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.

shard abstractmethod property

shard: GatewayShard

Shard that received this event.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

is_for_emoji

is_for_emoji(emoji: Union[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: Union[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.

app abstractmethod property

app: RESTAware

App instance for this application.

channel_id abstractmethod property

channel_id: Snowflake

ID of the channel that this event concerns.

emoji_id abstractmethod property

emoji_id: Optional[Snowflake]

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

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.

shard abstractmethod property

shard: GatewayShard

Shard that received this event.

user_id abstractmethod property

user_id: Snowflake

User ID for the user that added this reaction initially.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.

is_for_emoji

is_for_emoji(emoji: Union[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: Union[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.

app abstractmethod property

app: RESTAware

App instance for this application.

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.

shard abstractmethod property

shard: GatewayShard

Shard that received this event.

bitmask classmethod

bitmask() -> int

Bitmask for this event.

dispatches classmethod

dispatches() -> Sequence[Type[Event]]

Sequence of the event classes this event is dispatched as.