ExStreamClient.Operations.Devices (ExStreamClient v0.1.6)
View SourceModules for interacting with the devices
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 usedapi_key_secret
- API key secret to use. If not provided, the default secret from config will be usedendpoint
- endpoint to use. If not provided, the default endpoint from config will be usedclient
- HTTP client to use. Must implementExStreamClient.Http.Behavior
. Defaults toExStreamClient.Http
req_opts
- all of these options will be forwarded to req. SeeReq.new/1
for available options
Summary
Functions
Adds a new device to a user, if the same device already exists the call will have no effect
Deletes one device
Returns all available devices
Functions
Adds a new device to a user, if the same device already exists the call will have no effect
Required Arguments:
All options from Shared Options are supported.
@spec delete_device(String.t(), req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t(), user_id: String.t() ) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes one device
Required Arguments:
id
Optional Arguments:
user_id
All options from Shared Options are supported.
@spec list_devices( req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t(), user_id: String.t() ) :: {:ok, ExStreamClient.Model.ListDevicesResponse.t()} | {:error, any()}
Returns all available devices
Optional Arguments:
user_id
All options from Shared Options are supported.