Pdf React Native Reference Documentation

Pdf

Current Version: 11.6.1

PDF Signing, Metadata, and Attachments

Work with PDF signatures, embedded files, metadata, and LTV information

Chilkat.Pdf provides PDF operations focused on digital signatures, embedded files, metadata, signature verification, and long-term validation support. It can load PDFs from files or memory, inspect page, signature, and attachment counts, sign PDFs with visible or invisible signatures, verify existing signatures, retrieve signer certificates, and manage DSS/LTV verification information.

Digital signatures Sign, certify, countersign, timestamp, and verify PDF signatures.

Embedded files Add attachments to PDFs or extract existing embedded files.

Metadata Read, update, or insert XMP metadata in an existing PDF.

LTV and DSS Inspect or add certificates, OCSP responses, and CRL information.

The class is commonly used for PDF signing workflows, PDF/A-3-style embedded-file scenarios, signature validation, and adding long-term validation material after signing.

For an extended overview, see Pdf Class Overview.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, Pdf } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const pdf = new Pdf()
// ... the native object is released when `pdf` is garbage collected, or now with pdf.dispose()

new Pdf()

Creates the underlying native Chilkat object. Pdf is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  pdf.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // Pdf.someMethod(...): <reason>
  console.log(pdf.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await pdf.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // Pdf.someMethodAsync: <reason>
}

Properties

DebugLogFilePath

// read/write
debugLogFilePath: string

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Pdf React Native Reference Documentation

Pdf

Current Version: 11.6.1

Work with PDF signatures, embedded files, metadata, and LTV information

Object Creation

Errors

Properties

DebugLogFilePath

HasCertificationSig

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumEmbeddedFiles

NumPages

NumSignatures

OwnerPassword

SigAllocateSize

UncommonOptions

UserPassword

VerboseLogging

Version

Methods

AddEmbeddedFiles

AddEmbeddedFilesBd

AddSigningCert

AddVerificationInfo

AddVerificationInfoAsync

GetDss

GetEmbeddedFileBd

GetEmbeddedFileInfo

GetLastJsonData

GetMetadata

GetSignatureContent

GetSignerCert

GetUnsignedSigFields

LoadBd

LoadFile

SetHttpObj

SetSignatureJpeg

SetSigningCert

SetSigningCert2

SignPdf

SignPdfAsync

SignPdfBd

SignPdfBdAsync

UpdateMetadata

UpdateMetadataBd

VerifySignature

Events

PercentDone

ProgressInfo