WebAppRpcRequest<TResponse> Class

A web application RPC request.



Name Description
constructor(client: RpcInterface, operation: string, parameters: any[]): WebAppRpcRequest Constructs a web application request.  
handleUnknownResponse(code: number): void Protected    
load(): Promise<RpcSerializedValue> Protected    
send(): Promise<number> Protected Sends the request.  
setHeader(name: string, value: string): void Protected Sets request header values.  
computeTransportType(value: RpcSerializedValue, source: any): RpcContentType ProtectedStatic Determines the most efficient transport type for an RPC value.  
parseRequest(protocol: WebAppRpcProtocol, req: HttpServerRequest): Promise<SerializedRpcRequest> Static Parses a request.  
sendResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, res: HttpServerResponse): void Static Sends the response for a web request.  

Inherited methods

Name Inherited from Description
_resolveRaw(): undefined Protected RpcRequest  
findParameterOfType<T>(requiredProperties: [index: string]: string): T | undefined RpcRequest Finds the first parameter of a given structural type if present.
findTokenPropsParameter(): IModelTokenProps | undefined RpcRequest Finds the first IModelTokenProps parameter if present.
reject(reason: any): void Protected RpcRequest  
setLastUpdatedTime(): void Protected RpcRequest Sets the last updated time for the request.
submit(): Promise<void> RpcRequest  
current(context: RpcInterface): RpcRequest Static RpcRequest The request for the current RPC operation.


Name Type Description
maxUrlComponentSize Static number The maximum size permitted for an encoded component in a URL.  
method HttpMethod_T The HTTP method for this request.  
protocol WebAppRpcProtocol Convenience access to the protocol of this request.  

Inherited properties

Name Type Inherited from Description
_rawPromise Protected Promise<Response> RpcRequest  
_response Protected Response | undefined RpcRequest  
aggregateLoad Accessor StaticReadOnly RpcOperationsProfile RpcRequest The aggregate operations profile of all active RPC interfaces.
client RpcInterface RpcRequest The RPC client instance for this request.
connecting Accessor ReadOnly boolean RpcRequest Whether a connection is active for this request.
elapsed Accessor ReadOnly number RpcRequest The elapsed time for this request.
events Static BeEvent<RpcRequestEventHandler> RpcRequest Events raised by RpcRequest.
extendedStatus Accessor ReadOnly string RpcRequest Extended status information for this request (if available).
id string RpcRequest The unique identifier of this request.
lastSubmitted Accessor ReadOnly number RpcRequest The last submission for this request.
lastUpdated Accessor ReadOnly number RpcRequest The last status update received for this request.
notFoundHandlers Static BeEvent<RpcRequestNotFoundHandler> RpcRequest Resolvers for "not found" requests.
operation RpcOperation RpcRequest The operation for this request.
parameters any[] RpcRequest The parameters for this request.
path string RpcRequest A protocol-specific path identifier for this request.
pending Accessor ReadOnly boolean RpcRequest Whether this request is pending.
rawResponse Accessor ReadOnly Promise<Response> RpcRequest The raw implementation response for this request.
response Promise<TResponse> RpcRequest The implementation response for this request.
retryInterval number RpcRequest The target interval (in milliseconds) between submission attempts for this request.
status Accessor ReadOnly RpcRequestStatus RpcRequest The status of this request.

Object Literals

Name Description
Standardized access to metadata about the request (useful for purposes such as logging).

Defined in

Last Updated: 20 September, 2019