ExStreamClient.Operations.Devices (ExStreamClient v0.1.7)

View Source

Modules 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 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_device(payload, opts \\ [])

Adds a new device to a user, if the same device already exists the call will have no effect

delete_device(id, opts \\ [])

Deletes one device

list_devices(opts \\ [])

Returns all available devices

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_device(payload, opts \\ [])

@spec create_device(ExStreamClient.Model.CreateDeviceRequest.t(), shared_opts()) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}

Adds a new device to a user, if the same device already exists the call will have no effect

Required Arguments:

Optional Arguments:

delete_device(id, opts \\ [])

@spec delete_device(String.t(), [{:user_id, String.t()} | shared_opts()]) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}

Deletes one device

Required Arguments:

  • id

Optional Arguments:

list_devices(opts \\ [])

@spec list_devices([{:user_id, String.t()} | shared_opts()]) ::
  {:ok, ExStreamClient.Model.ListDevicesResponse.t()} | {:error, any()}

Returns all available devices

Optional Arguments: