Interface IImportEntryRequestPdfOptions

Server-side processing options for the imported file. Despite the type name, these fields apply to any supported electronic document as well as to files imported as image pages.

interface IImportEntryRequestPdfOptions {
    generatePages?: boolean;
    generatePagesImageType?: LfRepositoryClientV2.GeneratePagesImageType;
    generateText?: boolean;
    keepPdfAfterImport?: boolean;
}

Implemented by

Properties

generatePages? generatePagesImageType? generateText? keepPdfAfterImport?

Properties

OptionalgeneratePages

generatePages?: boolean

Render server-side image pages from the electronic document. Applicable when the file is imported as an electronic document. Default: false.

OptionalgeneratePagesImageType

generatePagesImageType?: LfRepositoryClientV2.GeneratePagesImageType

The image type used when generating image pages. The default value is StandardColor. This option is only applicable when GeneratePages is true.

OptionalgenerateText

generateText?: boolean

Generate searchable text for the imported file. For electronic documents, text is extracted from the document (or OCR'd when the source is image-based). For files imported as image pages (image file type with importAsElectronicDocument=false), the pages are OCR'd. Default: false. Does not affect pages added via imageFiles — use generateImagePagesText for those.

OptionalkeepPdfAfterImport

keepPdfAfterImport?: boolean

When GeneratePages is true, retain the original file as the electronic document. When false, only the generated image pages remain. Default: true. Ignored when GeneratePages=false.

Settings

Member Visibility

On This Page

Properties