dressed
Version:
A sleek, serverless-ready Discord bot framework.
38 lines (37 loc) • 2.09 kB
TypeScript
import type { RESTGetAPIGuildSoundboardSoundResult, RESTGetAPISoundboardDefaultSoundsResult, RESTPatchAPIGuildSoundboardSoundJSONBody, RESTPatchAPIGuildSoundboardSoundResult, RESTPostAPIGuildSoundboardSoundJSONBody, RESTPostAPIGuildSoundboardSoundResult, RESTPostAPISendSoundboardSoundResult, RESTPostAPISoundboardSendSoundJSONBody, Snowflake } from "discord-api-types/v10";
/**
* Send a soundboard sound to a voice channel the user is connected to.
* @param channel The channel to send the sound to
* @param data The data for the sound to send
*/
export declare function sendSound(channel: Snowflake, data: RESTPostAPISoundboardSendSoundJSONBody): Promise<RESTPostAPISendSoundboardSoundResult>;
/**
* Returns an array of soundboard sound objects that can be used by all users.
* @param guild Returns a list of this guild's soundboard sounds instead.
*/
export declare function listSounds(guild?: Snowflake): Promise<RESTGetAPISoundboardDefaultSoundsResult>;
/**
* Returns a soundboard sound object for the given sound id.
* @param guild The guild to get the sound from
* @param sound The sound to get
*/
export declare function getSound(guild: Snowflake, sound: Snowflake): Promise<RESTGetAPIGuildSoundboardSoundResult>;
/**
* Create a new soundboard sound for the guild.
* @param guild The guild to create the sound in
* @param data The data for the new sound
*/
export declare function createSound(guild: Snowflake, data: RESTPostAPIGuildSoundboardSoundJSONBody): Promise<RESTPostAPIGuildSoundboardSoundResult>;
/**
* Modify the given soundboard sound.
* @param guild The guild to modify the sound in
* @param sound The sound to modify
* @param data The new data for the sound
*/
export declare function modifySound(guild: Snowflake, sound: Snowflake, data: RESTPatchAPIGuildSoundboardSoundJSONBody): Promise<RESTPatchAPIGuildSoundboardSoundResult>;
/**
* Delete the given soundboard sound.
* @param guild The guild to delete the sound from
* @param sound The sound to delete
*/
export declare function deleteSound(guild: Snowflake, sound: Snowflake): Promise<void>;