Package com.vaadin.flow.server.webpush

Record Class WebPushMessage

java.lang.Object
java.lang.Record
com.vaadin.flow.server.webpush.WebPushMessage
All Implemented Interfaces:
Serializable
public record WebPushMessage(String title, com.fasterxml.jackson.databind.node.ObjectNode options) extends Record implements Serializable
Web Push message object containing an information to be shown in the notification.
Since:
24.2
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    WebPushMessage(String title)
    Creates a new Web Push notification message with just a title.
    WebPushMessage(String title, com.fasterxml.jackson.databind.node.ObjectNode options)
    Creates an instance of a WebPushMessage record class.
    WebPushMessage(String title, Serializable options)
    Creates a new Web Push notification message with the specified title and various options fetched from a given Java object.
    WebPushMessage(String title, String body)
    Creates a new Web Push notification message with just a title and body.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    com.fasterxml.jackson.databind.node.ObjectNode
    options()
    Returns the value of the options record component.
    String
    title()
    Returns the value of the title record component.
    String
    toJson()
    Converts this Web Push message into JSON format string.
    String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • WebPushMessage

      public WebPushMessage(String title, Serializable options)
      Creates a new Web Push notification message with the specified title and various options fetched from a given Java object.
      Parameters:
      title - the notification title
      options - any Serializable Java object representing custom settings to apply to the notification
      See Also:

    • WebPushMessage

      public WebPushMessage(String title, String body)
      Creates a new Web Push notification message with just a title and body.
      Parameters:
      title - notification title
      body - notification body

    • WebPushMessage

      public WebPushMessage(String title)
      Creates a new Web Push notification message with just a title.
      Parameters:
      title - notification title

    • WebPushMessage

      public WebPushMessage(String title, com.fasterxml.jackson.databind.node.ObjectNode options)
      Creates an instance of a WebPushMessage record class.
      Parameters:
      title - the value for the title record component
      options - the value for the options record component

  • Method Details

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • toJson

      public String toJson()
      Converts this Web Push message into JSON format string.
      Returns:
      JSON representation of this message

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • title

      public String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component

    • options

      public com.fasterxml.jackson.databind.node.ObjectNode options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component