Skip to main content

ScheduledEvent

Documentation

Documentation / @discordeno/bot / ScheduledEvent

Interface: ScheduledEvent

Defined in: transformers/types.ts:1644

Properties​

channelId?​

optional channelId?: bigint

Defined in: transformers/types.ts:1650

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

creator?​

optional creator?: User

Defined in: transformers/types.ts:1672

the user that created the scheduled event

creatorId?​

optional creatorId?: bigint

Defined in: transformers/types.ts:1652

the id of the user that created the scheduled event

description?​

optional description?: string

Defined in: transformers/types.ts:1656

the description of the scheduled event

entityId?​

optional entityId?: bigint

Defined in: transformers/types.ts:1668

any additional id of the hosting entity associated with event

entityType​

entityType: ScheduledEventEntityType

Defined in: transformers/types.ts:1666

the type of hosting entity associated with a scheduled event

guildId​

guildId: bigint

Defined in: transformers/types.ts:1648

the guild id which the scheduled event belongs to

id​

id: bigint

Defined in: transformers/types.ts:1646

the id of the scheduled event

image?​

optional image?: bigint

Defined in: transformers/types.ts:1676

the cover image hash of the scheduled event

location?​

optional location?: string

Defined in: transformers/types.ts:1670

the location for the scheduled event

name​

name: string

Defined in: transformers/types.ts:1654

the name of the scheduled event

privacyLevel​

privacyLevel: GuildOnly

Defined in: transformers/types.ts:1662

the privacy level of the scheduled event

recurrenceRule?​

optional recurrenceRule?: ScheduledEventRecurrenceRule

Defined in: transformers/types.ts:1678

the definition for how often this event should recur

scheduledEndTime?​

optional scheduledEndTime?: number

Defined in: transformers/types.ts:1660

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

scheduledStartTime​

scheduledStartTime: number

Defined in: transformers/types.ts:1658

the time the scheduled event will start

status​

status: ScheduledEventStatus

Defined in: transformers/types.ts:1664

the status of the scheduled event

userCount?​

optional userCount?: number

Defined in: transformers/types.ts:1674

the number of users subscribed to the scheduled event