NotificationContext

All Superinterfaces:

Countable, Extendable<PropertySet>, java.lang.Iterable<PropertyValue>, Mergable<PropertySet>, MutablePropertyValueSource, PropertySet, PropertyValueSource, java.io.Serializable
```
public interface NotificationContext
extends PropertySet
```
The 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 notificationDone() or notificationFailed(LocalizedString) when finished.
The NotificationContext extends PropertySet, and will contain the configured properties defined by the notification profile.

Field Summary
- Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet
  EMPTY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.List<AlarmEvent>`	`getAlarmEvents()`
`java.util.EnumSet<DropoutCondition>`	`getDropoutConditions()`
`User`	`getUser()`
`void`	`notificationDone()`	Call when notification has been completed successfully.
`void`	`notificationFailed(LocalizedString failureMessage)`	None of the `AlarmEvent`s in this context could be sent due some underlying failure.

Methods inherited from interface com.inductiveautomation.ignition.common.config.Countable
getCount

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable
merge

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

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource
contains, get, getNonNull, getNonNull, getOrDefault, getOrElse, getProperties, getValues

- Method Detail
  - getUser
```
User getUser()
```
    Returns:
    
    the User to notify.
  - getAlarmEvents
```
java.util.List<AlarmEvent> getAlarmEvents()
```
    Returns:
    
    A List of AlarmEvents that triggered this notification.
  - getDropoutConditions
```
java.util.EnumSet<DropoutCondition> getDropoutConditions()
```
    Returns:
    
    the DropoutConditions configured on the pipeline.
  - notificationDone
```
void notificationDone()
```
    Call when notification has been completed successfully.
  - notificationFailed
```
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 AlarmPipeline is defined, all events will be placed upon it for evaluation.
    
    Parameters:
    
    failureMessage - The reason for failure. This message will be user-facing in the pipeline status area if no fall-back is defined.