ODataMessageReader Class

 

Represents a reader class used to read all OData payloads.

Namespace:   Microsoft.OData.Core
Assembly:  Microsoft.OData.Core (in Microsoft.OData.Core.dll)

Inheritance Hierarchy

System.Object
  Microsoft.OData.Core.ODataMessageReader

Syntax

[SuppressMessageAttribute("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling", 
    Justification = "Main entry point for reader functionality")]
public sealed class ODataMessageReader : IDisposable

[SuppressMessageAttribute("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling", 
    Justification = "Main entry point for reader functionality")]
public ref class ODataMessageReader sealed : IDisposable

[<Sealed>]
[<SuppressMessageAttribute("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling",
    Justification = "Main entry point for reader functionality")>]
type ODataMessageReader = 
    class
        interface IDisposable
    end

<SuppressMessageAttribute("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling",
    Justification := "Main entry point for reader functionality")>
Public NotInheritable Class ODataMessageReader
    Implements IDisposable

Constructors

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

Methods

	Name	Description
	CreateODataAsynchronousReader()
	CreateODataAsynchronousReaderAsync()
	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)
	CreateODataDeltaReaderAsync(IEdmEntitySetBase, IEdmEntityType)
	CreateODataEntryReader()	Creates an ODataReader to read an entry.
	CreateODataEntryReader(IEdmEntityType)	Creates an ODataReader to read an entry.
	CreateODataEntryReader(IEdmNavigationSource, IEdmEntityType)	Creates an ODataReader to read an entry.
	CreateODataEntryReaderAsync()	Asynchronously creates an T:System.Data.OData.ODataReader to read an entry.
	CreateODataEntryReaderAsync(IEdmEntityType)	Asynchronously creates an ODataReader to read an entry.
	CreateODataEntryReaderAsync(IEdmNavigationSource, IEdmEntityType)	Asynchronously creates an ODataReader to read an entry.
	CreateODataFeedReader()	Creates an ODataReader to read a feed.
	CreateODataFeedReader(IEdmEntitySetBase, IEdmEntityType)	Creates an ODataReader to read a feed.
	CreateODataFeedReader(IEdmEntityType)	Creates an ODataReader to read a feed.
	CreateODataFeedReaderAsync()	Asynchronously creates an ODataReader to read a feed.
	CreateODataFeedReaderAsync(IEdmEntitySetBase, IEdmEntityType)	Asynchronously creates an ODataReader to read a feed.
	CreateODataFeedReaderAsync(IEdmEntityType)	Asynchronously creates an ODataReader to read a feed.
	CreateODataParameterReader(IEdmOperation)	Creates an ODataParameterReader to read the parameters for operation.
	CreateODataParameterReaderAsync(IEdmOperation)	Asynchronously creates an ODataParameterReader to read the parameters for operation.
	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()	Releases the resources used by the current instance of the ODataMessageReader class.
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	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.
	ReadMetadataDocument(Func<Uri, XmlReader>)
	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.
	ToString()	(Inherited from Object.)

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

Microsoft.OData.Core Namespace

Return to top