CDPotion.Domain.DeviceAccess (cdpotion v0.1.4)

Summary

Types

A device id.

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

Device request id.

Functions

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

Disable events in this domain.

Enable events in this domain.

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

Types

@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(request_id()) :: {String.t(), map()}

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

Parameters:

  • (Required) id: description not provided :(
@spec disable() :: {String.t(), map()}

Disable events in this domain.

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

Enable events in this domain.

Link to this function

select_prompt(id, device_id)

@spec select_prompt(
  request_id(),
  device_id()
) :: {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 :(