Class StageInstance

Represents a stage instance.

Hierarchy

Constructors

constructor

Properties

_cachedChannel? _cachedGuild? _cachedScheduledEvent? channelID client discoverableDisabled guildID id privacyLevel scheduledEventID topic

Accessors

channel createdAt guild scheduledEvent

Methods

toJSON toString update generateID getCreatedAt getDiscordEpoch

Constructors

constructor

Properties

Private Optional _cachedChannel

_cachedChannel?: any

Private Optional _cachedGuild

_cachedGuild?: any

Private Optional _cachedScheduledEvent

_cachedScheduledEvent?: any

channelID

channelID: string

The ID of the associated stage channel.

client

client: Client<ClientEvents>

discoverableDisabled

discoverableDisabled: boolean

Deprecated

If the stage channel is discoverable

guildID

guildID: string

The id of the guild associated with this stage instance's stage channel.

id

id: string

privacyLevel

privacyLevel: StageInstancePrivacyLevels

The privacy level of this stage instance.

scheduledEventID

scheduledEventID: null | string

The id of the scheduled event for this stage instance, if applicable.

topic

topic: string

The topic of this stage instance.

Accessors

channel

  • get channel(): undefined | StageChannel

  • The associated stage channel.

    Returns undefined | StageChannel

createdAt

  • get createdAt(): Date

  • Returns Date

guild

  • get guild(): Guild

  • The guild of the associated stage channel. This will throw an error if the guild is not cached.

    Returns Guild

scheduledEvent

  • get scheduledEvent(): undefined | null | GuildScheduledEvent

  • The scheduled event for this stage instance, if applicable.

    Returns undefined | null | GuildScheduledEvent

Methods

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