MCPcopy Index your code
hub / github.com/clover/clover-android-sdk

github.com/clover/clover-android-sdk @r262.2

Chat with this repo
repository ↗ · DeepWiki ↗ · release r262.2 ↗ · + Follow
23,518 symbols 51,877 edges 697 files 16,478 documented · 70%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Clover SDK for Android

This repo contains two Android Studio projects: clover-android-sdk and clover-android-sdk-examples. Both projects use the Gradle build system and were developed using Android Studio. If you do not have Gradle installed, you may use the Gradle wrapper executable gradlew / gradlew.bat present in this repo.

clover-android-sdk is an Android library project. To integrate it into your project, add the following dependency to your Gradle-enabled project:

dependencies {
    compile 'com.clover.sdk:clover-android-sdk:latest.release'
}

clover-android-sdk-examples is an Android application project. To build and install from the command line,

.../clover-android-sdk/clover-android-sdk-examples
$ gradle clean installDebug

Alternatively, you may import both the SDK and examples as an Android Studio project.

Java Documentation

You can browse the javadoc for more information, including example usages.

https://clover.github.io/clover-android-sdk

To generate your own local copy of the javadoc,

$ pwd
.../clover-android-sdk/clover-android-sdk
$ gradle clean assemble doc-clean doc

Latest Apps for Testing

If you are testing on your own emulator or tablet then you will need the latest apps. All apps can be downloaded at:

{baseURL}/developers/dev-apks

Ex: https://www.clover.com/developers/dev-apks
Ex: https://sandbox.dev.clover.com/developers/dev-apks

If you are developing on sandbox please use the minimum or greater version of the engine.
Minimum required version: com.clover.engine-1851.apk

To check the current version of the Clover engine on your Clover Devkit:
Navigate to Settings > Storage > Apps > Clover
Then up top by the logo it should say the version Ex: ‘version 2.0-1851'

If you are using the minimum or greater engine version you do not need to do the following steps.

Targeting an Emulator or Tablet to a new environment

Currently, some of the dev-apks are not pointing to the environment corresponding to the baseURL they were downloaded from (i.e. Sandbox).

You will need to have installed adb to be able to use the script and it must also be in your path. Reference: https://developer.android.com/studio/command-line/adb.html

Please run the following bash script on your developer/host machine: target_new_environment

This script is meant to re-target a non-Clover device's environment.

Do not attempt to run this on a Clover device.

Please select a connected device
1) 192.168.57.101:5555
2) C021UQ53170436
3) C010UC43010546
4) C021UQ50430029
#? 1

Selected device:

192.168.57.101:5555

Please select your desired target environment:
1) Prod-US
2) Prod-EU
3) Sandbox
4) Localhost
#? 3

Updating target to https://apisandbox.dev.clover.com/

You will need to 'Add Account' via Settings to set up your device
Success

Extension points exported contracts — how you extend this code

ValueExtractorEnum (Interface)
For Clover internal use only. There are two copies of this file, one in clover-android-sdk and one in schema-tool, p [8 …
clover-android-sdk/src/main/java/com/clover/sdk/ValueExtractorEnum.java
PaymentServiceListener (Interface)
Interface used to allow application to be notified of order updates. [2 implementers]
clover-android-connector-sdk/src/main/java/com/clover/connector/sdk/v3/PaymentV3Connector.java
ILoyaltyKit (Interface)
The interface of the Loyalty Kit [1 implementers]
clover-android-loyalty-kit/src/main/java/com/clover/loyalty/ILoyaltyKit.java
ClickListener (Interface)
(no doc) [1 implementers]
clover-android-sdk-examples/src/main/java/com/clover/android/sdk/examples/LockscreenEmployeeAdapter.java
JSONifiable (Interface)
An interface to get a org.json.JSONObject. There are two copies of this file, one in clover-android-sdk and one in s [340 …
clover-android-sdk/src/main/java/com/clover/sdk/JSONifiable.java
IDisplayConnector (Interface)
Interface into displays. Used to allow direct control of a single display, or possibly multiple displays (depending on [2 …
clover-android-connector-sdk/src/main/java/com/clover/sdk/v3/connector/IDisplayConnector.java
ILoyaltyDataService (Interface)
(no doc)
clover-android-loyalty-kit/src/main/java/com/clover/loyalty/ILoyaltyDataService.java
CheckListener (Interface)
(no doc) [1 implementers]
clover-android-sdk-examples/src/main/java/com/clover/android/sdk/examples/PrinterListAdapter.java

Core symbols most depended-on inside this repo

cacheGet
called by 2827
clover-android-sdk/src/main/java/com/clover/sdk/GenericClient.java
cacheHasKey
called by 2827
clover-android-sdk/src/main/java/com/clover/sdk/GenericClient.java
cacheValueIsNotNull
called by 2826
clover-android-sdk/src/main/java/com/clover/sdk/GenericClient.java
instance
called by 2820
clover-android-sdk/src/main/java/com/clover/sdk/extractors/MapExtractionStrategy.java
clear
called by 2330
clover-android-sdk/src/main/java/com/clover/sdk/GenericClient.java
setOther
called by 2255
clover-android-sdk/src/main/java/com/clover/sdk/GenericClient.java
getJSONObject
called by 1014
clover-android-sdk/src/main/java/com/clover/sdk/JSONifiable.java
setJsonObject
called by 677
clover-android-sdk/src/main/java/com/clover/sdk/GenericClient.java

Shape

Method 21,949
Class 690
Enum 464
Interface 407
Function 8

Languages

Java100%
Python1%

Modules by API surface

clover-android-sdk/src/main/java/com/clover/sdk/v3/apps/App.java566 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/pay/TransactionData.java492 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/merchant/MerchantProperties.java322 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/merchant/MerchantBoarding.java317 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/developer/Developer.java262 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/merchant/Merchant.java236 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/payments/TransactionInfo.java228 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/payments/Payment.java213 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/order/Order.java202 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/resellers/Reseller.java199 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/report/ReportItem.java193 symbols
clover-android-sdk/src/main/java/com/clover/sdk/v3/device/Device.java193 symbols

For agents

$ claude mcp add clover-android-sdk \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact