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

Contains type definitions for communicating with Knowmax Quest.

export interface ICollectionNode<T extends ICollectionNode<T> = ICollectionNode<any>> {
    /** Numeric identification of node. */
    id: number;
    /** Id of collection to which node belongs. */
    collectionId: number;
    /** Id of parent node. */
    parentId?: number;
    sequence: number;
    title?: string;
    description?: string;
    /** Optional reference to a Quest document (without version specification). */
    documentQuestId?: string;
    /** Resolved numeric id of referenced document. */
    documentId?: number;
    /** Explicitly specified version. If omited the current version is assumed. */
    documentVersion?: number;
    customValue?: string;
    customLicenseId?: string;
    created: string;
    createdBy: string;
    modified: string;
    modifiedBy: string;
    /** Indicates if child nodes are available for this node. */
    hasChilds: boolean;
    /** Title of referenced Quest document. Either title of specific document version of document.  */
    referencedTitle?: string;
    /** Version of referenced Quest document. */
    referencedVersion?: number;
    /** Date of referenced Quest document. */
    referencedDate?: string;
    /** Indicates if referenced Quest document is valid. */
    referenceValid?: boolean;
    /** Indicates if referenced Quest document could be located exactly. */
    referenceExact?: boolean;
    /** Indicates if reference Quest document has a cover. */
    referenceCover?: boolean;
    /** Indicates if reference Quest document root node has child nodes. If false, this document only has contents on document root node. If true document has child nodes and thus a toc. */
    referenceRootChildNodes?: boolean;
    /** License information for user calling method that returns this CollectionNodeInfoEx. Only applies to nodes with a valid document reference. Possible values: Unknown, Enabled, Disabled. */
    license?: string;
    /** Indicates if this node or any node in it's childs is enabled by license (and thus has a valid document reference). */
    hasLicenseEnabled?: boolean;
    /** Indicates if this node or any node in it's childs is disabled by license (and thus has a valid document reference). */
    hasLicenseDisabled?: boolean;
    child?: T[];
}
//# sourceMappingURL=ICollectionNode.d.ts.map