Class Notification


  • public class Notification
    extends Object
    Notification
    • Constructor Detail

      • Notification

        public Notification()
    • Method Detail

      • category

        public Notification category​(Notification.CategoryEnum category)
        The type of event notification sent when you select the notification button.
        Parameters:
        category - The type of event notification sent when you select the notification button.
        Returns:
        the current Notification instance, allowing for method chaining
      • getCategory

        public Notification.CategoryEnum getCategory()
        The type of event notification sent when you select the notification button.
        Returns:
        category The type of event notification sent when you select the notification button.
      • setCategory

        public void setCategory​(Notification.CategoryEnum category)
        The type of event notification sent when you select the notification button.
        Parameters:
        category - The type of event notification sent when you select the notification button.
      • details

        public Notification details​(String details)
        The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.
        Parameters:
        details - The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.
        Returns:
        the current Notification instance, allowing for method chaining
      • getDetails

        public String getDetails()
        The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.
        Returns:
        details The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.
      • setDetails

        public void setDetails​(String details)
        The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.
        Parameters:
        details - The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.
      • enabled

        public Notification enabled​(Boolean enabled)
        Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.
        Parameters:
        enabled - Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.
        Returns:
        the current Notification instance, allowing for method chaining
      • getEnabled

        public Boolean getEnabled()
        Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.
        Returns:
        enabled Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.
      • setEnabled

        public void setEnabled​(Boolean enabled)
        Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.
        Parameters:
        enabled - Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.
      • showButton

        public Notification showButton​(Boolean showButton)
        Shows or hides the event notification button on the screen of terminal models that have a keypad.
        Parameters:
        showButton - Shows or hides the event notification button on the screen of terminal models that have a keypad.
        Returns:
        the current Notification instance, allowing for method chaining
      • getShowButton

        public Boolean getShowButton()
        Shows or hides the event notification button on the screen of terminal models that have a keypad.
        Returns:
        showButton Shows or hides the event notification button on the screen of terminal models that have a keypad.
      • setShowButton

        public void setShowButton​(Boolean showButton)
        Shows or hides the event notification button on the screen of terminal models that have a keypad.
        Parameters:
        showButton - Shows or hides the event notification button on the screen of terminal models that have a keypad.
      • title

        public Notification title​(String title)
        The name of the notification button on the terminal screen.
        Parameters:
        title - The name of the notification button on the terminal screen.
        Returns:
        the current Notification instance, allowing for method chaining
      • getTitle

        public String getTitle()
        The name of the notification button on the terminal screen.
        Returns:
        title The name of the notification button on the terminal screen.
      • setTitle

        public void setTitle​(String title)
        The name of the notification button on the terminal screen.
        Parameters:
        title - The name of the notification button on the terminal screen.
      • includeNullValues

        public Notification includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this Notification object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static Notification fromJson​(String jsonString)
                                     throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of Notification given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of Notification
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to Notification
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of Notification to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException