Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeviceStates

Hierarchy

  • DeviceStates

Index

Methods

Methods

delete

  • delete(params: { deviceName: string }, callback: (err: Error) => void): void
  • delete(params: { deviceName: string }): Promise<void>
  • Destroy a device-state controlled by ARI.

    Parameters

    • params: { deviceName: string }
      • deviceName: string

        Name of the device.

    • callback: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Destroy a device-state controlled by ARI.

    Parameters

    • params: { deviceName: string }
      • deviceName: string

        Name of the device.

    Returns Promise<void>

get

  • get(params: { deviceName: string }, callback: (err: Error, devicestate: DeviceState) => void): void
  • get(params: { deviceName: string }): Promise<DeviceState>
  • Retrieve the current state of a device.

    Parameters

    • params: { deviceName: string }
      • deviceName: string

        Name of the device.

    • callback: (err: Error, devicestate: DeviceState) => void

    Returns void

  • Retrieve the current state of a device.

    Parameters

    • params: { deviceName: string }
      • deviceName: string

        Name of the device.

    Returns Promise<DeviceState>

list

  • List all ARI controlled device states.

    Parameters

    • callback: (err: Error, devicestates: DeviceState[]) => void
        • Parameters

          Returns void

    Returns void

  • List all ARI controlled device states.

    Returns Promise<DeviceState[]>

update

  • update(params: { deviceName: string; deviceState: string }, callback: (err: Error) => void): void
  • update(params: { deviceName: string; deviceState: string }): Promise<void>
  • Change the state of a device controlled by ARI. (Note - implicitly creates the device state).

    Parameters

    • params: { deviceName: string; deviceState: string }
      • deviceName: string

        Name of the device.

      • deviceState: string

        Device state value.

    • callback: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Change the state of a device controlled by ARI. (Note - implicitly creates the device state).

    Parameters

    • params: { deviceName: string; deviceState: string }
      • deviceName: string

        Name of the device.

      • deviceState: string

        Device state value.

    Returns Promise<void>

Generated using TypeDoc