API Reference > imodeljs-common > RpcInterface > WebAppRpcProtocol

WebAppRpcProtocol Class

The HTTP application protocol.

Extends

Extended by

Methods

Name Description
constructor(configuration: RpcConfiguration): WebAppRpcProtocol Constructs an HTTP protocol.  
getCode(status: RpcRequestStatus): number Supplies the protocol-specific code corresponding to a status value.  
getStatus(code: number): RpcRequestStatus Supplies the status corresponding to a protocol-specific code value.  
handleOpenApiDescriptionRequest(_req: HttpServerRequest, res: HttpServerResponse): void Convenience handler for an OpenAPI description request for an HTTP server.  
handleOperationGetRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void> Convenience handler for an RPC operation get request for an HTTP server.  
handleOperationPostRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void> Convenience handler for an RPC operation post request for an HTTP server.  
isTimeout(code: number): boolean Whether an HTTP status code indicates a request timeout.  
computeContentType(httpType: undefined | | string): RpcContentType Static Converts an HTTP content type value to an RPC content type value.  

Inherited methods

Name Inherited from Description
fulfill(request: SerializedRpcRequest): Promise<RpcRequestFulfillment> RpcProtocol Obtains the implementation result on the backend for an RPC operation request.
getOperationFromPath(path: string): SerializedRpcOperation RpcProtocol Override to supply the operation for a protocol-specific path value.
inflateToken(tokenFromBody: IModelRpcProps, _request: SerializedRpcRequest): IModelRpcProps RpcProtocol If checkToken is true, will be called on the backend to inflate the IModelRpcProps for each request.
serialize(request: RpcRequest<any>): Promise<SerializedRpcRequest> RpcProtocol Serializes a request.
supplyPathForOperation(operation: RpcOperation, _request: undefined | RpcRequest<any>): string RpcProtocol Override to supply the protocol-specific path value for an RPC operation.

Properties

Name Type Description
info Abstract OpenAPIInfo The OpenAPI-compatible info object for this protocol.  
pathPrefix string An optional prefix for RPC operation URI paths.  
preserveStreams boolean Used by protocols that can transmit stream values natively.  
requestType Readonly undefined The RPC request class for this protocol.  

Inherited properties

Name Type Inherited from Description
checkToken boolean RpcProtocol Used by protocols that can transmit IModelRpcProps values natively.
configuration Readonly RpcConfiguration RpcProtocol The configuration for the protocol.
events Readonly BeEvent<RpcProtocolEventHandler> RpcProtocol Events raised by the protocol.
events StaticReadonly BeEvent<RpcProtocolEventHandler> RpcProtocol Events raised by all protocols.
invocationType Readonly undefined RpcProtocol The RPC invocation class for this protocol.
protocolVersion StaticReadonly "1" RpcProtocol A version code that identifies the RPC protocol capabilties of this endpoint.
protocolVersionHeaderName string RpcProtocol The name of the RPC protocol version header.
serializedClientRequestContextHeaderNames SerializedClientRequestContext RpcProtocol  
transferChunkThreshold number RpcProtocol If greater than zero, specifies where to break large binary request payloads.

Defined in

Last Updated: 11 June, 2024