com.snowplowanalytics.snowplow.event

Class MessageNotification

java.lang.Object

com.snowplowanalytics.snowplow.event.AbstractEvent

com.snowplowanalytics.snowplow.event.AbstractSelfDescribing

com.snowplowanalytics.snowplow.event.MessageNotification

All Implemented Interfaces:

Event

public class MessageNotification
extends AbstractSelfDescribing

Event that represents the reception of a push notification (or a locally generated one).

Field Summary

Fields

Modifier and Type	Field and Description
String	action The action associated with the notification.
List<MessageNotificationAttachment>	attachments Attachments added to the notification (they can be part of the data object).
String	body The notification's body.
List<String>	bodyLocArgs Variable string values to be used in place of the format specifiers in bodyLocArgs to use to localize the body text to the user's current localization.
String	bodyLocKey The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
String	category The category associated to the notification.
Boolean	contentAvailable The application is notified of the delivery of the notification if it's in the foreground or background, the app will be woken up (iOS only).
String	group The group which this notification is part of.
String	icon The icon associated to the notification (Android only).
Integer	notificationCount The number of items this notification represents.
String	notificationTimestamp The time when the event of the notification occurred.
static String	PARAM_ACTION
static String	PARAM_BODY
static String	PARAM_BODYLOCARGS
static String	PARAM_BODYLOCKEY
static String	PARAM_CATEGORY
static String	PARAM_CONTENTAVAILABLE
static String	PARAM_GROUP
static String	PARAM_ICON
static String	PARAM_MESSAGENOTIFICATIONATTACHMENTS
static String	PARAM_NOTIFICATIONCOUNT
static String	PARAM_NOTIFICATIONTIMESTAMP
static String	PARAM_SOUND
static String	PARAM_SUBTITLE
static String	PARAM_TAG
static String	PARAM_THREADIDENTIFIER
static String	PARAM_TITLE
static String	PARAM_TITLELOCARGS
static String	PARAM_TITLELOCKEY
static String	PARAM_TRIGGER
static String	SCHEMA
String	sound The sound played when the device receives the notification.
String	subtitle The notification's subtitle.
String	tag An identifier similar to 'group' but usable for different purposes (Android only).
String	threadIdentifier An identifier similar to 'group' but usable for different purposes (iOS only).
String	title The notification's title.
List<String>	titleLocArgs Variable string values to be used in place of the format specifiers in titleLocArgs to use to localize the title text to the user's current localization.
String	titleLocKey The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
MessageNotificationTrigger	trigger The trigger that raised the notification message.

Fields inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

customContexts, trueTimestamp

Constructor Summary

Constructors

Constructor and Description
MessageNotification(String title, String body, MessageNotificationTrigger trigger) Creates a Message Notification event that represents a push notification or a local notification.

Method Summary

Modifier and Type	Method and Description
MessageNotification	action(String action) The action associated with the notification.
MessageNotification	attachments(List<MessageNotificationAttachment> attachments) Attachments added to the notification (they can be part of the data object).
MessageNotification	bodyLocArgs(List<String> bodyLocArgs) Variable string values to be used in place of the format specifiers in bodyLocArgs to use to localize the body text to the user's current localization.
MessageNotification	bodyLocKey(String bodyLocKey) The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
MessageNotification	category(String category) The category associated to the notification.
MessageNotification	contentAvailable(Boolean contentAvailable) The application is notified of the delivery of the notification if it's in the foreground or background, the app will be woken up (iOS only).
Map<String,Object>	getDataPayload()
String	getSchema()
MessageNotification	group(String group) The group which this notification is part of.
MessageNotification	icon(String icon) The icon associated to the notification (Android only).
MessageNotification	notificationCount(Integer notificationCount) The number of items this notification represents.
MessageNotification	notificationTimestamp(String notificationTimestamp) The time when the event of the notification occurred.
MessageNotification	sound(String sound) The sound played when the device receives the notification.
MessageNotification	subtitle(String subtitle) The notification's subtitle.
MessageNotification	tag(String tag) An identifier similar to 'group' but usable for different purposes (Android only).
MessageNotification	threadIdentifier(String threadIdentifier) An identifier similar to 'group' but usable for different purposes (iOS only).
MessageNotification	titleLocArgs(List<String> titleLocArgs) Variable string values to be used in place of the format specifiers in titleLocArgs to use to localize the title text to the user's current localization.
MessageNotification	titleLocKey(String titleLocKey) The key to the title string in the app's string resources to use to localize the title text to the user's current localization.

Methods inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

beginProcessing, contexts, endProcessing, getContexts, getTrueTimestamp, trueTimestamp

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA

public static final String SCHEMA

See Also:

Constant Field Values

PARAM_ACTION

public static final String PARAM_ACTION

See Also:

Constant Field Values

PARAM_MESSAGENOTIFICATIONATTACHMENTS

public static final String PARAM_MESSAGENOTIFICATIONATTACHMENTS

See Also:

Constant Field Values

PARAM_BODY

public static final String PARAM_BODY

See Also:

Constant Field Values

PARAM_BODYLOCARGS

public static final String PARAM_BODYLOCARGS

See Also:

Constant Field Values

PARAM_BODYLOCKEY

public static final String PARAM_BODYLOCKEY

See Also:

Constant Field Values

PARAM_CATEGORY

public static final String PARAM_CATEGORY

See Also:

Constant Field Values

PARAM_CONTENTAVAILABLE

public static final String PARAM_CONTENTAVAILABLE

See Also:

Constant Field Values

PARAM_GROUP

public static final String PARAM_GROUP

See Also:

Constant Field Values

PARAM_ICON

public static final String PARAM_ICON

See Also:

Constant Field Values

PARAM_NOTIFICATIONCOUNT

public static final String PARAM_NOTIFICATIONCOUNT

See Also:

Constant Field Values

PARAM_NOTIFICATIONTIMESTAMP

public static final String PARAM_NOTIFICATIONTIMESTAMP

See Also:

Constant Field Values

PARAM_SOUND

public static final String PARAM_SOUND

See Also:

Constant Field Values

PARAM_SUBTITLE

public static final String PARAM_SUBTITLE

See Also:

Constant Field Values

PARAM_TAG

public static final String PARAM_TAG

See Also:

Constant Field Values

PARAM_THREADIDENTIFIER

public static final String PARAM_THREADIDENTIFIER

See Also:

Constant Field Values

PARAM_TITLE

public static final String PARAM_TITLE

See Also:

Constant Field Values

PARAM_TITLELOCARGS

public static final String PARAM_TITLELOCARGS

See Also:

Constant Field Values

PARAM_TITLELOCKEY

public static final String PARAM_TITLELOCKEY

See Also:

Constant Field Values

PARAM_TRIGGER

public static final String PARAM_TRIGGER

See Also:

Constant Field Values

action

@Nullable
public String action

The action associated with the notification.

attachments

@Nullable
public List<MessageNotificationAttachment> attachments

Attachments added to the notification (they can be part of the data object).

body

@NonNull
public final String body

The notification's body.

bodyLocArgs

@Nullable
public List<String> bodyLocArgs

Variable string values to be used in place of the format specifiers in bodyLocArgs to use to localize the body text to the user's current localization.

bodyLocKey

@Nullable
public String bodyLocKey

The key to the body string in the app's string resources to use to localize the body text to the user's current localization.

category

@Nullable
public String category

The category associated to the notification.

contentAvailable

@Nullable
public Boolean contentAvailable

The application is notified of the delivery of the notification if it's in the foreground or background, the app will be woken up (iOS only).

group

@Nullable
public String group

The group which this notification is part of.

icon

@Nullable
public String icon

The icon associated to the notification (Android only).

notificationCount

@Nullable
public Integer notificationCount

The number of items this notification represents.

notificationTimestamp

@Nullable
public String notificationTimestamp

The time when the event of the notification occurred.

sound

@Nullable
public String sound

The sound played when the device receives the notification.

subtitle

@Nullable
public String subtitle

The notification's subtitle. (iOS only)

tag

@Nullable
public String tag

An identifier similar to 'group' but usable for different purposes (Android only).

threadIdentifier

@Nullable
public String threadIdentifier

An identifier similar to 'group' but usable for different purposes (iOS only).

title

@NonNull
public final String title

The notification's title.

titleLocArgs

@Nullable
public List<String> titleLocArgs

Variable string values to be used in place of the format specifiers in titleLocArgs to use to localize the title text to the user's current localization.

titleLocKey

@Nullable
public String titleLocKey

The key to the title string in the app's string resources to use to localize the title text to the user's current localization.

trigger

@NonNull
public final MessageNotificationTrigger trigger

The trigger that raised the notification message.

Constructor Detail

MessageNotification

public MessageNotification(@NonNull
                           String title,
                           @NonNull
                           String body,
                           @NonNull
                           MessageNotificationTrigger trigger)

Creates a Message Notification event that represents a push notification or a local notification.

Parameters:

title - Title of message notification.

body - Body content of the message notification.

trigger - The trigger that raised this notification: remote notification (push), position related (location), date-time related (calendar, timeInterval) or app generated (other).

Method Detail

action

@NonNull
public MessageNotification action(@Nullable
                                           String action)

The action associated with the notification.

attachments

@NonNull
public MessageNotification attachments(@Nullable
                                                List<MessageNotificationAttachment> attachments)

Attachments added to the notification (they can be part of the data object).

bodyLocArgs

@NonNull
public MessageNotification bodyLocArgs(@Nullable
                                                List<String> bodyLocArgs)

Variable string values to be used in place of the format specifiers in bodyLocArgs to use to localize the body text to the user's current localization.

bodyLocKey

@NonNull
public MessageNotification bodyLocKey(@Nullable
                                               String bodyLocKey)

The key to the body string in the app's string resources to use to localize the body text to the user's current localization.

category

@NonNull
public MessageNotification category(@Nullable
                                             String category)

The category associated to the notification.

contentAvailable

@NonNull
public MessageNotification contentAvailable(@Nullable
                                                     Boolean contentAvailable)

The application is notified of the delivery of the notification if it's in the foreground or background, the app will be woken up (iOS only).

group

@NonNull
public MessageNotification group(@Nullable
                                          String group)

The group which this notification is part of.

icon

@NonNull
public MessageNotification icon(@Nullable
                                         String icon)

The icon associated to the notification (Android only).

notificationCount

@NonNull
public MessageNotification notificationCount(@Nullable
                                                      Integer notificationCount)

The number of items this notification represents.

notificationTimestamp

@NonNull
public MessageNotification notificationTimestamp(@Nullable
                                                          String notificationTimestamp)

The time when the event of the notification occurred.

sound

@NonNull
public MessageNotification sound(@Nullable
                                          String sound)

The sound played when the device receives the notification.

subtitle

@NonNull
public MessageNotification subtitle(@Nullable
                                             String subtitle)

The notification's subtitle. (iOS only)

tag

@NonNull
public MessageNotification tag(@Nullable
                                        String tag)

An identifier similar to 'group' but usable for different purposes (Android only).

threadIdentifier

@NonNull
public MessageNotification threadIdentifier(@Nullable
                                                     String threadIdentifier)

An identifier similar to 'group' but usable for different purposes (iOS only).

titleLocArgs

@NonNull
public MessageNotification titleLocArgs(@Nullable
                                                 List<String> titleLocArgs)

Variable string values to be used in place of the format specifiers in titleLocArgs to use to localize the title text to the user's current localization.

titleLocKey

@NonNull
public MessageNotification titleLocKey(@Nullable
                                                String titleLocKey)

The key to the title string in the app's string resources to use to localize the title text to the user's current localization.

getDataPayload

@NonNull
public Map<String,Object> getDataPayload()

Returns:

the event data payload

getSchema

@NonNull
public String getSchema()

Specified by:

getSchema in class AbstractSelfDescribing

Returns:

The schema of the event.