Skip to main content

DiscordScheduledEvent

@discordeno/bot • Docs

Documentation / @discordeno/bot / DiscordScheduledEvent

Interface: DiscordScheduledEvent

Properties​

channel_id​

channel_id: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:2254

creator?​

optional creator: DiscordUser

the user that created the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2276

creator_id?​

optional creator_id: null | string

the id of the user that created the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2256

description?​

optional description: string

the description of the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2260

entity_id​

entity_id: null | string

any additional id of the hosting entity associated with event

Defined in​

packages/types/dist/types/discord.d.ts:2272

entity_metadata​

entity_metadata: null | DiscordScheduledEventEntityMetadata

the entity metadata for the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2274

entity_type​

entity_type: ScheduledEventEntityType

the type of hosting entity associated with a scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2270

guild_id​

guild_id: string

the guild id which the scheduled event belongs to

Defined in​

packages/types/dist/types/discord.d.ts:2252

id​

id: string

the id of the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2250

image?​

optional image: null | string

the cover image hash of the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2280

name​

name: string

the name of the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2258

privacy_level​

privacy_level: GuildOnly

the privacy level of the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2266

recurrence_rule​

recurrence_rule: null | DiscordScheduledEventRecurrenceRule

the definition for how often this event should recur

Defined in​

packages/types/dist/types/discord.d.ts:2282

scheduled_end_time​

scheduled_end_time: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:2264

scheduled_start_time​

scheduled_start_time: string

the time the scheduled event will start

Defined in​

packages/types/dist/types/discord.d.ts:2262

status​

status: ScheduledEventStatus

the status of the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2268

user_count?​

optional user_count: number

the number of users subscribed to the scheduled event

Defined in​

packages/types/dist/types/discord.d.ts:2278