This topic has not yet been rated - Rate this topic

DataServiceContext Class

Windows Phone

March 22, 2012

The DataServiceContext represents the runtime context of an Open Data Protocol (OData) service. OData services are stateless, but the DataServiceContext is not. State on the client is maintained between interactions in order to support features such as update management. This class, and the DataServiceQuery class that represents a particular HTTP request to an OData service, are the two main classes in the client library.

Inheritance Hierarchy

System.Object
System.Data.Services.Client.DataServiceContext

Namespace: System.Data.Services.Client
Assembly: System.Data.Services.Client (in System.Data.Services.Client.dll)

Syntax

Copy

[DataContractAttribute(IsReference = true)]
public class DataServiceContext

The DataServiceContext type exposes the following members.

Constructors

	Name	Description
	DataServiceContext	Initializes a new instance of the DataServiceContext class by using the specified baseUri.

Top

Properties

	Name	Description
	ApplyingChanges	Gets a value that indicates whether the DataServiceContext is currently applying changes to tracked objects.
	BaseUri	Gets the absolute URI identifying the root of the target Open Data Protocol (OData) service.
	Credentials	Gets or sets the authentication information that is used when you send a request to the data service.
	DataNamespace	Gets or sets the XML namespace for data items, not metadata items, of an Atom payload.
	Entities	Gets a list of all the resources currently being tracked by the DataServiceContext.
	IgnoreMissingProperties	Gets or sets whether the properties read from the type must be mapped to properties on the client-side type.
	IgnoreResourceNotFoundException	Gets or sets whether an exception is raised when a 404 error (resource not found) is returned by the Open Data Protocol (OData) service.
	Links	Gets the collection of all associations or links currently being tracked by the DataServiceContext object.
	MergeOption	Gets or sets the synchronization option for receiving entities from an Open Data Protocol (OData) service.
	ResolveName	Gets or sets a function to override the default type resolution strategy used by the client library when sending entities to an Open Data Protocol (OData) service.
	ResolveType	Gets or sets a function that is used to override the default type resolution option that is used by the client library when receiving entities from an Open Data Protocol (OData) service.
	SaveChangesDefaultOptions	Gets or sets the SaveChangesOptions values used by the BeginSaveChanges method.
	TypeScheme	Gets or sets the URI that is used to indicate what type scheme is used by the service.
	UsePostTunneling	Gets or sets a Boolean value that indicates whether to use post tunneling.

Top

Methods

	Name	Description
	AddLink	Adds the specified link to the set of objects that the DataServiceContext is tracking.
	AddObject	Adds the specified object to the set of objects that the DataServiceContext is tracking.
	AddRelatedObject	Adds a related object to the context and creates the link that defines the relationship between the two objects in a single request.
	AttachLink	Notifies the DataServiceContext to start tracking the specified link between the source and the specified target entity.
	AttachTo(String, Object)	Notifies the DataServiceContext to start tracking the specified resource and supplies the location of the resource within the specified resource set.
	AttachTo(String, Object, String)	Notifies the DataServiceContext to start tracking the specified resource and supplies the location of the resource within the specified resource set.
	BeginExecute<TElement>(Uri, AsyncCallback, Object)	Asynchronously sends the request so that this call does not block processing while waiting for the results from the service.
	BeginExecute<T>(DataServiceQueryContinuation<T>, AsyncCallback, Object)	Asynchronously sends a request to the Open Data Protocol (OData) service to retrieve the next page of data in a paged query result.
	BeginExecuteBatch	Asynchronously submits a group of queries as a batch to the Open Data Protocol (OData) service.
	BeginGetReadStream	Asynchronously gets binary property data for the specified entity as a data stream along with the specified message headers.
	BeginLoadProperty(Object, String, AsyncCallback, Object)	Begins the operation to load the value of the specified property from the Open Data Protocol (OData) service.
	BeginLoadProperty(Object, String, DataServiceQueryContinuation, AsyncCallback, Object)	Asynchronously loads a page of related entities from the Open Data Protocol (OData) service by using the supplied next link URI.
	BeginLoadProperty(Object, String, Uri, AsyncCallback, Object)	Asynchronously loads a page of related entities from the Open Data Protocol (OData) service by using the supplied next link URI.
	BeginSaveChanges(AsyncCallback, Object)	Asynchronously submits the pending changes to the Open Data Protocol (OData) service collected by the DataServiceContext since the last time changes were saved.
	BeginSaveChanges(SaveChangesOptions, AsyncCallback, Object)	Asynchronously submits the pending changes to the Open Data Protocol (OData) service collected by the DataServiceContext since the last time changes were saved.
	CancelRequest	Cancels a request to the DataServiceContext.
	CreateQuery<T>	Creates an Open Data Protocol (OData) service query for data of a specified generic type.
	DeleteLink	Changes the state of the link to Deleted in the list of links being tracked by the DataServiceContext.
	DeleteObject	Changes the state of the specified object to Deleted in the DataServiceContext.
	Detach	Removes the entity from the list of entities that the DataServiceContext is tracking.
	DetachLink	Removes the specified link from the list of links being tracked by the DataServiceContext.
	EndExecute<TElement>	Called to complete the BeginExecute.
	EndExecuteBatch	Called to complete the BeginExecuteBatch.
	EndGetReadStream	Called to complete the asynchronous operation of retrieving a binary property as a stream.
	EndLoadProperty	Called to complete the BeginLoadProperty operation.
	EndSaveChanges	Called to complete the BeginSaveChanges operation.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetEntityDescriptor	Gets the EntityDescriptor for the supplied entity object.
	GetHashCode	(Inherited from Object.)
	GetLinkDescriptor	Gets the LinkDescriptor for a specific link that defines the relationship between two entities.
	GetMetadataUri	Gets a URI of the Open Data Protocol (OData) service metadata for the OData service.
	GetReadStreamUri	Gets the URI that is used to return binary property data as a data stream.
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	SetLink	Notifies the DataServiceContext that a new link exists between the objects specified and that the link is represented by the property specified by the sourceProperty parameter.
	SetSaveStream(Object, Stream, Boolean, DataServiceRequestArgs)	Sets a new data stream as the binary property of an entity with the specified settings in the request message.
	SetSaveStream(Object, Stream, Boolean, String, String)	Sets a new data stream as the binary property of an entity. The specified Content-Type and Slug headers are included in the request message.
	ToString	(Inherited from Object.)
	TryGetEntity<TEntity>	Tests retrieval of an entity being tracked by the DataServiceContext by reference to the URI of the entity.
	TryGetUri	Retrieves the canonical URI associated with the specified entity, if available.
	UpdateObject	Changes the state of the specified object in the DataServiceContext to Modified.

Top

Events

	Name	Description
	ReadingEntity	Occurs after the entity has been completely read into the target entity.
	ReadingResponse	Occurs before the response message from the data service is read.
	SendingRequest	Occurs when a new HttpWebRequest has been created.
	WritingEntity	Occurs after an entity has been fully serialized into XML (Atom), and allows the developer to change the XML before it is sent.
	WritingRequest	Occurs before the request message to the data service is written.