Package com.inductiveautomation.ignition.alarming.common

Interface AlarmNotificationRPC

  • public interface AlarmNotificationRPC

    • 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 defined in the default pipeline project, by name.

      • listPipelines

        java.util.List<java.lang.String> listPipelines​(java.lang.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

        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