Documentation/detritus-client/Structures

StageInstanceclass

Stage Instance Structure

On this page

Overview
Constructor1
Properties10
Accessors10
Methods16

Stage Instance Structure

import { Structures } from 'detritus-client';

Structures.StageInstance;

Hierarchy

StructureBaseStructureStageInstance

17 properties4 methods15 inheritedsrc/structures/stageinstance.ts:40

Constructor

new StageInstance

src/structures/stageinstance.ts:53

new StageInstance(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

channelId

string

Default ''

client

ShardClient

readonly

Inherited from BaseStructure.client

deleted

boolean

Default false

discoverableDisabled

boolean

Default false

guildId

string

Default ''

guildScheduledEventId

string | null

Default null

string

Default ''

inviteCode

string | null

Default null

privacyLevel

StagePrivacyLevels

Default StagePrivacyLevels.PUBLIC

topic

string

Default ''

Accessors

channel

Channel | null

get

guild

Guild | null

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isGuildOnly

boolean

get

isPublic

boolean

get

listeners

BaseCollection<string, VoiceState>

get

moderators

BaseCollection<string, VoiceState>

get

shardId

number

get

Inherited from BaseStructure.shardId

speakers

BaseCollection<string, VoiceState>

get

voiceStates

BaseCollection<string, VoiceState>

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

delete()

async src/structures/stageinstance.ts:134

delete(): Promise<any>

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

edit()

async src/structures/stageinstance.ts:126

edit(options?: EditStageInstance): Promise<any>

fetch()

async src/structures/stageinstance.ts:130

fetch(): Promise<StageInstance>

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/stageinstance.ts:138

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON