hikari.impl.event_factory
#
Implementation for a singleton bot event factory.
EventFactoryImpl
#
EventFactoryImpl(app: RESTAware)
Bases: EventFactory
Implementation for a single-application bot event factory.
deserialize_application_command_permission_update_event
#
deserialize_application_command_permission_update_event(
shard: GatewayShard, payload: JSONObject
) -> ApplicationCommandPermissionsUpdateEvent
Parse a raw payload from Discord into an application command permissions update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ApplicationCommandPermissionsUpdateEvent
|
The parsed application command permissions update event. |
deserialize_audit_log_entry_create_event
#
deserialize_audit_log_entry_create_event(
shard: GatewayShard, payload: JSONObject
) -> AuditLogEntryCreateEvent
Parse a raw payload from Discord into a audit log entry create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
AuditLogEntryCreateEvent
|
The parsed audit log entry create object. |
deserialize_channel_pins_update_event
#
deserialize_channel_pins_update_event(
shard: GatewayShard, payload: JSONObject
) -> PinsUpdateEvent
Parse a raw payload from Discord into a channel pins update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
PinsUpdateEvent
|
The parsed channel pins update event object. |
deserialize_connected_event
#
deserialize_connected_event(shard: GatewayShard) -> ShardConnectedEvent
Build a shard connected event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ShardReadyEvent
|
The built shard connected event object. |
deserialize_disconnected_event
#
deserialize_disconnected_event(shard: GatewayShard) -> ShardDisconnectedEvent
Build a shard disconnected event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ShardReadyEvent
|
The built shard disconnected event object. |
deserialize_entitlement_create_event
#
deserialize_entitlement_create_event(
shard: GatewayShard, payload: JSONObject
) -> EntitlementCreateEvent
Parse a raw payload from Discord into a entitlement create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
EntitlementCreateEvent
|
The parsed entitlement create event object. |
deserialize_entitlement_delete_event
#
deserialize_entitlement_delete_event(
shard: GatewayShard, payload: JSONObject
) -> EntitlementDeleteEvent
Parse a raw payload from Discord into a entitlement delete event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
EntitlementDeleteEvent
|
The parsed entitlement delete event object. |
deserialize_entitlement_update_event
#
deserialize_entitlement_update_event(
shard: GatewayShard, payload: JSONObject
) -> EntitlementUpdateEvent
Parse a raw payload from Discord into a entitlement update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
EntitlementUpdateEvent
|
The parsed entitlement update event object. |
deserialize_guild_available_event
#
deserialize_guild_available_event(
shard: GatewayShard, payload: JSONObject
) -> GuildAvailableEvent
Parse a raw payload from Discord into a guild available event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildAvailableEvent
|
The parsed guild create event object. |
deserialize_guild_ban_add_event
#
deserialize_guild_ban_add_event(
shard: GatewayShard, payload: JSONObject
) -> BanCreateEvent
Parse a raw payload from Discord into a guild ban add event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
BanCreateEvent
|
The parsed guild ban add event object. |
deserialize_guild_ban_remove_event
#
deserialize_guild_ban_remove_event(
shard: GatewayShard, payload: JSONObject
) -> BanDeleteEvent
Parse a raw payload from Discord into a guild ban remove event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
BanDeleteEvent
|
The parsed guild ban remove event object. |
deserialize_guild_channel_create_event
#
deserialize_guild_channel_create_event(
shard: GatewayShard, payload: JSONObject
) -> GuildChannelCreateEvent
Parse a raw payload from Discord into a channel create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildChannelCreateEvent
|
The parsed channel create event object. |
deserialize_guild_channel_delete_event
#
deserialize_guild_channel_delete_event(
shard: GatewayShard, payload: JSONObject
) -> GuildChannelDeleteEvent
Parse a raw payload from Discord into a channel delete event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildChannelDeleteEvent
|
The parsed channel delete event object. |
deserialize_guild_channel_update_event
#
deserialize_guild_channel_update_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_channel: Optional[PermissibleGuildChannel] = None
) -> GuildChannelUpdateEvent
Parse a raw payload from Discord into a channel update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_channel |
The guild channel object or
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildChannelUpdateEvent
|
The parsed event object. |
deserialize_guild_emojis_update_event
#
deserialize_guild_emojis_update_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_emojis: Optional[Sequence[KnownCustomEmoji]] = None
) -> EmojisUpdateEvent
Parse a raw payload from Discord into a guild emojis update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_emojis |
The sequence of emojis or
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
EmojisUpdateEvent
|
The parsed guild emojis update event object. |
deserialize_guild_join_event
#
deserialize_guild_join_event(
shard: GatewayShard, payload: JSONObject
) -> GuildJoinEvent
Parse a raw payload from Discord into a guild join event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildJoinEvent
|
The parsed guild join event object. |
deserialize_guild_leave_event
#
deserialize_guild_leave_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_guild: Optional[GatewayGuild] = None
) -> GuildLeaveEvent
Parse a raw payload from Discord into a guild leave event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_guild |
The guild object or
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildLeaveEvent
|
The parsed guild leave event object. |
deserialize_guild_member_add_event
#
deserialize_guild_member_add_event(
shard: GatewayShard, payload: JSONObject
) -> MemberCreateEvent
Parse a raw payload from Discord into a guild member add event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
MemberCreateEvent
|
The parsed guild member add event object. |
deserialize_guild_member_chunk_event
#
deserialize_guild_member_chunk_event(
shard: GatewayShard, payload: JSONObject
) -> MemberChunkEvent
Parse a raw payload from Discord into a member chunk event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
MemberChunkEvent
|
The parsed member chunk object. |
deserialize_guild_member_remove_event
#
deserialize_guild_member_remove_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_member: Optional[Member] = None
) -> MemberDeleteEvent
Parse a raw payload from Discord into a guild member remove event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_member |
The member object or |
RETURNS | DESCRIPTION |
---|---|
MemberDeleteEvent
|
The parsed guild member remove event object. |
deserialize_guild_member_update_event
#
deserialize_guild_member_update_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_member: Optional[Member] = None
) -> MemberUpdateEvent
Parse a raw payload from Discord into a guild member update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_member |
The member object or |
RETURNS | DESCRIPTION |
---|---|
MemberUpdateEvent
|
The parsed guild member update event object. |
deserialize_guild_message_delete_bulk_event
#
deserialize_guild_message_delete_bulk_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_messages: Optional[Mapping[Snowflake, Message]] = None
) -> GuildBulkMessageDeleteEvent
Parse a raw payload from Discord into a guild message delete bulk event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_messages |
A mapping of the old message objects. |
RETURNS | DESCRIPTION |
---|---|
GuildBulkMessageDeleteEvent
|
The parsed guild message delete bulk event object. |
deserialize_guild_role_create_event
#
deserialize_guild_role_create_event(
shard: GatewayShard, payload: JSONObject
) -> RoleCreateEvent
Parse a raw payload from Discord into a guild role create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
RoleCreateEvent
|
The parsed guild role create event object. |
deserialize_guild_role_delete_event
#
deserialize_guild_role_delete_event(
shard: GatewayShard, payload: JSONObject, *, old_role: Optional[Role] = None
) -> RoleDeleteEvent
Parse a raw payload from Discord into a guild role delete event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_role |
The role object or |
RETURNS | DESCRIPTION |
---|---|
RoleDeleteEvent
|
The parsed guild role delete event object. |
deserialize_guild_role_update_event
#
deserialize_guild_role_update_event(
shard: GatewayShard, payload: JSONObject, *, old_role: Optional[Role] = None
) -> RoleUpdateEvent
Parse a raw payload from Discord into a guild role update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_role |
The role object or |
RETURNS | DESCRIPTION |
---|---|
RoleUpdateEvent
|
The parsed guild role update event object. |
deserialize_guild_stickers_update_event
#
deserialize_guild_stickers_update_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_stickers: Optional[Sequence[GuildSticker]] = None
) -> StickersUpdateEvent
Parse a raw payload from Discord into a guild stickers update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_stickers |
The sequence of stickers or
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
StickersUpdateEvent
|
The parsed guild stickers update event object. |
deserialize_guild_thread_access_event
#
deserialize_guild_thread_access_event(
shard: GatewayShard, payload: JSONObject
) -> GuildThreadAccessEvent
Parse a raw payload from Discord into a guild thread access event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildThreadAccessEvent
|
The parsed guild thread create event object. |
deserialize_guild_thread_create_event
#
deserialize_guild_thread_create_event(
shard: GatewayShard, payload: JSONObject
) -> GuildThreadCreateEvent
Parse a raw payload from Discord into a guild thread create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildThreadCreateEvent
|
The parsed guild thread create event object. |
deserialize_guild_thread_delete_event
#
deserialize_guild_thread_delete_event(
shard: GatewayShard, payload: JSONObject
) -> GuildThreadDeleteEvent
Parse a raw payload from Discord into a guild thread delete event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildThreadDeleteEvent
|
The parsed guild thread delete event object. |
deserialize_guild_thread_update_event
#
deserialize_guild_thread_update_event(
shard: GatewayShard, payload: JSONObject
) -> GuildThreadUpdateEvent
Parse a raw payload from Discord into a guild thread update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildThreadUpdateEvent
|
The parsed guild thread update event object. |
deserialize_guild_unavailable_event
#
deserialize_guild_unavailable_event(
shard: GatewayShard, payload: JSONObject
) -> GuildUnavailableEvent
Parse a raw payload from Discord into a guild unavailable event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildUnavailableEvent
|
The parsed guild unavailable event object. |
deserialize_guild_update_event
#
deserialize_guild_update_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_guild: Optional[GatewayGuild] = None
) -> GuildUpdateEvent
Parse a raw payload from Discord into a guild update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_guild |
The guild object or
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuildUpdateEvent
|
The parsed guild update event object. |
deserialize_integration_create_event
#
deserialize_integration_create_event(
shard: GatewayShard, payload: JSONObject
) -> IntegrationCreateEvent
Parse a raw payload from Discord into an integration create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
IntegrationCreateEvent
|
The parsed integration create event object. |
deserialize_integration_delete_event
#
deserialize_integration_delete_event(
shard: GatewayShard, payload: JSONObject
) -> IntegrationDeleteEvent
Parse a raw payload from Discord into an integration delete event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
IntegrationDeleteEvent
|
The parsed integration delete event object. |
deserialize_integration_update_event
#
deserialize_integration_update_event(
shard: GatewayShard, payload: JSONObject
) -> IntegrationUpdateEvent
Parse a raw payload from Discord into an integration update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
IntegrationUpdateEvent
|
The parsed integration update event object. |
deserialize_interaction_create_event
#
deserialize_interaction_create_event(
shard: GatewayShard, payload: JSONObject
) -> InteractionCreateEvent
Parse a raw payload from Discord into a interaction create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
InteractionCreateEvent
|
The parsed interaction create event object. |
deserialize_invite_create_event
#
deserialize_invite_create_event(
shard: GatewayShard, payload: JSONObject
) -> InviteCreateEvent
Parse a raw payload from Discord into an invite create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
InviteCreateEvent
|
The parsed invite create event object. |
deserialize_invite_delete_event
#
deserialize_invite_delete_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_invite: Optional[InviteWithMetadata] = None
) -> InviteDeleteEvent
Parse a raw payload from Discord into an invite delete event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_invite |
The invite object or
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
InviteDeleteEvent
|
The parsed invite delete event object. |
deserialize_message_create_event
#
deserialize_message_create_event(
shard: GatewayShard, payload: JSONObject
) -> MessageCreateEvent
Parse a raw payload from Discord into a message create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
MessageCreateEvent
|
The parsed message create event object. |
deserialize_message_delete_event
#
deserialize_message_delete_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_message: Optional[Message] = None
) -> MessageDeleteEvent
Parse a raw payload from Discord into a message delete event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_message |
The old message object. |
RETURNS | DESCRIPTION |
---|---|
MessageDeleteEvent
|
The parsed message delete event object. |
deserialize_message_reaction_add_event
#
deserialize_message_reaction_add_event(
shard: GatewayShard, payload: JSONObject
) -> ReactionAddEvent
Parse a raw payload from Discord into a message reaction add event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ReactionAddEvent
|
The parsed message reaction add event object. |
deserialize_message_reaction_remove_all_event
#
deserialize_message_reaction_remove_all_event(
shard: GatewayShard, payload: JSONObject
) -> ReactionDeleteAllEvent
Parse a raw payload from Discord into a message reaction remove all event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ReactionDeleteAllEvent
|
The parsed message reaction remove all event object. |
deserialize_message_reaction_remove_emoji_event
#
deserialize_message_reaction_remove_emoji_event(
shard: GatewayShard, payload: JSONObject
) -> ReactionDeleteEmojiEvent
Parse a raw payload from Discord into a message reaction remove emoji event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ReactionDeleteEmojiEvent
|
The parsed message reaction remove emoji event object. |
deserialize_message_reaction_remove_event
#
deserialize_message_reaction_remove_event(
shard: GatewayShard, payload: JSONObject
) -> ReactionDeleteEvent
Parse a raw payload from Discord into a message reaction remove event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ReactionDeleteEvent
|
The parsed message reaction remove event object. |
deserialize_message_update_event
#
deserialize_message_update_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_message: Optional[PartialMessage] = None
) -> MessageUpdateEvent
Parse a raw payload from Discord into a message update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_message |
The message object or
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
MessageUpdateEvent
|
The parsed message update event object. |
deserialize_own_user_update_event
#
deserialize_own_user_update_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_user: Optional[OwnUser] = None
) -> OwnUserUpdateEvent
Parse a raw payload from Discord into a own user update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_user |
The OwnUser object or |
RETURNS | DESCRIPTION |
---|---|
OwnUserUpdateEvent
|
The parsed own user update event object. |
deserialize_presence_update_event
#
deserialize_presence_update_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_presence: Optional[MemberPresence] = None
) -> PresenceUpdateEvent
Parse a raw payload from Discord into a presence update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_presence |
The presence object or
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
PresenceUpdateEvent
|
The parsed presence update event object. |
deserialize_ready_event
#
deserialize_ready_event(
shard: GatewayShard, payload: JSONObject
) -> ShardReadyEvent
Parse a raw payload from Discord into a ready event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ShardReadyEvent
|
The parsed ready event object. |
deserialize_resumed_event
#
deserialize_resumed_event(shard: GatewayShard) -> ShardResumedEvent
Build a shard resumed event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ShardReadyEvent
|
The built shard resumed event object. |
deserialize_scheduled_event_create_event
#
deserialize_scheduled_event_create_event(
shard: GatewayShard, payload: JSONObject
) -> ScheduledEventCreateEvent
Parse a raw payload from Discord into a scheduled event create event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ScheduledEventCreateEvent
|
The parsed scheduled event create event object. |
deserialize_scheduled_event_delete_event
#
deserialize_scheduled_event_delete_event(
shard: GatewayShard, payload: JSONObject
) -> ScheduledEventDeleteEvent
Parse a raw payload from Discord into a scheduled event delete event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ScheduledEventDeleteEvent
|
The parsed scheduled event delete event object. |
deserialize_scheduled_event_update_event
#
deserialize_scheduled_event_update_event(
shard: GatewayShard, payload: JSONObject
) -> ScheduledEventUpdateEvent
Parse a raw payload from Discord into a scheduled event update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ScheduledEventUpdateEvent
|
The parsed scheduled event update event object. |
deserialize_scheduled_event_user_add_event
#
deserialize_scheduled_event_user_add_event(
shard: GatewayShard, payload: JSONObject
) -> ScheduledEventUserAddEvent
Parse a raw payload from Discord into a scheduled event user add event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ScheduledEventUserAddEvent
|
The parsed scheduled event user add event object. |
deserialize_scheduled_event_user_remove_event
#
deserialize_scheduled_event_user_remove_event(
shard: GatewayShard, payload: JSONObject
) -> ScheduledEventUserRemoveEvent
Parse a raw payload from Discord into a scheduled event user remove event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ScheduledEventUserRemoveEvent
|
The parsed scheduled event user remove event object. |
deserialize_shard_payload_event
#
deserialize_shard_payload_event(
shard: GatewayShard, payload: JSONObject, *, name: str
) -> ShardPayloadEvent
Parse a raw payload from Discord into a shard payload event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
name |
Name of the event.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ShardPayloadEvent
|
The parsed shard payload event object. |
deserialize_started_event
#
deserialize_started_event() -> StartedEvent
Build a started event object.
RETURNS | DESCRIPTION |
---|---|
StartingEvent
|
The built started event object. |
deserialize_starting_event
#
deserialize_starting_event() -> StartingEvent
Build a starting event object.
RETURNS | DESCRIPTION |
---|---|
StartingEvent
|
The built starting event object. |
deserialize_stopped_event
#
deserialize_stopped_event() -> StoppedEvent
Build a stopped event object.
RETURNS | DESCRIPTION |
---|---|
StartingEvent
|
The built starting event object. |
deserialize_stopping_event
#
deserialize_stopping_event() -> StoppingEvent
Build a starting event object.
RETURNS | DESCRIPTION |
---|---|
StartingEvent
|
The built starting event object. |
deserialize_thread_list_sync_event
#
deserialize_thread_list_sync_event(
shard: GatewayShard, payload: JSONObject
) -> ThreadListSyncEvent
Parse a raw payload from Discord into a thread list sync event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ThreadListSyncEvent
|
The parsed thread member list sync event object. |
deserialize_thread_members_update_event
#
deserialize_thread_members_update_event(
shard: GatewayShard, payload: JSONObject
) -> ThreadMembersUpdateEvent
Parse a raw payload from Discord into a thread members update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
ThreadMembersUpdateEvent
|
The parsed thread members update event object. |
deserialize_typing_start_event
#
deserialize_typing_start_event(
shard: GatewayShard, payload: JSONObject
) -> TypingEvent
Parse a raw payload from Discord into a typing start event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
TypingEvent
|
The parsed typing start event object. |
deserialize_voice_server_update_event
#
deserialize_voice_server_update_event(
shard: GatewayShard, payload: JSONObject
) -> VoiceServerUpdateEvent
Parse a raw payload from Discord into a voice server update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
VoiceServerUpdateEvent
|
The parsed voice server update event object. |
deserialize_voice_state_update_event
#
deserialize_voice_state_update_event(
shard: GatewayShard,
payload: JSONObject,
*,
old_state: Optional[VoiceState] = None
) -> VoiceStateUpdateEvent
Parse a raw payload from Discord into a voice state update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
old_state |
The VoiceState object or
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
VoiceStateUpdateEvent
|
The parsed voice state update event object. |
deserialize_webhook_update_event
#
deserialize_webhook_update_event(
shard: GatewayShard, payload: JSONObject
) -> WebhookUpdateEvent
Parse a raw payload from Discord into a webhook update event object.
PARAMETER | DESCRIPTION |
---|---|
shard |
The shard that emitted this event.
TYPE:
|
payload |
The dict payload to parse.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
WebhookUpdateEvent
|
The parsed webhook update event object. |