PDF Web SDK Documentation

Comprehensive Guide for Developers: UI & SDK Integration, Configuration, and API Reference

PDF Web SDK
    Preparing search index...

    Interface IPdfaConvertCommandData

    Shared input for online-tool commands (convert / ocr / translate) that hand the document to a long-running, page-scoped API operation.

    interface IPdfaConvertCommandData {
        abortSignal: AbortSignal;
        backgroundCallbackUrl?: string;
        callback: (progress: number) => void;
        client: IPdfaConvertClient;
        conformanceLevel?: string;
        convertMode?: string;
        onFileTooLargeError?: () => void;
        onMovedToBackground?: () => void;
        onStep?: (step: ProcessingStep) => void;
        onUnauthorizedError?: () => void;
        pages: number[];
        password?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    abortSignal backgroundCallbackUrl? callback client conformanceLevel? convertMode? onFileTooLargeError? onMovedToBackground? onStep? onUnauthorizedError? pages password?

    Properties

    abortSignal: AbortSignal
    backgroundCallbackUrl?: string

    Webhook handed to the API as X-Callback-Url when the operation outruns the poll window — see executeApiOperation.

    callback: (progress: number) => void
    client: IPdfaConvertClient
    conformanceLevel?: string

    Target PDF/A conformance level (e.g. pdfa1a, pdfa2b, pdfa3u). Defaults to pdfa1a server-side when omitted.

    convertMode?: string

    How the requested conformance level is produced: auto, exact, or downgrade. Defaults to auto server-side when omitted.

    onFileTooLargeError?: () => void
    onMovedToBackground?: () => void

    Called once the API has accepted that background re-submission.

    onStep?: (step: ProcessingStep) => void
    onUnauthorizedError?: () => void
    pages: number[]

    Page indices to process. When this is a strict subset of the document, the command extracts those pages into a temporary PDF and processes that whole; otherwise it processes the document's own bytes.

    password?: string

    Settings

    Member Visibility

    On This Page

    Properties