MessageSettings Class

 

Contains settings shared by all message types for sending a message to a management point. Not all properties are recognized by all senders.

Namespace:   Microsoft.ConfigurationManagement.Messaging.Framework
Assembly:  Microsoft.ConfigurationManagement.Messaging (in Microsoft.ConfigurationManagement.Messaging.dll)

System::Object
  Microsoft.ConfigurationManagement.Messaging.Framework::MessageSettings

[SerializableAttribute]
public ref class MessageSettings sealed : IMessageSettings

NameDescription
System_CAPS_pubmethodMessageSettings()

Initializes a new instance of the MessageSettings class.

NameDescription
System_CAPS_pubpropertyBitsUpload

Gets or sets a value that indicates whether BITS will be used to send the message payload to the management point. Not all management point endpoints are compatible with BITS, therefore, use caution when setting this value to true. Additionally, not all senders support BITS uploading.

System_CAPS_pubpropertyCompression

Gets or sets the compression used with this message.

System_CAPS_pubpropertyCompressionLevel

Gets or sets the compression level used for sending compression. This property is ignored if compression is not enabled.

System_CAPS_pubpropertySystem_CAPS_staticDefaultSecurityMode

Controls the default security mode for messages. This property is static and will carry across the entire process. The default value is mixed mode.

System_CAPS_pubpropertyEndpoint

Gets or sets the management point endpoint that the message will be sent to.

Important: Do not set this value by anything outside of the messaging library (except for AdhocMessage ). All messages should set this appropriately (except for AdhocMessage ).

System_CAPS_pubpropertyHostName

Gets or sets the management point host name that the message will be sent to.

System_CAPS_pubpropertyHttpPort

Gets or sets the HTTP port to use for sending the message, if applicable. Not all senders will recognize this property value. For best compatibility, use the GetCommunicationPort method to get the most appropriate port.

System_CAPS_pubpropertyHttpsPort

Gets or sets the HTTPS (TLS/SSL) port to use for sending the message, if applicable. Not all senders will recognize this property value. For best compatibility, use the GetCommunicationPort method to get the most appropriate port.

System_CAPS_pubpropertyMessageProperties

Gets special message properties. This property is generally used by messages and should not be set by external code.

System_CAPS_pubpropertyMessageSourceType

Gets or sets the optional source type for the message.

System_CAPS_pubpropertyOverrideValidityChecks

Gets or sets a value that indicates whether the ability to override validity checking is enabled. If true, messages that have required properties that are null or empty will not fail to send.

System_CAPS_pubpropertyPostSendActionsEnabled

Gets or sets a value that indicates whether a post-send asynchronous task should be run, if supported by the message.

System_CAPS_pubpropertyReplyCompression

Gets or sets the reply compression used with this message.

System_CAPS_pubpropertyReplyEndpoint

Gets or sets the endpoint to direct message replies to. This setting is only relevant for senders. Do not change this property manually except under special circumstances.

System_CAPS_pubpropertySecurity

Gets the security settings for the message.

System_CAPS_pubpropertySecurityMode

Gets or sets the site security mode. The default value is mixed mode.

System_CAPS_pubpropertySenderProperties

Gets any special configuration settings for specific senders. Some messages may require special sender-specific settings that can be set here.

System_CAPS_pubpropertyServerRoleType

Gets or sets the optional server role type for the message.

System_CAPS_pubpropertySourceHost

Gets or sets the host name from which the message is sourced. The default value is the NetBIOS name of the local computer, but can be any value.

System_CAPS_pubpropertyTimeout

Get or sets a timeout for sending the message. Not all senders will honor this timeout value. The default value is 60 seconds.

NameDescription
System_CAPS_pubmethodCloneSettings(MessageSettings^)

Clones settings between message instances. This method can be used to preserve settings from one message to another. Settings that are specific to an implementation of a message will not be cloned.

System_CAPS_pubmethodCloneSettings(MessageSettings^, MessageCloneOptions)

Clones settings between message instances. This method can be used to preserve settings from one message to another. Settings that are specific to an implementation of a message will not be cloned.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_pubmethodGetCommunicationPort()

Gets the port that should be used for communication. The port that is returned depends on the setting for the SecurityMode property. If a specific override is required, use the GetCommunicationPort(MessageSecurityMode) method.

System_CAPS_pubmethodGetCommunicationPort(MessageSecurityMode)

Gets the port that should be used for communication. This is a hint; the actual port that should be used is specific to the implementation.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodSetCommunicationPort(MessageSecurityMode, UInt16)

Sets the communication port.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDefaultHttpPort

Default port for HTTP communication.

System_CAPS_pubfieldSystem_CAPS_staticDefaultHttpsPort

Default port for HTTPS communication.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: