com.parse

Class ParsePushBroadcastReceiver

java.lang.Object

android.content.BroadcastReceiver

com.parse.ParsePushBroadcastReceiver

public class ParsePushBroadcastReceiver
extends android.content.BroadcastReceiver

A BroadcastReceiver for rendering and reacting to to Notifications.

This BroadcastReceiver must be registered in order to use the ParsePush subscription methods. As a security precaution, the intent filters for this BroadcastReceiver must not be exported. Add the following lines to your AndroidManifest.xml file, inside the <application> element to properly register the ParsePushBroadcastReceiver:

 <receiver android:name="com.parse.ParsePushBroadcastReceiver" android:exported=false>
  <intent-filter>
     <action android:name="com.parse.push.intent.RECEIVE" />
     <action android:name="com.parse.push.intent.OPEN" />
     <action android:name="com.parse.push.intent.DELETE" />
   </intent-filter>
 </receiver>
 

The ParsePushBroadcastReceiver is designed to provide maximal configurability with minimal effort. To customize the push icon, add the following line as a child of your <application> element:

   <meta-data android:name="com.parse.push.notification_icon"
              android:resource="@drawable/icon"/>
 

where drawable/icon may be the path to any drawable resource. The Android style guide for Notifications suggests that push icons should be flat monochromatic images.

To achieve further customization, ParsePushBroadcastReceiver can be subclassed. When providing your own implementation of ParsePushBroadcastReceiver, be sure to change com.parse.PushBroadcastReceiver to the name of your custom subclass in your AndroidManifest.xml. You can intercept and override the behavior of entire portions of the push lifecycle by overriding onPushReceive(Context, Intent), onPushOpen(Context, Intent), or onPushDismiss(Context, Intent). To make minor changes to the appearance of a notification, override getSmallIconId(Context, Intent) or getLargeIcon(Context, Intent). To completely change the Notification generated, override getNotification(Context, Intent). To change the NotificationChannel generated, override getNotificationChannel(Context, Intent). To change how the NotificationChannel is created, override createNotificationChannel(Context, NotificationChannel). To change the Activity launched when a user opens a Notification, override getActivity(Context, Intent).

Nested Class Summary

Nested classes/interfaces inherited from class android.content.BroadcastReceiver

android.content.BroadcastReceiver.PendingResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_PUSH_DELETE The name of the Intent fired when a notification has been dismissed.
static java.lang.String	ACTION_PUSH_OPEN The name of the Intent fired when a notification has been opened.
static java.lang.String	ACTION_PUSH_RECEIVE The name of the Intent fired when a push has been received.
static java.lang.String	KEY_PUSH_CHANNEL The name of the Intent extra which contains a channel used to route this notification.
static java.lang.String	KEY_PUSH_DATA The name of the Intent extra which contains the JSON payload of the Notification.
static java.lang.String	PROPERTY_PUSH_ICON The name of the meta-data field used to override the icon used in Notifications.
protected static int	SMALL_NOTIFICATION_MAX_CHARACTER_LIMIT

Constructor Summary

Constructors

Constructor and Description
ParsePushBroadcastReceiver()

Method Summary

Modifier and Type	Method and Description
protected void	createNotificationChannel(android.content.Context context, android.app.NotificationChannel notificationChannel) Creates the notification channel with the NotificationManager.
protected java.lang.Class<? extends android.app.Activity>	getActivity(android.content.Context context, android.content.Intent intent) Used by onPushOpen(android.content.Context, android.content.Intent) to determine which activity to launch or insert into the back stack.
protected android.content.Intent	getContentIntent(android.os.Bundle extras, java.lang.String packageName) Get the content intent, which is the intent called when a notification is tapped.
protected android.content.Intent	getDeleteIntent(android.os.Bundle extras, java.lang.String packageName) Get the delete intent, which is the intent called when a notification is deleted (swiped away).
protected android.graphics.Bitmap	getLargeIcon(android.content.Context context, android.content.Intent intent) Retrieves the large icon to be used in a Notification.
protected NotificationCompat.Builder	getNotification(android.content.Context context, android.content.Intent intent) Creates a Notification with reasonable defaults.
protected android.app.NotificationChannel	getNotificationChannel(android.content.Context context, android.content.Intent intent) Retrieves the channel to be used in a Notification if API >= 26, if not null.
protected org.json.JSONObject	getPushData(android.content.Intent intent) Get the push data as a parsed JSONObject
protected int	getSmallIconId(android.content.Context context, android.content.Intent intent) Retrieves the small icon to be used in a Notification.
protected void	onPushDismiss(android.content.Context context, android.content.Intent intent) Called when the push notification is dismissed.
protected void	onPushOpen(android.content.Context context, android.content.Intent intent) Called when the push notification is opened by the user.
protected void	onPushReceive(android.content.Context context, android.content.Intent intent) Called when the push notification is received.
void	onReceive(android.content.Context context, android.content.Intent intent) Delegates the generic onReceive event to a notification lifecycle event.

Methods inherited from class android.content.BroadcastReceiver

abortBroadcast, clearAbortBroadcast, getAbortBroadcast, getDebugUnregister, getResultCode, getResultData, getResultExtras, goAsync, isInitialStickyBroadcast, isOrderedBroadcast, peekService, setDebugUnregister, setOrderedHint, setResult, setResultCode, setResultData, setResultExtras

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PUSH_CHANNEL

public static final java.lang.String KEY_PUSH_CHANNEL

The name of the Intent extra which contains a channel used to route this notification. May be null.

See Also:

Constant Field Values

KEY_PUSH_DATA

public static final java.lang.String KEY_PUSH_DATA

The name of the Intent extra which contains the JSON payload of the Notification.

See Also:

Constant Field Values

ACTION_PUSH_RECEIVE

public static final java.lang.String ACTION_PUSH_RECEIVE

The name of the Intent fired when a push has been received.

See Also:

Constant Field Values

ACTION_PUSH_OPEN

public static final java.lang.String ACTION_PUSH_OPEN

The name of the Intent fired when a notification has been opened.

See Also:

Constant Field Values

ACTION_PUSH_DELETE

public static final java.lang.String ACTION_PUSH_DELETE

The name of the Intent fired when a notification has been dismissed.

See Also:

Constant Field Values

PROPERTY_PUSH_ICON

public static final java.lang.String PROPERTY_PUSH_ICON

The name of the meta-data field used to override the icon used in Notifications.

See Also:

Constant Field Values

SMALL_NOTIFICATION_MAX_CHARACTER_LIMIT

protected static final int SMALL_NOTIFICATION_MAX_CHARACTER_LIMIT

See Also:

Constant Field Values

Constructor Detail

ParsePushBroadcastReceiver

public ParsePushBroadcastReceiver()

Method Detail

onReceive

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

Delegates the generic onReceive event to a notification lifecycle event. Subclasses are advised to override the lifecycle events and not this method.

Specified by:

onReceive in class android.content.BroadcastReceiver

Parameters:

context - The Context in which the receiver is running.

intent - An Intent containing the channel and data of the current push notification.

See Also:

onPushReceive(Context, Intent), onPushOpen(Context, Intent), onPushDismiss(Context, Intent)

onPushReceive

protected void onPushReceive(android.content.Context context,
                             android.content.Intent intent)

Called when the push notification is received. By default, a broadcast intent will be sent if an "action" is present in the data and a notification will be show if "alert" and "title" are present in the data.

Parameters:

context - The Context in which the receiver is running.

intent - An Intent containing the channel and data of the current push notification.

onPushDismiss

protected void onPushDismiss(android.content.Context context,
                             android.content.Intent intent)

Called when the push notification is dismissed. By default, nothing is performed on notification dismissal.

Parameters:

context - The Context in which the receiver is running.

intent - An Intent containing the channel and data of the current push notification.

onPushOpen

protected void onPushOpen(android.content.Context context,
                          android.content.Intent intent)

Called when the push notification is opened by the user. Sends analytics info back to Parse that the application was opened from this push notification. By default, this will navigate to the Activity returned by getActivity(Context, Intent). If the push contains a 'uri' parameter, an Intent is fired to view that URI with the Activity returned by getActivity(android.content.Context, android.content.Intent) in the back stack.

Parameters:

context - The Context in which the receiver is running.

intent - An Intent containing the channel and data of the current push notification.

getActivity

protected java.lang.Class<? extends android.app.Activity> getActivity(android.content.Context context,
                                                                      android.content.Intent intent)

Used by onPushOpen(android.content.Context, android.content.Intent) to determine which activity to launch or insert into the back stack. The default implementation retrieves the launch activity class for the package.

Parameters:

context - The Context in which the receiver is running.

intent - An Intent containing the channel and data of the current push notification.

Returns:

The default Activity class of the package or null if no launch intent is defined in AndroidManifest.xml.

getNotificationChannel

protected android.app.NotificationChannel getNotificationChannel(android.content.Context context,
                                                                 android.content.Intent intent)

Retrieves the channel to be used in a Notification if API >= 26, if not null. The default returns a new channel with id "parse_push", name "Push notifications" and default importance.

Parameters:

context - The Context in which the receiver is running.

intent - An Intent containing the channel and data of the current push notification.

Returns:

The notification channel

createNotificationChannel

protected void createNotificationChannel(android.content.Context context,
                                         android.app.NotificationChannel notificationChannel)

Creates the notification channel with the NotificationManager. Channel is not recreated if the channel properties are unchanged.

Parameters:

context - The Context in which the receiver is running.

notificationChannel - The NotificationChannel to be created.

getSmallIconId

protected int getSmallIconId(android.content.Context context,
                             android.content.Intent intent)

Retrieves the small icon to be used in a Notification. The default implementation uses the icon specified by com.parse.push.notification_icon meta-data in your AndroidManifest.xml with a fallback to the launcher icon for this package. To conform to Android style guides, it is highly recommended that developers specify an explicit push icon.

Parameters:

context - The Context in which the receiver is running.

intent - An Intent containing the channel and data of the current push notification.

Returns:

The resource id of the default small icon for the package

See Also:

Android Notification Style Guide

getLargeIcon

protected android.graphics.Bitmap getLargeIcon(android.content.Context context,
                                               android.content.Intent intent)

Retrieves the large icon to be used in a Notification. This Bitmap should be used to provide special context for a particular Notification, such as the avatar of user who generated the Notification. The default implementation returns null, causing the Notification to display only the small icon.

Parameters:

context - The Context in which the receiver is running.

intent - An Intent containing the channel and data of the current push notification.

Returns:

Bitmap of the default large icon for the package

See Also:

Android Notification UI Overview

getPushData

protected org.json.JSONObject getPushData(android.content.Intent intent)

Get the push data as a parsed JSONObject

Parameters:

intent - the intent of the notification

Returns:

the parsed JSONObject, or null

getContentIntent

protected android.content.Intent getContentIntent(android.os.Bundle extras,
                                                  java.lang.String packageName)

Get the content intent, which is the intent called when a notification is tapped. Note that if you override this, you will want to set the action to ACTION_PUSH_OPEN in order to still trigger onPushOpen(Context, Intent)

Parameters:

extras - the extras

packageName - the app package name

Returns:

the intent

getDeleteIntent

protected android.content.Intent getDeleteIntent(android.os.Bundle extras,
                                                 java.lang.String packageName)

Get the delete intent, which is the intent called when a notification is deleted (swiped away). Note that if you override this, you will want to set the action to ACTION_PUSH_DELETE in order to still trigger onPushOpen(Context, Intent)

Parameters:

extras - the extras

packageName - the app package name

Returns:

the intent

getNotification

protected NotificationCompat.Builder getNotification(android.content.Context context,
                                                     android.content.Intent intent)

Creates a Notification with reasonable defaults. If "alert" and "title" are both missing from data, then returns null. If the text in the notification is longer than 38 characters long, the style of the notification will be set to Notification.BigTextStyle.

As a security precaution, developers overriding this method should be sure to set the package on notification Intents to avoid leaking information to other apps.

Parameters:

context - The Context in which the receiver is running.

intent - An Intent containing the channel and data of the current push notification.

Returns:

The notification builder to be displayed.

See Also:

onPushReceive(Context, Intent)