Interface PairingDeviceConfiguration

For connections that require a pairing flow, this interface is used.

Hierarchy

PairingDeviceConfiguration

Implemented by

WebSocketPairedCloverDeviceConfiguration

Index

Methods

Methods

onPairingCode

onPairingCode(pairingCode: string): void

- Defined in remote/client/transport/PairingDeviceConfiguration.ts:11
Called when a pairing code is sent. Typically, this would be displayed to the user, and they would enter this code into the device screen.

Parameters
- pairingCode: string
  
  the string code to be displayed.
Returns void

onPairingSuccess

onPairingSuccess(authToken: string): void

- Defined in remote/client/transport/PairingDeviceConfiguration.ts:18
When the pairing process is complete, a authentication token is sent that be reused.

Parameters
- authToken: string
  
  the authentication code that can be reused to avoid redisplay of a pairing code.
Returns void

Generated using TypeDoc