IMessage Interface
The base interface for any message sent to a management point.
Namespace: Microsoft.ConfigurationManagement.Messaging.Framework
Assembly: Microsoft.ConfigurationManagement.Messaging (in Microsoft.ConfigurationManagement.Messaging.dll)
Syntax
public interface IMessage : IMessageBase
public interface class IMessage : IMessageBase
Public Interface IMessage
Inherits IMessageBase
Properties
Name | Description | |
---|---|---|
Attachments | Gets message attachments. |
|
Body | Gets message settings and properties. |
|
MessageId | Gets the internal ID of the message. |
|
Priority | Gets the priority for the message. This property is only used for reference by senders and has no effect on the message. |
|
SenderType | Gets the sender type and property. This property is only used by senders and has no effect on the message. |
|
Settings | Gets message settings. |
|
SiteCode | Gets or sets the site code. Some messages require this property. |
|
SmsId | Gets or sets the SMSID for the message. This value can be empty. |
Methods
Name | Description | |
---|---|---|
AddCertificateToMessage(MessageCertificateX509, CertificatePurposes) | Adds a certificate to the message. |
|
CloneBase() | 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. |
|
DeserializeMessageBody() | Internal handler for deserializing a payload into its object format. |
|
Discover() | Automatically discovers local information for sending a message. (Inherited from IMessageBase.) |
|
GetCertificateFromMessage(CertificatePurposes) | Retrieves the X509-based certificate from a message. Do not pass in this function as a Flag, because there's no guarantee what value will be returned. |
|
SendMessage(IMessageSender) | Sends a message by using the specified sender. |
|
SerializeMessageBody() | Internal handler used to serialize the message payload into its wire-level format. |
|
Validate() | Validates that all required properties are set for the message to be sent successfully. (Inherited from IMessageBase.) |
See Also
Microsoft.ConfigurationManagement.Messaging.Framework Namespace
Return to top