ConfigMgrStatusMessage Class

  • [アーティクル]

 

Sends a status message to the management point.

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

Inheritance Hierarchy

System.Object
  Microsoft.ConfigurationManagement.Messaging.Framework.Message
    Microsoft.ConfigurationManagement.Messaging.Framework.AsynchronousMessage
      Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrStatusMessage

Syntax

[SerializableAttribute]
[MessageSupportAttribute(MessageSupportStatus.Supported)]
[MessageClassAttribute(MessageClassAttributeSetting.SigningRequired)]
public sealed class ConfigMgrStatusMessage : AsynchronousMessage

[SerializableAttribute]
[MessageSupportAttribute(MessageSupportStatus::Supported)]
[MessageClassAttribute(MessageClassAttributeSetting::SigningRequired)]
public ref class ConfigMgrStatusMessage sealed : AsynchronousMessage

<SerializableAttribute>
<MessageSupportAttribute(MessageSupportStatus.Supported)>
<MessageClassAttribute(MessageClassAttributeSetting.SigningRequired)>
Public NotInheritable Class ConfigMgrStatusMessage
    Inherits AsynchronousMessage

Constructors

Name Description
System_CAPS_pubmethod ConfigMgrStatusMessage()

Initializes a new instance of the ConfigMgrStatusMessage class.

Properties

Name Description
System_CAPS_pubproperty Attachments

Gets message attachments. (Inherited from Message.)
System_CAPS_pubproperty Body

Gets the message body. This property should not be empty, with limited exceptions.(Inherited from Message.)
System_CAPS_pubproperty InitializeOnParse

Gets or sets a value indicating whether this class re-initializes the in-memory status message every time a parse is done. If false, you must manually Initialize() or the internal status message will be appended. The default value is false.
System_CAPS_pubproperty MessageId

Gets the internal ID of a message. (Inherited from Message.)
System_CAPS_pubproperty 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.)
System_CAPS_pubproperty 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.)
System_CAPS_pubproperty 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.)
System_CAPS_pubproperty Settings

Gets message settings. (Inherited from Message.)
System_CAPS_pubproperty SiteCode

Gets or sets the site code to use for sending a message. Some messages require this property. (Inherited from Message.)
System_CAPS_pubproperty SmsId

SMSID for the status request. (Overrides Message.SmsId.)
System_CAPS_pubproperty StatusMessage

Gets or sets the status message sent to the management point. To set this from a CcmEvent derived type, use the ParseStatusMessage method.
System_CAPS_protproperty 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
System_CAPS_pubmethod AddCertificateToMessage(MessageCertificateX509, CertificatePurposes)

Adds a certificate to the message. (Inherited from Message.)
System_CAPS_pubmethod AddCertificateToMessage(MessageCertificateX509, CertificatePurposes, Boolean)

Adds a certificate to a message with the option to disable any intelligence. (Inherited from Message.)
System_CAPS_pubmethod 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.)
System_CAPS_pubmethod 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.)
System_CAPS_pubmethod 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.)
System_CAPS_pubmethod 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.)
System_CAPS_pubmethod Discover()

Performs discovery, if supported by the message. (Inherited from Message.)
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)
System_CAPS_pubmethod GetCertificateFromMessage(CertificatePurposes)

Retrieves the X509-based certificate from a message. (Inherited from Message.)
System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)
System_CAPS_pubmethod GetType()

(Inherited from Object.)
System_CAPS_pubmethod Initialize()

Initializes the status message stored in memory for the instance of this class. If there is an existing status message in memory, it will not be overwritten unless you use this method or set InitializeOnParse to true.
System_CAPS_pubmethod OnDeserialization(Object)

Ensures validity checks are never performed on deserialization. (Inherited from Message.)
System_CAPS_pubmethod ParseStatusMessage(CcmEvent)

Builds the status properties and qualifiers for the message from a status message object. If you have already run ParseStatusMessage, running this method again will not delete the status memory stored in memory for this instance of this class. If this is not the action you want, you can Initialize() before ParseStatusMessage(...), or set InitializeOnParse to true.
System_CAPS_pubmethod PostSendActions(IMessageSender, Boolean)

Actions that run after a message is sent. This is an asynchronous action; use with caution. (Inherited from Message.)
System_CAPS_pubmethod PreSendActions()

Runs actions before the message is sent. This method is synchronous and blocking. (Overrides Message.PreSendActions().)
System_CAPS_pubmethod SendMessage(IMessageSender)

Sends the message using the specified sender.(Inherited from AsynchronousMessage.)
System_CAPS_pubmethod SerializeMessageBody()

Serializes the payload. (Overrides Message.SerializeMessageBody().)
System_CAPS_protmethod SimpleBodyDeserialization<T>()

Helper function that deserializes an object from the existing payload. (Inherited from Message.)
System_CAPS_protmethod SimpleBodyDeserialization<T>(DeserializationArguments)

Helper function that deserializes an object from the existing payload. (Inherited from Message.)
System_CAPS_protmethod SimpleObjectSerialization(Object)

Helper function that serializes an object to a payload. (Inherited from Message.)
System_CAPS_pubmethod ToString()

(Inherited from Object.)
System_CAPS_pubmethod 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.)
System_CAPS_pubmethod 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
System_CAPS_pubinterfaceSystem_CAPS_privmethod IMessage.SendMessage(IMessageSender)

Sends a message by using the specified sender. (Inherited from Message.)
System_CAPS_pubinterfaceSystem_CAPS_privproperty IMessageBase.Settings

Gets message properties and settings. (Inherited from Message.)

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.

See Also

Microsoft.ConfigurationManagement.Messaging.Messages Namespace

Return to top