Class PushApi.Tweak

  • Enclosing interface:
    PushApi

    public static class PushApi.Tweak
    extends Object
    The set_tweak action is used to add an entry to the 'tweaks' dictionary that is sent in the notification request to the Push Gateway.
    • Field Detail

      • SOUND

        public static final String SOUND
        A string representing the sound to be played when this notification arrives. A value of default means to play a default sound. A device may choose to alert the user by some other means if appropriate, eg. vibration.
        See Also:
        Constant Field Values
      • HIGHLIGHT

        public static final String HIGHLIGHT
        A boolean representing whether or not this message should be highlighted in the UI. This will normally take the form of presenting the message in a different colour and/or style. The UI might also be adjusted to draw particular attention to the room in which the event occurred. If a highlight tweak is given with no value, its value is defined to be true. If no highlight tweak is given at all then the value of highlight is defined to be false.
        See Also:
        Constant Field Values
    • Constructor Detail

      • Tweak

        protected Tweak()