CloverConnector  1.4.0
Copyright (C) 2017 Clover Network, Inc.
com.clover.remotepay.sdk.DefaultCloverConnectorListener Class Referenceabstract

This is a default implementation of the ICloverConnectorListener that can be used for quickly creating example applications by simply overriding the appropriate listener method(s) needed for testing a particular remote call. More...

Inheritance diagram for com.clover.remotepay.sdk.DefaultCloverConnectorListener:
com.clover.remotepay.sdk.ICloverConnectorListener

Public Member Functions

 DefaultCloverConnectorListener (ICloverConnector cloverConnector)
 
virtual void OnVaultCardResponse (VaultCardResponse response)
 Called when a vault card response is sent from the Clover device. More...
 
virtual void OnReadCardDataResponse (ReadCardDataResponse response)
 Called when a retrieve card data response is sent from the Clover device. More...
 
virtual void OnCapturePreAuthResponse (CapturePreAuthResponse response)
 Called when a capture pre authorization response is sent from the Clover device. More...
 
virtual void OnAuthResponse (AuthResponse response)
 Called when an authorization response is sent from the Clover device. More...
 
virtual void OnPreAuthResponse (PreAuthResponse response)
 Called when a pre authorization response message is sent. More...
 
virtual void OnTipAdjustAuthResponse (TipAdjustAuthResponse response)
 Called when a tip adjust authorization response is sent from the Clover device. More...
 
virtual void OnCloseoutResponse (CloseoutResponse response)
 Called when a closeout response is sent from the Clover device. More...
 
virtual void OnDeviceActivityEnd (CloverDeviceEvent deviceEvent)
 Called when a Clover device is activity ends. More...
 
virtual void OnDeviceActivityStart (CloverDeviceEvent deviceEvent)
 Called when a Clover device is activity starts. More...
 
virtual void OnDeviceConnected ()
 Called when a Clover device is connected. More...
 
virtual void OnDeviceDisconnected ()
 Called when a Clover device is disconnected from the CloverConnector. More...
 
virtual void OnDeviceError (CloverDeviceErrorEvent deviceErrorEvent)
 Called when a Clover device is error event is encountered. More...
 
virtual void OnDeviceReady (MerchantInfo merchantInfo)
 Called when a Clover device is ready to receive communications from the CloverConnector. More...
 
virtual void OnManualRefundResponse (ManualRefundResponse response)
 Called when a manual refund response is sent from the Clover device. More...
 
virtual void OnRefundPaymentResponse (RefundPaymentResponse response)
 Called when a refund payment response is sent from the Clover device. More...
 
virtual void OnSaleResponse (SaleResponse response)
 Called when a sale response is sent from the Clover device. More...
 
virtual void OnVerifySignatureRequest (VerifySignatureRequest request)
 Called when a verify signature request is sent from the Clover device. More...
 
abstract void OnConfirmPaymentRequest (ConfirmPaymentRequest request)
 Called when a confirm payment request is sent from the Clover device. More...
 
virtual void OnVoidPaymentResponse (VoidPaymentResponse response)
 Called when a void payment response is sent from the Clover device. More...
 
virtual void OnTipAdded (TipAddedMessage message)
 Called when a tip is added. More...
 
virtual void OnRetrievePendingPaymentsResponse (RetrievePendingPaymentsResponse response)
 Called when a retrieve pending payments response is sent from the Clover device. More...
 
virtual void OnCustomActivityResponse (CustomActivityResponse response)
 
virtual void OnPrintManualRefundReceipt (PrintManualRefundReceiptMessage printManualRefundReceiptMessage)
 
virtual void OnPrintManualRefundDeclineReceipt (PrintManualRefundDeclineReceiptMessage printManualRefundDeclineReceiptMessage)
 Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined ManualRefund More...
 
virtual void OnPrintPaymentReceipt (PrintPaymentReceiptMessage printPaymentReceiptMessage)
 Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment More...
 
virtual void OnPrintPaymentDeclineReceipt (PrintPaymentDeclineReceiptMessage printPaymentDeclineReceiptMessage)
 Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined payment More...
 
virtual void OnPrintPaymentMerchantCopyReceipt (PrintPaymentMerchantCopyReceiptMessage printPaymentMerchantCopyReceiptMessage)
 Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a merchant copy of a payment receipt More...
 
virtual void OnPrintRefundPaymentReceipt (PrintRefundPaymentReceiptMessage printRefundPaymentReceiptMessage)
 Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment refund More...
 
virtual void OnRetrieveDeviceStatusResponse (RetrieveDeviceStatusResponse response)
 
virtual void OnMessageFromActivity (MessageFromActivity response)
 
virtual void OnResetDeviceResponse (ResetDeviceResponse response)
 
virtual void OnRetrievePaymentResponse (RetrievePaymentResponse response)
 
virtual void OnPrintJobStatusResponse (PrintJobStatusResponse response)
 
virtual void OnPrintJobStatusRequest (PrintJobStatusRequest request)
 
virtual void OnRetrievePrintersResponse (RetrievePrintersResponse response)
 
virtual void OnRetrievePrintersRequest (RetrievePrintersRequest request)
 

Detailed Description

This is a default implementation of the ICloverConnectorListener that can be used for quickly creating example applications by simply overriding the appropriate listener method(s) needed for testing a particular remote call.

Definition at line 195 of file ICloverConnectorListener.cs.

Constructor & Destructor Documentation

◆ DefaultCloverConnectorListener()

com.clover.remotepay.sdk.DefaultCloverConnectorListener.DefaultCloverConnectorListener ( ICloverConnector  cloverConnector)

Definition at line 199 of file ICloverConnectorListener.cs.

Member Function Documentation

◆ OnAuthResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnAuthResponse ( AuthResponse  response)
virtual

Called when an authorization response is sent from the Clover device.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 219 of file ICloverConnectorListener.cs.

◆ OnCapturePreAuthResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnCapturePreAuthResponse ( CapturePreAuthResponse  response)
virtual

Called when a capture pre authorization response is sent from the Clover device.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 214 of file ICloverConnectorListener.cs.

◆ OnCloseoutResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnCloseoutResponse ( CloseoutResponse  response)
virtual

Called when a closeout response is sent from the Clover device.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 234 of file ICloverConnectorListener.cs.

◆ OnConfirmPaymentRequest()

abstract void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnConfirmPaymentRequest ( ConfirmPaymentRequest  request)
pure virtual

Called when a confirm payment request is sent from the Clover device.

Parameters
requestThe request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

◆ OnCustomActivityResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnCustomActivityResponse ( CustomActivityResponse  response)
virtual

◆ OnDeviceActivityEnd()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceActivityEnd ( CloverDeviceEvent  deviceEvent)
virtual

Called when a Clover device is activity ends.

Parameters
deviceEventThe device event.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 239 of file ICloverConnectorListener.cs.

◆ OnDeviceActivityStart()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceActivityStart ( CloverDeviceEvent  deviceEvent)
virtual

Called when a Clover device is activity starts.

Parameters
deviceEventThe device event.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 244 of file ICloverConnectorListener.cs.

◆ OnDeviceConnected()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceConnected ( )
virtual

Called when a Clover device is connected.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 249 of file ICloverConnectorListener.cs.

◆ OnDeviceDisconnected()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceDisconnected ( )
virtual

Called when a Clover device is disconnected from the CloverConnector.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 254 of file ICloverConnectorListener.cs.

◆ OnDeviceError()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceError ( CloverDeviceErrorEvent  deviceErrorEvent)
virtual

Called when a Clover device is error event is encountered.

Parameters
deviceErrorEventThe device error event.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 259 of file ICloverConnectorListener.cs.

◆ OnDeviceReady()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceReady ( MerchantInfo  merchantInfo)
virtual

Called when a Clover device is ready to receive communications from the CloverConnector.

Parameters
merchantInfoThe merchant information.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 264 of file ICloverConnectorListener.cs.

◆ OnManualRefundResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnManualRefundResponse ( ManualRefundResponse  response)
virtual

Called when a manual refund response is sent from the Clover device.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 269 of file ICloverConnectorListener.cs.

◆ OnMessageFromActivity()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnMessageFromActivity ( MessageFromActivity  response)
virtual

◆ OnPreAuthResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPreAuthResponse ( PreAuthResponse  response)
virtual

Called when a pre authorization response message is sent.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 224 of file ICloverConnectorListener.cs.

◆ OnPrintJobStatusRequest()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintJobStatusRequest ( PrintJobStatusRequest  request)
virtual

◆ OnPrintJobStatusResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintJobStatusResponse ( PrintJobStatusResponse  response)
virtual

◆ OnPrintManualRefundDeclineReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintManualRefundDeclineReceipt ( PrintManualRefundDeclineReceiptMessage  printManualRefundDeclineReceiptMessage)
virtual

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined ManualRefund

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 316 of file ICloverConnectorListener.cs.

◆ OnPrintManualRefundReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintManualRefundReceipt ( PrintManualRefundReceiptMessage  printManualRefundReceiptMessage)
virtual

◆ OnPrintPaymentDeclineReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintPaymentDeclineReceipt ( PrintPaymentDeclineReceiptMessage  printPaymentDeclineReceiptMessage)
virtual

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined payment

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 326 of file ICloverConnectorListener.cs.

◆ OnPrintPaymentMerchantCopyReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintPaymentMerchantCopyReceipt ( PrintPaymentMerchantCopyReceiptMessage  printPaymentMerchantCopyReceiptMessage)
virtual

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a merchant copy of a payment receipt

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 331 of file ICloverConnectorListener.cs.

◆ OnPrintPaymentReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintPaymentReceipt ( PrintPaymentReceiptMessage  printPaymentReceiptMessage)
virtual

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 321 of file ICloverConnectorListener.cs.

◆ OnPrintRefundPaymentReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintRefundPaymentReceipt ( PrintRefundPaymentReceiptMessage  printRefundPaymentReceiptMessage)
virtual

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment refund

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 336 of file ICloverConnectorListener.cs.

◆ OnReadCardDataResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnReadCardDataResponse ( ReadCardDataResponse  response)
virtual

Called when a retrieve card data response is sent from the Clover device.

Parameters
responseThe response.

summary> Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a ManualRefund

Parameters
printManualRefundReceiptMessage

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 209 of file ICloverConnectorListener.cs.

◆ OnRefundPaymentResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRefundPaymentResponse ( RefundPaymentResponse  response)
virtual

Called when a refund payment response is sent from the Clover device.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 274 of file ICloverConnectorListener.cs.

◆ OnResetDeviceResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnResetDeviceResponse ( ResetDeviceResponse  response)
virtual

◆ OnRetrieveDeviceStatusResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRetrieveDeviceStatusResponse ( RetrieveDeviceStatusResponse  response)
virtual

◆ OnRetrievePaymentResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRetrievePaymentResponse ( RetrievePaymentResponse  response)
virtual

◆ OnRetrievePendingPaymentsResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRetrievePendingPaymentsResponse ( RetrievePendingPaymentsResponse  response)
virtual

Called when a retrieve pending payments response is sent from the Clover device.

Parameters
response

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 301 of file ICloverConnectorListener.cs.

◆ OnRetrievePrintersRequest()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRetrievePrintersRequest ( RetrievePrintersRequest  request)
virtual

◆ OnRetrievePrintersResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRetrievePrintersResponse ( RetrievePrintersResponse  response)
virtual

summary> Called when a custom activity is terminated in a normal flow /summary>

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 371 of file ICloverConnectorListener.cs.

◆ OnSaleResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnSaleResponse ( SaleResponse  response)
virtual

Called when a sale response is sent from the Clover device.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 279 of file ICloverConnectorListener.cs.

◆ OnTipAdded()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnTipAdded ( TipAddedMessage  message)
virtual

Called when a tip is added.

Parameters
messageThe message.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 296 of file ICloverConnectorListener.cs.

◆ OnTipAdjustAuthResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnTipAdjustAuthResponse ( TipAdjustAuthResponse  response)
virtual

Called when a tip adjust authorization response is sent from the Clover device.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 229 of file ICloverConnectorListener.cs.

◆ OnVaultCardResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnVaultCardResponse ( VaultCardResponse  response)
virtual

Called when a vault card response is sent from the Clover device.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 204 of file ICloverConnectorListener.cs.

◆ OnVerifySignatureRequest()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnVerifySignatureRequest ( VerifySignatureRequest  request)
virtual

Called when a verify signature request is sent from the Clover device.

Parameters
requestThe request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 284 of file ICloverConnectorListener.cs.

◆ OnVoidPaymentResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnVoidPaymentResponse ( VoidPaymentResponse  response)
virtual

Called when a void payment response is sent from the Clover device.

Parameters
responseThe response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 291 of file ICloverConnectorListener.cs.


The documentation for this class was generated from the following file: