Class PushMessageBuilder

Method Details

• title

  public IPushNotificationMessageBuilder title(String title)

  Description copied from interface: IPushNotificationMessageBuilder

  Sets the notification title (the showNotification title argument). Required.

  Specified by:

  title in interface IPushNotificationMessageBuilder

  Parameters:

  title - The title; must be non-null and non-empty.

  Returns:

  this, for chaining.

• body

  public IPushNotificationMessageBuilder body(String body)

  Description copied from interface: IPushNotificationMessageBuilder

  Sets the notification body (the options.body field) — the secondary text shown beneath the title.

  Specified by:

  body in interface IPushNotificationMessageBuilder

  Parameters:

  body - The body text.

  Returns:

  this, for chaining.

• icon

  public IPushNotificationMessageBuilder icon(String iconUrl)

  Description copied from interface: IPushNotificationMessageBuilder

  Sets the notification icon URL (the options.icon field).

  Specified by:

  icon in interface IPushNotificationMessageBuilder

  Parameters:

  iconUrl - The icon URL.

  Returns:

  this, for chaining.

• badge

  public IPushNotificationMessageBuilder badge(String badgeUrl)

  Description copied from interface: IPushNotificationMessageBuilder

  Sets the notification badge URL (the options.badge field) — the monochrome glyph a device shows in its status area.

  Specified by:

  badge in interface IPushNotificationMessageBuilder

  Parameters:

  badgeUrl - The badge URL.

  Returns:

  this, for chaining.

• tag

  public IPushNotificationMessageBuilder tag(String tag)

  Description copied from interface: IPushNotificationMessageBuilder

  Sets the notification tag (the options.tag field). Notifications sharing a tag coalesce on the device, replacing rather than stacking.

  Specified by:

  tag in interface IPushNotificationMessageBuilder

  Parameters:

  tag - The tag.

  Returns:

  this, for chaining.

• data

  public IPushNotificationMessageBuilder data(String key, Object value)

  Description copied from interface: IPushNotificationMessageBuilder

  Adds one key/value pair to the notification's application data (the options.data object), which the service worker receives verbatim and the application interprets. Repeated calls accumulate; a repeated key overwrites.

  Specified by:

  data in interface IPushNotificationMessageBuilder

  Parameters:

  key - The data key; must be non-null.

  value - The data value.

  Returns:

  this, for chaining.

• option

  public IPushNotificationMessageBuilder option(String key, Object value)

  Description copied from interface: IPushNotificationMessageBuilder

  Sets an arbitrary option directly into the options map, for fields not covered by a dedicated setter (e.g. requireInteraction, silent, actions).

  Specified by:

  option in interface IPushNotificationMessageBuilder

  Parameters:

  key - The option key; must be non-null.

  value - The option value.

  Returns:

  this, for chaining.

• timeToLive

  public IPushNotificationMessageBuilder timeToLive(long millis)

  Description copied from interface: IPushNotificationMessageBuilder

  Sets this notification's time-to-live in milliseconds, overriding the server default. Clamped by the engine to the configured TTL range; a notification left without an explicit TTL uses IPushSettings.getDefaultTTL().

  Specified by:

  timeToLive in interface IPushNotificationMessageBuilder

  Parameters:

  millis - The TTL in milliseconds.

  Returns:

  this, for chaining.

• build

  public IPushNotification build()

  Description copied from interface: IPushNotificationMessageBuilder

  Validates the accumulated fields and builds the immutable notification.

  Specified by:

  build in interface IPushNotificationMessageBuilder

  Returns:

  The built IPushNotification; never null.