ScheduledEvent

class ScheduledEvent()

A scheduled guild event for a voice channel, stage channel, or external location.

exported from lib.weeble.d

Properties

ScheduledEvent.channelId

type: readonly string | null

Channel ID for voice/stage events, or null for external events.

ScheduledEvent.createdAt

type: readonly Date | null

When this scheduled event was created, decoded from the event snowflake.

ScheduledEvent.creatorId

type: readonly string | null

ID of the user who created the event, or null.

ScheduledEvent.description

type: readonly string | null

Event description, or null if not set.

ScheduledEvent.entityType

type: readonly ScheduledEventEntityType

Type of entity the event is associated with.

ScheduledEvent.guildId

type: readonly string

Guild ID this event belongs to.

ScheduledEvent.id

type: readonly string

Scheduled event ID.

ScheduledEvent.name

type: readonly string

Event name.

ScheduledEvent.privacyLevel

type: readonly 2

Privacy level of the event.

ScheduledEvent.scheduledEndTime

type: readonly Date | null

When the event is scheduled to end, or null.

ScheduledEvent.scheduledStartTime

type: readonly Date

When the event is scheduled to start.

ScheduledEvent.status

type: readonly ScheduledEventStatus

Current status of the event.

Methods

async ScheduledEvent.delete(reason: string) → Promise<void>

Delete this event.

Parameters:

• reason — – Reason for deletion, shown in audit log.

async ScheduledEvent.edit(options: ScheduledEventEditOptions) → Promise<ScheduledEvent>

Edit event properties.

Parameters:

• options — – Event properties to update.

Returns:

The updated event.