oceanic.js/dist/lib/structures/Soundboard.d.ts

A NodeJS library for interfacing with Discord.

/** @module Soundboard */
import Base from "./Base";
import User from "./User";
import type Client from "../Client";
import type { EditSoundboardSoundOptions, JSONSoundboard, RawSoundboard } from "../types";
/** Represents a soundboard. */
export default class Soundboard extends Base {
    /** If the soundboard sound can be used. */
    available: boolean;
    /** The emoji id of the soundboard sound. */
    emojiID: string | null;
    /** The emoji name of the soundboard sound. */
    emojiName: string | null;
    /** The guild this soundboard sound is in. */
    guildID?: string;
    /** The name of the soundboard sound. */
    name: string;
    /** The id of the soundboard sound. */
    soundID: string;
    /** The user who created the soundboard sound. */
    user?: User;
    /** The volume of the soundboard sound. */
    volume: number;
    constructor(data: RawSoundboard, client: Client);
    /**
     * Delete this soundboard sound.
     * @param reason The reason for deleting the soundboard sound.
     */
    delete(reason?: string): Promise<void>;
    /**
     * Edit this soundboard sound.
     * @param options The options for editing the soundboard sound.
     */
    edit(options: EditSoundboardSoundOptions): Promise<Soundboard>;
    /**
     * Send this soundboard sound to a voice channel.
     * @param channelID The ID of the voice channel to send the soundboard sound to.
     * @param sourceGuildID The ID of the guild the soundboard sound is from.
     */
    sendSoundboardSound(channelID: string, sourceGuildID?: string): Promise<void>;
    toJSON(): JSONSoundboard;
}