Skip to main content

ScheduledEvent

Documentation

Documentation / @discordeno/bot / ScheduledEvent

Interface: ScheduledEvent

Defined in: transformers/types.ts:1740

Properties​

channelId?​

optional channelId?: bigint

Defined in: transformers/types.ts:1746

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

creator?​

optional creator?: User

Defined in: transformers/types.ts:1768

the user that created the scheduled event

creatorId?​

optional creatorId?: bigint

Defined in: transformers/types.ts:1748

the id of the user that created the scheduled event

description?​

optional description?: string

Defined in: transformers/types.ts:1752

the description of the scheduled event

entityId?​

optional entityId?: bigint

Defined in: transformers/types.ts:1764

any additional id of the hosting entity associated with event

entityType​

entityType: ScheduledEventEntityType

Defined in: transformers/types.ts:1762

the type of hosting entity associated with a scheduled event

guildId​

guildId: bigint

Defined in: transformers/types.ts:1744

the guild id which the scheduled event belongs to

id​

id: bigint

Defined in: transformers/types.ts:1742

the id of the scheduled event

image?​

optional image?: bigint

Defined in: transformers/types.ts:1772

the cover image hash of the scheduled event

location?​

optional location?: string

Defined in: transformers/types.ts:1766

the location for the scheduled event

name​

name: string

Defined in: transformers/types.ts:1750

the name of the scheduled event

privacyLevel​

privacyLevel: GuildOnly

Defined in: transformers/types.ts:1758

the privacy level of the scheduled event

recurrenceRule?​

optional recurrenceRule?: ScheduledEventRecurrenceRule

Defined in: transformers/types.ts:1774

the definition for how often this event should recur

scheduledEndTime?​

optional scheduledEndTime?: number

Defined in: transformers/types.ts:1756

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

scheduledStartTime​

scheduledStartTime: number

Defined in: transformers/types.ts:1754

the time the scheduled event will start

status​

status: ScheduledEventStatus

Defined in: transformers/types.ts:1760

the status of the scheduled event

userCount?​

optional userCount?: number

Defined in: transformers/types.ts:1770

the number of users subscribed to the scheduled event