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)

public interface class IMessage : IMessageBase

NameDescription
System_CAPS_pubpropertyAttachments

Gets message attachments.

System_CAPS_pubpropertyBody

Gets message settings and properties.

System_CAPS_pubpropertyMessageId

Gets the internal ID of the message.

System_CAPS_pubpropertyPriority

Gets the priority for the message. This property is only used for reference by senders and has no effect on the message.

System_CAPS_pubpropertySenderType

Gets the sender type and property. This property is only used by senders and has no effect on the message.

System_CAPS_pubpropertySettings

Gets message settings.

System_CAPS_pubpropertySiteCode

Gets or sets the site code. Some messages require this property.

System_CAPS_pubpropertySmsId

Gets or sets the SMSID for the message. This value can be empty.

NameDescription
System_CAPS_pubmethodAddCertificateToMessage(MessageCertificateX509^, CertificatePurposes)

Adds a certificate to the message.

System_CAPS_pubmethodCloneBase()

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.

System_CAPS_pubmethodDeserializeMessageBody()

Internal handler for deserializing a payload into its object format.

System_CAPS_pubmethodDiscover()

Automatically discovers local information for sending a message. (Inherited from IMessageBase.)

System_CAPS_pubmethodGetCertificateFromMessage(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.

System_CAPS_pubmethodSendMessage(IMessageSender^)

Sends a message by using the specified sender.

System_CAPS_pubmethodSerializeMessageBody()

Internal handler used to serialize the message payload into its wire-level format.

System_CAPS_pubmethodValidate()

Validates that all required properties are set for the message to be sent successfully. (Inherited from IMessageBase.)

Return to top
Show: