Events¶

Event reference, names and parameters passed when calling events

When registering events in the client class, they must be an async function and be called on_event-name.

If using the Client.on() decorator, its preferred to not start the event with on_. However, it will still be accepted.

on_resume¶

Called when client session resumes

Parameters¶

This event has no parameters

on_heartbeat¶

Called when client responds to a heartbeat ack, an acknowledged heartbeat from discord.

Parameters¶

This event has no parameters

on_ready¶

Called when discord dispatches its ready event, noting the client has connected successfully and will begin receiving data such as joined guilds

Parameters¶

This event has no parameters

on_interaction_create¶

Called when an interaction has been created via button clicks or application commands.

Parameters¶

interaction: Interaction: Interaction created

on_interaction_update¶

Called when an interaction has been updated

Parameters¶

interaction: Interaction: Interaction updated

on_interaction_delete¶

Called when an interaction has been deleted

Parameters¶

interaction: Interaction: Interaction deleted

on_message_create¶

Called when a message has been created

Changed in version 0.0.1a3: on_message was renamed to on_message_create

Parameters¶

message: Message: Message created

on_message_update¶

Called when a message has been updated

Parameters¶

message: Message: Message updated

on_message_delete¶

Called when a message has been deleted

Parameters¶

message: Message: Message deleted

on_partial_message_delete¶

Called when a message has been deleted and cannot be found in the cache

Parameters¶

channel_id: Snowflake: ID of channel
id: Snowflake: ID of the message
guild_id: Optional[Snowflake]: ID of guild if message was not deleted in a DMChannel

on_bulk_message_delete¶

Called when messages were deleted in bulk

Parameters¶

messages: List[Union[Message, Snowflake]]: List of messages or message ids that were deleted
channel_id: Snowflake: ID of channel were messages were deleted
guild_id: Optional[Snowflake]: ID of guild if message was not deleted in a DMChannel

on_message_pin¶

Called when a message in a guild has been pinned or unpinned, not when a pinned message is deleted

Parameters¶

channel: Channel: Channel were message was pinned in
last_pin_timestamp: datetime.datetime: The time at which the most recent pinned message was pinned

on_invite_create¶

Called when an invite for a channel has been created

Parameters¶

invite: Invite: Invite created

on_invite_delete¶

Called when an invite for a channel has been deleted

Parameters¶

channel: Union[Channel, Snowflake]: Channel or Channel ID of were invite was deleted
guild: Optional[Union[Guild, Snowflake]]: Guild or Guild ID of were invite was deleted
code: str: Code of deleted invite

on_guild_recv¶

Called when an guild a client is already in has been received

Parameters¶

guild: Guild: The guild client is in

on_guild_create¶

Called when the client is added to a new guild

Parameters¶

guild: Guild: Guild client has just joined

on_guild_outage¶

Called when a guild a client is in is experiencing an outage

Parameters¶

guild: Guild: The client experiencing an outage

on_guild_remove¶

Called when client is removed from a guild, e.g client got banned

Parameters¶

guild: Guild: Guild client has been removed from

on_guild_update¶

Called when a guild is updated

Parameters¶

guild: Guild: Updated guild

on_guild_ban_add¶

Called when a user has been banned from a guild

Parameters¶

guild: Guild: Guild were user was banned from
user: User: User who was banned

on_guild_ban_remove¶

Called when a banned user has been unbanned

Parameters¶

guild: Guild: Guild were a user has been unbanned
user: User: User who was unbanned

on_guild_emoji_update¶

Called when an emoji has been updated

Parameters¶

emoji: Emoji: Emoji that has been updated

on_guild_emojis_update¶

Called when emojis have been updated in bulk, may be called when a single emoji has been updated.

Parameters¶

emojis: List[Emoji]: List of updated emojis

on_guild_sticker_update¶

Called when a sticker has been updated

Parameters¶

sticker: Sticker: Sticker updated

on_guild_stickers_update¶

Called when stickers have been updated in bulk, may be called when a single sticker has been updated.

Parameters¶

stickers: List[Sticker]: List of updated stickers

on_guild_integrations_update¶

Called when an integration for a guild has been updated

Parameters¶

guild: Union[Guild, Snowflake]: Guild were integrations has been updated

on_member_join¶

Called when a user joins a guild

Parameters¶

member: Member: member object of user who has just joined
guild: Guild: guild were user has joined

on_member_remove¶

Called when a user leaves a guild

Parameters¶

member: Union[Member, User]: Member who has just left
guild: Union[Guild, Snowflake]: Guild were integrations has been updated

on_member_update¶

Called when a member is updated, include internal user fields as well

Parameters¶

b_member: Member: Member before updates
a_member: Member: Member after updates
guild: Guild: Guild were member updated in

on_role_create¶

Called when a role is created in a guild

Parameters¶

role: Role: Created role
guild: Guild: Guild were role was created

on_role_update¶

Called when a role in a guild is updated

Parameters¶

b_role: Role: Role before updates
a_role: Role: Role after updates
guild: Guild: Guild were role was updated

on_role_delete¶

Called when a role in a guild is deleted

Parameters¶

role: Role: Role deleted
guild: Guild: Guild were role was deleted

on_guild_scheduled_event_create¶

Called when a guild scheduled event is created

Parameters¶

event: GuildScheduledEvent: Event that was created
guild: Guild: Guild that event was created in

on_guild_scheduled_event_update¶

Called when a guild scheduled event is updated

Parameters¶

event: GuildScheduledEvent: Event that was updated
guild: Guild: Guild that event was updated in

on_guild_scheduled_event_delete¶

Called when a guild scheduled event is deleted

Parameters¶

event: GuildScheduledEvent: Event that was deleted
guild: Guild: Guild that event was deleted in

on_channel_create¶

Called when a channel is created

Parameters¶

channel: Channel: Channel created

on_channel_update¶

Called when a channel is updated

Parameters¶

channel: Channel: Channel updated

on_channel_delete¶

Called when a channel is deleted

Parameters¶

channel: Channel: Channel deleted

on_thread_create¶

Called when a thread is created in a channel

Parameters¶

thread: Thread: Thread that was created

on_thread_update¶

Called when a thread is updated in a channel

Parameters¶

thread: Thread: Thread that was updated

on_thread_delete¶

Called when a thread is deleted in a channel

Parameters¶

thread: Thread: Thread that was deleted

on_thread_sync¶

Called when a threads sync when client gains access to them

Parameters¶

threads: List[Thread]: List of threads client has gained access to

on_thread_member_update¶

Called when a thread member has been updated

Parameters¶

member: ThreadMember: Thread member that was updated

on_thread_members_update¶

Called when many thread members are updated

Parameters¶

thread: Thread: New thread with updated members

on_voice_state_update¶

Called when a members voice state updates

Parameters¶

channel_id: Snowflake: ID of channel member has left or joined, None for left
member: Member: Member object with VoiceState attached

on_voice_server_update¶

Called when the client joins a VC.

Parameters¶

voice_connection: VoiceConnection: Connection to voice channel

on_guild_integration_create¶

Called when an integration is created for a guild.

Parameters¶

guild_id: Snowflake: ID of guild integration was created for
integration: Integration: Integration object

on_guild_integration_update¶

Called when an integration is updated for a guild.

Parameters¶

guild_id: Snowflake: ID of guild integration was updated for
integration: Integration: Integration object

on_guild_integration_delete¶

Called when an integration for a guild is deleted.

Parameters¶

integration_id: Snowflake: ID of deleted integration
guild_id: Snowflake: Guild ID of deleted integration
application_id: Optional[Snowflake]: ID of Bot/OAuth2 application for this integration

on_invite_create¶

Called when an invite is created

Parameters¶

invite: Invite: Invite created

on_invite_delete¶

Called when an invite is deleted

Parameters¶

code: str: Invite code
channel_id: Snowflake: ID of channel invite was deleted from
guild_id: Optional[Snowflake]: ID of guild where invite was deleted from

on_message_reaction_create¶

Called when a reaction is created on a message

Note

The message object is not updated with this reaction, so it is advised to refetch the message OR use Message.get_reactions().

Parameters¶

reaction: MessageReaction: Reaction added to message

on_message_reaction_remove¶

Called when a reaction is removed from a message

Note

The message object is not updated with this reaction, so it is advised to refetch the message OR use Message.get_reactions().

Parameters¶

reaction: MessageReaction: Reaction removed from message

on_message_reactions_clear¶

Called when all reactions on a message are cleared

Note

The message object is not updated, so it is advised to refetch the message OR use Message.get_reactions()

Parameters¶

channel_id: Snowflake: Channel ID of message
message_id: Snowflake: ID of message
guild_id: Optional[Snowflake]: ID of guild

on_message_reaction_emoji_clear¶

Called when all reactions of a given emoji are cleared

Note

The message object is not updated, so it is advised to refetch the message OR use Message.get_reactions()

Parameters¶

reaction: MessageReaction:: Reaction removed

on_presence_update¶

Called when a members presence is updated

Parameters¶

presence: MemberPresence: Updated presence