Lingo.Api.Soundboard (Lingo v0.4.2)

Soundboard sounds.

Every function returns {:ok, result}, :ok when Discord sends no body, or {:error, %Lingo.Error{}}. Calls go to the current bot (see Lingo.with_bot/2).

Summary

Functions

create_guild(guild_id, params, opts \\ [])

Creates a guild soundboard sound.

delete_guild(guild_id, sound_id, opts \\ [])

Deletes a guild soundboard sound.

get_guild(guild_id, sound_id)

Fetches a guild soundboard sound.

list_defaults()

Lists Discord's default soundboard sounds.

list_guild(guild_id)

Lists a guild's soundboard sounds.

send_sound(channel_id, params)

Plays a soundboard sound in the voice channel the bot is in.

update_guild(guild_id, sound_id, params, opts \\ [])

Edits a guild soundboard sound.

Functions

create_guild(guild_id, params, opts \\ [])

@spec create_guild(Lingo.Api.id(), Lingo.Api.params(), keyword()) ::
  Lingo.Api.result(Lingo.Type.SoundboardSound.t())

Creates a guild soundboard sound.

delete_guild(guild_id, sound_id, opts \\ [])

@spec delete_guild(Lingo.Api.id(), Lingo.Api.id(), keyword()) :: Lingo.Api.result()

Deletes a guild soundboard sound.

get_guild(guild_id, sound_id)

@spec get_guild(Lingo.Api.id(), Lingo.Api.id()) ::
  Lingo.Api.result(Lingo.Type.SoundboardSound.t())

Fetches a guild soundboard sound.

list_defaults()

@spec list_defaults() :: Lingo.Api.result([Lingo.Type.SoundboardSound.t()])

Lists Discord's default soundboard sounds.

list_guild(guild_id)

@spec list_guild(Lingo.Api.id()) :: Lingo.Api.result([Lingo.Type.SoundboardSound.t()])

Lists a guild's soundboard sounds.

send_sound(channel_id, params)

@spec send_sound(Lingo.Api.id(), Lingo.Api.params()) :: Lingo.Api.result()

Plays a soundboard sound in the voice channel the bot is in.

update_guild(guild_id, sound_id, params, opts \\ [])

@spec update_guild(Lingo.Api.id(), Lingo.Api.id(), Lingo.Api.params(), keyword()) ::
  Lingo.Api.result(Lingo.Type.SoundboardSound.t())

Edits a guild soundboard sound.