PDF Web SDK Documentation

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

PDF Web SDK
    Preparing search index...

    Interface IConvertToOfficeClient

    interface IConvertToOfficeClient {
        execute<TInput>(
            endpoints: { start: string },
            data: TInput,
            options: {
                download?: { signal?: AbortSignal };
                onStep?: (step: ProcessingStep) => void;
                poll?: {
                    onProgress?: (s: { progress?: number }) => void;
                    signal?: AbortSignal;
                };
                start?: { signal?: AbortSignal };
            },
        ): Promise<
            {
                download?: { ab: ArrayBuffer; contentType?: string; filename: string };
                finalStatus: { error?: IErrorLike; progress?: number; status: string };
            },
        >;
        startOperation<TInput>(
            endpoints: { start: string },
            data: TInput,
            options?: {
                headers?: Record<string, string | undefined>;
                signal?: AbortSignal;
            },
        ): Promise<{ id: string }>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    • Type Parameters

      • TInput

      Parameters

      • endpoints: { start: string }
      • data: TInput
      • options: {
            download?: { signal?: AbortSignal };
            onStep?: (step: ProcessingStep) => void;
            poll?: {
                onProgress?: (s: { progress?: number }) => void;
                signal?: AbortSignal;
            };
            start?: { signal?: AbortSignal };
        }

      Returns Promise<
          {
              download?: { ab: ArrayBuffer; contentType?: string; filename: string };
              finalStatus: { error?: IErrorLike; progress?: number; status: string };
          },
      >

    • Fire-and-forget start: POSTs the operation and resolves as soon as the API has accepted it, without polling or downloading. Only used by IApiOperationOptions.backgroundCallbackUrl.

      Type Parameters

      • TInput

      Parameters

      • endpoints: { start: string }
      • data: TInput
      • Optionaloptions: { headers?: Record<string, string | undefined>; signal?: AbortSignal }

      Returns Promise<{ id: string }>