Skip navigation links
A B C D G I M N O P R S T V W 

A

acceptPayment(Payment) - Method in class com.clover.remote.client.CloverConnector
 
acceptPayment(Payment) - Method in interface com.clover.remote.client.ICloverConnector
If payment confirmation is required during a Sale, this method accepts the payment
acceptSignature(VerifySignatureRequest) - Method in class com.clover.remote.client.CloverConnector
 
acceptSignature(VerifySignatureRequest) - Method in interface com.clover.remote.client.ICloverConnector
If signature is captured during a Sale, this method accepts the signature as entered
ActivityMessage - Class in com.clover.remote.client.messages
Base class for custom activity message communication
ActivityMessage(String, String) - Constructor for class com.clover.remote.client.messages.ActivityMessage
Constructor
addCloverConnectorListener(ICloverConnectorListener) - Method in class com.clover.remote.client.CloverConnector
Registers the provided listener to receive callbacks and events from the underlying device connection.
addCloverConnectorListener(ICloverConnectorListener) - Method in interface com.clover.remote.client.ICloverConnector
Adds a clover connection listener.
addObserver(ICloverTransportObserver) - Method in class com.clover.remote.client.transport.CloverTransport
 
addObserver(ICloverTransportObserver) - Method in interface com.clover.remote.client.transport.ICloverTransport
Registers a listener to receive connect events and messages from the transport
auth(AuthRequest) - Method in class com.clover.remote.client.CloverConnector
 
auth(AuthRequest) - Method in interface com.clover.remote.client.ICloverConnector
Auth method to obtain an Auth payment that can be used as the payment to call tipAdjust
AuthRequest - Class in com.clover.remote.client.messages
Request object for requesting an auth transaction.
AuthRequest(long, String) - Constructor for class com.clover.remote.client.messages.AuthRequest
Constructor
AuthResponse - Class in com.clover.remote.client.messages
Response object for an auth transaction request.
AuthResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.AuthResponse
Constructor

B

BaseRequest - Class in com.clover.remote.client.messages
The base for requests
BaseRequest() - Constructor for class com.clover.remote.client.messages.BaseRequest
 
BaseResponse - Class in com.clover.remote.client.messages
The base for responses
BaseResponse() - Constructor for class com.clover.remote.client.messages.BaseResponse
 
BaseResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.BaseResponse
Constructor

C

cancel() - Method in class com.clover.remote.client.CloverConnector
 
cancel() - Method in interface com.clover.remote.client.ICloverConnector
Cancels the current user action on the device.
CANCEL_INPUT_OPTION - Static variable in class com.clover.remote.client.CloverConnector
 
capturePreAuth(CapturePreAuthRequest) - Method in class com.clover.remote.client.CloverConnector
 
capturePreAuth(CapturePreAuthRequest) - Method in interface com.clover.remote.client.ICloverConnector
Capture a previous Auth.
CapturePreAuthRequest - Class in com.clover.remote.client.messages
Request to capture a payment that had been previously obtained from a preAuth(PreAuthRequest request) call
CapturePreAuthRequest() - Constructor for class com.clover.remote.client.messages.CapturePreAuthRequest
 
CapturePreAuthResponse - Class in com.clover.remote.client.messages
Response object for a payment capture request
CapturePreAuthResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.CapturePreAuthResponse
Constructor
CARD_ENTRY_METHOD_ICC_CONTACT - Static variable in class com.clover.remote.client.CloverConnector
 
CARD_ENTRY_METHOD_MAG_STRIPE - Static variable in class com.clover.remote.client.CloverConnector
 
CARD_ENTRY_METHOD_MANUAL - Static variable in class com.clover.remote.client.CloverConnector
 
CARD_ENTRY_METHOD_NFC_CONTACTLESS - Static variable in class com.clover.remote.client.CloverConnector
 
closeout(CloseoutRequest) - Method in class com.clover.remote.client.CloverConnector
 
closeout(CloseoutRequest) - Method in interface com.clover.remote.client.ICloverConnector
Request a closeout of all orders.
CloseoutRequest - Class in com.clover.remote.client.messages
Request object for closeout request
CloseoutRequest() - Constructor for class com.clover.remote.client.messages.CloseoutRequest
 
CloseoutResponse - Class in com.clover.remote.client.messages
Response object for a closeout request
CloseoutResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.CloseoutResponse
Constructor
CloverConnector - Class in com.clover.remote.client
Provides the default implementation of the ICloverConnector interface, connecting to the device specified in the constructor.
CloverConnector(CloverDeviceConfiguration) - Constructor for class com.clover.remote.client.CloverConnector
CloverConnector constructor
cloverConnector - Variable in class com.clover.remote.client.DefaultCloverConnectorListener
 
CloverDeviceConfiguration - Interface in com.clover.remote.client
Interface which defines the configuration of the underlying transport for connecting to a Clover device.
CloverDeviceErrorEvent - Class in com.clover.remote.client.messages
General error used for reporting error events to the POS
CloverDeviceErrorEvent(CloverDeviceErrorEvent.CloverDeviceErrorType, Integer, Throwable, String) - Constructor for class com.clover.remote.client.messages.CloverDeviceErrorEvent
Constructor
CloverDeviceErrorEvent.CloverDeviceErrorType - Enum in com.clover.remote.client.messages
Type of device error
CloverDeviceEvent - Class in com.clover.remote.client.messages
Encapsulates the start or stop of a Clover Device activity (e.g.
CloverDeviceEvent() - Constructor for class com.clover.remote.client.messages.CloverDeviceEvent
 
CloverDeviceEvent.DeviceEventState - Enum in com.clover.remote.client.messages
Enum corresponding to valid UI State events from the device
CloverTransport - Class in com.clover.remote.client.transport
 
CloverTransport() - Constructor for class com.clover.remote.client.transport.CloverTransport
 
com.clover.remote.client - package com.clover.remote.client
 
com.clover.remote.client.messages - package com.clover.remote.client.messages
 
com.clover.remote.client.transport - package com.clover.remote.client.transport
 
ConfirmPaymentRequest - Class in com.clover.remote.client.messages
Request sent from the Mini for the POS to verify or reject a signature
ConfirmPaymentRequest() - Constructor for class com.clover.remote.client.messages.ConfirmPaymentRequest
 
CustomActivityRequest - Class in com.clover.remote.client.messages
 
CustomActivityRequest(String) - Constructor for class com.clover.remote.client.messages.CustomActivityRequest
Constructor
CustomActivityResponse - Class in com.clover.remote.client.messages
Response object for a custom activity request
CustomActivityResponse(boolean, ResultCode, String, String, String) - Constructor for class com.clover.remote.client.messages.CustomActivityResponse
Constructor

D

DefaultCloverConnectorListener - Class in com.clover.remote.client
 
DefaultCloverConnectorListener(ICloverConnector) - Constructor for class com.clover.remote.client.DefaultCloverConnectorListener
 
DEVICE_CONNECTED - Static variable in class com.clover.remote.client.transport.CloverTransport
 
DEVICE_DISCONNECTED - Static variable in class com.clover.remote.client.transport.CloverTransport
 
DEVICE_READY - Static variable in class com.clover.remote.client.transport.CloverTransport
 
DeviceInfo() - Constructor for class com.clover.remote.client.MerchantInfo.DeviceInfo
 
displayPaymentReceiptOptions(String, String) - Method in class com.clover.remote.client.CloverConnector
 
displayPaymentReceiptOptions(String, String) - Method in interface com.clover.remote.client.ICloverConnector
Display the payment receipt screen for the orderId/paymentId combination.
dispose() - Method in class com.clover.remote.client.CloverConnector
 
dispose() - Method in interface com.clover.remote.client.ICloverConnector
Will dispose of the underlying connection to the device
dispose() - Method in class com.clover.remote.client.transport.CloverTransport
 
dispose() - Method in interface com.clover.remote.client.transport.ICloverTransport
Closes the connection to the underlying transport

G

getAction() - Method in class com.clover.remote.client.messages.ActivityMessage
Get the field value
getAction() - Method in class com.clover.remote.client.messages.CustomActivityRequest
Get the field value
getAction() - Method in class com.clover.remote.client.messages.CustomActivityResponse
Get the field value
getAllowOfflinePayment() - Method in class com.clover.remote.client.messages.AuthRequest
Get the field value
getAllowOfflinePayment() - Method in class com.clover.remote.client.messages.SaleRequest
Get the field value
getAmount() - Method in class com.clover.remote.client.messages.CapturePreAuthRequest
Get the field value
getAmount() - Method in class com.clover.remote.client.messages.CapturePreAuthResponse
Get the field value
getAmount() - Method in class com.clover.remote.client.messages.RefundPaymentRequest
Get the field value
getAmount() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getApplicationId() - Method in interface com.clover.remote.client.CloverDeviceConfiguration
Retrieve the application ID broadcast on all messages sent to the remote device
getApplicationId() - Method in class com.clover.remote.client.WebSocketCloverDeviceConfiguration
 
getApproveOfflinePaymentWithoutPrompt() - Method in class com.clover.remote.client.messages.AuthRequest
Get the field value
getApproveOfflinePaymentWithoutPrompt() - Method in class com.clover.remote.client.messages.SaleRequest
Get the field value
getAutoAcceptPaymentConfirmations() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getAutoAcceptSignature() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getBatch() - Method in class com.clover.remote.client.messages.CloseoutResponse
Get the field value
getBatchId() - Method in class com.clover.remote.client.messages.CloseoutRequest
Get the field value
getCard() - Method in class com.clover.remote.client.messages.VaultCardResponse
Get the field value
getCardData() - Method in class com.clover.remote.client.messages.ReadCardDataResponse
Get the field value
getCardEntryMethods() - Method in class com.clover.remote.client.messages.ReadCardDataRequest
Get the field value
getCardEntryMethods() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getCardEntryMethods() - Method in class com.clover.remote.client.messages.VaultCardRequest
Get the field value
getCardNotPresent() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getCategory() - Method in class com.clover.remote.client.messages.RetrievePrintersRequest
Get the field value
getCause() - Method in class com.clover.remote.client.messages.CloverDeviceErrorEvent
Get the field value
getChallenges() - Method in class com.clover.remote.client.messages.ConfirmPaymentRequest
Get the field value
getCloverDeviceTypeName() - Method in interface com.clover.remote.client.CloverDeviceConfiguration
Retrieve the class name of the clover device instantiated during the CloverConnector.initializeConnection() call.
getCloverDeviceTypeName() - Method in class com.clover.remote.client.WebSocketCloverDeviceConfiguration
 
getCloverTransport() - Method in interface com.clover.remote.client.CloverDeviceConfiguration
Retrieve the configuration specified transport (e.g.
getCloverTransport() - Method in class com.clover.remote.client.WebSocketCloverDeviceConfiguration
 
getCode() - Method in class com.clover.remote.client.messages.CloverDeviceErrorEvent
Get the field value
getCode() - Method in class com.clover.remote.client.messages.CloverDeviceEvent
Get the field value
getCredit() - Method in class com.clover.remote.client.messages.ManualRefundResponse
Get the field value
getCredit() - Method in class com.clover.remote.client.messages.PrintManualRefundDeclineReceiptMessage
Get the field value
getCredit() - Method in class com.clover.remote.client.messages.PrintManualRefundReceiptMessage
Get the field value
getData() - Method in class com.clover.remote.client.messages.RetrieveDeviceStatusResponse
Get the field value
getDeviceId() - Method in class com.clover.remote.client.messages.OpenCashDrawerRequest
Get the field value
getDeviceInfo() - Method in class com.clover.remote.client.MerchantInfo
 
getDisableCashback() - Method in class com.clover.remote.client.messages.AuthRequest
Get the field value
getDisableCashback() - Method in class com.clover.remote.client.messages.SaleRequest
Get the field value
getDisableDuplicateChecking() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getDisablePrinting() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getDisableReceiptSelection() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getDisableRestartTransactionOnFail() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getDisableTipOnScreen() - Method in class com.clover.remote.client.messages.SaleRequest
Get the field value
getEmployeeId() - Method in class com.clover.remote.client.messages.VoidPaymentRequest
Get the field value
getErrorType() - Method in class com.clover.remote.client.messages.CloverDeviceErrorEvent
Get the field value
getEventState() - Method in class com.clover.remote.client.messages.CloverDeviceEvent
Get the field value
getExternalId() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getExternalPaymentId() - Method in class com.clover.remote.client.messages.RetrievePaymentRequest
Get the field value
getExternalPaymentId() - Method in class com.clover.remote.client.messages.RetrievePaymentResponse
Get the field value
getForceOfflinePayment() - Method in class com.clover.remote.client.messages.AuthRequest
Get the field value
getForceOfflinePayment() - Method in class com.clover.remote.client.messages.SaleRequest
Get the field value
getImages() - Method in class com.clover.remote.client.messages.PrintRequest
Get the field value
getImageURLs() - Method in class com.clover.remote.client.messages.PrintRequest
Get the field value
getInputOptions() - Method in class com.clover.remote.client.messages.CloverDeviceEvent
Get the field value
getMaxMessageCharacters() - Method in interface com.clover.remote.client.CloverDeviceConfiguration
Retrieve the max message characters
getMaxMessageCharacters() - Method in class com.clover.remote.client.WebSocketCloverDeviceConfiguration
 
getMerchantID() - Method in class com.clover.remote.client.MerchantInfo
 
getMerchantMID() - Method in class com.clover.remote.client.MerchantInfo
 
getMerchantName() - Method in class com.clover.remote.client.MerchantInfo
 
getMessage() - Method in class com.clover.remote.client.messages.BaseResponse
Get the field value
getMessage() - Method in class com.clover.remote.client.messages.CloverDeviceErrorEvent
Get the field value
getMessage() - Method in class com.clover.remote.client.messages.CloverDeviceEvent
Get the field value
getMessagePackageName() - Method in interface com.clover.remote.client.CloverDeviceConfiguration
Retrieve the package name broadcast on all messages sent to the remote device
getMessagePackageName() - Method in class com.clover.remote.client.WebSocketCloverDeviceConfiguration
 
getModel() - Method in class com.clover.remote.client.MerchantInfo.DeviceInfo
 
getName() - Method in interface com.clover.remote.client.CloverDeviceConfiguration
Retrieve the device configuration name
getName() - Method in class com.clover.remote.client.MerchantInfo.DeviceInfo
 
getName() - Method in class com.clover.remote.client.WebSocketCloverDeviceConfiguration
 
getOrder() - Method in class com.clover.remote.client.messages.PrintPaymentReceiptMessage
Get the field value
getOrder() - Method in class com.clover.remote.client.messages.PrintRefundPaymentReceiptMessage
Get the field value
getOrderId() - Method in class com.clover.remote.client.messages.RefundPaymentRequest
Get the field value
getOrderId() - Method in class com.clover.remote.client.messages.RefundPaymentResponse
Get the field value
getOrderId() - Method in class com.clover.remote.client.messages.TipAdjustAuthRequest
Get the field value
getOrderId() - Method in class com.clover.remote.client.messages.VoidPaymentRequest
Get the field value
getPayload() - Method in class com.clover.remote.client.messages.ActivityMessage
Get the field value
getPayload() - Method in class com.clover.remote.client.messages.CustomActivityRequest
Get the field value
getPayload() - Method in class com.clover.remote.client.messages.CustomActivityResponse
Get the field value
getPayment() - Method in class com.clover.remote.client.messages.ConfirmPaymentRequest
Get the field value
getPayment() - Method in class com.clover.remote.client.messages.PaymentResponse
Get the field value
getPayment() - Method in class com.clover.remote.client.messages.PrintPaymentDeclineReceiptMessage
Get the field value
getPayment() - Method in class com.clover.remote.client.messages.PrintPaymentMerchantCopyReceiptMessage
Get the field value
getPayment() - Method in class com.clover.remote.client.messages.PrintPaymentReceiptMessage
Get the field value
getPayment() - Method in class com.clover.remote.client.messages.PrintRefundPaymentReceiptMessage
Get the field value
getPayment() - Method in class com.clover.remote.client.messages.RetrievePaymentResponse
Get the field value
getPayment() - Method in class com.clover.remote.client.messages.VerifySignatureRequest
Get the field value
getPaymentID() - Method in class com.clover.remote.client.messages.CapturePreAuthRequest
Get the field value
getPaymentID() - Method in class com.clover.remote.client.messages.CapturePreAuthResponse
Get the field value
getPaymentId() - Method in class com.clover.remote.client.messages.RefundPaymentRequest
Get the field value
getPaymentId() - Method in class com.clover.remote.client.messages.RefundPaymentResponse
Get the field value
getPaymentId() - Method in class com.clover.remote.client.messages.TipAdjustAuthRequest
Get the field value
getPaymentId() - Method in class com.clover.remote.client.messages.TipAdjustAuthResponse
Get the field value
getPaymentId() - Method in class com.clover.remote.client.messages.VoidPaymentRequest
Get the field value
getPaymentId() - Method in class com.clover.remote.client.messages.VoidPaymentResponse
Get the field value
getPendingPayments() - Method in class com.clover.remote.client.messages.RetrievePendingPaymentsResponse
Get the field value
getPrintDeviceId() - Method in class com.clover.remote.client.messages.PrintRequest
Get the field value
getPrinters() - Method in class com.clover.remote.client.messages.RetrievePrintersResponse
Get the field value
getPrintRequestId() - Method in class com.clover.remote.client.messages.PrintJobStatusRequest
Get the field value
getPrintRequestId() - Method in class com.clover.remote.client.messages.PrintJobStatusResponse
Get the field value
getPrintRequestId() - Method in class com.clover.remote.client.messages.PrintRequest
Get the field value
getQueryStatus() - Method in class com.clover.remote.client.messages.RetrievePaymentResponse
Get the field value
getReason() - Method in class com.clover.remote.client.messages.BaseResponse
Get the field value
getReason() - Method in class com.clover.remote.client.messages.OpenCashDrawerRequest
Get the field value
getReason() - Method in class com.clover.remote.client.messages.PrintManualRefundDeclineReceiptMessage
Get the field value
getReason() - Method in class com.clover.remote.client.messages.PrintPaymentDeclineReceiptMessage
Get the field value
getRefund() - Method in class com.clover.remote.client.messages.PrintRefundPaymentReceiptMessage
Get the field value
getRefund() - Method in class com.clover.remote.client.messages.RefundPaymentResponse
Get the field value
getRemoteMessageVersion() - Method in class com.clover.remote.client.transport.CloverTransport
 
getResult() - Method in class com.clover.remote.client.messages.BaseResponse
Get the field value
getSerial() - Method in class com.clover.remote.client.MerchantInfo.DeviceInfo
 
getSignature() - Method in class com.clover.remote.client.messages.PaymentResponse
Get the field value
getSignature() - Method in class com.clover.remote.client.messages.VerifySignatureRequest
Get the field value
getSignatureEntryLocation() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getSignatureThreshold() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getState() - Method in class com.clover.remote.client.messages.ResetDeviceResponse
Get the field value
getState() - Method in class com.clover.remote.client.messages.RetrieveDeviceStatusResponse
Get the field value
getStatus() - Method in class com.clover.remote.client.messages.PrintJobStatusResponse
Get the field value
getTaxAmount() - Method in class com.clover.remote.client.messages.AuthRequest
Get the field value
getTaxAmount() - Method in class com.clover.remote.client.messages.SaleRequest
Get the field value
getText() - Method in class com.clover.remote.client.messages.PrintRequest
Get the field value
getTipAmount() - Method in class com.clover.remote.client.messages.CapturePreAuthRequest
Get the field value
getTipAmount() - Method in class com.clover.remote.client.messages.CapturePreAuthResponse
Get the field value
getTipAmount() - Method in class com.clover.remote.client.messages.SaleRequest
Get the field value
getTipAmount() - Method in class com.clover.remote.client.messages.TipAdjustAuthRequest
Get the field value
getTipAmount() - Method in class com.clover.remote.client.messages.TipAdjustAuthResponse
Get the field value
getTipMode() - Method in class com.clover.remote.client.messages.SaleRequest
Get the field value
getTippableAmount() - Method in class com.clover.remote.client.messages.AuthRequest
Get the field value
getTippableAmount() - Method in class com.clover.remote.client.messages.SaleRequest
Get the field value
getType() - Method in class com.clover.remote.client.messages.AuthRequest
 
getType() - Method in class com.clover.remote.client.messages.ManualRefundRequest
 
getType() - Method in class com.clover.remote.client.messages.PreAuthRequest
 
getType() - Method in class com.clover.remote.client.messages.SaleRequest
 
getType() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getVaultedCard() - Method in class com.clover.remote.client.messages.TransactionRequest
Get the field value
getVoidReason() - Method in class com.clover.remote.client.messages.VoidPaymentRequest
Get the field value

I

ICloverConnector - Interface in com.clover.remote.client
Interface to define the available methods to send requests to a connected Clover device.
ICloverConnectorListener - Interface in com.clover.remote.client
These are the methods to implement for intercepting messages that are sent from a Clover device.
ICloverTransport - Interface in com.clover.remote.client.transport
Interface to operate on an underlying transport
ICloverTransportObserver - Interface in com.clover.remote.client.transport
Asynchronous callback interface to handle device event and message notifications.
initializeConnection() - Method in class com.clover.remote.client.CloverConnector
 
initializeConnection() - Method in interface com.clover.remote.client.ICloverConnector
Initialize the CloverConnector's connection and start communication with the device.
initializeConnection() - Method in interface com.clover.remote.client.transport.ICloverTransport
Initializes the connection using the underlying transport
invokeInputOption(InputOption) - Method in class com.clover.remote.client.CloverConnector
 
invokeInputOption(InputOption) - Method in interface com.clover.remote.client.ICloverConnector
Used to invoke user options on the mini such as "OK", "CANCEL", "DONE", etc.
isAllowOpenTabs() - Method in class com.clover.remote.client.messages.CloseoutRequest
Get the field value
isAuth() - Method in class com.clover.remote.client.messages.PaymentResponse
Check to see if the payment was processed as an auth
isForceSwipePinEntry() - Method in class com.clover.remote.client.messages.ReadCardDataRequest
Get the field value
isFullRefund() - Method in class com.clover.remote.client.messages.RefundPaymentRequest
Get the field value
isNonBlocking() - Method in class com.clover.remote.client.messages.CustomActivityRequest
Get the field value
isPreAuth() - Method in class com.clover.remote.client.messages.PaymentResponse
Check to see if the payment was processed as a pre-auth
isReady() - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
isSale() - Method in class com.clover.remote.client.messages.PaymentResponse
Check to see if the payment was processed as a sale
isSendLastMessage() - Method in class com.clover.remote.client.messages.RetrieveDeviceStatusRequest
Get the field value
isSuccess() - Method in class com.clover.remote.client.messages.BaseResponse
Get the field value
isSupportsAuths() - Method in class com.clover.remote.client.MerchantInfo
 
isSupportsManualRefunds() - Method in class com.clover.remote.client.MerchantInfo
 
isSupportsPreAuths() - Method in class com.clover.remote.client.MerchantInfo
 
isSupportsSales() - Method in class com.clover.remote.client.MerchantInfo
 
isSupportsTipAdjust() - Method in class com.clover.remote.client.MerchantInfo
 
isSupportsVaultCards() - Method in class com.clover.remote.client.MerchantInfo
 
isSupportsVoids() - Method in class com.clover.remote.client.MerchantInfo
 

M

manualRefund(ManualRefundRequest) - Method in class com.clover.remote.client.CloverConnector
 
manualRefund(ManualRefundRequest) - Method in interface com.clover.remote.client.ICloverConnector
Manual refund method, aka "naked credit"
ManualRefundRequest - Class in com.clover.remote.client.messages
Request object used when requesting a Manual Refund (Naked Credit)
ManualRefundRequest(long, String) - Constructor for class com.clover.remote.client.messages.ManualRefundRequest
Constructor
ManualRefundResponse - Class in com.clover.remote.client.messages
Response object for a manual refund (naked credit) request
ManualRefundResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.ManualRefundResponse
Constructor
MAX_PAYLOAD_SIZE - Static variable in class com.clover.remote.client.CloverConnector
 
merchantInfo - Variable in class com.clover.remote.client.DefaultCloverConnectorListener
 
MerchantInfo - Class in com.clover.remote.client
 
MerchantInfo() - Constructor for class com.clover.remote.client.MerchantInfo
 
MerchantInfo(DiscoveryResponseMessage) - Constructor for class com.clover.remote.client.MerchantInfo
 
MerchantInfo.DeviceInfo - Class in com.clover.remote.client
 
MessageFromActivity - Class in com.clover.remote.client.messages
Contains the message information sent from a custom Activity
MessageFromActivity(String, String) - Constructor for class com.clover.remote.client.messages.MessageFromActivity
Constructor
MessageToActivity - Class in com.clover.remote.client.messages
Contains the message information sent to a custom Activity
MessageToActivity(String, String) - Constructor for class com.clover.remote.client.messages.MessageToActivity
Constructor

N

notifyDeviceConnected() - Method in class com.clover.remote.client.transport.CloverTransport
Should be called by subclasses (super.notifyDeviceConnected) when the device connects (but is not ready) in order to forward to all observers
notifyDeviceDisconnected() - Method in class com.clover.remote.client.transport.CloverTransport
Should be called by subclasses (super.notifyDeviceDisconnected) when the device disconnects in order to forward to all observers
notifyDeviceReady() - Method in class com.clover.remote.client.transport.CloverTransport
Should be called by subclasses (super.notifyDeviceReady) when the device is ready to process messages in order to forward to all observers

O

onAuthResponse(AuthResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onAuthResponse(AuthResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to an auth request
onCapturePreAuthResponse(CapturePreAuthResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onCapturePreAuthResponse(CapturePreAuthResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a capture of a pre auth payment
onCloseoutResponse(CloseoutResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onCloseoutResponse(CloseoutResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a closeout being processed
onConfirmPaymentRequest(ConfirmPaymentRequest) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when the Clover device requires confirmation for a payment e.g.
onCustomActivityResponse(CustomActivityResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onCustomActivityResponse(CustomActivityResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when a custom activity finishes
onDeviceActivityEnd(CloverDeviceEvent) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onDeviceActivityEnd(CloverDeviceEvent) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when a Clover device activity ends.
onDeviceActivityStart(CloverDeviceEvent) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onDeviceActivityStart(CloverDeviceEvent) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when a Clover device activity starts.
onDeviceConnected() - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onDeviceConnected() - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when the Clover device is connected, but not ready to communicate
onDeviceConnected(ICloverTransport) - Method in interface com.clover.remote.client.transport.ICloverTransportObserver
Device is there but not yet ready for use
onDeviceDisconnected() - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onDeviceDisconnected() - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when the Clover device is disconnected
onDeviceDisconnected(ICloverTransport) - Method in interface com.clover.remote.client.transport.ICloverTransportObserver
Device is not there anymore
onDeviceError(CloverDeviceErrorEvent) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onDeviceError(CloverDeviceErrorEvent) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when a Clover device error event is encountered
onDeviceReady(MerchantInfo) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onDeviceReady(MerchantInfo) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when the Clover device is ready to communicate
onDeviceReady(ICloverTransport) - Method in interface com.clover.remote.client.transport.ICloverTransportObserver
Device is there and ready for use
onManualRefundResponse(ManualRefundResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onManualRefundResponse(ManualRefundResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a manual refund request
onMessage(String) - Method in class com.clover.remote.client.transport.CloverTransport
Should be called by subclasses (super.onMessage) when a message is received in order to forward to all observers
onMessage(String) - Method in interface com.clover.remote.client.transport.ICloverTransportObserver
Called when a raw message is received from the device
onMessageFromActivity(MessageFromActivity) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onMessageFromActivity(MessageFromActivity) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when a message is sent from a custom activity
onPairingCode(String) - Method in interface com.clover.remote.client.transport.PairingDeviceConfiguration
Called when a pairing code needs to be entered on the device
onPairingSuccess(String) - Method in interface com.clover.remote.client.transport.PairingDeviceConfiguration
Called when the pairing to the device has completed
onPreAuthResponse(PreAuthResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onPreAuthResponse(PreAuthResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a pre auth request
onPrintJobStatusResponse(PrintJobStatusResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onPrintJobStatusResponse(PrintJobStatusResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called to update the status of a print job
onPrintManualRefundDeclineReceipt(PrintManualRefundDeclineReceiptMessage) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onPrintManualRefundDeclineReceipt(PrintManualRefundDeclineReceiptMessage) - Method in interface com.clover.remote.client.ICloverConnectorListener
Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined ManualRefund
onPrintManualRefundReceipt(PrintManualRefundReceiptMessage) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onPrintManualRefundReceipt(PrintManualRefundReceiptMessage) - Method in interface com.clover.remote.client.ICloverConnectorListener
Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a ManualRefund
onPrintPaymentDeclineReceipt(PrintPaymentDeclineReceiptMessage) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onPrintPaymentDeclineReceipt(PrintPaymentDeclineReceiptMessage) - Method in interface com.clover.remote.client.ICloverConnectorListener
Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined payment
onPrintPaymentMerchantCopyReceipt(PrintPaymentMerchantCopyReceiptMessage) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onPrintPaymentMerchantCopyReceipt(PrintPaymentMerchantCopyReceiptMessage) - Method in interface com.clover.remote.client.ICloverConnectorListener
Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a merchant copy of a payment receipt
onPrintPaymentReceipt(PrintPaymentReceiptMessage) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onPrintPaymentReceipt(PrintPaymentReceiptMessage) - Method in interface com.clover.remote.client.ICloverConnectorListener
Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment
onPrintRefundPaymentReceipt(PrintRefundPaymentReceiptMessage) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onPrintRefundPaymentReceipt(PrintRefundPaymentReceiptMessage) - Method in interface com.clover.remote.client.ICloverConnectorListener
Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment refund
onReadCardDataResponse(ReadCardDataResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onReadCardDataResponse(ReadCardDataResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a readCardData(...) request.
onRefundPaymentResponse(RefundPaymentResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onRefundPaymentResponse(RefundPaymentResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a refund payment request
onResetDeviceResponse(ResetDeviceResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onResetDeviceResponse(ResetDeviceResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a ResetDevice request
onRetrieveDeviceStatusResponse(RetrieveDeviceStatusResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onRetrieveDeviceStatusResponse(RetrieveDeviceStatusResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a RetrieveDeviceState request
onRetrievePaymentResponse(RetrievePaymentResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onRetrievePaymentResponse(RetrievePaymentResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a RetrievePaymentRequest
onRetrievePendingPaymentsResponse(RetrievePendingPaymentsResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onRetrievePendingPaymentsResponse(RetrievePendingPaymentsResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a retrievePendingPayment(...) request.
onRetrievePrintersResponse(RetrievePrintersResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onRetrievePrintersResponse(RetrievePrintersResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a retrievePrinters() request
onSaleResponse(SaleResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onSaleResponse(SaleResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a sale request
onTipAdded(TipAddedMessage) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onTipAdded(TipAddedMessage) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when a customer selects a tip amount on the Clover device screen
onTipAdjustAuthResponse(TipAdjustAuthResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onTipAdjustAuthResponse(TipAdjustAuthResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a tip adjust of an auth payment
onVaultCardResponse(VaultCardResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onVaultCardResponse(VaultCardResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a vault card request
onVerifySignatureRequest(VerifySignatureRequest) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onVerifySignatureRequest(VerifySignatureRequest) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called when the Clover device requires a signature to be verified
onVoidPaymentResponse(VoidPaymentResponse) - Method in class com.clover.remote.client.DefaultCloverConnectorListener
 
onVoidPaymentResponse(VoidPaymentResponse) - Method in interface com.clover.remote.client.ICloverConnectorListener
Called in response to a void payment request
openCashDrawer(OpenCashDrawerRequest) - Method in class com.clover.remote.client.CloverConnector
 
openCashDrawer(String) - Method in class com.clover.remote.client.CloverConnector
 
openCashDrawer(OpenCashDrawerRequest) - Method in interface com.clover.remote.client.ICloverConnector
Request that the cash drawer connected to the device be opened.
openCashDrawer(String) - Method in interface com.clover.remote.client.ICloverConnector
Will trigger cash drawer to open that is connected to Clover Mini
OpenCashDrawerRequest - Class in com.clover.remote.client.messages
Request object to open cash drawer
OpenCashDrawerRequest(String) - Constructor for class com.clover.remote.client.messages.OpenCashDrawerRequest
Constructor

P

PairingDeviceConfiguration - Interface in com.clover.remote.client.transport
Defines the callback interface for the pairing process
PaymentResponse - Class in com.clover.remote.client.messages
Base reponse use for callbacks that contain payments.
PaymentResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.PaymentResponse
Constructor
preAuth(PreAuthRequest) - Method in class com.clover.remote.client.CloverConnector
 
preAuth(PreAuthRequest) - Method in interface com.clover.remote.client.ICloverConnector
PreAuth method to obtain a Pre-Auth for a card
PreAuthRequest - Class in com.clover.remote.client.messages
Request object for requesting a pre-auth transaction.
PreAuthRequest(long, String) - Constructor for class com.clover.remote.client.messages.PreAuthRequest
Constructor
PreAuthResponse - Class in com.clover.remote.client.messages
Response object for a pre-auth transaction request
PreAuthResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.PreAuthResponse
Constructor
print(PrintRequest) - Method in class com.clover.remote.client.CloverConnector
 
print(PrintRequest) - Method in interface com.clover.remote.client.ICloverConnector
Request to print.
printImage(Bitmap) - Method in class com.clover.remote.client.CloverConnector
 
printImage(Bitmap) - Method in interface com.clover.remote.client.ICloverConnector
Deprecated.
printImageFromURL(String) - Method in class com.clover.remote.client.CloverConnector
 
printImageFromURL(String) - Method in interface com.clover.remote.client.ICloverConnector
Print an image on the Clover Mini printer
PrintJobStatusRequest - Class in com.clover.remote.client.messages
Request for status of print job
PrintJobStatusRequest(String) - Constructor for class com.clover.remote.client.messages.PrintJobStatusRequest
Constructor
PrintJobStatusResponse - Class in com.clover.remote.client.messages
Response object, called to update status of print job
PrintJobStatusResponse(String, PrintJobStatus) - Constructor for class com.clover.remote.client.messages.PrintJobStatusResponse
Constructor
PrintJobStatusResponse(PrintJobStatus) - Constructor for class com.clover.remote.client.messages.PrintJobStatusResponse
Constructor
PrintManualRefundDeclineReceiptMessage - Class in com.clover.remote.client.messages
Callback to request the POS print a ManualRefund declined receipt
PrintManualRefundDeclineReceiptMessage(Credit, String) - Constructor for class com.clover.remote.client.messages.PrintManualRefundDeclineReceiptMessage
Constructor
PrintManualRefundReceiptMessage - Class in com.clover.remote.client.messages
Callback to request the POS print a receipt for a ManualRefund
PrintManualRefundReceiptMessage(Credit) - Constructor for class com.clover.remote.client.messages.PrintManualRefundReceiptMessage
Constructor
PrintPaymentDeclineReceiptMessage - Class in com.clover.remote.client.messages
Callback to the POS to request a payment declined receipt
PrintPaymentDeclineReceiptMessage(Payment, String) - Constructor for class com.clover.remote.client.messages.PrintPaymentDeclineReceiptMessage
Constructor
PrintPaymentMerchantCopyReceiptMessage - Class in com.clover.remote.client.messages
Callback to the POS to request a merchant payment receipt be printed
PrintPaymentMerchantCopyReceiptMessage(Payment) - Constructor for class com.clover.remote.client.messages.PrintPaymentMerchantCopyReceiptMessage
Constructor
PrintPaymentReceiptMessage - Class in com.clover.remote.client.messages
Callback to the POS to request a payment receipt be printed
PrintPaymentReceiptMessage(Payment, Order) - Constructor for class com.clover.remote.client.messages.PrintPaymentReceiptMessage
Constructor
PrintRefundPaymentReceiptMessage - Class in com.clover.remote.client.messages
Callback to the POS to request a payment refund receipt be printed
PrintRefundPaymentReceiptMessage(Payment, Order, Refund) - Constructor for class com.clover.remote.client.messages.PrintRefundPaymentReceiptMessage
Constructor
PrintRequest - Class in com.clover.remote.client.messages
Request object for requesting a print job.
PrintRequest(Bitmap, String, String) - Constructor for class com.clover.remote.client.messages.PrintRequest
Constructor Create a PrintRequest to print a given image
PrintRequest(Bitmap) - Constructor for class com.clover.remote.client.messages.PrintRequest
Constructor Create a PrintRequest to print a given image
printText(List<String>) - Method in class com.clover.remote.client.CloverConnector
 
printText(List<String>) - Method in interface com.clover.remote.client.ICloverConnector
Print simple lines of text to the Clover Mini printer

R

readCardData(ReadCardDataRequest) - Method in class com.clover.remote.client.CloverConnector
 
readCardData(ReadCardDataRequest) - Method in interface com.clover.remote.client.ICloverConnector
Used to request card information.
ReadCardDataRequest - Class in com.clover.remote.client.messages
Request object for requesting to read card data
ReadCardDataRequest(Integer) - Constructor for class com.clover.remote.client.messages.ReadCardDataRequest
Constructor
ReadCardDataResponse - Class in com.clover.remote.client.messages
Response object for a read card data request
ReadCardDataResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.ReadCardDataResponse
Constructor
refundPayment(RefundPaymentRequest) - Method in class com.clover.remote.client.CloverConnector
 
refundPayment(RefundPaymentRequest) - Method in interface com.clover.remote.client.ICloverConnector
Refund a specific payment
RefundPaymentRequest - Class in com.clover.remote.client.messages
Request object to refund a payment, either partially or fully
RefundPaymentRequest() - Constructor for class com.clover.remote.client.messages.RefundPaymentRequest
 
RefundPaymentResponse - Class in com.clover.remote.client.messages
Response object for a request to refund a payment, either partially or fully
RefundPaymentResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.RefundPaymentResponse
Constructor
rejectPayment(Payment, Challenge) - Method in class com.clover.remote.client.CloverConnector
 
rejectPayment(Payment, Challenge) - Method in interface com.clover.remote.client.ICloverConnector
If payment confirmation is required during a Sale, this method rejects the payment
rejectSignature(VerifySignatureRequest) - Method in class com.clover.remote.client.CloverConnector
 
rejectSignature(VerifySignatureRequest) - Method in interface com.clover.remote.client.ICloverConnector
If signature is captured during a Sale, this method rejects the signature as entered
removeCloverConnectorListener(ICloverConnectorListener) - Method in class com.clover.remote.client.CloverConnector
Remove a previously added listener.
removeCloverConnectorListener(ICloverConnectorListener) - Method in interface com.clover.remote.client.ICloverConnector
Removes a clover connector listener.
removeDisplayOrder(DisplayOrder) - Method in class com.clover.remote.client.CloverConnector
 
removeDisplayOrder(DisplayOrder) - Method in interface com.clover.remote.client.ICloverConnector
Remove the DisplayOrder from the device.
removeObserver(ICloverTransportObserver) - Method in class com.clover.remote.client.transport.CloverTransport
 
removeObserver(ICloverTransportObserver) - Method in interface com.clover.remote.client.transport.ICloverTransport
Remove a previously added listener.
resetDevice() - Method in class com.clover.remote.client.CloverConnector
 
resetDevice() - Method in interface com.clover.remote.client.ICloverConnector
Used to reset the device if it gets in an invalid state from POS perspective.
ResetDeviceResponse - Class in com.clover.remote.client.messages
Response object for a reset device request
ResetDeviceResponse(boolean, ResultCode, ExternalDeviceState) - Constructor for class com.clover.remote.client.messages.ResetDeviceResponse
Constructor
ResultCode - Enum in com.clover.remote.client.messages
The result of the Response objects used in the callbacks from the Mini
retrieveDeviceStatus(RetrieveDeviceStatusRequest) - Method in class com.clover.remote.client.CloverConnector
 
retrieveDeviceStatus(RetrieveDeviceStatusRequest) - Method in interface com.clover.remote.client.ICloverConnector
Send a message requesting the current status of the device.
RetrieveDeviceStatusRequest - Class in com.clover.remote.client.messages
Request object for requesting the current device status.
RetrieveDeviceStatusRequest(boolean) - Constructor for class com.clover.remote.client.messages.RetrieveDeviceStatusRequest
 
RetrieveDeviceStatusResponse - Class in com.clover.remote.client.messages
Response object for a retrieve device status request
RetrieveDeviceStatusResponse(boolean, ResultCode, ExternalDeviceState, ExternalDeviceStateData) - Constructor for class com.clover.remote.client.messages.RetrieveDeviceStatusResponse
Constructor
retrievePayment(RetrievePaymentRequest) - Method in class com.clover.remote.client.CloverConnector
 
retrievePayment(RetrievePaymentRequest) - Method in interface com.clover.remote.client.ICloverConnector
Sends a request to get a payment.
RetrievePaymentRequest - Class in com.clover.remote.client.messages
Request object for requesting information on a specific payment
RetrievePaymentRequest(String) - Constructor for class com.clover.remote.client.messages.RetrievePaymentRequest
 
RetrievePaymentResponse - Class in com.clover.remote.client.messages
Response object for a retrieve payment request
RetrievePaymentResponse(ResultCode, String, String, QueryStatus, Payment) - Constructor for class com.clover.remote.client.messages.RetrievePaymentResponse
Constructor
retrievePendingPayments() - Method in class com.clover.remote.client.CloverConnector
 
retrievePendingPayments() - Method in interface com.clover.remote.client.ICloverConnector
Used to request a list of pending payments that have been taken offline, but haven't processed yet.
RetrievePendingPaymentsResponse - Class in com.clover.remote.client.messages
Response object for a retrieve pending payments request
RetrievePendingPaymentsResponse(ResultCode, String, List<PendingPaymentEntry>) - Constructor for class com.clover.remote.client.messages.RetrievePendingPaymentsResponse
Constructor
retrievePrinters(RetrievePrintersRequest) - Method in class com.clover.remote.client.CloverConnector
 
retrievePrinters(RetrievePrintersRequest) - Method in interface com.clover.remote.client.ICloverConnector
Request to retrieve available printers.
RetrievePrintersRequest - Class in com.clover.remote.client.messages
Request to retrieve all available printers
RetrievePrintersRequest() - Constructor for class com.clover.remote.client.messages.RetrievePrintersRequest
Constructor
RetrievePrintersRequest(PrintCategory) - Constructor for class com.clover.remote.client.messages.RetrievePrintersRequest
Constructor
RetrievePrintersResponse - Class in com.clover.remote.client.messages
Response object for retrieving the printers
RetrievePrintersResponse(List<Printer>) - Constructor for class com.clover.remote.client.messages.RetrievePrintersResponse
Constructor
retrievePrintJobStatus(PrintJobStatusRequest) - Method in class com.clover.remote.client.CloverConnector
 
retrievePrintJobStatus(PrintJobStatusRequest) - Method in interface com.clover.remote.client.ICloverConnector
Request the status of a given print job

S

sale(SaleRequest) - Method in class com.clover.remote.client.CloverConnector
 
sale(SaleRequest) - Method in interface com.clover.remote.client.ICloverConnector
Sale method, aka "purchase"
SaleRequest - Class in com.clover.remote.client.messages
Request object for requesting a sale transaction.
SaleRequest(long, String) - Constructor for class com.clover.remote.client.messages.SaleRequest
Constructor
SaleRequest.TipMode - Enum in com.clover.remote.client.messages
Enumeration for indicating the mode of acquiring a tip
SaleResponse - Class in com.clover.remote.client.messages
Response object for a sale request
SaleResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.SaleResponse
Constructor
sendMessage(String) - Method in interface com.clover.remote.client.transport.ICloverTransport
Sends the specified encoded message
sendMessageToActivity(MessageToActivity) - Method in class com.clover.remote.client.CloverConnector
 
sendMessageToActivity(MessageToActivity) - Method in interface com.clover.remote.client.ICloverConnector
Send a message to a running custom activity on the Clover device
setAllowOfflinePayment(Boolean) - Method in class com.clover.remote.client.messages.AuthRequest
Set the field value
setAllowOfflinePayment(Boolean) - Method in class com.clover.remote.client.messages.SaleRequest
Set the field value
setAllowOpenTabs(boolean) - Method in class com.clover.remote.client.messages.CloseoutRequest
Set the field value
setAmount(long) - Method in class com.clover.remote.client.messages.CapturePreAuthRequest
Set the field value
setAmount(long) - Method in class com.clover.remote.client.messages.CapturePreAuthResponse
Set the field value
setAmount(long) - Method in class com.clover.remote.client.messages.RefundPaymentRequest
Set the field value
setAmount(long) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setApproveOfflinePaymentWithoutPrompt(Boolean) - Method in class com.clover.remote.client.messages.AuthRequest
Set the field value
setApproveOfflinePaymentWithoutPrompt(Boolean) - Method in class com.clover.remote.client.messages.SaleRequest
Set the field value
setAutoAcceptPaymentConfirmations(Boolean) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setAutoAcceptSignature(Boolean) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setBatch(Batch) - Method in class com.clover.remote.client.messages.CloseoutResponse
Set the field value
setBatchId(String) - Method in class com.clover.remote.client.messages.CloseoutRequest
Set the field value
setCardData(CardData) - Method in class com.clover.remote.client.messages.ReadCardDataResponse
Set the field value
setCardEntryMethods(Integer) - Method in class com.clover.remote.client.messages.ReadCardDataRequest
Set the field value
setCardEntryMethods(Integer) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setCardNotPresent(Boolean) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setChallenges(Challenge[]) - Method in class com.clover.remote.client.messages.ConfirmPaymentRequest
Set the field value
setCode(int) - Method in class com.clover.remote.client.messages.CloverDeviceEvent
Set the field value
setCredit(Credit) - Method in class com.clover.remote.client.messages.ManualRefundResponse
Set the field value
setDeviceId(String) - Method in class com.clover.remote.client.messages.OpenCashDrawerRequest
Set the field value
setDisableCashback(Boolean) - Method in class com.clover.remote.client.messages.AuthRequest
Set the field value
setDisableCashback(Boolean) - Method in class com.clover.remote.client.messages.SaleRequest
Set the field value
setDisableDuplicateChecking(Boolean) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setDisablePrinting(Boolean) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setDisableReceiptSelection(Boolean) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setDisableRestartTransactionOnFail(Boolean) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setDisableTipOnScreen(Boolean) - Method in class com.clover.remote.client.messages.SaleRequest
Set the field value
setEmployeeId(String) - Method in class com.clover.remote.client.messages.VoidPaymentRequest
Set the field value
setEventState(CloverDeviceEvent.DeviceEventState) - Method in class com.clover.remote.client.messages.CloverDeviceEvent
Set the field value
setExternalId(String) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setExternalPaymentId(String) - Method in class com.clover.remote.client.messages.RetrievePaymentRequest
Set the field value
setForceOfflinePayment(Boolean) - Method in class com.clover.remote.client.messages.AuthRequest
Set the field value
setForceOfflinePayment(Boolean) - Method in class com.clover.remote.client.messages.SaleRequest
Set the field value
setForceSwipePinEntry(boolean) - Method in class com.clover.remote.client.messages.ReadCardDataRequest
Set the field value
setFullRefund(boolean) - Method in class com.clover.remote.client.messages.RefundPaymentRequest
Set the field value
setInputOptions(InputOption[]) - Method in class com.clover.remote.client.messages.CloverDeviceEvent
Set the field value
setMessage(String) - Method in class com.clover.remote.client.messages.BaseResponse
Set the field value
setMessage(String) - Method in class com.clover.remote.client.messages.CloverDeviceEvent
Set the field value
setNonBlocking(boolean) - Method in class com.clover.remote.client.messages.CustomActivityRequest
Set the field value
setOrderId(String) - Method in class com.clover.remote.client.messages.RefundPaymentRequest
Set the field value
setOrderId(String) - Method in class com.clover.remote.client.messages.RefundPaymentResponse
Set the field value
setOrderId(String) - Method in class com.clover.remote.client.messages.TipAdjustAuthRequest
Set the field value
setOrderId(String) - Method in class com.clover.remote.client.messages.VoidPaymentRequest
Set the field value
setPayload(String) - Method in class com.clover.remote.client.messages.CustomActivityRequest
Set the field value
setPayment(Payment) - Method in class com.clover.remote.client.messages.ConfirmPaymentRequest
Set the field value
setPayment(Payment) - Method in class com.clover.remote.client.messages.PaymentResponse
Set the field value
setPayment(Payment) - Method in class com.clover.remote.client.messages.VerifySignatureRequest
Set the field value
setPaymentID(String) - Method in class com.clover.remote.client.messages.CapturePreAuthRequest
Set the field value
setPaymentID(String) - Method in class com.clover.remote.client.messages.CapturePreAuthResponse
Set the field value
setPaymentId(String) - Method in class com.clover.remote.client.messages.RefundPaymentRequest
Set the field value
setPaymentId(String) - Method in class com.clover.remote.client.messages.RefundPaymentResponse
Set the field value
setPaymentId(String) - Method in class com.clover.remote.client.messages.TipAdjustAuthRequest
Set the field value
setPaymentId(String) - Method in class com.clover.remote.client.messages.TipAdjustAuthResponse
Set the field value
setPaymentId(String) - Method in class com.clover.remote.client.messages.VoidPaymentRequest
Set the field value
setPaymentId(String) - Method in class com.clover.remote.client.messages.VoidPaymentResponse
Set the field value
setPrintDeviceId(String) - Method in class com.clover.remote.client.messages.PrintRequest
Set the field value
setPrintRequestId(String) - Method in class com.clover.remote.client.messages.PrintRequest
Set the field value
setReason(String) - Method in class com.clover.remote.client.messages.BaseResponse
Set the field value
setReason(String) - Method in class com.clover.remote.client.messages.OpenCashDrawerRequest
Set the field value
setRefund(Refund) - Method in class com.clover.remote.client.messages.RefundPaymentResponse
Set the field value
setResult(ResultCode) - Method in class com.clover.remote.client.messages.BaseResponse
Set the field value
setSendLastMessage(boolean) - Method in class com.clover.remote.client.messages.RetrieveDeviceStatusRequest
Set the field value
setSignature(Signature2) - Method in class com.clover.remote.client.messages.PaymentResponse
Set the field value
setSignature(Signature2) - Method in class com.clover.remote.client.messages.VerifySignatureRequest
Set the field value
setSignatureEntryLocation(DataEntryLocation) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setSignatureThreshold(Long) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setSuccess(boolean) - Method in class com.clover.remote.client.messages.BaseResponse
Set the field value
setTaxAmount(Long) - Method in class com.clover.remote.client.messages.AuthRequest
Set the field value
setTaxAmount(Long) - Method in class com.clover.remote.client.messages.SaleRequest
Set the field value
setTipAmount(long) - Method in class com.clover.remote.client.messages.CapturePreAuthRequest
Set the field value
setTipAmount(long) - Method in class com.clover.remote.client.messages.CapturePreAuthResponse
Set the field value
setTipAmount(Long) - Method in class com.clover.remote.client.messages.SaleRequest
Set the field value
setTipAmount(long) - Method in class com.clover.remote.client.messages.TipAdjustAuthRequest
Set the field value
setTipAmount(long) - Method in class com.clover.remote.client.messages.TipAdjustAuthResponse
Set the field value
setTipMode(SaleRequest.TipMode) - Method in class com.clover.remote.client.messages.SaleRequest
Set the field value
setTippableAmount(Long) - Method in class com.clover.remote.client.messages.AuthRequest
Set the field value
setTippableAmount(Long) - Method in class com.clover.remote.client.messages.SaleRequest
Set the field value
setVaultedCard(VaultedCard) - Method in class com.clover.remote.client.messages.TransactionRequest
Set the field value
setVoidReason(String) - Method in class com.clover.remote.client.messages.VoidPaymentRequest
Set the field value
showDisplayOrder(DisplayOrder) - Method in class com.clover.remote.client.CloverConnector
 
showDisplayOrder(DisplayOrder) - Method in interface com.clover.remote.client.ICloverConnector
Show the DisplayOrder on the device.
showMessage(String) - Method in class com.clover.remote.client.CloverConnector
 
showMessage(String) - Method in interface com.clover.remote.client.ICloverConnector
Show a message on the Clover Mini screen
showThankYouScreen() - Method in class com.clover.remote.client.CloverConnector
 
showThankYouScreen() - Method in interface com.clover.remote.client.ICloverConnector
Show the thank you screen on the device
showWelcomeScreen() - Method in class com.clover.remote.client.CloverConnector
 
showWelcomeScreen() - Method in interface com.clover.remote.client.ICloverConnector
Return the device to the Welcome Screen
startCustomActivity(CustomActivityRequest) - Method in class com.clover.remote.client.CloverConnector
 
startCustomActivity(CustomActivityRequest) - Method in interface com.clover.remote.client.ICloverConnector
Request to start a Custom Activity on the Clover device
supportsAcks() - Method in class com.clover.remote.client.MerchantInfo.DeviceInfo
 

T

tipAdjustAuth(TipAdjustAuthRequest) - Method in class com.clover.remote.client.CloverConnector
 
tipAdjustAuth(TipAdjustAuthRequest) - Method in interface com.clover.remote.client.ICloverConnector
Adjust the tip for a previous Auth.
TipAdjustAuthRequest - Class in com.clover.remote.client.messages
Request object for requesting to adjust the tip amount of a payment acquired from a previous auth
TipAdjustAuthRequest() - Constructor for class com.clover.remote.client.messages.TipAdjustAuthRequest
 
TipAdjustAuthResponse - Class in com.clover.remote.client.messages
Response object for a request to adjust the tip of a prior auth
TipAdjustAuthResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.TipAdjustAuthResponse
Constructor
TransactionRequest - Class in com.clover.remote.client.messages
Base class used by all transaction request objects like SaleRequest, AuthRequest, etc.
TransactionRequest(long, String) - Constructor for class com.clover.remote.client.messages.TransactionRequest
Constructor

V

valueOf(String) - Static method in enum com.clover.remote.client.messages.CloverDeviceErrorEvent.CloverDeviceErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.clover.remote.client.messages.CloverDeviceEvent.DeviceEventState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.clover.remote.client.messages.ResultCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.clover.remote.client.messages.SaleRequest.TipMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.clover.remote.client.messages.CloverDeviceErrorEvent.CloverDeviceErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.clover.remote.client.messages.CloverDeviceEvent.DeviceEventState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.clover.remote.client.messages.ResultCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.clover.remote.client.messages.SaleRequest.TipMode
Returns an array containing the constants of this enum type, in the order they are declared.
vaultCard(Integer) - Method in class com.clover.remote.client.CloverConnector
 
vaultCard(Integer) - Method in interface com.clover.remote.client.ICloverConnector
Vault card information.
VaultCardRequest - Class in com.clover.remote.client.messages
Request to acquire a payment token and card that can be used for future transaction requests
VaultCardRequest(Integer) - Constructor for class com.clover.remote.client.messages.VaultCardRequest
Constructor
VaultCardResponse - Class in com.clover.remote.client.messages
Response object for a vault card request
VaultCardResponse(boolean, ResultCode, VaultedCard) - Constructor for class com.clover.remote.client.messages.VaultCardResponse
Constructor
VerifySignatureRequest - Class in com.clover.remote.client.messages
Request sent from the Mini for the POS to verify or reject a signature
VerifySignatureRequest() - Constructor for class com.clover.remote.client.messages.VerifySignatureRequest
 
voidPayment(VoidPaymentRequest) - Method in class com.clover.remote.client.CloverConnector
 
voidPayment(VoidPaymentRequest) - Method in interface com.clover.remote.client.ICloverConnector
Void a transaction, given a previously used order ID and/or payment ID
VoidPaymentRequest - Class in com.clover.remote.client.messages
Request object for requesting to void a payment
VoidPaymentRequest() - Constructor for class com.clover.remote.client.messages.VoidPaymentRequest
 
VoidPaymentResponse - Class in com.clover.remote.client.messages
Response object for a void payment request
VoidPaymentResponse(boolean, ResultCode) - Constructor for class com.clover.remote.client.messages.VoidPaymentResponse
Constructor

W

WebSocketCloverDeviceConfiguration - Class in com.clover.remote.client
Default configuration to communicate with the Mini via WebSockets to the LAN Pay Display
WebSocketCloverDeviceConfiguration(URI, String, KeyStore, String, String, String) - Constructor for class com.clover.remote.client.WebSocketCloverDeviceConfiguration
Constructor
WebSocketCloverDeviceConfiguration(URI, String, KeyStore, String, String, String, long, long, long, long) - Constructor for class com.clover.remote.client.WebSocketCloverDeviceConfiguration
Constructor
A B C D G I M N O P R S T V W 
Skip navigation links