Results

Namespace

Type

A class representing a user's voice state.

Hierarchy

  • VoiceState <-- You are here!

Index

Properties

Readonly channelId

channelId: Snowflake | null

The id of the discord.GuildVoiceChannel. If null, it indicates the user has disconnected from voice.

Readonly deaf

deaf: boolean

true if the user has been server-deafened.

They will not be sent any voice data from other users if deafened.

Readonly guildId

guildId: Snowflake

The guild id this voice state is targeting.

Readonly member

member: GuildMember

A reference to the discord.GuildMember this voice state applies to.

Readonly mute

mute: boolean

true if the user has been server-muted.

They will not transmit voice data if muted.

Readonly requestToSpeakTimestamp

requestToSpeakTimestamp: string | null

The time at which the user requested to speak (used for GUILD_STAGE_VOICE channel hand-raising).

Note: The timestamp is in ISO-8601 UTC format (YYYY-MM-DDTHH:mm:ss).

Readonly selfDeaf

selfDeaf: boolean

`true if the user has opted to deafen themselves via the client.

They will not receive or be sent any voice data from other users if deafened.

Readonly selfMute

selfMute: boolean

true if the user has opted to mute their microphone via the client.

They will not transmit voice audio if they are self-muted.

Readonly selfStream

selfStream: boolean

true if the user is currently streaming to the channel using Go Live.

Readonly selfVideo

selfVideo: boolean

true if the user's camera is enabled.

Optional Readonly sessionId

sessionId: undefined | string

The session id associated with this user's voice connection.

Readonly suppress

suppress: boolean

true if the user is muted by the current user.

Readonly userId

userId: Snowflake

The id of the discord.User this voice state applies to.

Methods

edit

  • edit(options: IVoiceStateEditOptions): Promise<void>
  • Updates a voice state with the options provided. Only valid for voice states in Guild Stage Voice channels.

    Parameters

    Returns Promise<void>

getChannel

getGuild

  • getGuild(): Promise<Guild>
  • Fetches data for the guild associated with this voice state.

    Returns Promise<Guild>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc