DiscordClient Event Methods

For non-event handlers, see DiscordClient.

DiscordClient

Client for interaction with Discord.

on_any(self, object, raw_event) async

Called for every event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_event	dict	Raw dict from discord API.	required

on_channel_create(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_channel_delete(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_channel_pins_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_channel_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_ban_add(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_ban_remove(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_create(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_delete(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_emojis_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_integrations_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_member_add(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_member_remove(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_member_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_role_create(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_role_delete(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_role_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_stickers_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_guild_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_integration_create(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_integration_delete(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_integration_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_invite_create(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_invite_delete(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_message_create(self, message, raw_message) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
message	Message	Python object representing the event.	required
raw_message	dict	Raw dict from discord API.	required

on_message_delete(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_message_delete_bulk(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_message_reaction_add(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_message_reaction_remove(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_message_reaction_remove_all(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_message_reaction_remove_emoji(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_message_update(self, message, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
message	MessageUpdate	Updated message. Note that many fields may be missing from this entity!	required
raw_object	dict	Raw dict from discord API.	required

on_presence_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_ready(self, ready, raw_ready) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
ready	Ready	Python object representing the event.	required
raw_ready	dict	Raw dict from discord API.	required

on_resumed(self, resume, raw_resume) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
resume	None	Always None.	required
raw_resume	dict	Raw dict from discord API.	required

on_stage_instance_create(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_stage_instance_delete(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_stage_instance_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_thread_create(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_thread_delete(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_thread_list_sync(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_thread_member_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_thread_members_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_thread_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_typing_start(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_voice_state_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_webhooks_update(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required

on_interaction_create(self, object, raw_object) async

Empty placeholder for given event.

Parameters:

Name	Type	Description	Default
self	DiscordClient	Client	required
object	BaseDiscordObject	Python object representing the event.	required
raw_object	dict	Raw dict from discord API.	required