CDPotion.Domain.DeviceAccess (cdpotion v0.1.3)

Summary

Types

device_id()

A device id.

prompt_device()

Device information displayed in a user prompt to select a device.

request_id()

Device request id.

Functions

cancel_prompt(id)

Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.

disable()

Disable events in this domain.

enable()

Enable events in this domain.

select_prompt(id, device_id)

Select a device in response to a DeviceAccess.deviceRequestPrompted event.

Types

Link to this type

device_id()

@type device_id() :: String.t()

A device id.

Link to this type

prompt_device()

@type prompt_device() :: %{id: device_id(), name: String.t()}

Device information displayed in a user prompt to select a device.

Link to this type

request_id()

@type request_id() :: String.t()

Device request id.

Functions

Link to this function

cancel_prompt(id)

@spec cancel_prompt(CDPotion.Domain.DeviceAccess.RequestId) :: {String.t(), map()}

Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.

Parameters:

  • (Required) id: description not provided :(
Link to this function

disable()

@spec disable() :: {String.t(), map()}

Disable events in this domain.

Link to this function

enable()

@spec enable() :: {String.t(), map()}

Enable events in this domain.

Link to this function

select_prompt(id, device_id)

@spec select_prompt(
  CDPotion.Domain.DeviceAccess.RequestId,
  CDPotion.Domain.DeviceAccess.DeviceId
) ::
  {String.t(), map()}

Select a device in response to a DeviceAccess.deviceRequestPrompted event.

Parameters:

  • (Required) id: description not provided :(
  • (Required) device_id: description not provided :(