pdfire / io.pdfire.client / MergeParameters

MergeParameters

class MergeParameters : Parameters

Configuration for a conversion of multiple documents (merge).

Options may require a minimum subscription tier to be usable. See the documentation for information on the available options.

Constructors

<init>

MergeParameters(documents: MutableList<ConversionParameters> = mutableListOf(), ownerPassword: String? = null, userPassword: String? = null, cdn: Boolean? = null, storage: StorageParameter? = null)

Configuration for a conversion of multiple documents (merge).

Properties

cdn

var cdn: Boolean?

Indicates if the PDF should be served via the CDN.

documents

var documents: MutableList<ConversionParameters>

Conversion options (ConversionParameters) for the documents.

ownerPassword

var ownerPassword: String?

Secures the PDF with an owner password.

storage

var storage: StorageParameter?

Storage configuration for the PDF.

userPassword

var userPassword: String?

Secures the PDF with a user password.

Functions

addDocument

fun addDocument(configure: (ConversionParameters) -> Unit = null): MergeParameters

Add a document to the PDF.

addDocuments

fun addDocuments(vararg documents: ConversionParameters): MergeParameters

Add documents to the PDF.

secure

fun secure(owner: String? = null, user: String? = null): MergeParameters

Secure the PDF with an owner / user password.

setCDN

fun setCDN(cdn: Boolean): MergeParameters

Set the CDN option.

toMap

fun toMap(): Map<String, Any?>

Create a map from the parameters.

useCDN

fun useCDN(): MergeParameters

Serve the PDF via the PDFire.io CDN.

useStorage

fun useStorage(configure: (StorageParameter) -> Unit): MergeParameters

Serve the PDF via a custom cloud storage disk.

fun useStorage(use: Boolean): MergeParameters

Serve the PDF via the default custom cloud storage disk.