Skip to main content

ScheduledEvent

Documentation

Documentation / @discordeno/bot / ScheduledEvent

Interface: ScheduledEvent

Defined in: bot/src/transformers/types.ts:1578

Properties​

channelId?​

optional channelId: bigint

Defined in: bot/src/transformers/types.ts:1584

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

creator?​

optional creator: User

Defined in: bot/src/transformers/types.ts:1606

the user that created the scheduled event

creatorId?​

optional creatorId: bigint

Defined in: bot/src/transformers/types.ts:1586

the id of the user that created the scheduled event

description?​

optional description: string

Defined in: bot/src/transformers/types.ts:1590

the description of the scheduled event

entityId?​

optional entityId: bigint

Defined in: bot/src/transformers/types.ts:1602

any additional id of the hosting entity associated with event

entityType​

entityType: ScheduledEventEntityType

Defined in: bot/src/transformers/types.ts:1600

the type of hosting entity associated with a scheduled event

guildId​

guildId: bigint

Defined in: bot/src/transformers/types.ts:1582

the guild id which the scheduled event belongs to

id​

id: bigint

Defined in: bot/src/transformers/types.ts:1580

the id of the scheduled event

image?​

optional image: bigint

Defined in: bot/src/transformers/types.ts:1610

the cover image hash of the scheduled event

location?​

optional location: string

Defined in: bot/src/transformers/types.ts:1604

the location for the scheduled event

name​

name: string

Defined in: bot/src/transformers/types.ts:1588

the name of the scheduled event

privacyLevel​

privacyLevel: GuildOnly

Defined in: bot/src/transformers/types.ts:1596

the privacy level of the scheduled event

recurrenceRule?​

optional recurrenceRule: ScheduledEventRecurrenceRule

Defined in: bot/src/transformers/types.ts:1612

the definition for how often this event should recur

scheduledEndTime?​

optional scheduledEndTime: number

Defined in: bot/src/transformers/types.ts:1594

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

scheduledStartTime​

scheduledStartTime: number

Defined in: bot/src/transformers/types.ts:1592

the time the scheduled event will start

status​

status: ScheduledEventStatus

Defined in: bot/src/transformers/types.ts:1598

the status of the scheduled event

userCount?​

optional userCount: number

Defined in: bot/src/transformers/types.ts:1608

the number of users subscribed to the scheduled event