public static class AlarmNotificationProfile.DisabledProfile extends java.lang.Object implements AlarmNotificationProfile
AlarmNotificationProfile.DisabledProfile, AlarmNotificationProfile.NoOpProfile
NO_OP_PROFILE
Constructor and Description |
---|
DisabledProfile(AlarmNotificationProfile profile) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName()
Returns the user-defined name of this profile.
|
java.util.Collection<NotificationProfileProperty<?>> |
getProperties()
A
Collection of CategorizedProperty s that will be presented to the user during configuration of a
notification block in the alarm pipeline UI. |
ProfileStatus |
getStatus()
Returns information about the running status of the profile.
|
java.util.Collection<ContactType> |
getSupportedContactTypes() |
void |
onShutdown()
Called when the profile has been removed from
AlarmNotificationManager . |
void |
onStartup()
Called after instantiation and the profile has been added to
AlarmNotificationManager . |
void |
sendNotification(NotificationContext notificationContext)
Notify a list of Users about an alarm using the notification mechanism provided by this profile.
|
public DisabledProfile(AlarmNotificationProfile profile)
public ProfileStatus getStatus()
AlarmNotificationProfile
getStatus
in interface AlarmNotificationProfile
ProfileStatus
that describes the status of this profile.public java.lang.String getName()
AlarmNotificationProfile
getName
in interface AlarmNotificationProfile
public void sendNotification(NotificationContext notificationContext)
AlarmNotificationProfile
NotificationContext.notificationFailed(com.inductiveautomation.ignition.common.i18n.LocalizedString)
.sendNotification
in interface AlarmNotificationProfile
notificationContext
- The NotificationContext
.public java.util.Collection<NotificationProfileProperty<?>> getProperties()
AlarmNotificationProfile
Collection
of CategorizedProperty
s that will be presented to the user during configuration of a
notification block in the alarm pipeline UI.
The configured values for these properties will be available in the NotificationContext
for each
AlarmNotificationProfile.sendNotification(NotificationContext)
call to this profile.getProperties
in interface AlarmNotificationProfile
Collection
of Property
s that AlarmNotificationProfile.sendNotification(NotificationContext)
will
expect its NotificationContext
to have configured.public java.util.Collection<ContactType> getSupportedContactTypes()
getSupportedContactTypes
in interface AlarmNotificationProfile
Collection
of ContactType
s that this profile is capable of sending notification to.public void onStartup()
AlarmNotificationProfile
AlarmNotificationManager
.onStartup
in interface AlarmNotificationProfile
public void onShutdown()
AlarmNotificationProfile
AlarmNotificationManager
. This could be an update to the
profile (remove+add), a removal, or shutdown of the system.onShutdown
in interface AlarmNotificationProfile