Preview environment

class SoundboardSound

extends

Base
export class SoundboardSound extends Base

Represents a soundboard sound.

available : boolean

Whether this soundboard sound is available

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
createdAt : Date

The time this soundboard sound was created at

readonly
createdTimestamp : number

The timestamp this soundboard sound was created at

readonly
emoji : Emoji | null

The emoji of this soundboard sound

readonly
guild : Guild | null

The guild this soundboard sound is part of

guildId : Snowflake | null

The guild id of this soundboard sound

name : string

The name of this soundboard sound

soundId : Snowflake | string

The id of this soundboard sound

readonly
url : string

A link to this soundboard sound

user : User | null

The user who created this soundboard sound

volume : number

The volume (a double) of this soundboard sound, from 0 to 1

delete(
reason?: string
) : Promise<GuildSoundboardSound>

Deletes this soundboard sound.

Examples:
// Delete a soundboard sound
soundboardSound.delete()
  .then(sound => console.log(`Deleted soundboard sound ${sound.name}`))
  .catch(console.error);

edit(
options?: GuildSoundboardSoundEditOptions
) : Promise<GuildSoundboardSound>

Edits this soundboard sound.

Examples:
// Update the name of a soundboard sound
soundboardSound.edit({ name: 'new name' })
  .then(sound => console.log(`Updated the name of the soundboard sound to ${sound.name}`))
  .catch(console.error);

equals(
other: SoundboardSound | APISoundboardSound
) : boolean

Whether this soundboard sound is the same as another one.

toJSON(
...props: Record<string, boolean | string>[]
) : unknown

Inherited from: Base

valueOf() : string

Inherited from: Base