Class ODataEntityTypeSerializer

Namespace

System.Web.Http.OData.Formatter.Serialization

Assembly

System.Web.Http.OData.dll

ODataSerializer for serializing instances of Microsoft.Data.Edm.IEdmEntityType

public class ODataEntityTypeSerializer : ODataEdmTypeSerializer

Inheritance

object

ODataSerializer

ODataEdmTypeSerializer

ODataEntityTypeSerializer

Inherited Members

ODataEdmTypeSerializer.CreateODataValue(object, IEdmTypeReference, ODataSerializerContext)

ODataEdmTypeSerializer.SerializerProvider

ODataSerializer.ODataPayloadKind

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ODataEntityTypeSerializer(ODataSerializerProvider)

public ODataEntityTypeSerializer(ODataSerializerProvider serializerProvider)

Parameters

serializerProvider ODataSerializerProvider

Methods

CreateEntry(SelectExpandNode, EntityInstanceContext)

Creates the Microsoft.Data.OData.ODataEntry to be written while writing this entity.

public virtual ODataEntry CreateEntry(SelectExpandNode selectExpandNode, EntityInstanceContext entityInstanceContext)

Parameters

selectExpandNode SelectExpandNode

The SelectExpandNode describing the response graph.

entityInstanceContext EntityInstanceContext

The context for the entity instance being written.

Returns

ODataEntry

The created Microsoft.Data.OData.ODataEntry.

CreateNavigationLink(IEdmNavigationProperty, EntityInstanceContext)

Creates the Microsoft.Data.OData.ODataNavigationLink to be written while writing this entity.

public virtual ODataNavigationLink CreateNavigationLink(IEdmNavigationProperty navigationProperty, EntityInstanceContext entityInstanceContext)

Parameters

navigationProperty IEdmNavigationProperty

The navigation property for which the navigation link is being created.

entityInstanceContext EntityInstanceContext

The context for the entity instance being written.

Returns

ODataNavigationLink

The navigation link to be written.

CreateODataAction(IEdmFunctionImport, EntityInstanceContext)

Creates an Microsoft.Data.OData.ODataAction to be written for the given action and the entity instance.

public virtual ODataAction CreateODataAction(IEdmFunctionImport action, EntityInstanceContext entityInstanceContext)

Parameters

action IEdmFunctionImport

The OData action.

entityInstanceContext EntityInstanceContext

The context for the entity instance being written.

Returns

ODataAction

The created action or null if the action should not be written.

CreateSelectExpandNode(EntityInstanceContext)

Creates the SelectExpandNode that describes the set of properties and actions to select and expand while writing this entity.

public virtual SelectExpandNode CreateSelectExpandNode(EntityInstanceContext entityInstanceContext)

Parameters

entityInstanceContext EntityInstanceContext

Contains the entity instance being written and the context.

Returns

SelectExpandNode

The SelectExpandNode that describes the set of properties and actions to select and expand while writing this entity.

CreateStructuralProperty(IEdmStructuralProperty, EntityInstanceContext)

Creates the Microsoft.Data.OData.ODataProperty to be written for the given entity and the structural property.

public virtual ODataProperty CreateStructuralProperty(IEdmStructuralProperty structuralProperty, EntityInstanceContext entityInstanceContext)

Parameters

structuralProperty IEdmStructuralProperty

The EDM structural property being written.

entityInstanceContext EntityInstanceContext

The context for the entity instance being written.

Returns

ODataProperty

The Microsoft.Data.OData.ODataProperty to write.

WriteObject(object, Type, ODataMessageWriter, ODataSerializerContext)

public override void WriteObject(object graph, Type type, ODataMessageWriter messageWriter, ODataSerializerContext writeContext)

Parameters

graph object

type Type

messageWriter ODataMessageWriter

writeContext ODataSerializerContext

WriteObjectInline(object, IEdmTypeReference, ODataWriter, ODataSerializerContext)

public override void WriteObjectInline(object graph, IEdmTypeReference expectedType, ODataWriter writer, ODataSerializerContext writeContext)

Parameters

graph object

expectedType IEdmTypeReference

writer ODataWriter

writeContext ODataSerializerContext