pdfire-client / io.pdfire.client

Package io.pdfire.client

Types

AbstractResult

abstract class AbstractResult : Result

Base class for conversion results.

ApiError

data class ApiError

Represents an error from the API.

BytesResult

class BytesResult : AbstractResult

Contains the generated PDF as a byte array.

Client

class Client

Sends conversion parameters to the PDFire.io servers and builds the correct result.

Conversion

class Conversion : AbstractResult

Represents a conversion that has failed or is served via a CDN / custom cloud storage.

ConversionParameters

class ConversionParameters : Parameters

Configuration for a conversion.

ConversionResult

data class ConversionResult

The conversion result.

Media

enum class Media

CSS media types that can be emulated.

MergeParameters

class MergeParameters : Parameters

Configuration for a conversion of multiple documents (merge).

PaperFormat

enum class PaperFormat

Common paper formats provide ConversionParameters.paperWidth and ConversionParameters.paperHeight shortcuts.

Parameters

interface Parameters

Interface for conversion parameters.

Result

interface Result

Provides the PDF as a byte array and a function that saves it to a path on the disk.

StorageParameter

data class StorageParameter

Storage disk configuration.

WaitUntil

enum class WaitUntil

Options for the ConversionParameters.waitUntil option.

Exceptions

BadRequestException

class BadRequestException : RequestException

Exception for a 400 error response.

ConversionException

class ConversionException : RequestException

Exception for a 500 error response.

ForbiddenActionException

class ForbiddenActionException : RequestException

Exception for a 403 error response.

QuotaException

class QuotaException : RequestException

Exception for a 402 error response.

RequestException

open class RequestException : Exception

Generic exception for a failed conversion request.

UnauthorizedException

class UnauthorizedException : RequestException

Exception for a 401 error response.