packageDocumentation module import { Id64String } from "@itwin/core-bentley" ; import { IModelRpcProps , RpcInterface } from "@itwin/core-common" ; import { DescriptorJSON , DescriptorOverrides , SelectClassInfoJSON } from "./content/Descriptor" ; import { ItemJSON } from "./content/Item" ; import { DisplayValueGroupJSON } from "./content/Value" ; import { DiagnosticsOptions , DiagnosticsScopeLogs } from "./Diagnostics" ; import { CompressedClassInfoJSON , 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 { ContentDescriptorRequestOptions , ContentInstanceKeysRequestOptions , ContentRequestOptions , ContentSourcesRequestOptions , DisplayLabelRequestOptions , DisplayLabelsRequestOptions , DistinctValuesRequestOptions , FilterByInstancePathsHierarchyRequestOptions , FilterByTextHierarchyRequestOptions , HierarchyRequestOptions , Paged , SelectionScopeRequestOptions , SingleElementPropertiesRequestOptions , } from "./PresentationManagerOptions" ; import { RulesetVariableJSON } from "./RulesetVariables" ; import { SelectionScope } from "./selection/SelectionScope" ; import { Omit , PagedResponse } from "./Utils" ; public export type PresentationRpcRequestOptions < TManagerRequestOptions > = Omit < TManagerRequestOptions , "imodel" | "diagnostics" > & { internal clientId ? : string ; alpha diagnostics ? : DiagnosticsOptions ; } ; public export interface PresentationRpcResponseData < TResult = undefined > { /** 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 [ ] ; } public export type PresentationRpcResponse < TResult = undefined > = Promise < PresentationRpcResponseData < TResult > > ; public export type HierarchyRpcRequestOptions = PresentationRpcRequestOptions < HierarchyRequestOptions < never , NodeKeyJSON , RulesetVariableJSON > > ; public export type FilterByInstancePathsHierarchyRpcRequestOptions = PresentationRpcRequestOptions < FilterByInstancePathsHierarchyRequestOptions < never , RulesetVariableJSON > > ; public export type FilterByTextHierarchyRpcRequestOptions = PresentationRpcRequestOptions < FilterByTextHierarchyRequestOptions < never , RulesetVariableJSON > > ; beta export type ContentSourcesRpcRequestOptions = PresentationRpcRequestOptions < ContentSourcesRequestOptions < never > > ; beta export interface ContentSourcesRpcResult { /** A list of objects containing content source information. */ sources : SelectClassInfoJSON < Id64String > [ ] ; /** An `ECClassId` => [[CompressedClassInfoJSON]] map for deserializing [[sources]]. */ classesMap : { [ id ] : CompressedClassInfoJSON ; } ; } public export type ContentDescriptorRpcRequestOptions = PresentationRpcRequestOptions < ContentDescriptorRequestOptions < never , KeySetJSON , RulesetVariableJSON > > ; public export type ContentRpcRequestOptions = PresentationRpcRequestOptions < ContentRequestOptions < never , DescriptorOverrides , KeySetJSON , RulesetVariableJSON > > ; beta export type SingleElementPropertiesRpcRequestOptions = PresentationRpcRequestOptions < SingleElementPropertiesRequestOptions < never > > ; public export type DistinctValuesRpcRequestOptions = PresentationRpcRequestOptions < DistinctValuesRequestOptions < never , DescriptorOverrides , KeySetJSON , RulesetVariableJSON > > ; beta export type ContentInstanceKeysRpcRequestOptions = PresentationRpcRequestOptions < ContentInstanceKeysRequestOptions < never , KeySetJSON , RulesetVariableJSON > > ; public export type DisplayLabelRpcRequestOptions = PresentationRpcRequestOptions < DisplayLabelRequestOptions < never , InstanceKeyJSON > > ; public export type DisplayLabelsRpcRequestOptions = PresentationRpcRequestOptions < DisplayLabelsRequestOptions < never , InstanceKeyJSON > > ; public export type SelectionScopeRpcRequestOptions = PresentationRpcRequestOptions < SelectionScopeRequestOptions < never > > ; public export class PresentationRpcInterface extends RpcInterface { /** The immutable name of the interface. */ public static readonly interfaceName = "PresentationRpcInterface" ; /** The semantic version of the interface. */ public static interfaceVersion = "3.0.0" ; public async getNodesCount ( _token , _options ) { return this . forward ( arguments ) ; } public async getPagedNodes ( _token , _options ) { return this . forward ( arguments ) ; } public async getNodePaths ( _token , _options ) { return this . forward ( arguments ) ; } public async getFilteredNodePaths ( _token , _options ) { return this . forward ( arguments ) ; } beta public async getContentSources ( _token , _options ) { return this . forward ( arguments ) ; } public async getContentDescriptor ( _token , _options ) { return this . forward ( arguments ) ; } public async getContentSetSize ( _token , _options ) { return this . forward ( arguments ) ; } public async getPagedContent ( _token , _options ) { return this . forward ( arguments ) ; } public async getPagedContentSet ( _token , _options ) { return this . forward ( arguments ) ; } beta public async getElementProperties ( _token , _options ) { return this . forward ( arguments ) ; } public async getPagedDistinctValues ( _token , _options ) { return this . forward ( arguments ) ; } beta public async getContentInstanceKeys ( _token , _options ) { return this . forward ( arguments ) ; } public async getDisplayLabelDefinition ( _token , _options ) { return this . forward ( arguments ) ; } public async getPagedDisplayLabelDefinitions ( _token , _options ) { return this . forward ( arguments ) ; } public async getSelectionScopes ( _token , _options ) { return this . forward ( arguments ) ; } public async computeSelection ( _token , _options , _ids , _scopeId ) { return this . forward ( arguments ) ; } } alpha export enum PresentationIpcEvents { /**
     * ID of an event that's emitted when backend detects changes in presented data.
     */ Update = "presentation.onUpdate" }