Microsoft.ConfigurationManagement.Messaging.Framework Namespace

 

Classes

Class Description
System_CAPS_pubclass ActiveDirectoryHelpers

Provides properties to help you work with Windows Server Active Directory.

System_CAPS_pubclass AdhocMessage

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

System_CAPS_pubclass AggregateMessageException

Aggregated exception for a message.

System_CAPS_pubclass AsynchronousMessage

An abstract class that represents an asynchronous message. This class should be implemented by any asynchronous message type because no reply is expected from the management point.

System_CAPS_pubclass BitsFileTransferEventArgs

Provides Background Intelligent Transfer Service (BITS) file transfer event arguments.

System_CAPS_pubclass BitsHelper

Provides methods to help you work with the Background Intelligent Transfer Service (BITS).

System_CAPS_pubclass BitsJob

Provides a wrapper for Background Intelligent Transfer Service (BITS) jobs.

System_CAPS_pubclass BitsJobErrorEventArgs

Provides Background Intelligent Transfer Service (BITS) job transfer error arguments.

System_CAPS_pubclass BitsJobEventArgs

Provides Background Intelligent Transfer Service (BITS) job event arguments.

System_CAPS_pubclass BitsJobTransferEventArgs

Provides Background Intelligent Transfer Service (BITS) job transfer arguments.

System_CAPS_pubclass BitsUploadReply

Represents an UploadReply message from a management point. This message contains URL information about where and how to upload content to a management point by using the Background Intelligent Transfer Service (BITS).

System_CAPS_pubclass CDataHelper

A serialization class used to encapsulate CDATA into XML blobs.

System_CAPS_pubclass ClientReplyEndpointAttribute

Describes the client reply message endpoint.

System_CAPS_pubclass ClientVersion

Provides an ad hoc client version.

System_CAPS_pubclass ClientVersionBase

Represents a well-formed client version.

System_CAPS_pubclass ClientVersionV5

The client version for System Center 2012 Configuration Manager.

System_CAPS_pubclass ClientVersionV5R2

The client version for System Center 2012 R2 Configuration Manager.

System_CAPS_pubclass ClientVersionV5SP1

The client version for System Center 2012 Configuration Manager SP1.

System_CAPS_pubclass CompressedData

A public helper class that returns compressed data results.

System_CAPS_pubclass CompressedData<TCompressor>

Provides a generic representation of compressed data.

System_CAPS_pubclass Compression

An abstract class that defines data compression parameters.

System_CAPS_pubclass Compression<TCompressor>

Provides a generic compression wrapper.

System_CAPS_pubclass ConfigMgrCapabilities

Contains a list of Configuration Manager capabilities.

System_CAPS_pubclass ConfigMgrCapabilityProperty

Provides blobs that are used for instructing the client of the management point's capabilities. For example, SSL.

System_CAPS_pubclass ConvertibleVarFile<T>

Represents a VarFile type that can be converted from an existing IMessage type.

System_CAPS_pubclass DebugHelpers

Provides helper methods to use when debugging.

System_CAPS_pubclass FileSender

Sends a message to an output file.

System_CAPS_pubclass HexDumper

Provides utility methods for performing hex dumps of binary data.

System_CAPS_pubclass Message

Core message class. In general, this class should not be sub-classed directly. AsynchronousMessage should be used for one-way (no reply) messages (such as DDR or status) and SynchronousMessageRequest with SynchronousMessageReply should be used for two-way, synchronous, messages (such as policy or location).

System_CAPS_pubclass MessageAttachment

File attachments for messages.

System_CAPS_pubclass MessageBody

The message body.

System_CAPS_pubclass MessageBodyXmlRootTypeAttribute

Defines a message body XML root type for message conversion and removing duplication.

System_CAPS_pubclass MessageCertificate

Base class for a certificate used by or for a message.

System_CAPS_pubclass MessageCertificateX509

Base class that encapsulates X509 certificates for messages.

System_CAPS_pubclass MessageCertificateX509File

Represents a certificate file stored in the certificate store.

System_CAPS_pubclass MessageCertificateX509Volatile

A certificate that is in memory or not in the certificate store, including a handle to an existing certificate.

System_CAPS_pubclass MessageClassAttribute

Class-wide attribute for a message.

System_CAPS_pubclass MessageConstants

Constants used for Configuration Manager messages.

System_CAPS_pubclass MessageEndpointAttribute

Defines the endpoint for the message.

System_CAPS_pubclass MessageException

Base class for a message exception.

System_CAPS_pubclass MessageFile<T>

Generic file writer for an IMessage type.

System_CAPS_pubclass MessageFileBase

Base class used to write a message to a file.

System_CAPS_pubclass MessageFileSettings

Represents message file settings.

System_CAPS_pubclass MessageInvalidPropertySettingException

Used when a property that should be set has a value that is outside of the expected range. This class should not be called in user code.

System_CAPS_pubclass MessageMissingPropertyException

Used when a property that should be set is null or empty. This class should not be called in user code.

System_CAPS_pubclass MessageProperty

Represents a generic key/value pair.

System_CAPS_pubclass MessagePropertyAttribute

Defines message property requirements and settings.

System_CAPS_pubclass MessagePropertyDictionary

A collection of message properties. Message properties, which are different than sender properties, are special settings that are appended to the message by the sender.

System_CAPS_pubclass MessagePropertyException

Used when a property that should be set is null or empty. This class should not be called in user code.

System_CAPS_pubclass MessageReplyEndpointAttribute

Defines the reply endpoint for the message.

System_CAPS_pubclass MessageSecurityModeHelper

Utility class that helps convert security modes to schemes.

System_CAPS_pubclass MessageSenderEventArgs

Event handler used to fire message delivery and reception events.

System_CAPS_pubclass MessageSenderSettingsAttribute

Attributes used to configure senders.

System_CAPS_pubclass MessageSerializationAttribute

Sets special serialization flags for a specific class.

System_CAPS_pubclass MessageSettings

Contains settings shared by all message types for sending a message to a management point. Not all properties are recognized by all senders.

System_CAPS_pubclass MessageSettingsSecurity

Provides message security flags.

System_CAPS_pubclass MessageSignatureVerificationException

Exception that is raised when signature verification fails.

System_CAPS_pubclass MessageSigningRequiredException

Exception used when a message requires signing but is not signed.

System_CAPS_pubclass MessageSupportAttribute

Defines the supportability status of a message. All messages should define this property to let callers know what level of support is offered for the message.

System_CAPS_pubclass MessageValidationException

Special exception class for handling rolled-up exceptions from message validation.

System_CAPS_pubclass MessagingTrace

Special wrapper for System.Diagnostics.Trace. Use this class instead of System.Diagnostics.Trace. This class can be overridden with an app.config file to set the trace level.

System_CAPS_pubclass MimeBlob

Builds a MimeBlob from a blob of data.

System_CAPS_pubclass MimeHelpers

Provides helper methods used for splitting out various parts of a MIME reply.

System_CAPS_pubclass SenderConfigurationProperties

Collection of sender properties.

System_CAPS_pubclass SenderConfigurationProperty

Configuration property specific to a sender.

System_CAPS_pubclass SenderConfigurationPropertyDictionary

Dictionary of sender properties.

System_CAPS_pubclass SenderException

A custom exception used to indicate issues when sending a message.

System_CAPS_pubclass SenderHelpers

Helper class for use by senders.

System_CAPS_pubclass SerializationHelpers

Class that handles serializing and deserializing objects.

System_CAPS_pubclass SmsCertificateBlobHelpers

Provides helper methods to handle serializing and deserializing the special SMS certificate blob format.

System_CAPS_pubclass SmsClientId

Class used for constructing an SMSID.

System_CAPS_pubclass SupportedSenderAttribute

An attribute that notes which senders can send the message. Not all senders can send all messages. If this attribute is empty, or not defined, it is equivalent to all senders. This attribute is only valid as a class decoration.

You can define multiple SupportedSenderAttributes for a class.

System_CAPS_pubclass SynchronousMessageReply

Abstract class that encapsulates a synchronous message reply.

System_CAPS_pubclass SynchronousMessageRequest

Abstract class that represents a synchronous message request.

System_CAPS_pubclass SynchronousMessageRequest<TSynchronousReply>

Abstract class that represents a synchronous message request.

System_CAPS_pubclass SystemInformation

Gets information from the local computer.

System_CAPS_pubclass TextHelpers

Provides helper methods for text functions.

System_CAPS_pubclass TimeHelpers

Provides methods to help you work with time. Configuration Manager uses several different types of time internally. This class encapsulates many of them.

Supported time formats include: ISO 8601, CIM time (also called SMS time in the some of the methods and properties in this class), FILETIME, SystemTime, "SMS Cookie" time, and CTime/time_t/UNIX time. Conversion to and from these formats is supported in most cases.

System_CAPS_pubclass UserHelpers

Provides helpers for getting user information.

System_CAPS_pubclass VarFile

Base class for a VarFile writer.

System_CAPS_pubclass ZlibCompression

Handles compression with zlib. This is not a general-purpose zlib compression wrapper; it is only compatible with Configuration Manager messages.

Structures

Structure Description
System_CAPS_pubstructure SystemTime

Implementation of the native SYSTEMTIME structure.

Interfaces

Interface Description
System_CAPS_pubinterface IMessage

The base interface for any message sent to a management point.

System_CAPS_pubinterface IMessageBase

The minimum requirements for any message.

System_CAPS_pubinterface IMessageException

The base interface for a message exception.

System_CAPS_pubinterface IMessageSender

Interface to use for sending and receiving messages.

System_CAPS_pubinterface IMessageSerialization

Provides special dynamic serialization arguments. This class should only be used when MessageSerializationAttribute is not adequate.

Use of this interface supersedes any usage of MessageSerializationAttribute.

System_CAPS_pubinterface IMessageSerializedSection

Interface used to show that the class is part of a serialized message payload fragment.

System_CAPS_pubinterface IMessageSettings

Interface used to configure message settings.

Enumerations

Enumeration Description
System_CAPS_pubenum AuthenticationScheme

Specifies protocols used for authentication.

System_CAPS_pubenum AuthenticationType

Specifies the type of authentication used for the message.

System_CAPS_pubenum CcmHttpSslStates

Specifies the Secure Sockets Layer (SSL) state bitmask for client communications.

System_CAPS_pubenum CertificatePurposes

Specifies the purpose for a certificate.

System_CAPS_pubenum CompressionLevel

Specifies the compression level.

System_CAPS_pubenum DeserializationArguments

Flags that specify actions that can be taken when deserializing XML.

System_CAPS_pubenum MessageCertificateSigningOptions

Defines signing options.

System_CAPS_pubenum MessageClassAttributeSetting

Flags for the MessageClassAttribute.

System_CAPS_pubenum MessageCloneOptions

Special flags for message cloning.

System_CAPS_pubenum MessageCompression

Public enumeration of compression libraries.

System_CAPS_pubenum MessagePropertyImportance

Defines the importance of the message property. This importance value is considered when Validate is called.

System_CAPS_pubenum MessageSecurityMode

Supported security modes.

System_CAPS_pubenum MessageSenderType

The type of message that is sent. The message type is used only for reference by senders and has no effect on the message itself.

System_CAPS_pubenum MessageSerializationParameters

Flags for the MessageSerializationAttribute class.

System_CAPS_pubenum MessageSourceType

Message source type.

System_CAPS_pubenum MessageSupportStatus

Support status for a message. Used with the MessageSupportAttribute attribute.

System_CAPS_pubenum MimeType

Enumeration of MIME types used for MIME blob processing.

System_CAPS_pubenum SerializationArguments

Flags that specify actions to take when serializing XML.

System_CAPS_pubenum ServerRoleType

Server role type.

System_CAPS_pubenum SmsTimeZone

Specifies how to handle time zone generation for an SMS Time.

Return to top