Class PushApi.Actions

  • Enclosing interface:
    PushApi

    public static class PushApi.Actions
    extends Object
    All rules have an associated list of actions. An action affects if and how a notification is delivered for a matching event.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COALESCE
      This enables notifications for matching events but activates homeserver specific behaviour to intelligently coalesce multiple events into a single notification.
      static String DONT_NOTIFY
      This prevents each matching event from generating a notification.
      static String NOTIFY
      This causes each matching event to generate a notification.
      static String SET_TWEAK
      Sets an entry in the tweaks dictionary key that is sent in the notification request to the Push Gateway.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Actions()  
    • Field Detail

      • NOTIFY

        public static final String NOTIFY
        This causes each matching event to generate a notification.
        See Also:
        Constant Field Values
      • DONT_NOTIFY

        public static final String DONT_NOTIFY
        This prevents each matching event from generating a notification.
        See Also:
        Constant Field Values
      • COALESCE

        public static final String COALESCE
        This enables notifications for matching events but activates homeserver specific behaviour to intelligently coalesce multiple events into a single notification. Not all homeservers may support this. Those that do not support it should treat it as the notify action.
        See Also:
        Constant Field Values
      • SET_TWEAK

        public static final String SET_TWEAK
        Sets an entry in the tweaks dictionary key that is sent in the notification request to the Push Gateway. This takes the form of a dictionary with a set_tweak key whose value is the name of the tweak to set. It may also have a value key which is the value to which it should be set.
        See Also:
        Constant Field Values
    • Constructor Detail

      • Actions

        protected Actions()