NotificationMessage

Package: com.salesforce.marketingcloud.notifications

Inheritance: Parcelable

A data class representing a notification message in the Salesforce Marketing Cloud SDK.

1data class NotificationMessage : Parcelable

1enum Sound : Enum<NotificationMessage.Sound>

Enumeration for notification sound types.

1enum Trigger : Enum<NotificationMessage.Trigger>

Enumeration for notification trigger types.

1enum Type : Enum<NotificationMessage.Type>

Enumeration for notification message types.

1@JvmField
2val alert: String

The alert message text.

1@JvmField
2val custom: String?

Custom data associated with the notification (nullable).

1@JvmField
2val customKeys: Map<String, String>

A map of custom key-value pairs.

1@JvmField
2val id: String

The unique identifier for the notification message.

1@JvmField
2val mediaAltText: String?

Alternative text for media content (nullable).

1@JvmField
2val mediaUrl: String?

URL for media content (nullable).

1@JvmField
2val payload: Map<String, String>?

Additional payload data as a map (nullable).

1@JvmField
2val region: Region?

The geographic region associated with the notification (nullable).

1@JvmField
2val requestId: String?

The request identifier (nullable).

1@JvmField
2val richFeatures: RichFeatures?

Rich notification features (nullable).

1@JvmField
2val sound: NotificationMessage.Sound

The sound setting for the notification.

1@JvmField
2val soundName: String?

The name of the custom sound file (nullable).

1@JvmField
2val subtitle: String?

The notification subtitle (nullable).

1@JvmField
2val title: String?

The notification title (nullable).

1@JvmField
2val trigger: NotificationMessage.Trigger

The trigger type for the notification.

1@JvmField
2val type: NotificationMessage.Type

The type of notification message.

1@JvmField
2val url: String?

URL associated with the notification (nullable).

1fun toJson(): JSONObject

Converts the notification message to a JSON object.

Returns: A JSONObject representation of the notification message.