ODataOutputContext Class

  • Reference

Definition

Namespace:
Microsoft.OData
Assembly:
Microsoft.OData.Core.dll
Package:
Microsoft.OData.Core v7.9.0

Base class for all output contexts, defines the interface to be implemented by the specific formats.

public abstract class ODataOutputContext : IDisposable
type ODataOutputContext = class
    interface IDisposable
Public MustInherit Class ODataOutputContext
Implements IDisposable
Inheritance
Object
ODataOutputContext
Implements
IDisposable

Constructors

ODataOutputContext(ODataFormat, ODataMessageInfo, ODataMessageWriterSettings)

Constructor.

Properties

MessageWriterSettings

The message writer settings to be used for writing.
Model

The model to use or null if no metadata is available.
PayloadUriConverter

The optional URL converter to perform custom URL conversion for URLs written to the payload.
Synchronous

true if the output should be written synchronously; false if it should be written asynchronously.
WritingResponse

Set to true if a response is being written.

Methods

CreateODataCollectionWriter(IEdmTypeReference)

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(IEdmEntitySetBase, IEdmStructuredType)

Creates an ODataWriter to write a delta resource set.
CreateODataDeltaResourceSetWriterAsync(IEdmEntitySetBase, IEdmStructuredType)

Asynchronously creates an ODataWriter to write a delta resource set.
CreateODataParameterWriter(IEdmOperation)

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

Asynchronously creates an ODataParameterWriter to write a parameter payload.
CreateODataResourceSetWriter(IEdmEntitySetBase, IEdmStructuredType)

Creates an ODataWriter to write a resource set.
CreateODataResourceSetWriterAsync(IEdmEntitySetBase, IEdmStructuredType)

Asynchronously creates an ODataWriter to write a resource set.
CreateODataResourceWriter(IEdmNavigationSource, IEdmStructuredType)

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 resource set into a Uri operation parameter.
CreateODataUriParameterResourceSetWriterAsync(IEdmEntitySetBase, IEdmStructuredType)

Asynchronously Creates an ODataWriter to write a resource set into a Uri operation parameter.
CreateODataUriParameterResourceWriter(IEdmNavigationSource, IEdmStructuredType)

Creates an ODataWriter to write a resource into a Uri operation parameter.
CreateODataUriParameterResourceWriterAsync(IEdmNavigationSource, IEdmStructuredType)

Asynchronously creates an ODataWriter to write a resource into a Uri operation parameter.
Dispose()

IDisposable.Dispose() implementation to cleanup unmanaged resources of the context.
Dispose(Boolean)

Perform the actual cleanup work.
WriteError(ODataError, Boolean)

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

Asynchronously writes an ODataError as the message payload.
WriteProperty(ODataProperty)

Writes an ODataProperty as message payload.
WritePropertyAsync(ODataProperty)

Asynchronously writes an ODataProperty as message payload.

Applies to