Class VoiceCall

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

Hierarchy

BaseStructure
- VoiceCall

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides BaseStructure.constructor
- Defined in src/structures/voicecall.ts:47
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns VoiceCall

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Readonly _keysMerge

_keysMerge: BaseSet<string> = ...

channelId

channelId: string = ''

Readonly client

client: ShardClient

messageId

messageId: string = ''

region

region: string = ''

Readonly ringing

ringing: BaseCollection<string, null | User> = ...

unavailable

unavailable: boolean = false

Accessors

amBeingRinged

get amBeingRinged(): boolean

- Defined in src/structures/voicecall.ts:58
Returns boolean

channel

get channel(): null | Channel

- Defined in src/structures/voicecall.ts:65
Returns null | Channel

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

joined

get joined(): boolean

- Defined in src/structures/voicecall.ts:69
Returns boolean

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

voiceConnection

get voiceConnection(): null | VoiceConnection

- Defined in src/structures/voicecall.ts:73
Returns null | VoiceConnection

voiceStates

get voiceStates(): BaseCollection<string, VoiceState>

- Defined in src/structures/voicecall.ts:77
Returns BaseCollection<string, VoiceState>

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

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

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

clone

clone(): VoiceCall

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns VoiceCall

difference

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

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

hasDifference

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

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

isRinging

isRinging(userId: string): boolean

- Defined in src/structures/voicecall.ts:84
Parameters
- userId: string
Returns boolean

join

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

- Defined in src/structures/voicecall.ts:95
Parameters
- options: VoiceConnectOptions
Returns Promise<null | VoiceConnectObject>

kill

kill(): void

- Defined in src/structures/voicecall.ts:88
Returns void

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

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

Overrides BaseStructure.mergeValue
- Defined in src/structures/voicecall.ts:107
Parameters
- key: string
- value: any
Returns void

startRinging

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

- Defined in src/structures/voicecall.ts:99
Parameters
- Optional recipients: string[]
Returns Promise<any>

stopRinging

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

- Defined in src/structures/voicecall.ts:103
Parameters
- Optional recipients: string[]
Returns Promise<any>

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

Generated using TypeDoc