Message Class

Article
12/30/2016

Core message class. In general, this class should not be sub-classed directly. AsynchronousMessage should be used for one-way (no reply) messages (such as DDR or status) and SynchronousMessageRequest with SynchronousMessageReply should be used for two-way, synchronous, messages (such as policy or location).

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

Inheritance Hierarchy

System.Object
Microsoft.ConfigurationManagement.Messaging.Framework.Message
Microsoft.ConfigurationManagement.Messaging.Framework.AdhocMessage
Microsoft.ConfigurationManagement.Messaging.Framework.AsynchronousMessage
Microsoft.ConfigurationManagement.Messaging.Framework.SynchronousMessageReply
Microsoft.ConfigurationManagement.Messaging.Framework.SynchronousMessageRequest
Microsoft.ConfigurationManagement.Messaging.Messages.Ccm.CcmMessage

Syntax

[SerializableAttribute]
[MessageSupportAttribute(MessageSupportStatus.Unknown)]
public abstract class Message : IMessage, IMessageBase, IDeserializationCallback

[SerializableAttribute]
[MessageSupportAttribute(MessageSupportStatus::Unknown)]
public ref class Message abstract : IMessage, IMessageBase, IDeserializationCallback

<SerializableAttribute>
<MessageSupportAttribute(MessageSupportStatus.Unknown)>
Public MustInherit Class Message
    Implements IMessage, IMessageBase, IDeserializationCallback

Properties

	Name	Description
	Attachments	Gets message attachments.
	Body	Gets the message body. This property should not be empty, with limited exceptions.
	MessageId	Gets the internal ID of a message.
	PostSendActionsSupported	Gets a value that indicates whether the message supports post-send actions.
	Priority	Gets the priority for a message. This property is only used for reference by senders and has no effect on the message.
	SenderCallback	Gets a sender callback for a message. This property is null unless a message is in the process of being sent.
	SenderType	Gets the sender type for a message. This property is only used for reference by senders and has no effect on the message.
	Settings	Gets message settings.
	SiteCode	Gets or sets the site code to use for sending a message. Some messages require this property.
	SmsId	Gets or sets the SMSID to use for signing and sending a message.
	SupportsInlineSerializers	Gets a value that indicates whether Serialize() is called on send and DeserializeMessageBody is called on receive. The default setting for this property is true. Override to false with caution.

Methods

	Name	Description
	AddCertificateToMessage(MessageCertificateX509, CertificatePurposes)	Adds a certificate to the message.
	AddCertificateToMessage(MessageCertificateX509, CertificatePurposes, Boolean)	Adds a certificate to a message with the option to disable any intelligence.
	CloneBase()	Creates a clone of a message. Important: This method is not the same as nor does it behave the same as Clone. That is why this message type does not implement ICloneable. It is not recommended that any code outside of Messaging core code use this function without understanding how it works, what its limitations are, and why it's being used. Note: If you're considering this method, ensure that you have evaluated CloneByRef which you might want to use instead.
	CloneByRef(IMessage)	Clones a reference of a message. Use this method to create a copy of an existing message, especially one of a different type, into this message. Important: This method is not the same as nor does it behave the same as Clone. That is why this message type does not implement ICloneable. It is not recommended that any code outside of Messaging core code use this function without understanding how it works, what its limitations are, and why it's being used.
	CloneByRef(IMessage, MessageCloneOptions)	Clones a reference of a message. Use this method to create a copy of an existing message, especially one of a different type, into this message. Important: This method is not the same as nor does it behave the same as Clone. That is why this message type does not implement ICloneable. It is not recommended that any code outside of Messaging core code use this function without understanding how it works, what its limitations are, and why it's being used.
	CriticalSection(Action)	Invokes a statement within a thread-safe critical section.
	CriticalSection<T>(Func<T>)	Invokes a statement within a thread-safe critical section.
	DeserializeMessageBody()	Internal handler for deserializing a payload into its object format. This method should only be called by external code under exceptional circumstances.
	Discover()	Performs discovery, if supported by the message.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetCertificateFromMessage(CertificatePurposes)	Retrieves the X509-based certificate from a message.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	OnDeserialization(Object)	Ensures validity checks are never performed on deserialization.
	PostSendActions(IMessageSender, Boolean)	Actions that run after a message is sent. This is an asynchronous action; use with caution.
	PreSendActions()	Actions that run before the message is sent. This operation is synchronous and blocking.
	SendInlineStatusMessage(SmsEvent, IMessageSender)	Sends a status message. This is a synchronous operation and should be called from a separate thread to avoid blocking.
	SendInlineStatusMessage(StatusMessage, IMessageSender)	Sends a status message. This is a synchronous operation and should be called from a separate thread to avoid blocking.
	SendMessageAsync(IMessageSender)	Sends a message by using the specified sender.
	SendMessageSync<T>(IMessageSender)	Sends a message by using the specified sender.
	SerializeMessageBody()	Internal handler for serializing the message payload to its wire-level format. This method should only be called by external code under exceptional circumstances.
	SimpleBodyDeserialization<T>()	Helper function that deserializes an object from the existing payload.
	SimpleBodyDeserialization<T>(DeserializationArguments)	Helper function that deserializes an object from the existing payload.
	SimpleObjectSerialization(Object)	Helper function that serializes an object to a payload.
	ToString()	(Inherited from Object.)
	Validate()	Obsolete. Validates that all required message settings are present and meet the requirements. If this method fails, the message will likely fail in being sent or processed by the site or management point.
	Validate(IMessageSender)	Validates that all required message settings are present and meet the requirements. If this validation fails, the message is almost certain to fail in being sent or processed by the site or management point.