ODataBatchReader Class

Reference

Definition

Namespace:: Microsoft.OData

Assembly:: Microsoft.OData.Core.dll

Package:: Microsoft.OData.Core v7.9.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Abstract class for reading OData batch messages; also verifies the proper sequence of read calls on the reader.

public abstract class ODataBatchReader

type ODataBatchReader = class

Public MustInherit Class ODataBatchReader

Inheritance: Object
ODataBatchReader

Constructors

ODataBatchReader(ODataInputContext, Boolean)

Constructor.

Properties

CurrentGroupId	Public property for the current group id the reader is processing. The primary usage of this to correlate atomic group id in request and response operation messages as needed.
InputContext	The input context to read the content from.
State	Gets the current state of the batch reader.

Methods

BuildOperationRequestMessage(Func<Stream>, String, Uri, ODataBatchOperationHeaders, String, String, IEnumerable<String>, Boolean)	Instantiate an ODataBatchOperationRequestMessage instance.
BuildOperationResponseMessage(Func<Stream>, Int32, ODataBatchOperationHeaders, String, String)	Instantiate an ODataBatchOperationResponseMessage instance and set the status code.
CreateOperationRequestMessage()	Returns an ODataBatchOperationRequestMessage for reading the content of a batch operation.
CreateOperationRequestMessageAsync()	Asynchronously returns an ODataBatchOperationRequestMessage for reading the content of a batch operation.
CreateOperationRequestMessageImplementation()	Returns the cached ODataBatchOperationRequestMessage for reading the content of an operation in a batch request.
CreateOperationResponseMessage()	Returns an ODataBatchOperationResponseMessage for reading the content of a batch operation.
CreateOperationResponseMessageAsync()	Asynchronously returns an ODataBatchOperationResponseMessage for reading the content of a batch operation.
CreateOperationResponseMessageImplementation()	Returns the cached ODataBatchOperationRequestMessage for reading the content of an operation in a batch request.
GetCurrentGroupIdImplementation()	Gets the group id for the current request. Default implementation here is provided returning null.
Read()	Reads the next part from the batch message payload.
ReadAsync()	Asynchronously reads the next part from the batch message payload.
ReadAtChangesetEndImplementation()	Implementation of the reader logic when in state 'ChangesetEnd'.
ReadAtChangesetStartImplementation()	Implementation of the reader logic when in state 'ChangesetStart'.
ReadAtOperationImplementation()	Implementation of the reader logic when in state 'Operation'.
ReadAtStartImplementation()	Implementation of the reader logic when in state 'Start'.
ThrowODataException(String)	Sets the 'Exception' state and then throws an ODataException with the specified error message.
ValidateDependsOnIds(String, IEnumerable<String>)	Validate the dependsOnIds.

Applies to

Jaa