groupdocs-conversion-cloud
Version:
GroupDocs.Conversion Cloud SDK for Node.js
2,218 lines • 86.4 kB
TypeScript
export declare class ApiError {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
code: string;
message: string;
description: string;
dateTime: Date;
innerError: ApiError;
constructor(init?: Partial<ApiError>);
}
export declare class ApiErrorResponse {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
requestId: string;
error: ApiError;
constructor(init?: Partial<ApiErrorResponse>);
}
/**
* Metered license consumption information
*/
export declare class ConsumptionResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Amount of used credits
*/
credit: number;
/**
* Amount of MBs processed
*/
quantity: number;
/**
* Billed API calls number
*/
billedApiCalls: number;
constructor(init?: Partial<ConsumptionResult>);
}
/**
* ConvertOptions base
*/
export declare class ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Start conversion from FromPage page
*/
fromPage: number;
/**
* Number of pages to convert
*/
pagesCount: number;
/**
* Convert specific pages. The list contains the page indexes of the pages to be converted
*/
pages: Array<number>;
/**
* Watermark specific options
*/
watermarkOptions: WatermarkOptions;
constructor(init?: Partial<ConvertOptions>);
}
/**
* Defines conversion request
*/
export declare class ConvertSettings {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* StorageName which contains the file
*/
storageName: string;
/**
* Gets or sets absolute path to a file in the storage
*/
filePath: string;
/**
* Gets or sets requested conversion format
*/
format: string;
/**
* Gets or sets format specific load options for source file
*/
loadOptions: LoadOptions;
/**
* Gets or sets format specific convert options for output file
*/
convertOptions: ConvertOptions;
/**
* Gets or sets converted file save path
*/
outputPath: string;
/**
* The path to directory containing custom fonts in storage
*/
fontsPath: string;
constructor(init?: Partial<ConvertSettings>);
}
/**
* Class for disc space information.
*/
export declare class DiscUsage {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Application used disc space.
*/
usedSize: number;
/**
* Total disc space.
*/
totalSize: number;
constructor(init?: Partial<DiscUsage>);
}
/**
* Contains a document metadata
*/
export declare class DocumentMetadata {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Document file type
*/
fileType: string;
/**
* Gets pages count if applicable to the current document format
*/
pageCount: number;
/**
* Document bytes size
*/
size: number;
/**
* Returns detected width if applicable to the current document format
*/
width: number;
/**
* Returns detected height if applicable to the current document format
*/
height: number;
/**
* Returns detected horizontal resolution if applicable to the current document format
*/
horizontalResolution: number;
/**
* Returns detected vertical resolution if applicable to the current document format
*/
verticalResolution: number;
/**
* Returns detected bits per pixel if applicable to the current document format
*/
bitsPerPixel: number;
/**
* Returns document title width if applicable to the current document format
*/
title: string;
/**
* Returns detected document author if applicable to the current document format
*/
author: string;
/**
* Returns detected document creation date if it's applicable to the current document format
*/
createdDate: Date;
/**
* Returns detected document modification date if applicable to the current document format
*/
modifiedDate: Date;
/**
* Returns list of layer names if applicable to the current document format
*/
layers: Array<string>;
/**
* Is document password protected
*/
isPasswordProtected: boolean;
constructor(init?: Partial<DocumentMetadata>);
}
/**
* The error details
*/
export declare class ErrorDetails {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* The request id
*/
requestId: string;
/**
* Date
*/
date: Date;
constructor(init?: Partial<ErrorDetails>);
}
/**
* Represents field label
*/
export declare class FieldLabel {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* The field name
*/
field: FieldLabel.FieldEnum;
/**
* The label e.g. \"Sender\"
*/
label: string;
constructor(init?: Partial<FieldLabel>);
}
export declare namespace FieldLabel {
enum FieldEnum {
Start,
TabField,
Subject,
ShowTimeAs,
Sent,
RequiredAttendees,
RecurrencePattern,
Recurrence,
PageHeader,
Organizer,
Location,
Importance,
From,
End,
Bcc,
Attachments,
To
}
}
/**
* File versions FileVersion.
*/
export declare class FileVersions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File versions FileVersion.
*/
value: Array<FileVersion>;
constructor(init?: Partial<FileVersions>);
}
/**
* Files list
*/
export declare class FilesList {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Files and folders contained by folder StorageFile.
*/
value: Array<StorageFile>;
constructor(init?: Partial<FilesList>);
}
/**
* File upload result
*/
export declare class FilesUploadResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* List of uploaded file names
*/
uploaded: Array<string>;
/**
* List of errors.
*/
errors: Array<Error>;
constructor(init?: Partial<FilesUploadResult>);
}
/**
* Jpg convert options
*/
export declare class JpgConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Desired image quality when converting to Jpeg. The value must be between 0 and 100. The default value is 100.
*/
quality: number;
constructor(init?: Partial<JpgConvertOptions>);
}
/**
* Current license information
*/
export declare class LicenseInfo {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* True, if license was applied and valid, otherwise False
*/
isLicensed: boolean;
constructor(init?: Partial<LicenseInfo>);
}
/**
* Load document options
*/
export declare class LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
*/
format: string;
constructor(init?: Partial<LoadOptions>);
}
/**
* Error
*/
export declare class ModelError {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Code
*/
code: string;
/**
* Message
*/
message: string;
/**
* Description
*/
description: string;
/**
* Inner Error
*/
innerError: ErrorDetails;
constructor(init?: Partial<ModelError>);
}
/**
* Object exists
*/
export declare class ObjectExist {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Indicates that the file or folder exists.
*/
exists: boolean;
/**
* True if it is a folder, false if it is a file.
*/
isFolder: boolean;
constructor(init?: Partial<ObjectExist>);
}
/**
* Operation status result
*/
export declare class OperationResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
id: string;
method: OperationResult.MethodEnum;
status: OperationResult.StatusEnum;
created: Date;
started: Date;
failed: Date;
canceled: Date;
finished: Date;
result: Array<StoredConvertedResult>;
error: string;
constructor(init?: Partial<OperationResult>);
}
export declare namespace OperationResult {
enum MethodEnum {
Convert,
ConvertAndSave
}
enum StatusEnum {
Created,
Started,
Failed,
Canceled,
Finished
}
}
/**
* Psd convert options
*/
export declare class PsdConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Bits count per color channel
*/
channelBitsCount: number;
/**
* Color channels count
*/
channelsCount: number;
/**
* Psd color mode
*/
colorMode: PsdConvertOptions.ColorModeEnum;
/**
* Psd compression method
*/
compressionMethod: PsdConvertOptions.CompressionMethodEnum;
/**
* Psd file version
*/
version: number;
constructor(init?: Partial<PsdConvertOptions>);
}
export declare namespace PsdConvertOptions {
enum ColorModeEnum {
Bitmap,
Grayscale,
Indexed,
Rgb,
Cmyk,
Multichannel,
Duotone,
Lab
}
enum CompressionMethodEnum {
Raw,
Rle,
ZipWithoutPrediction,
ZipWithPrediction
}
}
/**
* Rtf convert options
*/
export declare class RtfConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies whether the keywords for \"old readers\" are written to RTF or not. This can significantly affect the size of the RTF document. Default is False.
*/
exportImagesForOldReaders: boolean;
constructor(init?: Partial<RtfConvertOptions>);
}
/**
* Storage exists
*/
export declare class StorageExist {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Shows that the storage exists.
*/
exists: boolean;
constructor(init?: Partial<StorageExist>);
}
/**
* File or folder information
*/
export declare class StorageFile {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File or folder name.
*/
name: string;
/**
* True if it is a folder.
*/
isFolder: boolean;
/**
* File or folder last modified DateTime.
*/
modifiedDate: Date;
/**
* File or folder size.
*/
size: number;
/**
* File or folder path.
*/
path: string;
constructor(init?: Partial<StorageFile>);
}
/**
* Contains single converted item. Result is provided as url to a storage
*/
export declare class StoredConvertedResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Name of converted item
*/
name: string;
/**
* Size of converted item
*/
size: number;
/**
* Path of resource file in storage
*/
path: string;
/**
* Uri in the storage of the converted item
*/
url: string;
constructor(init?: Partial<StoredConvertedResult>);
}
/**
* Represents information about supported conversion for SourceFormat
*/
export declare class SupportedFormat {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets source format
*/
sourceFormat: string;
/**
* Gets or sets target formats
*/
targetFormats: Array<string>;
constructor(init?: Partial<SupportedFormat>);
}
/**
* Tiff convert options
*/
export declare class TiffConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Set Tiff compression
*/
compression: TiffConvertOptions.CompressionEnum;
constructor(init?: Partial<TiffConvertOptions>);
}
export declare namespace TiffConvertOptions {
enum CompressionEnum {
Lzw,
None,
Ccitt3,
Ccitt4,
Rle
}
}
/**
* Options for settings watermark to the converted document
*/
export declare class WatermarkOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Watermark text
*/
text: string;
/**
* Watermark font name if text watermark is applied
*/
fontName: string;
/**
* Watermark font name if text watermark is applied
*/
fontSize: number;
/**
* Watermark font bold style if text watermark is applied
*/
bold: boolean;
/**
* Watermark font italic style if text watermark is applied
*/
italic: boolean;
/**
* Watermark font color if text watermark is applied
*/
color: string;
/**
* Watermark width
*/
width: number;
/**
* Watermark height
*/
height: number;
/**
* Watermark top position
*/
top: number;
/**
* Watermark left position
*/
left: number;
/**
* Watermark rotation angle
*/
rotationAngle: number;
/**
* Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.
*/
transparency: number;
/**
* Indicates that the watermark is stamped as background. If the value is true, the watermark is layed at the bottom. By default is false and the watermark is layed on top.
*/
background: boolean;
/**
* Image watermark
*/
image: string;
/**
* Auto scale the watermark. If the value is true the font size and the position is automatically calculated to fit the page size.
*/
autoAlign: boolean;
constructor(init?: Partial<WatermarkOptions>);
}
/**
* Webp convert options
*/
export declare class WebpConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Indicates if the compression of the converted file will be lossless
*/
lossless: boolean;
constructor(init?: Partial<WebpConvertOptions>);
}
/**
* Options for to Cad conversion
*/
export declare class CadConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Desired page width after conversion
*/
width: number;
/**
* Desired page height after conversion
*/
height: number;
/**
* Page size
*/
pageSize: CadConvertOptions.PageSizeEnum;
constructor(init?: Partial<CadConvertOptions>);
}
export declare namespace CadConvertOptions {
enum PageSizeEnum {
Default,
A3,
Statement,
Quarto,
Paper11x17,
Paper10x14,
Letter,
Legal,
Ledger,
Folio,
Executive,
EnvelopeDL,
Custom,
B5,
B4,
A5,
A4,
Tabloid
}
}
/**
* Options for loading CAD documents
*/
export declare class CadLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Render specific CAD layouts
*/
layoutNames: Array<string>;
/**
* A type of drawing.
*/
drawType: CadLoadOptions.DrawTypeEnum;
/**
* A foreground color.
*/
drawColor: string;
/**
* A background color.
*/
backgroundColor: string;
constructor(init?: Partial<CadLoadOptions>);
}
export declare namespace CadLoadOptions {
enum DrawTypeEnum {
UseDrawColor,
UseObjectColor
}
}
/**
* Options for to zip conversion
*/
export declare class CompressionConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Set this property if you want to protect the converted document with a password
*/
password: string;
constructor(init?: Partial<CompressionConvertOptions>);
}
/**
* Options for loading compression documents
*/
export declare class CompressionLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Set password to load protected document.
*/
password: string;
constructor(init?: Partial<CompressionLoadOptions>);
}
/**
* Options for loading Database documents
*/
export declare class DatabaseLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<DatabaseLoadOptions>);
}
/**
* Options for to Diagram conversion
*/
export declare class DiagramConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets a value indicating whether to enlarge the page to fit the drawing content.
*/
autoFitPageToDrawingContent: boolean;
constructor(init?: Partial<DiagramConvertOptions>);
}
/**
* Diagram document load options
*/
export declare class DiagramLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Default font for Diagram document. The following font will be used if a font is missing.
*/
defaultFont: string;
constructor(init?: Partial<DiagramLoadOptions>);
}
/**
* Ebook convert options
*/
export declare class EBookConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies page size
*/
pageSize: EBookConvertOptions.PageSizeEnum;
/**
* Specifies page orientation
*/
pageOrientation: EBookConvertOptions.PageOrientationEnum;
constructor(init?: Partial<EBookConvertOptions>);
}
export declare namespace EBookConvertOptions {
enum PageSizeEnum {
Default,
A3,
Statement,
Quarto,
Paper11x17,
Paper10x14,
Letter,
Legal,
Ledger,
Folio,
Executive,
EnvelopeDL,
Custom,
B5,
B4,
A5,
A4,
Tabloid
}
enum PageOrientationEnum {
Default,
Landscape,
Portrait
}
}
/**
* Options for loading e-book documents
*/
export declare class EBookLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<EBookLoadOptions>);
}
/**
* Options for to Email conversion
*/
export declare class EmailConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<EmailConvertOptions>);
}
/**
* Options for loading Email documents
*/
export declare class EmailLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Defines whether need to keep original date header string in mail message when saving or not (Default value is true)
*/
preserveOriginalDate: boolean;
/**
* The mapping between email message field and field text representation
*/
fieldLabels: Array<FieldLabel>;
/**
* Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC.
*/
timeZoneOffset: string;
/**
* Option to display or hide sent date/time in the header. Default: true.
*/
displaySent: boolean;
/**
* Option to display or hide subject in the header. Default: true.
*/
displaySubject: boolean;
/**
* Option to display or hide attachments in the header. Default: true.
*/
displayAttachments: boolean;
displayEmailAddresses: boolean;
/**
* Option to display or hide \"Bcc\" email address. Default: false
*/
displayBccEmailAddress: boolean;
/**
* Option to display or hide \"Cc\" email address. Default: false
*/
displayCcEmailAddress: boolean;
/**
* Option to display or hide \"to\" email address. Default: true
*/
displayToEmailAddress: boolean;
/**
* Option to display or hide \"from\" email address. Default: true
*/
displayFromEmailAddress: boolean;
/**
* Option to display or hide the email header. Default: true
*/
displayHeader: boolean;
/**
* Default font for Email document. The following font will be used if a font is missing.
*/
defaultFont: string;
/**
* List of font substitutes.
*/
fontSubstitutes: {
[key: string]: string;
};
constructor(init?: Partial<EmailLoadOptions>);
}
/**
* File Version
*/
export declare class FileVersion extends StorageFile {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File Version ID.
*/
versionId: string;
/**
* Specifies whether the file is (true) or is not (false) the latest version of an file.
*/
isLatest: boolean;
constructor(init?: Partial<FileVersion>);
}
/**
* Options for to Finance conversion
*/
export declare class FinanceConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<FinanceConvertOptions>);
}
/**
* Options for loading Finance documents
*/
export declare class FinanceLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<FinanceLoadOptions>);
}
/**
* Options for to Font conversion
*/
export declare class FontConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<FontConvertOptions>);
}
/**
* Options for loading Font documents
*/
export declare class FontLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<FontLoadOptions>);
}
/**
* Options for to Gis conversion
*/
export declare class GisConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<GisConvertOptions>);
}
/**
* Options for loading Gis documents
*/
export declare class GisLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Page width for converting GIS document. Default is 1000.
*/
width: number;
/**
* Page height for converting GIS document. Default is 1000.
*/
height: number;
constructor(init?: Partial<GisLoadOptions>);
}
/**
* Options for to Image conversion
*/
export declare class ImageConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Desired image width after conversion
*/
width: number;
/**
* Desired image height after conversion
*/
height: number;
/**
* Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96dpi
*/
horizontalResolution: number;
/**
* Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96dpi
*/
verticalResolution: number;
/**
* Convert to grayscale image
*/
grayscale: boolean;
/**
* Image rotation angle
*/
rotateAngle: number;
/**
* If true, the input firstly is converted to PDF and after that to desired format
*/
usePdf: boolean;
/**
* Adjust image brightness
*/
brightness: number;
/**
* Adjust image contrast
*/
contrast: number;
/**
* Adjust image gamma
*/
gamma: number;
/**
* Image flip mode
*/
flipMode: ImageConvertOptions.FlipModeEnum;
/**
* Gets or sets a background color.
*/
backgroundColor: string;
/**
* Options for converting to Jpeg-compatible image
*/
jpegOptions: JpgConvertOptions;
/**
* Options for converting to PSD-compatible image
*/
psdOptions: PsdConvertOptions;
/**
* Options for converting to Tiff-compatible image
*/
tiffOptions: TiffConvertOptions;
/**
* Options for converting to WebP-compatible image
*/
webpOptions: WebpConvertOptions;
constructor(init?: Partial<ImageConvertOptions>);
}
export declare namespace ImageConvertOptions {
enum FlipModeEnum {
None,
FlipX,
FlipY,
FlipXY
}
}
/**
* Image document load options
*/
export declare class ImageLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing.
*/
defaultFont: string;
constructor(init?: Partial<ImageLoadOptions>);
}
/**
* Options for loading Mbox documents
*/
export declare class MboxLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<MboxLoadOptions>);
}
/**
* One document load options
*/
export declare class NoteLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Default font for Note document. The following font will be used if a font is missing.
*/
defaultFont: string;
/**
* Substitute specific fonts when converting Note document.
*/
fontSubstitutes: {
[key: string]: string;
};
/**
* Set password to unprotect protected document
*/
password: string;
constructor(init?: Partial<NoteLoadOptions>);
}
/**
* Options for loading Olm documents
*/
export declare class OlmLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Folder which to be processed Default is Inbox
*/
folder: string;
constructor(init?: Partial<OlmLoadOptions>);
}
/**
* Page description language convert options
*/
export declare class PDLConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Desired page width after conversion.
*/
width: number;
/**
* Desired page height after conversion.
*/
height: number;
constructor(init?: Partial<PDLConvertOptions>);
}
/**
* Options for to PDF conversion
*/
export declare class PdfConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Desired page width in pixels after conversion
*/
width: number;
/**
* Desired page height in pixels after conversion
*/
height: number;
/**
* Desired page DPI after conversion. The default resolution is: 96dpi
*/
dpi: number;
/**
* Set this property if you want to protect the converted document with a password
*/
password: string;
/**
* Desired page top margin in pixels after conversion
*/
marginTop: number;
/**
* Desired page bottom margin in pixels after conversion
*/
marginBottom: number;
/**
* Desired page left margin in pixels after conversion
*/
marginLeft: number;
/**
* Desired page right margin in pixels after conversion
*/
marginRight: number;
/**
* Set the pdf format of the converted document.
*/
pdfFormat: PdfConvertOptions.PdfFormatEnum;
/**
* Remove Pdf-A Compliance
*/
removePdfaCompliance: boolean;
/**
* Specifies the zoom level in percentage. Default is 100.
*/
zoom: number;
/**
* Linearize PDF Document for the Web
*/
linearize: boolean;
/**
* Link duplicate streams
*/
linkDuplicateStreams: boolean;
/**
* Remove unused objects
*/
removeUnusedObjects: boolean;
/**
* Remove unused streams
*/
removeUnusedStreams: boolean;
/**
* If CompressImages set to true, all images in the document are recompressed. The compression is defined by the ImageQuality property.
*/
compressImages: boolean;
/**
* Value in percent where 100% is unchanged quality and image size. To decrease the image size, use ImageQuality less than 100
*/
imageQuality: number;
/**
* Make fonts not embedded if set to true
*/
unembedFonts: boolean;
/**
* Convert a PDF from RGB colorspace to Grayscale
*/
grayscale: boolean;
/**
* Specify whether position of the document's window will be centered on the screen. Default: false.
*/
centerWindow: boolean;
/**
* Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R.
*/
direction: PdfConvertOptions.DirectionEnum;
/**
* Specifying whether document's window title bar should display document title. Default: false.
*/
displayDocTitle: boolean;
/**
* Specify whether document window must be resized to fit the first displayed page. Default: false.
*/
fitWindow: boolean;
/**
* Specify whether menu bar should be hidden when document is active. Default: false.
*/
hideMenuBar: boolean;
/**
* Specifying whether toolbar should be hidden when document is active. Default: false.
*/
hideToolBar: boolean;
/**
* Specify whether user interface elements should be hidden when document is active. Default: false.
*/
hideWindowUI: boolean;
/**
* Sets page mode, specifying how to display the document on exiting full-screen mode.
*/
nonFullScreenPageMode: PdfConvertOptions.NonFullScreenPageModeEnum;
/**
* Sets page layout which shall be used when the document is opened.
*/
pageLayout: PdfConvertOptions.PageLayoutEnum;
/**
* Sets page mode, specifying how document should be displayed when opened.
*/
pageMode: PdfConvertOptions.PageModeEnum;
/**
* Rotate page
*/
rotate: PdfConvertOptions.RotateEnum;
/**
* Specifies page size
*/
pageSize: PdfConvertOptions.PageSizeEnum;
/**
* Specifies page orientation
*/
pageOrientation: PdfConvertOptions.PageOrientationEnum;
constructor(init?: Partial<PdfConvertOptions>);
}
export declare namespace PdfConvertOptions {
enum PdfFormatEnum {
Default,
PdfA1A,
PdfA1B,
PdfA2A,
PdfA3A,
PdfA2B,
PdfA2U,
PdfA3B,
PdfA3U,
V13,
V14,
V15,
V16,
V17,
PdfX1A,
PdfX3
}
enum DirectionEnum {
L2R,
R2L
}
enum NonFullScreenPageModeEnum {
UseNone,
UseOutlines,
UseThumbs,
FullScreen,
UseOC,
UseAttachments
}
enum PageLayoutEnum {
Default,
SinglePage,
OneColumn,
TwoColumnLeft,
TwoColumnRight,
TwoPageLeft,
TwoPageRight
}
enum PageModeEnum {
UseNone,
UseOutlines,
UseThumbs,
FullScreen,
UseOC,
UseAttachments
}
enum RotateEnum {
None,
On90,
On180,
On270
}
enum PageSizeEnum {
Default,
A3,
Statement,
Quarto,
Paper11x17,
Paper10x14,
Letter,
Legal,
Ledger,
Folio,
Executive,
EnvelopeDL,
Custom,
B5,
B4,
A5,
A4,
Tabloid
}
enum PageOrientationEnum {
Default,
Landscape,
Portrait
}
}
/**
* Pdf document load options
*/
export declare class PdfLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Clear built-in document properties
*/
clearBuiltInDocumentProperties: boolean;
/**
* Clear custom document properties
*/
clearCustomDocumentProperties: boolean;
/**
* Enable or disable generation of page numbering in converted document. Default: false
*/
pageNumbering: boolean;
/**
* Flatten all the fields of the PDF form
*/
flattenAllFields: boolean;
/**
* Hide annotations in Pdf documents
*/
hidePdfAnnotations: boolean;
/**
* Default font for Pdf document. The following font will be used if a font is missing.
*/
defaultFont: string;
/**
* Set password to unprotect protected document
*/
password: string;
/**
* Remove javascript
*/
removeJavascript: boolean;
/**
* Remove embedded files
*/
removeEmbeddedFiles: boolean;
/**
* Substitute specific fonts when converting Words document.
*/
fontSubstitutes: {
[key: string]: string;
};
constructor(init?: Partial<PdfLoadOptions>);
}
/**
* Options for loading Pdl documents
*/
export declare class PdlLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<PdlLoadOptions>);
}
/**
* Options for loading personal storage documents.
*/
export declare class PersonalStorageLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Folder which to be processed Default is Inbox
*/
folder: string;
/**
* Controls how many levels in depth to perform conversion
*/
depth: number;
constructor(init?: Partial<PersonalStorageLoadOptions>);
}
/**
* Options for to presentation conversion
*/
export declare class PresentationConvertOptions extends ConvertOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Set this property if you want to protect the converted document with a password
*/
password: string;
/**
* Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Powerpoint 2010. Starting from Microsoft Powerpoint 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.
*/
zoom: number;
constructor(init?: Partial<PresentationConvertOptions>);
}
/**
* Presentation document load options
*/
export declare class PresentationLoadOptions extends LoadOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Determines whether the document structure should be preserved when converting to PDF (default is false).
*/
preserveDocumentStructure: boolean;
/**
* Value indicating whether custom document properties should be cleared.
*/
clearCustomDocumentProperties: boolean;
/**
* Value indicating whether built in document properties should be cleared.
*/
clearBuiltInDocumentProperties: boolean;
/**
* Option to control how many levels in depth to perform conversion Default: 1
*/
depth: number;
/**
* Option to control whether the owned documents in the documents container must be converted
*/
con