PSPDFKit 2024.4 Migration Guide
This guide outlines the changes to PSPDFKit for Android 2024.4.
Breaking API Changes
Legacy Digital Signature APIs
Since version 8.9 was released last year, the old signing API has been deprecated in favor of the much simpler SigningManager API. See the migration guide here. We also have Catalog examples showing how to use the new API here and here, as well as a guide here.
Since version 2024.4, the deprecated code has been removed. It should be clear in your IDE where in your code you’re using the deprecated code. If you need help, contact Support.
There are additional public APIs and resources without a deprecation period that were removed in this release:
-
PdfFragment#setSignatureMetadata()
andPdfFragment#getSignatureMetadata()
have been removed. Metadata isn’t stored anywhere and is only used in the signing process. -
PdfFragment#setDocumentSigningListener()
has been removed, as we don’t have a signing listener. Signing is done via programmatic API only. -
DocumentSigningListener
has been removed, as it’s no longer used. -
Signature#getSignerIdentifier()
has been removed, as we have no need to storeSigner
. -
Signature#create()
methods have changed to removesignerIdentifier
, as it’s no longer required. -
SignatureCertificateSelectionMode
has been removed, as we don’t store certificates. -
PdfConfiguration#signatureCertificateSelectionMode
has been removed, as we don’t store certificates. -
SignatureOptions
has been changed to remove theSignatureCertificateSelectionMode
anddefaultSigner
properties, as they’re no longer required. -
Style attributes:
pspdf__signerChipIconBackground
,pspdf__signerChipIconRes
, andpspdf__signerChipIconTint
are no longer available and can be deleted. There’s no replacement, as we no longer storeSigner
objects in the SDK.
Deprecated APIs
-
AnnotationEditingController#saveCurrentlySelectedAnnotation()
has been deprecated and replaced by the pluralsaveCurrentlySelectedAnnotations()
.