To extend this class, you must declare the service in your manifest file with * the {@link android.Manifest.permission#BIND_NOTIFICATION_LISTENER_SERVICE} permission * and include an intent filter with the {@link #SERVICE_INTERFACE} action. For example:
** <service android:name=".NotificationListener" * android:label="@string/service_name" * android:permission="android.permission.BIND_NOTIFICATION_LISTENER_SERVICE"> * <intent-filter> * <action android:name="android.service.notification.NotificationListenerService" /> * </intent-filter> * </service>*/ public abstract class NotificationListenerService extends Service { // TAG = "NotificationListenerService[MySubclass]" private final String TAG = NotificationListenerService.class.getSimpleName() + "[" + getClass().getSimpleName() + "]"; /** * {@link #getCurrentInterruptionFilter() Interruption filter} constant - * Normal interruption filter. */ public static final int INTERRUPTION_FILTER_ALL = 1; /** * {@link #getCurrentInterruptionFilter() Interruption filter} constant - * Priority interruption filter. */ public static final int INTERRUPTION_FILTER_PRIORITY = 2; /** * {@link #getCurrentInterruptionFilter() Interruption filter} constant - * No interruptions filter. */ public static final int INTERRUPTION_FILTER_NONE = 3; /** {@link #getCurrentListenerHints() Listener hints} constant - the primary device UI * should disable notification sound, vibrating and other visual or aural effects. * This does not change the interruption filter, only the effects. **/ public static final int HINT_HOST_DISABLE_EFFECTS = 1; /** * The full trim of the StatusBarNotification including all its features. * * @hide */ @SystemApi public static final int TRIM_FULL = 0; /** * A light trim of the StatusBarNotification excluding the following features: * *
* This might occur because the user has dismissed the notification using system UI (or another * notification listener) or because the app has withdrawn the notification. *
* NOTE: The {@link StatusBarNotification} object you receive will be "light"; that is, the * result from {@link StatusBarNotification#getNotification} may be missing some heavyweight * fields such as {@link android.app.Notification#contentView} and * {@link android.app.Notification#largeIcon}. However, all other fields on * {@link StatusBarNotification}, sufficient to match this call with a prior call to * {@link #onNotificationPosted(StatusBarNotification)}, will be intact. * * @param sbn A data structure encapsulating at least the original information (tag and id) * and source (package name) used to post the {@link android.app.Notification} that * was just removed. */ public void onNotificationRemoved(StatusBarNotification sbn) { // optional } /** * Implement this method to learn when notifications are removed. *
* This might occur because the user has dismissed the notification using system UI (or another * notification listener) or because the app has withdrawn the notification. *
* NOTE: The {@link StatusBarNotification} object you receive will be "light"; that is, the * result from {@link StatusBarNotification#getNotification} may be missing some heavyweight * fields such as {@link android.app.Notification#contentView} and * {@link android.app.Notification#largeIcon}. However, all other fields on * {@link StatusBarNotification}, sufficient to match this call with a prior call to * {@link #onNotificationPosted(StatusBarNotification)}, will be intact. * * @param sbn A data structure encapsulating at least the original information (tag and id) * and source (package name) used to post the {@link android.app.Notification} that * was just removed. * @param rankingMap The current ranking map that can be used to retrieve ranking information * for active notifications. * */ public void onNotificationRemoved(StatusBarNotification sbn, RankingMap rankingMap) { onNotificationRemoved(sbn); } /** * Implement this method to learn about when the listener is enabled and connected to * the notification manager. You are safe to call {@link #getActiveNotifications()} * at this time. */ public void onListenerConnected() { // optional } /** * Implement this method to be notified when the notification ranking changes. * * @param rankingMap The current ranking map that can be used to retrieve ranking information * for active notifications. */ public void onNotificationRankingUpdate(RankingMap rankingMap) { // optional } /** * Implement this method to be notified when the * {@link #getCurrentListenerHints() Listener hints} change. * * @param hints The current {@link #getCurrentListenerHints() listener hints}. */ public void onListenerHintsChanged(int hints) { // optional } /** * Implement this method to be notified when the * {@link #getCurrentInterruptionFilter() interruption filter} changed. * * @param interruptionFilter The current * {@link #getCurrentInterruptionFilter() interruption filter}. */ public void onInterruptionFilterChanged(int interruptionFilter) { // optional } private final INotificationManager getNotificationInterface() { if (mNoMan == null) { mNoMan = INotificationManager.Stub.asInterface( ServiceManager.getService(Context.NOTIFICATION_SERVICE)); } return mNoMan; } /** * Inform the notification manager about dismissal of a single notification. *
* Use this if your listener has a user interface that allows the user to dismiss individual * notifications, similar to the behavior of Android's status bar and notification panel. * It should be called after the user dismisses a single notification using your UI; * upon being informed, the notification manager will actually remove the notification * and you will get an {@link #onNotificationRemoved(StatusBarNotification)} callback. *
* Note: If your listener allows the user to fire a notification's * {@link android.app.Notification#contentIntent} by tapping/clicking/etc., you should call * this method at that time if the Notification in question has the * {@link android.app.Notification#FLAG_AUTO_CANCEL} flag set. * * @param pkg Package of the notifying app. * @param tag Tag of the notification as specified by the notifying app in * {@link android.app.NotificationManager#notify(String, int, android.app.Notification)}. * @param id ID of the notification as specified by the notifying app in * {@link android.app.NotificationManager#notify(String, int, android.app.Notification)}. *
* @deprecated Use {@link #cancelNotification(String key)} * instead. Beginning with {@link android.os.Build.VERSION_CODES#LOLLIPOP} this method will no longer * cancel the notification. It will continue to cancel the notification for applications * whose {@code targetSdkVersion} is earlier than {@link android.os.Build.VERSION_CODES#LOLLIPOP}. */ public final void cancelNotification(String pkg, String tag, int id) { if (!isBound()) return; try { getNotificationInterface().cancelNotificationFromListener( mWrapper, pkg, tag, id); } catch (android.os.RemoteException ex) { Log.v(TAG, "Unable to contact notification manager", ex); } } /** * Inform the notification manager about dismissal of a single notification. *
* Use this if your listener has a user interface that allows the user to dismiss individual * notifications, similar to the behavior of Android's status bar and notification panel. * It should be called after the user dismisses a single notification using your UI; * upon being informed, the notification manager will actually remove the notification * and you will get an {@link #onNotificationRemoved(StatusBarNotification)} callback. *
* Note: If your listener allows the user to fire a notification's * {@link android.app.Notification#contentIntent} by tapping/clicking/etc., you should call * this method at that time if the Notification in question has the * {@link android.app.Notification#FLAG_AUTO_CANCEL} flag set. *
* @param key Notification to dismiss from {@link StatusBarNotification#getKey()}. */ public final void cancelNotification(String key) { if (!isBound()) return; try { getNotificationInterface().cancelNotificationsFromListener(mWrapper, new String[] {key}); } catch (android.os.RemoteException ex) { Log.v(TAG, "Unable to contact notification manager", ex); } } /** * Inform the notification manager about dismissal of all notifications. *
* Use this if your listener has a user interface that allows the user to dismiss all * notifications, similar to the behavior of Android's status bar and notification panel. * It should be called after the user invokes the "dismiss all" function of your UI; * upon being informed, the notification manager will actually remove all active notifications * and you will get multiple {@link #onNotificationRemoved(StatusBarNotification)} callbacks. * * {@see #cancelNotification(String, String, int)} */ public final void cancelAllNotifications() { cancelNotifications(null /*all*/); } /** * Inform the notification manager about dismissal of specific notifications. *
* Use this if your listener has a user interface that allows the user to dismiss * multiple notifications at once. * * @param keys Notifications to dismiss, or {@code null} to dismiss all. * * {@see #cancelNotification(String, String, int)} */ public final void cancelNotifications(String[] keys) { if (!isBound()) return; try { getNotificationInterface().cancelNotificationsFromListener(mWrapper, keys); } catch (android.os.RemoteException ex) { Log.v(TAG, "Unable to contact notification manager", ex); } } /** * Sets the notification trim that will be received via {@link #onNotificationPosted}. * *
* Setting a trim other than {@link #TRIM_FULL} enables listeners that don't need access to the * full notification features right away to reduce their memory footprint. Full notifications * can be requested on-demand via {@link #getActiveNotifications(int)}. * *
* Set to {@link #TRIM_FULL} initially.
*
* @hide
*
* @param trim trim of the notifications to be passed via {@link #onNotificationPosted}.
* See
* The current state may differ from the requested state if the hint represents state
* shared across all listeners or a feature the notification host does not support or refuses
* to grant.
*
* @return Zero or more of the HINT_ constants.
*/
public final int getCurrentListenerHints() {
if (!isBound()) return 0;
try {
return getNotificationInterface().getHintsFromListener(mWrapper);
} catch (android.os.RemoteException ex) {
Log.v(TAG, "Unable to contact notification manager", ex);
return 0;
}
}
/**
* Gets the current notification interruption filter active on the host.
*
*
* The interruption filter defines which notifications are allowed to interrupt the user
* (e.g. via sound & vibration) and is applied globally. Listeners can find out whether
* a specific notification matched the interruption filter via
* {@link Ranking#matchesInterruptionFilter()}.
*
* The current filter may differ from the previously requested filter if the notification host
* does not support or refuses to apply the requested filter, or if another component changed
* the filter in the meantime.
*
* Listen for updates using {@link #onInterruptionFilterChanged(int)}.
*
* @return One of the INTERRUPTION_FILTER_ constants, or 0 on errors.
*/
public final int getCurrentInterruptionFilter() {
if (!isBound()) return 0;
try {
return getNotificationInterface().getInterruptionFilterFromListener(mWrapper);
} catch (android.os.RemoteException ex) {
Log.v(TAG, "Unable to contact notification manager", ex);
return 0;
}
}
/**
* Sets the desired {@link #getCurrentListenerHints() listener hints}.
*
*
* This is merely a request, the host may or may not choose to take action depending
* on other listener requests or other global state.
*
* Listen for updates using {@link #onListenerHintsChanged(int)}.
*
* @param hints One or more of the HINT_ constants.
*/
public final void requestListenerHints(int hints) {
if (!isBound()) return;
try {
getNotificationInterface().requestHintsFromListener(mWrapper, hints);
} catch (android.os.RemoteException ex) {
Log.v(TAG, "Unable to contact notification manager", ex);
}
}
/**
* Sets the desired {@link #getCurrentInterruptionFilter() interruption filter}.
*
*
* This is merely a request, the host may or may not choose to apply the requested
* interruption filter depending on other listener requests or other global state.
*
* Listen for updates using {@link #onInterruptionFilterChanged(int)}.
*
* @param interruptionFilter One of the INTERRUPTION_FILTER_ constants.
*/
public final void requestInterruptionFilter(int interruptionFilter) {
if (!isBound()) return;
try {
getNotificationInterface()
.requestInterruptionFilterFromListener(mWrapper, interruptionFilter);
} catch (android.os.RemoteException ex) {
Log.v(TAG, "Unable to contact notification manager", ex);
}
}
/**
* Returns current ranking information.
*
*
* The returned object represents the current ranking snapshot and only
* applies for currently active notifications.
*
* Generally you should use the RankingMap that is passed with events such
* as {@link #onNotificationPosted(StatusBarNotification, RankingMap)},
* {@link #onNotificationRemoved(StatusBarNotification, RankingMap)}, and
* so on. This method should only be used when needing access outside of
* such events, for example to retrieve the RankingMap right after
* initialization.
*
* @return A {@link RankingMap} object providing access to ranking information
*/
public RankingMap getCurrentRanking() {
return mRankingMap;
}
@Override
public IBinder onBind(Intent intent) {
if (mWrapper == null) {
mWrapper = new INotificationListenerWrapper();
}
return mWrapper;
}
private boolean isBound() {
if (mWrapper == null) {
Log.w(TAG, "Notification listener service not yet bound.");
return false;
}
return true;
}
/**
* Directly register this service with the Notification Manager.
*
* Only system services may use this call. It will fail for non-system callers.
* Apps should ask the user to add their listener in Settings.
*
* @param context Context required for accessing resources. Since this service isn't
* launched as a real Service when using this method, a context has to be passed in.
* @param componentName the component that will consume the notification information
* @param currentUser the user to use as the stream filter
* @hide
*/
@SystemApi
public void registerAsSystemService(Context context, ComponentName componentName,
int currentUser) throws RemoteException {
mSystemContext = context;
if (mWrapper == null) {
mWrapper = new INotificationListenerWrapper();
}
INotificationManager noMan = getNotificationInterface();
noMan.registerListener(mWrapper, componentName, currentUser);
mCurrentUser = currentUser;
}
/**
* Directly unregister this service from the Notification Manager.
*
* This method will fail for listeners that were not registered
* with (@link registerAsService).
* @hide
*/
@SystemApi
public void unregisterAsSystemService() throws RemoteException {
if (mWrapper != null) {
INotificationManager noMan = getNotificationInterface();
noMan.unregisterListener(mWrapper, mCurrentUser);
}
}
private class INotificationListenerWrapper extends INotificationListener.Stub {
@Override
public void onNotificationPosted(IStatusBarNotificationHolder sbnHolder,
NotificationRankingUpdate update) {
StatusBarNotification sbn;
try {
sbn = sbnHolder.get();
} catch (RemoteException e) {
Log.w(TAG, "onNotificationPosted: Error receiving StatusBarNotification", e);
return;
}
Notification.Builder.rebuild(getContext(), sbn.getNotification());
// protect subclass from concurrent modifications of (@link mNotificationKeys}.
synchronized (mWrapper) {
applyUpdate(update);
try {
NotificationListenerService.this.onNotificationPosted(sbn, mRankingMap);
} catch (Throwable t) {
Log.w(TAG, "Error running onNotificationPosted", t);
}
}
}
@Override
public void onNotificationRemoved(IStatusBarNotificationHolder sbnHolder,
NotificationRankingUpdate update) {
StatusBarNotification sbn;
try {
sbn = sbnHolder.get();
} catch (RemoteException e) {
Log.w(TAG, "onNotificationRemoved: Error receiving StatusBarNotification", e);
return;
}
// protect subclass from concurrent modifications of (@link mNotificationKeys}.
synchronized (mWrapper) {
applyUpdate(update);
try {
NotificationListenerService.this.onNotificationRemoved(sbn, mRankingMap);
} catch (Throwable t) {
Log.w(TAG, "Error running onNotificationRemoved", t);
}
}
}
@Override
public void onListenerConnected(NotificationRankingUpdate update) {
// protect subclass from concurrent modifications of (@link mNotificationKeys}.
synchronized (mWrapper) {
applyUpdate(update);
try {
NotificationListenerService.this.onListenerConnected();
} catch (Throwable t) {
Log.w(TAG, "Error running onListenerConnected", t);
}
}
}
@Override
public void onNotificationRankingUpdate(NotificationRankingUpdate update)
throws RemoteException {
// protect subclass from concurrent modifications of (@link mNotificationKeys}.
synchronized (mWrapper) {
applyUpdate(update);
try {
NotificationListenerService.this.onNotificationRankingUpdate(mRankingMap);
} catch (Throwable t) {
Log.w(TAG, "Error running onNotificationRankingUpdate", t);
}
}
}
@Override
public void onListenerHintsChanged(int hints) throws RemoteException {
try {
NotificationListenerService.this.onListenerHintsChanged(hints);
} catch (Throwable t) {
Log.w(TAG, "Error running onListenerHintsChanged", t);
}
}
@Override
public void onInterruptionFilterChanged(int interruptionFilter) throws RemoteException {
try {
NotificationListenerService.this.onInterruptionFilterChanged(interruptionFilter);
} catch (Throwable t) {
Log.w(TAG, "Error running onInterruptionFilterChanged", t);
}
}
}
private void applyUpdate(NotificationRankingUpdate update) {
mRankingMap = new RankingMap(update);
}
private Context getContext() {
if (mSystemContext != null) {
return mSystemContext;
}
return this;
}
/**
* Stores ranking related information on a currently active notification.
*
*
* Ranking objects aren't automatically updated as notification events
* occur. Instead, ranking information has to be retrieved again via the
* current {@link RankingMap}.
*/
public static class Ranking {
/** Value signifying that the user has not expressed a per-app visibility override value.
* @hide */
public static final int VISIBILITY_NO_OVERRIDE = -1000;
private String mKey;
private int mRank = -1;
private boolean mIsAmbient;
private boolean mMatchesInterruptionFilter;
private int mVisibilityOverride;
public Ranking() {}
/**
* Returns the key of the notification this Ranking applies to.
*/
public String getKey() {
return mKey;
}
/**
* Returns the rank of the notification.
*
* @return the rank of the notification, that is the 0-based index in
* the list of active notifications.
*/
public int getRank() {
return mRank;
}
/**
* Returns whether the notification is an ambient notification, that is
* a notification that doesn't require the user's immediate attention.
*/
public boolean isAmbient() {
return mIsAmbient;
}
/**
* Returns the user specificed visibility for the package that posted
* this notification, or
* {@link NotificationListenerService.Ranking#VISIBILITY_NO_OVERRIDE} if
* no such preference has been expressed.
* @hide
*/
public int getVisibilityOverride() {
return mVisibilityOverride;
}
/**
* Returns whether the notification matches the user's interruption
* filter.
*
* @return {@code true} if the notification is allowed by the filter, or
* {@code false} if it is blocked.
*/
public boolean matchesInterruptionFilter() {
return mMatchesInterruptionFilter;
}
private void populate(String key, int rank, boolean isAmbient,
boolean matchesInterruptionFilter, int visibilityOverride) {
mKey = key;
mRank = rank;
mIsAmbient = isAmbient;
mMatchesInterruptionFilter = matchesInterruptionFilter;
mVisibilityOverride = visibilityOverride;
}
}
/**
* Provides access to ranking information on currently active
* notifications.
*
*
* Note that this object represents a ranking snapshot that only applies to
* notifications active at the time of retrieval.
*/
public static class RankingMap implements Parcelable {
private final NotificationRankingUpdate mRankingUpdate;
private ArrayMapTRIM_* constants.
*/
@SystemApi
public final void setOnNotificationPostedTrim(int trim) {
if (!isBound()) return;
try {
getNotificationInterface().setOnNotificationPostedTrimFromListener(mWrapper, trim);
} catch (RemoteException ex) {
Log.v(TAG, "Unable to contact notification manager", ex);
}
}
/**
* Request the list of outstanding notifications (that is, those that are visible to the
* current user). Useful when you don't know what's already been posted.
*
* @return An array of active notifications, sorted in natural order.
*/
public StatusBarNotification[] getActiveNotifications() {
return getActiveNotifications(null, TRIM_FULL);
}
/**
* Request the list of outstanding notifications (that is, those that are visible to the
* current user). Useful when you don't know what's already been posted.
*
* @hide
*
* @param trim trim of the notifications to be returned. See TRIM_* constants.
* @return An array of active notifications, sorted in natural order.
*/
@SystemApi
public StatusBarNotification[] getActiveNotifications(int trim) {
return getActiveNotifications(null, trim);
}
/**
* Request one or more notifications by key. Useful if you have been keeping track of
* notifications but didn't want to retain the bits, and now need to go back and extract
* more data out of those notifications.
*
* @param keys the keys of the notifications to request
* @return An array of notifications corresponding to the requested keys, in the
* same order as the key list.
*/
public StatusBarNotification[] getActiveNotifications(String[] keys) {
return getActiveNotifications(keys, TRIM_FULL);
}
/**
* Request one or more notifications by key. Useful if you have been keeping track of
* notifications but didn't want to retain the bits, and now need to go back and extract
* more data out of those notifications.
*
* @hide
*
* @param keys the keys of the notifications to request
* @param trim trim of the notifications to be returned. See TRIM_* constants.
* @return An array of notifications corresponding to the requested keys, in the
* same order as the key list.
*/
@SystemApi
public StatusBarNotification[] getActiveNotifications(String[] keys, int trim) {
if (!isBound())
return null;
try {
ParceledListSlice