Represents a guild scheduled event.

Hierarchy

  • Base
    • GuildScheduledEvent

Constructors

Properties

channelID: null | string

The id of the channel in which the event will be hosted. null if entityType is EXTERNAL

creator?: User

The creator of the event. Not present on events created before October 25th, 2021.

description?: null | string

The description of the event.

entityID: null | string

The id of the entity associated with the event.

entityMetadata: null | ScheduledEventEntityMetadata

The metadata associated with the event.

The entity type of the event

guildID: string

The id of the guild this scheduled event belongs to.

id: string
image: null | string

The cover image of this event.

name: string

The name of the event.

privacyLevel: GUILD_ONLY

The privacy level of the event.

scheduledEndTime: null | Date

The time at which the event will end. Required if entityType is EXTERNAL.

scheduledStartTime: Date

The time at which the event will start.

The status of the event.

userCount: number

The number of users subscribed to the event.

Accessors

Methods

  • Delete this scheduled event.

    Parameters

    • Optional reason: string

      The reason for deleting the scheduled event. Discord's docs do not explicitly state a reason can be provided, so it may not be used.

    Returns Promise<void>

  • The url of this event's cover image.

    Parameters

    • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

      The format of the image.

    • Optional size: number

      The size of the image.

    Returns null | string