Class StageInstance

Represents a stage instance.

Hierarchy (view full)

Base
- StageInstance

Index

Constructors

Properties

channelID client discoverableDisabled guildID id privacyLevel scheduledEventID topic

Accessors

channel createdAt guild scheduledEvent

Methods

toJSON toString generateID getCreatedAt getDiscordEpoch

Constructors

constructor

new StageInstance(data, client): StageInstance
Parameters
- data: RawStageInstance
- client: Client<ClientEvents>
Returns StageInstance
Overrides Base.constructor
- Defined in lib/structures/StageInstance.ts:29

Properties

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
- Defined in lib/structures/StageInstance.ts:59

createdAt

get createdAt(): Date
Returns Date
Inherited from Base.createdAt
- Defined in lib/structures/Base.ts:39

guild

get guild(): Guild
The guild of the associated stage channel. This will throw an error if the guild is not cached.

Returns Guild
- Defined in lib/structures/StageInstance.ts:64

scheduledEvent

get scheduledEvent(): undefined | null | GuildScheduledEvent
The scheduled event for this stage instance, if applicable.

Returns undefined | null | GuildScheduledEvent
- Defined in lib/structures/StageInstance.ts:82

Methods

toJSON

toJSON(): JSONStageInstance
Returns JSONStageInstance
Overrides Base.toJSON
- Defined in lib/structures/StageInstance.ts:94

toString

toString(): string
Returns string
Inherited from Base.toString
- Defined in lib/structures/Base.ts:64

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Base.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Base.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Base.getDiscordEpoch
- Defined in lib/structures/Base.ts:32