[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Core message class. In general this should not be sub-classed directly. AsynchronousMessageshould be used for one-way (no reply) messages (such as DDR, status) and SynchronousMessageRequestwith SynchronousMessageReplyshould be used for two-way "synchronous" messages (policy, location).

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

Syntax


	C#			Visual Basic			Visual C++

[
SerializableAttribute]
[

MessageSupportAttribute(

MessageSupportStatus.Unknown)]
public 
abstract 
class 
Message : 
IMessage, 
	

IMessageBase, 
IDeserializationCallback

<
SerializableAttribute> _
<

MessageSupportAttribute(

MessageSupportStatus.Unknown)> _
Public 
MustInherit 
Class 
Message _
	
Implements 
IMessage, 

IMessageBase, 
IDeserializationCallback

[
SerializableAttribute]
[

MessageSupportAttribute(

MessageSupportStatus::Unknown)]
public 
ref class 
Message 
abstract : 
IMessage, 
	

IMessageBase, 
IDeserializationCallback

Members

All Members

Fields

Properties Public property

Methods

Explicit Interface Implementations Explicit interface implemetation

 Public

 Protected

 Instance

 Static 

 Declared

 Inherited

 XNA Framework Only 

 .NET Compact Framework
Only

	Member	Description
	AddCertificateToMessage(MessageCertificateX509, CertificatePurposes)	Adds a certificate to the message
	AddCertificateToMessage(MessageCertificateX509, CertificatePurposes, Boolean)	Adds certificate to message with the option to disable any intelligence
	Attachments	Gets Attachments to the message.
	Body	Get/Set message body. This should never be empty except for some very special cases.
	CloneBase () () () ()	Creates a clone of this message IMPORTANT: This is not the same as Clone () () () () which is why this message type does not implement ICloneable. This does not behave the same as Clone () () () () . 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. Chances are if you're looking at this method, you probably want to use CloneByRef(IMessage)instead.
	CloneByRef(IMessage)	Clones a reference of a message. Use this for doing a copy of an existing message (especially of a different type) into this one. IMPORTANT: This is not the same as Clone () () () () which is why this message type does not implement ICloneable. This does not behave the same as Clone () () () () . 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 for doing a copy of an existing message (especially of a different type) into this one. IMPORTANT: This is not the same as Clone () () () () which is why this message type does not implement ICloneable. This does not behave the same as Clone () () () () . 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 < (Of < <' ( T > ) > > ) (Func < (Of < ( <' TResult > ) > ) > )
	DeserializeMessageBody () () () ()	Internal handler for deserializing payload to its object format. This 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 X509-based certificate from message.
	GetHashCode () () () ()	(Inherited from Object.)
	GetType () () () ()	(Inherited from Object.)
	MemberwiseClone () () () ()	(Inherited from Object.)
	MessageId	Internal ID of the message.
	OnDeserialization(Object)	On deserialization, this ensures validity checks are never performed.
	PostSendActions(IMessageSender, Boolean)	Actions to run after the message is sent (asynchronous, use with care).
	PostSendActionsSupported	If true, message supports post-send actions
	PreSendActions () () () ()	Actions to run before the message is sent (synchronous and blocking)
	Priority	The priority for the message. This is only used for reference by senders and has no actual effect on the message
	SenderCallback	Callback to Sender for the message. This is null unless a message is in the process of being sent.
	SenderType	The sender type for the message. This is only used for reference by senders and has no actual effect on the message.
	SendInlineStatusMessage(SmsEvent, IMessageSender)	Sends a status message. This is a synchronous operation so it should be called from a separate thread to avoid blocking
	SendInlineStatusMessage(StatusMessage, IMessageSender)	Sends a status message. This is a synchronous operation so it should be called from a separate thread to avoid blocking
	IMessage . . :: . . SendMessage(IMessageSender)	Sends message via the specified sender.
	SendMessageAsync(IMessageSender)	Sends message via the specified sender.
	SendMessageSync < (Of < <' ( T > ) > > ) (IMessageSender)	Sends message via the specified sender.
	SerializeMessageBody () () () ()	Internal handler for serializing the message payload to its wire-level format. This should only be called by external code under exceptional circumstances.
	IMessageBase . . :: . . Settings	Message settings and properties
	Settings	Message settings
	SimpleBodyDeserialization < (Of < <' ( T > ) > > ) () () () ()	Helper function that deserializes the object from the existing payload
	SimpleBodyDeserialization < (Of < <' ( T > ) > > ) (DeserializationArguments)	Helper function that deserializes the object from the existing payload
	SimpleObjectSerialization(Object)	Helper function that serializes the object to a payload
	SiteCode	Gets/sets the site code to use for sending the message. Some messages require this.
	SmsId	Get/Set the SMSID to use for sending and signing the message.
	SupportsInlineSerializers	If true, Serialize() will be called on send, and Deserialize() will be called on receive. Default setting is true. Override to false with care.
	Synchronizer	Synchronizer to use for locking in thread-safe operations
	ToString () () () ()	(Inherited from Object.)
	Validate () () () ()	Validates all required message settings are present and meet the requirements. If this fails, it means that the message is almost certain to fail sending or being processed by the site/MP.

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

Members

Inheritance Hierarchy

See Also