ODataMessageReader Class

Represents the reader class used to read all OData payloads (entries, feeds, metadata documents, service documents, and so on).

Inheritance Hierarchy

System.Object
  Microsoft.Data.OData.ODataMessageReader

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

Syntax

'Declaration
Public NotInheritable Class ODataMessageReader _
    Implements IDisposable
'Usage
Dim instance As ODataMessageReader

public sealed class ODataMessageReader : IDisposable

public ref class ODataMessageReader sealed : IDisposable

[<SealedAttribute>]
type ODataMessageReader =  
    class 
        interface IDisposable 
    end

public final class ODataMessageReader implements IDisposable

The ODataMessageReader type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	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).
	CreateODataEntryReader()	Creates an ODataReader to read an entry.
	CreateODataEntryReader(IEdmEntityType)	Creates an ODataReader to read an entry.
	CreateODataEntryReaderAsync()	Asynchronously creates an ODataReader to read an entry.
	CreateODataEntryReaderAsync(IEdmEntityType)	Asynchronously creates an ODataReader to read an entry.
	CreateODataFeedReader()	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(IEdmEntityType)	Asynchronously creates an ODataReader to read a feed.
	CreateODataParameterReader	Creates an ODataParameterReader object.
	CreateODataParameterReaderAsync	Asynchronously creates an ODataParameterReader object.
	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	[M:System.IDisposable.Dispose()] implementation to cleanup unmanaged resources of the reader.
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ReadEntityReferenceLink	Reads a singleton result of a $links query (entity reference link) as the message payload.
	ReadEntityReferenceLinkAsync	Asynchronously reads a singleton result of a $links query (entity reference link) as the message payload.
	ReadEntityReferenceLinks	Reads the result of a $links query (entity reference links) as the message payload.
	ReadEntityReferenceLinksAsync	Asynchronously reads the result of a $links 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.
	ReadProperty()	Reads an ODataProperty as message payload.
	ReadProperty(IEdmTypeReference)	Reads an ODataProperty as message payload.
	ReadPropertyAsync()	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	Reads a single value as the message body.
	ReadValueAsync	Asynchronously reads a single value as the message body.
	ToString	(Inherited from Object.)

Top

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

Microsoft.Data.OData Namespace