Class CloverDevice

Clover Device

Abstract clover device.

Hierarchy

CloverDevice
- DefaultCloverDevice

Index

Constructors

constructor

Properties

Constructors

constructor

new CloverDevice(packageName: string, transport: CloverTransport, applicationId: string): CloverDevice

- Defined in remote/client/device/CloverDevice.ts:16
Constructor

Parameters
- packageName: string
- transport: CloverTransport
- applicationId: string
Returns CloverDevice

Properties

Protected applicationId

applicationId: string

Protected deviceObservers

deviceObservers: CloverDeviceObserver[]

Protected packageName

packageName: string

Protected supportsAck

supportsAck: boolean = false

Protected transport

transport: CloverTransport

Methods

dispose

dispose(): void

- Defined in remote/client/device/CloverDevice.ts:182
Dispose

Returns void

doAcceptPayment

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

- Defined in remote/client/device/CloverDevice.ts:209
Accept Payment

Parameters
- payment: sdk.payments.Payment
Returns void

doCaptureAuth

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

- Defined in remote/client/device/CloverDevice.ts:89
Capture Auth

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

doCloseout

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

- Defined in remote/client/device/CloverDevice.ts:190
Closeout

Parameters
- allowOpenTabs: boolean
- batchId: string
Returns void

doDiscoveryRequest

doDiscoveryRequest(): void

- Defined in remote/client/device/CloverDevice.ts:57
Discovery request

Returns void

doKeyPress

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

- Defined in remote/client/device/CloverDevice.ts:72
Key Press

Parameters
- keyPress: sdk.remotemessage.KeyPress
Returns void

doOpenCashDrawer

doOpenCashDrawer(reason: string): void

- Defined in remote/client/device/CloverDevice.ts:163
Open Cash Drawer

Parameters
- reason: string
Returns void

doOrderUpdate

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

- Defined in remote/client/device/CloverDevice.ts:97
Order Update

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

doPaymentRefund

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

- Defined in remote/client/device/CloverDevice.ts:122
Payment Refund

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

doPrintImageObject

doPrintImageObject(bitmap: any): void

- Defined in remote/client/device/CloverDevice.ts:170
Print Image (Bitmap)

Parameters
- bitmap: any
Returns void

doPrintImageUrl

doPrintImageUrl(url: string): void

- Defined in remote/client/device/CloverDevice.ts:177
Print Image (URL)

Parameters
- url: string
Returns void

doPrintText

doPrintText(textLines: Array<string>): void

- Defined in remote/client/device/CloverDevice.ts:138
Print Text

Parameters
- textLines: Array<string>
Returns void

doReadCardData

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

- Defined in remote/client/device/CloverDevice.ts:229
Read Cart Data

Parameters
- payment: sdk.remotemessage.PayIntent
Returns void

doRejectPayment

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

- Defined in remote/client/device/CloverDevice.ts:217
Reject Payment

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

doResetDevice

doResetDevice(): void

- Defined in remote/client/device/CloverDevice.ts:202
Reset Device

Returns void

doRetrievePendingPayments

doRetrievePendingPayments(): void

- Defined in remote/client/device/CloverDevice.ts:222
Retrieve Pending Payments

Returns void

doShowPaymentReceiptScreen

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

- Defined in remote/client/device/CloverDevice.ts:151
Show Payment Receipt Screen

Parameters
- orderId: string
- paymentId: string
Returns void

doShowThankYouScreen

doShowThankYouScreen(): void

- Defined in remote/client/device/CloverDevice.ts:156
Show Thank You Screen

Returns void

doShowWelcomeScreen

doShowWelcomeScreen(): void

- Defined in remote/client/device/CloverDevice.ts:143
Show Welcome Screen

Returns void

doSignatureVerified

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

- Defined in remote/client/device/CloverDevice.ts:105
Signature Verified

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

doTerminalMessage

doTerminalMessage(text: string): void

- Defined in remote/client/device/CloverDevice.ts:112
Terminal Message

Parameters
- text: string
Returns void

doTipAdjustAuth

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

- Defined in remote/client/device/CloverDevice.ts:131
Tip Adjust Auth

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

doTxStart

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

- Defined in remote/client/device/CloverDevice.ts:65
Transaction Start

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

doVaultCard

doVaultCard(cardEntryMethods: number): void

- Defined in remote/client/device/CloverDevice.ts:197
Vault Card

Parameters
- cardEntryMethods: number
Returns void

doVoidPayment

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

- Defined in remote/client/device/CloverDevice.ts:80
Void Payment

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

setSupportsAcks

setSupportsAcks(supportsAck: boolean): void

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

Parameters
- supportsAck: boolean
Returns void

subscribe

subscribe(observer: CloverDeviceObserver): void

- 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

- 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

- 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