ScheduledEvent

class ScheduledEvent

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

Properties

Property	Type	Description
channelId	string | null	Channel ID for voice/stage events, or null for external events.
createdAt	Date | null	When this scheduled event was created, decoded from the event snowflake.
creatorId	string | null	ID of the user who created the event, or null.
description	string | null	Event description, or null if not set.
entityType	ScheduledEventEntityType	Type of entity the event is associated with.
guildId	string	Guild ID this event belongs to.
id	string	Scheduled event ID.
name	string	Event name.
privacyLevel	2	Privacy level of the event.
recurrenceRule	ScheduledEventRecurrenceRule | null	How the event repeats, or null for a one-off event.
scheduledEndTime	Date | null	When the event is scheduled to end, or null.
scheduledStartTime	Date	When the event is scheduled to start.
status	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.

async ScheduledEvent.fetchUsers(options: FetchScheduledEventUsersOptions) → Promise<ScheduledEventUser[]>

List users who marked themselves as interested, up to 100 per call, sorted by user ID. Page with after set to the last user’s ID.

const users = await event.fetchUsers({ limit: 100, withMember: true });