PSPDFKit 8.9 Migration Guide

This guide provides the necessary steps for migrating from PSPDFKit 8 for Android to PSPDFKit 8.9 for Android.

Before updating to PSPDFKit 8.9 for Android, make sure your app is running at least PSPDFKit 8 for Android. If you’re running an earlier version, see our previous migration guides first, which will guide you through the necessary update steps up to version 8.9.

Upgrading PSPDFKit

Inside your app/build.gradle file, update the version of the com.pspdfkit:pspdfkit dependency to 8.9.0:

dependencies {
-   implementation 'com.pspdfkit:pspdfkit:8.8.0'
+   implementation 'com.pspdfkit:pspdfkit:8.9.0'
 }

Upgrading OCR Dependencies

If your project also integrates the PSPDFKit OCR Library, make sure to upgrade the version of all OCR dependencies too:

dependencies {
-   implementation 'com.pspdfkit:pspdfkit-ocr:8.8.0'
-   implementation 'com.pspdfkit:pspdfkit-ocr-english:8.8.0'
+   implementation 'com.pspdfkit:pspdfkit-ocr:8.9.0'
+   implementation 'com.pspdfkit:pspdfkit-ocr-english:8.9.0'
    ...
}

API Changes

PSPDFKit 8.9 for Android introduces a simplified digital signing API designed to make it easier to add ETSI standard PAdES advanced digital signatures to your documents. There are a few breaking API changes that this version brings, so if you’re using any of the digital signature APIs, read carefully.

From this release, Signer and all its child classes — like MemorySigner and Pkcs12Signer — are deprecated. Instead, use SigningManager, which enables you to sign documents with ease:

val signerOptions = SignerOptions.Builder(signatureFormField, outputFileUri)
    .setPrivateKey(key)
    .build()

SigningManager.signDocument(context = context,
     signerOptions = signerOptions,
     type = digitalSignatureType,
     onFailure = {  /* Handle signing errors here..*/  },
     onSuccess = {  /* The document was successfully signed! */ }
     )