io.getlime.push.model.entity

Class PushMessageBody

java.lang.Object

io.getlime.push.model.entity.PushMessageBody

public class PushMessageBody
extends Object

Class representing a message body - the information that do not serve as a "message descriptor" but rather as payload. This data package is a subject of end-to-end encryption.

Constructor Summary

Constructors

Constructor and Description
PushMessageBody()

Method Summary

Modifier and Type	Method and Description
Integer	getBadge() App icon badge value (iOS only).
String	getBody() Get long message text, used as a notification body.
String	getCategory() Get the notification category, used to distinguish actions assinged with the notification.
String	getCollapseKey() Get the collapse key, used to collapse messages on the server in case messages cannot be delivered and as a tag / thread ID to group messages with the same content type.
Map<String,Object>	getExtras() Get the map (Map<String, Object>) with optional message parameters.
String	getSound() Get the sound name to be played with the notification.
String	getTitle() Push message title.
Date	getValidUntil() Get notification delivery validity (timestamp message should live to in case it's not delivered immediately).
void	setBadge(Integer badge) Set app icon badge value (iOS only).
void	setBody(String body) Set long message text, used as a notification body.
void	setCategory(String category) Set the notification category, used to distinguish actions assinged with the notification.
void	setCollapseKey(String collapseKey) Set the collapse key, used to collapse messages on the server in case messages cannot be delivered and as a tag / thread ID to group messages with the same content type.
void	setExtras(Map<String,Object> extras) Set the map (Map<String, Object>) with optional message parameters.
void	setSound(String sound) Set the sound name to be played with the notification.
void	setTitle(String title) Set push message title.
void	setValidUntil(Date validUntil) Set notification delivery validity (timestamp message should live to in case it's not delivered immediately).

Methods inherited from class java.lang.Object

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

Constructor Detail

PushMessageBody

public PushMessageBody()

Method Detail

getTitle

public String getTitle()

Push message title. Short and digestible message stating the message purpose, for example "Balance update".

Returns:

Push message title.

setTitle

public void setTitle(String title)

Set push message title. Short and digestible message stating the message purpose, for example "Balance update".

Parameters:

title - Push message title.

getBody

public String getBody()

Get long message text, used as a notification body. Place your message to this property, for example "Your today's balance is $782.40".

Returns:

Notification body text.

setBody

public void setBody(String body)

Set long message text, used as a notification body. Place your message to this property, for example "Your today's balance is $782.40".

Parameters:

body - Notification body text.

getBadge

public Integer getBadge()

App icon badge value (iOS only).

Returns:

App icon badge.

setBadge

public void setBadge(Integer badge)

Set app icon badge value (iOS only).

Parameters:

badge - App icon badge.

getSound

public String getSound()

Get the sound name to be played with the notification.

Returns:

Sound name.

setSound

public void setSound(String sound)

Set the sound name to be played with the notification.

Parameters:

sound - Sound name.

getCategory

public String getCategory()

Get the notification category, used to distinguish actions assinged with the notification.

Returns:

Notification category.

setCategory

public void setCategory(String category)

Set the notification category, used to distinguish actions assinged with the notification.

Parameters:

category - Notification category.

getCollapseKey

public String getCollapseKey()

Get the collapse key, used to collapse messages on the server in case messages cannot be delivered and as a tag / thread ID to group messages with the same content type.

Returns:

Notification collapse key.

setCollapseKey

public void setCollapseKey(String collapseKey)

Set the collapse key, used to collapse messages on the server in case messages cannot be delivered and as a tag / thread ID to group messages with the same content type.

Parameters:

collapseKey - Notification collapse key.

getValidUntil

public Date getValidUntil()

Get notification delivery validity (timestamp message should live to in case it's not delivered immediately).

Returns:

Validity timestamp.

setValidUntil

public void setValidUntil(Date validUntil)

Set notification delivery validity (timestamp message should live to in case it's not delivered immediately).

Parameters:

validUntil - Validity timestamp.

getExtras

public Map<String,Object> getExtras()

Get the map (Map<String, Object>) with optional message parameters. This is translated to custom parameters on iOS and to data notification payload object on Android.

Returns:

Extra attributes.

setExtras

public void setExtras(Map<String,Object> extras)

Set the map (Map<String, Object>) with optional message parameters. This is translated to custom parameters on iOS and to data notification payload object on Android.

Parameters:

extras - Extra attributes.