Class DefaultCloverDevice

Default Clover Device

This is a default implementation of the clover device.

Hierarchy

CloverDevice
- DefaultCloverDevice
  - WebsocketCloudCloverDevice

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DefaultCloverDevice(configuration: CloverDeviceConfiguration): DefaultCloverDevice

Overrides CloverDevice.constructor
- Defined in remote/client/device/DefaultCloverDevice.ts:29
Parameters
- configuration: CloverDeviceConfiguration
Returns DefaultCloverDevice

Properties

Protected applicationId

applicationId: string

Protected deviceObservers

deviceObservers: CloverDeviceObserver[]

Private imageUtil

imageUtil: IImageUtil

Protected logger

logger: Logger = Logger.create()

Protected messageParser

messageParser: RemoteMessageParser = RemoteMessageParser.getDefaultInstance()

Private msgIdToTask

msgIdToTask: object

Type declaration

[key: string]: Function

Protected packageName

packageName: string

Protected supportsAck

supportsAck: boolean = false

Protected transport

transport: CloverTransport

Static Private REMOTE_SDK

REMOTE_SDK: string = Version.CLOVER_CLOUD_SDK + ":" + Version.CLOVER_CLOUD_SDK_VERSION

Static Private id

id: number = 0

Methods

Protected addTaskForAck

addTaskForAck(msgId: string, task: Function): void

- Defined in remote/client/device/DefaultCloverDevice.ts:754
Parameters
- msgId: string
- task: Function
Returns void

Protected buildRemoteMessageToSend

buildRemoteMessageToSend(message: sdk.remotemessage.Message, version?: number): sdk.remotemessage.RemoteMessage

- Defined in remote/client/device/DefaultCloverDevice.ts:894
Parameters
- message: sdk.remotemessage.Message
- Optional version: number
Returns sdk.remotemessage.RemoteMessage

dispose

dispose(): void

Overrides CloverDevice.dispose
- Defined in remote/client/device/DefaultCloverDevice.ts:871
Dispose

Returns void

doAcceptPayment

doAcceptPayment(payment: sdk.payments.Payment): void

Overrides CloverDevice.doAcceptPayment
- Defined in remote/client/device/DefaultCloverDevice.ts:806
Accept Payment

Parameters
- payment: sdk.payments.Payment
Returns void

doCaptureAuth

doCaptureAuth(paymentId: string, amount: number, tipAmount: number): void

Overrides CloverDevice.doCaptureAuth
- Defined in remote/client/device/DefaultCloverDevice.ts:793
Capture Auth

Parameters
- paymentId: string
- amount: number
- tipAmount: number
Returns void

doCloseout

doCloseout(allowOpenTabs: boolean, batchId: string): void

Overrides CloverDevice.doCloseout
- Defined in remote/client/device/DefaultCloverDevice.ts:644
Closeout

Parameters
- allowOpenTabs: boolean
- batchId: string
Returns void

doDiscoveryRequest

doDiscoveryRequest(): void

Overrides CloverDevice.doDiscoveryRequest
- Defined in remote/client/device/DefaultCloverDevice.ts:828
Discovery request

Returns void

doKeyPress

doKeyPress(keyPress: sdk.remotemessage.KeyPress): void

Overrides CloverDevice.doKeyPress
- Defined in remote/client/device/DefaultCloverDevice.ts:572
Key Press

Parameters
- keyPress: sdk.remotemessage.KeyPress
Returns void

doOpenCashDrawer

doOpenCashDrawer(reason: string): void

Overrides CloverDevice.doOpenCashDrawer
- Defined in remote/client/device/DefaultCloverDevice.ts:632
Open Cash Drawer

Parameters
- reason: string
Returns void

doOrderUpdate

doOrderUpdate(order: sdk.order.DisplayOrder, orderOperation: any): void

Overrides CloverDevice.doOrderUpdate
- Defined in remote/client/device/DefaultCloverDevice.ts:840
Order Update

Parameters
- order: sdk.order.DisplayOrder
- orderOperation: any
Returns void

doPaymentRefund

doPaymentRefund(orderId: string, paymentId: string, amount: number, fullRefund: boolean): void

Overrides CloverDevice.doPaymentRefund
- Defined in remote/client/device/DefaultCloverDevice.ts:766
Payment Refund

Parameters
- orderId: string
- paymentId: string
- amount: number
- fullRefund: boolean
Returns void

doPrintImageObject

doPrintImageObject(bitmap: any): void

Overrides CloverDevice.doPrintImageObject
- Defined in remote/client/device/DefaultCloverDevice.ts:706
Print Image (Bitmap)

Parameters
- bitmap: any
Returns void

doPrintImageUrl

doPrintImageUrl(url: string): void

Overrides CloverDevice.doPrintImageUrl
- Defined in remote/client/device/DefaultCloverDevice.ts:718
Print Image (URL)

Parameters
- url: string
Returns void

doPrintText

doPrintText(textLines: Array<string>): void

Overrides CloverDevice.doPrintText
- Defined in remote/client/device/DefaultCloverDevice.ts:695
Print Text

Parameters
- textLines: Array<string>
Returns void

doReadCardData

doReadCardData(payIntent: sdk.remotemessage.PayIntent): void

Overrides CloverDevice.doReadCardData
- Defined in remote/client/device/DefaultCloverDevice.ts:684
Read Cart Data

Parameters
- payIntent: sdk.remotemessage.PayIntent
Returns void

doRejectPayment

doRejectPayment(payment: sdk.payments.Payment, challenge: sdk.base.Challenge): void

Overrides CloverDevice.doRejectPayment
- Defined in remote/client/device/DefaultCloverDevice.ts:818
Reject Payment

Parameters
- payment: sdk.payments.Payment
- challenge: sdk.base.Challenge
Returns void

doResetDevice

doResetDevice(): void

Overrides CloverDevice.doResetDevice
- Defined in remote/client/device/DefaultCloverDevice.ts:863
Reset Device

Returns void

doRetrievePendingPayments

doRetrievePendingPayments(): void

Overrides CloverDevice.doRetrievePendingPayments
- Defined in remote/client/device/DefaultCloverDevice.ts:611
Retrieve Pending Payments

Returns void

doShowPaymentReceiptScreen

doShowPaymentReceiptScreen(orderId: string, paymentId: string): void

Overrides CloverDevice.doShowPaymentReceiptScreen
- Defined in remote/client/device/DefaultCloverDevice.ts:559
Show Payment Receipt Screen

Parameters
- orderId: string
- paymentId: string
Returns void

doShowThankYouScreen

doShowThankYouScreen(): void

Overrides CloverDevice.doShowThankYouScreen
- Defined in remote/client/device/DefaultCloverDevice.ts:581
Show Thank You Screen

Returns void

doShowWelcomeScreen

doShowWelcomeScreen(): void

Overrides CloverDevice.doShowWelcomeScreen
- Defined in remote/client/device/DefaultCloverDevice.ts:590
Show Welcome Screen

Returns void

doSignatureVerified

doSignatureVerified(payment: sdk.payments.Payment, verified: boolean): void

Overrides CloverDevice.doSignatureVerified
- Defined in remote/client/device/DefaultCloverDevice.ts:601
Signature Verified

Parameters
- payment: sdk.payments.Payment
- verified: boolean
Returns void

doTerminalMessage

doTerminalMessage(text: string): void

Overrides CloverDevice.doTerminalMessage
- Defined in remote/client/device/DefaultCloverDevice.ts:621
Terminal Message

Parameters
- text: string
Returns void

doTipAdjustAuth

doTipAdjustAuth(orderId: string, paymentId: string, amount: number): void

Overrides CloverDevice.doTipAdjustAuth
- Defined in remote/client/device/DefaultCloverDevice.ts:671
Tip Adjust Auth

Parameters
- orderId: string
- paymentId: string
- amount: number
Returns void

doTxStart

doTxStart(payIntent: sdk.remotemessage.PayIntent, order: sdk.order.Order): void

Overrides CloverDevice.doTxStart
- Defined in remote/client/device/DefaultCloverDevice.ts:657
Transaction Start

Parameters
- payIntent: sdk.remotemessage.PayIntent
- order: sdk.order.Order
Returns void

doVaultCard

doVaultCard(cardEntryMethods: number): void

Overrides CloverDevice.doVaultCard
- Defined in remote/client/device/DefaultCloverDevice.ts:780
Vault Card

Parameters
- cardEntryMethods: number
Returns void

doVoidPayment

doVoidPayment(payment: sdk.payments.Payment, reason: sdk.order.VoidReason): void

Overrides CloverDevice.doVoidPayment
- Defined in remote/client/device/DefaultCloverDevice.ts:730
Void Payment

Parameters
- payment: sdk.payments.Payment
- reason: sdk.order.VoidReason
Returns void

getApplicationId

getApplicationId(): string

- Defined in remote/client/device/DefaultCloverDevice.ts:68
Returns string

Protected handleRemoteMessage

handleRemoteMessage(rMessage: sdk.remotemessage.RemoteMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:270
Parameters
- rMessage: sdk.remotemessage.RemoteMessage
Returns void

Protected handleRemoteMessageCOMMAND

handleRemoteMessageCOMMAND(rMessage: sdk.remotemessage.RemoteMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:80
Parameters
- rMessage: sdk.remotemessage.RemoteMessage
Returns void

Protected handleRemoteMessageEVENT

handleRemoteMessageEVENT(rMessage: sdk.remotemessage.RemoteMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:266
Parameters
- rMessage: sdk.remotemessage.RemoteMessage
Returns void

Protected handleRemoteMessagePING

handleRemoteMessagePING(rMessage: sdk.remotemessage.RemoteMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:72
Parameters
- rMessage: sdk.remotemessage.RemoteMessage
Returns void

Protected handleRemoteMessagePONG

handleRemoteMessagePONG(rMessage: sdk.remotemessage.RemoteMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:76
Parameters
- rMessage: sdk.remotemessage.RemoteMessage
Returns void

Protected handleRemoteMessageQUERY

handleRemoteMessageQUERY(rMessage: sdk.remotemessage.RemoteMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:262
Parameters
- rMessage: sdk.remotemessage.RemoteMessage
Returns void

Private notifyObserverAck

notifyObserverAck(ackMessage: sdk.remotemessage.AcknowledgementMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:363
Parameters
- ackMessage: sdk.remotemessage.AcknowledgementMessage
Returns void

notifyObserverTxStart

notifyObserverTxStart(txsrm: sdk.remotemessage.TxStartResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:463
Parameters
- txsrm: sdk.remotemessage.TxStartResponseMessage
Returns void

notifyObserverVaultCardResponse

notifyObserverVaultCardResponse(vaultCardResponseMessage: sdk.remotemessage.VaultCardResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:499
Parameters
- vaultCardResponseMessage: sdk.remotemessage.VaultCardResponseMessage
Returns void

Private notifyObserversActivityResponse

notifyObserversActivityResponse(message: sdk.remotemessage.ActivityResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:387
Parameters
- message: sdk.remotemessage.ActivityResponseMessage
Returns void

notifyObserversCapturePreAuth

notifyObserversCapturePreAuth(cparm: sdk.remotemessage.CapturePreAuthResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:511
Parameters
- cparm: sdk.remotemessage.CapturePreAuthResponseMessage
Returns void

notifyObserversCashbackSelected

notifyObserversCashbackSelected(cbSelected: sdk.remotemessage.CashbackSelectedMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:451
Parameters
- cbSelected: sdk.remotemessage.CashbackSelectedMessage
Returns void

notifyObserversCloseout

notifyObserversCloseout(crm: sdk.remotemessage.CloseoutResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:517
Parameters
- crm: sdk.remotemessage.CloseoutResponseMessage
Returns void

notifyObserversConfirmPayment

notifyObserversConfirmPayment(confirmPaymentMessage: sdk.remotemessage.ConfirmPaymentMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:493
Parameters
- confirmPaymentMessage: sdk.remotemessage.ConfirmPaymentMessage
Returns void

Private notifyObserversConnected

notifyObserversConnected(transport: CloverTransport): void

- Defined in remote/client/device/DefaultCloverDevice.ts:334
Notify the observers that the device is connected

Parameters
- transport: CloverTransport
Returns void

Private notifyObserversDisconnected

notifyObserversDisconnected(transport: CloverTransport): void

- Defined in remote/client/device/DefaultCloverDevice.ts:345
Notify the observers that the device has disconnected

Parameters
- transport: CloverTransport
Returns void

notifyObserversFinishCancel

notifyObserversFinishCancel(): void

- Defined in remote/client/device/DefaultCloverDevice.ts:535
Returns void

notifyObserversFinishOk

notifyObserversFinishOk(msg: sdk.remotemessage.FinishOkMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:541
Parameters
- msg: sdk.remotemessage.FinishOkMessage
Returns void

notifyObserversKeyPressed

notifyObserversKeyPressed(keyPress: sdk.remotemessage.KeyPressMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:445
Parameters
- keyPress: sdk.remotemessage.KeyPressMessage
Returns void

notifyObserversPartialAuth

notifyObserversPartialAuth(partialAuth: sdk.remotemessage.PartialAuthMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:475
Parameters
- partialAuth: sdk.remotemessage.PartialAuthMessage
Returns void

notifyObserversPaymentRefundResponse

notifyObserversPaymentRefundResponse(rrm: sdk.remotemessage.RefundResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:439
Parameters
- rrm: sdk.remotemessage.RefundResponseMessage
Returns void

notifyObserversPaymentVoided

notifyObserversPaymentVoided(payment: sdk.payments.Payment, voidReason: sdk.order.VoidReason, result: sdk.remotemessage.ResultStatus, reason: string, message: string): void

- Defined in remote/client/device/DefaultCloverDevice.ts:481
Parameters
- payment: sdk.payments.Payment
- voidReason: sdk.order.VoidReason
- result: sdk.remotemessage.ResultStatus
- reason: string
- message: string
Returns void

notifyObserversPendingPaymentsResponse

notifyObserversPendingPaymentsResponse(rpprm: sdk.remotemessage.RetrievePendingPaymentsResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:523
Parameters
- rpprm: sdk.remotemessage.RetrievePendingPaymentsResponseMessage
Returns void

Private notifyObserversPrintCredit

notifyObserversPrintCredit(cpm: sdk.remotemessage.CreditPrintMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:422
Parameters
- cpm: sdk.remotemessage.CreditPrintMessage
Returns void

Private notifyObserversPrintCreditDecline

notifyObserversPrintCreditDecline(dcpm: sdk.remotemessage.DeclineCreditPrintMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:428
Parameters
- dcpm: sdk.remotemessage.DeclineCreditPrintMessage
Returns void

Private notifyObserversPrintMerchantCopy

notifyObserversPrintMerchantCopy(ppmcm: sdk.remotemessage.PaymentPrintMerchantCopyMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:404
Parameters
- ppmcm: sdk.remotemessage.PaymentPrintMerchantCopyMessage
Returns void

Private notifyObserversPrintMessage

notifyObserversPrintMessage(rppm: sdk.remotemessage.RefundPaymentPrintMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:381
Parameters
- rppm: sdk.remotemessage.RefundPaymentPrintMessage
Returns void

Private notifyObserversPrintPayment

notifyObserversPrintPayment(ppm: sdk.remotemessage.PaymentPrintMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:416
Parameters
- ppm: sdk.remotemessage.PaymentPrintMessage
Returns void

Private notifyObserversPrintPaymentDecline

notifyObserversPrintPaymentDecline(dppm: sdk.remotemessage.DeclinePaymentPrintMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:410
Parameters
- dppm: sdk.remotemessage.DeclinePaymentPrintMessage
Returns void

Private notifyObserversReadCardData

notifyObserversReadCardData(rcdrm: sdk.remotemessage.CardDataResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:375
Parameters
- rcdrm: sdk.remotemessage.CardDataResponseMessage
Returns void

Private notifyObserversReady

notifyObserversReady(transport: CloverTransport, drm: sdk.remotemessage.DiscoveryResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:357
Notify the observers that the device is ready

Parameters
- transport: CloverTransport
- drm: sdk.remotemessage.DiscoveryResponseMessage
Returns void

Private notifyObserversRemoteError

notifyObserversRemoteError(message: sdk.remotemessage.RemoteError): void

- Defined in remote/client/device/DefaultCloverDevice.ts:393
Parameters
- message: sdk.remotemessage.RemoteError
Returns void

notifyObserversTipAdded

notifyObserversTipAdded(tipAdded: sdk.remotemessage.TipAddedMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:457
Parameters
- tipAdded: sdk.remotemessage.TipAddedMessage
Returns void

notifyObserversTipAdjusted

notifyObserversTipAdjusted(tarm: sdk.remotemessage.TipAdjustResponseMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:469
Parameters
- tarm: sdk.remotemessage.TipAdjustResponseMessage
Returns void

notifyObserversTxState

notifyObserversTxState(txStateMsg: sdk.remotemessage.TxStateMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:529
Parameters
- txStateMsg: sdk.remotemessage.TxStateMessage
Returns void

notifyObserversUiState

notifyObserversUiState(uiStateMsg: sdk.remotemessage.UiStateMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:505
Parameters
- uiStateMsg: sdk.remotemessage.UiStateMessage
Returns void

notifyObserversVerifySignature

notifyObserversVerifySignature(verifySigMsg: sdk.remotemessage.VerifySignatureMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:487
Parameters
- verifySigMsg: sdk.remotemessage.VerifySignatureMessage
Returns void

onDeviceConnected

onDeviceConnected(transport: CloverTransport): void

Implementation of CloverTransportObserver.onDeviceConnected
- Defined in remote/client/device/DefaultCloverDevice.ts:46
Device is there but not yet ready for use

Parameters
- transport: CloverTransport
  
  the transport holding the notifications
Returns void

onDeviceDisconnected

onDeviceDisconnected(transport: CloverTransport): void

- Defined in remote/client/device/DefaultCloverDevice.ts:64
Device is not there anymore

Parameters
- transport: CloverTransport
  
  the transport holding the notifications
Returns void

onDeviceReady

onDeviceReady(transport: CloverTransport): void

Implementation of CloverTransportObserver.onDeviceReady
- Defined in remote/client/device/DefaultCloverDevice.ts:55
Device is there and ready for use

Parameters
- transport: CloverTransport
  
  the transport holding the notifications
Returns void

onMessage

onMessage(message: string): void

Implementation of CloverTransportObserver.onMessage
- Defined in remote/client/device/DefaultCloverDevice.ts:302
Called when a raw message is received from the device

Parameters
- message: string
  
  the raw message from the device
Returns void

sendObjectMessage

sendObjectMessage(message: sdk.remotemessage.Message): string

Implementation of ObjectMessageSender.sendObjectMessage
- Defined in remote/client/device/DefaultCloverDevice.ts:884
Send the message to the device using the transport

Parameters
- message: sdk.remotemessage.Message
Returns string

Private sendObjectMessage_opt_version

sendObjectMessage_opt_version(message: sdk.remotemessage.Message, version?: number): string

- Defined in remote/client/device/DefaultCloverDevice.ts:888
Parameters
- message: sdk.remotemessage.Message
- Optional version: number
Returns string

Private sendPong

sendPong(pingMessage: sdk.remotemessage.RemoteMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:319
Send a PONG response

Parameters
- pingMessage: sdk.remotemessage.RemoteMessage
Returns void

Protected sendRemoteMessage

sendRemoteMessage(remoteMessage: sdk.remotemessage.RemoteMessage): void

- Defined in remote/client/device/DefaultCloverDevice.ts:930
Parameters
- remoteMessage: sdk.remotemessage.RemoteMessage
Returns void

setSupportsAcks

setSupportsAcks(supportsAck: boolean): void

Inherited from CloverDevice.setSupportsAcks
- Defined in remote/client/device/CloverDevice.ts:236
Supports Acknowledgements

Parameters
- supportsAck: boolean
Returns void

subscribe

subscribe(observer: CloverDeviceObserver): void

Inherited from CloverDevice.subscribe
- Defined in remote/client/device/CloverDevice.ts:38
Add a new observer to the list of observers

Parameters
- observer: CloverDeviceObserver
  
  observer to add
Returns void

supportsAcks

supportsAcks(): boolean

Inherited from CloverDevice.supportsAcks
- Defined in remote/client/device/CloverDevice.ts:245
Get Supports Acknowledgements flag

Returns boolean

boolean - Flag indicating if this device supports acks

unsubscribe

unsubscribe(observer: CloverDeviceObserver): void

Inherited from CloverDevice.unsubscribe
- Defined in remote/client/device/CloverDevice.ts:47
Remove an observer from the list of observers

Parameters
- observer: CloverDeviceObserver
  
  observer to remove
Returns void

Generated using TypeDoc