Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VoiceState

Voice State Structure

Hierarchy

Index

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysVoiceState

_keysMerge

_keysMerge: BaseSet<string> = keysMergeVoiceState

_keysSkipDifference

_keysSkipDifference: BaseSet<string> = keysSkipDifferenceVoiceState

Optional channelId

channelId: null | string

client

client: ShardClient

deaf

deaf: boolean = false

Optional guildId

guildId: null | string

member

member: Member

selfDeaf

selfDeaf: boolean = false

selfMute

selfMute: boolean = false

selfStream

selfStream: boolean = false

selfVideo

selfVideo: boolean = false

sessionId

sessionId: string = ""

suppress

suppress: boolean = false

userId

userId: string = ""

Accessors

channel

  • Returns Channel | null

guild

  • get guild(): Guild | null
  • Returns Guild | null

serverId

  • get serverId(): string
  • Returns string

shardId

  • get shardId(): number
  • Returns number

streamKey

  • get streamKey(): string
  • Returns string

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any
  • Parameters

    • key: string

    Returns any

_setFromSnake

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

    • key: string
    • value: any

    Returns any

difference

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

    • key: string
    • value: any

    Returns [boolean, any]

differences

edit

  • edit(options: EditGuildMember): Promise<any>
  • Parameters

    • options: EditGuildMember

    Returns Promise<any>

fetchStreamPreview

  • fetchStreamPreview(): Promise<any>
  • Returns Promise<any>

joinVoice

  • Parameters

    Returns Promise<null | object>

merge

mergeValue

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

    • key: string
    • value: any

    Returns void

move

  • move(channelId: string): Promise<any>
  • Parameters

    • channelId: string

    Returns Promise<any>

setDeaf

  • setDeaf(deaf: boolean): Promise<any>
  • Parameters

    • deaf: boolean

    Returns Promise<any>

setMute

  • setMute(mute: boolean): Promise<any>
  • Parameters

    • mute: boolean

    Returns Promise<any>

toJSON

  • toJSON(): object
  • Returns object

Generated using TypeDoc