Some test text!

menu
Setup viewerkeyboard_arrow_down

Setting up realtime document collaboration in Android

linkPrerequisites

  • Minimum API: 21
  • Java 8

linkStep 1: Integration

linkIntegrate 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:

    android {
        defaultConfig {
            minSdkVersion 21
        }
        compileOptions {
            sourceCompatibility JavaVersion.VERSION_1_8
            targetCompatibility JavaVersion.VERSION_1_8
        }
    }
    
    dependencies {
        implementation "com.pdftron:collab:7.1.4"
    }

linkIntegrate 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:

    android {
        defaultConfig {
            minSdkVersion 21
        }
        compileOptions {
            sourceCompatibility JavaVersion.VERSION_1_8
            targetCompatibility JavaVersion.VERSION_1_8
        }
    }
    
    dependencies {
        implementation "com.pdftron:collab@aar"
    
        // room
        implementation "android.arch.persistence.room:runtime:1.1.1"
        annotationProcessor "android.arch.persistence.room:compiler:1.1.1"
        implementation "android.arch.persistence.room:rxjava2:1.1.1"
    }

linkStep 2: Add the viewer

  1. Update your AndroidManifest.xml as described in Step 1 of this guide.
  2. Create the CollabViewerTabHostFragment, and start it like any other Android Fragment.

    // Create a viewer fragment using CollabViewerBuilder 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 CollabViewerBuilder
        CollabViewerTabHostFragment tabHostFragment =
                CollabViewerBuilder.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"/>

linkNext steps

Get the answers you need: Support

close

Free Trial

Get unlimited trial usage of PDFTron SDK to bring accurate, reliable, and fast document processing capabilities to any application or workflow.

Select a platform to get started with your free trial.

Unlimited usage. No email address required.