kord-common/dev.kord.common.entity/DiscordSoundboardSound

DiscordSoundboardSound

@Serializable
data class DiscordSoundboardSound(val name: String, val soundId: Snowflake, val volume: Double, val emojiId: Snowflake?, val emojiName: String?, val guildId: OptionalSnowflake = OptionalSnowflake.Missing, val available: Boolean, val user: Optional<DiscordUser> = Optional.Missing())(source)

Representation of a Soundboard Sound.

Constructors

Link copied to clipboard
constructor(name: String, soundId: Snowflake, volume: Double, emojiId: Snowflake?, emojiName: String?, guildId: OptionalSnowflake = OptionalSnowflake.Missing, available: Boolean, user: Optional<DiscordUser> = Optional.Missing())

Properties

Link copied to clipboard
val available: Boolean

whether this sound can be used, may be false due to loss of Server Boosts

Link copied to clipboard
@SerialName(value = "emoji_id")
val emojiId: Snowflake?

the id of this sound's custom emoji (if set)

Link copied to clipboard
@SerialName(value = "emoji_name")
val emojiName: String?

the unicode character of this sound's standard emoji (if set)

Link copied to clipboard
@SerialName(value = "guild_id")
val guildId: OptionalSnowflake

the id of the guild this sound is in, or OptionalSnowflake.Missing for default sounds

Link copied to clipboard
val name: String

the name of this sound

Link copied to clipboard
@SerialName(value = "sound_id")
val soundId: Snowflake

the id of this sound

Link copied to clipboard
val user: Optional<DiscordUser>

the user who created this sound, or OptionalSnowflake.Missing for default sounds

Link copied to clipboard
val volume: Double

the volume of this sound, from 0.0 to 1.0