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
	ODataMessageWriter(IODataRequestMessage)	Creates a new ODataMessageWriter for the given request message.
	ODataMessageWriter(IODataResponseMessage)	Creates a new ODataMessageWriter for the given response message.
	ODataMessageWriter(IODataRequestMessage, ODataMessageWriterSettings)	Creates a new ODataMessageWriter for the given request message and message writer settings.
	ODataMessageWriter(IODataResponseMessage, ODataMessageWriterSettings)	Creates a new ODataMessageWriter for the given response message and message writer settings.
	ODataMessageWriter(IODataRequestMessage, ODataMessageWriterSettings, IEdmModel)	Creates a new ODataMessageWriter for the given request message and message writer settings.
	ODataMessageWriter(IODataResponseMessage, ODataMessageWriterSettings, IEdmModel)	Creates a new ODataMessageWriter for the given response message and message writer settings.

Top

Methods

	Name	Description
	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 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).
	CreateODataEntryWriter()	Creates an ODataWriter to write an entry.
	CreateODataEntryWriter(IEdmEntitySet)	Creates an ODataWriter to write an entry.
	CreateODataEntryWriter(IEdmEntitySet, IEdmEntityType)	Creates an ODataWriter to write an entry.
	CreateODataEntryWriterAsync()	Asynchronously creates an ODataWriter to write an entry.
	CreateODataEntryWriterAsync(IEdmEntitySet)	Asynchronously creates an ODataWriter to write an entry.
	CreateODataEntryWriterAsync(IEdmEntitySet, IEdmEntityType)	Asynchronously creates an ODataWriter to write an entry.
	CreateODataFeedWriter()	Creates an ODataWriter to write a feed.
	CreateODataFeedWriter(IEdmEntitySet)	Creates an ODataWriter to write a feed.
	CreateODataFeedWriter(IEdmEntitySet, IEdmEntityType)	Creates an ODataWriter to write a feed.
	CreateODataFeedWriterAsync()	Asynchronously creates an ODataWriter to write a feed.
	CreateODataFeedWriterAsync(IEdmEntitySet)	Asynchronously creates an ODataWriter to write a feed.
	CreateODataFeedWriterAsync(IEdmEntitySet, IEdmEntityType)	Asynchronously creates an ODataWriter to write a feed.
	CreateODataParameterWriter	Creates an ODataParameterWriter to write a parameter payload.
	CreateODataParameterWriterAsync	Asynchronously creates an ODataParameterWriter to write a parameter payload.
	Dispose	[M:System.IDisposable.Dispose()] implementation to cleanup unmanaged resources of the writer.
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)
	WriteEntityReferenceLink(ODataEntityReferenceLink)	Writes a singleton result of a $links query as the message payload.
	WriteEntityReferenceLink(ODataEntityReferenceLink, IEdmEntitySet, IEdmNavigationProperty)	Writes a singleton result of a $links query as the message payload.
	WriteEntityReferenceLinkAsync(ODataEntityReferenceLink)	Asynchronously writes a singleton result of a $links query as the message payload.
	WriteEntityReferenceLinkAsync(ODataEntityReferenceLink, IEdmEntitySet, IEdmNavigationProperty)	Asynchronously writes a singleton result of a $links query as the message payload.
	WriteEntityReferenceLinks(ODataEntityReferenceLinks)	Writes the result of a $links query as the message payload.
	WriteEntityReferenceLinks(ODataEntityReferenceLinks, IEdmEntitySet, IEdmNavigationProperty)	Writes the result of a $links query as the message payload.
	WriteEntityReferenceLinksAsync(ODataEntityReferenceLinks)	Asynchronously writes the result of a $links query as the message payload.
	WriteEntityReferenceLinksAsync(ODataEntityReferenceLinks, IEdmEntitySet, IEdmNavigationProperty)	Asynchronously writes the result of a $links query as the message payload.
	WriteError	Writes an ODataError as the message payload.
	WriteErrorAsync	Asynchronously writes an ODataError as the message payload.
	WriteMetadataDocument	Writes the metadata document as the message body.
	WriteProperty	Writes an ODataProperty as the message payload.
	WritePropertyAsync	Asynchronously writes an ODataProperty as the message payload.
	WriteServiceDocument	Writes a service document with the specified defaultWorkspace as the message payload.
	WriteServiceDocumentAsync	Asynchronously writes a service document with the specified defaultWorkspace as the message payload.
	WriteValue	Writes a single value as the message body.
	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