Skip to content

Resources

guild_scheduled_event

GuildScheduledEvent dataclass

Bases: BaseResource


              flowchart TD
              scurrypy.resources.guild_scheduled_event.GuildScheduledEvent[GuildScheduledEvent]
              scurrypy.resources.base_resource.BaseResource[BaseResource]

                              scurrypy.resources.base_resource.BaseResource --> scurrypy.resources.guild_scheduled_event.GuildScheduledEvent
                


              click scurrypy.resources.guild_scheduled_event.GuildScheduledEvent href "" "scurrypy.resources.guild_scheduled_event.GuildScheduledEvent"
              click scurrypy.resources.base_resource.BaseResource href "" "scurrypy.resources.base_resource.BaseResource"

Represents the guild scheduled event resource.

guild_id: Snowflake instance-attribute

Guild ID of the scheduled events.

fetch async

Fetch a scheduled event.

Parameters:

  • event_id (Snowflake) –

    ID of the scheduled event

  • with_user_count (bool, default: None ) –

    include number of users subscribed to this event

Returns:

fetch_all async

Fetch all scheduled events for this guild.

Parameters:

  • with_user_count (bool, default: None ) –

    include number of users subscribed to this event

Returns:

  • JsonQuery –

    list of queried scheduled events

create async

Create a scheduled event for this guild. Fires Guild Scheduled Event Create Event.

Parameters:

Returns:

edit async

Edit a scheduled event. Fires Guild Scheduled Event Update.

Note

COMPLETED and CANCELED events cannot be updated.

Parameters:

  • event_id (Snowflake) –

    ID of the scheduled event to edit

  • options (GuildScheduledEventParams) –

    fields to edit

Returns:

delete async

Delete a scheduled event. Fires Guild Scheduled Event Delete.

Parameters:

  • event_id (Snowflake) –

    ID of the scheduled event to delete

fetch_users async

Fetch users subscribed to this scheduled event.

Parameters:

  • event_id (Snowflake) –

    ID of the scheduled event

  • limit (int, default: 100 ) –

    Max number of users to return. Defaults to 100.

  • with_member (bool, default: False ) –

    Include guild member data if it exists. Defaults to False.

  • before (Snowflake, default: None ) –

    consider only users before this user ID

  • after (Snowflake, default: None ) –

    consider only users after this user ID

Returns:

  • JsonQuery –

    list of queried scheduled event users