Skip to content

Objects

guild_scheduled_event

RecurrenceRulePart dataclass

Bases: Part


              flowchart TD
              scurrypy.api.guild_scheduled_event.RecurrenceRulePart[RecurrenceRulePart]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.api.guild_scheduled_event.RecurrenceRulePart
                


              click scurrypy.api.guild_scheduled_event.RecurrenceRulePart href "" "scurrypy.api.guild_scheduled_event.RecurrenceRulePart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"

Represents fields for creating a scheduled event recurrence rule.

start: RequiredPartField[Timestamp] = None class-attribute instance-attribute

Starting time of the recurrence interval.

end: RequiredNullablePartField[Timestamp] = None class-attribute instance-attribute

Ending time of the recurrence interval.

frequency: RequiredPartField[GuildScheduledEventRecurrenceRuleFrequencyType] = None class-attribute instance-attribute

How often the event occurs.

interval: RequiredPartField[int] = None class-attribute instance-attribute

Spacing between the events as defined by frequency.

by_weekday: RequiredNullablePartField[list[GuildScheduledEventRecurrenceRuleWeekdayType]] = None class-attribute instance-attribute

Set of specific days within a week for the event to recur.

by_month: RequiredNullablePartField[list[GuildScheduledEventRecurrenceRuleMonthType]] = None class-attribute instance-attribute

Set of specific months to recur.

by_month_day: RequiredNullablePartField[list[int]] = None class-attribute instance-attribute

Set of specific dates within a month to recur.

by_year_day: RequiredNullablePartField[list[int]] = None class-attribute instance-attribute

Set of days within a year to recur.

count: RequiredNullablePartField[int] = None class-attribute instance-attribute

Total amount of times that the event is allowed to recur before stopping.

GuildScheduledEventPart dataclass

Bases: Part


              flowchart TD
              scurrypy.api.guild_scheduled_event.GuildScheduledEventPart[GuildScheduledEventPart]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.api.guild_scheduled_event.GuildScheduledEventPart
                


              click scurrypy.api.guild_scheduled_event.GuildScheduledEventPart href "" "scurrypy.api.guild_scheduled_event.GuildScheduledEventPart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"

Represents fields for creating a scheduled event.

channel_id: OptionalPartField[Snowflake] = None class-attribute instance-attribute

Channel ID of the scheduled event.

name: RequiredPartField[str] = None class-attribute instance-attribute

Name of the scheduled event.

privacy_level: RequiredPartField[GuildScheduledEventPrivacyLevel] = None class-attribute instance-attribute

Privacy level of the scheduled event.

scheduled_start_time: RequiredPartField[Timestamp] = None class-attribute instance-attribute

When the scheduled event is to be scheduled.

scheduled_end_time: OptionalPartField[Timestamp] = None class-attribute instance-attribute

When the scheduled event is scheduled to end.

description: OptionalPartField[str] = None class-attribute instance-attribute

Description of the scheduled event.

entity_type: RequiredPartField[GuildScheduledEventEntityType] = None class-attribute instance-attribute

Entity type of the scheduled event.

image: OptionalPartField[ImageDataPart] = None class-attribute instance-attribute

Cover image of the scheduled event.

recurrence_rule: OptionalPartField[RecurrenceRulePart] = None class-attribute instance-attribute

How often the event should recur.