@docsvision/webclient/System/DirectoryServerModels.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

import { GenModels } from '@docsvision/webclient/Generated/DocsVision.WebClient.Models';
export interface IDirectoryItem<DataT> {
    data: GenModels.IDirectoryItemData & DataT;
    hasChildren?: boolean;
}
export interface IDirectorySearchItem<NodeT, DataT> extends IDirectoryItem<DataT> {
    /**
     * Search info
     */
    searchInfo: DirectorySearchInfo;
    /**
     * Search path in departments
     */
    path: NodeT[];
}
export interface DirectorySearchInfo {
    /**
     * Is matched
     */
    matched: boolean;
    /**
     * Matched field name
     */
    matchedFieldName: string;
    /**
     * Matched field value
     */
    matchedFieldValue: string;
}
export interface IDirectoryChildrenLoadResponse<DataT> {
    /**
     * List of partner directory items
     */
    items: IDirectoryItem<DataT>[];
    /**
     * Total partners count
     */
    totalItemsCount: number;
    /**
     * Directory timestamp
     */
    directoryTimestamp: number;
}
export interface IDirectorySearchResponse<NodeT, DataT> {
    /**
     * List of partner directory items
     */
    items: IDirectorySearchItem<NodeT, DataT>[];
    /**
     * Are there more items on server.
     */
    hasMore: boolean;
    /**
     * Directory timestamp
     */
    directoryTimestamp: number;
}