Home | Class Index
Class
caplin.streamlink.alerts

Trigger

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.

Note: Different instances of this class are not equal and will need to be checked for equality manually if the need arises. Use the trigger ID to identify a trigger.

Constructor Summary

Attributes Name and Description
caplin.streamlink.alerts.Trigger()

Method Summary

Attributes Name and Description
String getCondition()

Gets the condition that must be met for this trigger to fire a notification.
Object getParameters()

Gets a map containing the trigger parameters.
caplin.streamlink.alerts.TriggerState getState()

Gets the current state of the trigger.
String getSubject()

Gets the rttp subject associated with this trigger.
String getTriggerId()

Gets the unique id of the trigger.

Constructor Detail

► caplin.streamlink.alerts.Trigger()

Method Detail

► String getCondition()

Gets the condition that must be met for this trigger to fire a notification.

The format of the condition is the same as that for record filters. For more details on the format of the condition string, please see the StreamLink Overview document.

Returns
{String} the trigger condition.

► Object getParameters()

Gets a map containing the trigger parameters.

Returns
{Object} a map containing the trigger parameters.

► caplin.streamlink.alerts.TriggerState getState()

Gets the current state of the trigger.

Returns
{caplin.streamlink.alerts.TriggerState} the triggers state.

► String getSubject()

Gets the rttp subject associated with this trigger.

Returns
{String} the rttp subject associated with this trigger.

► String getTriggerId()

Gets the unique id of the trigger.

Returns
{String} the unique id of the trigger.