SnapshotIModelRpcInterface Class

Beta

The RPC interface for working with snapshot iModels. This interface is intended for desktop and mobile products. Web products are discouraged from registering this interface.

Extends

Methods

Name Description
closeSnapshot(_iModelToken: IModelTokenProps): Promise<boolean>    
openSnapshot(_fileName: string): Promise<IModelProps>    
getClient(): SnapshotIModelRpcInterface Static Returns the SnapshotIModelRpcInterface client instance for the frontend.  

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 "SnapshotIModelRpcInterface" = "SnapshotIModelRpcInterface" The immutable name of the interface.  
interfaceVersion Static string The version of the interface.  

Inherited properties

Name Type Inherited from Description
configuration RpcConfiguration RpcInterface The configuration for the RPC interface.

Defined in

Last Updated: 10 September, 2019