ExStreamClient.Operations.Devices (ExStreamClient v0.1.3)

View Source

Modules for interacting with the devices group of Stream APIs

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

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

create_device(payload, opts \\ [])

@spec create_device(ExStreamClient.Model.CreateDeviceRequest.t(), [
  {:client, module()}
]) ::
  {: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(), client: module(), user_id: String.t()) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}

Deletes one device

Required Arguments:

  • id

Optional Arguments:

list_devices(opts \\ [])

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

Returns all available devices

Optional Arguments: