- All Superinterfaces:
public interface NotificationContext extends PropertySetThe context for a particular notification. Provides the
AlarmEvents that should be described in the notification, as well as the user that should be notified. Beyond providing information, the notification context is an important control mechanism. Profiles must call either
notificationFailed(LocalizedString)when finished. The NotificationContext extends PropertySet, and will contain the configured properties defined by the notification profile.
All Methods Instance Methods Abstract Methods Modifier and Type Method Description
notificationDone()Call when notification has been completed successfully.
notificationFailed(LocalizedString failureMessage)None of the
AlarmEvents in this context could be sent due some underlying failure.
Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource
merge, remove, set, set
Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertySet
extend, getExtension, isExtended, isInherited, newDefaultInstance, newExtension
- A List of
AlarmEvents that triggered this notification.
DropoutConditions configured on the pipeline.
void notificationDone()Call when notification has been completed successfully.
void notificationFailed(LocalizedString failureMessage)None of the
AlarmEvents in this context could be sent due some underlying failure. If a fall-back for the current
AlarmPipelineis defined, all events will be placed upon it for evaluation.
failureMessage- The reason for failure. This message will be user-facing in the pipeline status area if no fall-back is defined.