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

The main interface for manipulating configuration elements of the standard app.config file. This class provides the abstraction needed to make altering configurations via code as simple as possible. More...

Static Public Member Functions

static SmtpSetup GetSmtpSetup ()
 Gets the currently persisted email setup. More...
 
static void UpdateSmtpSetup (SmtpNetworkElement network)
 Updates the persisted email setup using the supplied SmtpNetworkElement, and activates the change in the running system. More...
 
static void UpdateSmtpSetup (SmtpSetup setup)
 Updates the persisted email setup using the supplied SmtpSetup, and activates the change in the running system. More...
 
static Configuration.MessageControllerConfigSection GetMessagingConfig ()
 Gets the messaging configuration section (see Configuration.MessageControllerConfigSection). More...
 

Detailed Description

The main interface for manipulating configuration elements of the standard app.config file. This class provides the abstraction needed to make altering configurations via code as simple as possible.

Member Function Documentation

◆ GetMessagingConfig()

static Configuration.MessageControllerConfigSection Apac.Configuration.ConfigurationHandler.GetMessagingConfig ( )
inlinestatic

Gets the messaging configuration section (see Configuration.MessageControllerConfigSection).

Returns
Returns the active Configuration.MessageControllerConfigSection.

◆ GetSmtpSetup()

static SmtpSetup Apac.Configuration.ConfigurationHandler.GetSmtpSetup ( )
inlinestatic

Gets the currently persisted email setup.

Returns
Returns the SmtpNetworkElement for the email setup.

◆ UpdateSmtpSetup() [1/2]

static void Apac.Configuration.ConfigurationHandler.UpdateSmtpSetup ( SmtpNetworkElement  network)
inlinestatic

Updates the persisted email setup using the supplied SmtpNetworkElement, and activates the change in the running system.

Parameters
networkThe network settings.

◆ UpdateSmtpSetup() [2/2]

static void Apac.Configuration.ConfigurationHandler.UpdateSmtpSetup ( SmtpSetup  setup)
inlinestatic

Updates the persisted email setup using the supplied SmtpSetup, and activates the change in the running system.

Parameters
setupThe SMTP settings.

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