Class CloverConnector

Clover Connector

The clover connector implements the ICloverConnector interface. This is where we define how the connector interacts with remote pay adapters.

Hierarchy

CloverConnector
- LegacyCloverConnector

Implements

any

Index

Classes

InnerDeviceObserver

Constructors

constructor

Properties

Methods

Constructors

constructor

new CloverConnector(config: CloverDeviceConfiguration): CloverConnector

- Defined in remote/client/CloverConnector.ts:51
Parameters
- config: CloverDeviceConfiguration
Returns CloverConnector

Properties

broadcaster

broadcaster: CloverConnectorBroadcaster = new CloverConnectorBroadcaster()

Private cardEntryMethods

cardEntryMethods: number = CardEntryMethods.DEFAULT

Private configuration

configuration: CloverDeviceConfiguration

device

device: CloverDevice

Private deviceObserver

deviceObserver: InnerDeviceObserver

isReady

isReady: boolean = false

lastRequest

lastRequest: any

Protected logger

logger: Logger = Logger.create()

merchantInfo

merchantInfo: sdk.remotepay.MerchantInfo

Static CANCEL_INPUT_OPTION

CANCEL_INPUT_OPTION: sdk.remotemessage.InputOption

Methods

acceptPayment

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

- Defined in remote/client/CloverConnector.ts:292
Parameters
- payment: sdk.payments.Payment
Returns void

acceptSignature

acceptSignature(request: sdk.remotepay.VerifySignatureRequest): void

- Defined in remote/client/CloverConnector.ts:266
Parameters
- request: sdk.remotepay.VerifySignatureRequest
Returns void

addCloverConnectorListener

addCloverConnectorListener(connectorListener: sdk.remotepay.ICloverConnectorListener): void

- Defined in remote/client/CloverConnector.ts:93
Add new listener to receive broadcast notifications

Parameters
- connectorListener: sdk.remotepay.ICloverConnectorListener
  
  the listener to add
Returns void

auth

auth(request: sdk.remotepay.AuthRequest): void

- Defined in remote/client/CloverConnector.ts:320
Parameters
- request: sdk.remotepay.AuthRequest
Returns void

cancel

cancel(): void

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

capturePreAuth

capturePreAuth(request: sdk.remotepay.CapturePreAuthRequest): void

- Defined in remote/client/CloverConnector.ts:400
Parameters
- request: sdk.remotepay.CapturePreAuthRequest
Returns void

closeout

closeout(request: sdk.remotepay.CloseoutRequest): void

- Defined in remote/client/CloverConnector.ts:620
Parameters
- request: sdk.remotepay.CloseoutRequest
Returns void

displayPaymentReceiptOptions

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

- Defined in remote/client/CloverConnector.ts:712
Parameters
- orderId: string
- paymentId: string
Returns void

dispose

dispose(): void

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

Private getCardEntryMethods

getCardEntryMethods(): number

- Defined in remote/client/CloverConnector.ts:787
Returns number

initialize

initialize(config: CloverDeviceConfiguration): void

- Defined in remote/client/CloverConnector.ts:71
Initialize the connector with a new config

Parameters
- config: CloverDeviceConfiguration
  
  the configuration for the connector
Returns void

initializeConnection

initializeConnection(): void

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

invokeInputOption

invokeInputOption(io: sdk.remotemessage.InputOption): void

- Defined in remote/client/CloverConnector.ts:769
Parameters
- io: sdk.remotemessage.InputOption
Returns void

manualRefund

manualRefund(request: sdk.remotepay.ManualRefundRequest): void

- Defined in remote/client/CloverConnector.ts:540
Parameters
- request: sdk.remotepay.ManualRefundRequest
Returns void

notifyDeviceError

notifyDeviceError(errorType: sdk.remotepay.ErrorType, errorCode: sdk.remotepay.DeviceErrorEventCode, message: string): void

- Defined in remote/client/CloverConnector.ts:258
Parameters
- errorType: sdk.remotepay.ErrorType
- errorCode: sdk.remotepay.DeviceErrorEventCode
- message: string
Returns void

notifyDeviceNotConnected

notifyDeviceNotConnected(message: string): void

- Defined in remote/client/CloverConnector.ts:246
Parameters
- message: string
Returns void

notifyInvalidData

notifyInvalidData(message: string): void

- Defined in remote/client/CloverConnector.ts:252
Parameters
- message: string
Returns void

openCashDrawer

openCashDrawer(reason: string): void

- Defined in remote/client/CloverConnector.ts:727
Parameters
- reason: string
Returns void

preAuth

preAuth(request: sdk.remotepay.PreAuthRequest): void

- Defined in remote/client/CloverConnector.ts:356
Parameters
- request: sdk.remotepay.PreAuthRequest
Returns void

printImage

printImage(bitmap: HTMLImageElement): void

- Defined in remote/client/CloverConnector.ts:648
Parameters
- bitmap: HTMLImageElement
Returns void

printImageFromURL

printImageFromURL(url: string): void

- Defined in remote/client/CloverConnector.ts:660
Parameters
- url: string
Returns void

printText

printText(messages: Array<string>): void

- Defined in remote/client/CloverConnector.ts:638
Parameters
- messages: Array<string>
Returns void

readCardData

readCardData(request: sdk.remotepay.ReadCardDataRequest): void

- Defined in remote/client/CloverConnector.ts:601
Parameters
- request: sdk.remotepay.ReadCardDataRequest
Returns void

refundPayment

refundPayment(request: sdk.remotepay.RefundPaymentRequest): void

- Defined in remote/client/CloverConnector.ts:498
Parameters
- request: sdk.remotepay.RefundPaymentRequest
Returns void

rejectPayment

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

- Defined in remote/client/CloverConnector.ts:305
Parameters
- payment: sdk.payments.Payment
- challenge: sdk.base.Challenge
Returns void

rejectSignature

rejectSignature(request: sdk.remotepay.VerifySignatureRequest): void

- Defined in remote/client/CloverConnector.ts:279
Parameters
- request: sdk.remotepay.VerifySignatureRequest
Returns void

removeCloverConnectorListener

removeCloverConnectorListener(connectorListener: sdk.remotepay.ICloverConnectorListener): void

- Defined in remote/client/CloverConnector.ts:102
Remove a listener

Parameters
- connectorListener: sdk.remotepay.ICloverConnectorListener
  
  the listener to remove
Returns void

removeDisplayOrder

removeDisplayOrder(order: sdk.order.DisplayOrder): void

- Defined in remote/client/CloverConnector.ts:748
Parameters
- order: sdk.order.DisplayOrder
Returns void

resetDevice

resetDevice(): void

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

retrievePendingPayments

retrievePendingPayments(): void

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

sale

sale(request: sdk.remotepay.SaleRequest): void

- Defined in remote/client/CloverConnector.ts:109
Parameters
- request: sdk.remotepay.SaleRequest
Returns void

Private saleAuth

saleAuth(request: sdk.remotepay.TransactionRequest, suppressTipScreen: boolean): void

- Defined in remote/client/CloverConnector.ts:150
A common PayIntent builder method for Sale, Auth and PreAuth

Parameters
- request: sdk.remotepay.TransactionRequest
- suppressTipScreen: boolean
Returns void

showDisplayOrder

showDisplayOrder(order: sdk.order.DisplayOrder): void

- Defined in remote/client/CloverConnector.ts:736
Parameters
- order: sdk.order.DisplayOrder
Returns void

showMessage

showMessage(message: string): void

- Defined in remote/client/CloverConnector.ts:672
Parameters
- message: string
Returns void

showPaymentReceiptOptions

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

- Defined in remote/client/CloverConnector.ts:708
Incompatibility between sdks! Old cloud had this.

deprecated

Parameters
- orderId: string
- paymentId: string
Returns void

showThankYouScreen

showThankYouScreen(): void

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

showWelcomeScreen

showWelcomeScreen(): void

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

tipAdjustAuth

tipAdjustAuth(request: sdk.remotepay.TipAdjustAuthRequest): void

- Defined in remote/client/CloverConnector.ts:443
Parameters
- request: sdk.remotepay.TipAdjustAuthRequest
Returns void

vaultCard

vaultCard(cardEntryMethods: number): void

- Defined in remote/client/CloverConnector.ts:464
Parameters
- cardEntryMethods: number
Returns void

voidPayment

voidPayment(request: sdk.remotepay.VoidPaymentRequest): void

- Defined in remote/client/CloverConnector.ts:476
Parameters
- request: sdk.remotepay.VoidPaymentRequest
Returns void

Static Private getV3TipModeFromRequestTipMode

getV3TipModeFromRequestTipMode(saleTipMode: sdk.payments.TipMode): sdk.payments.TipMode

- Defined in remote/client/CloverConnector.ts:235
Parameters
- saleTipMode: sdk.payments.TipMode
Returns sdk.payments.TipMode

Static populateBaseResponse

populateBaseResponse(response: sdk.remotepay.BaseResponse, success: boolean, result: sdk.remotepay.ResponseCode, reason?: string, message?: string): void

- Defined in remote/client/CloverConnector.ts:791
Parameters
- response: sdk.remotepay.BaseResponse
- success: boolean
- result: sdk.remotepay.ResponseCode
- Optional reason: string
- Optional message: string
Returns void

Static populatePaymentResponse

populatePaymentResponse(response: sdk.remotepay.PaymentResponse, success: boolean, result: sdk.remotepay.ResponseCode, payment: sdk.payments.Payment, signature?: sdk.base.Signature, reason?: string, message?: string): void

- Defined in remote/client/CloverConnector.ts:802
Parameters
- response: sdk.remotepay.PaymentResponse
- success: boolean
- result: sdk.remotepay.ResponseCode
- payment: sdk.payments.Payment
- Optional signature: sdk.base.Signature
- Optional reason: string
- Optional message: string
Returns void

Generated using TypeDoc