These are the methods to implement for intercepting messages that are sent from a Clover device. More...

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

Public Member Functions
void	OnDeviceActivityStart (CloverDeviceEvent deviceEvent)
	Called when a Clover device is activity starts. More...

void	OnDeviceActivityEnd (CloverDeviceEvent deviceEvent)
	Called when a Clover device is activity ends. More...

void	OnDeviceError (CloverDeviceErrorEvent deviceErrorEvent)
	Called when a Clover device is error event is encountered. More...

void	OnPreAuthResponse (PreAuthResponse response)
	Called when a pre authorization response message is sent. More...

void	OnAuthResponse (AuthResponse response)
	Called when an authorization response is sent from the Clover device. More...

void	OnTipAdjustAuthResponse (TipAdjustAuthResponse response)
	Called when a tip adjust authorization response is sent from the Clover device. More...

void	OnCapturePreAuthResponse (CapturePreAuthResponse response)
	Called when a capture pre authorization response is sent from the Clover device. More...

void	OnVerifySignatureRequest (VerifySignatureRequest request)
	Called when a verify signature request is sent from the Clover device. More...

void	OnConfirmPaymentRequest (ConfirmPaymentRequest request)
	Called when a confirm payment request is sent from the Clover device. More...

void	OnCloseoutResponse (CloseoutResponse response)
	Called when a closeout response is sent from the Clover device. More...

void	OnSaleResponse (SaleResponse response)
	Called when a sale response is sent from the Clover device. More...

void	OnManualRefundResponse (ManualRefundResponse response)
	Called when a manual refund response is sent from the Clover device. More...

void	OnRefundPaymentResponse (RefundPaymentResponse response)
	Called when a refund payment response is sent from the Clover device. More...

void	OnTipAdded (TipAddedMessage message)
	Called when a tip is added. More...

void	OnVoidPaymentResponse (VoidPaymentResponse response)
	Called when a void payment response is sent from the Clover device. More...

void	OnDeviceConnected ()
	Called when a Clover device is connected. More...

void	OnDeviceReady (MerchantInfo merchantInfo)
	Called when a Clover device is ready to receive communications from the CloverConnector. More...

void	OnDeviceDisconnected ()
	Called when a Clover device is disconnected from the CloverConnector. More...

void	OnVaultCardResponse (VaultCardResponse response)
	Called when a vault card response is sent from the Clover device. More...

void	OnRetrievePendingPaymentsResponse (RetrievePendingPaymentsResponse response)
	Called when a retrieve pending payments response is sent from the Clover device. More...

void	OnReadCardDataResponse (ReadCardDataResponse response)
	Called when a retrieve card data response is sent from the Clover device. More...

void	OnPrintManualRefundReceipt (PrintManualRefundReceiptMessage printManualRefundReceiptMessage)

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...

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...

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...

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...

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...

void	OnCustomActivityResponse (CustomActivityResponse response)

void	OnRetrieveDeviceStatusResponse (RetrieveDeviceStatusResponse response)

void	OnMessageFromActivity (MessageFromActivity response)

void	OnResetDeviceResponse (ResetDeviceResponse response)

void	OnRetrievePaymentResponse (RetrievePaymentResponse response)

Detailed Description

These are the methods to implement for intercepting messages that are sent from a Clover device.

Member Function Documentation

◆ OnAuthResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnAuthResponse ( AuthResponse response )

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

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnCapturePreAuthResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnCapturePreAuthResponse ( CapturePreAuthResponse response )

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

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnCloseoutResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnCloseoutResponse ( CloseoutResponse response )

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

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnConfirmPaymentRequest()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnConfirmPaymentRequest ( ConfirmPaymentRequest request )

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

Parameters

request The request.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnDeviceActivityEnd()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceActivityEnd ( CloverDeviceEvent deviceEvent )

Called when a Clover device is activity ends.

Parameters

deviceEvent The device event.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnDeviceActivityStart()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceActivityStart ( CloverDeviceEvent deviceEvent )

Called when a Clover device is activity starts.

Parameters

deviceEvent The device event.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnDeviceConnected()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceConnected ( )

Called when a Clover device is connected.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnDeviceDisconnected()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceDisconnected ( )

Called when a Clover device is disconnected from the CloverConnector.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnDeviceError()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceError ( CloverDeviceErrorEvent deviceErrorEvent )

Called when a Clover device is error event is encountered.

Parameters

deviceErrorEvent The device error event.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnDeviceReady()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnDeviceReady ( MerchantInfo merchantInfo )

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

Parameters

merchantInfo The merchant information.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnManualRefundResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnManualRefundResponse ( ManualRefundResponse response )

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

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnPreAuthResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnPreAuthResponse ( PreAuthResponse response )

Called when a pre authorization response message is sent.

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnPrintManualRefundDeclineReceipt()

void com.clover.remotepay.sdk.ICloverConnectorListener.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

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnPrintPaymentDeclineReceipt()

void com.clover.remotepay.sdk.ICloverConnectorListener.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

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnPrintPaymentMerchantCopyReceipt()

void com.clover.remotepay.sdk.ICloverConnectorListener.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

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnPrintPaymentReceipt()

void com.clover.remotepay.sdk.ICloverConnectorListener.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

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnPrintRefundPaymentReceipt()

void com.clover.remotepay.sdk.ICloverConnectorListener.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

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

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnReadCardDataResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnReadCardDataResponse ( ReadCardDataResponse response )

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

Parameters

response The 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

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnRefundPaymentResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnRefundPaymentResponse ( RefundPaymentResponse response )

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

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnRetrievePendingPaymentsResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnRetrievePendingPaymentsResponse ( RetrievePendingPaymentsResponse response )

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

Parameters

response

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnSaleResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnSaleResponse ( SaleResponse response )

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

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnTipAdded()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnTipAdded ( TipAddedMessage message )

Called when a tip is added.

Parameters

message The message.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnTipAdjustAuthResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnTipAdjustAuthResponse ( TipAdjustAuthResponse response )

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

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnVaultCardResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnVaultCardResponse ( VaultCardResponse response )

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

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnVerifySignatureRequest()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnVerifySignatureRequest ( VerifySignatureRequest request )

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

Parameters

request The request.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

◆ OnVoidPaymentResponse()

void com.clover.remotepay.sdk.ICloverConnectorListener.OnVoidPaymentResponse ( VoidPaymentResponse response )

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

Parameters

response The response.

Implemented in com.clover.remotepay.sdk.DefaultCloverConnectorListener.

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

lib/CloverConnector/com/clover/remotepay/sdk/ICloverConnectorListener.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ OnAuthResponse()

◆ OnCapturePreAuthResponse()

◆ OnCloseoutResponse()

◆ OnConfirmPaymentRequest()

◆ OnDeviceActivityEnd()

◆ OnDeviceActivityStart()

◆ OnDeviceConnected()

◆ OnDeviceDisconnected()

◆ OnDeviceError()

◆ OnDeviceReady()

◆ OnManualRefundResponse()

◆ OnPreAuthResponse()

◆ OnPrintManualRefundDeclineReceipt()

◆ OnPrintPaymentDeclineReceipt()

◆ OnPrintPaymentMerchantCopyReceipt()

◆ OnPrintPaymentReceipt()

◆ OnPrintRefundPaymentReceipt()

◆ OnReadCardDataResponse()

◆ OnRefundPaymentResponse()

◆ OnRetrievePendingPaymentsResponse()

◆ OnSaleResponse()

◆ OnTipAdded()

◆ OnTipAdjustAuthResponse()

◆ OnVaultCardResponse()

◆ OnVerifySignatureRequest()

◆ OnVoidPaymentResponse()