Collapse All Expand All | Language Filter: C#Language Filter: Visual Basic Language Filter: Visual C++ C# Visual Basic Visual C++ | Members | See Also
StreamBase Client API
IAlertRule Interface

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.Alerts
Assembly: StreamBase.LiveView.API (in StreamBase.LiveView.API.dll) Version: 10.3.0.4 (10.3.0.4)

# 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).
| 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 | For time-based alerts, cron expression describing the time at which to trigger the alert. If this is set to a non-null value, the rule's AlertType will be changed to CronAlert automatically.
| Description | Description of this rule.
| GUID | Unique identifier for this rule.
| ID | 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.
| 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#
    *
means "all users."
| PersistedVersion | Persisted version of this rule.
| Quiescence | Quiescence value of this rule.
| StatusMessage | Current status of this rule.

# See Also

StreamBase.LiveView.API.Alerts Namespace