Documentation/detritus-client/Structures

VoiceStateclass

Voice State Structure

On this page

Overview
Constructor1
Properties15
Accessors10
Methods20

Voice State Structure

import { Structures } from 'detritus-client';

Structures.VoiceState;

Hierarchy

StructureBaseStructureVoiceState

21 properties8 methods15 inheritedsrc/structures/voicestate.ts:53

Constructor

new VoiceState

src/structures/voicestate.ts:74

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

Properties

_isSpeaking

boolean

channelId?

string | null

optional

client

ShardClient

readonly

Inherited from BaseStructure.client

deaf

boolean

Default false

guildId?

string | null

optional

member

Member | null

Default null

mute

boolean

Default false

requestToSpeakTimestampUnix

number

Default 0

selfDeaf

boolean

Default false

selfMute

boolean

Default false

selfStream

boolean

Default false

selfVideo

boolean

Default false

sessionId

string

Default ''

suppress

boolean

Default false

userId

string

Default ''

Accessors

channel

ChannelGuildVoice | ChannelGuildStageVoice | null

get

guild

Guild | null

get

isAudience

boolean

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isSpeaker

boolean

get

isSpeaking

boolean

get

requestToSpeakTimestamp

Date | null

get

serverId

string

get

shardId

number

get

Inherited from BaseStructure.shardId

streamKey

string

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

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/voicestate.ts:138

edit(options: EditGuildMember): Promise<Member>

editState()

async src/structures/voicestate.ts:145

editState(options: EditGuildVoiceState): Promise<any>

fetchStreamPreview()

async src/structures/voicestate.ts:128

fetchStreamPreview(): Promise<any>

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

joinVoice()

async src/structures/voicestate.ts:153

joinVoice(options?: VoiceConnectOptions): Promise<VoiceConnectObject | null>

merge()

src/structures/voicestate.ts:169

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from BaseStructure.mergeValue

move()

async src/structures/voicestate.ts:157

move(channelId: string): Promise<Member>

setDeaf()

async src/structures/voicestate.ts:161

setDeaf(deaf: boolean): Promise<Member>

setMute()

async src/structures/voicestate.ts:165

setMute(mute: boolean): Promise<Member>

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON