Gradle Integration

• Android Studio

• Project specifications:

  • Minimum API: 16 (using AndroidX)
  • Compile API: 34
  • Recommended target API: 34
  • If your app is using AndroidX you will also need to add android.useAndroidX=true and android.enableJetifier=true in your gradle.properties file. For more, check out our FAQ about AndroidX .

Create a new project on Android Studio called myApp.

For the purposes of this guide, you can start with an Empty Activity.

1. Open the settings.gradle file located in your project's root directory and add the Apryse Maven repository:

   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           google()
           mavenCentral()
           maven {
               url "https://pdftron-maven.s3.amazonaws.com/release"
           }
           jcenter() // Warning: this repository is going to shut down soon
       }
   }

   Apryse SDK for Android is hosted on a private Maven repository in Amazon S3, so an access token is required to download it. The project only communicates with Amazon S3 in order to download Apryse SDK for Android. Otherwise, no other communication between your environment and Amazon S3 (or any other external service) is required. If you prefer not to use Amazon S3, you can find an alternative approach here .

2. Open the build.gradle file in your app module's directory:

   

   Edit it to add a dependency for the full version of Apryse:

   android {
       defaultConfig {
           // ... Anything that was already here
           multiDexEnabled true
           vectorDrawables.useSupportLibrary = true
           manifestPlaceholders = [pdftronLicenseKey:PDFTRON_LICENSE_KEY]
       }
   }
   
   dependencies {
       // ... Anything that was already here
       implementation "com.pdftron:pdftron:11.0.0"
       implementation "com.pdftron:tools:11.0.0"
   
       implementation 'androidx.multidex:multidex:2.0.1'
   }

   The next part of this guide will use DocumentActivity to open and view a document which requires the full version of Apryse SDK. The standard version has lighter set of features to reduce the size of the APK.You can find out more about the differences between the two versions here . If you would like to use the standard version instead, please take a look at this guide

3. In your project's root directory, find the gradle.properties file. Copy the following line to it:

   # Add the PDFTRON_LICENSE_KEY variable here. 
   # For trial purposes leave it blank.
   # For production add a valid commercial license key.
   PDFTRON_LICENSE_KEY=

4. Open your AndroidManifest.xml file and add a <metadata> tag inside the <application> tag to be a placeholder for the license key:

   <application>
   <!-- Add license key in meta-data tag here. This should be inside the application tag. -->
       <meta-data
           android:name="pdftron_license_key"
           android:value="${pdftronLicenseKey}"/>
   </application>

View a document