This class provides access to alert-related functionality.
Namespace: StreamBase.LiveView.API.AlertsAssembly: StreamBase.LiveView.API (in StreamBase.LiveView.API.dll) Version: 10.4.4.0 (10.4.4.0)
Syntax
| C# | Visual Basic | Visual C++ |
public interface IAlertManager
Public Interface IAlertManager
public interface class IAlertManager
Members
| All Members | Methods  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| CreateAlertRule()()()() |
Creates a new alert rule. The returned object must be added to the server
once configured for it to take effect.
All of the properties of the returned IAlertRule have initial values, but
no initial value is guaranteed to be valid.
After valid property values have been assigned, the rule can be added to the
server using SetAlertRule(IAlertRule) |
| DeleteAlertRule(Guid) |
Deletes the given alert rule from the server. A LiveViewException is thrown if the rule
doesn't exist on the server.
|
| DeleteAlertRule(Int64) |
Deletes the given alert rule from the server. A LiveViewException is thrown if the rule
doesn't exist on the server.
|
| GetAlertRule(Guid) |
Gets the alert rule specified by the given GUID.
|
| GetAlertRule(Int64) |
Gets the alert rule specified by the given id.
|
| GetAlertRules(String) |
Gets all available alert rules from the server for the given user.
A user name of "*" or null returns all users' alerts.
"user" is currently just an opaque string that is used as a key in setting and getting alerts. There is no
validation or authentication done with or for this opaque string.
Blocks until all AlertRules are returned.
|
| SetAlertRule(IAlertRule) |
Add or updates the alert rule (matched using the rule's ID) on the server.
Only alert rules created via CreateAlertRule()()()() or retrieved by this manager may
be added to the server via this method.
If a new alert rule is being added, the given IAlertRule is mutated on return
such that its ID is set.
|
| ValidateAlertRule(IAlertRule) |
Validates the given alert rule. A LiveViewException is thrown if the rule fails to
validate properly.
|
See Also
