README.md

---

---

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

---

• Getting Started
  • Compatibility
  • Add Dependency
  • Setup
• Contributing
• More Parse Android Projects

Getting Started

Compatibility

The Parse Android SDK has the following Android API and Gradle Plugin compatibility.

SDK version	Minimum API level	Targeting API level	Gradle Plugin
1.26	< API 16	API 29	3.6.2
2.0	>= API 16	API 30	4.2.2
2.1	>= API 21	API 31	7.0.3

Add Dependency

Add the line maven { url 'https://www.jitpack.io' } to your settings.gradle file, inside the repositories property, for example:

dependencyResolutionManagement {
    repositories {
        maven { url 'https://www.jitpack.io' }
    }
}

Older versions of Android studio require different steps. See the following list of Android Studio versions for alternative instructions. You can find the version of your Android Studio installation by clicking on Help > About in the top menu.

Arctic Fox | 2020.3.1 or older

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 file.

Then, add the library to your (module:app) build.gradle file, replacing latest.version.here with the version of the Parse Android SDK you would like to use. We commend always updating your app to use the latest release version.

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"
}

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.

Contributing

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

More Parse Android Projects

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

• ParseGoogleUtils - Google login/signup.
• ParseFacebookUtils - Facebook login/signup.
• ParseTwitterUtils - Twitter login/signup.
• Parse FCM - Firebase Cloud Messaging support for sending push notifications.
• Parse KTX - Kotlin extensions for ease of developer use.
• Parse Coroutines - Kotlin Coroutines support for various Parse async operations
• Parse RxJava - Transform Parse Tasks to RxJava Completables and Singles
• ParseLiveQuery - Realtime query subscription.
• ParseUI - Prebuilt UI elements.

---

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.