Skip to main content

EditScheduledEvent

Documentation

Documentation / @discordeno/types / EditScheduledEvent

Interface: EditScheduledEvent

Defined in: discordeno/guildScheduledEvent.ts:42

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

Properties​

channelId?​

optional channelId?: BigString | null

Defined in: discordeno/guildScheduledEvent.ts:44

the channel id of the scheduled event. null if switching to external event.

description?​

optional description?: string | null

Defined in: discordeno/guildScheduledEvent.ts:56

the description of the scheduled event

entityMetadata?​

optional entityMetadata?: DiscordScheduledEventEntityMetadata | null

Defined in: discordeno/guildScheduledEvent.ts:46

The entity metadata for the scheduled event

entityType?​

optional entityType?: ScheduledEventEntityType

Defined in: discordeno/guildScheduledEvent.ts:58

the type of hosting entity associated with a scheduled event

image?​

optional image?: string

Defined in: discordeno/guildScheduledEvent.ts:62

the cover image of the scheduled event

name?​

optional name?: string

Defined in: discordeno/guildScheduledEvent.ts:48

the name of the scheduled event

privacyLevel?​

optional privacyLevel?: GuildOnly

Defined in: discordeno/guildScheduledEvent.ts:50

the privacy level of the scheduled event

recurrenceRule?​

optional recurrenceRule?: DiscordScheduledEventRecurrenceRule | null

Defined in: discordeno/guildScheduledEvent.ts:64

the definition for how often this event should recur

scheduledEndTime?​

optional scheduledEndTime?: string

Defined in: discordeno/guildScheduledEvent.ts:54

the time the scheduled event will end if it does end.

scheduledStartTime?​

optional scheduledStartTime?: string

Defined in: discordeno/guildScheduledEvent.ts:52

the time the scheduled event will start

status?​

optional status?: ScheduledEventStatus

Defined in: discordeno/guildScheduledEvent.ts:60

the status of the scheduled event