Options
All
  • Public
  • Public/Protected
  • All
Menu

Device definition that has Cloud specific implementation details.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected applicationId

applicationId: string

Protected deviceObservers

deviceObservers: CloverDeviceObserver[]

Protected logger

logger: Logger = Logger.create()

Protected messageParser

messageParser: RemoteMessageParser = RemoteMessageParser.getDefaultInstance()

Protected packageName

packageName: string

Protected supportsAck

supportsAck: boolean = false

Protected transport

transport: CloverTransport

Methods

Protected addTaskForAck

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

Protected buildRemoteMessageToSend

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

dispose

  • dispose(): void

Private disposeWithoutMessage

  • disposeWithoutMessage(): void

doAcceptPayment

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

doCaptureAuth

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

doCloseout

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

doDiscoveryRequest

  • doDiscoveryRequest(): void

doKeyPress

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

doOpenCashDrawer

  • doOpenCashDrawer(reason: string): void

doOrderUpdate

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

doPaymentRefund

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

doPrintImageObject

  • doPrintImageObject(bitmap: any): void

doPrintImageUrl

  • doPrintImageUrl(url: string): void

doPrintText

  • doPrintText(textLines: Array<string>): void

doReadCardData

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

doRejectPayment

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

doResetDevice

  • doResetDevice(): void

doRetrievePendingPayments

  • doRetrievePendingPayments(): void

doShowPaymentReceiptScreen

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

doShowThankYouScreen

  • doShowThankYouScreen(): void

doShowWelcomeScreen

  • doShowWelcomeScreen(): void

doSignatureVerified

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

doTerminalMessage

  • doTerminalMessage(text: string): void

doTipAdjustAuth

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

doTxStart

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

doVaultCard

  • doVaultCard(cardEntryMethods: number): void

doVoidPayment

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

getApplicationId

  • getApplicationId(): string

Protected handleRemoteMessage

  • handleRemoteMessage(rMessage: sdk.remotemessage.RemoteMessage): void
  • Handles the "RESET" message that originates from the server. This message is a request that the connection be severed and re-established. This is done because open long-lived connections can cause load balancers or other proxy type servers to hang when an attempt to restart them is made.

    Parameters

    • rMessage: sdk.remotemessage.RemoteMessage

    Returns void

Protected handleRemoteMessageCOMMAND

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

Protected handleRemoteMessageEVENT

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

Protected handleRemoteMessagePING

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

Protected handleRemoteMessagePONG

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

Protected handleRemoteMessageQUERY

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

notifyObserverTxStart

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

notifyObserverVaultCardResponse

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

notifyObserversCapturePreAuth

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

notifyObserversCashbackSelected

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

notifyObserversCloseout

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

notifyObserversConfirmPayment

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

notifyObserversFinishCancel

  • notifyObserversFinishCancel(): void

notifyObserversFinishOk

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

Private notifyObserversForceConnect

  • notifyObserversForceConnect(message: sdk.remotemessage.ForceConnectMessage): void

notifyObserversKeyPressed

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

notifyObserversPartialAuth

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

notifyObserversPaymentRefundResponse

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

notifyObserversPaymentVoided

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

notifyObserversPendingPaymentsResponse

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

notifyObserversTipAdded

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

notifyObserversTipAdjusted

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

notifyObserversTxState

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

notifyObserversUiState

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

notifyObserversVerifySignature

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

onDeviceConnected

onDeviceDisconnected

onDeviceReady

onMessage

  • onMessage(message: string): void

sendObjectMessage

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

Protected sendRemoteMessage

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

setSupportsAcks

  • setSupportsAcks(supportsAck: boolean): void

subscribe

supportsAcks

  • supportsAcks(): boolean

unsubscribe

Generated using TypeDoc