Push Models Module/com.salesforce.marketingcloud.pushmodels

Package-level declarations

Types

Message

data class Message : Parcelable

MessageIdUpdatedEvent

class MessageIdUpdatedEvent(val messageId: String, val notificationId: Int) : SdkEvent

MessageUtils

sealed class MessageUtils

NotificationClickEvent

class NotificationClickEvent(notificationEvent: NotificationEvent, val actionType: String, val actionItemId: String, val title: String?) : NotificationEvent

NotificationDisplayedEvent

class NotificationDisplayedEvent(notificationEvent: NotificationEvent) : NotificationEvent

NotificationEvent

open class NotificationEvent(val source: Int, val destinations: Int, val buId: String, val notificationMessage: NotificationMessage) : PushEvent

Notification event

NotificationMessage

data class NotificationMessage : Parcelable

NotificationMessageAccessor

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

class NotificationMessageAccessor

NotificationOpenEvent

class NotificationOpenEvent(notificationEvent: NotificationEvent) : NotificationEvent

ParsedData

data class ParsedData(val source: Int, val destinations: Int, val buId: String?)

Helper method to parse a Base64 encoded string into its component parts Expected format: source:destination:buId

PushCapabilityEvent

class PushCapabilityEvent(val isPushSdkEnabled: Boolean, val hasSystemPermissions: Boolean) : PushEvent

This event is used to track the capability of the push SDK to receive push notifications.

PushEvent

abstract class PushEvent(sticky: Boolean = false) : SdkEvent

Push event base class.

PushKeys

object PushKeys

PushNotificationErrorEvent

class PushNotificationErrorEvent(val error: PushException, val messageId: String) : PushEvent

PushReceivedEvent

class PushReceivedEvent(val notificationEvent: NotificationEvent, val receivedTimestamp: Long, val sentTimestamp: Long, val messageType: String?, val pushData: Map<String, String>?) : NotificationEvent

PushTokenRefreshedEvent

class PushTokenRefreshedEvent(val token: String, val src: ModuleIdentifier = ModuleIdentifier.PUSH_FEATURE_MODULE) : PushEvent

Region

data class Region : Parcelable, Comparable<Region>

RegionNotificationEvent

class RegionNotificationEvent(val notificationMessage: NotificationMessage) : SdkEvent

Event published when a region-based notification needs to be displayed. This event is used to decouple region messaging (geofence/proximity) from notification display.

ShouldShowNotificationDecisionEvent

class ShouldShowNotificationDecisionEvent(val message: NotificationMessage, val messageShown: Boolean) : PushEvent

SilentPushEvent

class SilentPushEvent(val pushData: Map<String, String>, val receivedTimestamp: Long = System.currentTimeMillis()) : PushEvent

Event published when a silent/sync push message is received. This event is specifically for push messages which are silent

Functions

asNotificationClickEvent

fun NotificationMessage.asNotificationClickEvent(base64EncodedData: String? = this.context, receivedTimestamp: Long = System.currentTimeMillis(), sentTimestamp: Long = System.currentTimeMillis(), actionType: String, actionItemId: String, title: String?): NotificationClickEvent

Direct extension to create a NotificationClickEvent from a NotificationMessage Uses toNotificationEvent() for base event and adds actionType, actionItemId, and title

asNotificationDisplayedEvent

fun NotificationMessage.asNotificationDisplayedEvent(base64EncodedData: String? = this.context, receivedTimestamp: Long = System.currentTimeMillis(), sentTimestamp: Long = System.currentTimeMillis()): NotificationDisplayedEvent

Direct extension to create a NotificationDisplayedEvent from a NotificationMessage Uses toNotificationEvent() to create the base event

asNotificationOpenEvent

fun NotificationMessage.asNotificationOpenEvent(base64EncodedData: String? = this.context, receivedTimestamp: Long = System.currentTimeMillis(), sentTimestamp: Long = System.currentTimeMillis()): NotificationOpenEvent

Direct extension to create a NotificationOpenEvent from a NotificationMessage Uses toNotificationEvent() to create the base event

asPushReceivedEvent

fun NotificationMessage.asPushReceivedEvent(base64EncodedData: String? = this.context, receivedTimestamp: Long = System.currentTimeMillis(), sentTimestamp: Long = System.currentTimeMillis(), messageType: String?, pushData: Map<String, String>?): PushReceivedEvent

Direct extension to create a PushReceivedEvent from a NotificationMessage Uses toNotificationEvent() for base event and adds receivedTimestamp, sentTimestamp, and messageType

isNotificationEventForDestination

fun SdkEvent.isNotificationEventForDestination(destination: Int): Boolean

parseBase64EncodedData

fun parseBase64EncodedData(base64EncodedData: String?): ParsedData

shouldHandleForEngagement

fun SilentPushEvent.shouldHandleForEngagement(): Boolean

Extension function to check if a SilentPushEvent should be handled for ENGAGEMENT destination.

toNotificationClickEvent

fun NotificationEvent.toNotificationClickEvent(actionType: String, actionItemId: String, title: String?): NotificationClickEvent

toNotificationDisplayedEvent

fun NotificationEvent.toNotificationDisplayedEvent(): NotificationDisplayedEvent

toNotificationEvent

fun NotificationMessage.toNotificationEvent(base64EncodedData: String? = this.context, receivedTimestamp: Long = System.currentTimeMillis(), sentTimestamp: Long = System.currentTimeMillis()): NotificationEvent

Extension function to create a PushReceivedEvent from a NotificationMessage Parses a Base64 encoded string to extract source, destination, mid, and tenantid

toNotificationOpenEvent

fun NotificationEvent.toNotificationOpenEvent(): NotificationOpenEvent

toPushReceivedEvent

fun NotificationEvent.toPushReceivedEvent(receivedTimestamp: Long, sentTimestamp: Long, messageType: String?, pushData: Map<String, String>?): PushReceivedEvent