ODataMessageWriterSettings Class

Represents the configuration settings for OData message writers.

Inheritance Hierarchy

System.Object
  Microsoft.Data.OData.ODataMessageWriterSettingsBase
    Microsoft.Data.OData.ODataMessageWriterSettings

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

Syntax

'Declaration
Public NotInheritable Class ODataMessageWriterSettings _
    Inherits ODataMessageWriterSettingsBase
'Usage
Dim instance As ODataMessageWriterSettings
public sealed class ODataMessageWriterSettings : ODataMessageWriterSettingsBase
public ref class ODataMessageWriterSettings sealed : public ODataMessageWriterSettingsBase
[<SealedAttribute>]
type ODataMessageWriterSettings =  
    class 
        inherit ODataMessageWriterSettingsBase 
    end
public final class ODataMessageWriterSettings extends ODataMessageWriterSettingsBase

The ODataMessageWriterSettings type exposes the following members.

Constructors

  Name Description
Public method ODataMessageWriterSettings() Initializes a new instance of the ODataMessageWriterSettings class with default settings.
Public method ODataMessageWriterSettings(ODataMessageWriterSettings) Initializes a new instance of the ODataMessageWriterSettings class with specified settings.

Top

Properties

  Name Description
Public property 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.
Public property BaseUri Gets or sets the document base URI which is used as base for all relative URIs.
Public property CheckCharacters Gets or sets whether the writer should check for valid Xml characters or not. (Inherited from ODataMessageWriterSettingsBase.)
Public property DisableMessageStreamDisposal Gets or sets a value that indicates whether the message stream will not be disposed after finishing writing with the message.
Public property Indent Gets or sets whether the writer should use indentation or not. (Inherited from ODataMessageWriterSettingsBase.)
Public property JsonPCallback Gets or sets a callback function use to wrap the response from server.
Public property MessageQuotas Gets or sets the quotas to use for limiting resource consumption when writing an OData message. (Inherited from ODataMessageWriterSettingsBase.)
Public property Version Gets or sets the OData protocol version to be used for writing payloads.

Top

Methods

  Name Description
Public method EnableDefaultBehavior Enables the ODataMessageWriterSettings default behavior.
Public method EnableWcfDataServicesClientBehavior Enables the WCF data services client behavior.
Public method EnableWcfDataServicesServerBehavior(Boolean) Specifies whether the WCF data services server behavior is enabled.
Public method EnableWcfDataServicesServerBehavior(Boolean, Boolean) Specifies whether the WCF data services server behavior is enabled.
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method SetAtomEntryXmlCustomization Sets the customization XML format for Atom entry.
Public method SetContentType(ODataFormat) Sets the format to be used when writing the payload. This will automatically set a compatible content type header.
Public method SetContentType(String, String) Sets the acceptable media types and character sets from which the content type will be computed when writing the payload.
Public method SetMetadataDocumentUri(Uri) Sets the URI of the metadata document.
Public method SetMetadataDocumentUri(Uri, String) Sets the URI of the metadata document.
Public method ToString (Inherited from Object.)

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