com.clover.remotepay.sdk.ICloverConnector Interface Reference

Interface to define the available methods to send requests to a connected Clover device. More...

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

Public Member Functions
void	InitializeConnection ()
	Starts communication with the device. This is called after the connector is created and listeners are added to the connector. More...
void	AddCloverConnectorListener (ICloverConnectorListener connectorListener)
	Adds a clover connector listener. More...
void	RemoveCloverConnectorListener (ICloverConnectorListener connectorListener)
	Removes a clover connector listener. 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	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	Auth (AuthRequest request)
	Auth method to obtain an Auth or Pre-Auth, based on the AuthRequest IsPreAuth flag More...
void	PreAuth (PreAuthRequest request)
	Auth method to obtain an Auth or Pre-Auth, based on the AuthRequest IsPreAuth flag 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	VaultCard (int? CardEntryMethods)
	Vault card, used to get payment token
void	ReadCardData (ReadCardDataRequest CardDataRequest)
	Retrieve Card Data
void	Cancel ()
	Cancels the device from waiting for a payment card. More...
void	Closeout (CloseoutRequest request)
	Send a request to the server to closeout all orders. More...
void	ResetDevice ()
	Send a request to the server to reset the Clover device. 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	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	Dispose ()
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...
void	RetrievePendingPayments ()
	Request a list of payments taken offline, but that haven't been processed yet 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...

Detailed Description

Interface to define the available methods to send requests to a connected Clover device.

Member Function Documentation

AcceptPayment()

void com.clover.remotepay.sdk.ICloverConnector.AcceptPayment

(

Payment

payment

)

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

Parameters

request

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

AcceptSignature()

void com.clover.remotepay.sdk.ICloverConnector.AcceptSignature

(

VerifySignatureRequest

request

)

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

Parameters

request

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

AddCloverConnectorListener()

void com.clover.remotepay.sdk.ICloverConnector.AddCloverConnectorListener

(

ICloverConnectorListener

connectorListener

)

Adds a clover connector listener.

Parameters

connectorListener

The connector listener.

Implemented in com.clover.remotepay.sdk.CloverConnector.

Auth()

void com.clover.remotepay.sdk.ICloverConnector.Auth

(

AuthRequest

request

)

Auth method to obtain an Auth or Pre-Auth, based on the AuthRequest IsPreAuth flag

Parameters

request

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

Cancel()

void com.clover.remotepay.sdk.ICloverConnector.Cancel

(

)

Cancels the device from waiting for a payment card.

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

CapturePreAuth()

void com.clover.remotepay.sdk.ICloverConnector.CapturePreAuth

(

CapturePreAuthRequest

request

)

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

Parameters

request

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

Closeout()

void com.clover.remotepay.sdk.ICloverConnector.Closeout

(

CloseoutRequest

request

)

Send a request to the server to closeout all orders.

Parameters

request

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

DisplayPaymentReceiptOptions()

void com.clover.remotepay.sdk.ICloverConnector.DisplayPaymentReceiptOptions	(	String	orderId,
		String	paymentId
	)

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

InitializeConnection()

void com.clover.remotepay.sdk.ICloverConnector.InitializeConnection

(

)

Starts communication with the device. This is called after the connector is created and listeners are added to the connector.

Implemented in com.clover.remotepay.sdk.CloverConnector.

InvokeInputOption()

void com.clover.remotepay.sdk.ICloverConnector.InvokeInputOption

(

transport.InputOption

io

)

Invoke the InputOption as sent in the DeviceActivityStart callback

Parameters

io

ManualRefund()

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

Implemented in com.clover.remotepay.sdk.CloverConnector.

OpenCashDrawer()

void com.clover.remotepay.sdk.ICloverConnector.OpenCashDrawer

(

String

reason

)

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

Implemented in com.clover.remotepay.sdk.CloverConnector.

PreAuth()

void com.clover.remotepay.sdk.ICloverConnector.PreAuth

(

PreAuthRequest

request

)

Auth method to obtain an Auth or Pre-Auth, based on the AuthRequest IsPreAuth flag

Parameters

request

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

PrintImage()

void com.clover.remotepay.sdk.ICloverConnector.PrintImage

(

Bitmap

bitmap

)

Print an image on the Clover Mini printer

Parameters

bitmap

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

PrintImageFromURL()

void com.clover.remotepay.sdk.ICloverConnector.PrintImageFromURL

(

String

ImgURL

)

Print an image from a url

Parameters

ImgURL

PrintText()

void com.clover.remotepay.sdk.ICloverConnector.PrintText

(

List< string >

messages

)

Print simple lines of text to the Clover Mini printer

Parameters

messages

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

RefundPayment()

void com.clover.remotepay.sdk.ICloverConnector.RefundPayment

(

RefundPaymentRequest

request

)

Refund a specific payment

Parameters

request

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

RejectPayment()

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

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

Parameters

request

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

RejectSignature()

void com.clover.remotepay.sdk.ICloverConnector.RejectSignature

(

VerifySignatureRequest

request

)

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

Parameters

request

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

RemoveCloverConnectorListener()

void com.clover.remotepay.sdk.ICloverConnector.RemoveCloverConnectorListener

(

ICloverConnectorListener

connectorListener

)

Removes a clover connector listener.

Parameters

connectorListener

The connector listener.

Implemented in com.clover.remotepay.sdk.CloverConnector.

RemoveDisplayOrder()

void com.clover.remotepay.sdk.ICloverConnector.RemoveDisplayOrder

(

DisplayOrder

order

)

Remove the DisplayOrder from the device.

Parameters

order

Implemented in com.clover.remotepay.sdk.CloverConnector.

ResetDevice()

void com.clover.remotepay.sdk.ICloverConnector.ResetDevice

(

)

Send a request to the server to reset the Clover device.

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

RetrieveDeviceStatus()

void com.clover.remotepay.sdk.ICloverConnector.RetrieveDeviceStatus

(

RetrieveDeviceStatusRequest

request

)

Send a message requesting the current status of the device

Parameters

request

Implemented in com.clover.remotepay.sdk.CloverConnector.

RetrievePayment()

void com.clover.remotepay.sdk.ICloverConnector.RetrievePayment

(

RetrievePaymentRequest

request

)

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

Parameters

request

Implemented in com.clover.remotepay.sdk.CloverConnector.

RetrievePendingPayments()

void com.clover.remotepay.sdk.ICloverConnector.RetrievePendingPayments

(

)

Request a list of payments taken offline, but that haven't been processed yet

Implemented in com.clover.remotepay.sdk.CloverConnector.

Sale()

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

Implemented in com.clover.remotepay.sdk.CloverConnector.

SendMessageToActivity()

void com.clover.remotepay.sdk.ICloverConnector.SendMessageToActivity

(

MessageToActivity

request

)

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

Parameters

request

Implemented in com.clover.remotepay.sdk.CloverConnector.

ShowDisplayOrder()

void com.clover.remotepay.sdk.ICloverConnector.ShowDisplayOrder

(

DisplayOrder

order

)

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

Parameters

order

Implemented in com.clover.remotepay.sdk.CloverConnector.

ShowMessage()

void com.clover.remotepay.sdk.ICloverConnector.ShowMessage

(

string

message

)

Show a message on the Clover Mini screen

Parameters

message

Returns

Implemented in com.clover.remotepay.sdk.CloverConnector.

ShowThankYouScreen()

void com.clover.remotepay.sdk.ICloverConnector.ShowThankYouScreen

(

)

Show the thank you screen on the device

Implemented in com.clover.remotepay.sdk.CloverConnector.

ShowWelcomeScreen()

void com.clover.remotepay.sdk.ICloverConnector.ShowWelcomeScreen

(

)

Return the device to the Welcome Screen

Implemented in com.clover.remotepay.sdk.CloverConnector.

StartCustomActivity()

void com.clover.remotepay.sdk.ICloverConnector.StartCustomActivity

(

CustomActivityRequest

request

)

Request to start a Custom Activity on the Clover device

Implemented in com.clover.remotepay.sdk.CloverConnector.

TipAdjustAuth()

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

Implemented in com.clover.remotepay.sdk.CloverConnector.

VoidPayment()

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

Implemented in com.clover.remotepay.sdk.CloverConnector.

---

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

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