IsolatedWebSite | SiteKiosk Online API

Index

Properties

config name state type

Events

onError onStateChanged

Methods

onMessageReceived ready reportDeviceError reportDeviceStarted requestAsync send start stop whenMessageReceived

Properties

config

config: any

The device config.

name

name: string

The name of the device.

state

state: DeviceState

The device state.

type

type: string

The type of the device.

Events

onError

onError(callback: ((error: Error) => void)): EventSubscription
Registers a callback which will be triggered when the device encounters an error.
Parameters
- callback: ((error: Error) => void)
  
  The callback which will be called once the device encountered an error.
  - - (error: Error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns EventSubscription

Inherited from Device.onError

onStateChanged

onStateChanged(callback: ((state: DeviceState) => void)): EventSubscription
Registers a callback which will be triggered when the device state changes.
Parameters
- callback: ((state: DeviceState) => void)
  
  The callback which will be called once the device changes its state.
  - - (state: DeviceState): void
    - Parameters
      
      state: DeviceState
      
      Returns void
Returns EventSubscription

Inherited from Device.onStateChanged

Methods

onMessageReceived

onMessageReceived(callback: ((message: ReceivedMessage | ReceivedRespondableMessage) => void)): EventSubscription
Triggers the callback when a message from the website has been received.
Parameters
- callback: ((message: ReceivedMessage | ReceivedRespondableMessage) => void)
  - - (message: ReceivedMessage | ReceivedRespondableMessage): void
    - Parameters
      
      message: ReceivedMessage | ReceivedRespondableMessage
      
      Returns void
Returns EventSubscription

ready

ready(): Promise<any>
Returns a promise which is fulfilled when the device is started.

Returns Promise<any>

Inherited from Device.ready

reportDeviceError

reportDeviceError(error: string): void
Parameters
- error: string
Returns void

reportDeviceStarted

reportDeviceStarted(): void
Returns void

requestAsync

requestAsync(message: string, payload?: unknown): Promise<unknown>
Sends a replyable message to the website, returns the response when it has been received.
Parameters
- message: string
- Optional payload: unknown
Returns Promise<unknown>

send

send(message: string, payload?: unknown): void
Sends a message to the website without waiting for any reply.
Parameters
- message: string
- Optional payload: unknown
Returns void

start

start(): Promise<any>
Starts the device when needed and returns a promise which is fulfilled when the device is started.

Returns Promise<any>

Inherited from Device.start

stop

stop(): Promise<any>
Stops the device.

Returns Promise<any>

Inherited from Device.stop

whenMessageReceived

whenMessageReceived(message: string): Promise<ReceivedMessage | ReceivedRespondableMessage>
Waits for a message to be received.
Parameters
- message: string
Returns Promise<ReceivedMessage | ReceivedRespondableMessage>

Generated using TypeDoc