Share via

ODataMessageWriter Class

  • Article

 

Represents a class to write all OData payloads (entries, feeds, metadata documents, service documents, etc.).

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

Inheritance Hierarchy

System.Object
  Microsoft.OData.Core.ODataMessageWriter

Syntax

public sealed class ODataMessageWriter : IDisposable

public ref class ODataMessageWriter sealed : IDisposable

[<Sealed>]
type ODataMessageWriter = 
    class
        interface IDisposable
    end

Public NotInheritable Class ODataMessageWriter
    Implements IDisposable

Constructors

Name Description
System_CAPS_pubmethod ODataMessageWriter(IODataRequestMessage)

Creates a new ODataMessageWriter for the given request message.
System_CAPS_pubmethod ODataMessageWriter(IODataRequestMessage, ODataMessageWriterSettings)

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

Creates a new ODataMessageWriter for the given request message and message writer settings.
System_CAPS_pubmethod ODataMessageWriter(IODataResponseMessage)

Creates a new ODataMessageWriter for the given response message.
System_CAPS_pubmethod ODataMessageWriter(IODataResponseMessage, ODataMessageWriterSettings)

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

Creates a new ODataMessageWriter for the given response message and message writer settings.

Methods

Name Description
System_CAPS_pubmethod CreateODataAsynchronousWriter()

System_CAPS_pubmethod CreateODataAsynchronousWriterAsync()

System_CAPS_pubmethod CreateODataBatchWriter()

Creates an ODataBatchWriter to write a batch of requests or responses.
System_CAPS_pubmethod CreateODataBatchWriterAsync()

Asynchronously creates an ODataBatchWriter to write a batch of requests or responses.
System_CAPS_pubmethod CreateODataCollectionWriter()

Creates an ODataCollectionWriter to write a collection of primitive or complex values (as result of a service operation invocation).
System_CAPS_pubmethod CreateODataCollectionWriter(IEdmTypeReference)

Creates an ODataCollectionWriter to write a collection of primitive or complex values (as result of a service operation invocation).
System_CAPS_pubmethod CreateODataCollectionWriterAsync()

Asynchronously creates an ODataCollectionWriter to write a collection of primitive or complex values (as result of a service operation invocation).
System_CAPS_pubmethod CreateODataCollectionWriterAsync(IEdmTypeReference)

Asynchronously creates an ODataCollectionWriter to write a collection of primitive or complex values (as result of a service operation invocation).
System_CAPS_pubmethod CreateODataDeltaWriter(IEdmEntitySetBase, IEdmEntityType)

System_CAPS_pubmethod CreateODataDeltaWriterAsync(IEdmEntitySetBase, IEdmEntityType)

System_CAPS_pubmethod CreateODataEntryWriter()

Creates an ODataWriter to write an entry.
System_CAPS_pubmethod CreateODataEntryWriter(IEdmNavigationSource)

Creates an ODataWriter to write an entry.
System_CAPS_pubmethod CreateODataEntryWriter(IEdmNavigationSource, IEdmEntityType)

Creates an ODataWriter to write an entry.
System_CAPS_pubmethod CreateODataEntryWriterAsync()

Asynchronously creates an ODataWriter to write an entry.
System_CAPS_pubmethod CreateODataEntryWriterAsync(IEdmNavigationSource)

Asynchronously creates an ODataWriter to write an entry.
System_CAPS_pubmethod CreateODataEntryWriterAsync(IEdmNavigationSource, IEdmEntityType)

Asynchronously creates an ODataWriter to write an entry.
System_CAPS_pubmethod CreateODataFeedWriter()

Creates an ODataWriter to write a feed.
System_CAPS_pubmethod CreateODataFeedWriter(IEdmEntitySetBase)

Creates an ODataWriter to write a feed.
System_CAPS_pubmethod CreateODataFeedWriter(IEdmEntitySetBase, IEdmEntityType)

Creates an ODataWriter to write a feed.
System_CAPS_pubmethod CreateODataFeedWriterAsync()

Asynchronously creates an ODataWriter to write a feed.
System_CAPS_pubmethod CreateODataFeedWriterAsync(IEdmEntitySetBase)

Asynchronously creates an ODataWriter to write a feed.
System_CAPS_pubmethod CreateODataFeedWriterAsync(IEdmEntitySetBase, IEdmEntityType)

Asynchronously creates an ODataWriter to write a feed.
System_CAPS_pubmethod CreateODataParameterWriter(IEdmOperation)

Creates an ODataParameterWriter to write a parameter payload.
System_CAPS_pubmethod CreateODataParameterWriterAsync(IEdmOperation)

Asynchronously creates an ODataParameterWriter to write a parameter payload.
System_CAPS_pubmethod Dispose()

Releases the resources used by the current instance of the ODataMessageWriter 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 ToString()

(Inherited from Object.)
System_CAPS_pubmethod WriteEntityReferenceLink(ODataEntityReferenceLink)

Writes a singleton result of a $ref query as the message payload.
System_CAPS_pubmethod WriteEntityReferenceLinkAsync(ODataEntityReferenceLink)

Asynchronously writes a singleton result of a $ref query as the message payload.
System_CAPS_pubmethod WriteEntityReferenceLinks(ODataEntityReferenceLinks)

Writes the result of a $ref query as the message payload.
System_CAPS_pubmethod WriteEntityReferenceLinksAsync(ODataEntityReferenceLinks)

Asynchronously writes the result of a $ref query as the message payload.
System_CAPS_pubmethod WriteError(ODataError, Boolean)

Writes an ODataError as the message payload.
System_CAPS_pubmethod WriteErrorAsync(ODataError, Boolean)

Asynchronously writes an ODataError as the message payload.
System_CAPS_pubmethod WriteMetadataDocument()

Writes the metadata document as the message body.
System_CAPS_pubmethod WriteProperty(ODataProperty)

Writes an ODataProperty as the message payload.
System_CAPS_pubmethod WritePropertyAsync(ODataProperty)

Asynchronously writes an ODataProperty as the message payload.
System_CAPS_pubmethod WriteServiceDocument(ODataServiceDocument)

Writes a service document with the specified serviceDocument as the message payload.
System_CAPS_pubmethod WriteServiceDocumentAsync(ODataServiceDocument)

Asynchronously writes a service document with the specified serviceDocument as the message payload.
System_CAPS_pubmethod WriteValue(Object)

Writes a single value as the message body.
System_CAPS_pubmethod WriteValueAsync(Object)

Asynchronously writes a single value as the message body.

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