Classes

Added in API level 18

public abstract class

NotificationListenerService

extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	android.service.notification.NotificationListenerService

Class Overview

A service that receives calls from the system when new notifications are posted or removed, or their ranking changed.

To extend this class, you must declare the service in your manifest file with the BIND_NOTIFICATION_LISTENER_SERVICE permission and include an intent filter with the 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>

Summary

Nested Classes
class	NotificationListenerService.Ranking	Provides access to ranking information on a currently active notification.
class	NotificationListenerService.RankingMap	Provides access to ranking information on currently active notifications.

Constants
String	SERVICE_INTERFACE	The `Intent` that must be declared as handled by the service.

[Expand]

Inherited Constants

From class android.app.Service

From class android.content.Context

From interface android.content.ComponentCallbacks2

Public Constructors
	NotificationListenerService()

Public Methods
final void	cancelAllNotifications() Inform the notification manager about dismissal of all notifications.
final void	cancelNotification(String key) Inform the notification manager about dismissal of a single notification.
final void	cancelNotification(String pkg, String tag, int id) This method is deprecated. Use `cancelNotification(String)` instead. Beginning with `L` this method will no longer cancel the notification. It will continue to cancel the notification for applications whose `targetSdkVersion` is earlier than `L`.
final void	cancelNotifications(String[] keys) Inform the notification manager about dismissal of specific notifications.
StatusBarNotification[]	getActiveNotifications() Request the list of outstanding notifications (that is, those that are visible to the current user).
NotificationListenerService.RankingMap	getCurrentRanking() Returns current ranking information.
IBinder	onBind(Intent intent) Return the communication channel to the service.
void	onListenerConnected() Implement this method to learn about when the listener is enabled and connected to the notification manager.
void	onNotificationPosted(StatusBarNotification sbn) Implement this method to learn about new notifications as they are posted by apps.
void	onNotificationPosted(StatusBarNotification sbn, NotificationListenerService.RankingMap rankingMap) Implement this method to learn about new notifications as they are posted by apps.
void	onNotificationRankingUpdate(NotificationListenerService.RankingMap rankingMap) Implement this method to be notified when the notification ranking changes.
void	onNotificationRemoved(StatusBarNotification sbn) Implement this method to learn when notifications are removed.
void	onNotificationRemoved(StatusBarNotification sbn, NotificationListenerService.RankingMap rankingMap) Implement this method to learn when notifications are removed.

[Expand]

Inherited Methods

From class android.app.Service

void	dump(FileDescriptor fd, PrintWriter writer, String[] args) Print the Service's state into the given stream.
final Application	getApplication() Return the application that owns this service.
abstract IBinder	onBind(Intent intent) Return the communication channel to the service.
void	onConfigurationChanged(Configuration newConfig) Called by the system when the device configuration changes while your component is running.
void	onCreate() Called by the system when the service is first created.
void	onDestroy() Called by the system to notify a Service that it is no longer used and is being removed.
void	onLowMemory() This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
void	onRebind(Intent intent) Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its `onUnbind(Intent)`.
void	onStart(Intent intent, int startId) This method was deprecated in API level 5. Implement `onStartCommand(Intent, int, int)` instead.
int	onStartCommand(Intent intent, int flags, int startId) Called by the system every time a client explicitly starts the service by calling `startService(Intent)`, providing the arguments it supplied and a unique integer token representing the start request.
void	onTaskRemoved(Intent rootIntent) This is called if the service is currently running and the user has removed a task that comes from the service's application.
void	onTrimMemory(int level) Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
boolean	onUnbind(Intent intent) Called when all clients have disconnected from a particular interface published by the service.
final void	startForeground(int id, Notification notification) Make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state.
final void	stopForeground(boolean removeNotification) Remove this service from foreground state, allowing it to be killed if more memory is needed.
final void	stopSelf() Stop the service, if it was previously started.
final void	stopSelf(int startId) Old version of `stopSelfResult(int)` that doesn't return a result.
final boolean	stopSelfResult(int startId) Stop the service if the most recent time it was started was `startId`.

From class android.content.ContextWrapper

From class android.content.Context

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.content.ComponentCallbacks

From interface android.content.ComponentCallbacks2

Constants

public static final String SERVICE_INTERFACE

Added in API level 18

The Intent that must be declared as handled by the service.

Constant Value: "android.service.notification.NotificationListenerService"

Public Constructors

public NotificationListenerService ()

Added in API level 18

Public Methods

public final void cancelAllNotifications ()

Added in API level 18

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 onNotificationRemoved(StatusBarNotification) callbacks.

public final void cancelNotification (String key)

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 onNotificationRemoved(StatusBarNotification) callback.

Note: If your listener allows the user to fire a notification's contentIntent by tapping/clicking/etc., you should call this method at that time if the Notification in question has the FLAG_AUTO_CANCEL flag set.

Parameters

key	Notification to dismiss from `getKey()`.

public final void cancelNotification (String pkg, String tag, int id)

Added in API level 18

This method is deprecated.
Use cancelNotification(String) instead. Beginning with L this method will no longer cancel the notification. It will continue to cancel the notification for applications whose targetSdkVersion is earlier than L.

Inform the notification manager about dismissal of a single notification.

Parameters

pkg	Package of the notifying app.
tag	Tag of the notification as specified by the notifying app in `notify(String, int, android.app.Notification)`.
id	ID of the notification as specified by the notifying app in `notify(String, int, android.app.Notification)`.

public final void cancelNotifications (String[] keys)

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.

Parameters

keys	Notifications to dismiss, or `null` to dismiss all.

public StatusBarNotification[] getActiveNotifications ()

Added in API level 18

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.

Returns

An array of active notifications, sorted in natural order.

public NotificationListenerService.RankingMap getCurrentRanking ()

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 onNotificationPosted(StatusBarNotification, RankingMap), 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.

Returns

A NotificationListenerService.RankingMap object providing access to ranking information

public IBinder onBind (Intent intent)

Added in API level 18

Return the communication channel to the service. May return null if clients can not bind to the service. The returned IBinder is usually for a complex interface that has been described using aidl.

Note that unlike other application components, calls on to the IBinder interface returned here may not happen on the main thread of the process. More information about the main thread can be found in Processes and Threads.

Parameters

intent	The Intent that was used to bind to this service, as given to `Context.bindService`. Note that any extras that were included with the Intent at that point will not be seen here.

Returns

Return an IBinder through which clients can call on to the service.

public void onListenerConnected ()

Implement this method to learn about when the listener is enabled and connected to the notification manager. You are safe to call getActiveNotifications() at this time.

public void onNotificationPosted (StatusBarNotification sbn)

Added in API level 18

Implement this method to learn about new notifications as they are posted by apps.

Parameters

sbn	A data structure encapsulating the original `Notification` object as well as its identifying information (tag and id) and source (package name).

public void onNotificationPosted (StatusBarNotification sbn, NotificationListenerService.RankingMap rankingMap)

Implement this method to learn about new notifications as they are posted by apps.

Parameters

sbn	A data structure encapsulating the original `Notification` object as well as its identifying information (tag and id) and source (package name).
rankingMap	The current ranking map that can be used to retrieve ranking information for active notifications, including the newly posted one.

public void onNotificationRankingUpdate (NotificationListenerService.RankingMap rankingMap)

Implement this method to be notified when the notification ranking changes.

Parameters

rankingMap	The current ranking map that can be used to retrieve ranking information for active notifications.

public void onNotificationRemoved (StatusBarNotification sbn)

Added in API level 18

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 StatusBarNotification object you receive will be "light"; that is, the result from getNotification() may be missing some heavyweight fields such as contentView and largeIcon. However, all other fields on StatusBarNotification, sufficient to match this call with a prior call to onNotificationPosted(StatusBarNotification), will be intact.

Parameters

sbn	A data structure encapsulating at least the original information (tag and id) and source (package name) used to post the `Notification` that was just removed.

public void onNotificationRemoved (StatusBarNotification sbn, NotificationListenerService.RankingMap rankingMap)

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.

Parameters

sbn	A data structure encapsulating at least the original information (tag and id) and source (package name) used to post the `Notification` that was just removed.
rankingMap	The current ranking map that can be used to retrieve ranking information for active notifications.

Results

Classes

NotificationListenerService

Class Overview

Summary

Constants

public static final String SERVICE_INTERFACE

Public Constructors

public NotificationListenerService ()

Public Methods

public final void cancelAllNotifications ()

See Also

public final void cancelNotification (String key)

Parameters

public final void cancelNotification (String pkg, String tag, int id)

Parameters

public final void cancelNotifications (String[] keys)

Parameters

public StatusBarNotification[] getActiveNotifications ()

Returns

public NotificationListenerService.RankingMap getCurrentRanking ()

Returns

public IBinder onBind (Intent intent)

Parameters

Returns

public void onListenerConnected ()

public void onNotificationPosted (StatusBarNotification sbn)

Parameters

public void onNotificationPosted (StatusBarNotification sbn, NotificationListenerService.RankingMap rankingMap)

Parameters

public void onNotificationRankingUpdate (NotificationListenerService.RankingMap rankingMap)

Parameters

public void onNotificationRemoved (StatusBarNotification sbn)

Parameters

public void onNotificationRemoved (StatusBarNotification sbn, NotificationListenerService.RankingMap rankingMap)

Parameters