com.braze

Interface IBrazeNotificationFactory

All Known Subinterfaces:

IAppboyNotificationFactory

All Known Implementing Classes:

AppboyNotificationFactory, BrazeNotificationFactory

public interface IBrazeNotificationFactory

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. Please use createNotification(BrazeNotificationPayload). Deprecated since 12/01/2020.
android.app.Notification	createNotification(BrazeNotificationPayload brazeNotificationPayload) The interface for a custom notification factory.

Method Detail

createNotification

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

Deprecated. Please use createNotification(BrazeNotificationPayload). Deprecated since 12/01/2020.

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

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:

createNotification(BrazeNotificationPayload)

createNotification

android.app.Notification createNotification(BrazeNotificationPayload brazeNotificationPayload)

The interface for a custom notification factory. Implementing this interface and registering an instance via Appboy#setCustomBrazeNotificationFactory(com.braze.IBrazeNotificationFactory) allows for custom modification or replacement of Braze push messages before they are deployed to the notification center.

Separate from notification object generation, it is also possible to handle deployment to the notification center itself manually (for example, to finely control what notification id is sent with the notification). When handling display manually, your notification factory should return null and also handle sending a push received broadcast intent and optionally waking the screen.

Note that #createNotification(com.braze.configuration.BrazeConfigurationProvider, Context, Bundle, Bundle) is only called if this method returns null for backwards compatibility reasons.

Parameters:

brazeNotificationPayload - 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.