PDF Web SDK Documentation

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

PDF Web SDK
    Preparing search index...

    Interface ITranslateCommandData

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

    interface ITranslateCommandData {
        abortSignal: AbortSignal;
        backgroundCallbackUrl?: string;
        callback: (progress: number) => void;
        client: ITranslateClient;
        from: string;
        onFileTooLargeError?: () => void;
        onMovedToBackground?: () => void;
        onStep?: (step: ProcessingStep) => void;
        onUnauthorizedError?: () => void;
        pages: number[];
        to: string;
        useOcr: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    abortSignal backgroundCallbackUrl? callback client from onFileTooLargeError? onMovedToBackground? onStep? onUnauthorizedError? pages to useOcr

    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: ITranslateClient
    from: string
    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.

    to: string
    useOcr: boolean

    Settings

    Member Visibility

    On This Page

    Properties