Stitch SDK Deprecation Notice

Stitch SDK functionality has been moved into the Realm SDKs. Applications using a Stitch SDK can be migrated to the corresponding Realm SDK by using one of the Stitch SDK Migration Guides. Support for the Stitch SDKs will fully end on November 1, 2021.

MongoDB Stitch Android/Java SDK

The official MongoDB Stitch SDK for Android/Java.

Index

• Documentation
• Discussion
• Installation
• Example Usage

Documentation

• API/Javadoc Documentation
• MongoDB Stitch Documentation

Discussion

• MongoDB Stitch Users - Google Group
• MongoDB Stitch Announcements - Google Group

Installation

The SDK artifacts are hosted by JCenter/Bintray at https://bintray.com/mongodb/MongoDB. Use the jcenter() and mavenCentral() repositories to get these artifacts.

Android

Add the following to the build.gradle for your app module:

implementation 'org.mongodb:stitch-android-sdk:4.7.0'

Also add the following to your android block in your app module:

compileOptions {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
}

This will start you off with the core SDK functionality as well as the remote MongoDB service.

For customized dependencies use the following:

implementation 'org.mongodb:stitch-android-core:4.7.0'
implementation 'org.mongodb:stitch-android-services-aws:4.7.0'
implementation 'org.mongodb:stitch-android-services-fcm:4.7.0'
implementation 'org.mongodb:stitch-android-services-http:4.7.0'
implementation 'org.mongodb:stitch-android-services-mongodb-remote:4.7.0'
implementation 'org.mongodb:stitch-android-services-twilio:4.7.0'

R8 / ProGuard

For Android applications with ProGuard and minify enabled, the Stitch SDK provides a consumer ProGuard rules file that will automatically be applied when including the SDK.

If you experience any ProGuard related warnings or error when using the Stitch SDK with an application where minify is enabled, try manually adding the rules in android/core/lib-proguard-rules.pro to your application's proguard-rules.pro file. If that doesn't work, please open an issue on this repository.

Server/Java

Add the following to the build.gradle for your module:

implementation 'org.mongodb:stitch-server-sdk:4.7.0'

This will start you off with the core SDK functionality as well as the remote MongoDB service.

For customized dependencies use the following:

implementation 'org.mongodb:stitch-server-core:4.7.0'
implementation 'org.mongodb:stitch-server-services-aws:4.7.0'
implementation 'org.mongodb:stitch-server-services-fcm:4.7.0'
implementation 'org.mongodb:stitch-server-services-http:4.7.0'
implementation 'org.mongodb:stitch-server-services-mongodb-remote:4.7.0'
implementation 'org.mongodb:stitch-server-services-twilio:4.7.0'

Example Usage

Creating a new app with the SDK (Android)

Set up an application on Stitch

1. Go to https://stitch.mongodb.com/ and log in to MongoDB Atlas.
2. Create a new app in your project with your desired name.
3. Go to your app in Stitch via Atlas by clicking Stitch Apps in the left side pane and clicking your app.
4. Copy your app's client app id by going to Clients on the left side pane and clicking copy on the App ID section.
5. Go to Providers from Users in the left side pane and edit and enable "Allow users to log in anonymously".

Set up a project in Android Studio using Stitch

1. Download and install Android Studio.

2. Start a new Android Studio project.

   • Note: The minimum supported API level is 21 (Android 5.0 Lollipop)
   • Starting with an empty activity is ideal

3. In your build.gradle for your app module, add the following to your dependencies block:

   implementation 'org.mongodb:stitch-android-sdk:4.7.0'

4. In your build.gradle for your app module, add the following to your android block:

   compileOptions {
       sourceCompatibility = JavaVersion.VERSION_1_8
       targetCompatibility = JavaVersion.VERSION_1_8
   }

5. Android Studio will prompt you to sync your changes in your project; hit Sync Now.

Set up an Android Virtual Device

1. In Android Studio, go to Tools, Android, AVD manager.
2. Click Create Virtual Device.
3. Select a device that should run your app (as of Android Studio 3.2, the default device does not work properly for this purpose).
4. Select and download a recommended system image of your choice (the latest is fine).
   • This device must use a system image built on an architecture supported by the libmongo library, e.g. x86_64
     • x86 images are unsupported
     • x86_64 images are available in the x86 tab.
   • The current minimum Android API version: 21
   • Please consult the the MongoDB Mobile Documentation for more information about minimum device requirements.
5. Name your device and hit finish.

Using the SDK

Set up app info

1. Create a resource values file in your app (e.g. res/values/mongodb-stitch.xml) and set the following using the app id you copied earlier in place of YOUR_APP_ID:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="stitch_client_app_id">YOUR_APP_ID</string>
</resources>

Logging In

1. Since we enabled anonymous log in, let's log in with it; add the following anywhere in your code:

  final StitchAppClient client = Stitch.getDefaultAppClient();
  client.getAuth().loginWithCredential(new AnonymousCredential()).addOnCompleteListener(
      new OnCompleteListener<StitchUser>() {
        @Override
        public void onComplete(@NonNull final Task<StitchUser> task) {
          if (task.isSuccessful()) {
            Log.d("myApp", String.format(
                "logged in as user %s with provider %s",
                task.getResult().getId(),
                task.getResult().getLoggedInProviderType()));
          } else {
            Log.e("myApp", "failed to log in", task.getException());
          }
        }
  });

2. Now run your app in Android Studio by going to run, Run 'app'. Use the Android Virtual Device you created previously

3. Once the app is running, open up Logcat in the bottom of Android studio and you should see the following log message:

   logged in as user 5b0483778f25b978044aca76 with provider anon-user
   

Getting a StitchAppClient without Stitch.getDefaultAppClient

In the case that you don't want a default initialized StitchAppClient by setting up the resource values, you can use the following code once to initialize a client for a given app id that you copied earlier:

final StitchAppClient client = Stitch.initializeAppClient("YOUR_APP_ID");

You can use the client returned there or anywhere else in your app you can use the following:

final StitchAppClient client = Stitch.getAppClient("YOUR_APP_ID");