CloverConnector
4.0.5
Copyright (C) 2018 Clover Network, Inc.
|
This is a default implementation of the ICloverConnectorListener that can be used for quickly creating applications by simply overriding the appropriate listener method(s) needed for testing a particular remote call. More...
Public Member Functions | |
abstract void | OnConfirmPaymentRequest (ConfirmPaymentRequest request) |
Called when the Clover device encounters a Challenge at the payment gateway and requires confirmation. A Challenge is triggered by a potential duplicate Payment (DUPLICATE_CHALLENGE) or an offline Payment (OFFLINE_CHALLENGE). The device sends an OnConfirmPaymentRequest() asking the merchant to reply by sending either an AcceptPayment() or RejectPayment() call. More... | |
virtual void | OnVaultCardResponse (VaultCardResponse response) |
Called in response to a VaultCard() request. Contains a { More... | |
virtual void | OnReadCardDataResponse (ReadCardDataResponse response) |
Called in response to a ReadCardData() request. Contains card information (specifically Track 1 and Track 2 card data). More... | |
virtual void | OnCapturePreAuthResponse (CapturePreAuthResponse response) |
Called in response to a CapturePreAuth() request. Contains the new Amount and TipAmount if successful. More... | |
virtual void | OnIncrementPreAuthResponse (IncrementPreAuthResponse response) |
Called in response to an IncrementPreAuth() request. Contains the authorization if successful. More... | |
virtual void | OnAuthResponse (AuthResponse response) |
Called in response to an Auth() request. Note: An Auth transaction may come back as a final Sale, depending on the payment gateway. The AuthResponse has a boolean IsAuth flag that indicates whether the Payment can still be tip-adjusted. More... | |
virtual void | OnPreAuthResponse (PreAuthResponse response) |
Called in response to a PreAuth() request. Note: The boolean IsPreAuth flag in the PreAuthResponse indicates whether CapturePreAuth() can be called for the returned Payment. If the IsPreAuth flag is false and the IsAuth flag is true, then the payment gateway coerced the PreAuth() request to an Auth. The payment will need to be voided or it will be automatically captured at closeout. More... | |
virtual void | OnTipAdjustAuthResponse (TipAdjustAuthResponse response) |
Called in response to a tip adjustment for an Auth transaction. Contains the TipAmount if successful. More... | |
virtual void | OnCloseoutResponse (CloseoutResponse response) |
Called in response to a Closeout() request. More... | |
virtual void | OnDeviceActivityEnd (CloverDeviceEvent deviceEvent) |
Called when the Clover device transitions away from a screen or activity. The CloverDeviceEvent passed in will contain an event type and description. Note: The start and end events are not guaranteed to process in order. The event type should be used to make sure these events are paired. More... | |
virtual void | OnDeviceActivityStart (CloverDeviceEvent deviceEvent) |
Called when the Clover device transitions to a new screen or activity. The CloverDeviceEvent passed in will contain an event type, a description, and a list of available InputOptions. More... | |
virtual void | OnDeviceConnected () |
Called when the Clover device is initially connected, but not ready to communicate. More... | |
virtual void | OnDeviceDisconnected () |
Called when the Clover device is disconnected from the CloverConnector or not responding. More... | |
virtual void | OnDeviceError (CloverDeviceErrorEvent deviceErrorEvent) |
Called when an error occurs while trying to send messages to the Clover device. More... | |
virtual void | OnDeviceReady (MerchantInfo merchantInfo) |
Called when the Clover device is ready to communicate and respond to requests. More... | |
virtual void | OnManualRefundResponse (ManualRefundResponse response) |
Called in response to a ManualRefund() request. Contains a { More... | |
virtual void | OnRefundPaymentResponse (RefundPaymentResponse response) |
Called in response to a RefundPayment() request. Contains a { More... | |
virtual void | OnSaleResponse (SaleResponse response) |
Called at the completion of a Sale() request. The SaleResponse contains a { More... | |
virtual void | OnVerifySignatureRequest (VerifySignatureRequest request) |
Called when the Clover device requests verification for a user's on-screen signature. The Payment and Signature will be passed in. More... | |
virtual void | OnVoidPaymentResponse (VoidPaymentResponse response) |
Called in response to a VoidPayment() request. Contains a { More... | |
virtual void | OnVoidPaymentRefundResponse (VoidPaymentRefundResponse response) |
Called in response to a VoidPaymentRefund() request with results. More... | |
virtual void | OnTipAdded (TipAddedMessage message) |
Called when a customer selects a tip amount on the Clover device's screen. More... | |
virtual void | OnRetrievePendingPaymentsResponse (RetrievePendingPaymentsResponse response) |
Called in response to a RetrievePendingPayment() request. More... | |
virtual void | OnCustomActivityResponse (CustomActivityResponse response) |
Called when a Custom Activity finishes normally. More... | |
virtual void | OnPrintManualRefundReceipt (PrintManualRefundReceiptMessage message) |
Called when a user requests a paper receipt for a Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request. More... | |
virtual void | OnPrintManualRefundDeclineReceipt (PrintManualRefundDeclineReceiptMessage message) |
Called when a user requests a paper receipt for a declined Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request. More... | |
virtual void | OnPrintPaymentReceipt (PrintPaymentReceiptMessage message) |
Called when a user requests a paper receipt for a Payment. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request. More... | |
virtual void | OnPrintPaymentDeclineReceipt (PrintPaymentDeclineReceiptMessage message) |
Called when a user requests a paper receipt for a declined Payment. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request. More... | |
virtual void | OnPrintPaymentMerchantCopyReceipt (PrintPaymentMerchantCopyReceiptMessage message) |
Called when a user requests a merchant copy of a Payment receipt. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request. More... | |
virtual void | OnPrintRefundPaymentReceipt (PrintRefundPaymentReceiptMessage message) |
Called when a user requests a paper receipt for a Payment Refund. Will only be called if DisablePrinting = true on the Sale(), Auth(), PreAuth() or ManualRefund() request. More... | |
virtual void | OnRetrieveDeviceStatusResponse (RetrieveDeviceStatusResponse response) |
Called in response to a RetrieveDeviceStatus() request. More... | |
virtual void | OnMessageFromActivity (MessageFromActivity response) |
Called when a Custom Activity sends a message to the POS. More... | |
virtual void | OnResetDeviceResponse (ResetDeviceResponse response) |
Called in response to a ResetDevice() request. More... | |
virtual void | OnRetrievePaymentResponse (RetrievePaymentResponse response) |
Called in response to a RetrievePayment() request. More... | |
virtual void | OnPrintJobStatusResponse (PrintJobStatusResponse response) |
Called in response to a RetrievePrintJobStatus() request. More... | |
virtual void | OnPrintJobStatusRequest (PrintJobStatusRequest request) |
Called in response to a RetrievePrintJobStatus() request. More... | |
virtual void | OnRetrievePrintersResponse (RetrievePrintersResponse response) |
Called in response to a RetrievePrinters() request. More... | |
virtual void | OnDisplayReceiptOptionsResponse (DisplayReceiptOptionsResponse response) |
Called in response to a DisplayReceiptOptions request. More... | |
virtual void | OnCustomerProvidedData (CustomerProvidedDataEvent response) |
Called when Loyalty API sends customer identifying data for a loyalty data type subscribed to in CloverConnector.RegisterForCustomerProvidedData() More... | |
virtual void | OnInvalidStateTransitionResponse (InvalidStateTransitionNotification notification) |
Called to notify the Point of Sale that a call was invalid in the current context or an internal state change failed. More... | |
Protected Member Functions | |
DefaultCloverConnectorListener (ICloverConnector cloverConnector) | |
This is a default implementation of the ICloverConnectorListener that can be used for quickly creating applications by simply overriding the appropriate listener method(s) needed for testing a particular remote call.
Also see the CloverEventConnector for another option to receive events instead of overriding the class and receiving method calls
Definition at line 356 of file ICloverConnectorListener.cs.
|
protected |
Definition at line 362 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to an Auth() request. Note: An Auth transaction may come back as a final Sale, depending on the payment gateway. The AuthResponse has a boolean IsAuth flag that indicates whether the Payment can still be tip-adjusted.
response | The AuthResponse to the transaction request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 383 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a CapturePreAuth() request. Contains the new Amount and TipAmount if successful.
response | The CapturePreAuthResponse to the transaction request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 375 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a Closeout() request.
response | The CloseoutResponse details for the transaction request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 395 of file ICloverConnectorListener.cs.
|
pure virtual |
Called when the Clover device encounters a Challenge at the payment gateway and requires confirmation. A Challenge is triggered by a potential duplicate Payment (DUPLICATE_CHALLENGE) or an offline Payment (OFFLINE_CHALLENGE). The device sends an OnConfirmPaymentRequest() asking the merchant to reply by sending either an AcceptPayment() or RejectPayment() call.
Note: Duplicate Payment Challenges are raised when multiple Payments are made with the same card type and last four digits within the same hour. For this reason, we recommend that you do not programmatically call CloverConnector.RejectPayment() on all instances of DUPLICATE_CHALLENGE. For more information, see with Challenges.
request | The ConfirmPaymentRequest for confirmation. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
|
virtual |
Called when a Custom Activity finishes normally.
response | The CustomActivityResponse. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 455 of file ICloverConnectorListener.cs.
|
virtual |
Called when Loyalty API sends customer identifying data for a loyalty data type subscribed to in CloverConnector.RegisterForCustomerProvidedData()
response | The CustomerProvidedDataEvent containing type and data payload, like PHONE, 555-1212 in type-specific custom encoding |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 515 of file ICloverConnectorListener.cs.
|
virtual |
Called when the Clover device transitions away from a screen or activity. The CloverDeviceEvent passed in will contain an event type and description. Note: The start and end events are not guaranteed to process in order. The event type should be used to make sure these events are paired.
deviceEvent | The CloverDeviceEvent event. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 399 of file ICloverConnectorListener.cs.
|
virtual |
Called when the Clover device transitions to a new screen or activity. The CloverDeviceEvent passed in will contain an event type, a description, and a list of available InputOptions.
deviceEvent | The CloverDeviceEvent event. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 403 of file ICloverConnectorListener.cs.
|
virtual |
Called when the Clover device is initially connected, but not ready to communicate.
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 407 of file ICloverConnectorListener.cs.
|
virtual |
Called when the Clover device is disconnected from the CloverConnector or not responding.
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 411 of file ICloverConnectorListener.cs.
|
virtual |
Called when an error occurs while trying to send messages to the Clover device.
deviceErrorEvent | The CloverDeviceErrorEvent event. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 415 of file ICloverConnectorListener.cs.
|
virtual |
Called when the Clover device is ready to communicate and respond to requests.
merchantInfo | The MerchantInfo details to associate with the device. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 419 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a DisplayReceiptOptions request.
response | The DisplayReceiptOptionsResponse details for the response. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 511 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to an IncrementPreAuth() request. Contains the authorization if successful.
response | The IncrementPreAuthResponse to the transaction |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 379 of file ICloverConnectorListener.cs.
|
virtual |
Called to notify the Point of Sale that a call was invalid in the current context or an internal state change failed.
message |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 519 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a ManualRefund() request. Contains a {
response | The ManualRefundResponse details for the transaction request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 423 of file ICloverConnectorListener.cs.
|
virtual |
Called when a Custom Activity sends a message to the POS.
response | The MessageFromActivity details. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 487 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a PreAuth() request. Note: The boolean IsPreAuth flag in the PreAuthResponse indicates whether CapturePreAuth() can be called for the returned Payment. If the IsPreAuth flag is false and the IsAuth flag is true, then the payment gateway coerced the PreAuth() request to an Auth. The payment will need to be voided or it will be automatically captured at closeout.
response | The PreAuthResponse details. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 387 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a RetrievePrintJobStatus() request.
request | The PrintJobStatusResponse details for the request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 503 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a RetrievePrintJobStatus() request.
response | The PrintJobStatusResponse details for the request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 499 of file ICloverConnectorListener.cs.
|
virtual |
Called when a user requests a paper receipt for a declined Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request.
message | The PrintManualRefundDeclineReceiptMessage. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 463 of file ICloverConnectorListener.cs.
|
virtual |
Called when a user requests a paper receipt for a Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request.
message | A callback that asks the POS to print a receipt for a ManualRefund. Contains a Credit object. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 459 of file ICloverConnectorListener.cs.
|
virtual |
Called when a user requests a paper receipt for a declined Payment. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request.
message | The PrintPaymentDeclineReceiptMessage details. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 471 of file ICloverConnectorListener.cs.
|
virtual |
Called when a user requests a merchant copy of a Payment receipt. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request.
message | The PrintPaymentMerchantCopyReceiptMessage details. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 475 of file ICloverConnectorListener.cs.
|
virtual |
Called when a user requests a paper receipt for a Payment. Will only be called if DisablePrinting = true on the Sale(), Auth(), or PreAuth() request.
message | The PrintPaymentReceiptMessage details. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 467 of file ICloverConnectorListener.cs.
|
virtual |
Called when a user requests a paper receipt for a Payment Refund. Will only be called if DisablePrinting = true on the Sale(), Auth(), PreAuth() or ManualRefund() request.
message | The PrintRefundPaymentReceiptMessage details. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 479 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a ReadCardData() request. Contains card information (specifically Track 1 and Track 2 card data).
response | The ReadCardDataResponse details for the request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 371 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a RefundPayment() request. Contains a {
response | The RefundPaymentResponse details for the transaction request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 427 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a ResetDevice() request.
response | The ResetDeviceResponse details for the request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 491 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a RetrieveDeviceStatus() request.
response | The RetrieveDeviceStatusResponse details for the request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 483 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a RetrievePayment() request.
response | The RetrievePaymentResponse details for the request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 495 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a RetrievePendingPayment() request.
response | The RetrievePendingPaymentsResponse details for the request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 451 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a RetrievePrinters() request.
response | The RetrievePrintersResponse details for the request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 507 of file ICloverConnectorListener.cs.
|
virtual |
Called at the completion of a Sale() request. The SaleResponse contains a {
response | The SaleResponse details for the transaction request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 431 of file ICloverConnectorListener.cs.
|
virtual |
Called when a customer selects a tip amount on the Clover device's screen.
message | The TipAddedMessage. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 447 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a tip adjustment for an Auth transaction. Contains the TipAmount if successful.
response | The TipAdjustAuthResponse to the transaction request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 391 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a VaultCard() request. Contains a {
response | The VaultCardResponse details for the request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 367 of file ICloverConnectorListener.cs.
|
virtual |
Called when the Clover device requests verification for a user's on-screen signature. The Payment and Signature will be passed in.
request | The VerifySignatureRequest. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 435 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a VoidPaymentRefund() request with results.
response |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 443 of file ICloverConnectorListener.cs.
|
virtual |
Called in response to a VoidPayment() request. Contains a {
response | The VoidPaymentResponse details for the transaction request. |
Implements com.clover.remotepay.sdk.ICloverConnectorListener.
Definition at line 439 of file ICloverConnectorListener.cs.