snowplow-android-tracker/com.snowplowanalytics.snowplow.event/MessageNotification

MessageNotification

class MessageNotification(val title: String, val body: String, val trigger: MessageNotificationTrigger) : AbstractSelfDescribing

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

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).

Constructors

MessageNotification

constructor(title: String, body: String, trigger: MessageNotificationTrigger)

Types

object Companion

Functions

fun action(action: String?): MessageNotification

The action associated with the notification.

fun attachments(attachments: List<MessageNotificationAttachment>?): MessageNotification

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

fun bodyLocArgs(bodyLocArgs: List<String>?): MessageNotification

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.

fun bodyLocKey(bodyLocKey: String?): MessageNotification

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.

fun category(category: String?): MessageNotification

The category associated to the notification.

contentAvailable

fun contentAvailable(contentAvailable: Boolean?): MessageNotification

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).

fun ~~contexts~~(contexts: List<SelfDescribingJson>): AbstractEvent

Adds a list of context entities to the existing ones.

fun entities(entities: List<SelfDescribingJson>): AbstractEvent

Adds a list of context entities to the existing ones.

fun group(group: String?): MessageNotification

The group which this notification is part of.

fun icon(icon: String?): MessageNotification

The icon associated to the notification (Android only).

notificationCount

fun notificationCount(notificationCount: Int?): MessageNotification

The number of items this notification represents.

notificationTimestamp

fun notificationTimestamp(notificationTimestamp: String?): MessageNotification

The time when the event of the notification occurred.

fun sound(sound: String?): MessageNotification

The sound played when the device receives the notification.

fun subtitle(subtitle: String?): MessageNotification

The notification's subtitle. (iOS only)

fun tag(tag: String?): MessageNotification

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

threadIdentifier

fun threadIdentifier(threadIdentifier: String?): MessageNotification

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

fun titleLocArgs(titleLocArgs: List<String>?): MessageNotification

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.

fun titleLocKey(titleLocKey: String?): MessageNotification

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.

fun trueTimestamp(trueTimestamp: Long?): AbstractEvent

Set the custom timestamp of the event.

Properties

var action: String?

The action associated with the notification.

var attachments: List<MessageNotificationAttachment>?

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

val body: String

var bodyLocArgs: List<String>?

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.

var bodyLocKey: String?

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.

var category: String?

The category associated to the notification.

contentAvailable

var contentAvailable: Boolean?

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).

open override var ~~contexts~~: List<SelfDescribingJson>

open override val dataPayload: Map<String, Any?>

The payload for the event.

open override var entities: MutableList<SelfDescribingJson>

entitiesForProcessing

open val entitiesForProcessing: List<SelfDescribingJson>?

Used for events whose properties are added as entities, e.g. Ecommerce events

var group: String?

The group which this notification is part of.

var icon: String?

The icon associated to the notification (Android only).

notificationCount

var notificationCount: Int?

The number of items this notification represents.

notificationTimestamp

var notificationTimestamp: String?

The time when the event of the notification occurred.

open override val schema: String

var sound: String?

The sound played when the device receives the notification.

var subtitle: String?

The notification's subtitle. (iOS only)

var tag: String?

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

threadIdentifier

var threadIdentifier: String?

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

val title: String

var titleLocArgs: List<String>?

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.

var titleLocKey: String?

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.

val trigger: MessageNotificationTrigger

open override var trueTimestamp: Long?