PushFeatureConfig

com.salesforce.marketingcloud.pushfeature.config

A data class that extends PushFeatureModuleConfig to configure push notification functionality for the Salesforce Marketing Cloud SDK. It provides settings for Firebase Cloud Messaging integration, notification customization, URL handling, and notification filtering.

  • Extends: PushFeatureModuleConfig

The Firebase Cloud Messaging sender ID for push notifications. This is required for FCM integration.

Configuration options for customizing notification appearance and behavior, including icon, sound, LED color, and other visual elements.

Optional handler for processing URLs from push notifications. Implement this interface to customize URL handling behavior.

Optional listener for filtering or controlling whether notifications should be displayed. Allows dynamic control of notification visibility based on custom logic.

Creates a new Builder instance initialized with the current configuration values.

Returns: A Builder with current configuration values

Builder class for constructing PushFeatureConfig instances using a fluent API pattern.

setSenderId

Sets the Firebase Cloud Messaging sender ID.

Parameters:

  • senderId - The FCM sender ID (typically a 12-digit number)

Returns: The Builder instance for method chaining

setNotificationCustomizationOptions

Sets the notification customization options.

Parameters:

  • options - NotificationCustomizationOptions instance with customization settings

Returns: The Builder instance for method chaining

setUrlHandler

Sets the URL handler for processing notification URLs.

Parameters:

  • handler - UrlHandler implementation or null

Returns: The Builder instance for method chaining

setShouldShowNotificationListener

Sets the listener for controlling notification visibility.

Parameters:

  • listener - ShouldShowNotificationListener implementation or null

Returns: The Builder instance for method chaining

build

Finalizes the configuration and creates the PushFeatureConfig instance.

Returns: A new PushFeatureConfig instance with the specified configuration

Companion object providing factory methods for creating Builder instances.

builder

Creates a new Builder instance for constructing a PushFeatureConfig.

Returns: A new PushFeatureConfig.Builder instance

  • PushFeature - The main push feature module
  • PushFeatureModuleConfig - Parent configuration class
  • NotificationCustomizationOptions - Notification customization settings
  • UrlHandler - Interface for handling URLs from notifications
  • NotificationManager.ShouldShowNotificationListener - Interface for notification filtering