Documentation/detritus-client/Collections

VoiceStatesclass

VoiceState Collection

On this page

Overview
Constructor1
Properties4
Accessors2
Methods14

VoiceState Collection

import { Collections } from 'detritus-client';

Collections.VoiceStates;

Hierarchy

BaseCollectionMixin<K, V>BaseCollectionCache<K, V>BaseClientCollectionCache<string, VoiceState>VoiceStates

2 methods18 inheritedsrc/collections/voicestates.ts:20

Constructor

new VoiceStates

src/collections/basecollection.ts:219

new VoiceStates(client: ShardClient, options?: boolean | BaseClientCollectionOptions)

Properties

caches

BaseCollection<string, BaseCollection<string, VoiceState>>

readonly

Inherited from BaseClientCollectionCache.caches

client

ShardClient

Inherited from BaseClientCollectionCache.client

enabled

boolean

Inherited from BaseClientCollectionCache.enabled

options

BaseCollectionOptions

readonly

Default {}

Inherited from BaseClientCollectionCache.options

Accessors

[toStringTag]

string

get

Overrides BaseClientCollectionCache.[toStringTag]

size

number

get

Inherited from BaseClientCollectionCache.size

Methods

[iterator]()

src/collections/basecollection.ts:161

[iterator](): IterableIterator<[string, VoiceState]>

Inherited from BaseClientCollectionCache.[iterator]

clear()

src/collections/basecollection.ts:37

clear(): void

Inherited from BaseClientCollectionCache.clear

delete()

src/collections/voicestates.ts:28

delete(serverId: string): boolean

delete(serverId: string | null | undefined, userId: string): boolean

Overrides BaseClientCollectionCache.delete

forEach()

src/collections/basecollection.ts:68

forEach(
  func: (v: VoiceState, k: string, map: Map<string, VoiceState>) => void,
  thisArg?: any,
): void

Inherited from BaseClientCollectionCache.forEach

get()

src/collections/basecollection.ts:76

get(cacheKey: string): BaseCollection<string, VoiceState> | undefined

get(cacheKey: string | null | undefined, key: string): VoiceState | undefined

Inherited from BaseClientCollectionCache.get

getOrInsert()

src/collections/basecollection.ts:98

getOrInsert(cacheKey: string, key: string, defaultValue: VoiceState): VoiceState

Inherited from BaseClientCollectionCache.getOrInsert

getOrInsertComputed()

src/collections/basecollection.ts:103

getOrInsertComputed(
  cacheKey: string,
  key: string,
  func: (key: string) => VoiceState,
): VoiceState

Inherited from BaseClientCollectionCache.getOrInsertComputed

has()

src/collections/basecollection.ts:108

has(cacheKey: string): boolean

has(cacheKey: string | null | undefined, key: string): boolean

Inherited from BaseClientCollectionCache.has

insert()

src/collections/voicestates.ts:21

insert(voiceState: VoiceState): void

insertCache()

src/collections/basecollection.ts:130

insertCache(cacheKey: string): BaseCollection<string, VoiceState>

Inherited from BaseClientCollectionCache.insertCache

keys()

src/collections/basecollection.ts:145

keys(): IterableIterator<string>

Inherited from BaseClientCollectionCache.keys

set()

src/collections/basecollection.ts:139

set(cacheKey: string, key: string, value: VoiceState): this

Inherited from BaseClientCollectionCache.set

setEnabled()

src/collections/basecollection.ts:237

setEnabled(value: boolean): void

Inherited from BaseClientCollectionCache.setEnabled

values()

src/collections/basecollection.ts:153

values(): IterableIterator<VoiceState>

Inherited from BaseClientCollectionCache.values