Skip to content

Events

invite_events

InviteCreateEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.invite_events.InviteCreateEvent[InviteCreateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.invite_events.InviteCreateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.invite_events.InviteCreateEvent
                


              click scurrypy.events.invite_events.InviteCreateEvent href "" "scurrypy.events.invite_events.InviteCreateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when an invite is created.

dispatch_name = EventType.INVITE_CREATE class-attribute instance-attribute

channel_id: Snowflake instance-attribute

Channel ID in which the invite belongs.

code: str instance-attribute

Invite code (unique ID).

guild_id: Snowflake | None instance-attribute

Guild ID in which the invite belongs.

inviter: UserModel | None instance-attribute

User who created invite.

uses: int instance-attribute

Number of times this invite was used.

max_uses: int instance-attribute

Max number of times this invite can be used.

max_age: int instance-attribute

Duration (in seconds) after which this invite expires.

temporary: bool instance-attribute

Whether this invite only grants temporary membership.

created_at: str instance-attribute

ISO8601 timestamp for when this invite was created.

InviteDeleteEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.invite_events.InviteDeleteEvent[InviteDeleteEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.invite_events.InviteDeleteEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.invite_events.InviteDeleteEvent
                


              click scurrypy.events.invite_events.InviteDeleteEvent href "" "scurrypy.events.invite_events.InviteDeleteEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when an invite is deleted.

dispatch_name = EventType.INVITE_DELETE class-attribute instance-attribute

channel_id: Snowflake instance-attribute

Channel ID in which the invite belongs.

guild_id: Snowflake | None instance-attribute

Guild ID in which the invite belongs.

code: str instance-attribute

Unique invite code.