Module plugin-dropbox

Set up your Dropbox application

To access Dropbox APIs, generate a unique App Key for your app in the Dropbox Console. Add the * *App Key** to your app’s code and complete the required Dropbox Console setup steps:

  1. Go to the Dropbox Console.
  2. Click on “Create app” to start creating a new Dropbox application.

Edit Your Resources and Manifest

Create strings for your Dropbox App Key. Also, add AuthActivity to your Android manifest.

  1. Open your /app/res/values/strings.xml file.

  2. Add a new string element with the name db_login_protocol_scheme and set the value to your App ID. For example, if your app ID is 1234, your code looks like the following:


<string name="db_login_protocol_scheme">db-1234</string>

  1. Open the /app/manifest/AndroidManifest.xml file.

  2. Configure an intent filter in the Android Manifest, using your redirect URI:


<activity android:name="com.dropbox.core.android.AuthActivity"
    android:configChanges="orientation|keyboard" android:exported="true"
    android:launchMode="singleTask">
    <intent-filter>
        <data android:scheme="@string/db_login_protocol_scheme" />

        <action android:name="android.intent.action.VIEW" />

        <category android:name="android.intent.category.BROWSABLE" />
        <category android:name="android.intent.category.DEFAULT" />
    </intent-filter>

    <!-- Additional intent-filter required as a workaround for Apps using targetSdk=33 until the fix in the Dropbox app is available to all users. -->
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
    </intent-filter>
</activity>
  1. Add Dropbox package to queries:

<queries>
    <package android:name="com.dropbox.android" />
</queries>

You can find more information on how to integrate the Dropbox SDK by following the official documentation.

Add the App Key to your app

You should not check your App Key into your version control system, so it is recommended storing it in the local.properties file, which is located in the root directory of your project. For more information about the local.properties file, see Gradle properties files.

Open the local.properties in your project level directory, and do the following:

  • Replace YOUR_DROPBOX_APP_KEY with your APP ID: DROPBOX_APP_KEY=YOUR_DROPBOX_APP_KEY.

Gradle configuration

To incorporate Dropbox plugin into your project, you have to directly include the Dropbox plugin as a dependency. In the build.gradle.kts, add the following implementation statement to the dependencies{} section:

implementation("com.openmobilehub.android.auth:plugin-dropbox:2.0.4")

Save the file and sync your project with Gradle.

Provide the Dropbox OMH Auth Client

In the SingletonModule.kt file in the :auth-starter-sample module add the following code to provide the Dropbox OMH Auth Client.

@Provides
fun providesDropboxAuthClient(@ApplicationContext context: Context): DropboxAuthClient {
    return DropboxAuthClient(
        scopes = arrayListOf("account_info.read"),
        context = context,
        appId = BuildConfig.DROPBOX_APP_KEY,
    )
}

We’d recommend to store the client as a singleton with your preferred dependency injection library as this will be your only gateway to the OMH Auth SDK and it doesn’t change in runtime at all.

Escape Hatch

This plugin provides an escape hatch to access the native Dropbox Android SDK. This allows developers to use the underlying provider’s API directly, should they need to access a feature of the provider that is not supported by the OMH plugin.

You can obtain the Dropbox client instances by casting the result of getProviderSdk to DbxClientV2:

import com.dropbox.core.v2.DbxClientV2
...
authClient.getProviderSdk() as DbxClientV2