Class RestVoiceState

Namespace

Discord.Rest

Assembly

Discord.Net.Rest.dll

Represents a snapshot of a user's voice state in a guild, fetched via REST.

public class RestVoiceState : RestEntity<ulong>, IEntity<ulong>, IVoiceState

Inheritance

object

RestEntity<ulong>

RestVoiceState

Implements

IEntity<ulong>

IVoiceState

Inherited Members

RestEntity<ulong>.Id

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Guild

Gets the guild this voice state is for.

public IGuild Guild { get; }

Property Value

IGuild

IsDeafened

Gets a value indicating whether this user is deafened by the guild.

public bool IsDeafened { get; }

Property Value

bool

IsMuted

Gets a value indicating whether this user is muted by the guild.

public bool IsMuted { get; }

Property Value

bool

IsSelfDeafened

Gets a value indicating whether this user has deafened themselves.

public bool IsSelfDeafened { get; }

Property Value

bool

IsSelfMuted

Gets a value indicating whether this user has muted themselves.

public bool IsSelfMuted { get; }

Property Value

bool

IsStreaming

Gets a value indicating whether this user is streaming in a voice channel.

public bool IsStreaming { get; }

Property Value

bool

IsSuppressed

Gets a value indicating whether this user is suppressed.

public bool IsSuppressed { get; }

Property Value

bool

IsVideoing

Gets a value indicating whether this user has their camera turned on.

public bool IsVideoing { get; }

Property Value

bool

RequestToSpeakTimestamp

Gets the time at which the user requested to speak, if any.

public DateTimeOffset? RequestToSpeakTimestamp { get; }

Property Value

DateTimeOffset?

VoiceChannel

Gets the voice channel this user is currently in.

public IVoiceChannel VoiceChannel { get; }

Property Value

IVoiceChannel

A generic voice channel object representing the voice channel that the user is currently in; null if none.

Remarks

This property will always be null for a REST voice state, as the voice channel is not included in the payload.

VoiceChannelId

Gets the snowflake of the voice channel the user is currently in, or null if the user is not in any voice channel.

public ulong? VoiceChannelId { get; }

Property Value

ulong?

VoiceSessionId

Gets the unique identifier for this user's voice session.

public string VoiceSessionId { get; }

Property Value

string