The KidoZen SDK for Android provides libraries for developers to build connected mobile applications using KidoZen. This guide walks through the steps for setting up the SDK and running the code samples.

• Analytics support ( see the analytics example in the samples folder )

• Data Visualization support ( see the dataviz example in the samples folder )

• Support for G+ authentication ( see the gplus example in the samples folder )

• Support for custom providers authentication

The KidoZen SDK for Android includes:

• Source code
• Class libraries: Build Android applications on top of class libraries that hide much of the lower-level plumbing of the web service interface, including authentication, caching, and error handling.

To get Your Credentials Register at KidoZen

• Android SDK Build Tools 19.1 For more information on the Android SDK, see
• Google Play Services Library (User Android SDK Manager to get it)
• Google Repository (User Android SDK Manager to get it)
• To run the code examples, you also need the Android Studio 1.0.1 or above

The SDK now is packaged as a Gradle project, you can either include the full code or include a jar file

• Create a new Android Project
• Create a new 'library' folder in your project and copy the SDK folder inside it
• Open the file settings.gradle and add the following line of code: 'include ':library:client' This set ups the client as a new module
• Select your application module settings and add the client depency
• Rebuild your project to update all dependencies

You can also create the jars file using gradle by typing the following in your terminal:

	./gradlew jarRelease androidJavadocsJar androidSourcesJar

This will generate two files in the 'builds/libs' folder

• client.jar : the SDK as .jar file
• client-javadoc.jar : javadocs
• client-sources.jar: sources

The integration tests code can help you to understand how to use some features of the SDK. To run the tests execute the following command:

	./gradlew test --info -Ptenant=TENANT -Papp=APP -Pkey=KEY -Pprovider=PROVIDER -Puser=USER -Ppass=SECRET -Pservice=SERVICE -Pemail_to=EMAIL -Pemail_attach=PATH_TO_FILE

where:

• TENANT : your KidoZen marketplace url eg: https://contoso.kidocloud.com
• APP : the KidoZen application you want to use eg: tasks
• KEY : the application key, you can find it in the marketplace
• PROVIDER : the Identity provider you want to use for user authentication eg: Kidozen
• USER : the username
• SECRET : the user password
• SERVICE : the service name to execute some integration tests. Check the code of the files DsTest.java and EApiTest.java to configure the services and datasources properly
• EMAIL : email address to use for Email services integration tests
• PATH_TO_FILE : path to file to attach for Email services integration tests

##Getting started with the code One instance of the Application object has one or many instances of each of the services that you can find in the Kidozen platform (Storage, Queue, etc.)

###Initialization During initialization the SDK pulls the application configuration from the cloud services

	KZApplication app = new KZApplication(TENANT, APP_NAME, APP_KEY);

Getting application key

This key is used for secure authentication in the KidoZen SDK’s, you must use this key in order to send crash logs to KidoZen platform. To get it browse the application marketplace and select the target application, you can find it below the application icon.

###Authentication You must provide the identity provider that you will use the username and the password (Kidozen, Google, etc.). The SDK hides all the calls needed to authenticate the user against the selected identity provider and to create a security context to execute all the services call.

app.Authenticate(USER, PASS, PROVIDER, new ServiceEventListener() {
    @Override
    public void onFinish(ServiceEvent e) {
    }
});

###Invoke services

Once the user is authenticated you can start using all the services:

####ServiceEventListener callback interface

The callback signature provides the onFinish method with the following information:

• StatusCode is the http status code response that the service invocation has returned

• Response the response body of the call. It could be an string with the description of the operation such as “Created” or “Internal server error” or a JSON Object with the results of one operation

• Exception the Exception object is there was one

    Storage storage= kidozen.Storage("orders");
    storage.Create(data, new ServiceResponseListener() {
        @Override
        public void onFinish(ServiceEvent e) {
            assertEquals(statusCode, HttpStatus.SC_CREATED);
        }
    );
  

####ServiceResponseListener callback interface (beta)

The callback signature provides the following methods:

• onStart : this is fired when the operation starts

• onSuccess: this is fired when the operation was successful.

• onError: this is fired when the operation failed

    Storage storage= kidozen.Storage("orders");
    storage.Create(data, new ServiceResponseListener() {
        @Override
            public void onSuccess(int statusCode, JSONObject response)
            {
                assertEquals(statusCode, HttpStatus.SC_CREATED);
            }
            @Override
            public void onError(int statusCode, String response)
            {
                fail();
            }
    );
  

####Synchronous interface (beta)

This interface will block the current thread

    Storage storage= kidozen.Storage(KZ_STORAGE_SERVICE_ID);
    JSONObject result = storage.Create(data, true);
    Assert.assertNotNull(result);

For more information please check the KidoZen documentation

You wil find samples about Social Authentication, Push notifications and other services inside the 'Samples' folder.

###Breaking changes with first version

• The constructor now requires an Application Id. You must get this ID from your marketplace
• The 'ByPassSSL' parameter changed his name and default value. Now its called 'StrictSSL' and its default value is TRUE instead of FALSE
• The 'OnSessionExpirationRunnable' method has been remove from the KZApplication object. You can create your own expiration handler using GetExpirationInMiliseconds() method of the KidoZen user instance

#License

Copyright (c) 2013 KidoZen, inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.