StreamLink.NET  7.0.3-7.0.3-3688-ee25766
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Classes | Enumerations
Package Caplin.StreamLink.Alerts

The classes within this package provide the functionality of StreamLink alerts More...

Classes

interface  INotification
 A Notification is an object that can be sent to notify a user of a particular event. More...
 
interface  INotificationListener
 Interface that should be implemented to receive notification change callbacks from the NotificationProvider More...
 
interface  IResultListener
 An interface that can be registered to be called back when an operation completes. More...
 
interface  ITrigger
 A Trigger is an object associated with a particular RTTP subject that contains a condition (on the given subjects fields) that when met will trigger a notification message. More...
 
interface  ITriggerListener
 Interface that should be implemented to receive trigger change callbacks from the TriggerProvider More...
 
class  NotificationService
 A NotificationService subscribes to a Notifications container of the StreamLink user and allows the user to register a listener to be called when notifications are triggered or dismissed. More...
 
class  TriggerService
 A TriggerService subscribes to the Triggers of a StreamLink user and allows the user to register a listener to be called back when triggers are added, removed or modified. More...
 

Enumerations

enum  TriggerState { TriggerState.ACTIVE, TriggerState.INACTIVE, TriggerState.TRIGGERED, TriggerState.UNKNOWN }
 Enumeration that defines the different states a ITrigger can be in More...
 

Detailed Description

The classes within this package provide the functionality of StreamLink alerts

Enumeration Type Documentation

Enumeration that defines the different states a ITrigger can be in

Enumerator
ACTIVE 

the trigger is active and waiting for the condition to be met

INACTIVE 

the trigger is disabled/paused and will not trigger if the condition is met

TRIGGERED 

the condition was met and a notification was triggered

UNKNOWN 

Invalid state that only happens if the backend sends an unsupported state


Generated on Fri Jan 26 2018 17:04:15 for StreamLink.NET