Share via


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
Public method ODataMessageReader(IODataRequestMessage) Creates a new ODataMessageReader for the given request message.
Public method ODataMessageReader(IODataResponseMessage) Creates a new ODataMessageReader for the given response message.
Public method ODataMessageReader(IODataRequestMessage, ODataMessageReaderSettings) Creates a new ODataMessageReader for the given request message and message reader settings.
Public method ODataMessageReader(IODataResponseMessage, ODataMessageReaderSettings) Creates a new ODataMessageReader for the given response message and message reader settings.
Public method ODataMessageReader(IODataRequestMessage, ODataMessageReaderSettings, IEdmModel) Creates a new ODataMessageReader for the given request message and message reader settings.
Public method ODataMessageReader(IODataResponseMessage, ODataMessageReaderSettings, IEdmModel) Creates a new ODataMessageReader for the given response message and message reader settings.

Top

Methods

  Name Description
Public method CreateODataBatchReader Creates an ODataBatchReader to read a batch of requests or responses.
Public method CreateODataBatchReaderAsync Asynchronously creates an ODataBatchReader to read a batch of requests or responses.
Public method CreateODataCollectionReader() Creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
Public method CreateODataCollectionReader(IEdmTypeReference) Creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
Public method CreateODataCollectionReaderAsync() Asynchronously creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
Public method CreateODataCollectionReaderAsync(IEdmTypeReference) Asynchronously creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
Public method CreateODataEntryReader() Creates an ODataReader to read an entry.
Public method CreateODataEntryReader(IEdmEntityType) Creates an ODataReader to read an entry.
Public method CreateODataEntryReader(IEdmEntitySet, IEdmEntityType) Creates an ODataReader to read an entry.
Public method CreateODataEntryReaderAsync() Asynchronously creates an ODataReader to read an entry.
Public method CreateODataEntryReaderAsync(IEdmEntityType) Asynchronously creates an ODataReader to read an entry.
Public method CreateODataEntryReaderAsync(IEdmEntitySet, IEdmEntityType) Asynchronously creates an ODataReader to read an entry.
Public method CreateODataFeedReader() Creates an ODataReader to read a feed.
Public method CreateODataFeedReader(IEdmEntityType) Creates an ODataReader to read a feed.
Public method CreateODataFeedReader(IEdmEntitySet, IEdmEntityType) Creates an ODataReader to read a feed.
Public method CreateODataFeedReaderAsync() Asynchronously creates an ODataReader to read a feed.
Public method CreateODataFeedReaderAsync(IEdmEntityType) Asynchronously creates an ODataReader to read a feed.
Public method CreateODataFeedReaderAsync(IEdmEntitySet, IEdmEntityType) Asynchronously creates an ODataReader to read a feed.
Public method CreateODataParameterReader Creates an ODataParameterReader object.
Public method CreateODataParameterReaderAsync Asynchronously creates an ODataParameterReader object.
Public method DetectPayloadKind Determines the potential payload kinds and formats of the payload being read and returns it.
Public method DetectPayloadKindAsync Determines the potential payload kinds and formats of the payload being read and returns it.
Public method Dispose [M:System.IDisposable.Dispose()] implementation to cleanup unmanaged resources of the reader.
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method ReadEntityReferenceLink() Reads a singleton result of a $links query (entity reference link) as the message payload.
Public method ReadEntityReferenceLink(IEdmNavigationProperty) Reads a singleton result of a $links query (entity reference link) as the message payload.
Public method ReadEntityReferenceLinkAsync() Asynchronously reads a singleton result of a $links query (entity reference link) as the message payload.
Public method ReadEntityReferenceLinkAsync(IEdmNavigationProperty) Asynchronously reads a singleton result of a $links query (entity reference link) as the message payload.
Public method ReadEntityReferenceLinks() Reads the result of a $links query (entity reference links) as the message payload.
Public method ReadEntityReferenceLinks(IEdmNavigationProperty) Reads the result of a $links query (entity reference links) as the message payload.
Public method ReadEntityReferenceLinksAsync() Asynchronously reads the result of a $links query as the message payload.
Public method ReadEntityReferenceLinksAsync(IEdmNavigationProperty) Asynchronously reads the result of a $links query as the message payload.
Public method ReadError Reads an ODataError as the message payload.
Public method ReadErrorAsync Asynchronously reads an ODataError as the message payload.
Public method ReadMetadataDocument Reads the message body as metadata document.
Public method ReadProperty() Reads an ODataProperty as message payload.
Public method ReadProperty(IEdmStructuralProperty) Reads an ODataProperty as message payload.
Public method ReadProperty(IEdmTypeReference) Reads an ODataProperty as message payload.
Public method ReadPropertyAsync() Asynchronously reads an ODataProperty as message payload.
Public method ReadPropertyAsync(IEdmStructuralProperty) Asynchronously reads an ODataProperty as message payload.
Public method ReadPropertyAsync(IEdmTypeReference) Asynchronously reads an ODataProperty as message payload.
Public method ReadServiceDocument Reads a service document payload.
Public method ReadServiceDocumentAsync Asynchronously reads a service document payload.
Public method ReadValue Reads a single value as the message body.
Public method ReadValueAsync Asynchronously reads a single value as the message body.
Public method 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