@softvision/webpdf-wsclient-typescript/lib/session/rest/documents/DocumentManager.d.ts

A simplified and optimized API client library for the webPDF server

import { RestDocument } from "./RestDocument";
import { RestSession } from "../RestSession";
import { DocumentFile, FileCompress, FileExtract, HistoryEntry, Info, InfoType, PdfPassword } from "../../../generated-sources";
import { AxiosProgressEvent } from "axios";
export interface DocumentManager<T_REST_DOCUMENT extends RestDocument> {
    getSession(): RestSession<T_REST_DOCUMENT>;
    synchronizeDocument(documentFile: DocumentFile): Promise<T_REST_DOCUMENT>;
    synchronize(fileList?: Array<DocumentFile>): Promise<Array<T_REST_DOCUMENT>>;
    getDocument(documentId: string): T_REST_DOCUMENT;
    getDocuments(): Array<T_REST_DOCUMENT>;
    containsDocument(documentId: string): boolean;
    downloadDocument(documentId: string, options?: {
        onProgress?: (event: AxiosProgressEvent) => void;
        abortSignal?: AbortSignal;
    }): Promise<Buffer>;
    downloadArchive(documentIdList: Array<string>, options?: {
        onProgress?: (event: AxiosProgressEvent) => void;
        abortSignal?: AbortSignal;
    }): Promise<Buffer>;
    uploadDocument(data: Blob, fileName: string, options?: {
        onProgress?: (event: AxiosProgressEvent) => void;
        abortSignal?: AbortSignal;
    }): Promise<T_REST_DOCUMENT>;
    deleteDocument(documentId: string): Promise<void>;
    renameDocument(documentId: string, fileName: string): Promise<T_REST_DOCUMENT>;
    isDocumentHistoryActive(): boolean;
    setDocumentHistoryActive(documentHistoryActive: boolean): void;
    getDocumentHistory(documentId: string): Array<HistoryEntry>;
    getDocumentHistoryEntry(documentId: string, historyId: number): HistoryEntry;
    updateDocumentHistory(documentId: string, historyEntry: HistoryEntry): Promise<HistoryEntry>;
    updateDocumentSecurity(documentId: string, passwordType: PdfPassword): Promise<T_REST_DOCUMENT>;
    getDocumentInfo(documentId: string, infoType: InfoType): Promise<Info>;
    extractDocument(documentId: string, fileExtract: FileExtract): Promise<Array<T_REST_DOCUMENT>>;
    extractArchiveFile(documentId: string, archivePath: string): Promise<Buffer>;
    compressDocuments(fileCompress: FileCompress): Promise<T_REST_DOCUMENT>;
    updateDocument(documentId: string, data: Blob): Promise<T_REST_DOCUMENT>;
}