Package com.inductiveautomation.ignition.alarming.common

Interface AlarmNotificationRPC

public interface AlarmNotificationRPC

Field Summary

Fields

Modifier and Type	Field	Description
static final ProtoRpcSerializer	SERIALIZER	Base serializer for Alarm Notification-related classes.

Method Summary

Modifier and Type	Method	Description
void	createRoster(String name, String description)
UIResponse	createRoster(Locale locale, String name)
UIResponse	deleteRosters(Locale locale, List<String> names)
UIResponse	editRoster(Locale locale, String name, List<User> model)
List<String>	getNotificationProfiles()
List<String>	getOnCallRosters()
Collection<NotificationProfileProperty<?>>	getProfileProperties(String profileName)
RosterModel	getRoster(String name)
Map<String,List<String>>	getRosters()
List<String>	listPipelines()
List<String>	listPipelines(String project)	Get a List of alarm pipelines defined in project, by name.

Field Details

SERIALIZER

static final ProtoRpcSerializer SERIALIZER

Base serializer for Alarm Notification-related classes. We'll come back to replace this with custom serializers later to avoid java serialization.

Method Details

getNotificationProfiles

List<String> getNotificationProfiles()

Returns:

A list of notification profiles, by name.

getProfileProperties

Collection<NotificationProfileProperty<?>> getProfileProperties(String profileName)
                                                         throws Exception

Parameters:

profileName - The name of the profile.

Returns:

The NotificationProfilePropertys provided by the given profile.

Throws:

Exception

listPipelines

List<String> listPipelines()

Returns:

a List of alarm pipelines defined in the default pipeline project, by name.

listPipelines

List<String> listPipelines(String project)

Get a List of alarm pipelines defined in project, by name.

Parameters:

project - the name of the project.

Returns:

a list of alarm pipelines defined in the given project.

getOnCallRosters

List<String> getOnCallRosters()

getRoster

RosterModel getRoster(String name)

editRoster

UIResponse editRoster(Locale locale,
 String name,
 List<User> model)

createRoster

UIResponse createRoster(Locale locale,
 String name)

deleteRosters

UIResponse deleteRosters(Locale locale,
 @Nonnull
 List<String> names)

getRosters

Map<String,List<String>> getRosters()

createRoster

void createRoster(String name,
 String description)