ODataMessageWriter Class

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

Inheritance Hierarchy

System.Object
  Microsoft.Data.OData.ODataMessageWriter

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

Syntax

'Declaration
Public NotInheritable Class ODataMessageWriter _
    Implements IDisposable
'Usage
Dim instance As ODataMessageWriter
public sealed class ODataMessageWriter : IDisposable
public ref class ODataMessageWriter sealed : IDisposable
[<SealedAttribute>]
type ODataMessageWriter =  
    class 
        interface IDisposable 
    end
public final class ODataMessageWriter implements IDisposable

The ODataMessageWriter type exposes the following members.

Constructors

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

Top

Methods

  Name Description
Public method CreateODataBatchWriter Creates an ODataBatchWriter to write a batch of requests or responses.
Public method CreateODataBatchWriterAsync Asynchronously creates an ODataBatchWriter to write a batch of requests or responses.
Public method CreateODataCollectionWriter Creates an ODataCollectionWriter to write a collection of primitive or complex values (as result of a service operation invocation).
Public method CreateODataCollectionWriterAsync Asynchronously creates an ODataCollectionWriter to write a collection of primitive or complex values (as result of a service operation invocation).
Public method CreateODataEntryWriter Creates an ODataWriter to write an entry.
Public method CreateODataEntryWriterAsync Asynchronously creates an ODataWriter to write an entry.
Public method CreateODataFeedWriter Creates an ODataWriter to write a feed.
Public method CreateODataFeedWriterAsync Asynchronously creates an ODataWriter to write a feed.
Public method CreateODataParameterWriter Creates an ODataParameterWriter to write a parameter payload.
Public method CreateODataParameterWriterAsync Asynchronously creates an ODataParameterWriter to write a parameter payload.
Public method Dispose [M:System.IDisposable.Dispose()] implementation to cleanup unmanaged resources of the writer.
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method ToString (Inherited from Object.)
Public method WriteEntityReferenceLink Writes a singleton result of a $links query as the message payload.
Public method WriteEntityReferenceLinkAsync Asynchronously writes a singleton result of a $links query as the message payload.
Public method WriteEntityReferenceLinks Writes the result of a $links query as the message payload.
Public method WriteEntityReferenceLinksAsync Asynchronously writes the result of a $links query as the message payload.
Public method WriteError Writes an ODataError as the message payload.
Public method WriteErrorAsync Asynchronously writes an ODataError as the message payload.
Public method WriteMetadataDocument Writes the metadata document as the message body.
Public method WriteProperty Writes an ODataProperty as the message payload.
Public method WritePropertyAsync Asynchronously writes an ODataProperty as the message payload.
Public method WriteServiceDocument Writes a service document with the specified defaultWorkspace as the message payload.
Public method WriteServiceDocumentAsync Asynchronously writes a service document with the specified defaultWorkspace as the message payload.
Public method WriteValue Writes a single value as the message body.
Public method WriteValueAsync Asynchronously writes a single value as the message body.

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