com.braze.push

Class BrazeNotificationFactory

java.lang.Object

com.braze.push.BrazeNotificationFactory

All Implemented Interfaces:

IBrazeNotificationFactory

Direct Known Subclasses:

AppboyNotificationFactory

public class BrazeNotificationFactory
extends java.lang.Object
implements IBrazeNotificationFactory

Constructor Summary

Constructors

Constructor and Description
BrazeNotificationFactory()

Method Summary

Modifier and Type	Method and Description
android.app.Notification	createNotification(AppboyConfigurationProvider appConfigurationProvider, android.content.Context context, android.os.Bundle notificationExtras, android.os.Bundle appboyExtras) Deprecated. Deprecated since 8/25/20
android.app.Notification	createNotification(BrazeNotificationPayload payload) Creates the rich notification.
static BrazeNotificationFactory	getInstance() Returns the singleton BrazeNotificationFactory instance.
NotificationCompat.Builder	populateNotificationBuilder(AppboyConfigurationProvider appboyConfigurationProvider, android.content.Context context, android.os.Bundle notificationExtras, android.os.Bundle appboyExtras) Deprecated. Please use populateNotificationBuilder(BrazeConfigurationProvider, Context, Bundle, Bundle) instead. Deprecated since 3/26/21
NotificationCompat.Builder	populateNotificationBuilder(BrazeConfigurationProvider configurationProvider, android.content.Context context, android.os.Bundle notificationExtras, android.os.Bundle appboyExtras) Equivalent to createNotification(BrazeNotificationPayload)
static NotificationCompat.Builder	populateNotificationBuilder(BrazeNotificationPayload payload) Returns a notification builder populated with all fields from the notification extras and Braze extras.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BrazeNotificationFactory

public BrazeNotificationFactory()

Method Detail

getInstance

public static BrazeNotificationFactory getInstance()

Returns the singleton BrazeNotificationFactory instance.

createNotification

@Deprecated
public android.app.Notification createNotification(AppboyConfigurationProvider appConfigurationProvider,
                                                               android.content.Context context,
                                                               android.os.Bundle notificationExtras,
                                                               android.os.Bundle appboyExtras)

Deprecated. Deprecated since 8/25/20

Description copied from interface: IBrazeNotificationFactory

Note that this method is only called if IBrazeNotificationFactory.createNotification(BrazeNotificationPayload) returns null as it is the preferred method moving forward.

Specified by:

createNotification in interface IBrazeNotificationFactory

Parameters:

appConfigurationProvider - Braze app configuration

context - Application context

notificationExtras - the original Bundle object passed to Braze by fcm/adm, potentially with additions or modifications.

appboyExtras - a Bundle object containing 'extra' key value pairs defined by the client

Returns:

a Notification object to be delivered to the notification area, or null if delivery to the notification center will be handled manually.

See Also:

IBrazeNotificationFactory.createNotification(BrazeNotificationPayload)

createNotification

public android.app.Notification createNotification(BrazeNotificationPayload payload)

Creates the rich notification. The notification content varies based on the Android version on the device, but each notification can contain an icon, image, title, and content. Opening a notification from the notification center triggers a broadcast message to be sent. The broadcast message action is .intent.APPBOY_NOTIFICATION_OPENED.

Specified by:

createNotification in interface IBrazeNotificationFactory

Parameters:

payload - A convenience wrapper object around the Braze notification payload.

Returns:

a Notification object to be delivered to the notification area, or null if delivery to the notification center will be handled manually.

populateNotificationBuilder

@Deprecated
public NotificationCompat.Builder populateNotificationBuilder(AppboyConfigurationProvider appboyConfigurationProvider,
                                                                          android.content.Context context,
                                                                          android.os.Bundle notificationExtras,
                                                                          android.os.Bundle appboyExtras)

Deprecated. Please use populateNotificationBuilder(BrazeConfigurationProvider, Context, Bundle, Bundle) instead. Deprecated since 3/26/21

populateNotificationBuilder

public NotificationCompat.Builder populateNotificationBuilder(BrazeConfigurationProvider configurationProvider,
                                                              android.content.Context context,
                                                              android.os.Bundle notificationExtras,
                                                              android.os.Bundle appboyExtras)

Equivalent to createNotification(BrazeNotificationPayload)

populateNotificationBuilder

public static NotificationCompat.Builder populateNotificationBuilder(BrazeNotificationPayload payload)

Returns a notification builder populated with all fields from the notification extras and Braze extras. To create a notification object, call `build()` on the returned builder instance.