This documentation is archived and is not being maintained.

EntityDescriptor Class

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


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

public sealed class EntityDescriptor : Descriptor

The EntityDescriptor type exposes the following members.

Public propertyEditLinkGets or sets the URI that modifies the entity.
Public propertyEditStreamUriGets or sets the URI that modifies the binary property data of the entity.
Public propertyEntityGets the entity that contains the update data.
Public propertyETagGets an eTag value that indicates the state of data targeted for update since the last call to SaveChanges.
Public propertyIdentityGets or sets the URI that is the identity value of the entity.
Public propertyParentForInsertGets the parent entity that is related to the entity.
Public propertyParentPropertyForInsertGets the name of the property of the entity that is a navigation property and links to the parent entity.
Public propertyReadStreamUriGets or sets the URI that accesses the binary property data of the entity.
Public propertySelfLinkGets or sets the URI that is used to return the entity resource.
Public propertyServerTypeNameGets or sets the name of the type in the data source to which the entity is mapped.
Public propertyStateWhen overridden in a derived class, gets the state of the object at the time this instance was constructed. (Inherited from Descriptor.)
Public propertyStreamETagGets the eTag for the media resource associated with an entity that is a media link entry.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The SaveChanges 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 SaveChanges was called.

If an error occurred and processing stopped during an operation, the State() will remain unchanged.

.NET Framework

Supported in: 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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