Common Python Library
Introduction to the CPL Docs
Getting started
Contributing to CPL
CLI reference
API reference
Discord reference
cpl_discord.application
cpl_discord.command
cpl_discord.configuration
cpl_discord.container
cpl_discord.events
cpl_discord.events.on_bulk_message_delete_abc
cpl_discord.events.on_command_abc
cpl_discord.events.on_command_completion_abc
cpl_discord.events.on_command_error_abc
cpl_discord.events.on_connect_abc
cpl_discord.events.on_disconnect_abc
cpl_discord.events.on_error_abc
cpl_discord.events.on_group_join_abc
cpl_discord.events.on_group_remove_abc
cpl_discord.events.on_guild_available_abc
cpl_discord.events.on_guild_channel_create_abc
cpl_discord.events.on_guild_channel_delete_abc
cpl_discord.events.on_guild_channel_pins_update_abc
cpl_discord.events.on_guild_channel_update_abc
cpl_discord.events.on_guild_emojis_update_abc
cpl_discord.events.on_guild_integrations_update_abc
cpl_discord.events.on_guild_join_abc
cpl_discord.events.on_guild_remove_abc
cpl_discord.events.on_guild_role_create_abc
cpl_discord.events.on_guild_role_delete_abc
cpl_discord.events.on_guild_role_update_abc
cpl_discord.events.on_guild_unavailable_abc
cpl_discord.events.on_guild_update_abc
cpl_discord.events.on_invite_create_abc
cpl_discord.events.on_invite_delete_abc
cpl_discord.events.on_member_ban_abc
cpl_discord.events.on_member_join_abc
cpl_discord.events.on_member_remove_abc
cpl_discord.events.on_member_unban_abc
cpl_discord.events.on_member_update_abc
cpl_discord.events.on_message_abc
cpl_discord.events.on_message_delete_abc
cpl_discord.events.on_message_edit_abc
cpl_discord.events.on_private_channel_create_abc
cpl_discord.events.on_private_channel_delete_abc
cpl_discord.events.on_private_channel_pins_update_abc
cpl_discord.events.on_private_channel_update_abc
cpl_discord.events.on_raw_reaction_add_abc
cpl_discord.events.on_raw_reaction_clear_abc
cpl_discord.events.on_raw_reaction_clear_emoji_abc
cpl_discord.events.on_raw_reaction_remove_abc
cpl_discord.events.on_reaction_add_abc
cpl_discord.events.on_reaction_clear_abc
cpl_discord.events.on_reaction_clear_emoji_abc
cpl_discord.events.on_reaction_remove_abc
cpl_discord.events.on_ready_abc
cpl_discord.events.on_resume_abc
cpl_discord.events.on_typing_abc
cpl_discord.events.on_user_update_abc
cpl_discord.events.on_voice_state_update_abc
cpl_discord.events.on_webhooks_update_abc
cpl_discord.helper
cpl_discord.service
Query reference
Translation reference
Common Python Library
»
Discord reference
»
cpl_discord.events
View page source
cpl_discord.events
cpl_discord.events.on_bulk_message_delete_abc
class
cpl_discord.events.on_bulk_message_delete_abc.
OnBulkMessageDeleteABC
Bases:
ABC
abstract
async
on_bulk_message_delete
(
messages
:
list
[
discord.message.Message
]
)
cpl_discord.events.on_command_abc
class
cpl_discord.events.on_command_abc.
OnCommandABC
Bases:
ABC
abstract
async
on_command
(
ctx
:
Context
)
cpl_discord.events.on_command_completion_abc
class
cpl_discord.events.on_command_completion_abc.
OnCommandCompletionABC
Bases:
ABC
abstract
async
on_command_completion
(
ctx
:
Context
)
cpl_discord.events.on_command_error_abc
class
cpl_discord.events.on_command_error_abc.
OnCommandErrorABC
Bases:
ABC
abstract
async
on_command_error
(
ctx
:
Context
,
error
:
CommandError
)
cpl_discord.events.on_connect_abc
class
cpl_discord.events.on_connect_abc.
OnConnectABC
Bases:
ABC
abstract
async
on_connect
(
)
cpl_discord.events.on_disconnect_abc
class
cpl_discord.events.on_disconnect_abc.
OnDisconnectABC
Bases:
ABC
abstract
async
on_disconnect
(
)
cpl_discord.events.on_error_abc
class
cpl_discord.events.on_error_abc.
OnErrorABC
Bases:
ABC
abstract
async
on_error
(
event
:
str
,
*
args
,
**
kwargs
)
cpl_discord.events.on_group_join_abc
class
cpl_discord.events.on_group_join_abc.
OnGroupJoinABC
Bases:
ABC
abstract
async
on_group_join
(
channel
:
GroupChannel
,
user
:
User
)
cpl_discord.events.on_group_remove_abc
class
cpl_discord.events.on_group_remove_abc.
OnGroupRemoveABC
Bases:
ABC
abstract
async
on_group_remove
(
chhanel
:
GroupChannel
,
user
:
User
)
cpl_discord.events.on_guild_available_abc
class
cpl_discord.events.on_guild_available_abc.
OnGuildAvailableABC
Bases:
ABC
abstract
async
on_guild_available
(
guild
:
Guild
)
cpl_discord.events.on_guild_channel_create_abc
class
cpl_discord.events.on_guild_channel_create_abc.
OnGuildChannelCreateABC
Bases:
ABC
abstract
async
on_guild_channel_create
(
channel
:
GuildChannel
)
cpl_discord.events.on_guild_channel_delete_abc
class
cpl_discord.events.on_guild_channel_delete_abc.
OnGuildChannelDeleteABC
Bases:
ABC
abstract
async
on_guild_channel_delete
(
channel
:
GuildChannel
)
cpl_discord.events.on_guild_channel_pins_update_abc
class
cpl_discord.events.on_guild_channel_pins_update_abc.
OnGuildChannelPinsUpdateABC
Bases:
ABC
abstract
async
on_guild_channel_pins_update
(
channel
:
GuildChannel
,
list_pin
:
Optional
[
datetime
]
)
cpl_discord.events.on_guild_channel_update_abc
class
cpl_discord.events.on_guild_channel_update_abc.
OnGuildChannelUpdateABC
Bases:
ABC
abstract
async
on_guild_channel_update
(
before
:
GuildChannel
,
after
:
GuildChannel
)
cpl_discord.events.on_guild_emojis_update_abc
class
cpl_discord.events.on_guild_emojis_update_abc.
OnGuildEmojisUpdateABC
Bases:
ABC
abstract
async
on_guild_emojis_update
(
guild
:
Guild
,
before
:
Sequence
[
Emoji
]
,
after
:
Sequence
[
Emoji
]
)
cpl_discord.events.on_guild_integrations_update_abc
class
cpl_discord.events.on_guild_integrations_update_abc.
OnGuildIntegrationsUpdateABC
Bases:
ABC
abstract
async
on_guild_integrations_update
(
guild
:
Guild
)
cpl_discord.events.on_guild_join_abc
class
cpl_discord.events.on_guild_join_abc.
OnGuildJoinABC
Bases:
ABC
abstract
async
on_guild_join
(
guild
:
Guild
)
cpl_discord.events.on_guild_remove_abc
class
cpl_discord.events.on_guild_remove_abc.
OnGuildRemoveABC
Bases:
ABC
abstract
async
on_guild_remove
(
guild
:
Guild
)
cpl_discord.events.on_guild_role_create_abc
class
cpl_discord.events.on_guild_role_create_abc.
OnGuildRoleCreateABC
Bases:
ABC
abstract
async
on_guild_role_create
(
role
:
Role
)
cpl_discord.events.on_guild_role_delete_abc
class
cpl_discord.events.on_guild_role_delete_abc.
OnGuildRoleDeleteABC
Bases:
ABC
abstract
async
on_guild_role_delete
(
role
:
Role
)
cpl_discord.events.on_guild_role_update_abc
class
cpl_discord.events.on_guild_role_update_abc.
OnGuildRoleUpdateABC
Bases:
ABC
abstract
async
on_guild_role_update
(
before
:
Role
,
after
:
Role
)
cpl_discord.events.on_guild_unavailable_abc
class
cpl_discord.events.on_guild_unavailable_abc.
OnGuildUnavailableABC
Bases:
ABC
abstract
async
on_guild_unavailable
(
guild
:
Guild
)
cpl_discord.events.on_guild_update_abc
class
cpl_discord.events.on_guild_update_abc.
OnGuildUpdateABC
Bases:
ABC
abstract
async
on_guild_update
(
before
:
Guild
,
after
:
Guild
)
cpl_discord.events.on_invite_create_abc
class
cpl_discord.events.on_invite_create_abc.
OnInviteCreateABC
Bases:
ABC
abstract
async
on_invite_create
(
invite
:
Invite
)
cpl_discord.events.on_invite_delete_abc
class
cpl_discord.events.on_invite_delete_abc.
OnInviteDeleteABC
Bases:
ABC
abstract
async
on_invite_delete
(
invite
:
Invite
)
cpl_discord.events.on_member_ban_abc
class
cpl_discord.events.on_member_ban_abc.
OnMemberBanABC
Bases:
ABC
abstract
async
on_member_ban
(
guild
:
Guild
,
user
:
User
)
cpl_discord.events.on_member_join_abc
class
cpl_discord.events.on_member_join_abc.
OnMemberJoinABC
Bases:
ABC
abstract
async
on_member_join
(
member
:
Member
)
cpl_discord.events.on_member_remove_abc
class
cpl_discord.events.on_member_remove_abc.
OnMemberRemoveABC
Bases:
ABC
abstract
async
on_member_remove
(
member
:
Member
)
cpl_discord.events.on_member_unban_abc
class
cpl_discord.events.on_member_unban_abc.
OnMemberUnbanABC
Bases:
ABC
abstract
async
on_member_unban
(
guild
:
Guild
,
user
:
User
)
cpl_discord.events.on_member_update_abc
class
cpl_discord.events.on_member_update_abc.
OnMemberUpdateABC
Bases:
ABC
abstract
async
on_member_update
(
before
:
Member
,
after
:
Member
)
cpl_discord.events.on_message_abc
class
cpl_discord.events.on_message_abc.
OnMessageABC
Bases:
ABC
abstract
async
on_message
(
message
:
Message
)
cpl_discord.events.on_message_delete_abc
class
cpl_discord.events.on_message_delete_abc.
OnMessageDeleteABC
Bases:
ABC
abstract
async
on_message_delete
(
message
:
Message
)
cpl_discord.events.on_message_edit_abc
class
cpl_discord.events.on_message_edit_abc.
OnMessageEditABC
Bases:
ABC
abstract
async
on_message_edit
(
before
:
Message
,
after
:
Message
)
cpl_discord.events.on_private_channel_create_abc
class
cpl_discord.events.on_private_channel_create_abc.
OnPrivateChannelCreateABC
Bases:
ABC
abstract
async
on_private_channel_create
(
channel
:
PrivateChannel
)
cpl_discord.events.on_private_channel_delete_abc
class
cpl_discord.events.on_private_channel_delete_abc.
OnPrivateChannelDeleteABC
Bases:
ABC
abstract
async
on_private_channel_delete
(
channel
:
PrivateChannel
)
cpl_discord.events.on_private_channel_pins_update_abc
class
cpl_discord.events.on_private_channel_pins_update_abc.
OnPrivateChannelPinsUpdateABC
Bases:
ABC
abstract
async
on_private_channel_pins_update
(
channel
:
PrivateChannel
,
list_pin
:
Optional
[
datetime
]
)
cpl_discord.events.on_private_channel_update_abc
class
cpl_discord.events.on_private_channel_update_abc.
OnPrivateChannelUpdateABC
Bases:
ABC
abstract
async
on_private_channel_update
(
before
:
GroupChannel
,
after
:
GroupChannel
)
cpl_discord.events.on_raw_reaction_add_abc
class
cpl_discord.events.on_raw_reaction_add_abc.
OnRawReactionAddABC
Bases:
ABC
abstract
async
on_raw_reaction_add
(
payload
:
RawReactionActionEvent
)
cpl_discord.events.on_raw_reaction_clear_abc
class
cpl_discord.events.on_raw_reaction_clear_abc.
OnRawReactionClearABC
Bases:
ABC
abstract
async
on_raw_reaction_clear
(
payload
:
RawReactionActionEvent
)
cpl_discord.events.on_raw_reaction_clear_emoji_abc
class
cpl_discord.events.on_raw_reaction_clear_emoji_abc.
OnRawReactionClearEmojiABC
Bases:
ABC
abstract
async
on_raw_reaction_clear_emoji
(
payload
:
RawReactionActionEvent
)
cpl_discord.events.on_raw_reaction_remove_abc
class
cpl_discord.events.on_raw_reaction_remove_abc.
OnRawReactionRemoveABC
Bases:
ABC
abstract
async
on_raw_reaction_remove
(
payload
:
RawReactionActionEvent
)
cpl_discord.events.on_reaction_add_abc
class
cpl_discord.events.on_reaction_add_abc.
OnReactionAddABC
Bases:
ABC
abstract
async
on_reaction_add
(
reaction
:
Reaction
,
user
:
User
)
cpl_discord.events.on_reaction_clear_abc
class
cpl_discord.events.on_reaction_clear_abc.
OnReactionClearABC
Bases:
ABC
abstract
async
on_reaction_clear
(
message
:
Message
,
reactions
:
list
[
discord.reaction.Reaction
]
)
cpl_discord.events.on_reaction_clear_emoji_abc
class
cpl_discord.events.on_reaction_clear_emoji_abc.
OnReactionClearEmojiABC
Bases:
ABC
abstract
async
on_reaction_clear_emoji
(
reaction
:
Reaction
)
cpl_discord.events.on_reaction_remove_abc
class
cpl_discord.events.on_reaction_remove_abc.
OnReactionRemoveABC
Bases:
ABC
abstract
async
on_reaction_remove
(
reaction
:
Reaction
,
user
:
User
)
cpl_discord.events.on_ready_abc
class
cpl_discord.events.on_ready_abc.
OnReadyABC
Bases:
ABC
abstract
async
on_ready
(
)
cpl_discord.events.on_resume_abc
class
cpl_discord.events.on_resume_abc.
OnResumeABC
Bases:
ABC
abstract
async
on_resume
(
)
cpl_discord.events.on_typing_abc
class
cpl_discord.events.on_typing_abc.
OnTypingABC
Bases:
ABC
abstract
async
on_typing
(
channel
:
Messageable
,
user
:
Union
[
User
,
Member
]
,
when
:
datetime
)
cpl_discord.events.on_user_update_abc
class
cpl_discord.events.on_user_update_abc.
OnUserUpdateABC
Bases:
ABC
abstract
async
on_user_update
(
before
:
User
,
after
:
User
)
cpl_discord.events.on_voice_state_update_abc
class
cpl_discord.events.on_voice_state_update_abc.
OnVoiceStateUpdateABC
Bases:
ABC
abstract
async
on_voice_state_update
(
member
:
Member
,
before
:
VoiceState
,
after
:
VoiceState
)
cpl_discord.events.on_webhooks_update_abc
class
cpl_discord.events.on_webhooks_update_abc.
OnWebhooksUpdateABC
Bases:
ABC
abstract
async
on_webhooks_update
(
channel
:
GuildChannel
)