Skip to main content

DiscordScheduledEvent

@discordeno/bot

Documentation / @discordeno/bot / DiscordScheduledEvent

Interface: DiscordScheduledEvent

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:4

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

Properties​

channel_id​

channel_id: null | string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:10

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

creator?​

optional creator: DiscordUser

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:32

the user that created the scheduled event

creator_id?​

optional creator_id: null | string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:12

the id of the user that created the scheduled event

description?​

optional description: string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:16

the description of the scheduled event

entity_id​

entity_id: null | string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:28

any additional id of the hosting entity associated with event

entity_metadata​

entity_metadata: null | DiscordScheduledEventEntityMetadata

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:30

the entity metadata for the scheduled event

entity_type​

entity_type: ScheduledEventEntityType

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:26

the type of hosting entity associated with a scheduled event

guild_id​

guild_id: string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:8

the guild id which the scheduled event belongs to

id​

id: string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:6

the id of the scheduled event

image?​

optional image: null | string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:36

the cover image hash of the scheduled event

name​

name: string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:14

the name of the scheduled event

privacy_level​

privacy_level: GuildOnly

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:22

the privacy level of the scheduled event

recurrence_rule​

recurrence_rule: null | DiscordScheduledEventRecurrenceRule

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:38

the definition for how often this event should recur

scheduled_end_time​

scheduled_end_time: null | string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:20

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

scheduled_start_time​

scheduled_start_time: string

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:18

the time the scheduled event will start

status​

status: ScheduledEventStatus

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:24

the status of the scheduled event

user_count?​

optional user_count: number

Defined in: packages/types/dist/types/discord/guildScheduledEvent.d.ts:34

the number of users subscribed to the scheduled event