Interface IImportEntryRequest

Request body for importing an entry.

interface IImportEntryRequest {
    autoRename?: boolean;
    generateImagePagesText?: boolean;
    importAsElectronicDocument?: boolean;
    metadata?: LfRepositoryClientV2.ImportEntryRequestMetadata;
    name: string;
    pdfOptions?: LfRepositoryClientV2.ImportEntryRequestPdfOptions;
    volumeName?: string;
}

Implemented by

Properties

autoRename? generateImagePagesText? importAsElectronicDocument? metadata? name pdfOptions? volumeName?

Properties

OptionalautoRename

autoRename?: boolean

Indicates if the entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.

OptionalgenerateImagePagesText

generateImagePagesText?: boolean

Whether to generate searchable text (OCR) for image pages added via imageFiles. Default: true. Does not affect pages generated from file — use pdfOptions.generateText for those.

OptionalimportAsElectronicDocument

importAsElectronicDocument?: boolean

Whether the file is imported as the electronic document (true) or as image pages (false). Default: false. This flag is only effective when the file extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png. For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag.

Optionalmetadata

metadata?: LfRepositoryClientV2.ImportEntryRequestMetadata

The metadata that will be assigned to the entry.

name

name: string

The name for the imported entry.

OptionalpdfOptions

pdfOptions?: LfRepositoryClientV2.ImportEntryRequestPdfOptions

The options applied when importing a PDF.

OptionalvolumeName

volumeName?: string

The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud.

Settings

Member Visibility

On This Page

Properties