siteKiosk.accessibility.remoteControl

Index

Properties

enabled errorState isSessionActive qrCodeImageUri sessionCode

Methods

closeActiveSession onErrorChanged onSessionCodeReceived requestNewCode

Properties

enabled

enabled: boolean

Gets or sets whether the remote control feature is enabled.

`Readonly` errorState

errorState: RemoteControlError

Gets the current error state.

`Readonly` isSessionActive

isSessionActive: boolean

Gets whether a remote session is currently active.

`Readonly` qrCodeImageUri

qrCodeImageUri: string

Gets the URI of the QR code image for the current session.

`Readonly` sessionCode

sessionCode: string

Gets the current session code string.

Methods

closeActiveSession

closeActiveSession(): void
Closes the currently active remote session.

Returns void

onErrorChanged

onErrorChanged(callback: ((error: RemoteControlError) => void)): EventSubscription
Registers a callback which will be called when the error state changes.

Returns
An event subscription which can be used to unsubscribe from the event.
Parameters
- callback: ((error: RemoteControlError) => void)
  
  The callback which will be called with the new error state.
  - - (error: RemoteControlError): void
    - Parameters
      
      error: RemoteControlError
      
      Returns void
Returns EventSubscription

onSessionCodeReceived

onSessionCodeReceived(callback: ((sessionCode: string) => void)): EventSubscription
Registers a callback which will be called when a new session code is received.

Returns
An event subscription which can be used to unsubscribe from the event.
Parameters
- callback: ((sessionCode: string) => void)
  
  The callback which will be called with the new session code.
  - - (sessionCode: string): void
    - Parameters
      
      sessionCode: string
      
      Returns void
Returns EventSubscription

requestNewCode

requestNewCode(): void
Requests a new session code.

Returns void

Generated using TypeDoc