com.inductiveautomation.ignition.alarming.common

Interface AlarmNotificationRPC

public interface AlarmNotificationRPC

Method Summary

Modifier and Type	Method and Description
UIResponse	createRoster(java.util.Locale locale, java.lang.String name)
UIResponse	deleteRosters(java.util.Locale locale, java.util.List<java.lang.String> names)
UIResponse	editRoster(java.util.Locale locale, java.lang.String name, java.util.List<User> model)
java.util.List<java.lang.String>	getNotificationProfiles()
java.util.List<java.lang.String>	getOnCallRosters()
java.util.Collection<NotificationProfileProperty<?>>	getProfileProperties(java.lang.String profileName)
RosterModel	getRoster(java.lang.String name)
java.util.List<java.lang.String>	listPipelines()

Method Detail

getNotificationProfiles

java.util.List<java.lang.String> getNotificationProfiles()

Returns:

A list of notification profiles, by name.

getProfileProperties

java.util.Collection<NotificationProfileProperty<?>> getProfileProperties(java.lang.String profileName)
                                                                   throws java.lang.Exception

Parameters:

profileName - The name of the profile.

Returns:

The NotificationProfilePropertys provided by the given profile.

Throws:

java.lang.Exception

listPipelines

java.util.List<java.lang.String> listPipelines()

Returns:

A list of alarm pipelines, by name.

getOnCallRosters

java.util.List<java.lang.String> getOnCallRosters()
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getRoster

RosterModel getRoster(java.lang.String name)
               throws java.lang.Exception

Throws:

java.lang.Exception

editRoster

UIResponse editRoster(java.util.Locale locale,
                      java.lang.String name,
                      java.util.List<User> model)
               throws java.lang.Exception

Throws:

java.lang.Exception

createRoster

UIResponse createRoster(java.util.Locale locale,
                        java.lang.String name)
                 throws java.lang.Exception

Throws:

java.lang.Exception

deleteRosters

UIResponse deleteRosters(java.util.Locale locale,
                         @Nonnull
                         java.util.List<java.lang.String> names)
                  throws java.lang.Exception

Throws:

java.lang.Exception