RpcInterface

Classes for working with RpcInterfaces.

Classes

Name Description  
BentleyCloudRpcConfiguration Operating parameters for Bentley cloud RPC interface deployments.  
BentleyCloudRpcManager Coordinates usage of RPC interfaces for Bentley cloud deployments.  
BentleyCloudRpcProtocol An http protocol for Bentley cloud RPC interface deployments.  
ElectronRpcConfiguration RPC interface configuration for an Electron-based application.  
ElectronRpcManager Coordinates usage of RPC interfaces for an Electron-based application.  
ElectronRpcProtocol RPC interface protocol for an Electron-based application.  
ElectronRpcRequest  
IModelNotFoundResponse Response if the IModelDb was not found at the backend  
IModelReadRpcInterface The RPC interface for reading from an iModel.  
IModelTileRpcInterface  
ResponseLike  
RpcConfiguration A RpcConfiguration specifies how calls on an RPC interface will be marshalled, plus other operating parameters.  
RpcControlResponse An RPC operation control response.  
RpcInterface An RPC interface is a set of operations exposed by a service that a client can call, using configurable protocols,  
RpcManager RPC interface management is concerned with coordination of access and configuration for RPC interfaces.  
RpcNotFoundResponse A RPC operation response.  
RpcOpenAPIDescription An OpenAPI-compatible description of an RPC protocol.  
RpcOperation An RPC operation descriptor.  
RpcOperationPolicy The policy for an RPC operation.  
RpcPendingResponse A pending RPC operation response.  
RpcProtocol An application protocol for an RPC interface.  
RpcRequest A RPC operation request.  
SnapshotIModelRpcInterface The RPC interface for working with snapshot iModels. Beta
WebAppRpcProtocol The HTTP application protocol.  
WebAppRpcRequest A web application RPC request.  

Enumerations

Name Description  
RpcResponseCacheControl Describes available options for RPC response caching.  

Interfaces

Name Description  
BentleyCloudRpcParams Initialization parameters for BentleyCloudRpcConfiguration.  
ElectronRpcParams Initialization parameters for ElectronRpcConfiguration.  
HttpServerRequest An HTTP server request object.  
HttpServerResponse An HTTP server response object.  
OpenAPIContentMap An OpenAPI 3.0 content map.  
OpenAPIDocument An OpenAPI 3.0 root document object.  
OpenAPIEncoding An OpenAPI 3.0 encoding object.  
OpenAPIInfo An OpenAPI 3.0 info object.  
OpenAPIMediaType An OpenAPI 3.0 media type object.  
OpenAPIOperation An OpenAPI 3.0 operation object.  
OpenAPIParameter An OpenAPI 3.0 parameter object.  
OpenAPIPathItem An OpenAPI 3.0 path item object.  
OpenAPIPaths An OpenAPI 3.0 paths object.  
OpenAPIRequestBody An OpenAPI 3.0 parameter object.  
OpenAPIResponse An OpenAPI 3.0 response object.  
OpenAPIResponses An OpenAPI 3.0 responses object.  
OpenAPISchema An OpenAPI 3.0 schema object.  
RpcInterfaceDefinition  
RpcInterfaceEndpoints Describes the endpoints of an RPC interface.  
RpcOperationsProfile Runtime information related to the operation load of one or more RPC interfaces.  
RpcRequestContext Interface to enable passing application-specific context with each RPC request.  

Type Aliases

Name Description  
HttpMethod_T  
RpcConfigurationSupplier  
RpcInterfaceImplementation  
RpcInvocationCallback_T Notification callback for an RPC invocation.  
RpcOperationPolicyProps  
RpcProtocolEventHandler Handles RPC protocol events.  
RpcRequestCallback_T Notification callback for an RPC request.  
RpcRequestEventHandler Handles RPC request events.  
RpcRequestInitialRetryIntervalSupplier_T Supplies the initial retry interval for an RPC request.  
RpcRequestNotFoundHandler Resolves "not found" responses for RPC requests.  
RpcRequestTokenSupplier_T Supplies an IModelToken for an RPC request.  
RpcResponseCachingCallback_T Determines if caching is permitted for a RPC response.  

Last Updated: 10 April, 2019