FPCAlert Object

The FPCAlert object defines an alert. When a specific event occurs, this object determines the actions to be taken in response to that event. The actions that can be triggered by an alert include sending an e-mail message, invoking a command, writing to a log, and starting or stopping Forefront TMG services. The FPCAlert object also defines three thresholds that determine whether an alert will be issued and the actions defined for it will be taken. With alerts, an administrator can be notified about the occurrence of certain events and decide which actions should be taken in advance. Properties of the actions to be taken can be accessed through the FPCAlertActions collection.

This object is an element of an FPCAlerts collection.

Click here to see the Forefront TMG object hierarchy.

For a detailed example of using the FPCAlert object to create an alert for a Web filter, see Signaling Events and Alerts. For information about using alerts for responding to events in application filters, see Using Events and Alerts.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting an object's data to and importing it from an XML document.

Methods

The FPCAlert object defines the following method.

Method	Description
SetDefinitions	Sets the following properties of the alert: the globally unique identifier (GUID) of the event for which the alert is issued, the name of the server that issues the alert, and the additional key.

Properties

The FPCAlert object defines the following properties.

Property	Description
Actions	Gets an FPCAlertActions collection that contains FPCAlertAction objects defining the actions to be taken in response to the event that issues the alert.
AdditionalKey	Gets the additional key in the table of subevents defined for the event for which the alert is issued.
Category	Gets or sets a value from the FpcAlertCategory enumerated type that specifies the category of the alert.
Description	Gets or sets the description of the alert.
Enabled	Gets or sets a Boolean value that indicates whether the alert is enabled.
EventGUID	Gets the globally unique identifier (GUID) of the event for which the alert is issued.
EventsBeforeRaise	Gets or sets the minimal number of occurrences of the event for which the alert is issued before the alert can be issued.
MinEventsPerSecond	Gets or sets the minimal frequency of occurrences of the event for which the alert is issued before the alert can be issued.
MinutesBeforeReRaise	Gets or sets a time interval that must pass before the alert can be issued again.
Name	Gets or sets the name of the alert object.
Password	Sets the password in the credentials supplied for command-line actions.
ServerName	Gets the name of the server that is allowed to issue the alert.
Severity	Gets or sets a value from the FpcAlertSeverity enumerated type that specifies the severity of the alert.
UserName	Gets or sets the user name in the credentials supplied for command-line actions.

Methods Inherited from FPCPersist

Name	Description
CancelWaitForChanges	Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport	Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML file.
GetServiceRestartMask	Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML file to persistent storage.
LoadDocProperties	Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh	Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save	Recursively writes the current values of all the properties of the object and its subobjects to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

Properties Inherited from FPCPersist

Name	Description
PersistentName	Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets	Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This object implements the IFPCAlert interface.

Requirements

Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
IDL	Declared in Msfpccom.idl.