Events

---

Message

---

message_events

MessageCreateEvent dataclass

Bases: Event, MessageModel

              flowchart TD
              scurrypy.events.message_events.MessageCreateEvent[MessageCreateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.api.messages.message.MessageModel[MessageModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.message_events.MessageCreateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.api.messages.message.MessageModel --> scurrypy.events.message_events.MessageCreateEvent
                                scurrypy.core.model.DataModel --> scurrypy.api.messages.message.MessageModel
                



              click scurrypy.events.message_events.MessageCreateEvent href "" "scurrypy.events.message_events.MessageCreateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.api.messages.message.MessageModel href "" "scurrypy.api.messages.message.MessageModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Received when a message is created.

Note

member may be missing on MESSAGE_CREATE and MESSAGE_UPDATE. Use author when you need the user.

dispatch_name = EventType.MESSAGE_CREATE class-attribute instance-attribute

guild_id: Snowflake | None instance-attribute

Guild ID of the updated message (if in a guild channel).

member: GuildMemberModel | None instance-attribute

Partial Member object of the author of the message.

MessageUpdateEvent dataclass

Bases: Event, MessageModel

              flowchart TD
              scurrypy.events.message_events.MessageUpdateEvent[MessageUpdateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.api.messages.message.MessageModel[MessageModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.message_events.MessageUpdateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.api.messages.message.MessageModel --> scurrypy.events.message_events.MessageUpdateEvent
                                scurrypy.core.model.DataModel --> scurrypy.api.messages.message.MessageModel
                



              click scurrypy.events.message_events.MessageUpdateEvent href "" "scurrypy.events.message_events.MessageUpdateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.api.messages.message.MessageModel href "" "scurrypy.api.messages.message.MessageModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Received when a message is updated.

dispatch_name = EventType.MESSAGE_UPDATE class-attribute instance-attribute

guild_id: Snowflake | None instance-attribute

Guild ID of the updated message (if in a guild channel).

member: GuildMemberModel | None instance-attribute

Partial Member object of the author of the message.

MessageDeleteEvent dataclass

Bases: Event, DataModel

              flowchart TD
              scurrypy.events.message_events.MessageDeleteEvent[MessageDeleteEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.message_events.MessageDeleteEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.message_events.MessageDeleteEvent
                


              click scurrypy.events.message_events.MessageDeleteEvent href "" "scurrypy.events.message_events.MessageDeleteEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Received when a message is deleted.

dispatch_name = EventType.MESSAGE_DELETE class-attribute instance-attribute

id: Snowflake instance-attribute

ID of the deleted message.

channel_id: Snowflake instance-attribute

Channel ID of the deleted message.

guild_id: Snowflake | None instance-attribute

Guild ID of the deleted message (if in a guild channel).

BulkMessageDeleteEvent dataclass

Bases: Event, DataModel

              flowchart TD
              scurrypy.events.message_events.BulkMessageDeleteEvent[BulkMessageDeleteEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.message_events.BulkMessageDeleteEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.message_events.BulkMessageDeleteEvent
                


              click scurrypy.events.message_events.BulkMessageDeleteEvent href "" "scurrypy.events.message_events.BulkMessageDeleteEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Received when bulk deleting messages.

dispatch_name = EventType.BULK_MESSAGE_DELETE class-attribute instance-attribute

ids: list[Snowflake] instance-attribute

IDs of the messages that were deleted.

channel_id: Snowflake instance-attribute

ID of the channel.

guild_id: Snowflake | None instance-attribute

ID of the guild.

Reaction

---

reaction_events

ReactionAddEvent dataclass

Bases: Event, DataModel

              flowchart TD
              scurrypy.events.reaction_events.ReactionAddEvent[ReactionAddEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.reaction_events.ReactionAddEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.reaction_events.ReactionAddEvent
                


              click scurrypy.events.reaction_events.ReactionAddEvent href "" "scurrypy.events.reaction_events.ReactionAddEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Reaction added event.

dispatch_name = EventType.MESSAGE_REACTION_ADD class-attribute instance-attribute

type: int instance-attribute

Type of reaction added.

user_id: Snowflake instance-attribute

ID of user who added the emoji.

emoji: EmojiModel instance-attribute

Emoji used to react.

channel_id: Snowflake instance-attribute

ID of the channel where the reaction took place.

message_id: Snowflake instance-attribute

ID of the message where the reaction took place.

guild_id: Snowflake | None instance-attribute

ID of the guild where the reaction took place (if in a guild).

burst: bool instance-attribute

Whether the emoji is super.

member: GuildMemberModel | None instance-attribute

Partial member object of the guild member that added the emoji (if in a guild).

message_author_id: Snowflake | None instance-attribute

ID of the user who sent the message where the reaction was added.

ReactionRemoveEvent dataclass

Bases: Event, DataModel

              flowchart TD
              scurrypy.events.reaction_events.ReactionRemoveEvent[ReactionRemoveEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.reaction_events.ReactionRemoveEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.reaction_events.ReactionRemoveEvent
                


              click scurrypy.events.reaction_events.ReactionRemoveEvent href "" "scurrypy.events.reaction_events.ReactionRemoveEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Reaction removed event.

dispatch_name = EventType.MESSAGE_REACTION_REMOVE class-attribute instance-attribute

type: int instance-attribute

Type of reaction removed.

user_id: Snowflake instance-attribute

ID of user who removed their reaction.

emoji: EmojiModel instance-attribute

Emoji data of the emoji where the reaction was removed.

channel_id: Snowflake instance-attribute

ID of the channel where the reaction was removed.

message_id: Snowflake instance-attribute

ID of the message where the reaction was removed.

guild_id: Snowflake | None instance-attribute

ID of the guild where the reaction was removed (if in a guild).

burst: bool instance-attribute

If the emoji of the removed reaction is super.

ReactionRemoveEmojiEvent dataclass

Bases: Event, DataModel

              flowchart TD
              scurrypy.events.reaction_events.ReactionRemoveEmojiEvent[ReactionRemoveEmojiEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.reaction_events.ReactionRemoveEmojiEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.reaction_events.ReactionRemoveEmojiEvent
                


              click scurrypy.events.reaction_events.ReactionRemoveEmojiEvent href "" "scurrypy.events.reaction_events.ReactionRemoveEmojiEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

All reactions of a specific emoji removed.

dispatch_name = EventType.MESSAGE_REACTION_REMOVE_EMOJI class-attribute instance-attribute

emoji: EmojiModel instance-attribute

Emoji data of the removed reaction emoji.

channel_id: Snowflake instance-attribute

ID of the channel where the reaction emoji was removed.

message_id: Snowflake instance-attribute

ID of the message where the reaction emoji was removed.

guild_id: Snowflake | None instance-attribute

ID of the guild where the reaction emoji was removed. (if in a guild)

ReactionRemoveAllEvent dataclass

Bases: Event, DataModel

              flowchart TD
              scurrypy.events.reaction_events.ReactionRemoveAllEvent[ReactionRemoveAllEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.reaction_events.ReactionRemoveAllEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.reaction_events.ReactionRemoveAllEvent
                


              click scurrypy.events.reaction_events.ReactionRemoveAllEvent href "" "scurrypy.events.reaction_events.ReactionRemoveAllEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Remove all reactions event.

dispatch_name = EventType.MESSAGE_REACTION_REMOVE_ALL class-attribute instance-attribute

channel_id: Snowflake instance-attribute

ID of the channel where all reaction were removed.

message_id: Snowflake instance-attribute

ID of the message where all reaction were removed.

guild_id: Snowflake | None instance-attribute

ID of the guild where all reaction were removed (if in a guild).