Preview environment

interface GuildScheduledEventCreateOptions

export interface GuildScheduledEventCreateOptions

Options used to create a guild scheduled event.

optional
channel? : GuildVoiceChannelResolvable

The channel of the guild scheduled event This is required if entityType is GuildScheduledEventEntityType.StageInstance or GuildScheduledEventEntityType.Voice

optional
description? : string

The description of the guild scheduled event

optional
entityMetadata? : GuildScheduledEventEntityMetadataOptions

The entity metadata of the guild scheduled event This is required if entityType is GuildScheduledEventEntityType.External

entityType : GuildScheduledEventEntityType

The scheduled entity type of the event

optional
image? : BufferResolvable | Base64Resolvable | null

The cover image of the guild scheduled event

name : string

The name of the guild scheduled event

privacyLevel : GuildScheduledEventPrivacyLevel

The privacy level of the guild scheduled event

optional
reason? : string

The reason for creating the guild scheduled event

optional
recurrenceRule? : GuildScheduledEventRecurrenceRuleOptions

The recurrence rule of the guild scheduled event

optional
scheduledEndTime? : DateResolvable

The time to end the event at This is required if entityType is GuildScheduledEventEntityType.External

scheduledStartTime : DateResolvable

The time to schedule the event at