Package com.inductiveautomation.ignition.alarming.common.pipelines

Interface NotificationBlockProperties

All Known Implementing Classes:
NotificationBlockEditor, NotificationBlockPrototype
public interface NotificationBlockProperties

  • Field Details

    • FACTORY

      static final String FACTORY
      See Also:

    • PROFILE_KEY_PREFIX

      static final String PROFILE_KEY_PREFIX
      The prefix to append to the key of the property for each configured notification profile's property set.

      For example, if NOTIFICATION_PROFILES value was ["A", "B"] then it would be expected that each profile's corresponding property set is obtainable from the config property set using properties keyed on "settingsFor_A" and "settingsFor_B".

      See Also:

    • BLOCK_VERSION

      static final Property<Integer> BLOCK_VERSION
      Introduced in 7.6.1 support the notion of notification blocks being able to use multiple notification profiles.

      If version 1, then the deprecated NOTIFICATION_PROFILE property will be used during notification.

      If version 2, then the new NOTIFICATION_PROFILES and TIME_BETWEEN_NOTIFICATIONS will be used to process the roster in order, but across multiple notification profiles based on the order of the user's contact info.

    • THROTTLING_ENABLED

      static final Property<Boolean> THROTTLING_ENABLED
      Consolidation enabled/disabled.

    • THROTTLING_DELAY

      static final Property<Long> THROTTLING_DELAY
      How long to wait to "collect" more events before dispatching for notification.

    • THROTTLING_FREQUENCY

      static final Property<Long> THROTTLING_FREQUENCY
      The limit on how frequently consolidated notifications can be sent, i.e., don't send out a notification unless N milliseconds has elapsed since the last notification was sent.

    • ROSTER_TYPE

      static final Property<String> ROSTER_TYPE
      Determines how the call roster is interpreted.

    • ON_CALL_ROSTER

      static final Property<String> ON_CALL_ROSTER
      The name of the call roster to use.

    • IGNORE_SCHEDULE

      static final Property<Boolean> IGNORE_SCHEDULE
      If true, ignore user schedules when sending notifications.

    • NOTIFICATION_PROFILE

      @Deprecated static final Property<String> NOTIFICATION_PROFILE
      Deprecated.
      The name of the notification profile to use for notification.

      This property should only be used if getOrDefault for BLOCK_VERSION is 1.

    • NOTIFICATION_PROFILES

      static final Property<String[]> NOTIFICATION_PROFILES
      The names of the notification profiles to use for notification.

    • TIME_BETWEEN_NOTIFICATIONS

      static final Property<Long> TIME_BETWEEN_NOTIFICATIONS
      The time to delay between notifications, in milliseconds. It is passed along to the notification profile through the NotificationContext- if a profile loops through the various contact infos available for a user, they should try to respect this delay.