com.braze.push

Class BrazeNotificationUtils

java.lang.Object

com.braze.push.BrazeNotificationUtils

Direct Known Subclasses:

AppboyNotificationUtils

public class BrazeNotificationUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPBOY_NOTIFICATION_DELETED_SUFFIX Deprecated. Please Constants.BRAZE_PUSH_INTENT_NOTIFICATION_DELETED. Deprecated since 6/25/21
static java.lang.String	APPBOY_NOTIFICATION_OPENED_SUFFIX Deprecated. Please see Constants.BRAZE_PUSH_INTENT_NOTIFICATION_OPENED. Deprecated since 6/25/21
static java.lang.String	APPBOY_NOTIFICATION_RECEIVED_SUFFIX Deprecated. Please Constants.BRAZE_PUSH_INTENT_NOTIFICATION_OPENED. Deprecated since 6/25/21

Constructor Summary

Constructors

Constructor and Description
BrazeNotificationUtils()

Method Summary

Modifier and Type	Method and Description
static void	cancelNotification(android.content.Context context, int notificationId) Creates a request to cancel a push notification in the notification center.
static IBrazeNotificationFactory	getActiveNotificationFactory() Returns a custom AppboyNotificationFactory if set, else the default AppboyNotificationFactory
static android.os.Bundle	getAppboyExtrasWithoutPreprocessing(android.os.Bundle notificationExtras) Deprecated. Please use BrazeNotificationPayload.getAttachedAppboyExtras(Bundle)
static int	getNotificationId(BrazeNotificationPayload payload) Returns an id for the new notification we'll send to the notification center.
static int	getNotificationId(android.os.Bundle notificationExtras) Deprecated. Please use getNotificationId(BrazeNotificationPayload)
static int	getNotificationPriority(android.os.Bundle notificationExtras) This method will retrieve notification priority from notificationExtras bundle if it has been set.
static java.lang.Class<?>	getNotificationReceiverClass()
static java.lang.String	getOrCreateNotificationChannelId(BrazeNotificationPayload payload) Returns the channel id for a valid NotificationChannel, creating one if necessary.
static java.lang.String	getOrCreateNotificationChannelId(android.content.Context context, BrazeConfigurationProvider appConfigurationProvider, android.os.Bundle notificationExtras) Deprecated. Please use getOrCreateNotificationChannelId(BrazeNotificationPayload)
static void	handleCancelNotificationAction(android.content.Context context, android.content.Intent intent) Handles a request to cancel a push notification in the notification center.
static void	handleContentCardsSerializedCardIfPresent(BrazeNotificationPayload payload) Parses the notification bundle for any associated ContentCards, if present.
static void	handleNotificationDeleted(android.content.Context context, android.content.Intent intent) Handles a push notification deletion by the user.
static void	handleNotificationOpened(android.content.Context context, android.content.Intent intent) Handles a push notification click.
static void	handlePushStoryPageClicked(android.content.Context context, android.content.Intent intent) Handles a push story page click.
static boolean	isAppboyPushMessage(android.content.Intent intent) Checks the incoming FCM/ADM intent to determine whether this is a Braze push message.
static boolean	isInAppMessageTestPush(android.content.Intent intent) Checks if a push Intent contains extras found in a test push for in-app messages.
static boolean	isNotificationMessage(android.content.Intent intent) Checks the intent received from FCM to determine whether this is a notification message or a silent push.
static boolean	isUninstallTrackingPush(android.os.Bundle notificationExtras) Returns true if the bundle is from a push sent by Braze for uninstall tracking.
static boolean	isValidNotificationVisibility(int visibility) Checks whether the given integer value is a valid Android notification visibility constant.
static void	logBaiduNotificationClick(android.content.Context context, java.lang.String customContentString) Logs a notification click with Braze if the extras passed down indicate that they are from Braze and contain a campaign Id.
static android.os.Bundle	parseJSONStringDictionaryIntoBundle(java.lang.String jsonStringDictionary) Deprecated. Please use JsonUtils.parseJsonObjectIntoBundle(String)
static void	prefetchBitmapsIfNewlyReceivedStoryPush(android.content.Context context, android.os.Bundle notificationExtras, android.os.Bundle appboyExtras) Checks that the notification is a story that has only just been received.
static boolean	requestGeofenceRefreshIfAppropriate(android.content.Context context, android.os.Bundle notificationExtras) Requests a geofence refresh from Braze if appropriate based on the payload of the push notification.
static void	routeUserWithNotificationOpenedIntent(android.content.Context context, android.content.Intent intent) Opens any available deep links with an Intent.ACTION_VIEW intent, placing the main activity on the back stack.
static void	sendPushMessageReceivedBroadcast(android.content.Context context, android.os.Bundle notificationExtras) Creates and sends a broadcast message that can be listened for by the host app.
static void	setAccentColorIfPresentAndSupported(BrazeConfigurationProvider appConfigurationProvider, NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setAccentColorIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)
static void	setAccentColorIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Set accent color for devices on Lollipop and above.
static void	setCategoryIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Set category for devices on Lollipop and above.
static void	setCategoryIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setCategoryIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)
static void	setContentIfPresent(BrazeConfigurationProvider configurationProvider, NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setContentIfPresent(NotificationCompat.Builder, BrazeNotificationPayload) instead.
static void	setContentIfPresent(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Sets notification content if it exists in the payload.
static void	setContentIntentIfPresent(android.content.Context context, NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Create broadcast intent that will fire when the notification has been opened.
static void	setDeleteIntent(android.content.Context context, NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras)
static boolean	setLargeIconIfPresentAndSupported(android.content.Context context, BrazeConfigurationProvider appConfigurationProvider, NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setLargeIconIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)
static boolean	setLargeIconIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Set large icon.
static void	setNotificationBadgeNumberIfPresent(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Sets the notification number, set via NotificationCompat.Builder#setNumber(int).
static void	setNotificationBadgeNumberIfPresent(NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setNotificationBadgeNumberIfPresent(NotificationCompat.Builder, BrazeNotificationPayload)
static void	setNotificationChannelIfSupported(android.content.Context context, BrazeConfigurationProvider appConfigurationProvider, NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. The channel id should be set in NotificationCompat.Builder#Builder(Context, String)
static void	setNotificationDurationAlarm(android.content.Context context, java.lang.Class<?> thisClass, int notificationId, int durationInMillis) Creates an alarm which will issue a broadcast to cancel the notification specified by the given notificationId after the given duration.
static void	setPriorityIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Sets the priority of the notification if a priority is present in the notification extras.
static void	setPublicVersionIfPresentAndSupported(android.content.Context context, BrazeConfigurationProvider configurationProvider, NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setPublicVersionIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)
static void	setPublicVersionIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Set the public version of the notification for notifications with private visibility.
static void	setSetShowWhen(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) This method exists to disable NotificationCompat.Builder#setShowWhen(boolean) for push stories.
static void	setSetShowWhen(NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setSetShowWhen(NotificationCompat.Builder, BrazeNotificationPayload)
static int	setSmallIcon(BrazeConfigurationProvider appConfigurationProvider, NotificationCompat.Builder notificationBuilder) Sets the icon used in the notification bar itself.
static void	setSoundIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Notifications can optionally include a sound to play when the notification is delivered.
static void	setSoundIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setSoundIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)
static void	setStyleIfSupported(android.content.Context context, NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras, android.os.Bundle appboyExtras) Deprecated. Please use BrazeNotificationStyleFactory.setStyleIfSupported(NotificationCompat.Builder, BrazeNotificationPayload)
static void	setSummaryTextIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Sets the subText of the notification if a summary is present in the notification extras.
static void	setSummaryTextIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setSummaryTextIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)
static void	setTickerIfPresent(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Sets notification ticker to the title if it exists in the notificationExtras.
static void	setTickerIfPresent(NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setTickerIfPresent(NotificationCompat.Builder, BrazeNotificationPayload)
static void	setTitleIfPresent(BrazeConfigurationProvider configurationProvider, NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setTitleIfPresent(NotificationCompat.Builder, BrazeNotificationPayload) instead.
static void	setTitleIfPresent(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload)
static void	setVisibilityIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, BrazeNotificationPayload payload) Set visibility for devices on Lollipop and above.
static void	setVisibilityIfPresentAndSupported(NotificationCompat.Builder notificationBuilder, android.os.Bundle notificationExtras) Deprecated. Please use setVisibilityIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)
static boolean	wakeScreenIfAppropriate(android.content.Context context, BrazeConfigurationProvider configurationProvider, android.os.Bundle notificationExtras) This method will wake the device using a wake lock if the Manifest.permission.WAKE_LOCK permission is present in the manifest.

Methods inherited from class java.lang.Object

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

Field Detail

APPBOY_NOTIFICATION_OPENED_SUFFIX

@Deprecated
public static final java.lang.String APPBOY_NOTIFICATION_OPENED_SUFFIX

Deprecated. Please see Constants.BRAZE_PUSH_INTENT_NOTIFICATION_OPENED. Deprecated since 6/25/21

See Also:

Constant Field Values

APPBOY_NOTIFICATION_RECEIVED_SUFFIX

@Deprecated
public static final java.lang.String APPBOY_NOTIFICATION_RECEIVED_SUFFIX

Deprecated. Please Constants.BRAZE_PUSH_INTENT_NOTIFICATION_OPENED. Deprecated since 6/25/21

See Also:

Constant Field Values

APPBOY_NOTIFICATION_DELETED_SUFFIX

@Deprecated
public static final java.lang.String APPBOY_NOTIFICATION_DELETED_SUFFIX

Deprecated. Please Constants.BRAZE_PUSH_INTENT_NOTIFICATION_DELETED. Deprecated since 6/25/21

See Also:

Constant Field Values

Constructor Detail

BrazeNotificationUtils

public BrazeNotificationUtils()

Method Detail

handleNotificationOpened

public static void handleNotificationOpened(android.content.Context context,
                                            android.content.Intent intent)

Handles a push notification click. Called by FCM/ADM receiver when a Braze push notification click intent is received.

See sendNotificationOpenedBroadcast(android.content.Context, android.content.Intent)

Parameters:

context - Application context

intent - the internal notification clicked intent constructed in setContentIntentIfPresent(android.content.Context, NotificationCompat.Builder, android.os.Bundle)

handleNotificationDeleted

public static void handleNotificationDeleted(android.content.Context context,
                                             android.content.Intent intent)

Handles a push notification deletion by the user. Called by FCM/ADM receiver when a Braze push notification delete intent is received.

See NotificationCompat.Builder#setDeleteIntent(PendingIntent)

Parameters:

context - Application context

intent - the internal notification delete intent constructed in setDeleteIntent(Context, NotificationCompat.Builder, Bundle)

routeUserWithNotificationOpenedIntent

public static void routeUserWithNotificationOpenedIntent(android.content.Context context,
                                                         android.content.Intent intent)

Opens any available deep links with an Intent.ACTION_VIEW intent, placing the main activity on the back stack. If no deep link is available, opens the main activity.

Parameters:

context -

intent - the internal notification clicked intent constructed in setContentIntentIfPresent(android.content.Context, NotificationCompat.Builder, android.os.Bundle)

getAppboyExtrasWithoutPreprocessing

@Deprecated
public static android.os.Bundle getAppboyExtrasWithoutPreprocessing(android.os.Bundle notificationExtras)

Deprecated. Please use BrazeNotificationPayload.getAttachedAppboyExtras(Bundle)

parseJSONStringDictionaryIntoBundle

@Deprecated
public static android.os.Bundle parseJSONStringDictionaryIntoBundle(java.lang.String jsonStringDictionary)

Deprecated. Please use JsonUtils.parseJsonObjectIntoBundle(String)

isAppboyPushMessage

public static boolean isAppboyPushMessage(android.content.Intent intent)

Checks the incoming FCM/ADM intent to determine whether this is a Braze push message.

All Braze push messages must contain an extras entry with key set to "_ab" and value set to "true".

isNotificationMessage

public static boolean isNotificationMessage(android.content.Intent intent)

Checks the intent received from FCM to determine whether this is a notification message or a silent push.

A notification message is a Braze push message that displays a notification in the notification center (and optionally contains extra information that can be used directly by the app).

A silent push is a Braze push message that contains only extra information that can be used directly by the app.

sendPushMessageReceivedBroadcast

public static void sendPushMessageReceivedBroadcast(android.content.Context context,
                                                    android.os.Bundle notificationExtras)

Creates and sends a broadcast message that can be listened for by the host app. The broadcast message intent contains all of the data sent as part of the Braze push message. The broadcast message action is .intent.APPBOY_PUSH_RECEIVED.

requestGeofenceRefreshIfAppropriate

public static boolean requestGeofenceRefreshIfAppropriate(android.content.Context context,
                                                          android.os.Bundle notificationExtras)

Requests a geofence refresh from Braze if appropriate based on the payload of the push notification.

Parameters:

context -

notificationExtras - Notification extras as provided by FCM/ADM.

Returns:

True iff a geofence refresh was requested from Appboy.

setNotificationDurationAlarm

public static void setNotificationDurationAlarm(android.content.Context context,
                                                java.lang.Class<?> thisClass,
                                                int notificationId,
                                                int durationInMillis)

Creates an alarm which will issue a broadcast to cancel the notification specified by the given notificationId after the given duration.

getNotificationId

@Deprecated
public static int getNotificationId(android.os.Bundle notificationExtras)

Deprecated. Please use getNotificationId(BrazeNotificationPayload)

getNotificationId

public static int getNotificationId(BrazeNotificationPayload payload)

Returns an id for the new notification we'll send to the notification center. Notification id is used by the Android OS to override currently active notifications with identical ids. If a custom notification id is not defined in the payload, Braze derives an id value from the message's contents to prevent duplication in the notification center.

getNotificationPriority

public static int getNotificationPriority(android.os.Bundle notificationExtras)

This method will retrieve notification priority from notificationExtras bundle if it has been set. Otherwise returns the default priority.

Starting with Android O, priority is set on a notification channel and not individually on notifications.

wakeScreenIfAppropriate

public static boolean wakeScreenIfAppropriate(android.content.Context context,
                                              BrazeConfigurationProvider configurationProvider,
                                              android.os.Bundle notificationExtras)

This method will wake the device using a wake lock if the Manifest.permission.WAKE_LOCK permission is present in the manifest. If the permission is not present, this does nothing. If the screen is already on, and the permission is present, this does nothing. If the priority of the incoming notification is min, this does nothing.

getActiveNotificationFactory

public static IBrazeNotificationFactory getActiveNotificationFactory()

Returns a custom AppboyNotificationFactory if set, else the default AppboyNotificationFactory

prefetchBitmapsIfNewlyReceivedStoryPush

public static void prefetchBitmapsIfNewlyReceivedStoryPush(android.content.Context context,
                                                           android.os.Bundle notificationExtras,
                                                           android.os.Bundle appboyExtras)

Checks that the notification is a story that has only just been received. If so, each image within the story is put in the Braze image loader's cache.

Parameters:

context - Application context.

notificationExtras - Notification extras as provided by FCM/ADM.

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

setTitleIfPresent

@Deprecated
public static void setTitleIfPresent(BrazeConfigurationProvider configurationProvider,
                                                 NotificationCompat.Builder notificationBuilder,
                                                 android.os.Bundle notificationExtras)

Deprecated. Please use setTitleIfPresent(NotificationCompat.Builder, BrazeNotificationPayload) instead.

setTitleIfPresent

public static void setTitleIfPresent(NotificationCompat.Builder notificationBuilder,
                                     BrazeNotificationPayload payload)

setContentIfPresent

@Deprecated
public static void setContentIfPresent(BrazeConfigurationProvider configurationProvider,
                                                   NotificationCompat.Builder notificationBuilder,
                                                   android.os.Bundle notificationExtras)

Deprecated. Please use setContentIfPresent(NotificationCompat.Builder, BrazeNotificationPayload) instead.

setContentIfPresent

public static void setContentIfPresent(NotificationCompat.Builder notificationBuilder,
                                       BrazeNotificationPayload payload)

Sets notification content if it exists in the payload.

setTickerIfPresent

@Deprecated
public static void setTickerIfPresent(NotificationCompat.Builder notificationBuilder,
                                                  android.os.Bundle notificationExtras)

Deprecated. Please use setTickerIfPresent(NotificationCompat.Builder, BrazeNotificationPayload)

Sets notification ticker to the title if it exists in the notificationExtras.

setTickerIfPresent

public static void setTickerIfPresent(NotificationCompat.Builder notificationBuilder,
                                      BrazeNotificationPayload payload)

Sets notification ticker to the title if it exists in the notificationExtras.

setContentIntentIfPresent

public static void setContentIntentIfPresent(android.content.Context context,
                                             NotificationCompat.Builder notificationBuilder,
                                             android.os.Bundle notificationExtras)

Create broadcast intent that will fire when the notification has been opened. The FCM or ADM receiver will be notified, log a click, then send a broadcast to the client receiver.

Parameters:

context -

notificationBuilder -

notificationExtras -

setDeleteIntent

public static void setDeleteIntent(android.content.Context context,
                                   NotificationCompat.Builder notificationBuilder,
                                   android.os.Bundle notificationExtras)

setSmallIcon

public static int setSmallIcon(BrazeConfigurationProvider appConfigurationProvider,
                               NotificationCompat.Builder notificationBuilder)

Sets the icon used in the notification bar itself. If a drawable defined in braze.xml is found, we use that. Otherwise, fall back to the application icon.

Returns:

the resource id of the small icon to be used.

setSetShowWhen

@Deprecated
public static void setSetShowWhen(NotificationCompat.Builder notificationBuilder,
                                              android.os.Bundle notificationExtras)

Deprecated. Please use setSetShowWhen(NotificationCompat.Builder, BrazeNotificationPayload)

setSetShowWhen

public static void setSetShowWhen(NotificationCompat.Builder notificationBuilder,
                                  BrazeNotificationPayload payload)

This method exists to disable NotificationCompat.Builder#setShowWhen(boolean) for push stories.

setLargeIconIfPresentAndSupported

@Deprecated
public static boolean setLargeIconIfPresentAndSupported(android.content.Context context,
                                                                    BrazeConfigurationProvider appConfigurationProvider,
                                                                    NotificationCompat.Builder notificationBuilder,
                                                                    android.os.Bundle notificationExtras)

Deprecated. Please use setLargeIconIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)

setLargeIconIfPresentAndSupported

public static boolean setLargeIconIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                        BrazeNotificationPayload payload)

Set large icon. We use the large icon URL if it exists in the notificationExtras. Otherwise we search for a drawable defined in braze.xml. If that doesn't exists, we do nothing.

Returns:

whether a large icon was successfully set.

setSoundIfPresentAndSupported

@Deprecated
public static void setSoundIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                             android.os.Bundle notificationExtras)

Deprecated. Please use setSoundIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)

setSoundIfPresentAndSupported

public static void setSoundIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                 BrazeNotificationPayload payload)

Notifications can optionally include a sound to play when the notification is delivered.

Starting with Android O, sound is set on a notification channel and not individually on notifications.

setSummaryTextIfPresentAndSupported

@Deprecated
public static void setSummaryTextIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                                   android.os.Bundle notificationExtras)

Deprecated. Please use setSummaryTextIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)

setSummaryTextIfPresentAndSupported

public static void setSummaryTextIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                       BrazeNotificationPayload payload)

Sets the subText of the notification if a summary is present in the notification extras.

Supported on JellyBean+.

setPriorityIfPresentAndSupported

public static void setPriorityIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                    android.os.Bundle notificationExtras)

Sets the priority of the notification if a priority is present in the notification extras.

Supported JellyBean+.

Starting with Android O, priority is set on a notification channel and not individually on notifications.

setStyleIfSupported

@Deprecated
public static void setStyleIfSupported(android.content.Context context,
                                                   NotificationCompat.Builder notificationBuilder,
                                                   android.os.Bundle notificationExtras,
                                                   android.os.Bundle appboyExtras)

Deprecated. Please use BrazeNotificationStyleFactory.setStyleIfSupported(NotificationCompat.Builder, BrazeNotificationPayload)

setAccentColorIfPresentAndSupported

@Deprecated
public static void setAccentColorIfPresentAndSupported(BrazeConfigurationProvider appConfigurationProvider,
                                                                   NotificationCompat.Builder notificationBuilder,
                                                                   android.os.Bundle notificationExtras)

Deprecated. Please use setAccentColorIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)

setAccentColorIfPresentAndSupported

public static void setAccentColorIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                       BrazeNotificationPayload payload)

Set accent color for devices on Lollipop and above. We use the push-specific accent color if it exists in the notificationExtras, otherwise we search for a default set in braze.xml or don't set the color at all (and the system notification gray default is used).

Supported Lollipop+.

setCategoryIfPresentAndSupported

@Deprecated
public static void setCategoryIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                                android.os.Bundle notificationExtras)

Deprecated. Please use setCategoryIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)

setCategoryIfPresentAndSupported

public static void setCategoryIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                    BrazeNotificationPayload payload)

Set category for devices on Lollipop and above. Category is one of the predefined notification categories (see the CATEGORY_* constants in Notification) that best describes a Notification. May be used by the system for ranking and filtering.

Supported Lollipop+.

setVisibilityIfPresentAndSupported

@Deprecated
public static void setVisibilityIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                                  android.os.Bundle notificationExtras)

Deprecated. Please use setVisibilityIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)

setVisibilityIfPresentAndSupported

public static void setVisibilityIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                      BrazeNotificationPayload payload)

Set visibility for devices on Lollipop and above.

Sphere of visibility of this notification, which affects how and when the SystemUI reveals the notification's presence and contents in untrusted situations (namely, on the secure lockscreen). The default level, VISIBILITY_PRIVATE, behaves exactly as notifications have always done on Android: The notification's icon and tickerText (if available) are shown in all situations, but the contents are only available if the device is unlocked for the appropriate user. A more permissive policy can be expressed by VISIBILITY_PUBLIC; such a notification can be read even in an "insecure" context (that is, above a secure lockscreen). To modify the public version of this notification—for example, to redact some portions—see setPublicVersion(Notification). Finally, a notification can be made VISIBILITY_SECRET, which will suppress its icon and ticker until the user has bypassed the lockscreen.

Supported Lollipop+.

setPublicVersionIfPresentAndSupported

@Deprecated
public static void setPublicVersionIfPresentAndSupported(android.content.Context context,
                                                                     BrazeConfigurationProvider configurationProvider,
                                                                     NotificationCompat.Builder notificationBuilder,
                                                                     android.os.Bundle notificationExtras)

Deprecated. Please use setPublicVersionIfPresentAndSupported(NotificationCompat.Builder, BrazeNotificationPayload)

setPublicVersionIfPresentAndSupported

public static void setPublicVersionIfPresentAndSupported(NotificationCompat.Builder notificationBuilder,
                                                         BrazeNotificationPayload payload)

Set the public version of the notification for notifications with private visibility.

Supported Lollipop+.

isValidNotificationVisibility

public static boolean isValidNotificationVisibility(int visibility)

Checks whether the given integer value is a valid Android notification visibility constant.

logBaiduNotificationClick

public static void logBaiduNotificationClick(android.content.Context context,
                                             java.lang.String customContentString)

Logs a notification click with Braze if the extras passed down indicate that they are from Braze and contain a campaign Id.

A Braze session must be active to log a push notification.

Parameters:

customContentString - extra key value pairs in JSON format.

handleCancelNotificationAction

public static void handleCancelNotificationAction(android.content.Context context,
                                                  android.content.Intent intent)

Handles a request to cancel a push notification in the notification center. Called by FCM/ADM receiver when a Braze cancel notification intent is received.

Any existing notification in the notification center with the integer Id specified in the "nid" field of the provided intent's extras is cancelled.

If no Id is found, the defaut Braze notification Id is used.

Parameters:

context -

intent - the cancel notification intent

cancelNotification

public static void cancelNotification(android.content.Context context,
                                      int notificationId)

Creates a request to cancel a push notification in the notification center.

Sends an intent to the FCM/ADM receiver requesting Braze to cancel the notification with the specified notification Id.

See handleCancelNotificationAction(android.content.Context, android.content.Intent)

Parameters:

context -

notificationId -

getNotificationReceiverClass

public static java.lang.Class<?> getNotificationReceiverClass()

Returns:

the Class of the notification receiver used by this application.

isUninstallTrackingPush

public static boolean isUninstallTrackingPush(android.os.Bundle notificationExtras)

Returns true if the bundle is from a push sent by Braze for uninstall tracking. Uninstall tracking push can be ignored.

Parameters:

notificationExtras - A notificationExtras bundle that is passed with the push received intent when a GCM/ADM message is received, and that Braze passes in the intent to registered receivers.

setNotificationChannelIfSupported

@Deprecated
public static void setNotificationChannelIfSupported(android.content.Context context,
                                                                 BrazeConfigurationProvider appConfigurationProvider,
                                                                 NotificationCompat.Builder notificationBuilder,
                                                                 android.os.Bundle notificationExtras)

Deprecated. The channel id should be set in NotificationCompat.Builder#Builder(Context, String)

Sets a notification channel on all Android O and above notifications. If not present in the extras, then a default notification channel is used.

To change the default notification channel name and description, please use BrazeConfig.Builder#setDefaultNotificationChannelName(String) and BrazeConfig.Builder#setDefaultNotificationChannelDescription(String).

The default notification channel uses the id Constants.APPBOY_PUSH_DEFAULT_NOTIFICATION_CHANNEL_ID.

getOrCreateNotificationChannelId

public static java.lang.String getOrCreateNotificationChannelId(BrazeNotificationPayload payload)

Returns the channel id for a valid NotificationChannel, creating one if necessary.

1. First, if Constants.APPBOY_PUSH_NOTIFICATION_CHANNEL_ID_KEY key is present in notificationExtras's and is the id of a valid NotificationChannel, this id will be returned.
2. Next, if the channel with id Constants.APPBOY_PUSH_DEFAULT_NOTIFICATION_CHANNEL_ID exists, then Constants.APPBOY_PUSH_DEFAULT_NOTIFICATION_CHANNEL_ID will be returned.
3. Finally, if neither of the cases above is true, a channel with id Constants.APPBOY_PUSH_DEFAULT_NOTIFICATION_CHANNEL_ID will be created and Constants.APPBOY_PUSH_DEFAULT_NOTIFICATION_CHANNEL_ID will be returned.

getOrCreateNotificationChannelId

@Deprecated
public static java.lang.String getOrCreateNotificationChannelId(android.content.Context context,
                                                                            BrazeConfigurationProvider appConfigurationProvider,
                                                                            android.os.Bundle notificationExtras)

Deprecated. Please use getOrCreateNotificationChannelId(BrazeNotificationPayload)

setNotificationBadgeNumberIfPresent

@Deprecated
public static void setNotificationBadgeNumberIfPresent(NotificationCompat.Builder notificationBuilder,
                                                                   android.os.Bundle notificationExtras)

Deprecated. Please use setNotificationBadgeNumberIfPresent(NotificationCompat.Builder, BrazeNotificationPayload)

setNotificationBadgeNumberIfPresent

public static void setNotificationBadgeNumberIfPresent(NotificationCompat.Builder notificationBuilder,
                                                       BrazeNotificationPayload payload)

Sets the notification number, set via NotificationCompat.Builder#setNumber(int). On Android O, this number is used with notification badges.

handlePushStoryPageClicked

public static void handlePushStoryPageClicked(android.content.Context context,
                                              android.content.Intent intent)

Handles a push story page click. Called by FCM/ADM receiver when an Braze push story click intent is received.

Parameters:

context - Application context.

intent - The push story click intent.

handleContentCardsSerializedCardIfPresent

public static void handleContentCardsSerializedCardIfPresent(BrazeNotificationPayload payload)

Parses the notification bundle for any associated ContentCards, if present. If found, the card object is added to card storage.

isInAppMessageTestPush

public static boolean isInAppMessageTestPush(android.content.Intent intent)

Checks if a push Intent contains extras found in a test push for in-app messages.

Returns:

True if this Intent is from an in-app message test send.