GuildScheduledEventEditOptions

typedef · Source

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

Properties

name

optional

name: string

The name of the guild scheduled event

scheduledStartTime

optional

scheduledStartTime: DateResolvable

The time to schedule the event at

scheduledEndTime

optional

scheduledEndTime: DateResolvable

The time to end the event at

privacyLevel

optional

privacyLevel: PrivacyLevel | number

The privacy level of the guild scheduled event

entityType

optional

entityType: GuildScheduledEventEntityType | number

The scheduled entity type of the event

description

optional

description: string

The description of the guild scheduled event

channel

nullable · optional

channel: GuildVoiceChannelResolvable

The channel of the guild scheduled event

status

optional

status: GuildScheduledEventStatus | number

The status of the guild scheduled event

entityMetadata

optional

entityMetadata: GuildScheduledEventEntityMetadataOptions

The entity metadata of the guild scheduled event This can be modified only if entityType of the GuildScheduledEvent to be edited is 'EXTERNAL'

image

nullable · optional

image: BufferResolvable | Base64Resolvable

The cover image of the guild scheduled event

reason

optional

reason: string

The reason for editing the guild scheduled event

recurrenceRule

nullable · optional

recurrenceRule: GuildScheduledEventRecurrenceRuleOptions

The recurrence rule of the guild scheduled event