Class VoiceState<T>

Represents a guild member's voice state.

Type Parameters

T extends AnyVoiceChannel = AnyVoiceChannel

Hierarchy (view full)

Base
- VoiceState

Index

Constructors

constructor

new VoiceState<T>(data, client): VoiceState<T>
Type Parameters
- T extends AnyVoiceChannel = AnyVoiceChannel
Parameters
- data: RawVoiceState
- client: Client<ClientEvents>
Returns VoiceState<T>
Overrides Base.constructor
- Defined in lib/structures/VoiceState.ts:42

Properties

channelID

channelID: null | string

The ID of the channel the user is connected to.

client

client: Client<ClientEvents>

deaf

deaf: boolean

If the associated member is deafened.

guildID

guildID: string

The ID of the guild this voice state is a part of.

id

id: string

mute

mute: boolean

If the associated member is muted.

requestToSpeakTimestamp

requestToSpeakTimestamp: null | Date

The time at which the associated member requested to speak.

selfDeaf

selfDeaf: boolean

If the associated member is self deafened.

selfMute

selfMute: boolean

If the associated member is self muted.

selfStream

selfStream: boolean

If the associated member is streaming.

selfVideo

selfVideo: boolean

If the associated member is has their camera on.

sessionID

sessionID: string

The id of the associated member's voice session.

suppress

suppress: boolean

If the associated member is suppressed.

userID

userID: string

The ID of the user associated with this voice state.

Accessors

channel

get channel(): undefined | null | T
The channel the user is connected to.

Returns undefined | null | T
- Defined in lib/structures/VoiceState.ts:99

createdAt

get createdAt(): Date
Returns Date
Inherited from Base.createdAt
- Defined in lib/structures/Base.ts:39

guild

get guild(): Guild
The guild this voice state is a part of. This will throw an error if the guild is not cached.

Returns Guild
- Defined in lib/structures/VoiceState.ts:108

member

get member(): undefined | Member
The member associated with this voice state.

Returns undefined | Member
- Defined in lib/structures/VoiceState.ts:126

user

get user(): undefined | User
TThe user associated with this voice state.

Returns undefined | User
- Defined in lib/structures/VoiceState.ts:131

Methods

toJSON

toJSON(): JSONVoiceState
Returns JSONVoiceState
Overrides Base.toJSON
- Defined in lib/structures/VoiceState.ts:135

toString

toString(): string
Returns string
Inherited from Base.toString
- Defined in lib/structures/Base.ts:64

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Base.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Base.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Base.getDiscordEpoch
- Defined in lib/structures/Base.ts:32

Class VoiceState<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VoiceState<T>

Properties

channelID

client

deaf

guildID

id

mute

requestToSpeakTimestamp

selfDeaf

selfMute

selfStream

selfVideo

sessionID

suppress

userID

Accessors

channel

Returns undefined | null | T

createdAt

Returns Date

guild

Returns Guild

member

Returns undefined | Member

user

Returns undefined | User

Methods

toJSON

Returns JSONVoiceState

toString

Returns string

Static generateID

Parameters

Returns string

Static getCreatedAt

Parameters

Returns Date

Static getDiscordEpoch

Parameters

Returns number

Settings

Member Visibility

Theme

On This Page

`Static` generateID

`Static` getCreatedAt

`Static` getDiscordEpoch