Marketing Cloud SDK/com.salesforce.marketingcloud.notifications/NotificationCustomizationOptions

NotificationCustomizationOptions

open class NotificationCustomizationOptions

The class holds any notification customization options allowed by the SDK. It is designed to make understanding and customizing notifications easier than in previous versions of the SDK. With this you can elect to take one of two possible options for customization:

Option one is a guided approach where in you can provide, at a minimum, the resource ID for the notification's small icon. Optionally, you could provide a NotificationManager.NotificationLaunchIntentProvider to customize the destination of a notification when clicked, and/or a NotificationManager.NotificationChannelIdProvider to specify on a per message basis which notification channel will be assigned to the notification.

Option two will require you to provide a NotificationManager.NotificationBuilder in which you will be responsible for the entire process of setting up the notification. These responsibilities include, but are not limited to:

  • Creation of the androidx.core.app.NotificationCompat.Builder
  • Assignment of the notification channel
  • Redirecting any launch intents to the SDK for open analytic recording. See: redirectIntentForAnalytics
The SDK will still display the notification with this option.

See also

Properties

Link copied to clipboard

Functions

Link copied to clipboard
@NonNull
open fun create(@NonNull notificationBuilder: NotificationManager.NotificationBuilder): NotificationCustomizationOptions
Creates a NotificationCustomizationOptions with only a NotificationManager.NotificationBuilder.
@NonNull
open fun create(@DrawableRes smallIconResId: Int): NotificationCustomizationOptions
Creates a NotificationCustomizationOptions with only the notification's small icon resource id.
@NonNull
open fun create(@DrawableRes smallIconResId: Int, @Nullable launchIntentProvider: NotificationManager.NotificationLaunchIntentProvider, @Nullable channelIdProvider: NotificationManager.NotificationChannelIdProvider): NotificationCustomizationOptions
Created a NotificationCustomizationOptions with the notification's small icon resource id and optional instances of NotificationManager.NotificationLaunchIntentProvider and NotificationManager.NotificationChannelIdProvider.
Link copied to clipboard
@NonNull
open fun toString(): String