/Parse-SDK-Android

The Android SDK for the Parse Platform

Primary LanguageJavaOtherNOASSERTION

Parse SDK for Android

License Build Status Backers on Open Collective Sponsors on Open Collective Twitter Follow

A library that gives you access to the powerful Parse cloud platform from your Android app. For more information about Parse and its features, see the website, getting started, and blog.

Dependency

Add this in your root build.gradle file (not your module build.gradle file):

allprojects {
	repositories {
		...
		maven { url "https://jitpack.io" }
	}
}

Then, add the library to your project build.gradle

ext {
   parseVersion = "latest.version.here"
}
dependencies {
    implementation "com.github.parse-community.Parse-SDK-Android:parse:$parseVersion"
    // for Google login/signup support (optional)
    implementation "com.github.parse-community.Parse-SDK-Android:google:$parseVersion"
    // for Facebook login/signup support (optional)
    implementation "com.github.parse-community.Parse-SDK-Android:facebook:$parseVersion"
    // for Twitter login/signup support (optional)
    implementation "com.github.parse-community.Parse-SDK-Android:twitter:$parseVersion"
    // for FCM Push support (optional)
    implementation "com.github.parse-community.Parse-SDK-Android:fcm:$parseVersion"
    // for Kotlin extensions support (optional)
    implementation "com.github.parse-community.Parse-SDK-Android:ktx:$parseVersion"
    // for Kotlin coroutines support (optional)
    implementation "com.github.parse-community.Parse-SDK-Android:coroutines:$parseVersion"
    // for RxJava support (optional)
    implementation "com.github.parse-community.Parse-SDK-Android:rxjava:$parseVersion"
}

replacing latest.version.here with the latest released version (see JitPack badge above).

Setup

Initialize Parse in a custom class that extends Application:

import com.parse.Parse;
import android.app.Application;

public class App extends Application {
    @Override
    public void onCreate() {
      super.onCreate();

      Parse.initialize(new Parse.Configuration.Builder(this)
        .applicationId("YOUR_APP_ID")
        // if desired
        .clientKey("YOUR_CLIENT_KEY")
        .server("https://your-server-address/parse/")
        .build()
      );
    }
}

The custom Application class must be registered in AndroidManifest.xml:

<application
    android:name=".App"
    ...>
    ...
</application>

Note that if you are testing with a server using http, you will need to add android:usesCleartextTraffic="true" to your above <application> definition, but you should only do this while testing and should use https for your final product.

See the guide for the rest of the SDK usage.

How Do I Contribute?

We want to make contributing to this project as easy and transparent as possible. Please refer to the Contribution Guidelines.

Other Parse Projects

These are other official libraries we made that can help you create your Parse app.

License

Copyright (c) 2015-present, Parse, LLC.
All rights reserved.

This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.

As of April 5, 2017, Parse, LLC has transferred this code to the parse-community organization, and will no longer be contributing to or distributing this code.