A job that allows specific pages in a PDF file to be replaced with pages from multiple PDF files.

For more complex use cases, refer the CombinePDFJob.

Example

Sample Usage:

        baseReadStream = fs.createReadStream("<SOURCE_PATH>");
readStream1 = fs.createReadStream("<SOURCE_PATH>");

const credentials = new ServicePrincipalCredentials({
clientId: process.env.PDF_SERVICES_CLIENT_ID,
clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
});

const pdfServices = new PDFServices({credentials});

const [baseAsset, asset1] = await pdfServices.uploadAssets({
streamAssets: [{
readStream: baseReadStream,
mimeType: MimeType.PDF
}, {
readStream: readStream1,
mimeType: MimeType.PDF
}]
});

const params = new ReplacePagesParams(baseAsset)
.addPagesForReplace({
asset: asset1,
basePage: 1
});

const job = new ReplacePagesJob({params});

const pollingURL = await pdfServices.submit({job});

const pdfServicesResponse = await pdfServices.getJobResult({
pollingURL,
resultType: InsertPagesResult
});

const resultAsset = pdfServicesResponse.result.asset;
const streamAsset = await pdfServices.getContent({asset: resultAsset});

Hierarchy (view full)

Constructors

  • Constructs a new ReplacePagesJob instance.

    Parameters

    Returns ReplacePagesJob

    Remarks

    External assets can be set as output only when input is external asset as well.

Properties

_outputAsset?: Asset
_replacePagesParams: ReplacePagesParams

Methods

  • Parameters

    Returns PDFServicesApiRequest

  • Parameters

    • baseAsset: Asset
    • assetsToReplace: Map<number, CombinePDFJobInput>

    Returns CombinePDFParams

  • Parameters

    • executionContext: ExecutionContext

    Returns void

Generated using TypeDoc