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

Public Member Functions
void	AddCloverConnectorListener (ICloverConnectorListener connectorListener)
	Adds a clover connector listener. More...

void	RemoveCloverConnectorListener (ICloverConnectorListener connectorListener)
	Removes a clover connector listener. More...

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

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)

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

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")

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

Constructor & Destructor Documentation

◆ CloverConnector()

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

CloverConnector constructor

Parameters

config A CloverDeviceConfiguration object; TestDeviceConfiguration can be used for testing

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.

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

◆ AddCloverConnectorListener()

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

Adds a clover connector listener.

Parameters

connectorListener The connector listener.

Implements com.clover.remotepay.sdk.ICloverConnector.

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

◆ Cancel()

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

Cancels the device from waiting for payment card

Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

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

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

◆ DisplayPaymentReceiptOptions()

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

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

◆ InitializeConnection()

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

Initialize the connector with a given configuration

Implements com.clover.remotepay.sdk.ICloverConnector.

◆ InvokeInputOption()

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

Invoke the InputOption on the device

Parameters

io

◆ ManualRefund()

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

Manual refund method, aka "naked credit"

Parameters

request A ManualRefundRequest object

Returns: Status code, 0 for success, -1 for failure (need to use pre-defined constants)

Implements com.clover.remotepay.sdk.ICloverConnector.

◆ OpenCashDrawer()

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.

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

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

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

◆ ReadCardData()

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

Retrieve Card Data

Implements com.clover.remotepay.sdk.ICloverConnector.

◆ RefundPayment()

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

Refund a specific payment

Parameters

request

Returns

Implements com.clover.remotepay.sdk.ICloverConnector.

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

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

◆ RemoveCloverConnectorListener()

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

Removes a clover connector listener.

Parameters

connectorListener The connector listener.

Implements com.clover.remotepay.sdk.ICloverConnector.

◆ RemoveDisplayOrder()

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

Remove the DisplayOrder from the device.

Parameters

order

Implements com.clover.remotepay.sdk.ICloverConnector.

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

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

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

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

◆ Sale()

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

Sale method, aka "purchase"

Parameters

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

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

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

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

◆ ShowThankYouScreen()

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

Show the thank you screen on the device

Implements com.clover.remotepay.sdk.ICloverConnector.

◆ ShowWelcomeScreen()

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

Return the device to the Welcome Screen

Implements com.clover.remotepay.sdk.ICloverConnector.

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

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

◆ VaultCard()

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

Vault Card information and payment token

Implements com.clover.remotepay.sdk.ICloverConnector.

◆ 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

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

Property Documentation

◆ IsReady

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

get

Holds the current connection state

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

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

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CloverConnector()

Member Function Documentation

◆ AcceptPayment()

◆ AcceptSignature()

◆ AddCloverConnectorListener()

◆ Auth()

◆ Cancel()

◆ CapturePreAuth()

◆ Closeout()

◆ DisplayPaymentReceiptOptions()

◆ InitializeConnection()

◆ InvokeInputOption()

◆ ManualRefund()

◆ OpenCashDrawer()

◆ PreAuth()

◆ PrintImage()

◆ PrintText()

◆ ReadCardData()

◆ RefundPayment()

◆ RejectPayment()

◆ RejectSignature()

◆ RemoveCloverConnectorListener()

◆ RemoveDisplayOrder()

◆ ResetDevice()

◆ RetrieveDeviceStatus()

◆ RetrievePayment()

◆ RetrievePendingPayments()

◆ Sale()

◆ SendMessageToActivity()

◆ ShowDisplayOrder()

◆ ShowMessage()

◆ ShowThankYouScreen()

◆ ShowWelcomeScreen()

◆ StartCustomActivity()

◆ TipAdjustAuth()

◆ VaultCard()

◆ VoidPayment()

Property Documentation

◆ IsReady