ODataMessageWriter Class

Definition

Namespace:

Microsoft.OData

Assembly:

Microsoft.OData.Core.dll

Package:

Microsoft.OData.Core v7.9.0

Writer class used to write all OData payloads (entries, resource sets, metadata documents, service documents, etc.).

public sealed class ODataMessageWriter : IDisposable

type ODataMessageWriter = class
    interface IDisposable

Public NotInheritable Class ODataMessageWriter
Implements IDisposable

Inheritance

Object

ODataMessageWriter

Implements

IDisposable

Constructors

ODataMessageWriter(IODataRequestMessage)	Creates a new ODataMessageWriter for the given request message.
ODataMessageWriter(IODataRequestMessage, ODataMessageWriterSettings)	Creates a new ODataMessageWriter for the given request message and message writer settings.
ODataMessageWriter(IODataRequestMessage, ODataMessageWriterSettings, IEdmModel)	Creates a new ODataMessageWriter for the given request message and message writer settings.
ODataMessageWriter(IODataResponseMessage)	Creates a new ODataMessageWriter for the given response message.
ODataMessageWriter(IODataResponseMessage, ODataMessageWriterSettings)	Creates a new ODataMessageWriter for the given response message and message writer settings.
ODataMessageWriter(IODataResponseMessage, ODataMessageWriterSettings, IEdmModel)	Creates a new ODataMessageWriter for the given response message and message writer settings.

Methods

CreateODataAsynchronousWriter()	Creates an ODataAsynchronousWriter to write an async response.
CreateODataAsynchronousWriterAsync()	Asynchronously creates an ODataAsynchronousWriter to write an async response.
CreateODataBatchWriter()	Creates an ODataBatchWriter to write a batch of requests or responses.
CreateODataBatchWriterAsync()	Asynchronously creates an ODataBatchWriter to write a batch of requests or responses.
CreateODataCollectionWriter()	Creates an ODataCollectionWriter to write a collection of primitive or complex values (as result of a service operation invocation).
CreateODataCollectionWriter(IEdmTypeReference)	Creates an ODataCollectionWriter to write a collection of primitive , enum or complex values (as result of a service operation invocation).
CreateODataCollectionWriterAsync()	Asynchronously creates an ODataCollectionWriter to write a collection of primitive or complex values (as result of a service operation invocation).
CreateODataCollectionWriterAsync(IEdmTypeReference)	Asynchronously creates an ODataCollectionWriter to write a collection of primitive or complex values (as result of a service operation invocation).
CreateODataDeltaResourceSetWriter()	Creates an ODataWriter to write a delta resource set.
CreateODataDeltaResourceSetWriter(IEdmEntitySetBase)	Creates an ODataWriter to write a delta resource set.
CreateODataDeltaResourceSetWriter(IEdmEntitySetBase, IEdmStructuredType)	Creates an ODataWriter to write a resource set.
CreateODataDeltaResourceSetWriterAsync()	Asynchronously creates an ODataWriter to write a delta resource set.
CreateODataDeltaResourceSetWriterAsync(IEdmEntitySetBase)	Asynchronously creates an ODataWriter to write a delta resource set.
CreateODataDeltaResourceSetWriterAsync(IEdmEntitySetBase, IEdmEntityType)	Asynchronously creates an ODataWriter to write a delta resource set.
CreateODataDeltaWriter(IEdmEntitySetBase, IEdmEntityType)	Obsolete. Creates an ODataDeltaWriter to write a delta response.
CreateODataDeltaWriterAsync(IEdmEntitySetBase, IEdmEntityType)	Obsolete. Asynchronously creates an ODataDeltaWriter to write a delta response.
CreateODataParameterWriter(IEdmOperation)	Creates an ODataParameterWriter to write a parameter payload.
CreateODataParameterWriterAsync(IEdmOperation)	Asynchronously creates an ODataParameterWriter to write a parameter payload.
CreateODataResourceSetWriter()	Creates an ODataWriter to write a resource set.
CreateODataResourceSetWriter(IEdmEntitySetBase)	Creates an ODataWriter to write a resource set.
CreateODataResourceSetWriter(IEdmEntitySetBase, IEdmStructuredType)	Creates an ODataWriter to write a resource set.
CreateODataResourceSetWriterAsync()	Asynchronously creates an ODataWriter to write a resource set.
CreateODataResourceSetWriterAsync(IEdmEntitySetBase)	Asynchronously creates an ODataWriter to write a resource set.
CreateODataResourceSetWriterAsync(IEdmEntitySetBase, IEdmStructuredType)	Asynchronously creates an ODataWriter to write a resource set.
CreateODataResourceWriter()	Creates an ODataWriter to write a resource.
CreateODataResourceWriter(IEdmNavigationSource)	Creates an ODataWriter to write a resource.
CreateODataResourceWriter(IEdmNavigationSource, IEdmStructuredType)	Creates an ODataWriter to write a resource.
CreateODataResourceWriterAsync()	Asynchronously creates an ODataWriter to write a resource.
CreateODataResourceWriterAsync(IEdmNavigationSource)	Asynchronously creates an ODataWriter to write a resource.
CreateODataResourceWriterAsync(IEdmNavigationSource, IEdmStructuredType)	Asynchronously creates an ODataWriter to write a resource.
CreateODataUriParameterResourceSetWriter(IEdmEntitySetBase, IEdmStructuredType)	Creates an ODataWriter to write a Uri operation parameter.
CreateODataUriParameterResourceSetWriterAsync(IEdmEntitySetBase, IEdmStructuredType)	Asynchronously creates an ODataWriter to write Uri operation parameter.
CreateODataUriParameterResourceWriter(IEdmNavigationSource, IEdmStructuredType)	Creates an ODataWriter to write a Uri operation parameter.
CreateODataUriParameterResourceWriterAsync(IEdmNavigationSource, IEdmStructuredType)	Asynchronously creates an ODataWriter to write Uri operation parameter.
Dispose()	Dispose() implementation to cleanup unmanaged resources of the writer.
WriteEntityReferenceLink(ODataEntityReferenceLink)	Writes a singleton result of a $ref query as the message payload.
WriteEntityReferenceLinkAsync(ODataEntityReferenceLink)	Asynchronously writes a singleton result of a $ref query as the message payload.
WriteEntityReferenceLinks(ODataEntityReferenceLinks)	Writes the result of a $ref query as the message payload.
WriteEntityReferenceLinksAsync(ODataEntityReferenceLinks)	Asynchronously writes the result of a $ref query as the message payload.
WriteError(ODataError, Boolean)	Writes an ODataError as the message payload.
WriteErrorAsync(ODataError, Boolean)	Asynchronously writes an ODataError as the message payload.
WriteMetadataDocument()	Writes the metadata document as the message body.
WriteMetadataDocumentAsync()	Asynchronously writes a metadata document as the message payload.
WriteProperty(ODataProperty)	Writes an ODataProperty as the message payload.
WritePropertyAsync(ODataProperty)	Asynchronously writes an ODataProperty as the message payload.
WriteServiceDocument(ODataServiceDocument)	Writes a service document with the specified serviceDocument as the message payload.
WriteServiceDocumentAsync(ODataServiceDocument)	Asynchronously writes a service document with the specified serviceDocument as the message payload.
WriteValue(Object)	Writes a single value as the message body.
WriteValueAsync(Object)	Asynchronously writes a single value as the message body.