Packages

c

ackcord.data

VoiceState

case class VoiceState(guildId: Option[GuildId], channelId: Option[VoiceGuildChannelId], userId: UserId, member: Option[RawGuildMember], sessionId: String, deaf: Boolean, mute: Boolean, selfDeaf: Boolean, selfMute: Boolean, selfStream: Option[Boolean], selfVideo: Boolean, suppress: Boolean, requestToSpeakTimestamp: Option[OffsetDateTime]) extends GetGuildOpt with GetVoiceChannelOpt with GetUser with Product with Serializable

Represents a user voice connection status

guildId

The guild this state belongs to

channelId

The channel the user is in, or None if the user isn't in a channel.

userId

The user of this state.

member

The guild member of this voice state. Can be missing.

sessionId

The sessionId

deaf

If the user is deafened by the guild

mute

If the user is muted by the guild

selfDeaf

If the user is deafened locally

selfMute

If the user is muted locally

selfStream

If the user is streaming

selfVideo

If the user's camera is on

suppress

If the client has muted the user

Source
voice.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VoiceState
  2. Serializable
  3. Product
  4. Equals
  5. GetUser
  6. GetVoiceChannelOpt
  7. GetGuildOpt
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new VoiceState(guildId: Option[GuildId], channelId: Option[VoiceGuildChannelId], userId: UserId, member: Option[RawGuildMember], sessionId: String, deaf: Boolean, mute: Boolean, selfDeaf: Boolean, selfMute: Boolean, selfStream: Option[Boolean], selfVideo: Boolean, suppress: Boolean, requestToSpeakTimestamp: Option[OffsetDateTime])

    guildId

    The guild this state belongs to

    channelId

    The channel the user is in, or None if the user isn't in a channel.

    userId

    The user of this state.

    member

    The guild member of this voice state. Can be missing.

    sessionId

    The sessionId

    deaf

    If the user is deafened by the guild

    mute

    If the user is muted by the guild

    selfDeaf

    If the user is deafened locally

    selfMute

    If the user is muted locally

    selfStream

    If the user is streaming

    selfVideo

    If the user's camera is on

    suppress

    If the client has muted the user

Value Members

  1. val channelId: Option[VoiceGuildChannelId]
    Definition Classes
    VoiceStateGetVoiceChannelOpt
  2. val deaf: Boolean
  3. def guild(implicit snapshot: CacheSnapshot): Option[GatewayGuild]

    The guild for this object

    The guild for this object

    Definition Classes
    GetGuildOpt
  4. val guildId: Option[GuildId]
    Definition Classes
    VoiceStateGetGuildOpt
  5. val member: Option[RawGuildMember]
  6. val mute: Boolean
  7. def productElementNames: Iterator[String]
    Definition Classes
    Product
  8. val requestToSpeakTimestamp: Option[OffsetDateTime]
  9. val selfDeaf: Boolean
  10. val selfMute: Boolean
  11. val selfStream: Option[Boolean]
  12. val selfVideo: Boolean
  13. val sessionId: String
  14. val suppress: Boolean
  15. def user(implicit snapshot: CacheSnapshot): Option[User]

    The user for this object

    The user for this object

    Definition Classes
    GetUser
  16. val userId: UserId
    Definition Classes
    VoiceStateGetUser
  17. def voiceChannel(implicit snapshot: CacheSnapshot): Option[VoiceGuildChannel]

    Resolve the channelId of this object as a voice channel.

    Resolve the channelId of this object as a voice channel.

    Definition Classes
    GetVoiceChannelOpt