CloverConnector  1.4.0
Copyright (C) 2017 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 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 Cancel ()
 Cancels the device from waiting for payment card More...
 
void ShowMessage (string message)
 Show a message on the Clover Mini screen More...
 
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 (string orderId, string paymentId)
 Show the customer facing receipt option screen for the specified Payment. More...
 
void OpenCashDrawer (String reason)
 Will trigger cash drawer to open that is connected to Clover Mini 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 ()
 
void InvokeInputOption (InputOption io)
 Invoke the InputOption on the device More...
 
void PrintImageFromURL (string ImgURL)
 
GetEnumFromString< T > (string stringValue, bool isCaseInsensitive=false)
 
void OnDeviceError (CloverDeviceErrorEvent ee)
 
void AcceptPayment (Payment payment)
 If signature is captured during a Sale, this method accepts the signature as entered More...
 
void RejectPayment (Payment payment, Challenge challenge)
 If signature is captured during a Sale, this method rejects the signature as entered More...
 
void StartCustomActivity (CustomActivityRequest request)
 Request to start a Custom Activity on the Clover device More...
 
void SendMessageToActivity (MessageToActivity request)
 Send a message to a running custom activity on the Clover device More...
 
void RetrieveDeviceStatus (RetrieveDeviceStatusRequest request)
 Send a message requesting the current status of the device More...
 
void RetrievePayment (RetrievePaymentRequest request)
 Send a message requesting the Payment information corresponding the the provided External Payment Id More...
 
void OpenCashDrawer (OpenCashDrawerRequest request)
 Will trigger cash drawer to open that is connected to Clover Mini More...
 
void Print (PrintRequest request)
 Print image from a PrintRequest More...
 
void RetrievePrinters (RetrievePrintersRequest request)
 Retrieve printer list from RetrievePrintersRequest More...
 
void RetrievePrintJobStatus (PrintJobStatusRequest request)
 Retrieve printer job status from PrintJobStatusRequest More...
 
void PrintText (List< string > messages)
 Print simple lines of text to the Clover Mini printer More...
 
void PrintImage (Bitmap bitmap)
 Print an image on the Clover Mini printer More...
 
- Public Member Functions inherited from com.clover.remotepay.sdk.ICloverConnector
void DisplayPaymentReceiptOptions (String orderId, String paymentId)
 Show the customer facing receipt option screen for the specified payment. More...
 
void InvokeInputOption (transport.InputOption io)
 Invoke the InputOption as sent in the DeviceActivityStart callback More...
 
void PrintImageFromURL (String ImgURL)
 Print an image from a url 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
 

Static Public Attributes

static readonly InputOption CANCEL_INPUT_OPTION = new InputOption(KeyPress.ESC, "Cancel")
 
static long MAX_PAYLOAD_SIZE = 10000000
 

Protected Attributes

CloverDevice Device
 
CloverDeviceConfiguration Config
 
SDKInfo _SDKInfo = new SDKInfo()
 

Properties

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

Detailed Description

Definition at line 34 of file CloverConnector.cs.

Constructor & Destructor Documentation

◆ CloverConnector() [1/2]

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

Definition at line 88 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 99 of file CloverConnector.cs.

Member Function Documentation

◆ AcceptPayment()

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

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 1188 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 281 of file CloverConnector.cs.

◆ AddCloverConnectorListener()

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

Adds a clover connector listener.

Parameters
connectorListenerThe connector listener.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 78 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 343 of file CloverConnector.cs.

◆ Cancel()

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

Cancels the device from waiting for payment card

Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 819 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 505 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 781 of file CloverConnector.cs.

◆ DisplayPaymentReceiptOptions()

void com.clover.remotepay.sdk.CloverConnector.DisplayPaymentReceiptOptions ( string  orderId,
string  paymentId 
)

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

Definition at line 1004 of file CloverConnector.cs.

◆ Dispose()

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

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1123 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 1173 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 111 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 1135 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 711 of file CloverConnector.cs.

◆ OnDeviceError()

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

Definition at line 1183 of file CloverConnector.cs.

◆ OpenCashDrawer() [1/2]

void com.clover.remotepay.sdk.CloverConnector.OpenCashDrawer ( String  reason)

Will trigger cash drawer to open that is connected to Clover Mini

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1032 of file CloverConnector.cs.

◆ OpenCashDrawer() [2/2]

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

Will trigger cash drawer to open that is connected to Clover Mini

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1292 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 432 of file CloverConnector.cs.

◆ Print()

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

Print image from a PrintRequest

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1297 of file CloverConnector.cs.

◆ PrintImage()

void com.clover.remotepay.sdk.CloverConnector.PrintImage ( Bitmap  bitmap)

Print an image on the Clover Mini printer

Parameters
bitmap
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1347 of file CloverConnector.cs.

◆ PrintImageFromURL()

void com.clover.remotepay.sdk.CloverConnector.PrintImageFromURL ( string  ImgURL)

Definition at line 1154 of file CloverConnector.cs.

◆ PrintText()

void com.clover.remotepay.sdk.CloverConnector.PrintText ( List< string >  messages)

Print simple lines of text to the Clover Mini printer

Parameters
messages
Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1327 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 967 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 649 of file CloverConnector.cs.

◆ RejectPayment()

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

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 1207 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 310 of file CloverConnector.cs.

◆ RemoveCloverConnectorListener()

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

Removes a clover connector listener.

Parameters
connectorListenerThe connector listener.

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 83 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 1079 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 800 of file CloverConnector.cs.

◆ RetrieveDeviceStatus()

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

Send a message requesting the current status of the device

Parameters
request

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1264 of file CloverConnector.cs.

◆ RetrievePayment()

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

Send a message requesting the Payment information corresponding the the provided External Payment Id

Parameters
request

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1278 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 1106 of file CloverConnector.cs.

◆ RetrievePrinters()

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

Retrieve printer list from RetrievePrintersRequest

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1317 of file CloverConnector.cs.

◆ RetrievePrintJobStatus()

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

Retrieve printer job status from PrintJobStatusRequest

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1322 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 133 of file CloverConnector.cs.

◆ SendMessageToActivity()

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

Send a message to a running custom activity on the Clover device

Parameters
request

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1245 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 1055 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 840 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 876 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 858 of file CloverConnector.cs.

◆ StartCustomActivity()

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

Request to start a Custom Activity on the Clover device

Implements com.clover.remotepay.sdk.ICloverConnector.

Definition at line 1226 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 555 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 940 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 606 of file CloverConnector.cs.

Member Data Documentation

◆ _SDKInfo

SDKInfo com.clover.remotepay.sdk.CloverConnector._SDKInfo = new SDKInfo()
protected

Definition at line 44 of file CloverConnector.cs.

◆ CANCEL_INPUT_OPTION

readonly InputOption com.clover.remotepay.sdk.CloverConnector.CANCEL_INPUT_OPTION = new InputOption(KeyPress.ESC, "Cancel")
static

Definition at line 41 of file CloverConnector.cs.

◆ 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 38 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 37 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 40 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 39 of file CloverConnector.cs.

◆ Config

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

Definition at line 43 of file CloverConnector.cs.

◆ Device

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

Definition at line 42 of file CloverConnector.cs.

◆ MAX_PAYLOAD_SIZE

long com.clover.remotepay.sdk.CloverConnector.MAX_PAYLOAD_SIZE = 10000000
static

Definition at line 45 of file CloverConnector.cs.

Property Documentation

◆ IsReady

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

Holds the current connection state

Definition at line 71 of file CloverConnector.cs.

◆ SDKInfo

SDKInfo com.clover.remotepay.sdk.CloverConnector.SDKInfo
get

Definition at line 47 of file CloverConnector.cs.


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