discord.js

class GuildSoundboardSoundManager

export class GuildSoundboardSoundManager extends CachedManager<Snowflake, SoundboardSound, SoundboardSoundResolvable>

Manages API methods for Soundboard Sounds and stores their cache.

readonly
cache : Collection<Key, Holds>

The cache of items for this manager.

Inherited from: DataManager

readonly
client : Client

The client that instantiated this Manager

Inherited from: BaseManager

guild : Guild

The guild this manager belongs to

readonly
holds : Constructable<Holds>

The data structure belonging to this manager.

Inherited from: DataManager

create(
options: GuildSoundboardSoundCreateOptions
) : Promise<GuildSoundboardSound>

Creates a new guild soundboard sound.

Examples:
// Create a new soundboard sound from a file on your computer
guild.soundboardSounds.create({ file: './sound.mp3', name: 'sound' })
  .then(sound => console.log(`Created new soundboard sound with name ${sound.name}!`))
  .catch(console.error);

Returns: The created soundboard sound

delete(
soundboardSound: SoundboardSoundResolvable
) : Promise<void>

Deletes a soundboard sound.

edit(
soundboardSound: SoundboardSoundResolvable
options: GuildSoundboardSoundEditOptions = {}
) : Promise<GuildSoundboardSound>

Edits a soundboard sound.

fetch(
id: Snowflake
options?: BaseFetchOptions
) : Promise<GuildSoundboardSound>

Obtains one or more soundboard sounds from Discord, or the soundboard sound cache if they're already available.

Examples:
// Fetch all soundboard sounds from the guild
guild.soundboardSounds.fetch()
  .then(sounds => console.log(`There are ${sounds.size} soundboard sounds.`))
  .catch(console.error);
// Fetch a single soundboard sound
guild.soundboardSounds.fetch('222078108977594368')
  .then(sound => console.log(`The soundboard sound name is: ${sound.name}`))
  .catch(console.error);

resolve(
soundboardSound: SoundboardSoundResolvable
) : SoundboardSound | null

Resolves a SoundboardSoundResolvable to a SoundboardSound object.

resolveId(
soundboardSound: SoundboardSoundResolvable
) : Snowflake | null

Resolves a SoundboardSoundResolvable to a SoundboardSound id.

valueOf() : Collection<Key, Holds>

Inherited from: DataManager