[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Inventory message base class

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

Syntax

                 
  C#     Visual Basic     Visual C++   
[
SerializableAttribute]
public 
abstract 
class 
ConfigMgrInventoryMessage : 

AsynchronousMessage

<
SerializableAttribute> _
Public 
MustInherit 
Class 
ConfigMgrInventoryMessage _
	
Inherits 

AsynchronousMessage

[
SerializableAttribute]
public 
ref class 
ConfigMgrInventoryMessage 
abstract : 
public 

AsynchronousMessage

Members

                             
  All Members     Fields      Properties      Methods      Explicit Interface Implementations   
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

  Member Description
AddCertificateToMessage(MessageCertificateX509, CertificatePurposes)
Adds a certificate to the message
(Inherited from Message.)
AddCertificateToMessage(MessageCertificateX509, CertificatePurposes, Boolean)
Adds certificate to message with the option to disable any intelligence
(Inherited from Message.)
Attachments
Gets Attachments to the message.
(Inherited from Message.)
Body
Get/Set message body. This should never be empty except for some very special cases.
(Inherited from Message.)
BodyAsAttachment
If true, the ReportBody is sent as an attachment, if false, the entire message is sent as one.

Inventory messages need to be sent with attachments, relay messages don't.
BuildInventoryMessage(InventoryReportBodyElement)
Constructs an inventory report from a InventoryReportBodyElement using default settings
BuildInventoryMessage(Collection < (Of < <' ( InventoryReportBodyElement > ) > > ) )
Constructs an inventory report from an InventoryReportBodyElement[] array
BuildInventoryMessage(InventoryReportBodyElement, Boolean)
Constructs an inventory report from a InventoryReportBodyElement using default settings
BuildInventoryMessage(Collection < (Of < <' ( InventoryReportBodyElement > ) > > ) , Boolean)
Constructs an inventory report from an InventoryReportBodyElement[] array
ClientVersion
Client version for the client sending the state message. Defaults to random version if unset.
CloneBase () () () ()
Creates a clone of this message

IMPORTANT: This is not the same as Clone () () () () which is why this message type does not implement ICloneable. This does not behave the same as Clone () () () () . 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. Chances are if you're looking at this method, you probably want to use CloneByRef(IMessage)instead.

(Inherited from Message.)
CloneByRef(IMessage)
Clones a reference of a message. Use this for doing a copy of an existing message (especially of a different type) into this one.

IMPORTANT: This is not the same as Clone () () () () which is why this message type does not implement ICloneable. This does not behave the same as Clone () () () () . 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 for doing a copy of an existing message (especially of a different type) into this one.

IMPORTANT: This is not the same as Clone () () () () which is why this message type does not implement ICloneable. This does not behave the same as Clone () () () () . 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.)
CodePage
Gets/sets the code page for the message
CriticalSection(Action)
Invokes a statement within a thread-safe critical section
(Inherited from Message.)
CriticalSection < (Of < <' ( T > ) > > ) (Func < (Of < ( <' TResult > ) > ) > ) (Inherited from Message.)
DefaultReportFormat
Default report format for inventory reports
DefaultReportVersion
Default report version for inventory reports
DeserializeMessageBody () () () ()
Internal handler for deserializing payload to its object format. This should only be called by external code under exceptional circumstances.
(Inherited from Message.)
Discover () () () ()
Performs discovery
(Overrides Message . . :: . . Discover () () () () .)
DiscoveredNetBiosName
If true, NetBiosName property was derived from discovery
Equals(Object) (Inherited from Object.)
Finalize () () () () (Inherited from Object.)
GetCertificateFromMessage(CertificatePurposes)
Retrieves X509-based certificate from message.
(Inherited from Message.)
GetHashCode () () () () (Inherited from Object.)
GetType () () () () (Inherited from Object.)
IncludeMachinePublicKey
If true, and BuildInventoryMessage is used, public key will be included in inventory report
InstancesContainsElementOfType(Boolean, List < (Of < <' ( Type > ) > > ) )
InventoryReport
Contains the entire serialized Inventory message. BuildInventoryMessage should be used to initialize, setting everything manually is not recommended.
LocaleId
Locale ID for state messages. Defaults to the current processe's locale ID
MemberwiseClone () () () () (Inherited from Object.)
MessageId
Internal ID of the message.
(Inherited from Message.)
NetBiosName
Gets/sets the NetBIOS name of the machine generating the state message. If unset, uses the executing machine's name.
OnDeserialization(Object)
On deserialization, this ensures validity checks are never performed.
(Inherited from Message.)
PostSendActions(IMessageSender, Boolean)
Actions to run after the message is sent (asynchronous, use with care).
(Inherited from Message.)
PostSendActionsSupported
If true, message supports post-send actions
(Inherited from Message.)
PreSendActions () () () ()
Actions to run before the message is sent (synchronous and blocking)
(Inherited from Message.)
Priority
The priority for the message. This is only used for reference by senders and has no actual effect on the message
(Inherited from Message.)
ReportContentType
Gets the report content type.
ReportFormat
By default report format is 1.1. Can be overriden by inheriting classes
ReportVersion
By default report version is 1.0. Can be overridden by inheriting classes
SenderCallback
Callback to Sender for the message. This is null unless a message is in the process of being sent.
(Inherited from Message.)
SenderType
The sender type for the message. This is only used for reference by senders and has no actual effect on the message.
(Inherited from Message.)
SendInlineStatusMessage(SmsEvent, IMessageSender)
Sends a status message. This is a synchronous operation so it should be called from a separate thread to avoid blocking
(Inherited from Message.)
SendInlineStatusMessage(StatusMessage, IMessageSender)
Sends a status message. This is a synchronous operation so it should be called from a separate thread to avoid blocking
(Inherited from Message.)
SendMessage(IMessageSender)
Sends the message using the specified sender
(Inherited from AsynchronousMessage.)
IMessage . . :: . . SendMessage(IMessageSender)
Sends message via the specified sender.
(Inherited from Message.)
SendMessageAsync(IMessageSender)
Sends message via the specified sender.
(Inherited from Message.)
SendMessageSync < (Of < <' ( T > ) > > ) (IMessageSender)
Sends message via the specified sender.
(Inherited from Message.)
SerializeMessageBody () () () ()
Serializes the payload
(Overrides Message . . :: . . SerializeMessageBody () () () () .)
IMessageBase . . :: . . Settings
Message settings and properties
(Inherited from Message.)
Settings
Message settings
(Inherited from Message.)
SimpleBodyDeserialization < (Of < <' ( T > ) > > ) () () () ()
Helper function that deserializes the object from the existing payload
(Inherited from Message.)
SimpleBodyDeserialization < (Of < <' ( T > ) > > ) (DeserializationArguments)
Helper function that deserializes the object from the existing payload
(Inherited from Message.)
SimpleObjectSerialization(Object)
Helper function that serializes the object to a payload
(Inherited from Message.)
SiteCode
Gets/sets the site code for the message. This is an optional property
(Overrides Message . . :: . . SiteCode.)
SmsId
SMSID must be set for inventory messages
(Overrides Message . . :: . . SmsId.)
SupportsInlineSerializers
If true, Serialize() will be called on send, and Deserialize() will be called on receive.

Default setting is true. Override to false with care.

(Inherited from Message.)
Synchronizer
Synchronizer to use for locking in thread-safe operations
(Inherited from Message.)
ToString () () () () (Inherited from Object.)
Validate () () () ()
Validates all required message settings are present and meet the requirements. If this fails, it means that the message is almost certain to fail sending or being processed by the site/MP.
(Inherited from Message.)

Inheritance Hierarchy

See Also