2021-11-15 23:46:29 +02:00

142 lines
3.7 KiB
TypeScript

/**
* Object containing information on a specific file.
*/
import { ProcessingFileStatus, WorkflowFileStatus } from './types';
import { FileAttributes } from '../file-attributes';
export interface IFile {
/**
* Date and time when the file was added to the system.
*/
readonly added?: string;
/**
* Shows if all manual changes have been applied by a reanalysis.
*/
readonly allManualRedactionsApplied?: boolean;
/**
* Shows how long the last analysis took
*/
readonly analysisDuration?: number;
/**
* Shows if the file requires reanalysis.
*/
readonly analysisRequired?: boolean;
/**
* Shows the date of approval, if approved.
*/
readonly approvalDate?: string;
/**
* The current reviewer's (if any) user id.
*/
readonly currentReviewer?: string;
/**
* Shows which dictionary versions was used during the analysis.
*/
readonly dictionaryVersion?: number;
/**
* Shows which dossier dictionary versions was used during the analysis.
*/
readonly dossierDictionaryVersion?: number;
/**
* The ID of the dossier the file belongs to.
*/
readonly dossierId: string;
/**
* Shows if the file was excluded from analysis.
*/
readonly excluded?: boolean;
/**
* Set of excluded pages for this file.
*/
readonly excludedPages?: Array<number>;
fileAttributes?: FileAttributes;
/**
* The ID of the file.
*/
readonly fileId: string;
/**
* The file's name.
*/
readonly filename: string;
/**
* Shows if this file has comments on annotations.
*/
readonly hasAnnotationComments?: boolean;
/**
* Shows if any hints were found during the analysis.
*/
readonly hasHints?: boolean;
/**
* Shows if any images were found during the analysis.
*/
readonly hasImages?: boolean;
/**
* Shows if any redactions were found during the analysis.
*/
readonly hasRedactions?: boolean;
/**
* Shows if any requests were found during the analysis.
*/
readonly hasRequests?: boolean;
/**
* Shows if there are any Suggestions in this file.
*/
readonly hasSuggestions?: boolean;
/**
* Shows if there is any change between the previous and current analysis.
*/
readonly hasUpdates?: boolean;
/**
* Date and time when the files attributes was last updated.
*/
readonly lastFileAttributeChange?: string;
/**
* Shows if this file has been OCRed by us. Last Time of OCR.
*/
readonly lastOCRTime?: string;
/**
* Shows the last date of a successful analysis.
*/
readonly lastProcessed?: string;
/**
* The last reviewer's (if any) user id.
*/
readonly lastReviewer?: string;
/**
* Date and time when the file was last updated.
*/
readonly lastUpdated?: string;
/**
* Shows last date the document was uploaded.
*/
readonly lastUploaded?: string;
/**
* Shows which legal basis versions was used during the analysis.
*/
readonly legalBasisVersion?: number;
/**
* The number of times the file has been analyzed.
*/
readonly numberOfAnalyses: number;
/**
* The number of pages of the file.
*/
readonly numberOfPages?: number;
/**
* Shows which rules versions was used during the analysis.
*/
readonly rulesVersion?: number;
/**
* Shows if the file is soft deleted.
*/
readonly softDeleted?: string;
/**
* The ID of the user who uploaded the file.
*/
readonly uploader?: string;
readonly processingStatus: ProcessingFileStatus;
readonly workflowStatus: WorkflowFileStatus;
}