pdfire-client

alltypes

abstract class AbstractResult : Result

AbstractResult()
open fun saveTo(path: String): Unit

data class ApiError

ApiError(message: String)
val message: String

class BadRequestException : RequestException

BadRequestException(errors: List<ApiError>)

class BytesResult : AbstractResult

BytesResult(bytes: ByteArray)
fun getBytes(): ByteArray

class Client

Client(apiKey: String)
var apiKey: String
@JvmStatic val baseUrl: String
fun convert(params: Parameters): Result
fun convertHTML(html: String, params: ConversionParameters? = null): Result
fun convertToByteArray(params: Parameters): ByteArray
fun convertURL(url: String, params: ConversionParameters? = null): Result
fun convertUsingCDN(params: Parameters): Conversion
fun convertUsingStorage(params: Parameters, configure: (StorageParameter) -> Unit = null): Conversion

class Conversion : AbstractResult

Conversion(initializedAt: OffsetDateTime, finishedAt: OffsetDateTime, status: String, error: String?, result: ConversionResult)
fun download(): ByteArray
val error: String?
val finishedAt: OffsetDateTime
fun getBytes(): ByteArray
val initializedAt: OffsetDateTime
val result: ConversionResult
val status: String

class ConversionException : RequestException

ConversionException(errors: List<ApiError>)

class ConversionParameters : Parameters

ConversionParameters(html: String? = null, url: String? = null, cdn: Boolean? = null, storage: StorageParameter? = null, landscape: Boolean? = null, printBackground: Boolean? = null, scale: Float? = null, format: PaperFormat? = null, paperWidth: String? = null, paperHeight: String? = null, margin: String? = null, marginTop: String? = null, marginRight: String? = null, marginBottom: String? = null, marginLeft: String? = null, pageRanges: MutableList<String> = mutableListOf(), headerTemplate: String? = null, footerTemplate: String? = null, preferCSSPageSize: Boolean? = null, viewportWidth: Float? = null, viewportHeight: Float? = null, blockAds: Boolean? = null, selector: String? = null, waitForSelector: String? = null, waitForSelectorTimeout: Duration? = null, waitUntil: WaitUntil? = null, waitUntilTimeout: Duration? = null, delay: Duration? = null, timeout: Duration? = null, headers: MutableMap<String, Any> = mutableMapOf(), emulateMedia: Media? = null, ownerPassword: String? = null, userPassword: String? = null, allowErrorPage: Boolean? = null, optimize: Boolean? = null)
fun addPageRange(range: String): ConversionParameters
var allowErrorPage: Boolean?
var blockAds: Boolean?
var cdn: Boolean?
var delay: Duration?
var emulateMedia: Media?
var footerTemplate: String?
var format: PaperFormat?
var headerTemplate: String?
var headers: MutableMap<String, Any>
var html: String?
var landscape: Boolean?
var margin: String?
var marginBottom: String?
var marginLeft: String?
var marginRight: String?
var marginTop: String?
var optimize: Boolean?
var ownerPassword: String?
var pageRanges: MutableList<String>
var paperHeight: String?
var paperWidth: String?
var preferCSSPageSize: Boolean?
var printBackground: Boolean?
var scale: Float?
fun secure(owner: String? = null, user: String? = null): ConversionParameters
var selector: String?
fun setAllowErrorPage(allowErrorPage: Boolean = true): ConversionParameters
fun setBlockAds(blockAds: Boolean = true): ConversionParameters
fun setCdn(cdn: Boolean): ConversionParameters
fun setDelay(delay: Duration): ConversionParameters
fun setFooterTemplate(html: String): ConversionParameters
fun setHeaderTemplate(html: String): ConversionParameters
fun setHtml(html: String): ConversionParameters
fun setLandscape(landscape: Boolean = true): ConversionParameters
fun setMargin(margin: Int): ConversionParameters
fun setMargin(margin: String): ConversionParameters
fun setMarginBottom(margin: Int): ConversionParameters
fun setMarginBottom(margin: String): ConversionParameters
fun setMarginBottomCentimeter(margin: Float): ConversionParameters
fun setMarginBottomInch(margin: Float): ConversionParameters
fun setMarginBottomMillimeter(margin: Float): ConversionParameters
fun setMarginBottomPixel(margin: Float): ConversionParameters
fun setMarginCentimeter(margin: Float): ConversionParameters
fun setMarginInch(margin: Float): ConversionParameters
fun setMarginLeft(margin: Int): ConversionParameters
fun setMarginLeft(margin: String): ConversionParameters
fun setMarginLeftCentimeter(margin: Float): ConversionParameters
fun setMarginLeftInch(margin: Float): ConversionParameters
fun setMarginLeftMillimeter(margin: Float): ConversionParameters
fun setMarginLeftPixel(margin: Float): ConversionParameters
fun setMarginMillimeter(margin: Float): ConversionParameters
fun setMarginPixel(margin: Float): ConversionParameters
fun setMarginRight(margin: Int): ConversionParameters
fun setMarginRight(margin: String): ConversionParameters
fun setMarginRightCentimeter(margin: Float): ConversionParameters
fun setMarginRightInch(margin: Float): ConversionParameters
fun setMarginRightMillimeter(margin: Float): ConversionParameters
fun setMarginRightPixel(margin: Float): ConversionParameters
fun setMarginTop(margin: Int): ConversionParameters
fun setMarginTop(margin: String): ConversionParameters
fun setMarginTopCentimeter(margin: Float): ConversionParameters
fun setMarginTopInch(margin: Float): ConversionParameters
fun setMarginTopMillimeter(margin: Float): ConversionParameters
fun setMarginTopPixel(margin: Float): ConversionParameters
fun setOptimize(optimize: Boolean = true): ConversionParameters
fun setPaperHeight(height: Int): ConversionParameters
fun setPaperHeight(height: String): ConversionParameters
fun setPaperHeightCentimeter(height: Float): ConversionParameters
fun setPaperHeightInch(height: Float): ConversionParameters
fun setPaperHeightMillimeter(height: Float): ConversionParameters
fun setPaperHeightPixel(height: Float): ConversionParameters
fun setPaperWidth(width: Int): ConversionParameters
fun setPaperWidth(width: String): ConversionParameters
fun setPaperWidthCentimeter(width: Float): ConversionParameters
fun setPaperWidthInch(width: Float): ConversionParameters
fun setPaperWidthMillimeter(width: Float): ConversionParameters
fun setPaperWidthPixel(width: Int): ConversionParameters
fun setPreferCSSPageSize(preferCSSPageSize: Boolean = true): ConversionParameters
fun setPrintBackground(printBackground: Boolean = true): ConversionParameters
fun setTimeout(timeout: Duration): ConversionParameters
fun setUrl(url: String): ConversionParameters
fun setWaitForSelectorTimeout(timeout: Duration): ConversionParameters
fun setWaitUntilTimeout(timeout: Duration): ConversionParameters
var storage: StorageParameter?
var timeout: Duration?
fun toMap(): Map<String, Any?>
var url: String?
fun useCdn(): ConversionParameters
fun useStorage(configure: (StorageParameter) -> Unit): ConversionParameters
fun useStorage(use: Boolean): ConversionParameters
var userPassword: String?
var viewportHeight: Float?
var viewportWidth: Float?
var waitForSelector: String?
var waitForSelectorTimeout: Duration?
var waitUntil: WaitUntil?
fun waitUntilDOM(): ConversionParameters
fun waitUntilLoad(): ConversionParameters
var waitUntilTimeout: Duration?
fun withHeaders(headers: Map<String, Any>): ConversionParameters

data class ConversionResult

ConversionResult(size: Int, expiresAt: OffsetDateTime?, runtime: Duration, url: String)
val expiresAt: OffsetDateTime?
val runtime: Duration
val size: Int
val url: String

class ForbiddenActionException : RequestException

ForbiddenActionException(errors: List<ApiError>)

enum class Media

Print
Screen
fun toString(): String

class MergeParameters : Parameters

MergeParameters(documents: MutableList<ConversionParameters> = mutableListOf(), ownerPassword: String? = null, userPassword: String? = null, cdn: Boolean? = null, storage: StorageParameter? = null)
fun addDocument(configure: (ConversionParameters) -> Unit = null): MergeParameters
fun addDocuments(vararg documents: ConversionParameters): MergeParameters
var cdn: Boolean?
var documents: MutableList<ConversionParameters>
var ownerPassword: String?
fun secure(owner: String? = null, user: String? = null): MergeParameters
fun setCdn(cdn: Boolean): MergeParameters
var storage: StorageParameter?
fun toMap(): Map<String, Any?>
fun useCdn(): MergeParameters
fun useStorage(configure: (StorageParameter) -> Unit): MergeParameters
fun useStorage(use: Boolean): MergeParameters
var userPassword: String?

enum class PaperFormat

A0
A1
A2
A3
A4
A5
A6
Ledger
Legal
Letter
Tabloid
fun toString(): String

interface Parameters

abstract fun setCdn(cdn: Boolean = true): Parameters
abstract fun toMap(): Map<String, Any?>
abstract fun useStorage(configure: (StorageParameter) -> Unit): Parameters
abstract fun useStorage(use: Boolean = true): Parameters

class QuotaException : RequestException

QuotaException(errors: List<ApiError>)

open class RequestException : Exception

RequestException(errors: List<ApiError>, default: String)
val errors: List<ApiError>

interface Result

abstract fun getBytes(): ByteArray
abstract fun saveTo(path: String): Unit

data class StorageParameter

StorageParameter(disk: String = "", path: String = "")
var disk: String
var path: String
fun toMap(): Map<String, Any?>

class UnauthorizedException : RequestException

UnauthorizedException(errors: List<ApiError>)

enum class WaitUntil

DOM
Load
fun toString(): String

package io.pdfire.client

abstract class AbstractResult : Result

AbstractResult()
open fun saveTo(path: String): Unit

data class ApiError

ApiError(message: String)
val message: String

class BadRequestException : RequestException

BadRequestException(errors: List<ApiError>)

class BytesResult : AbstractResult

BytesResult(bytes: ByteArray)
fun getBytes(): ByteArray

class Client

Client(apiKey: String)
var apiKey: String
@JvmStatic val baseUrl: String
fun convert(params: Parameters): Result
fun convertHTML(html: String, params: ConversionParameters? = null): Result
fun convertToByteArray(params: Parameters): ByteArray
fun convertURL(url: String, params: ConversionParameters? = null): Result
fun convertUsingCDN(params: Parameters): Conversion
fun convertUsingStorage(params: Parameters, configure: (StorageParameter) -> Unit = null): Conversion

class Conversion : AbstractResult

Conversion(initializedAt: OffsetDateTime, finishedAt: OffsetDateTime, status: String, error: String?, result: ConversionResult)
fun download(): ByteArray
val error: String?
val finishedAt: OffsetDateTime
fun getBytes(): ByteArray
val initializedAt: OffsetDateTime
val result: ConversionResult
val status: String

class ConversionException : RequestException

ConversionException(errors: List<ApiError>)

class ConversionParameters : Parameters

ConversionParameters(html: String? = null, url: String? = null, cdn: Boolean? = null, storage: StorageParameter? = null, landscape: Boolean? = null, printBackground: Boolean? = null, scale: Float? = null, format: PaperFormat? = null, paperWidth: String? = null, paperHeight: String? = null, margin: String? = null, marginTop: String? = null, marginRight: String? = null, marginBottom: String? = null, marginLeft: String? = null, pageRanges: MutableList<String> = mutableListOf(), headerTemplate: String? = null, footerTemplate: String? = null, preferCSSPageSize: Boolean? = null, viewportWidth: Float? = null, viewportHeight: Float? = null, blockAds: Boolean? = null, selector: String? = null, waitForSelector: String? = null, waitForSelectorTimeout: Duration? = null, waitUntil: WaitUntil? = null, waitUntilTimeout: Duration? = null, delay: Duration? = null, timeout: Duration? = null, headers: MutableMap<String, Any> = mutableMapOf(), emulateMedia: Media? = null, ownerPassword: String? = null, userPassword: String? = null, allowErrorPage: Boolean? = null, optimize: Boolean? = null)
fun addPageRange(range: String): ConversionParameters
var allowErrorPage: Boolean?
var blockAds: Boolean?
var cdn: Boolean?
var delay: Duration?
var emulateMedia: Media?
var footerTemplate: String?
var format: PaperFormat?
var headerTemplate: String?
var headers: MutableMap<String, Any>
var html: String?
var landscape: Boolean?
var margin: String?
var marginBottom: String?
var marginLeft: String?
var marginRight: String?
var marginTop: String?
var optimize: Boolean?
var ownerPassword: String?
var pageRanges: MutableList<String>
var paperHeight: String?
var paperWidth: String?
var preferCSSPageSize: Boolean?
var printBackground: Boolean?
var scale: Float?
fun secure(owner: String? = null, user: String? = null): ConversionParameters
var selector: String?
fun setAllowErrorPage(allowErrorPage: Boolean = true): ConversionParameters
fun setBlockAds(blockAds: Boolean = true): ConversionParameters
fun setCdn(cdn: Boolean): ConversionParameters
fun setDelay(delay: Duration): ConversionParameters
fun setFooterTemplate(html: String): ConversionParameters
fun setHeaderTemplate(html: String): ConversionParameters
fun setHtml(html: String): ConversionParameters
fun setLandscape(landscape: Boolean = true): ConversionParameters
fun setMargin(margin: Int): ConversionParameters
fun setMargin(margin: String): ConversionParameters
fun setMarginBottom(margin: Int): ConversionParameters
fun setMarginBottom(margin: String): ConversionParameters
fun setMarginBottomCentimeter(margin: Float): ConversionParameters
fun setMarginBottomInch(margin: Float): ConversionParameters
fun setMarginBottomMillimeter(margin: Float): ConversionParameters
fun setMarginBottomPixel(margin: Float): ConversionParameters
fun setMarginCentimeter(margin: Float): ConversionParameters
fun setMarginInch(margin: Float): ConversionParameters
fun setMarginLeft(margin: Int): ConversionParameters
fun setMarginLeft(margin: String): ConversionParameters
fun setMarginLeftCentimeter(margin: Float): ConversionParameters
fun setMarginLeftInch(margin: Float): ConversionParameters
fun setMarginLeftMillimeter(margin: Float): ConversionParameters
fun setMarginLeftPixel(margin: Float): ConversionParameters
fun setMarginMillimeter(margin: Float): ConversionParameters
fun setMarginPixel(margin: Float): ConversionParameters
fun setMarginRight(margin: Int): ConversionParameters
fun setMarginRight(margin: String): ConversionParameters
fun setMarginRightCentimeter(margin: Float): ConversionParameters
fun setMarginRightInch(margin: Float): ConversionParameters
fun setMarginRightMillimeter(margin: Float): ConversionParameters
fun setMarginRightPixel(margin: Float): ConversionParameters
fun setMarginTop(margin: Int): ConversionParameters
fun setMarginTop(margin: String): ConversionParameters
fun setMarginTopCentimeter(margin: Float): ConversionParameters
fun setMarginTopInch(margin: Float): ConversionParameters
fun setMarginTopMillimeter(margin: Float): ConversionParameters
fun setMarginTopPixel(margin: Float): ConversionParameters
fun setOptimize(optimize: Boolean = true): ConversionParameters
fun setPaperHeight(height: Int): ConversionParameters
fun setPaperHeight(height: String): ConversionParameters
fun setPaperHeightCentimeter(height: Float): ConversionParameters
fun setPaperHeightInch(height: Float): ConversionParameters
fun setPaperHeightMillimeter(height: Float): ConversionParameters
fun setPaperHeightPixel(height: Float): ConversionParameters
fun setPaperWidth(width: Int): ConversionParameters
fun setPaperWidth(width: String): ConversionParameters
fun setPaperWidthCentimeter(width: Float): ConversionParameters
fun setPaperWidthInch(width: Float): ConversionParameters
fun setPaperWidthMillimeter(width: Float): ConversionParameters
fun setPaperWidthPixel(width: Int): ConversionParameters
fun setPreferCSSPageSize(preferCSSPageSize: Boolean = true): ConversionParameters
fun setPrintBackground(printBackground: Boolean = true): ConversionParameters
fun setTimeout(timeout: Duration): ConversionParameters
fun setUrl(url: String): ConversionParameters
fun setWaitForSelectorTimeout(timeout: Duration): ConversionParameters
fun setWaitUntilTimeout(timeout: Duration): ConversionParameters
var storage: StorageParameter?
var timeout: Duration?
fun toMap(): Map<String, Any?>
var url: String?
fun useCdn(): ConversionParameters
fun useStorage(configure: (StorageParameter) -> Unit): ConversionParameters
fun useStorage(use: Boolean): ConversionParameters
var userPassword: String?
var viewportHeight: Float?
var viewportWidth: Float?
var waitForSelector: String?
var waitForSelectorTimeout: Duration?
var waitUntil: WaitUntil?
fun waitUntilDOM(): ConversionParameters
fun waitUntilLoad(): ConversionParameters
var waitUntilTimeout: Duration?
fun withHeaders(headers: Map<String, Any>): ConversionParameters

data class ConversionResult

ConversionResult(size: Int, expiresAt: OffsetDateTime?, runtime: Duration, url: String)
val expiresAt: OffsetDateTime?
val runtime: Duration
val size: Int
val url: String

class ForbiddenActionException : RequestException

ForbiddenActionException(errors: List<ApiError>)

enum class Media

Print
Screen
fun toString(): String

class MergeParameters : Parameters

MergeParameters(documents: MutableList<ConversionParameters> = mutableListOf(), ownerPassword: String? = null, userPassword: String? = null, cdn: Boolean? = null, storage: StorageParameter? = null)
fun addDocument(configure: (ConversionParameters) -> Unit = null): MergeParameters
fun addDocuments(vararg documents: ConversionParameters): MergeParameters
var cdn: Boolean?
var documents: MutableList<ConversionParameters>
var ownerPassword: String?
fun secure(owner: String? = null, user: String? = null): MergeParameters
fun setCdn(cdn: Boolean): MergeParameters
var storage: StorageParameter?
fun toMap(): Map<String, Any?>
fun useCdn(): MergeParameters
fun useStorage(configure: (StorageParameter) -> Unit): MergeParameters
fun useStorage(use: Boolean): MergeParameters
var userPassword: String?

enum class PaperFormat

A0
A1
A2
A3
A4
A5
A6
Ledger
Legal
Letter
Tabloid
fun toString(): String

interface Parameters

abstract fun setCdn(cdn: Boolean = true): Parameters
abstract fun toMap(): Map<String, Any?>
abstract fun useStorage(configure: (StorageParameter) -> Unit): Parameters
abstract fun useStorage(use: Boolean = true): Parameters

class QuotaException : RequestException

QuotaException(errors: List<ApiError>)

open class RequestException : Exception

RequestException(errors: List<ApiError>, default: String)
val errors: List<ApiError>

interface Result

abstract fun getBytes(): ByteArray
abstract fun saveTo(path: String): Unit

data class StorageParameter

StorageParameter(disk: String = "", path: String = "")
var disk: String
var path: String
fun toMap(): Map<String, Any?>

class UnauthorizedException : RequestException

UnauthorizedException(errors: List<ApiError>)

enum class WaitUntil

DOM
Load
fun toString(): String