PresentationRpcInterface Class

Interface used for communication between Presentation backend and frontend.

Extends

Methods

Name Description
constructor(routing?: RpcRoutingToken): PresentationRpcInterface    
computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions): PresentationRpcResponse<KeySetJSON>    
computeSelection(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions, _ids: string[], _scopeId: string): PresentationRpcResponse<KeySetJSON>   Deprecated  
getContentDescriptor(_token: IModelRpcProps, _options: ContentDescriptorRpcRequestOptions): PresentationRpcResponse<undefined | DescriptorJSON>    
getContentInstanceKeys(_token: IModelRpcProps, _options: ContentInstanceKeysRpcRequestOptions): PresentationRpcResponse<{ items: KeySetJSON, total: number }>    
getContentSetSize(_token: IModelRpcProps, _options: ContentRpcRequestOptions): PresentationRpcResponse<number>    
getContentSources(_token: IModelRpcProps, _options: ContentSourcesRpcRequestOptions): PresentationRpcResponse<ContentSourcesRpcResult>    
getDisplayLabelDefinition(_token: IModelRpcProps, _options: DisplayLabelRpcRequestOptions): PresentationRpcResponse<LabelDefinition>    
getElementProperties(_token: IModelRpcProps, _options: SingleElementPropertiesRpcRequestOptions): PresentationRpcResponse<undefined | ElementProperties>    
getFilteredNodePaths(_token: IModelRpcProps, _options: FilterByTextHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]>    
getNodePaths(_token: IModelRpcProps, _options: FilterByInstancePathsHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]>    
getNodesCount(_token: IModelRpcProps, _options: HierarchyRpcRequestOptions): PresentationRpcResponse<number>    
getNodesDescriptor(_token: IModelRpcProps, _options: HierarchyLevelDescriptorRpcRequestOptions): PresentationRpcResponse<undefined | string | DescriptorJSON>    
getPagedContent(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<undefined | { contentSet: PagedResponse<ItemJSON>, descriptor: DescriptorJSON }>    
getPagedContentSet(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<PagedResponse<ItemJSON>>    
getPagedDisplayLabelDefinitions(_token: IModelRpcProps, _options: DisplayLabelsRpcRequestOptions): PresentationRpcResponse<PagedResponse<LabelDefinition>>    
getPagedDistinctValues(_token: IModelRpcProps, _options: DistinctValuesRpcRequestOptions): PresentationRpcResponse<PagedResponse<DisplayValueGroupJSON>>    
getPagedNodes(_token: IModelRpcProps, _options: Paged<HierarchyRpcRequestOptions>): PresentationRpcResponse<PagedResponse<NodeJSON>>    
getSelectionScopes(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions): PresentationRpcResponse<SelectionScope[]>    

Inherited methods

Name Inherited from Description
forward<T>(parameters: IArguments): Promise<T> RpcInterface Obtains the implementation result for an RPC operation.
isVersionCompatible(backend: string, frontend: string): boolean Static RpcInterface Determines whether the backend version of an RPC interface is compatible (according to semantic versioning) with the frontend version of the interface.

Properties

Name Type Description
interfaceName Static Readonly "PresentationRpcInterface" The immutable name of the interface.  
interfaceVersion Static string The semantic version of the interface.  

Defined in

Last Updated: 13 June, 2024