Represents an alert rule suitable for residing in a TIBCO Live Datamart server.
Properties managed by the server include, but are not limited to, the id, enabled status
and validation status.
Namespace: StreamBase.LiveView.API.AlertsAssembly: StreamBase.LiveView.API (in StreamBase.LiveView.API.dll) Version: 10.6.6.1 (10.6.6.1)
Syntax
| C# | Visual Basic | Visual C++ |
public interface IAlertRule
Public Interface IAlertRule
public interface class IAlertRule
Members
| All Members | Properties  | Methods  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| Actions |
This gets the list of actions triggered by this rule. You can remove or rearrange these, and the changes will be saved if you save the Alert
using SetAlertRule(IAlertRule)
Use any of the "New*Action()" factory methods (e.g. NewExecuteOSCommandAction()()()()) to create one of the action types (which will also add it to this list).
|
| AlertGroup |
The name of the alert group that this alert is part of, if supported. Null or empty string is default group or not supported
|
| AlertQueryConfig |
Configuration of this rule.
Note that the values of the QueryConfig object must be set via its individual properties (Table, Predicate, etc.);
using the QueryString property will result in an exception being thrown as it is currently unsupported.
|
| AlertType |
The type of alert -- query-based or time-based
|
| CreationTime |
Creation time of this rule.
|
| CronString | |
| Description |
Description of this rule.
|
| GUID |
Unique identifier for this rule.
|
| IsEnabled |
Whether this rule is currently enabled.
|
| IsValid |
Whether this rule is valiid.
|
| LastModificationTime |
Last modification time of this rule.
|
| MessageTemplate |
Message template for this rule.
|
| Name |
Name of this rule.
|
| NewExecuteJavaAction()()()() |
Creates a new IExecuteJavaAction and adds it to the end of the list of IAlertRuleActions for this rule.
|
| NewExecuteOSCommandAction()()()() |
Creates a new IExecuteOSCommandAction and adds it to the end of the list of IAlertRuleActions for this rule.
|
| NewInvokeHttpAction()()()() |
Creates a new IInvokeHttpAction and adds it to the end of the list of IAlertRuleActions for this rule.
|
| NewIssueDeleteQueryAction()()()() |
Creates a new IIssueDeleteQueryAction and adds it to the end of the list of IAlertRuleActions for this rule.
|
| NewLVPublishAlertAction()()()() |
Creates a new ILVPublishAlertAction and adds it to the end of the list of IAlertRuleActions for this rule.
|
| NewPublishAlertAction()()()() |
Creates a new IPublishAlertAction and adds it to the end of the list of IAlertRuleActions for this rule.
|
| NewSendEmailAction()()()() |
Creates a new ISendEmailAction and adds it to the end of the list of IAlertRuleActions for this rule.
|
| NewSendTupleAction()()()() |
Creates a new ISendTupleAction and adds it to the end of the list of IAlertRuleActions for this rule.
|
| Owner |
Owner of this rule.
The special value  CopyC#* |
| PersistedVersion |
Persisted version of this rule.
|
| Quiescence |
Quiescence value of this rule.
|
| StatusMessage |
Current status of this rule.
|
See Also
