GuildScheduledEventRecurrenceRule

typedef · Source

Represents the recurrence rule for a GuildScheduledEvent. Type: Object

Properties

startTimestamp

startTimestamp: number

The timestamp the recurrence rule interval starts at

startAt

startAt: Date

The time the recurrence rule interval starts at

endTimestamp

nullable

endTimestamp: number

The timestamp the recurrence rule interval ends at

endAt

nullable

endAt: Date

The time the recurrence rule interval ends at

frequency

frequency: GuildScheduledEventRecurrenceRuleFrequency

How often the event occurs

interval

interval: number

The spacing between the events

byWeekday

nullable

byWeekday: Array<GuildScheduledEventRecurrenceRuleWeekday>

The days within a week to recur on

byNWeekday

nullable

byNWeekday: Array<GuildScheduledEventRecurrenceRuleNWeekday>

The days within a week to recur on

byMonth

nullable

byMonth: Array<GuildScheduledEventRecurrenceRuleMonth>

The months to recur on

byMonthDay

nullable

byMonthDay: Array<number>

The days within a month to recur on

byYearDay

nullable

byYearDay: Array<number>

The days within a year to recur on

count

nullable

count: number

The total amount of times the event is allowed to recur before stopping