ODataMessageReader Class

  • Article

 

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
System_CAPS_pubmethod ODataMessageReader(IODataRequestMessage)

Creates a new ODataMessageReader instance for the given request message.
System_CAPS_pubmethod ODataMessageReader(IODataRequestMessage, ODataMessageReaderSettings)

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

Creates a new ODataMessageReader instance for the given request message and message reader settings.
System_CAPS_pubmethod ODataMessageReader(IODataResponseMessage)

Creates a new ODataMessageReader instance for the given response message.
System_CAPS_pubmethod ODataMessageReader(IODataResponseMessage, ODataMessageReaderSettings)

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

Creates a new ODataMessageReader instance for the given response message and message reader settings.

Methods

Name Description
System_CAPS_pubmethod CreateODataAsynchronousReader()

System_CAPS_pubmethod CreateODataAsynchronousReaderAsync()

System_CAPS_pubmethod CreateODataBatchReader()

Creates an ODataBatchReader to read a batch of requests or responses.
System_CAPS_pubmethod CreateODataBatchReaderAsync()

Asynchronously creates an ODataBatchReader to read a batch of requests or responses.
System_CAPS_pubmethod CreateODataCollectionReader()

Creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
System_CAPS_pubmethod CreateODataCollectionReader(IEdmTypeReference)

Creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
System_CAPS_pubmethod CreateODataCollectionReaderAsync()

Asynchronously creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
System_CAPS_pubmethod CreateODataCollectionReaderAsync(IEdmTypeReference)

Asynchronously creates an ODataCollectionReader to read a collection of primitive or complex values (as result of a service operation invocation).
System_CAPS_pubmethod CreateODataDeltaReader(IEdmEntitySetBase, IEdmEntityType)

System_CAPS_pubmethod CreateODataDeltaReaderAsync(IEdmEntitySetBase, IEdmEntityType)

System_CAPS_pubmethod CreateODataEntryReader()

Creates an ODataReader to read an entry.
System_CAPS_pubmethod CreateODataEntryReader(IEdmEntityType)

Creates an ODataReader to read an entry.
System_CAPS_pubmethod CreateODataEntryReader(IEdmNavigationSource, IEdmEntityType)

Creates an ODataReader to read an entry.
System_CAPS_pubmethod CreateODataEntryReaderAsync()

Asynchronously creates an T:System.Data.OData.ODataReader to read an entry.
System_CAPS_pubmethod CreateODataEntryReaderAsync(IEdmEntityType)

Asynchronously creates an ODataReader to read an entry.
System_CAPS_pubmethod CreateODataEntryReaderAsync(IEdmNavigationSource, IEdmEntityType)

Asynchronously creates an ODataReader to read an entry.
System_CAPS_pubmethod CreateODataFeedReader()

Creates an ODataReader to read a feed.
System_CAPS_pubmethod CreateODataFeedReader(IEdmEntitySetBase, IEdmEntityType)

Creates an ODataReader to read a feed.
System_CAPS_pubmethod CreateODataFeedReader(IEdmEntityType)

Creates an ODataReader to read a feed.
System_CAPS_pubmethod CreateODataFeedReaderAsync()

Asynchronously creates an ODataReader to read a feed.
System_CAPS_pubmethod CreateODataFeedReaderAsync(IEdmEntitySetBase, IEdmEntityType)

Asynchronously creates an ODataReader to read a feed.
System_CAPS_pubmethod CreateODataFeedReaderAsync(IEdmEntityType)

Asynchronously creates an ODataReader to read a feed.
System_CAPS_pubmethod CreateODataParameterReader(IEdmOperation)

Creates an ODataParameterReader to read the parameters for operation.
System_CAPS_pubmethod CreateODataParameterReaderAsync(IEdmOperation)

Asynchronously creates an ODataParameterReader to read the parameters for operation.
System_CAPS_pubmethod DetectPayloadKind()

Determines the potential payload kinds and formats of the payload being read and returns it.
System_CAPS_pubmethod DetectPayloadKindAsync()

Determines the potential payload kinds and formats of the payload being read and returns it.
System_CAPS_pubmethod Dispose()

Releases the resources used by the current instance of the ODataMessageReader class.
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)
System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)
System_CAPS_pubmethod GetType()

(Inherited from Object.)
System_CAPS_pubmethod ReadEntityReferenceLink()

Reads a singleton result of a $ref query (entity reference link) as the message payload.
System_CAPS_pubmethod ReadEntityReferenceLinkAsync()

Asynchronously reads a singleton result of a $ref query (entity reference link) as the message payload.
System_CAPS_pubmethod ReadEntityReferenceLinks()

Reads the result of a $ref query (entity reference links) as the message payload.
System_CAPS_pubmethod ReadEntityReferenceLinksAsync()

Asynchronously reads the result of a $ref query as the message payload.
System_CAPS_pubmethod ReadError()

Reads an ODataError as the message payload.
System_CAPS_pubmethod ReadErrorAsync()

Asynchronously reads an ODataError as the message payload.
System_CAPS_pubmethod ReadMetadataDocument()

Reads the message body as metadata document.
System_CAPS_pubmethod ReadMetadataDocument(Func<Uri, XmlReader>)

System_CAPS_pubmethod ReadProperty()

Reads an ODataProperty as message payload.
System_CAPS_pubmethod ReadProperty(IEdmStructuralProperty)

Reads an ODataProperty as message payload.
System_CAPS_pubmethod ReadProperty(IEdmTypeReference)

Reads an ODataProperty as message payload.
System_CAPS_pubmethod ReadPropertyAsync()

Asynchronously reads an ODataProperty as message payload.
System_CAPS_pubmethod ReadPropertyAsync(IEdmStructuralProperty)

Asynchronously reads an ODataProperty as message payload.
System_CAPS_pubmethod ReadPropertyAsync(IEdmTypeReference)

Asynchronously reads an ODataProperty as message payload.
System_CAPS_pubmethod ReadServiceDocument()

Reads a service document payload.
System_CAPS_pubmethod ReadServiceDocumentAsync()

Asynchronously reads a service document payload.
System_CAPS_pubmethod ReadValue(IEdmTypeReference)

Reads a single value as the message body.
System_CAPS_pubmethod ReadValueAsync(IEdmTypeReference)

Asynchronously reads a single value as the message body.
System_CAPS_pubmethod 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