GuildScheduledEventCreateOptions

typedef · Source

Options used to create a guild scheduled event. Type: Object

Properties

name

name: string

The name of the guild scheduled event

scheduledStartTime

scheduledStartTime: DateResolvable

The time to schedule the event at

scheduledEndTime

optional

scheduledEndTime: DateResolvable

The time to end the event at This is required if entityType is 'EXTERNAL'

privacyLevel

privacyLevel: PrivacyLevel | number

The privacy level of the guild scheduled event

entityType

entityType: GuildScheduledEventEntityType | number

The scheduled entity type of the event

description

optional

description: string

The description of the guild scheduled event

channel

optional

channel: GuildVoiceChannelResolvable

The channel of the guild scheduled event This is required if entityType is 'STAGE_INSTANCE' or VOICE

entityMetadata

optional

entityMetadata: GuildScheduledEventEntityMetadataOptions

The entity metadata of the guild scheduled event This is required if entityType is 'EXTERNAL'

image

nullable · optional

image: BufferResolvable | Base64Resolvable

The cover image of the guild scheduled event

reason

optional

reason: string

The reason for creating the guild scheduled event

recurrenceRule

optional

recurrenceRule: GuildScheduledEventRecurrenceRuleOptions

The recurrence rule of the guild scheduled event