Skip to main content

DiscordScheduledEvent

Documentation

Documentation / @discordeno/types / DiscordScheduledEvent

Interface: DiscordScheduledEvent

Defined in: discord/guildScheduledEvent.ts:7

https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure

Properties​

channel_id​

channel_id: string | null

Defined in: discord/guildScheduledEvent.ts:13

the channel id in which the scheduled event will be hosted if specified

creator?​

optional creator?: DiscordUser

Defined in: discord/guildScheduledEvent.ts:35

the user that created the scheduled event

creator_id?​

optional creator_id?: string | null

Defined in: discord/guildScheduledEvent.ts:15

the id of the user that created the scheduled event

description?​

optional description?: string | null

Defined in: discord/guildScheduledEvent.ts:19

the description of the scheduled event

entity_id​

entity_id: string | null

Defined in: discord/guildScheduledEvent.ts:31

any additional id of the hosting entity associated with event

entity_metadata​

entity_metadata: DiscordScheduledEventEntityMetadata | null

Defined in: discord/guildScheduledEvent.ts:33

the entity metadata for the scheduled event

entity_type​

entity_type: ScheduledEventEntityType

Defined in: discord/guildScheduledEvent.ts:29

the type of hosting entity associated with a scheduled event

guild_id​

guild_id: string

Defined in: discord/guildScheduledEvent.ts:11

the guild id which the scheduled event belongs to

id​

id: string

Defined in: discord/guildScheduledEvent.ts:9

the id of the scheduled event

image?​

optional image?: string | null

Defined in: discord/guildScheduledEvent.ts:39

the cover image hash of the scheduled event

name​

name: string

Defined in: discord/guildScheduledEvent.ts:17

the name of the scheduled event

privacy_level​

privacy_level: GuildOnly

Defined in: discord/guildScheduledEvent.ts:25

the privacy level of the scheduled event

recurrence_rule​

recurrence_rule: DiscordScheduledEventRecurrenceRule | null

Defined in: discord/guildScheduledEvent.ts:41

the definition for how often this event should recur

scheduled_end_time​

scheduled_end_time: string | null

Defined in: discord/guildScheduledEvent.ts:23

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

scheduled_start_time​

scheduled_start_time: string

Defined in: discord/guildScheduledEvent.ts:21

the time the scheduled event will start

status​

status: ScheduledEventStatus

Defined in: discord/guildScheduledEvent.ts:27

the status of the scheduled event

user_count?​

optional user_count?: number

Defined in: discord/guildScheduledEvent.ts:37

the number of users subscribed to the scheduled event