AdhocMessage Class

Article
12/30/2016

Provides a wrapper for sending an ad hoc message. This class should only be used for development and testing of new messages.

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

Syntax

[SerializableAttribute]
[MessageSupportAttribute(MessageSupportStatus.Unsupported, "This message type is only for testing or development purposes. Any permanent messages should implement AsynchronousMessage or SynchronousMessageRequest/Reply patterns instead.")]
[MessageClassAttribute(MessageClassAttributeSetting.None)]
public sealed class AdhocMessage : Message

[SerializableAttribute]
[MessageSupportAttribute(MessageSupportStatus::Unsupported, "This message type is only for testing or development purposes. Any permanent messages should implement AsynchronousMessage or SynchronousMessageRequest/Reply patterns instead.")]
[MessageClassAttribute(MessageClassAttributeSetting::None)]
public ref class AdhocMessage sealed : Message

<SerializableAttribute>
<MessageSupportAttribute(MessageSupportStatus.Unsupported, "This message type is only for testing or development purposes. Any permanent messages should implement AsynchronousMessage or SynchronousMessageRequest/Reply patterns instead.")>
<MessageClassAttribute(MessageClassAttributeSetting.None)>
Public NotInheritable Class AdhocMessage
    Inherits Message

Constructors

	Name	Description
	AdhocMessage()	Initializes a new instance of the AdhocMessage class.

Properties

	Name	Description
	Attachments	Gets message attachments. (Inherited from Message.)
	Body	Gets the message body. This property should not be empty, with limited exceptions.(Inherited from Message.)
	MessageId	Gets the internal ID of a message. (Inherited from Message.)
	Priority	Gets the priority for a message. This property is only used for reference by senders and has no effect on the message. (Inherited from Message.)
	SenderCallback	Gets a sender callback for a message. This property is null unless a message is in the process of being sent. (Inherited from Message.)
	SenderType	Gets the sender type for a message. This property is only used for reference by senders and has no effect on the message. (Inherited from Message.)
	Settings	Gets message settings. (Inherited from Message.)
	SiteCode	Gets or sets the site code to use for sending a message. Some messages require this property. (Inherited from Message.)
	SmsId	Gets or sets the SMSID to use for signing and sending a message. (Inherited from 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. (Inherited from Message.)

Methods

	Name	Description
	AddCertificateToMessage(MessageCertificateX509, CertificatePurposes)	Adds a certificate to the message. (Inherited from Message.)
	AddCertificateToMessage(MessageCertificateX509, CertificatePurposes, Boolean)	Adds a certificate to a message with the option to disable any intelligence. (Inherited from Message.)
	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. (Inherited from Message.)
	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. (Inherited from Message.)
	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. (Inherited from Message.)
	DeserializeMessageBody()	Internal handler for deserializing a payload into its object format. This method should only be called by external code under exceptional circumstances. (Inherited from Message.)
	Discover()	Performs discovery, if supported by the message. (Inherited from Message.)
	Equals(Object)	(Inherited from Object.)
	GetCertificateFromMessage(CertificatePurposes)	Retrieves the X509-based certificate from a message. (Inherited from Message.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	OnDeserialization(Object)	Ensures validity checks are never performed on deserialization. (Inherited from Message.)
	PostSendActions(IMessageSender, Boolean)	Actions that run after a message is sent. This is an asynchronous action; use with caution. (Inherited from Message.)
	PreSendActions()	Actions that run before the message is sent. This operation is synchronous and blocking. (Inherited from Message.)
	SendMessage(IMessageSender)	Sends a message. Ensure that you set the SetSenderType method before using this method.
	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. (Inherited from Message.)
	SetIsapiPath(String)	Sets the management point ISAPI. To reset to the default value, pass in null or string.Empty as an argument.
	SetMessageVerb(String)	Sets the verb for a message. To reset to the default value, pass in null or string.Empty as an argument.
	SetSenderType(MessageSenderType)	Sets the sender type for a message.
	SimpleBodyDeserialization<T>()	Helper function that deserializes an object from the existing payload. (Inherited from Message.)
	SimpleBodyDeserialization<T>(DeserializationArguments)	Helper function that deserializes an object from the existing payload. (Inherited from Message.)
	SimpleObjectSerialization(Object)	Helper function that serializes an object to a payload. (Inherited from Message.)
	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. (Inherited from Message.)
	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. (Inherited from Message.)

Explicit Interface Implementations

	Name	Description
	IMessage.SendMessage(IMessageSender)	Sends a message by using the specified sender. (Inherited from Message.)
	IMessageBase.Settings	Gets message properties and settings. (Inherited from Message.)

Examples

Send an ad hoc message to the management point.

HttpSender sender = new HttpSender();
AdhocMessage message = new AdhocMessage();
message.Settings.HostName = "MyManagementPoint";
message.Body.Payload = "Lorem ipsum dolor sit amet";
message.SendMessage(sender);

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.

Share via