Class WebSocketPairedCloverDeviceConfiguration

Hierarchy

WebSocketCloverDeviceConfiguration
- WebSocketPairedCloverDeviceConfiguration

Implements

CloverDeviceConfiguration
PairingDeviceConfiguration

Index

Constructors

constructor

new WebSocketPairedCloverDeviceConfiguration(endpoint: string, applicationId: string, posName: string, serialNumber: string, authToken: string, onPairingCode: function, onPairingSuccess: function, webSocketFactoryFunction: any, imageUtil: IImageUtil, heartbeatInterval: number, reconnectDelay: number, heartbeatDisconnectTimeout: number): WebSocketPairedCloverDeviceConfiguration

Overrides WebSocketCloverDeviceConfiguration.__constructor
- Defined in remote/client/device/WebSocketPairedCloverDeviceConfiguration.ts:22
Parameters
- endpoint: string
- applicationId: string
- posName: string
- serialNumber: string
- authToken: string
- onPairingCode: function
  - - (pairingCode: string): void
    - Parameters
      - pairingCode: string
      Returns void
- onPairingSuccess: function
  - - (authToken: string): void
    - Parameters
      - authToken: string
      Returns void
- webSocketFactoryFunction: any
- imageUtil: IImageUtil
- Optional heartbeatInterval: number
- Optional reconnectDelay: number
- Optional heartbeatDisconnectTimeout: number
Returns WebSocketPairedCloverDeviceConfiguration

Properties

Private authToken

authToken: string

Protected imageUtil

imageUtil: IImageUtil

Protected logger

logger: Logger = Logger.create()

Protected maxCharInMessage

maxCharInMessage: number = 50000

Private onPairingCodeHandler

onPairingCodeHandler: function

Type declaration

- (pairingCode: string): void
- Parameters
  - pairingCode: string
  Returns void

Private onPairingSuccessHandler

onPairingSuccessHandler: function

Type declaration

- (authToken: string): void
- Parameters
  - authToken: string
  Returns void

Private posName

posName: string

Private serialNumber

serialNumber: string

Private uri

uri: string = null

Protected webSocketImplClass

webSocketImplClass: any

Methods

getApplicationId

getApplicationId(): string

Inherited from WebSocketCloverDeviceConfiguration.getApplicationId
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:51
Returns string

getCloverDeviceType

getCloverDeviceType(): any

Inherited from WebSocketCloverDeviceConfiguration.getCloverDeviceType
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:85
Returns any

getCloverTransport

getCloverTransport(): CloverTransport

Overrides WebSocketCloverDeviceConfiguration.getCloverTransport
- Defined in remote/client/device/WebSocketPairedCloverDeviceConfiguration.ts:75
Returns CloverTransport

getHeartbeatDisconnectTimeout

getHeartbeatDisconnectTimeout(): number

Inherited from WebSocketCloverDeviceConfiguration.getHeartbeatDisconnectTimeout
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:55
Returns number

getHeartbeatInterval

getHeartbeatInterval(): number

Inherited from WebSocketCloverDeviceConfiguration.getHeartbeatInterval
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:63
Returns number

getImageUtil

getImageUtil(): IImageUtil

Inherited from WebSocketCloverDeviceConfiguration.getImageUtil
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:96
Returns IImageUtil

getMaxMessageCharacters

getMaxMessageCharacters(): number

Inherited from WebSocketCloverDeviceConfiguration.getMaxMessageCharacters
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:110
Returns number

getMessagePackageName

getMessagePackageName(): string

Overrides WebSocketCloverDeviceConfiguration.getMessagePackageName
- Defined in remote/client/device/WebSocketPairedCloverDeviceConfiguration.ts:67
Returns string

getName

getName(): string

Overrides WebSocketCloverDeviceConfiguration.getName
- Defined in remote/client/device/WebSocketPairedCloverDeviceConfiguration.ts:71
Returns string

getReconnectDelay

getReconnectDelay(): number

Inherited from WebSocketCloverDeviceConfiguration.getReconnectDelay
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:74
Returns number

onPairingCode

onPairingCode(pairingCode: string): void

- Defined in remote/client/device/WebSocketPairedCloverDeviceConfiguration.ts:93
Parameters
- pairingCode: string
Returns void

onPairingSuccess

onPairingSuccess(authToken: string): void

- Defined in remote/client/device/WebSocketPairedCloverDeviceConfiguration.ts:97
Parameters
- authToken: string
Returns void

setAuthToken

setAuthToken(authToken: string): void

- Defined in remote/client/device/WebSocketPairedCloverDeviceConfiguration.ts:89
Parameters
- authToken: string
Returns void

setHeartbeatDisconnectTimeout

setHeartbeatDisconnectTimeout(heartbeatDisconnectTimeout: number): void

Inherited from WebSocketCloverDeviceConfiguration.setHeartbeatDisconnectTimeout
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:59
Parameters
- heartbeatDisconnectTimeout: number
Returns void

setHeartbeatInterval

setHeartbeatInterval(heartbeatInterval: number): void

Inherited from WebSocketCloverDeviceConfiguration.setHeartbeatInterval
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:70
Parameters
- heartbeatInterval: number
Returns void

setReconnectDelay

setReconnectDelay(reconnectDelay: number): void

Inherited from WebSocketCloverDeviceConfiguration.setReconnectDelay
- Defined in remote/client/device/WebSocketCloverDeviceConfiguration.ts:81
Parameters
- reconnectDelay: number
Returns void

Generated using TypeDoc