1.4.1

NOTE: Full support for version 1.4 of the SDK requires the following applications on the Clover device:

• Clover - Version 1892 or higher
• Secure Payments - Version 133 or higher
• Payments - Version 194 or higher
• Pay Display - Version 143 or higher

NEW

• Added a new Print API

  • Please migrate all print requests to the new API using the PrintRequest object:

    • print(PrintRequest request)

  • The following type-specific printing functions are deprecated and will be removed in a future release:

    • printText(List<string> messages)

    • printImage(img)

    • printImageFromURL(imageURL)

  • Added a new API for opening cash drawers

    • Please migrate all cash drawer requests to the new API using the OpenCashDrawerRequest object:

      • openCashDrawer(OpenCashDrawerRequest)

    • The following method for opening cash drawers with a reason string is deprecated and will be removed in a future release:

      • openCashDrawer(reason)

    • Added methods for querying available printers:

      • retrievePrinters(RetrievePrintersRequest)

      • onRetrievePrintersResponse(RetrievePrintersResponse)

    • Added methods for querying the status of a print job:

      • retrievePrintJobStatus(PrintJobStatusRequest)

      • onPrintJobStatusResponse(PrintJobStatusResponse)

  • Added support for printing large images through message fragmenting


1.3.1-3

FIXED

• SEMI-1045 - Corrected array serialization for top-level remotemessage.Message types
• SEMI-1057 - Added the VaultedCard to the Vaulted Card response
• SEMI-1054 - Added tipAmount to tipAdded

1.3.1-2

FIXED

• SEMI-1045 - Fixed issue where array serialization to the Clover Mini was not working properly in all cases, which interfered with displaying orders. This fix converts array elements into the format expected by Clover devices.

1.3.1-1

OTHER

• SEMI-1025 - OrderUpdateMessage.js and related files were removed in the 1.3.1 version of the Remote Pay Cloud API. These files are used in order display, and were reintegrated in version 1.3.1-1 of the Remote Pay Cloud API. This release depends on the updated 1.3.1-1 version of the Remote Pay Cloud API that contains OrderUpdateMessage.js and related files.

IMPROVED

• SEMI-991 - Updated the API so that when Cloud connections fail because a device is not communicating with the Clover servers, the disconnect is reported.

1.3.1

NEW

• SEMI-777 - Added support for Custom Activities.

  • ICloverConnector

    • Added
      • startCustomActivity() - Starts a Custom Activity on the Clover device.
      • sendMessageToActivity() - Sends messages to Custom Activities running on the Clover device.
      • retrievePayment() - Queries the status of a payment on the device by its External ID.
      • retrieveDeviceStatus() - Queries the status of the device.

  • ICloverConnectorListener

    • Added
      • onCustomActivityResponse() - Receives the callbacks from startCustomActivity().
      • onMessageFromActivity() - Receives the callbacks from sendMessageToActivity().
      • onRetrievePaymentResponse() - Receives the callbacks from retrievePayment().
      • onRetrieveDeviceStatusResponse() - Receives the callbacks from retrieveDeviceStatus().

  • CustomActivity

    • The APK must be approved and then installed via the Clover App Market.
    • clover-cfp-sdk library
      • Added CloverCFPActivity, which can be extended.
      • Added constants for retrieving activity payload CloverCFP interface.
      • Working with Custom Activities
        • The action of the activity, as defined in the AndroidManifest, should be passed in as part of the request.
        • A single text payload can be passed in to the request and retrieved in the intent via com.clover.remote.cfp.CFPActivity.EXTRA_PAYLOAD constant.
          • Example: com.clover.remote.terminal.remotecontrol.extra.EXTRA_PAYLOAD
        • The Custom Activity Response (onCustomActivityResponse()) contains a single text payload, populated from the com.clover.remote.cfp.EXTRA_PAYLOAD extra in the result Intent.
        • Block vs Non-Blocking Activities
          • A blocking Custom Activity (CustomActivityRequest.setNonBlocking(boolean)) will either need to finish itself, or be stopped by a ICloverConnector.resetDevice() request. One use case would be if you don't want a Sale request to interrupt a Custom Activity that collects customer information.
          • A non-blocking Custom Activity will finish when a new request is made. One use case would be if you want a Sale request to interrupt a Custom Activity that displays ads.
• SEMI-795 - Added retrievePayment() functionality.
• Added support for device status queries and retrieving payments.

IMPROVED

• SEMI-917 - Added onDeviceDisconnected, onDeviceConnected, and onDeviceReady and deprecated onDisconnected, onConnected, and onReady. The additions bring this API into closer alignment with the other Remote Pay APIs.
• SEMI-889 - Remove automatic transition to welcome screen when device is ready.
• SEMI-695 - Add response to resetDevice call.

OTHER

• CLOVER-21536 - Default allowPartialAuth in PayIntent dto. Update to dependency on remote-pay-cloud-api.
• SEMI-695 - Updated typescript version and typedoc dependencies.

FIXED

• SEMI-864 - Fixed case where a tip of 0 resulted in a Sale being converted to an Auth.

1.2.0

NEW

• SEMI-689 - Initial 1.2 implementation
• Added support for Per-Transaction Settings
• SEMI-554 - Added support for REMOTE_ERROR handling

IMPROVED

• Redesigned internal classes and many processes
• SEMI-554 - Updated the SDK to use version 1.2.0-rc1.0 of the remote-pay-cloud-api classes
• Increased request validation before communication
• Added the ability to connect to the device directly through the Secure Network Pay Display app
• Added displayPaymentReceiptOptions() to replace deprecated showPaymentReceiptOptions()
• Removed dependency on browser for connector objects produced using 1.2 factory objects

FIXED

• SEMI-792 - Fixed the installation script. Move dev-dependencies to dependencies
• SEMI-554 - Fixed cloverShouldHandleReceipts and disablePrinting check to look for correct property