curalate-android-sdk

curalate-android-sdk is an API client to call Curalate's API methods from an Android app (or other project running on the JDK).

For questions or support, please contact your Curalate Account Manager or support@curalate.com.

Installation

Gradle

The recommended way to install the library for Android is with a build system like Gradle. Simply add the module to your build.gradle:

dependencies {
  implementation 'com.curalate:android-sdk:0.1.5'
}

Usage

Creating the API Client

CuralateApi curalate = new CuralateApi();

Fetch content (w/ synchronous client)

GetMediaRequest request = new GetMediaRequest.Builder()
    .setDataSourceId("<YOUR_DATA_SOURCE_ID>")
    .build();
GetMediaResult result = curalate.getMediaSynchronous(request);
for (MediaApiItem item : result.getData().getItems()) {
    // Process the item.
}

Fetch content (w/ asynchronous client)

GetMediaRequest request = new GetMediaRequest.Builder()
    .setDataSourceId("<YOUR_DATA_SOURCE_ID>")
    .build();

curalate.getMedia(request, new ApiHandler<GetMediaResult>() {
    @Override
    public void onSuccess(GetMediaResult result) {
        for (MediaApiItem item : result.getData().getItems()) {
            // Process the item.
        }
    }
    @Override
    public void onIOException(IOException exception) {
        // Handle the IOException
    }
    @Override
    public void onFailure(CuralateApiException exception) {
        // Handle the CuralateApiException
    }
});

Fetch content (using filters)

MediaFilter mediaFilter = new MediaFilter.And(
    new MediaFilter.ProductIdFilter("BQ8927"),
    new MediaFilter.LabelFilter("shopthelook")
);
GetMediaRequest request = new GetMediaRequest.Builder()
    .setDataSourceId("<YOUR_DATA_SOURCE_ID>")
    .setFilter(mediaFilter)
    .build();

Paginate through responses (w/ synchronous client)

String bookmark = null;
int page = 1;

do {
    GetMediaRequest request = new GetMediaRequest.Builder()
        .setDataSourceId("<YOUR_DATA_SOURCE_ID>")
        .setLimit(MAX_ITEMS_PER_REQUEST)
        .setAfter(bookmark)
        .build();
    GetMediaResult result = curalate.getMediaSynchronous(request);
    for (MediaApiItem item : result.getData().getItems()) {
        // Process the item.
    }

    bookmark = (result.getPaging() == null || result.getPaging().getCursors() == null) ?
        null : result.getPaging().getCursors().getAfter();
    page++;

} while (page <= MAX_PAGES && bookmark != null);