ExStreamClient.Operations.Chat.Commands (ExStreamClient v0.1.3)

View Source

Modules for interacting with the chat/commands group of Stream APIs

API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2

Summary

Functions

Creates custom chat command

Deletes custom chat command

Returns custom command by its name

Returns all custom commands

Updates custom chat command

Functions

create_command(payload, opts \\ [])

@spec create_command(ExStreamClient.Model.CreateCommandRequest.t(), [
  {:client, module()}
]) ::
  {:ok, ExStreamClient.Model.CreateCommandResponse.t()} | {:error, any()}

Creates custom chat command

Required Arguments:

Optional Arguments:

delete_command(name, opts \\ [])

@spec delete_command(String.t(), [{:client, module()}]) ::
  {:ok, ExStreamClient.Model.DeleteCommandResponse.t()} | {:error, any()}

Deletes custom chat command

Required Arguments:

  • name

Optional Arguments:

get_command(name, opts \\ [])

@spec get_command(String.t(), [{:client, module()}]) ::
  {:ok, ExStreamClient.Model.GetCommandResponse.t()} | {:error, any()}

Returns custom command by its name

Required Arguments:

  • name

Optional Arguments:

list_commands(opts \\ [])

@spec list_commands([{:client, module()}]) ::
  {:ok, ExStreamClient.Model.ListCommandsResponse.t()} | {:error, any()}

Returns all custom commands

Optional Arguments:

update_command(name, payload, opts \\ [])

@spec update_command(String.t(), ExStreamClient.Model.UpdateCommandRequest.t(), [
  {:client, module()}
]) ::
  {:ok, ExStreamClient.Model.UpdateCommandResponse.t()} | {:error, any()}

Updates custom chat command

Required Arguments:

Optional Arguments: