new ICloverConnector()
- Source:
Methods
(static) ICloverConnector#acceptPayment(payment)
Accepts a payment that has been challenged.
Parameters:
| Name | Type | Description |
|---|---|---|
payment |
payments.Payment |
- Source:
Returns:
void
(static) ICloverConnector#acceptSignature(request)
Send a signature acceptance
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.VerifySignatureRequest |
- Source:
Returns:
void
(static) ICloverConnector#auth(authRequest)
Request an authorization operation.
Parameters:
| Name | Type | Description |
|---|---|---|
authRequest |
remotepay.AuthRequest |
- Source:
Returns:
void
(static) ICloverConnector#cancel()
Request a cancel be sent to the device.
- Deprecated:
- - use #invokeInputOption(InputOption), or #resetDevice(). The cancel() functionality is dependant upon the presence of a 'cancel' input option being present on the screen, and the terminology is confusing. A call to this function sends a 'cancel' button press, but the device may not be in a state where it can respond to the button press.
- Source:
Returns:
void
(static) ICloverConnector#capturePreAuth(capturePreAuthRequest)
Request a preauth be captured.
Parameters:
| Name | Type | Description |
|---|---|---|
capturePreAuthRequest |
remotepay.CapturePreAuthRequest |
- Source:
Returns:
void
(static) ICloverConnector#closeout(closeoutRequest)
Request a closeout.
Parameters:
| Name | Type | Description |
|---|---|---|
closeoutRequest |
remotepay.CloseoutRequest |
- Source:
Returns:
void
(static) ICloverConnector#discountAddedToDisplayOrder(discount, order)
Notify device of a discount being added to the order. The discount will then reflect in the displayOrder.
Note: This is independent of a discount being added to a display line item.
Parameters:
| Name | Type | Description |
|---|---|---|
discount |
order.DisplayDiscount | |
order |
order.DisplayOrder |
- Source:
Returns:
void
(static) ICloverConnector#discountRemovedFromDisplayOrder(discount, order)
Notify device of a discount being removed to the order. The discount will then reflect in the displayOrder.
Note: This is independent of a discount being removed to a display line item.
Parameters:
| Name | Type | Description |
|---|---|---|
discount |
order.DisplayDiscount | |
order |
order.DisplayOrder |
- Source:
Returns:
void
(static) ICloverConnector#displayPaymentReceiptOptions(orderId, paymentId)
Show the customer facing receipt option screen for the specified payment
Parameters:
| Name | Type | Description |
|---|---|---|
orderId |
String | |
paymentId |
String |
- Source:
Returns:
void
(static) ICloverConnector#dispose()
Destroy the connector. After this is called, the connection to the device is severed, and this object is
no longer usable
- Source:
Returns:
void
(static) ICloverConnector#initializeConnection()
Starts communication with the device. This is called after the connector is created and listeners are added to the connector.
- Source:
Returns:
void
(static) ICloverConnector#invokeInputOption(io)
Send a keystroke to the device. When in non secure displays are on the device, this can be used to
act in the role of the user to 'press' available keys.
Parameters:
| Name | Type | Description |
|---|---|---|
io |
remotepay.InputOption |
- Source:
Returns:
void
(static) ICloverConnector#lineItemAddedToDisplayOrder(lineItem, order)
Notify device of a line item being added to the order. The line item will then reflect in the displayOrder.
Note: This is independent of a line item being added to a display line item.
Parameters:
| Name | Type | Description |
|---|---|---|
lineItem |
order.DisplayLineItem | |
order |
order.DisplayOrder |
- Source:
Returns:
void
(static) ICloverConnector#lineItemRemovedFromDisplayOrder(lineItem, order)
Notify device of a line item being removed to the order. The line item will then reflect in the displayOrder.
Note: This is independent of a line item being removed to a display line item.
Parameters:
| Name | Type | Description |
|---|---|---|
lineItem |
order.DisplayLineItem | |
order |
order.DisplayOrder |
- Source:
Returns:
void
(static) ICloverConnector#manualRefund(request)
Do a refund to a card.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.ManualRefundRequest |
- Source:
Returns:
void
(static) ICloverConnector#openCashDrawer(reason)
Open the first cash drawer that is found connected to the clover device.
Parameters:
| Name | Type | Description |
|---|---|---|
reason |
String |
- Source:
Returns:
void
(static) ICloverConnector#preAuth(preAuthRequest)
Request a preauth operation.
Parameters:
| Name | Type | Description |
|---|---|---|
preAuthRequest |
remotepay.PreAuthRequest |
- Source:
Returns:
void
(static) ICloverConnector#printImage(bitmap)
Print the passed image. bitmap is a language specific object that represents an image.
Parameters:
| Name | Type | Description |
|---|---|---|
bitmap |
remotepay.Img |
- Deprecated:
- - use #printImageFromURL(). This functionality is severely limited because of transport limitations.
- Source:
Returns:
void
(static) ICloverConnector#printImageFromURL(imgUrl)
Print an image on the clover device that is found at the passed url.
Parameters:
| Name | Type | Description |
|---|---|---|
imgUrl |
String |
- Source:
Returns:
void
(static) ICloverConnector#printText(messages)
Print text on the clover device printer.
Parameters:
| Name | Type | Description |
|---|---|---|
messages |
Array.<String> | An array of |
- Source:
Returns:
void
(static) ICloverConnector#readCardData(request)
Sends a request to read card information and call back with the information collected.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.ReadCardDataRequest |
- Source:
- See:
-
- ICloverConnectorListener.onReadCardDataResponse(ReadCardDataResponse)
Returns:
void
(static) ICloverConnector#refundPayment(request)
Do a refund on a previously made payment.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.RefundPaymentRequest |
- Source:
Returns:
void
(static) ICloverConnector#rejectPayment(payment, challenge)
Rejects a payment that has been challenged.
Parameters:
| Name | Type | Description |
|---|---|---|
payment |
payments.Payment | |
challenge |
base.Challenge |
- Source:
Returns:
void
(static) ICloverConnector#rejectSignature(request)
Reject a signature
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.VerifySignatureRequest |
- Source:
Returns:
void
(static) ICloverConnector#removeDisplayOrder(order)
Removes the Display order information on the screen.
Parameters:
| Name | Type | Description |
|---|---|---|
order |
order.DisplayOrder |
- Source:
Returns:
void
(static) ICloverConnector#resetDevice()
Send a message to the device to reset back to the welcome screen. Can be used when the device is in
an unknown state. Will trigger an onResetDevice callback
- Source:
Returns:
void
(static) ICloverConnector#retrieveDeviceStatus(request) → {Null}
retrieve the status of the device, and conditionally re-send the last message
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.RetrieveDeviceStatusRequest |
- Source:
Returns:
- Type
- Null
(static) ICloverConnector#retrievePayment(request)
Sends a request to get a payment. Only valid for payments made in the past 24 hours on the device queried
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.RetrievePaymentRequest |
- Source:
- See:
-
- ICloverConnectorListener.onRetrievePaymentResponse(RetrievePaymentResponse)
Returns:
void
(static) ICloverConnector#retrievePendingPayments()
Used to request a list of pending payments that have been taken offline, but
haven't processed yet. will trigger an onRetrievePendingPaymentsResponse callback
- Source:
Returns:
void
(static) ICloverConnector#sale(request)
Begin a sale transaction.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.SaleRequest |
- Source:
Returns:
void
(static) ICloverConnector#sendMessageToActivity(request, request)
Parameters:
| Name | Type | Description |
|---|---|---|
request |
a message that is sent to an existing running custom activity | |
request |
remotepay.MessageToActivity |
- Source:
- See:
-
- ICloverConnectorListener.onMessageFromActivity(MessageFromActivity)
Returns:
void
(static) ICloverConnector#showDisplayOrder(order)
Display order information on the screen. Calls to this method will cause the DisplayOrder
to show on the clover device. If a DisplayOrder is already showing on the Clover device,
it will replace the existing DisplayOrder on the device.
Parameters:
| Name | Type | Description |
|---|---|---|
order |
order.DisplayOrder |
- Source:
Returns:
void
(static) ICloverConnector#showMessage(message)
Show a text message on the device.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
String |
- Source:
Returns:
void
(static) ICloverConnector#showPaymentReceiptOptions(orderId, paymentId)
Incompatibility between sdks! Old cloud had this.
Show the customer facing receipt option screen for the specified payment
Parameters:
| Name | Type | Description |
|---|---|---|
orderId |
String | |
paymentId |
String |
- Deprecated:
- - use #displayPaymentReceiptOptions(string orderId, string paymentId)
- Source:
Returns:
void
(static) ICloverConnector#showThankYouScreen()
Show the thank you display on the device.
- Source:
Returns:
void
(static) ICloverConnector#showWelcomeScreen()
Show the welcome display on the device.
- Source:
Returns:
void
(static) ICloverConnector#startCustomActivity(request)
Start a custom activity on a device
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.CustomActivityRequest |
- Source:
Returns:
void
(static) ICloverConnector#tipAdjustAuth(request)
Tip adjust an existing auth
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.TipAdjustAuthRequest |
- Source:
Returns:
void
(static) ICloverConnector#vaultCard(cardEntryMethods)
Vault a card using optional cardEntryMethods
Parameters:
| Name | Type | Description |
|---|---|---|
cardEntryMethods |
Number | must be an integer |
- Source:
Returns:
void
(static) ICloverConnector#voidPayment(request)
Void a payment
Parameters:
| Name | Type | Description |
|---|---|---|
request |
remotepay.VoidPaymentRequest |
- Source:
Returns:
void