ClientRequestContext Class

Provides generic context for a server application to get details of a particular request that originated at the client. This context is used to pass information for various purposes including usage tracking and logging. Services that require authorization are passed an instance of the subclass: AuthorizedClientRequestContext

see ClientRequestContext rules.

see AuthorizedClientRequestContext

Methods

Name Description
constructor(activityId: string = ..., applicationId: string = "", applicationVersion: string = "", sessionId: string = Guid.empty): ClientRequestContext Create a new ClientRequestContext  
enter(): ClientRequestContext Set or reset the current ClientRequestContext to be this object.  
fromJSON(json: ClientRequestContextProps): ClientRequestContext Static    

Properties

Name Type Description
_current ProtectedStatic ClientRequestContext    
activityId Readonly string Used for logging to correlate all service requests that originated from this client request  
applicationId Readonly string Used for logging and usage tracking to identify the application that created this client request  
applicationVersion Readonly string Used for logging and usage tracking to identify the application version that created this client request  
current Accessor StaticReadOnly ClientRequestContext Get the current client request context  
sessionId Readonly string Used for logging to identify the session that created this client request  
useContextForRpc Accessor boolean    

Defined in

Last Updated: 11 June, 2024