ODataMessageReader Class

Definition

Namespace:

Microsoft.OData

Assembly:

Microsoft.OData.Core.dll

Package:

Microsoft.OData.Core v7.9.0

Reader class used to read all OData payloads (resources, resource sets, metadata documents, service documents, etc.).

public sealed class ODataMessageReader : IDisposable

type ODataMessageReader = class
    interface IDisposable

Public NotInheritable Class ODataMessageReader
Implements IDisposable

Inheritance

Object

ODataMessageReader

Implements

IDisposable

Constructors

ODataMessageReader(IODataRequestMessage)	Creates a new ODataMessageReader for the given request message.
ODataMessageReader(IODataRequestMessage, ODataMessageReaderSettings)	Creates a new ODataMessageReader for the given request message and message reader settings.
ODataMessageReader(IODataRequestMessage, ODataMessageReaderSettings, IEdmModel)	Creates a new ODataMessageReader for the given request message and message reader settings.
ODataMessageReader(IODataResponseMessage)	Creates a new ODataMessageReader for the given response message.
ODataMessageReader(IODataResponseMessage, ODataMessageReaderSettings)	Creates a new ODataMessageReader for the given response message and message reader settings.
ODataMessageReader(IODataResponseMessage, ODataMessageReaderSettings, IEdmModel)	Creates a new ODataMessageReader for the given response message and message reader settings.

Methods

CreateODataAsynchronousReader()	Creates an ODataAsynchronousReader to read an async response.
CreateODataAsynchronousReaderAsync()	Asynchronously creates an ODataAsynchronousReader to read an async response.
CreateODataBatchReader()	Creates an ODataBatchReader to read a batch of requests or responses.
CreateODataBatchReaderAsync()	Asynchronously creates an ODataBatchReader to read a batch of requests or responses.
CreateODataCollectionReader()	Creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
CreateODataCollectionReader(IEdmTypeReference)	Creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
CreateODataCollectionReaderAsync()	Asynchronously creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
CreateODataCollectionReaderAsync(IEdmTypeReference)	Asynchronously creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
CreateODataDeltaReader(IEdmEntitySetBase, IEdmEntityType)	Obsolete. Creates an ODataDeltaReader to read a resource set.
CreateODataDeltaReaderAsync(IEdmEntitySetBase, IEdmEntityType)	Obsolete. Asynchronously creates an ODataDeltaReader to read a resource set.
CreateODataDeltaResourceSetReader()	Creates an ODataReader to read a delta resource set.
CreateODataDeltaResourceSetReader(IEdmEntitySetBase, IEdmStructuredType)	Creates an ODataReader to read a delta resource set.
CreateODataDeltaResourceSetReader(IEdmStructuredType)	Creates an ODataReader to read a delta resource set.
CreateODataDeltaResourceSetReaderAsync()	Asynchronously creates an ODataReader to read a delta resource set.
CreateODataDeltaResourceSetReaderAsync(IEdmEntitySetBase, IEdmStructuredType)	Asynchronously creates an ODataReader to read a delta resource set.
CreateODataDeltaResourceSetReaderAsync(IEdmStructuredType)	Asynchronously creates an ODataReader to read a delta resource set.
CreateODataParameterReader(IEdmOperation)	Creates an ODataParameterReader to read the parameters for operation.
CreateODataParameterReaderAsync(IEdmOperation)	Asynchronously creates an ODataParameterReader to read the parameters for operation.
CreateODataResourceReader()	Creates an ODataReader to read a resource.
CreateODataResourceReader(IEdmNavigationSource, IEdmStructuredType)	Creates an ODataReader to read a resource.
CreateODataResourceReader(IEdmStructuredType)	Creates an ODataReader to read a resource.
CreateODataResourceReaderAsync()	Asynchronously creates an ODataReader to read a resource.
CreateODataResourceReaderAsync(IEdmNavigationSource, IEdmStructuredType)	Asynchronously creates an ODataReader to read a resource.
CreateODataResourceReaderAsync(IEdmStructuredType)	Asynchronously creates an ODataReader to read a resource.
CreateODataResourceSetReader()	Creates an ODataReader to read a resource set.
CreateODataResourceSetReader(IEdmEntitySetBase, IEdmStructuredType)	Creates an ODataReader to read a resource set.
CreateODataResourceSetReader(IEdmStructuredType)	Creates an ODataReader to read a resource set.
CreateODataResourceSetReaderAsync()	Asynchronously creates an ODataReader to read a resource set.
CreateODataResourceSetReaderAsync(IEdmEntitySetBase, IEdmStructuredType)	Asynchronously creates an ODataReader to read a resource set.
CreateODataResourceSetReaderAsync(IEdmStructuredType)	Asynchronously creates an ODataReader to read a resource set.
CreateODataUriParameterResourceReader(IEdmNavigationSource, IEdmStructuredType)	Creates an ODataReader to read a resource in a Uri operation parameter.
CreateODataUriParameterResourceReaderAsync(IEdmNavigationSource, IEdmStructuredType)	Asynchronously creates an ODataReader to read a resource in a Uri operation parameter.
CreateODataUriParameterResourceSetReader(IEdmEntitySetBase, IEdmStructuredType)	Creates an ODataReader to read a resource set in a Uri operation parameter.
CreateODataUriParameterResourceSetReaderAsync(IEdmEntitySetBase, IEdmStructuredType)	Asynchronously creates an ODataReader to read a resource set in a Uri operation parameter.
DetectPayloadKind()	Determines the potential payload kinds and formats of the payload being read and returns it.
DetectPayloadKindAsync()	Determines the potential payload kinds and formats of the payload being read and returns it.
Dispose()	Dispose() implementation to cleanup unmanaged resources of the reader.
ReadEntityReferenceLink()	Reads a singleton result of a $ref query (entity reference link) as the message payload.
ReadEntityReferenceLinkAsync()	Asynchronously reads a singleton result of a $ref query (entity reference link) as the message payload.
ReadEntityReferenceLinks()	Reads the result of a $ref query (entity reference links) as the message payload.
ReadEntityReferenceLinksAsync()	Asynchronously reads the result of a $ref query as the message payload.
ReadError()	Reads an ODataError as the message payload.
ReadErrorAsync()	Asynchronously reads an ODataError as the message payload.
ReadMetadataDocument()	Reads the message body as metadata document. It can read JSON/XML CSDL based on the content type.
ReadMetadataDocument(CsdlReaderSettingsBase)	Reads the message body as metadata document. It can read CSDL based on the content type using the given settings. Be NOTED: If the setting is not related to the metadata format, it will be ignored.
ReadMetadataDocument(Func<Uri,XmlReader>)	Reads the message body as metadata document.
ReadProperty()	Reads an ODataProperty as message payload.
ReadProperty(IEdmStructuralProperty)	Reads an ODataProperty as message payload.
ReadProperty(IEdmTypeReference)	Reads an ODataProperty as message payload.
ReadPropertyAsync()	Asynchronously reads an ODataProperty as message payload.
ReadPropertyAsync(IEdmStructuralProperty)	Asynchronously reads an ODataProperty as message payload.
ReadPropertyAsync(IEdmTypeReference)	Asynchronously reads an ODataProperty as message payload.
ReadServiceDocument()	Reads a service document payload.
ReadServiceDocumentAsync()	Asynchronously reads a service document payload.
ReadValue(IEdmTypeReference)	Reads a single value as the message body.
ReadValueAsync(IEdmTypeReference)	Asynchronously reads a single value as the message body.