/** @packageDocumentation * @module RPC */ import { Id64String } from "@bentley/bentleyjs-core"; import { IModelRpcProps, RpcInterface } from "@bentley/imodeljs-common"; import { ContentJSON } from "./content/Content"; import { DescriptorJSON, DescriptorOverrides, SelectionInfo } from "./content/Descriptor"; import { ItemJSON } from "./content/Item"; import { DisplayValueGroupJSON } from "./content/Value"; import { DiagnosticsOptions, DiagnosticsScopeLogs } from "./Diagnostics"; import { InstanceKeyJSON } from "./EC"; import { ElementProperties } from "./ElementProperties"; import { PresentationStatus } from "./Error"; import { NodeKeyJSON } from "./hierarchy/Key"; import { NodeJSON } from "./hierarchy/Node"; import { NodePathElementJSON } from "./hierarchy/NodePathElement"; import { KeySetJSON } from "./KeySet"; import { LabelDefinitionJSON } from "./LabelDefinition"; import { ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions, ElementPropertiesRequestOptions, ExtendedContentRequestOptions, ExtendedHierarchyRequestOptions, HierarchyCompareOptions, HierarchyRequestOptions, LabelRequestOptions, Paged, SelectionScopeRequestOptions } from "./PresentationManagerOptions"; import { RulesetVariableJSON } from "./RulesetVariables"; import { SelectionScope } from "./selection/SelectionScope"; import { HierarchyCompareInfoJSON, PartialHierarchyModificationJSON } from "./Update"; import { Omit, PagedResponse } from "./Utils"; /** * Base options for all presentation RPC requests. * @public */ export declare type PresentationRpcRequestOptions = Omit & { /** @internal ID of the client requesting data */ clientId?: string; /** @alpha */ diagnostics?: DiagnosticsOptions; }; /** * Data structure for presentation RPC responses * @public */ export declare type PresentationRpcResponse = Promise<{ /** Response status code */ statusCode: PresentationStatus; /** In case of an error response, the error message */ errorMessage?: string; /** In case of a success response, the result */ result?: TResult; /** @alpha */ diagnostics?: DiagnosticsScopeLogs[]; }>; /** * Data structure for base hierarchy request options. * @public * @deprecated Use [[ExtendedHierarchyRpcRequestOptions]] */ export declare type HierarchyRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for hierarchy request options. * @public */ export declare type ExtendedHierarchyRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for content request options. * @public * @deprecated Use [[ContentDescriptorRpcRequestOptions]] or [[ExtendedContentRpcRequestOptions]] */ export declare type ContentRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for content descriptor RPC request options. * @public */ export declare type ContentDescriptorRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for content RPC request options. * @public */ export declare type ExtendedContentRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for element properties RPC request options. * @beta */ export declare type ElementPropertiesRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for distinct values' request options. * @public */ export declare type DistinctValuesRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for label request options. * @public * @deprecated Use [[DisplayLabelRpcRequestOptions]] or [[DisplayLabelsRpcRequestOptions]] */ export declare type LabelRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for label request options. * @public */ export declare type DisplayLabelRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for labels request options. * @public */ export declare type DisplayLabelsRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for selection scope request options. * @public */ export declare type SelectionScopeRpcRequestOptions = PresentationRpcRequestOptions>; /** * @alpha */ export declare type ComputeSelectionRpcRequestOptions = PresentationRpcRequestOptions>; /** * Data structure for comparing presentation data after ruleset or ruleset variable changes. * @public */ export declare type HierarchyCompareRpcOptions = PresentationRpcRequestOptions>; /** * Interface used for communication between Presentation backend and frontend. * @public */ export declare class PresentationRpcInterface extends RpcInterface { /** The immutable name of the interface. */ static readonly interfaceName = "PresentationRpcInterface"; /** The semantic version of the interface. */ static interfaceVersion: string; /** @deprecated Use an overload with [[ExtendedHierarchyRpcRequestOptions]] */ getNodesCount(_token: IModelRpcProps, _options: HierarchyRpcRequestOptions, _parentKey: NodeKeyJSON | undefined): PresentationRpcResponse; getNodesCount(_token: IModelRpcProps, _options: ExtendedHierarchyRpcRequestOptions): PresentationRpcResponse; /** @deprecated Use [[getPagedNodes]] */ getNodesAndCount(_token: IModelRpcProps, _options: Paged, _parentKey?: NodeKeyJSON): PresentationRpcResponse<{ nodes: NodeJSON[]; count: number; }>; /** @deprecated Use [[getPagedNodes]] */ getNodes(_token: IModelRpcProps, _options: Paged, _parentKey?: NodeKeyJSON): PresentationRpcResponse; getPagedNodes(_token: IModelRpcProps, _options: Paged): PresentationRpcResponse>; getNodePaths(_token: IModelRpcProps, _options: Omit, _paths: InstanceKeyJSON[][], _markedIndex: number): PresentationRpcResponse; getFilteredNodePaths(_token: IModelRpcProps, _options: Omit, _filterText: string): PresentationRpcResponse; /** @alpha @deprecated Will be removed in 3.0 */ loadHierarchy(_token: IModelRpcProps, _options: HierarchyRpcRequestOptions): PresentationRpcResponse; /** @deprecated Use an overload with [[ContentDescriptorRpcRequestOptions]] */ getContentDescriptor(_token: IModelRpcProps, _options: ContentRpcRequestOptions, _displayType: string, _keys: KeySetJSON, _selection: SelectionInfo | undefined): PresentationRpcResponse; getContentDescriptor(_token: IModelRpcProps, _options: ContentDescriptorRpcRequestOptions): PresentationRpcResponse; /** @deprecated Use an overload with [[ExtendedContentRpcRequestOptions]] */ getContentSetSize(_token: IModelRpcProps, _options: ContentRpcRequestOptions, _descriptorOrOverrides: DescriptorJSON | DescriptorOverrides, _keys: KeySetJSON): PresentationRpcResponse; getContentSetSize(_token: IModelRpcProps, _options: ExtendedContentRpcRequestOptions): PresentationRpcResponse; /** @deprecated Use [[getPagedContent]] or [[getPagedContentSet]] */ getContent(_token: IModelRpcProps, _options: ContentRpcRequestOptions, _descriptorOrOverrides: DescriptorJSON | DescriptorOverrides, _keys: KeySetJSON): PresentationRpcResponse; /** @deprecated Use [[getPagedContent]] or [[getPagedContentSet]] */ getContentAndSize(_token: IModelRpcProps, _options: ContentRpcRequestOptions, _descriptorOrOverrides: DescriptorJSON | DescriptorOverrides, _keys: KeySetJSON): PresentationRpcResponse<{ content?: ContentJSON; size: number; }>; getPagedContent(_token: IModelRpcProps, _options: Paged): PresentationRpcResponse<{ descriptor: DescriptorJSON; contentSet: PagedResponse; } | undefined>; getPagedContentSet(_token: IModelRpcProps, _options: Paged): PresentationRpcResponse>; /** @beta */ getElementProperties(_token: IModelRpcProps, _options: ElementPropertiesRpcRequestOptions): PresentationRpcResponse; /** @deprecated Use [[getPagedDistinctValues]] */ getDistinctValues(_token: IModelRpcProps, _options: ContentRpcRequestOptions, _descriptor: DescriptorJSON | DescriptorOverrides, _keys: KeySetJSON, _fieldName: string, _maximumValueCount: number): PresentationRpcResponse; getPagedDistinctValues(_token: IModelRpcProps, _options: DistinctValuesRpcRequestOptions): PresentationRpcResponse>; /** @deprecated Use an overload with [[DisplayLabelRpcRequestOptions]] */ getDisplayLabelDefinition(_token: IModelRpcProps, _options: LabelRpcRequestOptions, _key: InstanceKeyJSON): PresentationRpcResponse; getDisplayLabelDefinition(_token: IModelRpcProps, _options: DisplayLabelRpcRequestOptions): PresentationRpcResponse; /** @deprecated Use [[getPagedDisplayLabelDefinitions]] */ getDisplayLabelDefinitions(_token: IModelRpcProps, _options: LabelRpcRequestOptions, _keys: InstanceKeyJSON[]): PresentationRpcResponse; getPagedDisplayLabelDefinitions(_token: IModelRpcProps, _options: DisplayLabelsRpcRequestOptions): PresentationRpcResponse>; getSelectionScopes(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions): PresentationRpcResponse; computeSelection(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions, _ids: Id64String[], _scopeId: string): PresentationRpcResponse; /** @alpha */ computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions): PresentationRpcResponse; /** @alpha @deprecated Use [[compareHierarchiesPaged]] */ compareHierarchies(_token: IModelRpcProps, _options: HierarchyCompareRpcOptions): PresentationRpcResponse; compareHierarchiesPaged(_token: IModelRpcProps, _options: HierarchyCompareRpcOptions): PresentationRpcResponse; } /** @alpha */ export declare enum PresentationIpcEvents { /** * ID of an event that's emitted when backend detects changes in presented data. */ Update = "presentation.onUpdate" } //# sourceMappingURL=PresentationRpcInterface.d.ts.map