Lingo.Api.Command (Lingo v0.4.2)

Copy Markdown View Source

Application commands, global and per guild. Bots usually declare commands with Lingo.Bot.Commands and register them with Lingo.register_commands/1 instead.

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

Replaces all global application commands with commands.

Replaces all of a guild's application commands with commands.

Creates or replaces one global application command.

Creates or replaces one guild application command.

Deletes a global application command.

Deletes a guild application command.

Fetches a global application command.

Fetches a guild application command.

Fetches the permission settings of one command in a guild.

Lists the global application commands.

Lists a guild's application commands.

Lists the permission settings of every command in a guild.

Edits a global application command.

Edits a guild application command.

Functions

bulk_overwrite_global(commands)

@spec bulk_overwrite_global([map()]) ::
  Lingo.Api.result([Lingo.Type.ApplicationCommand.t()])

Replaces all global application commands with commands.

bulk_overwrite_guild(guild_id, commands)

@spec bulk_overwrite_guild(Lingo.Api.id(), [map()]) ::
  Lingo.Api.result([Lingo.Type.ApplicationCommand.t()])

Replaces all of a guild's application commands with commands.

create_global(params)

Creates or replaces one global application command.

create_guild(guild_id, params)

Creates or replaces one guild application command.

delete_global(command_id)

@spec delete_global(Lingo.Api.id()) :: Lingo.Api.result()

Deletes a global application command.

delete_guild(guild_id, command_id)

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

Deletes a guild application command.

get_global(command_id)

Fetches a global application command.

get_guild(guild_id, command_id)

Fetches a guild application command.

get_permissions(guild_id, command_id)

Fetches the permission settings of one command in a guild.

list_global()

Lists the global application commands.

list_guild(guild_id)

Lists a guild's application commands.

list_permissions(guild_id)

Lists the permission settings of every command in a guild.

update_global(command_id, params)

Edits a global application command.

update_guild(guild_id, command_id, params)

Edits a guild application command.