Skip to main content

DiscordScheduledEventRecurrenceRule

@discordeno/bot

Documentation / @discordeno/bot / DiscordScheduledEventRecurrenceRule

Interface: DiscordScheduledEventRecurrenceRule

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:64

https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-structure

Properties​

by_month​

by_month: null | DiscordScheduledEventRecurrenceRuleMonth[]

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:78

Set of specific months to recur on

by_month_day​

by_month_day: null | number[]

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:80

Set of specific dates within a month to recur on

by_n_weekday​

by_n_weekday: null | DiscordScheduledEventRecurrenceRuleNWeekday[]

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:76

List of specific days within a specific week (1-5) to recur on

by_weekday​

by_weekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:74

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

by_year_day​

by_year_day: null | number[]

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:82

Set of days within a year to recur on (1-364)

count​

count: null | number

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:84

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

end​

end: null | string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:68

Ending time of the recurrence interval

frequency​

frequency: DiscordScheduledEventRecurrenceRuleFrequency

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:70

How often the event occurs

interval​

interval: number

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:72

The spacing between the events, defined by frequency. For example, frequency of Weekly and an interval of 2 would be "every-other week"

start​

start: string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:66

Starting time of the recurrence interval