Documentation/detritus-client/Structures

VoiceCallclass

VoiceCall Structure a DM Channel's call (non-bots only)

On this page

Overview
Constructor1
Properties6
Accessors7
Methods18

VoiceCall Structure a DM Channel's call (non-bots only)

import { Structures } from 'detritus-client';

Structures.VoiceCall;

Hierarchy

StructureBaseStructureVoiceCall

10 properties7 methods14 inheritedsrc/structures/voicecall.ts:39

Constructor

new VoiceCall

src/structures/voicecall.ts:50

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

Properties

channelId

string

Default ''

client

ShardClient

readonly

Inherited from BaseStructure.client

messageId

string

Default ''

region

string

Default ''

ringing

BaseCollection<string, User | null>

readonly

unavailable

boolean

Default false

Accessors

amBeingRinged

boolean

get

channel

Channel | null

get

isClone

boolean

get

Inherited from BaseStructure.isClone

joined

boolean

get

shardId

number

get

Inherited from BaseStructure.shardId

voiceConnection

VoiceConnection | null

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

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

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

isRinging()

src/structures/voicecall.ts:85

isRinging(userId: string): boolean

join()

async src/structures/voicecall.ts:96

join(options: VoiceConnectOptions): Promise<VoiceConnectObject | null>

kill()

src/structures/voicecall.ts:89

kill(): void

merge()

src/structures/voicecall.ts:108

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from BaseStructure.mergeValue

startRinging()

async src/structures/voicecall.ts:100

startRinging(recipients?: string[]): Promise<any>

stopRinging()

async src/structures/voicecall.ts:104

stopRinging(recipients?: string[]): Promise<any>

toJSON()

src/structures/voicecall.ts:164

toJSON(): any

Overrides BaseStructure.toJSON