Class VoiceState<T>

Represents a guild member's voice state.

Type Parameters

Hierarchy

Constructors

constructor

Properties

_cachedChannel? _cachedGuild? _cachedMember? _cachedUser? channelID client deaf guildID id mute requestToSpeakTimestamp selfDeaf selfMute selfStream selfVideo sessionID suppress userID

Accessors

channel createdAt guild member user

Methods

toJSON toString update generateID getCreatedAt getDiscordEpoch

Constructors

constructor

Properties

Private Optional _cachedChannel

_cachedChannel?: any

Private Optional _cachedGuild

_cachedGuild?: any

Private Optional _cachedMember

_cachedMember?: any

Private Optional _cachedUser

_cachedUser?: any

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

createdAt

  • get createdAt(): Date

  • Returns Date

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

member

  • get member(): undefined | Member

  • The member associated with this voice state.

    Returns undefined | Member

user

  • get user(): undefined | User

  • TThe user associated with this voice state.

    Returns undefined | User

Methods

toJSON

toString

  • Returns string

Protected update

  • Parameters

    Returns void

Static generateID

  • Parameters

    • Optional timestamp: number | Date

    Returns string

Static getCreatedAt

  • Parameters

    • id: string

    Returns Date

Static getDiscordEpoch

  • Parameters

    • id: string

    Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc