Class VoiceState

Hierarchy

Base
- VoiceState

Index

Constructors

Constructors

`Private` constructor

new VoiceState(guild, data): VoiceState
Parameters
- guild: Guild
- data: RawVoiceStateData
Returns VoiceState
Overrides Base.constructor
- Defined in node_modules/discord.js/typings/index.d.ts:3632

Properties

channelId

channelId: null | string

`Readonly` client

client: Client<true>

guild

guild: Guild

id

id: string

requestToSpeakTimestamp

requestToSpeakTimestamp: null | number

selfDeaf

selfDeaf: null | boolean

selfMute

selfMute: null | boolean

selfVideo

selfVideo: null | boolean

serverDeaf

serverDeaf: null | boolean

serverMute

serverMute: null | boolean

sessionId

sessionId: null | string

streaming

streaming: null | boolean

suppress

suppress: null | boolean

Accessors

channel

get channel(): null | VoiceBasedChannel
Returns null | VoiceBasedChannel
- Defined in node_modules/discord.js/typings/index.d.ts:3633

deaf

get deaf(): null | boolean
Returns null | boolean
- Defined in node_modules/discord.js/typings/index.d.ts:3635

member

get member(): null | GuildMember
Returns null | GuildMember
- Defined in node_modules/discord.js/typings/index.d.ts:3638

mute

get mute(): null | boolean
Returns null | boolean
- Defined in node_modules/discord.js/typings/index.d.ts:3639

Methods

disconnect

disconnect(reason?): Promise<GuildMember>
Parameters
- Optional reason: string
Returns Promise<GuildMember>
- Defined in node_modules/discord.js/typings/index.d.ts:3652

edit

edit(options): Promise<VoiceState>
Parameters
- options: VoiceStateEditOptions
Returns Promise<VoiceState>
- Defined in node_modules/discord.js/typings/index.d.ts:3656

fetch

fetch(force?): Promise<VoiceState>
Parameters
- Optional force: boolean
Returns Promise<VoiceState>
- Defined in node_modules/discord.js/typings/index.d.ts:3657

setChannel

setChannel(channel, reason?): Promise<GuildMember>
Parameters
- channel: null | GuildVoiceChannelResolvable
- Optional reason: string
Returns Promise<GuildMember>
- Defined in node_modules/discord.js/typings/index.d.ts:3653

setDeaf

setDeaf(deaf?, reason?): Promise<GuildMember>
Parameters
- Optional deaf: boolean
- Optional reason: string
Returns Promise<GuildMember>
- Defined in node_modules/discord.js/typings/index.d.ts:3650

setMute

setMute(mute?, reason?): Promise<GuildMember>
Parameters
- Optional mute: boolean
- Optional reason: string
Returns Promise<GuildMember>
- Defined in node_modules/discord.js/typings/index.d.ts:3651

setRequestToSpeak

setRequestToSpeak(request?): Promise<VoiceState>
Parameters
- Optional request: boolean
Returns Promise<VoiceState>
- Defined in node_modules/discord.js/typings/index.d.ts:3654

setSuppressed

setSuppressed(suppressed?): Promise<VoiceState>
Parameters
- Optional suppressed: boolean
Returns Promise<VoiceState>
- Defined in node_modules/discord.js/typings/index.d.ts:3655

toJSON

toJSON(...props): unknown
Parameters
- Rest ...props: Record<string, string | boolean>[]
Returns unknown
Inherited from Base.toJSON
- Defined in node_modules/discord.js/typings/index.d.ts:523

valueOf

valueOf(): string
Returns string
Inherited from Base.valueOf
- Defined in node_modules/discord.js/typings/index.d.ts:524

Class VoiceState

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

guild: Guild

data: RawVoiceStateData

Returns VoiceState

Properties

channelId

Readonly client

guild

id

requestToSpeakTimestamp

selfDeaf

selfMute

selfVideo

serverDeaf

serverMute

sessionId

streaming

suppress

Accessors

channel

Returns null | VoiceBasedChannel

deaf

Returns null | boolean

member

Returns null | GuildMember

mute

Returns null | boolean

Methods

disconnect

Parameters

Optional reason: string

Returns Promise<GuildMember>

edit

Parameters

options: VoiceStateEditOptions

Returns Promise<VoiceState>

fetch

Parameters

Optional force: boolean

Returns Promise<VoiceState>

setChannel

Parameters

channel: null | GuildVoiceChannelResolvable

Optional reason: string

Returns Promise<GuildMember>

setDeaf

Parameters

Optional deaf: boolean

Optional reason: string

Returns Promise<GuildMember>

setMute

Parameters

Optional mute: boolean

Optional reason: string

Returns Promise<GuildMember>

setRequestToSpeak

Parameters

Optional request: boolean

Returns Promise<VoiceState>

setSuppressed

Parameters

Optional suppressed: boolean

Returns Promise<VoiceState>

toJSON

Parameters

Rest ...props: Record<string, string | boolean>[]

Returns unknown

valueOf

Returns string

Settings

Member Visibility

`Private` constructor

`Readonly` client

`Optional` reason: string

`Optional` force: boolean

`Optional` reason: string

`Optional` deaf: boolean

`Optional` reason: string

`Optional` mute: boolean

`Optional` reason: string

`Optional` request: boolean

`Optional` suppressed: boolean

`Rest` ...props: Record<string, string | boolean>[]