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

View Source

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

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

Shared options

All functions in this module accept the following optional parameters:

  • api_key - API key to use. If not provided, the default key from config will be used
  • api_key_secret - API key secret to use. If not provided, the default secret from config will be used
  • endpoint - endpoint to use. If not provided, the default endpoint from config will be used
  • client - HTTP client to use. Must implement ExStreamClient.Http.Behavior. Defaults to ExStreamClient.Http
  • req_opts - all of these options will be forwarded to req. See Req.new/1 for available options

Summary

Types

shared_opts()

Functions

create_command(payload, opts \\ [])

Creates custom chat command

delete_command(name, opts \\ [])

Deletes custom chat command

get_command(name, opts \\ [])

Returns custom command by its name

list_commands(opts \\ [])

Returns all custom commands

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

Updates custom chat command

Types

shared_opts()

@type shared_opts() :: [
  api_key: String.t(),
  api_key_secret: String.t(),
  client: module(),
  endpoint: String.t(),
  req_opts: keyword()
]

Functions

create_command(payload, opts \\ [])

@spec create_command(ExStreamClient.Model.CreateCommandRequest.t(), shared_opts()) ::
  {:ok, ExStreamClient.Model.CreateCommandResponse.t()} | {:error, any()}

Creates custom chat command

Required Arguments:

Optional Arguments:

delete_command(name, opts \\ [])

@spec delete_command(String.t(), shared_opts()) ::
  {: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(), shared_opts()) ::
  {:ok, ExStreamClient.Model.GetCommandResponse.t()} | {:error, any()}

Returns custom command by its name

Required Arguments:

  • name

Optional Arguments:

list_commands(opts \\ [])

@spec list_commands(shared_opts()) ::
  {: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(),
  shared_opts()
) ::
  {:ok, ExStreamClient.Model.UpdateCommandResponse.t()} | {:error, any()}

Updates custom chat command

Required Arguments:

Optional Arguments: