Interface CloverDeviceObserver

Clover Device Observer

The device observer listens for notifications and handles them.

interface

Hierarchy

CloverDeviceObserver

Implemented by

Methods

onAuthTipAdjusted

onAuthTipAdjusted(paymentId: string, amount: number, success: boolean): void

- Defined in remote/client/CloverDeviceObserver.ts:51
Auth Tip Adjusted

Parameters
- paymentId: string
- amount: number
- success: boolean
Returns void

onCapturePreAuth

onCapturePreAuth(status: sdk.remotemessage.ResultStatus, reason: string, paymentId: string, amount: number, tipAmount: number): void

- Defined in remote/client/CloverDeviceObserver.ts:156
Capture Pre-Auth

Parameters
- status: sdk.remotemessage.ResultStatus
- reason: string
- paymentId: string
- amount: number
- tipAmount: number
Returns void

onCashbackSelected

onCashbackSelected(cashbackAmount: number): void

- Defined in remote/client/CloverDeviceObserver.ts:58
Cashback Selected

Parameters
- cashbackAmount: number
Returns void

onCloseoutResponse

onCloseoutResponse(status: sdk.remotemessage.ResultStatus, reason: string, batch: sdk.payments.Batch): void

- Defined in remote/client/CloverDeviceObserver.ts:164
Closeout Response

Parameters
- status: sdk.remotemessage.ResultStatus
  
  base @param {string} reason
- reason: string
- batch: sdk.payments.Batch
Returns void

onConfirmPayment

onConfirmPayment(payment: sdk.payments.Payment, challenges: Array<sdk.base.Challenge>): void

- Defined in remote/client/CloverDeviceObserver.ts:108
Confirm Payment

Parameters
- payment: sdk.payments.Payment
- challenges: Array<sdk.base.Challenge>
Returns void

onDeviceConnected

onDeviceConnected(device: CloverDevice): void

- Defined in remote/client/CloverDeviceObserver.ts:178
Device Connected

Parameters
- device: CloverDevice
Returns void

onDeviceDisconnected

onDeviceDisconnected(device: CloverDevice): void

- Defined in remote/client/CloverDeviceObserver.ts:171
Device Disconnected

Parameters
- device: CloverDevice
Returns void

onDeviceError

onDeviceError(errorEvent: sdk.remotemessage.CloverDeviceErrorEvent): void

- Defined in remote/client/CloverDeviceObserver.ts:193
Device Error

Parameters
- errorEvent: sdk.remotemessage.CloverDeviceErrorEvent
Returns void

onDeviceReady

onDeviceReady(device: CloverDevice, drm: sdk.remotemessage.DiscoveryResponseMessage): void

- Defined in remote/client/CloverDeviceObserver.ts:186
Device Ready

Parameters
- device: CloverDevice
- drm: sdk.remotemessage.DiscoveryResponseMessage
Returns void

onFinishCancel

onFinishCancel(): void

- Defined in remote/client/CloverDeviceObserver.ts:92
Finish Cancel

Returns void

onFinishOk

onFinishOk(payment: sdk.payments.Payment, signature2: sdk.base.Signature): void
onFinishOk(credit: sdk.payments.Credit): void
onFinishOk(refund: sdk.payments.Refund): void

- Defined in remote/client/CloverDeviceObserver.ts:73
Finish Ok

Parameters
- payment: sdk.payments.Payment
- signature2: sdk.base.Signature
Returns void
- Defined in remote/client/CloverDeviceObserver.ts:80
Finish Ok

Parameters
- credit: sdk.payments.Credit
Returns void
- Defined in remote/client/CloverDeviceObserver.ts:87
Finish Ok

Parameters
- refund: sdk.payments.Refund
Returns void

onKeyPressed

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

- Defined in remote/client/CloverDeviceObserver.ts:126
Key Pressed

Parameters
- keyPress: sdk.remotemessage.KeyPress
Returns void

onMessageAck

onMessageAck(sourceMessageId: string): void

- Defined in remote/client/CloverDeviceObserver.ts:247
Message Acknowledgement

Parameters
- sourceMessageId: string
Returns void

onPartialAuth

onPartialAuth(partialAuthAmount: number): void

- Defined in remote/client/CloverDeviceObserver.ts:65
Partial Auth

Parameters
- partialAuthAmount: number
Returns void

onPaymentRefundResponse

onPaymentRefundResponse(orderId: string, paymentId: string, refund: sdk.payments.Refund, code: sdk.remotemessage.TxState): void

- Defined in remote/client/CloverDeviceObserver.ts:136
Payment Refund Response

Parameters
- orderId: string
- paymentId: string
- refund: sdk.payments.Refund
- code: sdk.remotemessage.TxState
Returns void

onPaymentVoided

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

- Defined in remote/client/CloverDeviceObserver.ts:119
Payment Voided

Parameters
- payment: sdk.payments.Payment
- voidReason: sdk.order.VoidReason
- result: sdk.remotemessage.ResultStatus
- reason: string
- message: string
Returns void

onPendingPaymentsResponse

onPendingPaymentsResponse(success: boolean, payments: Array<sdk.base.PendingPaymentEntry>): void

- Defined in remote/client/CloverDeviceObserver.ts:255
Pending Payments Response

Parameters
- success: boolean
- payments: Array<sdk.base.PendingPaymentEntry>
Returns void

onPrintCredit

onPrintCredit(credit: sdk.payments.Credit): void

- Defined in remote/client/CloverDeviceObserver.ts:232
Print Credit

Parameters
- credit: sdk.payments.Credit
Returns void

onPrintCreditDecline

onPrintCreditDecline(credit: sdk.payments.Credit, reason: string): void

- Defined in remote/client/CloverDeviceObserver.ts:240
Print Credit Decline

Parameters
- credit: sdk.payments.Credit
- reason: string
Returns void

onPrintMerchantReceipt

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

- Defined in remote/client/CloverDeviceObserver.ts:209
Print Merchant Receipt

Parameters
- payment: sdk.payments.Payment
Returns void

onPrintPayment

onPrintPayment(payment: sdk.payments.Payment, order: sdk.order.Order): void

- Defined in remote/client/CloverDeviceObserver.ts:225
Print Payment

Parameters
- payment: sdk.payments.Payment
- order: sdk.order.Order
Returns void

onPrintPaymentDecline

onPrintPaymentDecline(payment: sdk.payments.Payment, reason: string): void

- Defined in remote/client/CloverDeviceObserver.ts:217
Print Payment Decline

Parameters
- payment: sdk.payments.Payment
- reason: string
Returns void

onPrintRefundPayment

onPrintRefundPayment(payment: sdk.payments.Payment, order: sdk.order.Order, refund: sdk.payments.Refund): void

- Defined in remote/client/CloverDeviceObserver.ts:202
Print Refund Payment

Parameters
- payment: sdk.payments.Payment
- order: sdk.order.Order
- refund: sdk.payments.Refund
Returns void

onReadCardResponse

onReadCardResponse(status: sdk.remotemessage.ResultStatus, reason: string, cardData: sdk.base.CardData): void

- Defined in remote/client/CloverDeviceObserver.ts:264
Read Card Response

Parameters
- status: sdk.remotemessage.ResultStatus
- reason: string
- cardData: sdk.base.CardData
Returns void

onTipAdded

onTipAdded(tipAmount: number): void

- Defined in remote/client/CloverDeviceObserver.ts:42
Tip Added

Parameters
- tipAmount: number
Returns void

onTxStartResponse

onTxStartResponse(result: sdk.remotemessage.TxStartResponseResult, externalId: string): void

- Defined in remote/client/CloverDeviceObserver.ts:25
Transaction Start Response

Parameters
- result: sdk.remotemessage.TxStartResponseResult
- externalId: string
Returns void

onTxState

onTxState(txState: sdk.remotemessage.TxState): void

- Defined in remote/client/CloverDeviceObserver.ts:17
Transaction State

Parameters
- txState: sdk.remotemessage.TxState
Returns void

onUiState

onUiState(uiState: sdk.remotemessage.UiState, uiText: string, uiDirection: sdk.remotemessage.UiState.UiDirection, inputOptions: Array<sdk.remotemessage.InputOption>): void

- Defined in remote/client/CloverDeviceObserver.ts:35
UI State change

Parameters
- uiState: sdk.remotemessage.UiState
- uiText: string
- uiDirection: sdk.remotemessage.UiState.UiDirection
- inputOptions: Array<sdk.remotemessage.InputOption>
Returns void

onVaultCardResponse

onVaultCardResponse(vaultedCard: sdk.payments.VaultedCard, code: string, reason: string): void

- Defined in remote/client/CloverDeviceObserver.ts:145
Vault Card Response

Parameters
- vaultedCard: sdk.payments.VaultedCard
- code: string
- reason: string
Returns void

onVerifySignature

onVerifySignature(payment: sdk.payments.Payment, signature: sdk.base.Signature): void

- Defined in remote/client/CloverDeviceObserver.ts:100
Verify Signature

Parameters
- payment: sdk.payments.Payment
- signature: sdk.base.Signature
Returns void

Generated using TypeDoc