public static final class PushMessage.Builder

  1. Object
  2. PushMessage.Builder
Builds an immutable PushMessage.

Methods

public PushMessage.Builder id(String value)
public PushMessage.Builder title(String value)
public PushMessage.Builder body(String value)
public PushMessage.Builder imageUrl(String value)
public PushMessage.Builder deepLink(String value)
public PushMessage.Builder collapseKey(String value)
public PushMessage.Builder ttlSeconds(int value)Sets provider retention time.
public PushMessage.Builder silent(boolean value)Selects data-only delivery when true.
public PushMessage.Builder data(String key, Object value)Adds application data, or removes the key when value is null.
public PushMessage.Builder platform(String platformId, Map<String, Object> options)Adds provider-specific options.
public PushMessage.Builder surface(Map<String, Object> command)Sets a widget or live-surface command.
public PushMessage build()Creates an immutable message snapshot.

Inherited methods

From Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait, clone

Method details

id

public PushMessage.Builder id(String value)

Parameters

value String
message ID @return this builder

title

public PushMessage.Builder title(String value)

Parameters

value String
visible title @return this builder

body

public PushMessage.Builder body(String value)

Parameters

value String
visible body @return this builder

imageUrl

public PushMessage.Builder imageUrl(String value)

Parameters

value String
HTTPS image URL @return this builder

deepLink

public PushMessage.Builder deepLink(String value)

Parameters

value String
application deep link @return this builder

collapseKey

public PushMessage.Builder collapseKey(String value)

Parameters

value String
provider collapse key @return this builder

ttlSeconds

public PushMessage.Builder ttlSeconds(int value)
Sets provider retention time.

Parameters

value int
positive lifetime in seconds

Returns

this builder

silent

public PushMessage.Builder silent(boolean value)
Selects data-only delivery when true.

Parameters

value boolean
whether the message is silent

Returns

this builder

data

public PushMessage.Builder data(String key, Object value)
Adds application data, or removes the key when value is null.

Parameters

key String
application-defined key
value Object
JSON-compatible value

Returns

this builder

Throws

IllegalArgumentException
if key is null, empty, or has surrounding whitespace

platform

public PushMessage.Builder platform(String platformId, Map<String, Object> options)
Adds provider-specific options.

Parameters

platformId String
provider ID such as fcm, apns, huawei, wns, or web
options Map<String, Object>
JSON-compatible options, or null to remove

Returns

this builder

Throws

IllegalArgumentException
if platformId is null, empty, or has surrounding whitespace

surface

public PushMessage.Builder surface(Map<String, Object> command)
Sets a widget or live-surface command.

Parameters

command Map<String, Object>
command map, or null to remove it

Returns

this builder

build

public PushMessage build()
Creates an immutable message snapshot. The builder may be reused.

Returns

the message