Class GuildScheduledEvent

Represents a guild scheduled event.

Hierarchy

  • Base
    • GuildScheduledEvent

Constructors

constructor

Properties

_cachedChannel? _cachedGuild? channelID client creator? description? entityID entityMetadata entityType guildID id image name privacyLevel scheduledEndTime scheduledStartTime status userCount

Accessors

channel createdAt guild

Methods

deleteScheduledEvent imageURL toJSON toString update generateID getCreatedAt getDiscordEpoch

Constructors

constructor

Properties

Private Optional _cachedChannel

_cachedChannel?: any

Private Optional _cachedGuild

_cachedGuild?: any

channelID

channelID: null | string

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

client

client: Client<ClientEvents>

Optional creator

creator?: User

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

Optional description

description?: null | string

The description of the event.

entityID

entityID: null | string

The id of the entity associated with the event.

entityMetadata

entityMetadata: null | ScheduledEventEntityMetadata

The metadata associated with the event.

entityType

entityType: GuildScheduledEventEntityTypes

The entity type of the event

guildID

guildID: string

The id of the guild this scheduled event belongs to.

id

id: string

image

image: null | string

The cover image of this event.

name

name: string

The name of the event.

privacyLevel

privacyLevel: GUILD_ONLY

The privacy level of the event.

scheduledEndTime

scheduledEndTime: null | Date

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

scheduledStartTime

scheduledStartTime: Date

The time at which the event will start.

status

status: GuildScheduledEventStatuses

The status of the event.

userCount

userCount: number

The number of users subscribed to the event.

Accessors

channel

  • get channel(): undefined | null | StageChannel

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

    Returns undefined | null | StageChannel

createdAt

  • get createdAt(): Date

  • Returns Date

guild

  • get guild(): Guild

  • The guild this scheduled event belongs to. This will throw an error if the guild is not cached.

    Returns Guild

Methods

deleteScheduledEvent

  • 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>

imageURL

  • 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

toJSON

toString

  • Returns string

Protected update

  • Parameters

    Returns void

Static generateID

  • Parameters

    • Optional timestamp: number | Date

    Returns string

Static getCreatedAt

  • Parameters

    • id: string

    Returns Date

Static getDiscordEpoch

  • Parameters

    • id: string

    Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc