@itwin/presentation-frontend 4.0.0-dev.21 → 4.0.0-dev.23

package/lib/esm/presentation-frontend/PresentationManager.d.ts

@@ -1,187 +1,187 @@
-/** @packageDocumentation
- * @module Core
- */
-import { BeEvent, IDisposable } from "@itwin/core-bentley";
-import { IModelConnection } from "@itwin/core-frontend";
-import { UnitSystemKey } from "@itwin/core-quantity";
-import { ClientDiagnosticsAttribute, Content, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, ContentUpdateInfo, Descriptor, DescriptorOverrides, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DisplayValueGroup, DistinctValuesRequestOptions, ElementProperties, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, HierarchyUpdateInfo, InstanceKey, KeySet, LabelDefinition, Node, NodeKey, NodePathElement, Paged, PagedResponse, PageOptions, RpcRequestsHandler, RulesetVariable, SelectClassInfo, SingleElementPropertiesRequestOptions } from "@itwin/presentation-common";
-import { IpcRequestsHandler } from "./IpcRequestsHandler";
-import { RulesetManager } from "./RulesetManager";
-import { RulesetVariablesManager } from "./RulesetVariablesManager";
-import { StateTracker } from "./StateTracker";
-/**
- * Data structure that describes IModel hierarchy change event arguments.
- * @alpha
- */
-export interface IModelHierarchyChangeEventArgs {
-    /** Id of ruleset that was used to create hierarchy. */
-    rulesetId: string;
-    /** Hierarchy changes info. */
-    updateInfo: HierarchyUpdateInfo;
-    /** Key of iModel that was used to create hierarchy. It matches [[IModelConnection.key]] property. */
-    imodelKey: string;
-}
-/**
- * Data structure that describes iModel content change event arguments.
- * @alpha
- */
-export interface IModelContentChangeEventArgs {
-    /** Id of ruleset that was used to create content. */
-    rulesetId: string;
-    /** Content changes info. */
-    updateInfo: ContentUpdateInfo;
-    /** Key of iModel that was used to create content. It matches [[IModelConnection.key]] property. */
-    imodelKey: string;
-}
-/**
- * Properties used to configure [[PresentationManager]]
- * @public
- */
-export interface PresentationManagerProps {
-    /**
-     * Sets the active locale to use when localizing presentation-related
-     * strings. It can later be changed through [[PresentationManager]].
-     */
-    activeLocale?: string;
-    /**
-     * Sets the active unit system to use for formatting property values with
-     * units. Default presentation units are used if this is not specified. The active unit
-     * system can later be changed through [[PresentationManager]] or overriden for each request.
-     */
-    activeUnitSystem?: UnitSystemKey;
-    /**
-     * ID used to identify client that requests data. Generally, clients should
-     * store this ID in their local storage so the ID can be reused across
-     * sessions - this allows reusing some caches.
-     *
-     * Defaults to a unique GUID as a client id.
-     */
-    clientId?: string;
-    /** @internal */
-    rpcRequestsHandler?: RpcRequestsHandler;
-    /** @internal */
-    ipcRequestsHandler?: IpcRequestsHandler;
-    /** @internal */
-    stateTracker?: StateTracker;
-}
-/**
- * Frontend Presentation manager which basically just forwards all calls to
- * the backend implementation.
- *
- * @public
- */
-export declare class PresentationManager implements IDisposable {
-    private _requestsHandler;
-    private _rulesets;
-    private _localizationHelper;
-    private _rulesetVars;
-    private _clearEventListener?;
-    private _connections;
-    private _ipcRequestsHandler?;
-    private _stateTracker?;
-    /**
-     * An event raised when hierarchies created using specific ruleset change
-     * @alpha
-     */
-    onIModelHierarchyChanged: BeEvent<(args: IModelHierarchyChangeEventArgs) => void>;
-    /**
-     * An event raised when content created using specific ruleset changes
-     * @alpha
-     */
-    onIModelContentChanged: BeEvent<(args: IModelContentChangeEventArgs) => void>;
-    /** Get / set active unit system used to format property values with units */
-    activeUnitSystem: UnitSystemKey | undefined;
-    private constructor();
-    /** Get / set active locale used for localizing presentation data */
-    get activeLocale(): string | undefined;
-    set activeLocale(locale: string | undefined);
-    dispose(): void;
-    private onConnection;
-    private initializeIModel;
-    private onUpdate;
-    /** @note This is only called in native apps after changes in iModels */
-    private handleUpdateAsync;
-    /** Function that is called when a new IModelConnection is used to retrieve data.
-     *  @internal
-     */
-    onNewiModelConnection(_: IModelConnection): Promise<void>;
-    /**
-     * Create a new PresentationManager instance
-     * @param props Optional properties used to configure the manager
-     */
-    static create(props?: PresentationManagerProps): PresentationManager;
-    /** @internal */
-    get rpcRequestsHandler(): RpcRequestsHandler;
-    /** @internal */
-    get ipcRequestsHandler(): IpcRequestsHandler | undefined;
-    /** @internal */
-    get stateTracker(): StateTracker | undefined;
-    /**
-     * Get rulesets manager
-     */
-    rulesets(): RulesetManager;
-    /**
-     * Get ruleset variables manager for specific ruleset
-     * @param rulesetId Id of the ruleset to get the vars manager for
-     */
-    vars(rulesetId: string): RulesetVariablesManager;
-    private toRpcTokenOptions;
-    private addRulesetAndVariablesToOptions;
-    /** Retrieves nodes */
-    getNodes(requestOptions: Paged<HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<Node[]>;
-    /** Retrieves nodes count. */
-    getNodesCount(requestOptions: HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable> & ClientDiagnosticsAttribute): Promise<number>;
-    /** Retrieves total nodes count and a single page of nodes. */
-    getNodesAndCount(requestOptions: Paged<HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<{
-        count: number;
-        nodes: Node[];
-    }>;
-    /**
-     * Retrieves hierarchy level descriptor.
-     * @beta
-     */
-    getNodesDescriptor(requestOptions: HierarchyLevelDescriptorRequestOptions<IModelConnection, NodeKey, RulesetVariable> & ClientDiagnosticsAttribute): Promise<Descriptor | undefined>;
-    /** Retrieves paths from root nodes to children nodes according to specified keys. Intersecting paths will be merged. */
-    getNodePaths(requestOptions: FilterByInstancePathsHierarchyRequestOptions<IModelConnection, RulesetVariable> & ClientDiagnosticsAttribute): Promise<NodePathElement[]>;
-    /** Retrieves paths from root nodes to nodes containing filter text in their label. */
-    getFilteredNodePaths(requestOptions: FilterByTextHierarchyRequestOptions<IModelConnection, RulesetVariable> & ClientDiagnosticsAttribute): Promise<NodePathElement[]>;
-    /**
-     * Get information about the sources of content when building it for specific ECClasses. Sources involve classes of the primary select instance,
-     * its related instances for loading related and navigation properties.
-     * @public
-     */
-    getContentSources(requestOptions: ContentSourcesRequestOptions<IModelConnection> & ClientDiagnosticsAttribute): Promise<SelectClassInfo[]>;
-    /** Retrieves the content descriptor which describes the content and can be used to customize it. */
-    getContentDescriptor(requestOptions: ContentDescriptorRequestOptions<IModelConnection, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<Descriptor | undefined>;
-    /** Retrieves overall content set size. */
-    getContentSetSize(requestOptions: ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<number>;
-    /** Retrieves content which consists of a content descriptor and a page of records. */
-    getContent(requestOptions: Paged<ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<Content | undefined>;
-    /** Retrieves content set size and content which consists of a content descriptor and a page of records. */
-    getContentAndSize(requestOptions: Paged<ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<{
-        content: Content;
-        size: number;
-    } | undefined>;
-    /** Retrieves distinct values of specific field from the content. */
-    getPagedDistinctValues(requestOptions: DistinctValuesRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroup>>;
-    /**
-     * Retrieves property data in a simplified format for a single element specified by ID.
-     * @public
-     */
-    getElementProperties(requestOptions: SingleElementPropertiesRequestOptions<IModelConnection> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined>;
-    /**
-     * Retrieves content item instance keys.
-     * @public
-     */
-    getContentInstanceKeys(requestOptions: ContentInstanceKeysRequestOptions<IModelConnection, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<{
-        total: number;
-        items: () => AsyncGenerator<InstanceKey>;
-    }>;
-    /** Retrieves display label definition of specific item. */
-    getDisplayLabelDefinition(requestOptions: DisplayLabelRequestOptions<IModelConnection, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition>;
-    /** Retrieves display label definition of specific items. */
-    getDisplayLabelDefinitions(requestOptions: DisplayLabelsRequestOptions<IModelConnection, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition[]>;
-}
-/** @internal */
-export declare const buildPagedArrayResponse: <TItem>(requestedPage: PageOptions | undefined, getter: (page: Required<PageOptions>, requestIndex: number) => Promise<PagedResponse<TItem>>) => Promise<PagedResponse<TItem>>;
+/** @packageDocumentation
+ * @module Core
+ */
+import { BeEvent, IDisposable } from "@itwin/core-bentley";
+import { IModelConnection } from "@itwin/core-frontend";
+import { UnitSystemKey } from "@itwin/core-quantity";
+import { ClientDiagnosticsAttribute, Content, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, ContentUpdateInfo, Descriptor, DescriptorOverrides, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DisplayValueGroup, DistinctValuesRequestOptions, ElementProperties, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, HierarchyUpdateInfo, InstanceKey, KeySet, LabelDefinition, Node, NodeKey, NodePathElement, Paged, PagedResponse, PageOptions, RpcRequestsHandler, RulesetVariable, SelectClassInfo, SingleElementPropertiesRequestOptions } from "@itwin/presentation-common";
+import { IpcRequestsHandler } from "./IpcRequestsHandler";
+import { RulesetManager } from "./RulesetManager";
+import { RulesetVariablesManager } from "./RulesetVariablesManager";
+import { StateTracker } from "./StateTracker";
+/**
+ * Data structure that describes IModel hierarchy change event arguments.
+ * @alpha
+ */
+export interface IModelHierarchyChangeEventArgs {
+    /** Id of ruleset that was used to create hierarchy. */
+    rulesetId: string;
+    /** Hierarchy changes info. */
+    updateInfo: HierarchyUpdateInfo;
+    /** Key of iModel that was used to create hierarchy. It matches [[IModelConnection.key]] property. */
+    imodelKey: string;
+}
+/**
+ * Data structure that describes iModel content change event arguments.
+ * @alpha
+ */
+export interface IModelContentChangeEventArgs {
+    /** Id of ruleset that was used to create content. */
+    rulesetId: string;
+    /** Content changes info. */
+    updateInfo: ContentUpdateInfo;
+    /** Key of iModel that was used to create content. It matches [[IModelConnection.key]] property. */
+    imodelKey: string;
+}
+/**
+ * Properties used to configure [[PresentationManager]]
+ * @public
+ */
+export interface PresentationManagerProps {
+    /**
+     * Sets the active locale to use when localizing presentation-related
+     * strings. It can later be changed through [[PresentationManager]].
+     */
+    activeLocale?: string;
+    /**
+     * Sets the active unit system to use for formatting property values with
+     * units. Default presentation units are used if this is not specified. The active unit
+     * system can later be changed through [[PresentationManager]] or overriden for each request.
+     */
+    activeUnitSystem?: UnitSystemKey;
+    /**
+     * ID used to identify client that requests data. Generally, clients should
+     * store this ID in their local storage so the ID can be reused across
+     * sessions - this allows reusing some caches.
+     *
+     * Defaults to a unique GUID as a client id.
+     */
+    clientId?: string;
+    /** @internal */
+    rpcRequestsHandler?: RpcRequestsHandler;
+    /** @internal */
+    ipcRequestsHandler?: IpcRequestsHandler;
+    /** @internal */
+    stateTracker?: StateTracker;
+}
+/**
+ * Frontend Presentation manager which basically just forwards all calls to
+ * the backend implementation.
+ *
+ * @public
+ */
+export declare class PresentationManager implements IDisposable {
+    private _requestsHandler;
+    private _rulesets;
+    private _localizationHelper;
+    private _rulesetVars;
+    private _clearEventListener?;
+    private _connections;
+    private _ipcRequestsHandler?;
+    private _stateTracker?;
+    /**
+     * An event raised when hierarchies created using specific ruleset change
+     * @alpha
+     */
+    onIModelHierarchyChanged: BeEvent<(args: IModelHierarchyChangeEventArgs) => void>;
+    /**
+     * An event raised when content created using specific ruleset changes
+     * @alpha
+     */
+    onIModelContentChanged: BeEvent<(args: IModelContentChangeEventArgs) => void>;
+    /** Get / set active unit system used to format property values with units */
+    activeUnitSystem: UnitSystemKey | undefined;
+    private constructor();
+    /** Get / set active locale used for localizing presentation data */
+    get activeLocale(): string | undefined;
+    set activeLocale(locale: string | undefined);
+    dispose(): void;
+    private onConnection;
+    private initializeIModel;
+    private onUpdate;
+    /** @note This is only called in native apps after changes in iModels */
+    private handleUpdateAsync;
+    /** Function that is called when a new IModelConnection is used to retrieve data.
+     *  @internal
+     */
+    onNewiModelConnection(_: IModelConnection): Promise<void>;
+    /**
+     * Create a new PresentationManager instance
+     * @param props Optional properties used to configure the manager
+     */
+    static create(props?: PresentationManagerProps): PresentationManager;
+    /** @internal */
+    get rpcRequestsHandler(): RpcRequestsHandler;
+    /** @internal */
+    get ipcRequestsHandler(): IpcRequestsHandler | undefined;
+    /** @internal */
+    get stateTracker(): StateTracker | undefined;
+    /**
+     * Get rulesets manager
+     */
+    rulesets(): RulesetManager;
+    /**
+     * Get ruleset variables manager for specific ruleset
+     * @param rulesetId Id of the ruleset to get the vars manager for
+     */
+    vars(rulesetId: string): RulesetVariablesManager;
+    private toRpcTokenOptions;
+    private addRulesetAndVariablesToOptions;
+    /** Retrieves nodes */
+    getNodes(requestOptions: Paged<HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<Node[]>;
+    /** Retrieves nodes count. */
+    getNodesCount(requestOptions: HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable> & ClientDiagnosticsAttribute): Promise<number>;
+    /** Retrieves total nodes count and a single page of nodes. */
+    getNodesAndCount(requestOptions: Paged<HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<{
+        count: number;
+        nodes: Node[];
+    }>;
+    /**
+     * Retrieves hierarchy level descriptor.
+     * @beta
+     */
+    getNodesDescriptor(requestOptions: HierarchyLevelDescriptorRequestOptions<IModelConnection, NodeKey, RulesetVariable> & ClientDiagnosticsAttribute): Promise<Descriptor | undefined>;
+    /** Retrieves paths from root nodes to children nodes according to specified keys. Intersecting paths will be merged. */
+    getNodePaths(requestOptions: FilterByInstancePathsHierarchyRequestOptions<IModelConnection, RulesetVariable> & ClientDiagnosticsAttribute): Promise<NodePathElement[]>;
+    /** Retrieves paths from root nodes to nodes containing filter text in their label. */
+    getFilteredNodePaths(requestOptions: FilterByTextHierarchyRequestOptions<IModelConnection, RulesetVariable> & ClientDiagnosticsAttribute): Promise<NodePathElement[]>;
+    /**
+     * Get information about the sources of content when building it for specific ECClasses. Sources involve classes of the primary select instance,
+     * its related instances for loading related and navigation properties.
+     * @public
+     */
+    getContentSources(requestOptions: ContentSourcesRequestOptions<IModelConnection> & ClientDiagnosticsAttribute): Promise<SelectClassInfo[]>;
+    /** Retrieves the content descriptor which describes the content and can be used to customize it. */
+    getContentDescriptor(requestOptions: ContentDescriptorRequestOptions<IModelConnection, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<Descriptor | undefined>;
+    /** Retrieves overall content set size. */
+    getContentSetSize(requestOptions: ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<number>;
+    /** Retrieves content which consists of a content descriptor and a page of records. */
+    getContent(requestOptions: Paged<ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<Content | undefined>;
+    /** Retrieves content set size and content which consists of a content descriptor and a page of records. */
+    getContentAndSize(requestOptions: Paged<ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<{
+        content: Content;
+        size: number;
+    } | undefined>;
+    /** Retrieves distinct values of specific field from the content. */
+    getPagedDistinctValues(requestOptions: DistinctValuesRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroup>>;
+    /**
+     * Retrieves property data in a simplified format for a single element specified by ID.
+     * @public
+     */
+    getElementProperties(requestOptions: SingleElementPropertiesRequestOptions<IModelConnection> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined>;
+    /**
+     * Retrieves content item instance keys.
+     * @public
+     */
+    getContentInstanceKeys(requestOptions: ContentInstanceKeysRequestOptions<IModelConnection, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<{
+        total: number;
+        items: () => AsyncGenerator<InstanceKey>;
+    }>;
+    /** Retrieves display label definition of specific item. */
+    getDisplayLabelDefinition(requestOptions: DisplayLabelRequestOptions<IModelConnection, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition>;
+    /** Retrieves display label definition of specific items. */
+    getDisplayLabelDefinitions(requestOptions: DisplayLabelsRequestOptions<IModelConnection, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition[]>;
+}
+/** @internal */
+export declare const buildPagedArrayResponse: <TItem>(requestedPage: PageOptions | undefined, getter: (page: Required<PageOptions>, requestIndex: number) => Promise<PagedResponse<TItem>>) => Promise<PagedResponse<TItem>>;
 //# sourceMappingURL=PresentationManager.d.ts.map