EntityDescriptor Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Description of modifications done to entities by operations returned in a DataServiceResponse.

Inheritance Hierarchy

System.Object
  System.Data.Services.Client.Descriptor
    System.Data.Services.Client.EntityDescriptor

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

Syntax

'Declaration
<DebuggerDisplayAttribute("State = {state}, Uri = {editLink}, Element = {entity.GetType().ToString()}")> _
Public NotInheritable Class EntityDescriptor _
    Inherits Descriptor

[DebuggerDisplayAttribute("State = {state}, Uri = {editLink}, Element = {entity.GetType().ToString()}")]
public sealed class EntityDescriptor : Descriptor

The EntityDescriptor type exposes the following members.

Properties

	Name	Description
	EditLink	Gets or sets the URI that modifies the entity.
	EditStreamUri	Gets or sets the URI that modifies the binary property data of the entity.
	Entity	Gets the entity that contains the update data.
	ETag	Gets an eTag value that indicates the state of data targeted for update since the last call to BeginSaveChanges.
	Identity	Gets or sets the URI that is the identity value of the entity.
	ParentForInsert	Gets the parent entity that is related to the entity.
	ParentPropertyForInsert	Gets the name of the property of the entity that is a navigation property and links to the parent entity.
	ReadStreamUri	Gets or sets the URI that accesses the binary property data of the entity.
	SelfLink	Gets or sets the URI that is used to return the entity resource.
	ServerTypeName	Gets or sets the name of the type in the data source to which the entity is mapped.
	State	When overridden in a derived class, gets the state of the object at the time this instance was constructed. (Inherited from Descriptor.)
	StreamETag	Gets the eTag for the media resource associated with an entity that is a media link entry.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The EndSaveChanges method returns a DataServiceResponse object that contains a series of OperationResponse objects, each of which contains a sequence of EntityDescriptor or LinkDescriptor instances that represent changes that were persisted.

For successful operations, the State property of the descriptor will be set to Unchanged and the new values for insert and update operations will be merged according to the merge settings.

For operations with errors, the State of the descriptor will remain the same as it was before BeginSaveChanges was called.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Data.Services.Client Namespace