pspdfkit-cordova-android

This plugin defines a global PSPDFKit object, which provides an API for viewing PDF documents with PSPDFKit for Android.

Installation

cordova plugin add https://github.com/PSPDFKit/Cordova-Android.git

Example

function showMyDocument() {
	PSPDFKit.showDocumentFromAssets('www/documents/myFile.pdf');
}

PSPDFKit.showDocument

Opens a document from the local device storage.

PSPDFKit.showDocument(uri, success, fail)

PSPDFKit.showDocumentFromAssets

Opens a document from the app's asset directory. To package a file within your app's assets, put it into the www/ directory of your project.

PSPDFKit.showDocumentFromAssets(assetPath, success, fail)

Supported Platforms

• Android SDK API level 15+ / Android 4.0.3+ (Ice Cream Sandwich MR1)

Quickstart Guide

Create a new Apache Cordova project from your command line using the Apache Cordova Command-Line Interface (CLI).

$ cordova create pdfapp com.example.pdfapp PDF-App
$ cd pdfapp

Important: Your app's package name (in the above example com.example.pdfapp) has to match your PSPDFKit license name or PSPDFKit will throw an exception.

Add Android platform support to your project:

$ cordova platform add android

Install the PSPDFKit plugin:

$ cordova plugin add https://github.com/PSPDFKit/Cordova-Android.git

Copy the PSPDFKit library file (usually pspdfkit-<version>.aar) into your project. This example uses version 1.3.0 of the PSPDFKit library. The current working directory has to be your project directory:

$ cp /path/to/pspdfkit-1.3.0.aar platforms/android/libs/

Set the minimum SDK version of your Android application to 15. To do so, add the android-minSdkVersion preference to the android platform configuration of your config.xml. It should now look like this:

<platform name="android">
    <preference name="android-minSdkVersion" value="15" />
    <!-- more Android platform settings -->
</platform>

Configure your PSPDFKit license key inside the platforms/android/AndroidManifest:

<manifest>
	<application>
		<meta-data android:name="PSPDFKIT_LICENSE_KEY" android:value="..." />
	</application>
</manifest>

You are now ready to build your app!

$ cordova build