Official android SDK for Kuzzle
Java
Latest commit 7a358f2 Dec 29, 2016 @jenow jenow committed on GitHub Update README.md

README.md

Build Status codecov.io Download Join the chat at https://gitter.im/kuzzleio/kuzzle

Official Kuzzle Android SDK

This SDK version requires Kuzzle v1.0.0-RC8 or higher.

About Kuzzle

For UI and linked objects developers, Kuzzle is an open-source solution that handles all the data management (CRUD, real-time storage, search, high-level features, etc).

You can access the Kuzzle repository on Github

SDK Documentation

The complete SDK documentation is available here

Installation

You can configure your android project to get the Kuzzle's android SDK from jcenter in your build.gradle:

buildscript {
    repositories {
        jcenter()
    }
}
compile 'io.kuzzle:sdk-android:2.1.0'

Basic usage

Kuzzle kuzzle = new Kuzzle("host", new ResponseListener<Void>() {
@Override
public void onSuccess(Void object) {
    // Handle success
    KuzzleDocument doc = new KuzzleDocument(dataCollection);
    doc.setContent("foo", "bar").save();
}

@Override
public void onError(JSONObject error) {
    // Handle error
}
});

KuzzleDocument

KuzzleDocument is an encapsulation of a JSONObject.

KuzzleDataCollection myCollection = new KuzzleDataCollection(kuzzle, "myNewCollection");
KuzzleDocument myDocument = new KuzzleDocument(myCollection);
// Add properties to the body
myDocument.setContent("foo", "bar");
// Persist the document
myDocument.save();
// Send it on real time (not persistent)
myDocument.publish();

Adding metadata

As stated here you can add metadata to a subscription.

KuzzleOptions options = new KuzzleOptions();
JSONObject metadata = new JSONObject();
metadata.put("foo", "bar");
options.setMetadata(metadata);
myCollection.subscribe(options);

Login

Prerequisite

To login using kuzzle you need at least one authentication plugin. You can refer here for a local authentication plugin or here to refer to an OAuth plugin with github.

Login with local strategy

If you have the kuzzle-plugin-auth-passport-local installed you can login using either the Kuzzle's constructor or the login method.

KuzzleOptions options = new KuzzleOptions();
kuzzle = new Kuzzle("localhost", options);

Login with an OAuth strategy

If you have an OAUTH plugin like kuzzle-plugin-auth-passport-oauth you can login and use the KuzzleWebViewClient to make it easier to handle.

Handler handler = new Handler();
WebView webView = (WebView) findViewById(R.id.webView);
webView.setWebViewClient(kuzzle.getKuzzleWebViewClient());
kuzzle.login("github", new KuzzleResponseListener<JSONObject>() {
      @Override
      public void onSuccess(final JSONObject object) {
        handler.post(new Runnable() {
          @Override
          public void run() {
            try {
              if (object.has("headers")) {
                webView.loadUrl(object.getJSONObject("headers").getString("Location"));
              }
            } catch (JSONException e) {
              e.printStackTrace();
            }
          }
        });
      }

      @Override
      public void onError(JSONObject error) {
        Log.e("error", error.toString());
      }
    });

Javadoc

You can find the java doc of the SDK here: http://kuzzleio.github.io/sdk-android/