knowmax-quest-types/dist/types/IReferenceInfoOptions.d.ts

Contains type definitions for communicating with Knowmax Quest.

export interface IReferenceInfoOptions {
    /** Get information for document versions marked offline. Specific version required. */
    allowOffline?: boolean;
    /** Get information for document versions marked invalid. Specific version required. */
    allowInvalid?: boolean;
    /** Include information about requested version. */
    includeDocumentVersion?: boolean;
    /** Include information about requested resource. */
    includeResource?: boolean;
    /** Include information about requested document node. */
    includeDocumentNode?: boolean;
    /** Include information about requested document alternative. */
    includeDocumentAlternative?: boolean;
    /** Include metadata. */
    includeMetadata?: boolean;
    /** Include collections in which document exists. */
    includeCollections?: boolean;
    /** Include availability information about cover image. */
    includeCoverInfo?: boolean;
    /** Include archive status of document version. Make sure to set includeDocumentVersion to true if archive value is required. */
    includeDocumentVersionArchive?: boolean;
    /** Include information about available document alternatives at level of reference (either documentversion of documentnode). */
    includeDocumentAlternativesInfo?: boolean;
    /** Include information about optional document group to which document referenced belongs. */
    includeDocumentGroup?: boolean;
}
//# sourceMappingURL=IReferenceInfoOptions.d.ts.map