AP&C API Reference
Public Member Functions | Properties | List of all members
Apac.Configuration.MessageConfigElement Class Reference

This configuration class provides a one-to-many mapping between message types and protocols use to send messages of those types. This allows, for example, a SystemStatus message to be sent via email and IM simply by changing the configuration on the server hosting the message controller. More...

Inheritance diagram for Apac.Configuration.MessageConfigElement:

Public Member Functions

System.Xml.Schema.XmlSchema GetSchema ()
 
void ReadXml (System.Xml.XmlReader reader)
 Deserializes the object from XML. More...
 
void WriteXml (System.Xml.XmlWriter writer)
 Serializes the object to XML. More...
 

Properties

override ConfigurationPropertyCollection Properties [get]
 Gets the collection of configuration properties for this configuration element. More...
 
string MessageType [get, set]
 Gets or sets the type of message to which the entries in ProtocolRefConfigElements apply. More...
 
Messaging.MessageType MessageTypeValue [get]
 A convenience property for getting the MessageType as a valid Apac.Messaging.MessageType enum value. More...
 
ProtocolRefConfigElements ProtocolRefs [get, set]
 Gets or sets the name of the protocol configuration to use for delivering message with the type specified by MessageType. More...
 

Detailed Description

This configuration class provides a one-to-many mapping between message types and protocols use to send messages of those types. This allows, for example, a SystemStatus message to be sent via email and IM simply by changing the configuration on the server hosting the message controller.

Member Function Documentation

◆ ReadXml()

void Apac.Configuration.MessageConfigElement.ReadXml ( System.Xml.XmlReader  reader)
inline

Deserializes the object from XML.

Parameters
readerThe object from which the data is read.

◆ WriteXml()

void Apac.Configuration.MessageConfigElement.WriteXml ( System.Xml.XmlWriter  writer)
inline

Serializes the object to XML.

Parameters
writerThe object to which the data is written.

Property Documentation

◆ MessageType

string Apac.Configuration.MessageConfigElement.MessageType
getset

Gets or sets the type of message to which the entries in ProtocolRefConfigElements apply.

◆ MessageTypeValue

Messaging.MessageType Apac.Configuration.MessageConfigElement.MessageTypeValue
get

A convenience property for getting the MessageType as a valid Apac.Messaging.MessageType enum value.

◆ Properties

override ConfigurationPropertyCollection Apac.Configuration.MessageConfigElement.Properties
getprotected

Gets the collection of configuration properties for this configuration element.

◆ ProtocolRefs

ProtocolRefConfigElements Apac.Configuration.MessageConfigElement.ProtocolRefs
getset

Gets or sets the name of the protocol configuration to use for delivering message with the type specified by MessageType.


The documentation for this class was generated from the following file: