kord-core/dev.kord.core.entity/VoiceState

VoiceState

class VoiceState(val data: VoiceStateData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordObject, Strategizable(source)

Constructors

Link copied to clipboard
constructor(data: VoiceStateData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

Link copied to clipboard
val channelId: Snowflake?

The channel id this user is connected to.

Link copied to clipboard
Link copied to clipboard
val guildId: Snowflake

The guild id this voice state is for.

Link copied to clipboard
val isDeafened: Boolean

Whether this user is deafened by the server.

Link copied to clipboard
val isMuted: Boolean

Whether this user is muted by the server.

Link copied to clipboard
val isSelfDeafened: Boolean

Whether this user is locally deafened.

Link copied to clipboard
val isSelfMuted: Boolean

Whether this user is locally muted.

Link copied to clipboard
val isSelfStreaming: Boolean

Whether this user is streaming using "Go Live".

Link copied to clipboard
val isSelfVideo: Boolean

Whether this user's camera is enabled.

Link copied to clipboard
val isSuppressed: Boolean

Whether this user is muted by the current user.

Link copied to clipboard
open override val kord: Kord

The kord instance that created this object.

Link copied to clipboard
val requestToSpeakTimestamp: Instant?

The Instant at which the user requested to speak.

Link copied to clipboard
val sessionId: String

The session id for this voice state.

Link copied to clipboard
open override val supplier: EntitySupplier

The supplier used to request entities.

Link copied to clipboard
val userId: Snowflake

The user id this voice state is for.

Functions

Link copied to clipboard
suspend fun getChannelOrNull(): BaseVoiceChannelBehavior?

Requests to get the voice channel, returns null if the VoiceChannel isn't present.

Link copied to clipboard
suspend fun getGuild(): Guild

Requests to get the guild of this voice state.

Link copied to clipboard
suspend fun getGuildOrNull(): Guild?

Requests to get the guild of this voice state, returns null if the Guild isn't present.

Link copied to clipboard
suspend fun getMember(): Member

Requests to get the member that belongs to this voice state.

Link copied to clipboard
suspend fun getMemberOrNull(): Member?

Requests to get the member that belongs to this voice state, returns null if the Member isn't present.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun withStrategy(strategy: EntitySupplyStrategy<*>): VoiceState

Returns a new VoiceState with the given strategy.