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

Contains type definitions for communicating with Knowmax Quest.

import type { IDocument, IDocumentVersion, IDocumentNode, IMetadata, IFavoriteInfo, ICollectionDocumentReference, ICoverInfo, IResource, IDocumentAlternativeInfo } from '.';
export interface IReferenceInfo<T extends IDocumentNode<T> = IDocumentNode<any>> {
    /** Originally requested Quest id. */
    requestedQuestId: string;
    /** Quest id after parsing. */
    parsedQuestId: string;
    /** Contains last part of Quest id in case reference was partly located but last part could not be located. */
    questIdLeftover?: string;
    /** Contains located reference. In case a version was specified, it includes explicit version number. */
    questId: string;
    /** True if requested item was exactly located. */
    located: boolean;
    /** Contains type of reference located. */
    type: string;
    /** Set in case of error while resolving reference. Possible values: InvalidInput, InvalidIdentification, DocumentNotFound, DocumentVersionNotFound, DocumentNodeNotFound, DocumentAlternativeNotFound. */
    error?: string;
    /** Document referenced by Quest id. */
    document?: IDocument;
    /** Document version referenced by Quest id (if any). */
    documentVersion?: IDocumentVersion;
    /** Document node referenced by Quest id (if any). */
    documentNode?: T;
    /** Resource referenced by Quest id (if any). */
    resource?: IResource;
    /** Info about document alternative referenced by Quest id (if any). */
    documentAlternative?: IDocumentAlternativeInfo;
    /** Metadata that belongs to Quest id (if requested). */
    metadata: IMetadata[];
    /** Collections in which document referenced by Quest id occurs (if requested). */
    collections: ICollectionDocumentReference[];
    /** List of info about document alternatives referenced by Quest id (if requested). */
    documentAlternativesInfo?: IDocumentAlternativeInfo[];
    /** Information about cover image for document and/or documentversion specified by Quest id (if requested). */
    coverInfo?: ICoverInfo;
    /** Set for user calling this method. Only for users authenticated by Knowmax License System. Possible values: Unknown, Enabled, Disabled */
    licenseItemAccess?: string;
    /** Security labels for document. Only for users authenticated by Knowmax License System. */
    securityLabels?: string[];
    /** Set for user calling this method. Only for users with a custom identity in an associated application. */
    favoriteInfo?: IFavoriteInfo;
    /** Key for this document version in search index. */
    documentVersionIndexKey?: string;
    /** Key for this document node in search index. */
    documentNodeIndexKey?: string;
}
//# sourceMappingURL=IReferenceInfo.d.ts.map