pdfire-client / 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): Unit` Add a document to the PDF.
addDocuments	`fun addDocuments(vararg documents: ConversionParameters): Unit` Add documents to the PDF.
toMap	`fun toMap(): Map<String, Any?>` Create a map from the parameters.
useStorage	`fun useStorage(configure: (StorageParameter) -> Unit): Unit` Serve the PDF via a custom cloud storage disk. `fun useStorage(use: Boolean = true): Unit` Serve the PDF via the default custom cloud storage disk.