ClientRuntimeContext Members

Include Protected Members
Include Inherited Members

Represents the runtime context for accessing data from and invoking methods on remote objects.

The ClientRuntimeContext type exposes the following members.

Constructors

  Name Description
Protected method ClientRuntimeContext Initializes a new instance of the ClientRuntimeContext class with the specified absolute URL.

Top

Properties

  Name Description
Public property ApplicationName Gets or sets the name of the runtime where the current client application is located.
Public property AuthenticationMode Gets or sets the authentication mode for the client context.
Public property Credentials Gets or sets the authentication information for the client context.
Public property FormsAuthenticationLoginInfo Gets or sets the login information for the forms authentication mode of the client context.
Public property HasPendingRequest Gets the flag that indicates whether the client context has the ClientRequest to be sent to the server.
Public property PendingRequest Gets the ClientRequest object that is sent to the server when the next ExecuteQuery() is executed.
Public property RequestTimeout Gets or sets the requested time-out value in milliseconds.
Public property ServerLibraryVersion Gets the build version of Microsoft.SharePoint.Client.ServerRuntime.dll on the server.
Public property ServerSchemaVersion Gets the schema version of Microsoft.SharePoint.Client.ServerRuntime.dll on the server.
Public property StaticObjects This member is reserved for internal use and is not intended to be used directly from your code.
Public property Tag Gets or sets the object that stores custom data about the client context.
Public property Url Gets the URL associated with the runtime context.
Public property ValidateOnClient Gets or sets the flag that indicates whether the client library needs to validate the method parameters on the client side.
Public property WebRequestExecutorFactory Gets or sets the factory to create the WebRequestExecutor that is used to send the request to and get the response from the server.

Top

Methods

  Name Description
Public methodStatic member AddClientTypeAssembly Stores the client library type of the calling assembly.
Public method AddQuery This member is reserved for internal use and is not intended to be used directly from your code.
Public method AddQueryIdAndResultObject This member is reserved for internal use and is not intended to be used directly from your code.
Public method CastTo<T> Casts a specified client object to its derived type.
Public method Dispose() Disposes of the runtime context.
Protected method Dispose(Boolean) Disposes of the runtime context depending on the specified Boolean value.
Public method ExecuteQuery Executes the current set of data retrieval queries and method invocations.
Public method ExecuteQueryAsync(ClientRequestSucceededEventHandler, ClientRequestFailedEventHandler) Executes the current pending request asynchronously on the server.
Protected method ExecuteQueryAsync(ClientRequest, ClientRequestSucceededEventHandler, ClientRequestFailedEventHandler)
Public method Load<T> Retrieves the properties of a client object from the server.
Public method LoadQuery<T>(IQueryable<T>) Retrieves an enumerable sequence of the child client objects from a collection that can be the query expression in LINQ syntax.
Public method LoadQuery<T>(ClientObjectCollection<T>) Retrieves an enumerable sequence of the child client objects from a collection.
Protected method OnExecutingWebRequest Raises the ExecutingWebRequest event.
Public method ParseObjectFromJsonString Parses the specified JavaScript Object Notation (JSON) string and gets an object from it.
Protected method SetPendingRequestToBeExecuted
Public methodStatic member SetupRequestCredential Associates the authentication information with the specified request.
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event ExecutingWebRequest An event that is raised when the Web request is sent to the server.

Top

See Also

Reference

ClientRuntimeContext Class

Microsoft.SharePoint.Client Namespace