Getting Started

If you are starting with a fresh Android project or an existing app, follow these steps to add the Kinvey Android library to your app and set up the Kinvey Client.

Prerequisites

• Java Development Kit (JDK) >= 7
• Android SDK simply follow the installation instructions. This library currently supports Android 4.0.3 and higher.
• Intellij or Android Studio, with Gradle.
  • Google has announced the end of life of official support for the Eclipse ADT Plugin. We do distribute JAR files (within the libsJAR directory of the downloaded zip file) which can be used with other IDEs and build systems, however it is not offically supported.

Manual Project Set Up

Android Studio

1. In Android Studio, create a new Android project: File → New Project. The Application Name will be displayed to users, and the Module Name is used internally with Android Studio. Specify a package name ("com.myApp"), and set the Minimum SDK level to API 15 or greater. Set the Target SDK to your preferred platform level, and finally Compile With the highest API level available.
2. Download the latest Kinvey library (zip) and extract the downloaded zip file.
3. Within Android Studio, right click on your project and select Reveal In Finder (OSX) or Reveal in Explorer (Windows)
4. In the window that opens, navigate to the directory MyApplicationName/app/libs. If the libs directory does not exist, create it.
5. Copy all JAR files and AAR files, from the lib/ folder of the extracted Kinvey library zip into the MyApplicationName/app/libs folder you opened in the previous step.
6. Expand Gradle Scripts in the Project Window, and select build.gradle(Module:app). Note this is NOT the Top-level build file.
7. Modify the dependencies and the repositories section, leaving any existing dependencies and repositories in place.

buildscript {
  repositories {
    jcenter() // or mavenCentral()
  }

dependencies {
    classpath 'com.android.tools.build:gradle:2.3.1'
  }
}

dependencies {
  compile fileTree(dir: 'libs', include: ['*.jar'])
  compile ':kinvey-android:+@aar'
  compile ':relinker:+@aar'
  compile ':realm-android-library:+@aar'
}

1. Expand Gradle Scripts in the Project Window, and select build.gradle(Project:MyApplicationName). Note this is the Top-level build file.
2. Modify the allprojects section, leaving any existing dependencies and repositories in place.

allprojects {
  repositories {
    jcenter()
    flatDir {
      dirs './libs'
    }
  }
}

Add an App Backend

In the Kinvey console, click "Create an App" and enter the name of your app when prompted.

You can find your key and secret in the dropdown menu in the environment sidebar.

Copy the key and secret when performing the next steps.

Initialize a Client

The Client.Builder is used to build and initialize the Client before making any calls to the Kinvey API.

The Client.Builder requires the App Key and App Secret obtained from the Kinvey console, as well as your Android Application context. Initializing a Client is usually done within your Application.

import com.kinvey.android.Client;

…
public class App extends Application {

    private Client mKinveyClient;

    @Override
    public void onCreate() {
        super.onCreate();
        mKinveyClient = new Client.Builder(this).build();
    }

    public Client getKinveyClient(){
        return kinveyClient;
    }

}

mKinveyClient = new Client.Builder(your_app_key, your_app_secret
    , this).setBaseUrl("<your dedicated host URL>".build();

You can use Client.sharedInstance() to get Client instance from any place of your app, but you have to initialize client before.

Using a properties file

Hard wiring the appKey and appSecret programatically is a handy way for you to initialize the Kinvey library. However, this is not always the best choice. Often times you may want more control over the library config and would prefer to keep it in a separate properties file.

Your kinvey.properties file in the assets folder of your project should contain the properties:

# Required settings
app.key=your_app_key
app.secret=your_app_secret

# Optional settings, 
#### required for push
gcm.enabled=true
gcm.senderID=mySenderID

#### required for Dedicated Kinvey customers
api.base.url=<your dedicated host URL>

In order to initialize Client with the properties file settings you need to call a different constructor method on the Client.Builder class, then call build().

mKinveyClient = new Client.Builder(this).build();

Verify Set Up

You can use myClient.ping(…) to verify that the app has valid credentials. The following code example:

• builds a new client
• pings the backend with the app credentials

mKinveyClient = new Client.Builder(appKey, appSecret, this.getApplicationContext()).build();

mKinveyClient.ping(new KinveyPingCallback() {

    public void onFailure(Throwable t) {
        Log.e(TAG, "Kinvey Ping Failed", t);
    }

    public void onSuccess(Boolean b) {
        Log.d(TAG, "Kinvey Ping Success");
    }
});

Every App has an Active User

Your app will be used by a real-life human being. This person is represented by the Active User. This user object must explicitly be created, either with a username and password, OAuth sign-on (such as Facebook, Google+, LinkedIn, etc.), or Mobile Identity Connect. See the User Guide for more information.

What's next

You are now ready to start building your awesome apps! Next we recommend diving into the User Guide or Data Store Guide to learn more about our service, or explore the sample apps to go straight to working projects.