CreateScheduledEvent

Documentation

---

Documentation / @discordeno/types / CreateScheduledEvent

Interface: CreateScheduledEvent

Defined in: discordeno/guildScheduledEvent.ts:19

https://docs.discord.com/developers/resources/guild-scheduled-event#create-guild-scheduled-event-json-params

Properties

channelId?

optional channelId?: BigString

Defined in: discordeno/guildScheduledEvent.ts:21

the channel id of the scheduled event.

---

description

description: string

Defined in: discordeno/guildScheduledEvent.ts:32

the description of the scheduled event

---

entityMetadata?

optional entityMetadata?: DiscordScheduledEventEntityMetadata

Defined in: discordeno/guildScheduledEvent.ts:22

---

entityType

entityType: ScheduledEventEntityType

Defined in: discordeno/guildScheduledEvent.ts:34

the type of hosting entity associated with a scheduled event

---

image?

optional image?: string

Defined in: discordeno/guildScheduledEvent.ts:36

the cover image of the scheduled event

---

name

name: string

Defined in: discordeno/guildScheduledEvent.ts:24

the name of the scheduled event

---

privacyLevel?

optional privacyLevel?: GuildOnly

Defined in: discordeno/guildScheduledEvent.ts:26

the privacy level of the scheduled event

---

recurrenceRule?

optional recurrenceRule?: DiscordScheduledEventRecurrenceRule

Defined in: discordeno/guildScheduledEvent.ts:38

the definition for how often this event should recur

---

scheduledEndTime?

optional scheduledEndTime?: string

Defined in: discordeno/guildScheduledEvent.ts:30

the time the scheduled event will end if it does end. Required for events with entityType: ScheduledEventEntityType.External

---

scheduledStartTime

scheduledStartTime: string

Defined in: discordeno/guildScheduledEvent.ts:28

the time the scheduled event will start