ScheduledEvent

@discordeno/bot

---

Documentation / @discordeno/bot / ScheduledEvent

Interface: ScheduledEvent

Defined in: packages/bot/src/transformers/types.ts:1541

Properties

channelId?

optional channelId: bigint

Defined in: packages/bot/src/transformers/types.ts:1547

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

---

creator?

optional creator: User

Defined in: packages/bot/src/transformers/types.ts:1569

the user that created the scheduled event

---

creatorId?

optional creatorId: bigint

Defined in: packages/bot/src/transformers/types.ts:1549

the id of the user that created the scheduled event

---

description?

optional description: string

Defined in: packages/bot/src/transformers/types.ts:1553

the description of the scheduled event

---

entityId?

optional entityId: bigint

Defined in: packages/bot/src/transformers/types.ts:1565

any additional id of the hosting entity associated with event

---

entityType

entityType: ScheduledEventEntityType

Defined in: packages/bot/src/transformers/types.ts:1563

the type of hosting entity associated with a scheduled event

---

guildId

guildId: bigint

Defined in: packages/bot/src/transformers/types.ts:1545

the guild id which the scheduled event belongs to

---

id

id: bigint

Defined in: packages/bot/src/transformers/types.ts:1543

the id of the scheduled event

---

image?

optional image: bigint

Defined in: packages/bot/src/transformers/types.ts:1573

the cover image hash of the scheduled event

---

location?

optional location: string

Defined in: packages/bot/src/transformers/types.ts:1567

the location for the scheduled event

---

name

name: string

Defined in: packages/bot/src/transformers/types.ts:1551

the name of the scheduled event

---

privacyLevel

privacyLevel: GuildOnly

Defined in: packages/bot/src/transformers/types.ts:1559

the privacy level of the scheduled event

---

recurrenceRule?

optional recurrenceRule: ScheduledEventRecurrenceRule

Defined in: packages/bot/src/transformers/types.ts:1575

the definition for how often this event should recur

---

scheduledEndTime?

optional scheduledEndTime: number

Defined in: packages/bot/src/transformers/types.ts:1557

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

---

scheduledStartTime

scheduledStartTime: number

Defined in: packages/bot/src/transformers/types.ts:1555

the time the scheduled event will start

---

status

status: ScheduledEventStatus

Defined in: packages/bot/src/transformers/types.ts:1561

the status of the scheduled event

---

userCount?

optional userCount: number

Defined in: packages/bot/src/transformers/types.ts:1571

the number of users subscribed to the scheduled event