Some test text!

Loading...
Guides
Setup viewer

Setting up realtime document collaboration in Android

Prerequisites

  • Minimum API: 21
  • Java 8

Step 1: Integration

Integrate collaboration package with Gradle

  1. Integrate PDFTron core and the tools library as described here .

  2. In your app module's build.gradle file (usually app/build.gradle), set the minSdkVersion to 21+ and enable compatibility for Java 8 features. Then, add the dependency for PDFTron's collaboration package:

//@data {"ga":4242623008}// android { defaultConfig { minSdkVersion //variable android-collab-min// } compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } }

dependencies {
    implementation "com.pdftron:collab:9.1.1"
}
```

Integrate collaboration package manually

  1. Integrate PDFTron core and tools packages as described here .

  2. Copy pdftron-collab.aar directly into your app module's libs directory. You will see other PDFTron AARs here such as pdftron.aar and tools.aar

  3. In your app module's build.gradle file (usually app/build.gradle), make sure the minSdkVersion is 21+ using Java 8 features. And add a dependency to PDFTron collaboration package:

//@data {"ga":6815055711}// android { defaultConfig { minSdkVersion //variable android-collab-min// } compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } }

dependencies {
    implementation "com.pdftron:collab@aar"

    // room
    implementation "android.arch.persistence.room:runtime:2.2.5"
    annotationProcessor "android.arch.persistence.room:compiler:2.2.5"
    implementation "android.arch.persistence.room:rxjava2:2.2.5"
}
```

Step 2: Add the viewer

  1. Update your AndroidManifest.xml as described in Step 1 of this guide.

  2. Create the CollabViewerTabHostFragment2, and start it like any other Android Fragment.

    // Create a viewer fragment using CollabViewerBuilder2 and add it to an activity
    public void addViewerFragment(AppCompatActivity activity, Uri fileUri) {
        // Create a custom ViewerConfig used to initialize the viewer fragment
        ViewerConfig config = new ViewerConfig.Builder()
                .multiTabEnabled(false)
                .build();
        // Create the Fragment using CollabViewerBuilder2
        CollabViewerTabHostFragment2 tabHostFragment =
                CollabViewerBuilder2.withUri(fileUri)
                        .usingConfig(config)
                        .build(activity);
        // Add the Fragment to your activity
        FragmentTransaction ft = activity.getSupportFragmentManager().beginTransaction();
        ft.replace(R.id.fragment_container, tabHostFragment, null);
        ft.commit();
    }

where R.id.fragment_container is the resource id of a layout in your activity that will contain your fragment:

For example:

<?xml version="1.0" encoding="utf-8"?>
<!-- This FrameLayout will contain our viewer fragment -->
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/fragment_container"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>

Next steps

Get the answers you need: Support

UPCOMING WEBINAR: Live tech update and run-through. October 21 @ 11am PDT