InnerDeviceObserver | Clover SDK for Javascript Integration

Hierarchy

InnerDeviceObserver

Implements

CloverDeviceObserver

Index

Classes

Constructors

constructor

Properties

Methods

Constructors

constructor

new InnerDeviceObserver(cc: CloverConnector): InnerDeviceObserver

- Defined in remote/client/CloverConnector.ts:833
Parameters
- cc: CloverConnector
Returns InnerDeviceObserver

Properties

cloverConnector

cloverConnector: CloverConnector

lastPRR

lastPRR: sdk.remotepay.RefundPaymentResponse

logger

logger: Logger = Logger.create()

Methods

onAuthTipAdjusted

onAuthTipAdjusted(paymentId: string, tipAmount: number, success: boolean): void
onAuthTipAdjusted(result: sdk.remotepay.ResponseCode, reason: string, message: string): void
onAuthTipAdjusted(status: sdk.remotemessage.ResultStatus, reason: string, message: string): void

Implementation of CloverDeviceObserver.onAuthTipAdjusted
- Defined in remote/client/CloverConnector.ts:895
Parameters
- paymentId: string
- tipAmount: number
- success: boolean
Returns void
- Defined in remote/client/CloverConnector.ts:896
Parameters
- result: sdk.remotepay.ResponseCode
- reason: string
- message: string
Returns void
- Defined in remote/client/CloverConnector.ts:897
Parameters
- status: sdk.remotemessage.ResultStatus
- reason: string
- message: string
Returns void

onCapturePreAuth

onCapturePreAuth(statusOrCode: any, reason: string, paymentId: string, amount: number, tipAmount: number): void

- Defined in remote/client/CloverConnector.ts:1141
Parameters
- statusOrCode: any
- reason: string
- paymentId: string
- amount: number
- tipAmount: number
Returns void

onCashbackSelected

onCashbackSelected(cashbackAmount: number): void

Implementation of CloverDeviceObserver.onCashbackSelected
- Defined in remote/client/CloverConnector.ts:922
Parameters
- cashbackAmount: number
Returns void

onCloseoutResponse

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

Implementation of CloverDeviceObserver.onCloseoutResponse
- Defined in remote/client/CloverConnector.ts:1153
Parameters
- status: sdk.remotemessage.ResultStatus
- reason: string
- batch: sdk.payments.Batch
Returns void
- Defined in remote/client/CloverConnector.ts:1154
Parameters
- result: sdk.remotepay.ResponseCode
- reason: string
- message: string
Returns void

onConfirmPayment

onConfirmPayment(payment: sdk.payments.Payment, challenges: sdk.base.Challenge[]): void

- Defined in remote/client/CloverConnector.ts:1080
Parameters
- payment: sdk.payments.Payment
- challenges: sdk.base.Challenge[]
Returns void

onDeviceConnected

onDeviceConnected(): void

- Defined in remote/client/CloverConnector.ts:1177
Returns void

onDeviceDisconnected

onDeviceDisconnected(): void

- Defined in remote/client/CloverConnector.ts:1171
Returns void

onDeviceError

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

Implementation of CloverDeviceObserver.onDeviceError
- Defined in remote/client/CloverConnector.ts:1216
Parameters
- errorEvent: sdk.remotepay.CloverDeviceErrorEvent
Returns void

onDeviceReady

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

Implementation of CloverDeviceObserver.onDeviceReady
- Defined in remote/client/CloverConnector.ts:1183
Parameters
- device: CloverDevice
- drm: sdk.remotemessage.DiscoveryResponseMessage
Returns void

onFinishCancel

onFinishCancel(): void
onFinishCancel(result: sdk.remotepay.ResponseCode, reason: string, message: string): void

Implementation of CloverDeviceObserver.onFinishCancel
- Defined in remote/client/CloverConnector.ts:1005
Returns void
- Defined in remote/client/CloverConnector.ts:1006
Parameters
- result: sdk.remotepay.ResponseCode
- reason: string
- message: string
Returns void

onFinishCancelAuth

onFinishCancelAuth(result: sdk.remotepay.ResponseCode, reason?: string, message?: string): void

- Defined in remote/client/CloverConnector.ts:1057
Parameters
- result: sdk.remotepay.ResponseCode
- Optional reason: string
- Optional message: string
Returns void

onFinishCancelManualRefund

onFinishCancelManualRefund(result: sdk.remotepay.ResponseCode, reason?: string, message?: string): void

- Defined in remote/client/CloverConnector.ts:1065
Parameters
- result: sdk.remotepay.ResponseCode
- Optional reason: string
- Optional message: string
Returns void

onFinishCancelPreAuth

onFinishCancelPreAuth(result: sdk.remotepay.ResponseCode, reason?: string, message?: string): void

- Defined in remote/client/CloverConnector.ts:1041
Parameters
- result: sdk.remotepay.ResponseCode
- Optional reason: string
- Optional message: string
Returns void

onFinishCancelSale

onFinishCancelSale(result: sdk.remotepay.ResponseCode, reason?: string, message?: string): void

- Defined in remote/client/CloverConnector.ts:1049
Parameters
- result: sdk.remotepay.ResponseCode
- Optional reason: string
- Optional message: string
Returns void

onFinishOk

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

Implementation of CloverDeviceObserver.onFinishOk
- Defined in remote/client/CloverConnector.ts:930
Parameters
- payment: sdk.payments.Payment
- signature: sdk.base.Signature
Returns void
Implementation of CloverDeviceObserver.onFinishOk
- Defined in remote/client/CloverConnector.ts:931
Parameters
- credit: sdk.payments.Credit
Returns void
Implementation of CloverDeviceObserver.onFinishOk
- Defined in remote/client/CloverConnector.ts:932
Parameters
- refund: sdk.payments.Refund
Returns void

onKeyPressed

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

Implementation of CloverDeviceObserver.onKeyPressed
- Defined in remote/client/CloverConnector.ts:1110
Parameters
- keyPress: sdk.remotemessage.KeyPress
Returns void

onMessageAck

onMessageAck(messageId: string): void

Implementation of CloverDeviceObserver.onMessageAck
- Defined in remote/client/CloverConnector.ts:1240
Parameters
- messageId: string
Returns void

onPartialAuth

onPartialAuth(partialAmount: number): void

Implementation of CloverDeviceObserver.onPartialAuth
- Defined in remote/client/CloverConnector.ts:926
Parameters
- partialAmount: number
Returns void

onPaymentRefundResponse

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

Implementation of CloverDeviceObserver.onPaymentRefundResponse
- Defined in remote/client/CloverConnector.ts:1114
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, resultStatus: sdk.remotemessage.ResultStatus, reason: string, message: string): void

Implementation of CloverDeviceObserver.onPaymentVoided
- Defined in remote/client/CloverConnector.ts:1087
Parameters
- payment: sdk.payments.Payment
- voidReason: sdk.order.VoidReason
- resultStatus: sdk.remotemessage.ResultStatus
- reason: string
- message: string
Returns void

onPaymentVoided_responseCode

onPaymentVoided_responseCode(code: sdk.remotepay.ResponseCode, reason: string, message: string): void

- Defined in remote/client/CloverConnector.ts:1100
Parameters
- code: sdk.remotepay.ResponseCode
- reason: string
- message: string
Returns void

onPendingPaymentsResponse

onPendingPaymentsResponse(success: boolean, pendingPayments: Array<sdk.base.PendingPaymentEntry>): void
onPendingPaymentsResponse(result: sdk.remotepay.ResponseCode, reason: string, message: string): void
onPendingPaymentsResponse(status: sdk.remotemessage.ResultStatus, reason: string, message: string): void

Implementation of CloverDeviceObserver.onPendingPaymentsResponse
- Defined in remote/client/CloverConnector.ts:1244
Parameters
- success: boolean
- pendingPayments: Array<sdk.base.PendingPaymentEntry>
Returns void
- Defined in remote/client/CloverConnector.ts:1245
Parameters
- result: sdk.remotepay.ResponseCode
- reason: string
- message: string
Returns void
- Defined in remote/client/CloverConnector.ts:1246
Parameters
- status: sdk.remotemessage.ResultStatus
- reason: string
- message: string
Returns void

onPrintCredit

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

Implementation of CloverDeviceObserver.onPrintCredit
- Defined in remote/client/CloverConnector.ts:1233
Parameters
- credit: sdk.remotepay.Credit
Returns void

onPrintCreditDecline

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

Implementation of CloverDeviceObserver.onPrintCreditDecline
- Defined in remote/client/CloverConnector.ts:1236
Parameters
- credit: sdk.remotepay.Credit
- reason: string
Returns void

onPrintMerchantReceipt

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

Implementation of CloverDeviceObserver.onPrintMerchantReceipt
- Defined in remote/client/CloverConnector.ts:1224
Parameters
- payment: sdk.remotepay.Payment
Returns void

onPrintPayment

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

Implementation of CloverDeviceObserver.onPrintPayment
- Defined in remote/client/CloverConnector.ts:1230
Parameters
- payment: sdk.remotepay.Payment
- order: sdk.order.Order
Returns void

onPrintPaymentDecline

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

Implementation of CloverDeviceObserver.onPrintPaymentDecline
- Defined in remote/client/CloverConnector.ts:1227
Parameters
- payment: sdk.remotepay.Payment
- reason: string
Returns void

onPrintRefundPayment

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

Implementation of CloverDeviceObserver.onPrintRefundPayment
- Defined in remote/client/CloverConnector.ts:1221
Parameters
- payment: sdk.remotepay.Payment
- order: sdk.order.Order
- refund: sdk.payments.Refund
Returns void

onReadCardDataResponse

onReadCardDataResponse(result: sdk.remotepay.ResponseCode, reason: string, message: string): void

- Defined in remote/client/CloverConnector.ts:1284
Parameters
- result: sdk.remotepay.ResponseCode
- reason: string
- message: string
Returns void

onReadCardResponse

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

Implementation of CloverDeviceObserver.onReadCardResponse
- Defined in remote/client/CloverConnector.ts:1266
Parameters
- status: sdk.remotemessage.ResultStatus
- reason: string
- cardData: sdk.base.CardData
Returns void

onTipAdded

onTipAdded(tip: number): void

Implementation of CloverDeviceObserver.onTipAdded
- Defined in remote/client/CloverConnector.ts:891
Parameters
- tip: number
Returns void

onTxStartResponse

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

Implementation of CloverDeviceObserver.onTxStartResponse
- Defined in remote/client/CloverConnector.ts:842
Parameters
- result: sdk.remotemessage.TxStartResponseResult
- externalId: string
Returns void

onTxState

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

Implementation of CloverDeviceObserver.onTxState
- Defined in remote/client/CloverConnector.ts:839
Parameters
- txState: sdk.remotemessage.TxState
Returns void

onUiState

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

Implementation of CloverDeviceObserver.onUiState
- Defined in remote/client/CloverConnector.ts:875
Parameters
- uiState: sdk.remotemessage.UiState
- uiText: string
- uiDirection: sdk.remotemessage.UiDirection
- inputOptions: Array<sdk.remotemessage.InputOption>
Returns void

onVaultCardResponse

onVaultCardResponse(vaultedCard: sdk.payments.VaultedCard, code: string, reason: string): void
onVaultCardResponse(success: boolean, code: sdk.remotepay.ResponseCode, reason: string, message: string, vaultedCard: sdk.payments.VaultedCard): void

Implementation of CloverDeviceObserver.onVaultCardResponse
- Defined in remote/client/CloverConnector.ts:1126
Parameters
- vaultedCard: sdk.payments.VaultedCard
- code: string
- reason: string
Returns void
- Defined in remote/client/CloverConnector.ts:1127
Parameters
- success: boolean
- code: sdk.remotepay.ResponseCode
- reason: string
- message: string
- vaultedCard: sdk.payments.VaultedCard
Returns void

onVerifySignature

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

Implementation of CloverDeviceObserver.onVerifySignature
- Defined in remote/client/CloverConnector.ts:1073
Parameters
- payment: sdk.remotepay.Payment
- signature: sdk.base.Signature
Returns void

Hierarchy

Implements

Index

Classes

Constructors

Properties

Methods

Constructors

constructor

Parameters

cc: CloverConnector

Returns InnerDeviceObserver

Properties

cloverConnector

lastPRR

logger

Methods

onAuthTipAdjusted

Parameters

paymentId: string

tipAmount: number

success: boolean

Returns void

Parameters

result: sdk.remotepay.ResponseCode

reason: string

message: string

Returns void

Parameters

status: sdk.remotemessage.ResultStatus

reason: string

message: string

Returns void

onCapturePreAuth

Parameters

statusOrCode: any

reason: string

paymentId: string

amount: number

tipAmount: number

Returns void

onCashbackSelected

Parameters

cashbackAmount: number

Returns void

onCloseoutResponse

Parameters

status: sdk.remotemessage.ResultStatus

reason: string

batch: sdk.payments.Batch

Returns void

Parameters

result: sdk.remotepay.ResponseCode

reason: string

message: string

Returns void

onConfirmPayment

Parameters

payment: sdk.payments.Payment

challenges: sdk.base.Challenge[]

Returns void

onDeviceConnected

Returns void

onDeviceDisconnected

Returns void

onDeviceError

Parameters

errorEvent: sdk.remotepay.CloverDeviceErrorEvent

Returns void

onDeviceReady

Parameters

device: CloverDevice

drm: sdk.remotemessage.DiscoveryResponseMessage

Returns void

onFinishCancel

Returns void

Parameters

result: sdk.remotepay.ResponseCode

reason: string

message: string