ExStreamClient.Operations.Chat.Commands (ExStreamClient v0.1.3)
View SourceModules 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
@spec create_command(ExStreamClient.Model.CreateCommandRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.CreateCommandResponse.t()} | {:error, any()}
Creates custom chat command
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec delete_command(String.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.DeleteCommandResponse.t()} | {:error, any()}
Deletes custom chat command
Required Arguments:
name
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@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:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec list_commands([{:client, module()}]) :: {:ok, ExStreamClient.Model.ListCommandsResponse.t()} | {:error, any()}
Returns all custom commands
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec update_command(String.t(), ExStreamClient.Model.UpdateCommandRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.UpdateCommandResponse.t()} | {:error, any()}
Updates custom chat command
Required Arguments:
name
payload
:Elixir.ExStreamClient.Model.UpdateCommandRequest
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)