CloverConnector  3.0.2
Copyright (C) 2018 Clover Network, Inc.
com.clover.remotepay.sdk.CloverConnector Class Reference

More...

Inheritance diagram for com.clover.remotepay.sdk.CloverConnector:
com.clover.remotepay.sdk.ICloverConnector

Public Member Functions

void AddCloverConnectorListener (ICloverConnectorListener connectorListener)
 Adds a Clover Connector listener. More...
 
void RemoveCloverConnectorListener (ICloverConnectorListener connectorListener)
 Removes a Clover Connector listener. More...
 
 CloverConnector ()
 
 CloverConnector (CloverDeviceConfiguration config)
 CloverConnector constructor More...
 
void InitializeConnection ()
 Initialize the connector with a given configuration More...
 
void Sale (SaleRequest request)
 Sale method, aka "purchase" More...
 
void AcceptSignature (VerifySignatureRequest request)
 If signature is captured during a Sale, this method accepts the signature as entered More...
 
void RejectSignature (VerifySignatureRequest request)
 If signature is captured during a Sale, this method rejects the signature as entered More...
 
void Auth (AuthRequest request)
 Auth method to obtain an Auth. While a Pre-Auth can also be accomplished by setting the IsPreAuth flag to true, the PreAuthRequest is the preferred request type. PreAuth functionality was retained for backward compatibility More...
 
void PreAuth (PreAuthRequest request)
 PreAuth method to obtain a PreAuth. More...
 
void CapturePreAuth (CapturePreAuthRequest request)
 Capture a previous Auth. Note: Should only be called if request's PaymentID is from an AuthResponse More...
 
void TipAdjustAuth (TipAdjustAuthRequest request)
 Adjust the tip for a previous Auth. Note: Should only be called if request's PaymentID is from an AuthResponse More...
 
void VoidPayment (VoidPaymentRequest request)
 Void a transaction, given a previously used order ID and/or payment ID TBD - defining a payment or order ID to be used with a void without requiring a response from Sale() More...
 
void VoidPaymentRefund (VoidPaymentRefundRequest request)
 
void RefundPayment (RefundPaymentRequest request)
 Refund a specific payment More...
 
void ManualRefund (ManualRefundRequest request)
 Manual refund method, aka "naked credit" More...
 
void Closeout (CloseoutRequest request)
 Send a request to the server to closeout all orders. More...
 
void ResetDevice ()
 Send a request to the mini to reset. This can be used if the device gets into a non-recoverable state. More...
 
void ShowMessage (string message)
 Show a message on the Clover Mini screen More...
 
void SendDebugLog (string message)
 
void ShowWelcomeScreen ()
 Return the device to the Welcome Screen More...
 
void ShowThankYouScreen ()
 Show the thank you screen on the device More...
 
void VaultCard (int? CardEntryMethods)
 Vault Card information and payment token More...
 
void ReadCardData (ReadCardDataRequest request)
 Retrieve Card Data More...
 
void DisplayPaymentReceiptOptions (DisplayPaymentReceiptOptionsRequest request)
 Show the customer facing receipt option screen for the specified Payment. More...
 
void ShowDisplayOrder (DisplayOrder order)
 Show the DisplayOrder on the device. Replaces the existing DisplayOrder on the device. More...
 
void RemoveDisplayOrder (DisplayOrder order)
 Remove the DisplayOrder from the device. More...
 
void RetrievePendingPayments ()
 Request a list of pending payments from the device. Pending payments are payments taken offline that have not yet been sent to the server More...
 
void Dispose ()
 Disposes the connection to the Clover device. After this is called, the connection to the device is severed, and the CloverConnector object is no longer usable. Instantiate a new CloverConnector object in order to call InitializeConnection(). More...
 
void InvokeInputOption (InputOption io)
 Invoke the InputOption on the device More...
 
GetEnumFromString< T > (string stringValue, bool isCaseInsensitive=false)
 
void OnDeviceError (CloverDeviceErrorEvent ee)
 
void AcceptPayment (Payment payment)
 If Payment confirmation is required during a transaction due to a Challenge, this method accepts the Payment. A Challenge may be triggered by a potential duplicate Payment or an offline Payment. More...
 
void RejectPayment (Payment payment, Challenge challenge)
 If Payment confirmation is required during a transaction due to a Challenge, this method rejects the Payment. A Challenge may be triggered by a potential duplicate Payment or an offline Payment. More...
 
void StartCustomActivity (CustomActivityRequest request)
 Starts a Custom Activity on the Clover device. Note: The Custom Activity must already be set up and configured on the Clover device. More...
 
void SendMessageToActivity (MessageToActivity request)
 Sends a message to a Custom Activity running on a Clover device. More...
 
void RetrieveDeviceStatus (RetrieveDeviceStatusRequest request)
 Sends a message requesting the current status of the Clover device. More...
 
void RetrievePayment (RetrievePaymentRequest request)
 Requests the Payment information associated with the externalPaymentId passed in. Only valid for Payments made in the past 24 hours on the Clover device queried. More...
 
void OpenCashDrawer (OpenCashDrawerRequest request)
 Opens the first cash drawer found connected to the Clover device. The reason for opening the cash drawer must be provided. More...
 
void Print (PrintRequest request)
 Sends a print request using the PrintRequest object. Used to print text, Bitmap image objects, and images from URLs using the specified printer. More...
 
void RetrievePrinters (RetrievePrintersRequest request)
 Queries available printers attached to the Clover device using the RetrievePrintersRequest object. More...
 
void RetrievePrintJobStatus (PrintJobStatusRequest request)
 Queries the status of a print job using the PrintJobStatusRequest object. More...
 
void DisplayReceiptOptions (DisplayReceiptOptionsRequest request)
 Display receipt options for a Credit, Refund, or Payment More...
 
void RegisterForCustomerProvidedData (RegisterForCustomerProvidedDataRequest request)
 Register to receive customer data with the Clover Loyalty API More...
 
void SetCustomerInfo (SetCustomerInfoRequest request)
 Set the Loyalty API's current customer info More...
 
- Public Member Functions inherited from com.clover.remotepay.sdk.ICloverConnector
void InvokeInputOption (transport.InputOption io)
 Sends a keystroke to the Clover device that invokes an input option (OK, CANCEL, DONE, etc.) on the customer's behalf. InputOptions are on the CloverDeviceEvent passed to OnDeviceActivityStart(). More...
 

Public Attributes

const int CARD_ENTRY_METHOD_MAG_STRIPE = 1 | (1 << 8) | ENABLE_KIOSK_ENTRY_METHODS
 
const int CARD_ENTRY_METHOD_ICC_CONTACT = 2 | (2 << 8) | ENABLE_KIOSK_ENTRY_METHODS
 
const int CARD_ENTRY_METHOD_NFC_CONTACTLESS = 4 | (4 << 8) | ENABLE_KIOSK_ENTRY_METHODS
 
const int CARD_ENTRY_METHOD_MANUAL = 8 | (8 << 8) | ENABLE_KIOSK_ENTRY_METHODS
 

Protected Attributes

CloverDevice Device
 
CloverDeviceConfiguration Config
 

Properties

SDKInfo SDKInfo [get, protected set]
 
bool IsReady [get]
 Holds the current connection state More...
 

Detailed Description

Definition at line 37 of file CloverConnector.cs.

Constructor & Destructor Documentation

◆ CloverConnector() [1/2]

com.clover.remotepay.sdk.CloverConnector.CloverConnector ( )

Definition at line 89 of file CloverConnector.cs.

◆ CloverConnector() [2/2]

com.clover.remotepay.sdk.CloverConnector.CloverConnector ( CloverDeviceConfiguration  config)

CloverConnector constructor

Parameters
configA CloverDeviceConfiguration object; TestDeviceConfiguration can be used for testing

Definition at line 100 of file CloverConnector.cs.

Member Function Documentation

◆ AcceptPayment()

void com.clover.remotepay.sdk.CloverConnector.AcceptPayment ( Payment  payment)

If Payment confirmation is required during a transaction due to a Challenge, this method accepts the Payment. A Challenge may be triggered by a potential duplicate Payment or an offline Payment.

Parameters
paymentThe Payment to accept.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1259 of file CloverConnector.cs.

◆ AcceptSignature()

void com.clover.remotepay.sdk.CloverConnector.AcceptSignature ( VerifySignatureRequest  request)

If signature is captured during a Sale, this method accepts the signature as entered

Parameters
request
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 304 of file CloverConnector.cs.

◆ AddCloverConnectorListener()

void com.clover.remotepay.sdk.CloverConnector.AddCloverConnectorListener ( ICloverConnectorListener  connectorListener)

Adds a Clover Connector listener.

Parameters
connectorListenerThe connection listener.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 73 of file CloverConnector.cs.

◆ Auth()

void com.clover.remotepay.sdk.CloverConnector.Auth ( AuthRequest  request)

Auth method to obtain an Auth. While a Pre-Auth can also be accomplished by setting the IsPreAuth flag to true, the PreAuthRequest is the preferred request type. PreAuth functionality was retained for backward compatibility

Parameters
request
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 367 of file CloverConnector.cs.

◆ CapturePreAuth()

void com.clover.remotepay.sdk.CloverConnector.CapturePreAuth ( CapturePreAuthRequest  request)

Capture a previous Auth. Note: Should only be called if request's PaymentID is from an AuthResponse

Parameters
request
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 555 of file CloverConnector.cs.

◆ Closeout()

void com.clover.remotepay.sdk.CloverConnector.Closeout ( CloseoutRequest  request)

Send a request to the server to closeout all orders.

Parameters
request
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 880 of file CloverConnector.cs.

◆ DisplayPaymentReceiptOptions()

void com.clover.remotepay.sdk.CloverConnector.DisplayPaymentReceiptOptions ( DisplayPaymentReceiptOptionsRequest  request)

Show the customer facing receipt option screen for the specified Payment.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1108 of file CloverConnector.cs.

◆ DisplayReceiptOptions()

void com.clover.remotepay.sdk.CloverConnector.DisplayReceiptOptions ( DisplayReceiptOptionsRequest  request)

Display receipt options for a Credit, Refund, or Payment

Parameters
requestThe DisplayReceiptOptionsRequest details

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1495 of file CloverConnector.cs.

◆ Dispose()

void com.clover.remotepay.sdk.CloverConnector.Dispose ( )

Disposes the connection to the Clover device. After this is called, the connection to the device is severed, and the CloverConnector object is no longer usable. Instantiate a new CloverConnector object in order to call InitializeConnection().

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1212 of file CloverConnector.cs.

◆ GetEnumFromString< T >()

T com.clover.remotepay.sdk.CloverConnector.GetEnumFromString< T > ( string  stringValue,
bool  isCaseInsensitive = false 
)
Type Constraints
T :struct 
T :IConvertible 

Definition at line 1244 of file CloverConnector.cs.

◆ InitializeConnection()

void com.clover.remotepay.sdk.CloverConnector.InitializeConnection ( )

Initialize the connector with a given configuration

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 112 of file CloverConnector.cs.

◆ InvokeInputOption()

void com.clover.remotepay.sdk.CloverConnector.InvokeInputOption ( InputOption  io)

Invoke the InputOption on the device

Parameters
io

Definition at line 1224 of file CloverConnector.cs.

◆ ManualRefund()

void com.clover.remotepay.sdk.CloverConnector.ManualRefund ( ManualRefundRequest  request)

Manual refund method, aka "naked credit"

Parameters
requestA ManualRefundRequest object
Returns
Status code, 0 for success, -1 for failure (need to use pre-defined constants)

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 799 of file CloverConnector.cs.

◆ OnDeviceError()

void com.clover.remotepay.sdk.CloverConnector.OnDeviceError ( CloverDeviceErrorEvent  ee)

Definition at line 1254 of file CloverConnector.cs.

◆ OpenCashDrawer()

void com.clover.remotepay.sdk.CloverConnector.OpenCashDrawer ( OpenCashDrawerRequest  request)

Opens the first cash drawer found connected to the Clover device. The reason for opening the cash drawer must be provided.

Parameters
requestRequest with text specifying the reason for opening the cash drawer.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1380 of file CloverConnector.cs.

◆ PreAuth()

void com.clover.remotepay.sdk.CloverConnector.PreAuth ( PreAuthRequest  request)

PreAuth method to obtain a PreAuth.

Parameters
request
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 469 of file CloverConnector.cs.

◆ Print()

void com.clover.remotepay.sdk.CloverConnector.Print ( PrintRequest  request)

Sends a print request using the PrintRequest object. Used to print text, Bitmap image objects, and images from URLs using the specified printer.

Parameters
requestThe PrintRequest details.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1400 of file CloverConnector.cs.

◆ ReadCardData()

void com.clover.remotepay.sdk.CloverConnector.ReadCardData ( ReadCardDataRequest  request)

Retrieve Card Data

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1068 of file CloverConnector.cs.

◆ RefundPayment()

void com.clover.remotepay.sdk.CloverConnector.RefundPayment ( RefundPaymentRequest  request)

Refund a specific payment

Parameters
request
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 736 of file CloverConnector.cs.

◆ RegisterForCustomerProvidedData()

void com.clover.remotepay.sdk.CloverConnector.RegisterForCustomerProvidedData ( RegisterForCustomerProvidedDataRequest  request)

Register to receive customer data with the Clover Loyalty API

Parameters
request

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1524 of file CloverConnector.cs.

◆ RejectPayment()

void com.clover.remotepay.sdk.CloverConnector.RejectPayment ( Payment  payment,
Challenge  challenge 
)

If Payment confirmation is required during a transaction due to a Challenge, this method rejects the Payment. A Challenge may be triggered by a potential duplicate Payment or an offline Payment.

Parameters
paymentThe Payment to accept.
challengeThe Challenge that resulted in Payment rejection.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1279 of file CloverConnector.cs.

◆ RejectSignature()

void com.clover.remotepay.sdk.CloverConnector.RejectSignature ( VerifySignatureRequest  request)

If signature is captured during a Sale, this method rejects the signature as entered

Parameters
request
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 334 of file CloverConnector.cs.

◆ RemoveCloverConnectorListener()

void com.clover.remotepay.sdk.CloverConnector.RemoveCloverConnectorListener ( ICloverConnectorListener  connectorListener)

Removes a Clover Connector listener.

Parameters
connectorListenerThe connection listener.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 81 of file CloverConnector.cs.

◆ RemoveDisplayOrder()

void com.clover.remotepay.sdk.CloverConnector.RemoveDisplayOrder ( DisplayOrder  order)

Remove the DisplayOrder from the device.

Parameters
order

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1166 of file CloverConnector.cs.

◆ ResetDevice()

void com.clover.remotepay.sdk.CloverConnector.ResetDevice ( )

Send a request to the mini to reset. This can be used if the device gets into a non-recoverable state.

Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 904 of file CloverConnector.cs.

◆ RetrieveDeviceStatus()

void com.clover.remotepay.sdk.CloverConnector.RetrieveDeviceStatus ( RetrieveDeviceStatusRequest  request)

Sends a message requesting the current status of the Clover device.

Parameters
requestThe RetrieveDeviceStatusRequest details.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1344 of file CloverConnector.cs.

◆ RetrievePayment()

void com.clover.remotepay.sdk.CloverConnector.RetrievePayment ( RetrievePaymentRequest  request)

Requests the Payment information associated with the externalPaymentId passed in. Only valid for Payments made in the past 24 hours on the Clover device queried.

Parameters
requestThe RetrievePaymentRequest details.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1360 of file CloverConnector.cs.

◆ RetrievePendingPayments()

void com.clover.remotepay.sdk.CloverConnector.RetrievePendingPayments ( )

Request a list of pending payments from the device. Pending payments are payments taken offline that have not yet been sent to the server

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1194 of file CloverConnector.cs.

◆ RetrievePrinters()

void com.clover.remotepay.sdk.CloverConnector.RetrievePrinters ( RetrievePrintersRequest  request)

Queries available printers attached to the Clover device using the RetrievePrintersRequest object.

Parameters
requestThe RetrievePrintersRequest details.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1451 of file CloverConnector.cs.

◆ RetrievePrintJobStatus()

void com.clover.remotepay.sdk.CloverConnector.RetrievePrintJobStatus ( PrintJobStatusRequest  request)

Queries the status of a print job using the PrintJobStatusRequest object.

Parameters
requestThe PrintJobStatusRequest details.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1471 of file CloverConnector.cs.

◆ Sale()

void com.clover.remotepay.sdk.CloverConnector.Sale ( SaleRequest  request)

Sale method, aka "purchase"

Parameters
requestA SaleRequest object containing basic information needed for the transaction
Returns
Status code, 0 for success, -1 for failure (need to use pre-defined constants)

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 141 of file CloverConnector.cs.

◆ SendDebugLog()

void com.clover.remotepay.sdk.CloverConnector.SendDebugLog ( string  message)

Definition at line 939 of file CloverConnector.cs.

◆ SendMessageToActivity()

void com.clover.remotepay.sdk.CloverConnector.SendMessageToActivity ( MessageToActivity  request)

Sends a message to a Custom Activity running on a Clover device.

Parameters
requestThe MessageToActivity details to send to the Custom Activity.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1324 of file CloverConnector.cs.

◆ SetCustomerInfo()

void com.clover.remotepay.sdk.CloverConnector.SetCustomerInfo ( SetCustomerInfoRequest  request)

Set the Loyalty API's current customer info

Parameters
request

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1548 of file CloverConnector.cs.

◆ ShowDisplayOrder()

void com.clover.remotepay.sdk.CloverConnector.ShowDisplayOrder ( DisplayOrder  order)

Show the DisplayOrder on the device. Replaces the existing DisplayOrder on the device.

Parameters
order

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1142 of file CloverConnector.cs.

◆ ShowMessage()

void com.clover.remotepay.sdk.CloverConnector.ShowMessage ( string  message)

Show a message on the Clover Mini screen

Parameters
message
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 924 of file CloverConnector.cs.

◆ ShowThankYouScreen()

void com.clover.remotepay.sdk.CloverConnector.ShowThankYouScreen ( )

Show the thank you screen on the device

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 980 of file CloverConnector.cs.

◆ ShowWelcomeScreen()

void com.clover.remotepay.sdk.CloverConnector.ShowWelcomeScreen ( )

Return the device to the Welcome Screen

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 962 of file CloverConnector.cs.

◆ StartCustomActivity()

void com.clover.remotepay.sdk.CloverConnector.StartCustomActivity ( CustomActivityRequest  request)

Starts a Custom Activity on the Clover device. Note: The Custom Activity must already be set up and configured on the Clover device.

Parameters
requestThe CustomActivityRequest details.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1304 of file CloverConnector.cs.

◆ TipAdjustAuth()

void com.clover.remotepay.sdk.CloverConnector.TipAdjustAuth ( TipAdjustAuthRequest  request)

Adjust the tip for a previous Auth. Note: Should only be called if request's PaymentID is from an AuthResponse

Parameters
request
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 605 of file CloverConnector.cs.

◆ VaultCard()

void com.clover.remotepay.sdk.CloverConnector.VaultCard ( int?  CardEntryMethods)

Vault Card information and payment token

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1042 of file CloverConnector.cs.

◆ VoidPayment()

void com.clover.remotepay.sdk.CloverConnector.VoidPayment ( VoidPaymentRequest  request)

Void a transaction, given a previously used order ID and/or payment ID TBD - defining a payment or order ID to be used with a void without requiring a response from Sale()

Parameters
requestA VoidRequest object containing basic information needed to void the transaction
Returns
Status code, 0 for success, -1 for failure (need to use pre-defined constants)

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 656 of file CloverConnector.cs.

◆ VoidPaymentRefund()

void com.clover.remotepay.sdk.CloverConnector.VoidPaymentRefund ( VoidPaymentRefundRequest  request)

Parameters
request

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 710 of file CloverConnector.cs.

Member Data Documentation

◆ CARD_ENTRY_METHOD_ICC_CONTACT

const int com.clover.remotepay.sdk.CloverConnector.CARD_ENTRY_METHOD_ICC_CONTACT = 2 | (2 << 8) | ENABLE_KIOSK_ENTRY_METHODS

Definition at line 41 of file CloverConnector.cs.

◆ CARD_ENTRY_METHOD_MAG_STRIPE

const int com.clover.remotepay.sdk.CloverConnector.CARD_ENTRY_METHOD_MAG_STRIPE = 1 | (1 << 8) | ENABLE_KIOSK_ENTRY_METHODS

Definition at line 40 of file CloverConnector.cs.

◆ CARD_ENTRY_METHOD_MANUAL

const int com.clover.remotepay.sdk.CloverConnector.CARD_ENTRY_METHOD_MANUAL = 8 | (8 << 8) | ENABLE_KIOSK_ENTRY_METHODS

Definition at line 43 of file CloverConnector.cs.

◆ CARD_ENTRY_METHOD_NFC_CONTACTLESS

const int com.clover.remotepay.sdk.CloverConnector.CARD_ENTRY_METHOD_NFC_CONTACTLESS = 4 | (4 << 8) | ENABLE_KIOSK_ENTRY_METHODS

Definition at line 42 of file CloverConnector.cs.

◆ Config

CloverDeviceConfiguration com.clover.remotepay.sdk.CloverConnector.Config
protected

Definition at line 47 of file CloverConnector.cs.

◆ Device

CloverDevice com.clover.remotepay.sdk.CloverConnector.Device
protected

Definition at line 46 of file CloverConnector.cs.

Property Documentation

◆ IsReady

bool com.clover.remotepay.sdk.CloverConnector.IsReady
get

Holds the current connection state

Definition at line 68 of file CloverConnector.cs.

◆ SDKInfo

SDKInfo com.clover.remotepay.sdk.CloverConnector.SDKInfo
getprotected set

Definition at line 49 of file CloverConnector.cs.


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