AP&C API Reference
Public Member Functions | Protected Member Functions | List of all members
Apac.Reporting.AlertAction Class Referenceabstract

Provides a the base implementation for plugins that will notify of alert status changes. These plugin actions are intended for communication with human agents rather than integration with other systems. See the other types of actions for integration callouts. More...

Inheritance diagram for Apac.Reporting.AlertAction:
Apac.Configuration.Plugin< PluginAttribute, PluginDescriptor > Apac.Reporting.IAlertAction Apac.EventManagement.IAction Apac.Plugins.Actions.EmailAlertAction

Public Member Functions

void Notify (Apac.Monitoring.Alert alert)
 Notifies of the alert. More...
 
void Execute (ActionArgs args)
 Performs the action. More...
 

Protected Member Functions

abstract void OnNotify (Apac.Monitoring.Alert alert)
 Called when the subclass should notify of the alert. More...
 

Additional Inherited Members

- Properties inherited from Apac.Configuration.Plugin< PluginAttribute, PluginDescriptor >
virtual log4net.ILog Log [get]
 Gets the log. It lazy loads as necessary. More...
 
Guid Id [get]
 Gets the id of the formula from the subclass's PluginAttribute. More...
 
string Name [get]
 Gets the name of the formula from the subclass's PluginAttribute. More...
 
string Description [get]
 Gets the description from the subclass's PluginAttribute. More...
 
string Instructions [get]
 Gets the instructions from the subclass's PluginAttribute. More...
 
Descriptor [get]
 Gets the descriptor so it can be serialized to remote clients.. More...
 
Attribute [get]
 Gets the attribute, lazy loads it as necessary. More...
 
- Properties inherited from Apac.EventManagement.IAction
PluginDescriptor Descriptor [get]
 The descriptor of the action used by the plugin infrastructure to define the action. More...
 

Detailed Description

Provides a the base implementation for plugins that will notify of alert status changes. These plugin actions are intended for communication with human agents rather than integration with other systems. See the other types of actions for integration callouts.

Member Function Documentation

◆ Execute()

void Apac.Reporting.AlertAction.Execute ( ActionArgs  args)
inline

Performs the action.

Parameters
argsThe ActionArgs used to perform dynamic actions.

Implements Apac.EventManagement.IAction.

◆ Notify()

void Apac.Reporting.AlertAction.Notify ( Apac.Monitoring.Alert  alert)
inline

Notifies of the alert.

Parameters
alertThe alert to be sent.

Implements Apac.Reporting.IAlertAction.

◆ OnNotify()

abstract void Apac.Reporting.AlertAction.OnNotify ( Apac.Monitoring.Alert  alert)
protectedpure virtual

Called when the subclass should notify of the alert.

Parameters
alertThe alert.

Implemented in Apac.Plugins.Actions.EmailAlertAction.


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