ODataMessageWriterSettings Class

 

Represents a configuration settings for OData message writers.

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

Inheritance Hierarchy

System.Object
  Microsoft.OData.Core.ODataMessageWriterSettingsBase
    Microsoft.OData.Core.ODataMessageWriterSettings

Syntax

public sealed class ODataMessageWriterSettings : ODataMessageWriterSettingsBase
public ref class ODataMessageWriterSettings sealed : ODataMessageWriterSettingsBase
[<Sealed>]
type ODataMessageWriterSettings = 
    class
        inherit ODataMessageWriterSettingsBase
    end
Public NotInheritable Class ODataMessageWriterSettings
    Inherits ODataMessageWriterSettingsBase

Constructors

Name Description
System_CAPS_pubmethod ODataMessageWriterSettings()

Initializes a new instance of the ODataMessageWriterSettings class with default settings.

System_CAPS_pubmethod ODataMessageWriterSettings(ODataMessageWriterSettings)

Initializes a new instance of the ODataMessageWriterSettings class with specified settings.

Properties

Name Description
System_CAPS_pubproperty AutoComputePayloadMetadataInJson

Gets or sets a value that indicates whether the writer should automatically generate or omit metadata in JSON payloads based on the metadata level.

System_CAPS_pubproperty CheckCharacters

Gets or sets whether the writer should check for valid Xml characters.(Inherited from ODataMessageWriterSettingsBase.)

System_CAPS_pubproperty DisableMessageStreamDisposal

Gets or sets a value that indicates whether the message stream will not be disposed after finishing writing with the message.

System_CAPS_pubproperty EnableFullValidation

System_CAPS_pubproperty Indent

Gets or sets whether the writer should use indentation.(Inherited from ODataMessageWriterSettingsBase.)

System_CAPS_pubproperty JsonPCallback

Gets or sets a callback function use to wrap the response from server.

System_CAPS_pubproperty MediaTypeResolver

System_CAPS_pubproperty MessageQuotas

Gets or sets the quotas to use for limiting resource consumption when writing an OData message.(Inherited from ODataMessageWriterSettingsBase.)

System_CAPS_pubproperty ODataUri

Gets or sets the OData Uri of an incoming request.

System_CAPS_pubproperty PayloadBaseUri

Gets or sets the document base URI which is used as base for all relative URIs.

System_CAPS_pubproperty UseKeyAsSegment

Gets or sets a value that indicates whether the writer should put key values in their own URI segment when automatically building URIs.

System_CAPS_pubproperty Version

Gets or sets the OData protocol version to be used for writing payloads.

Methods

Name Description
System_CAPS_pubmethod EnableDefaultBehavior()

Enables the ODataMessageWriterSettings default behavior.

System_CAPS_pubmethod EnableODataServerBehavior()

Specifies whether the WCF data services server behavior is enabled.

System_CAPS_pubmethod EnableODataServerBehavior(Boolean)

Specifies whether the OData services server behavior is enabled.

System_CAPS_pubmethod EnableWcfDataServicesClientBehavior()

Enables the WCF data services client behavior.

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 SetContentType(ODataFormat)

Sets the format to be used when writing the payload. This will automatically set a compatible content type header.

System_CAPS_pubmethod SetContentType(String, String)

Sets the acceptable media types and character sets from which the content type will be computed when writing the payload.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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