kord-core/dev.kord.core.entity/GuildSoundboardSound

GuildSoundboardSound

class GuildSoundboardSound(val data: SoundboardSoundData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : SoundboardSound, GuildSoundboardSoundBehavior(source)

A Soundboard Sound that can be used by everyone.

See also

Constructors

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

Properties

Link copied to clipboard
open val available: Boolean

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

Link copied to clipboard
open override val data: SoundboardSoundData

the cache data

Link copied to clipboard
val emojiId: Snowflake?

the id of this sound's custom emoji

Link copied to clipboard
open override val emojiName: String

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

Link copied to clipboard
open val guild: GuildBehavior

The behavior of the guild this emoji is part of.

Link copied to clipboard
open override val guildId: Snowflake

The id of the guild the sound is on.

Link copied to clipboard
open override val id: Snowflake

The unique identifier of this entity.

Link copied to clipboard
open override val kord: Kord

The kord instance that created this object.

Link copied to clipboard
open val name: String

the name of this sound

Link copied to clipboard
open val soundId: Snowflake

the id of this sound

Link copied to clipboard
open override val supplier: EntitySupplier

The supplier used to request entities.

Link copied to clipboard
val user: User

the user who created this sound

Link copied to clipboard
open val volume: Double

the volume of this sound, from 0.0 to 1.0

Functions

Link copied to clipboard
open suspend override fun asGuildSoundboardSound(): GuildSoundboardSound

Requests to get this behavior as a GuildSoundboardSoundBehavior .

Link copied to clipboard
open suspend override fun asGuildSoundboardSoundOrNull(): GuildSoundboardSound

Requests to get this behavior as a GuildSoundboardSoundBehavior or null if the sound does not exist.

Link copied to clipboard
open operator override fun compareTo(other: Entity): Int

Compares entities on id.

Link copied to clipboard
open suspend fun delete(reason: String? = null)

Deletes this sound.

Link copied to clipboard
inline suspend fun GuildSoundboardSoundBehavior.edit(builder: SoundboardSoundModifyBuilder.() -> Unit): GuildSoundboardSound

Modifies this sound.

Link copied to clipboard
open suspend fun fetchGuildSoundboardSound(): GuildSoundboardSound

Retrieves to get this behavior as a GuildSoundboardSoundBehavior .

Link copied to clipboard
open suspend fun fetchGuildSoundboardSoundOrNull(): GuildSoundboardSound?

Retrieves to get this behavior as a GuildSoundboardSoundBehavior or null if the sound does not exist.

Link copied to clipboard
abstract suspend fun send(channel: VoiceChannelBehavior)

Plays this sound in channel.

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

Returns a copy of this class with a new supplier provided by the strategy.