Skip to content

Events

user_events

UserUpdateEvent dataclass

Bases: Event, UserModel


              flowchart TD
              scurrypy.events.user_events.UserUpdateEvent[UserUpdateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.api.user.UserModel[UserModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.user_events.UserUpdateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.api.user.UserModel --> scurrypy.events.user_events.UserUpdateEvent
                                scurrypy.core.model.DataModel --> scurrypy.api.user.UserModel
                



              click scurrypy.events.user_events.UserUpdateEvent href "" "scurrypy.events.user_events.UserUpdateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.api.user.UserModel href "" "scurrypy.api.user.UserModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a user's settings are updated.

dispatch_name = EventType.USER_UPDATE class-attribute instance-attribute

GuildMemberAddEvent dataclass

Bases: Event, GuildMemberModel


              flowchart TD
              scurrypy.events.user_events.GuildMemberAddEvent[GuildMemberAddEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.api.user.GuildMemberModel[GuildMemberModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.user_events.GuildMemberAddEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.api.user.GuildMemberModel --> scurrypy.events.user_events.GuildMemberAddEvent
                                scurrypy.core.model.DataModel --> scurrypy.api.user.GuildMemberModel
                



              click scurrypy.events.user_events.GuildMemberAddEvent href "" "scurrypy.events.user_events.GuildMemberAddEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.api.user.GuildMemberModel href "" "scurrypy.api.user.GuildMemberModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a member joins a guild the bot is in.

Warning

Requires privileged GUILD_MEMBERS intent.

dispatch_name = EventType.GUILD_MEMBER_ADD class-attribute instance-attribute

guild_id: Snowflake instance-attribute

ID of the guild.

GuildMemberUpdateEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.user_events.GuildMemberUpdateEvent[GuildMemberUpdateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.user_events.GuildMemberUpdateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.user_events.GuildMemberUpdateEvent
                


              click scurrypy.events.user_events.GuildMemberUpdateEvent href "" "scurrypy.events.user_events.GuildMemberUpdateEvent"
              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 guild member is updated.

Warning

Requires privileged GUILD_MEMBERS intent.

dispatch_name = EventType.GUILD_MEMBER_UPDATE class-attribute instance-attribute

guild_id: Snowflake instance-attribute

ID of the guild.

roles: list[Snowflake] instance-attribute

List of user's roles (their IDs).

user: UserModel instance-attribute

The User object.

avatar: str instance-attribute

Guild avatar hash.

banner: str instance-attribute

Guild banner hash.

joined_at: str instance-attribute

When the user joined the guild

GuildMemberRemoveEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.user_events.GuildMemberRemoveEvent[GuildMemberRemoveEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.user_events.GuildMemberRemoveEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.user_events.GuildMemberRemoveEvent
                


              click scurrypy.events.user_events.GuildMemberRemoveEvent href "" "scurrypy.events.user_events.GuildMemberRemoveEvent"
              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 member leaves or is kicked/banned from a guild the bot is in.

Warning

Requires privileged GUILD_MEMBERS intent.

dispatch_name = EventType.GUILD_MEMBER_REMOVE class-attribute instance-attribute

guild_id: Snowflake instance-attribute

ID of the guild.

user: UserModel instance-attribute

User object of the user leaving the guild.