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

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

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 \\ [])

Creates custom chat command

Required Arguments:

All options from Shared Options are supported.

delete_command(name, opts \\ [])

Deletes custom chat command

Required Arguments:

  • name

All options from Shared Options are supported.

get_command(name, opts \\ [])

Returns custom command by its name

Required Arguments:

  • name

All options from Shared Options are supported.

list_commands(opts \\ [])

Returns all custom commands

All options from Shared Options are supported.

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

Updates custom chat command

Required Arguments:

All options from Shared Options are supported.