Skip to main content

ScheduledEvent

@discordeno/bot • Docs

Documentation / @discordeno/bot / ScheduledEvent

Interface: ScheduledEvent

Properties​

channelId?​

optional channelId: bigint

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

Defined in​

packages/bot/src/transformers/types.ts:1483

creator?​

optional creator: User

the user that created the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1505

creatorId?​

optional creatorId: bigint

the id of the user that created the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1485

description?​

optional description: string

the description of the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1489

entityId?​

optional entityId: bigint

any additional id of the hosting entity associated with event

Defined in​

packages/bot/src/transformers/types.ts:1501

entityType​

entityType: ScheduledEventEntityType

the type of hosting entity associated with a scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1499

guildId​

guildId: bigint

the guild id which the scheduled event belongs to

Defined in​

packages/bot/src/transformers/types.ts:1481

id​

id: bigint

the id of the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1479

image?​

optional image: bigint

the cover image hash of the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1509

location?​

optional location: string

the location for the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1503

name​

name: string

the name of the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1487

privacyLevel​

privacyLevel: GuildOnly

the privacy level of the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1495

recurrenceRule?​

optional recurrenceRule: ScheduledEventRecurrenceRule

the definition for how often this event should recur

Defined in​

packages/bot/src/transformers/types.ts:1511

scheduledEndTime?​

optional scheduledEndTime: number

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

Defined in​

packages/bot/src/transformers/types.ts:1493

scheduledStartTime​

scheduledStartTime: number

the time the scheduled event will start

Defined in​

packages/bot/src/transformers/types.ts:1491

status​

status: ScheduledEventStatus

the status of the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1497

userCount?​

optional userCount: number

the number of users subscribed to the scheduled event

Defined in​

packages/bot/src/transformers/types.ts:1507