NotificationListenerService - Android SDK

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	Stores ranking related information on a currently active notification.
class	NotificationListenerService.RankingMap	Provides access to ranking information on currently active notifications.

Constants
int	HINT_HOST_DISABLE_EFFECTS	`Listener hints` constant - the primary device UI should disable notification sound, vibrating and other visual or aural effects.
int	INTERRUPTION_FILTER_ALARMS	`Interruption filter` constant - Alarms only interruption filter.
int	INTERRUPTION_FILTER_ALL	`Interruption filter` constant - Normal interruption filter.
int	INTERRUPTION_FILTER_NONE	`Interruption filter` constant - No interruptions filter.
int	INTERRUPTION_FILTER_PRIORITY	`Interruption filter` constant - Priority interruption filter.
int	INTERRUPTION_FILTER_UNKNOWN	`Interruption filter` constant - returned when the value is unavailable for any reason.
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 pkg, String tag, int id) This method was deprecated in API level 21. Use `cancelNotification(String)` instead. Beginning with `LOLLIPOP` this method will no longer cancel the notification. It will continue to cancel the notification for applications whose `targetSdkVersion` is earlier than `LOLLIPOP`.
final void	cancelNotification(String key) Inform the notification manager about dismissal of a single notification.
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).
StatusBarNotification[]	getActiveNotifications(String[] keys) Request one or more notifications by key.
final int	getCurrentInterruptionFilter() Gets the current notification interruption filter active on the host.
final int	getCurrentListenerHints() Gets the set of hints representing current state.
NotificationListenerService.RankingMap	getCurrentRanking() Returns current ranking information.
IBinder	onBind(Intent intent) Return the communication channel to the service.
void	onInterruptionFilterChanged(int interruptionFilter) Implement this method to be notified when the `interruption filter` changed.
void	onListenerConnected() Implement this method to learn about when the listener is enabled and connected to the notification manager.
void	onListenerHintsChanged(int hints) Implement this method to be notified when the `Listener hints` change.
void	onNotificationPosted(StatusBarNotification sbn, NotificationListenerService.RankingMap rankingMap) Implement this method to learn about new notifications as they are posted by apps.
void	onNotificationPosted(StatusBarNotification sbn) 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.
final void	requestInterruptionFilter(int interruptionFilter) Sets the desired `interruption filter`.
final void	requestListenerHints(int hints) Sets the desired `listener hints`.
final void	setNotificationsShown(String[] keys) Inform the notification manager that these notifications have been viewed by the user.

[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

void	attachBaseContext(Context base) Set the base context for this ContextWrapper.
boolean	bindService(Intent service, ServiceConnection conn, int flags) Connect to an application service, creating it if needed.
int	checkCallingOrSelfPermission(String permission) Determine whether the calling process of an IPC or you have been granted a particular permission.
int	checkCallingOrSelfUriPermission(Uri uri, int modeFlags) Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.
int	checkCallingPermission(String permission) Determine whether the calling process of an IPC you are handling has been granted a particular permission.
int	checkCallingUriPermission(Uri uri, int modeFlags) Determine whether the calling process and user ID has been granted permission to access a specific URI.
int	checkPermission(String permission, int pid, int uid) Determine whether the given permission is allowed for a particular process and user ID running in the system.
int	checkSelfPermission(String permission) Determine whether you have been granted a particular permission.
int	checkUriPermission(Uri uri, int pid, int uid, int modeFlags) Determine whether a particular process and user ID has been granted permission to access a specific URI.
int	checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags) Check both a Uri and normal permission.
void	clearWallpaper() This method was deprecated in API level 23. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
Context	createConfigurationContext(Configuration overrideConfiguration) Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
Context	createDisplayContext(Display display) Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display.
Context	createPackageContext(String packageName, int flags) Return a new Context object for the given application name.
String[]	databaseList() Returns an array of strings naming the private databases associated with this Context's application package.
boolean	deleteDatabase(String name) Delete an existing private SQLiteDatabase associated with this Context's application package.
boolean	deleteFile(String name) Delete the given private file associated with this Context's application package.
void	enforceCallingOrSelfPermission(String permission, String message) If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a `SecurityException`.
void	enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message) If the calling process of an IPC or you has not been granted permission to access a specific URI, throw `SecurityException`.
void	enforceCallingPermission(String permission, String message) If the calling process of an IPC you are handling has not been granted a particular permission, throw a `SecurityException`.
void	enforceCallingUriPermission(Uri uri, int modeFlags, String message) If the calling process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
void	enforcePermission(String permission, int pid, int uid, String message) If the given permission is not allowed for a particular process and user ID running in the system, throw a `SecurityException`.
void	enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message) If a particular process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
void	enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message) Enforce both a Uri and normal permission.
String[]	fileList() Returns an array of strings naming the private files associated with this Context's application package.
Context	getApplicationContext() Return the context of the single, global Application object of the current process.
ApplicationInfo	getApplicationInfo() Return the full application info for this context's package.
AssetManager	getAssets() Return an AssetManager instance for your application's package.
Context	getBaseContext()
File	getCacheDir() Returns the absolute path to the application specific cache directory on the filesystem.
ClassLoader	getClassLoader() Return a class loader you can use to retrieve classes in this package.
File	getCodeCacheDir() Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
ContentResolver	getContentResolver() Return a ContentResolver instance for your application's package.
File	getDatabasePath(String name) Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory)` is stored.
File	getDir(String name, int mode) Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
File	getExternalCacheDir() Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()` where the application can place cache files it owns.
File[]	getExternalCacheDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place cache files it owns.
File	getExternalFilesDir(String type) Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()`) where the application can place persistent files it owns.
File[]	getExternalFilesDirs(String type) Returns absolute paths to application-specific directories on all external storage devices where the application can place persistent files it owns.
File[]	getExternalMediaDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place media files.
File	getFileStreamPath(String name) Returns the absolute path on the filesystem where a file created with `openFileOutput(String, int)` is stored.
File	getFilesDir() Returns the absolute path to the directory on the filesystem where files created with `openFileOutput(String, int)` are stored.
Looper	getMainLooper() Return the Looper for the main thread of the current process.
File	getNoBackupFilesDir() Returns the absolute path to the directory on the filesystem similar to `getFilesDir()`.
File	getObbDir() Return the primary external storage directory where this application's OBB files (if there are any) can be found.
File[]	getObbDirs() Returns absolute paths to application-specific directories on all external storage devices where the application's OBB files (if there are any) can be found.
String	getPackageCodePath() Return the full path to this context's primary Android package.
PackageManager	getPackageManager() Return PackageManager instance to find global package information.
String	getPackageName() Return the name of this application's package.
String	getPackageResourcePath() Return the full path to this context's primary Android package.
Resources	getResources() Return a Resources instance for your application's package.
SharedPreferences	getSharedPreferences(String name, int mode) Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.
Object	getSystemService(String name) Return the handle to a system-level service by name.
String	getSystemServiceName(Class<?> serviceClass) Gets the name of the system-level service that is represented by the specified class.
Resources.Theme	getTheme() Return the Theme object associated with this Context.
Drawable	getWallpaper() This method was deprecated in API level 23. Use `WallpaperManager.get()` instead.
int	getWallpaperDesiredMinimumHeight() This method was deprecated in API level 23. Use `WallpaperManager.getDesiredMinimumHeight()` instead.
int	getWallpaperDesiredMinimumWidth() This method was deprecated in API level 23. Use `WallpaperManager.getDesiredMinimumWidth()` instead.
void	grantUriPermission(String toPackage, Uri uri, int modeFlags) Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.
boolean	isRestricted() Indicates whether this Context is restricted.
FileInputStream	openFileInput(String name) Open a private file associated with this Context's application package for reading.
FileOutputStream	openFileOutput(String name, int mode) Open a private file associated with this Context's application package for writing.
SQLiteDatabase	openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory) Open a new private SQLiteDatabase associated with this Context's application package.
SQLiteDatabase	openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler) Open a new private SQLiteDatabase associated with this Context's application package.
Drawable	peekWallpaper() This method was deprecated in API level 23. Use `WallpaperManager.peek()` instead.
Intent	registerReceiver(BroadcastReceiver receiver, IntentFilter filter) Register a BroadcastReceiver to be run in the main activity thread.
Intent	registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler) Register to receive intent broadcasts, to run in the context of `scheduler`.
void	removeStickyBroadcast(Intent intent) This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	removeStickyBroadcastAsUser(Intent intent, UserHandle user) This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	revokeUriPermission(Uri uri, int modeFlags) Remove all permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)`.
void	sendBroadcast(Intent intent) Broadcast the given intent to all interested BroadcastReceivers.
void	sendBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
void	sendBroadcastAsUser(Intent intent, UserHandle user) Version of `sendBroadcast(Intent)` that allows you to specify the user the broadcast will be sent to.
void	sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission) Version of `sendBroadcast(Intent, String)` that allows you to specify the user the broadcast will be sent to.
void	sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of `sendBroadcast(Intent)` that allows you to receive data back from the broadcast.
void	sendOrderedBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
void	sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of `sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)` that allows you to specify the user the broadcast will be sent to.
void	sendStickyBroadcast(Intent intent) This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	sendStickyBroadcastAsUser(Intent intent, UserHandle user) This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	setTheme(int resid) Set the base theme for this context.
void	setWallpaper(Bitmap bitmap) This method was deprecated in API level 23. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
void	setWallpaper(InputStream data) This method was deprecated in API level 23. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
void	startActivities(Intent[] intents) Same as `startActivities(Intent[], Bundle)` with no options specified.
void	startActivities(Intent[] intents, Bundle options) Launch multiple new activities.
void	startActivity(Intent intent) Same as `startActivity(Intent, Bundle)` with no options specified.
void	startActivity(Intent intent, Bundle options) Launch a new activity.
boolean	startInstrumentation(ComponentName className, String profileFile, Bundle arguments) Start executing an `Instrumentation` class.
void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options) Like `startActivity(Intent, Bundle)`, but taking a IntentSender to start.
void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) Same as `startIntentSender(IntentSender, Intent, int, int, int, Bundle)` with no options specified.
ComponentName	startService(Intent service) Request that a given application service be started.
boolean	stopService(Intent name) Request that a given application service be stopped.
void	unbindService(ServiceConnection conn) Disconnect from an application service.
void	unregisterReceiver(BroadcastReceiver receiver) Unregister a previously registered BroadcastReceiver.

From class android.content.Context

abstract boolean	bindService(Intent service, ServiceConnection conn, int flags) Connect to an application service, creating it if needed.
abstract int	checkCallingOrSelfPermission(String permission) Determine whether the calling process of an IPC or you have been granted a particular permission.
abstract int	checkCallingOrSelfUriPermission(Uri uri, int modeFlags) Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.
abstract int	checkCallingPermission(String permission) Determine whether the calling process of an IPC you are handling has been granted a particular permission.
abstract int	checkCallingUriPermission(Uri uri, int modeFlags) Determine whether the calling process and user ID has been granted permission to access a specific URI.
abstract int	checkPermission(String permission, int pid, int uid) Determine whether the given permission is allowed for a particular process and user ID running in the system.
abstract int	checkSelfPermission(String permission) Determine whether you have been granted a particular permission.
abstract int	checkUriPermission(Uri uri, int pid, int uid, int modeFlags) Determine whether a particular process and user ID has been granted permission to access a specific URI.
abstract int	checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags) Check both a Uri and normal permission.
abstract void	clearWallpaper() This method was deprecated in API level 5. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
abstract Context	createConfigurationContext(Configuration overrideConfiguration) Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
abstract Context	createDisplayContext(Display display) Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display.
abstract Context	createPackageContext(String packageName, int flags) Return a new Context object for the given application name.
abstract String[]	databaseList() Returns an array of strings naming the private databases associated with this Context's application package.
abstract boolean	deleteDatabase(String name) Delete an existing private SQLiteDatabase associated with this Context's application package.
abstract boolean	deleteFile(String name) Delete the given private file associated with this Context's application package.
abstract void	enforceCallingOrSelfPermission(String permission, String message) If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a `SecurityException`.
abstract void	enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message) If the calling process of an IPC or you has not been granted permission to access a specific URI, throw `SecurityException`.
abstract void	enforceCallingPermission(String permission, String message) If the calling process of an IPC you are handling has not been granted a particular permission, throw a `SecurityException`.
abstract void	enforceCallingUriPermission(Uri uri, int modeFlags, String message) If the calling process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
abstract void	enforcePermission(String permission, int pid, int uid, String message) If the given permission is not allowed for a particular process and user ID running in the system, throw a `SecurityException`.
abstract void	enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message) If a particular process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
abstract void	enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message) Enforce both a Uri and normal permission.
abstract String[]	fileList() Returns an array of strings naming the private files associated with this Context's application package.
abstract Context	getApplicationContext() Return the context of the single, global Application object of the current process.
abstract ApplicationInfo	getApplicationInfo() Return the full application info for this context's package.
abstract AssetManager	getAssets() Return an AssetManager instance for your application's package.
abstract File	getCacheDir() Returns the absolute path to the application specific cache directory on the filesystem.
abstract ClassLoader	getClassLoader() Return a class loader you can use to retrieve classes in this package.
abstract File	getCodeCacheDir() Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
final int	getColor(int id) Returns a color associated with a particular resource ID and styled for the current theme.
final ColorStateList	getColorStateList(int id) Returns a color state list associated with a particular resource ID and styled for the current theme.
abstract ContentResolver	getContentResolver() Return a ContentResolver instance for your application's package.
abstract File	getDatabasePath(String name) Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory)` is stored.
abstract File	getDir(String name, int mode) Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
final Drawable	getDrawable(int id) Returns a drawable object associated with a particular resource ID and styled for the current theme.
abstract File	getExternalCacheDir() Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()` where the application can place cache files it owns.
abstract File[]	getExternalCacheDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place cache files it owns.
abstract File	getExternalFilesDir(String type) Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()`) where the application can place persistent files it owns.
abstract File[]	getExternalFilesDirs(String type) Returns absolute paths to application-specific directories on all external storage devices where the application can place persistent files it owns.
abstract File[]	getExternalMediaDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place media files.
abstract File	getFileStreamPath(String name) Returns the absolute path on the filesystem where a file created with `openFileOutput(String, int)` is stored.
abstract File	getFilesDir() Returns the absolute path to the directory on the filesystem where files created with `openFileOutput(String, int)` are stored.
abstract Looper	getMainLooper() Return the Looper for the main thread of the current process.
abstract File	getNoBackupFilesDir() Returns the absolute path to the directory on the filesystem similar to `getFilesDir()`.
abstract File	getObbDir() Return the primary external storage directory where this application's OBB files (if there are any) can be found.
abstract File[]	getObbDirs() Returns absolute paths to application-specific directories on all external storage devices where the application's OBB files (if there are any) can be found.
abstract String	getPackageCodePath() Return the full path to this context's primary Android package.
abstract PackageManager	getPackageManager() Return PackageManager instance to find global package information.
abstract String	getPackageName() Return the name of this application's package.
abstract String	getPackageResourcePath() Return the full path to this context's primary Android package.
abstract Resources	getResources() Return a Resources instance for your application's package.
abstract SharedPreferences	getSharedPreferences(String name, int mode) Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.
final String	getString(int resId) Returns a localized string from the application's package's default string table.
final String	getString(int resId, Object... formatArgs) Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `format(String, Object...)`.
final <T> T	getSystemService(Class<T> serviceClass) Return the handle to a system-level service by class.
abstract Object	getSystemService(String name) Return the handle to a system-level service by name.
abstract String	getSystemServiceName(Class<?> serviceClass) Gets the name of the system-level service that is represented by the specified class.
final CharSequence	getText(int resId) Return a localized, styled CharSequence from the application's package's default string table.
abstract Resources.Theme	getTheme() Return the Theme object associated with this Context.
abstract Drawable	getWallpaper() This method was deprecated in API level 5. Use `WallpaperManager.get()` instead.
abstract int	getWallpaperDesiredMinimumHeight() This method was deprecated in API level 5. Use `WallpaperManager.getDesiredMinimumHeight()` instead.
abstract int	getWallpaperDesiredMinimumWidth() This method was deprecated in API level 5. Use `WallpaperManager.getDesiredMinimumWidth()` instead.
abstract void	grantUriPermission(String toPackage, Uri uri, int modeFlags) Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.
boolean	isRestricted() Indicates whether this Context is restricted.
final TypedArray	obtainStyledAttributes(int[] attrs) Retrieve styled attribute information in this Context's theme.
final TypedArray	obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) Retrieve styled attribute information in this Context's theme.
final TypedArray	obtainStyledAttributes(AttributeSet set, int[] attrs) Retrieve styled attribute information in this Context's theme.
final TypedArray	obtainStyledAttributes(int resid, int[] attrs) Retrieve styled attribute information in this Context's theme.
abstract FileInputStream	openFileInput(String name) Open a private file associated with this Context's application package for reading.
abstract FileOutputStream	openFileOutput(String name, int mode) Open a private file associated with this Context's application package for writing.
abstract SQLiteDatabase	openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory) Open a new private SQLiteDatabase associated with this Context's application package.
abstract SQLiteDatabase	openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler) Open a new private SQLiteDatabase associated with this Context's application package.
abstract Drawable	peekWallpaper() This method was deprecated in API level 5. Use `WallpaperManager.peek()` instead.
void	registerComponentCallbacks(ComponentCallbacks callback) Add a new `ComponentCallbacks` to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.
abstract Intent	registerReceiver(BroadcastReceiver receiver, IntentFilter filter) Register a BroadcastReceiver to be run in the main activity thread.
abstract Intent	registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler) Register to receive intent broadcasts, to run in the context of `scheduler`.
abstract void	removeStickyBroadcast(Intent intent) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	removeStickyBroadcastAsUser(Intent intent, UserHandle user) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	revokeUriPermission(Uri uri, int modeFlags) Remove all permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)`.
abstract void	sendBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
abstract void	sendBroadcast(Intent intent) Broadcast the given intent to all interested BroadcastReceivers.
abstract void	sendBroadcastAsUser(Intent intent, UserHandle user) Version of `sendBroadcast(Intent)` that allows you to specify the user the broadcast will be sent to.
abstract void	sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission) Version of `sendBroadcast(Intent, String)` that allows you to specify the user the broadcast will be sent to.
abstract void	sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of `sendBroadcast(Intent)` that allows you to receive data back from the broadcast.
abstract void	sendOrderedBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
abstract void	sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of `sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)` that allows you to specify the user the broadcast will be sent to.
abstract void	sendStickyBroadcast(Intent intent) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	sendStickyBroadcastAsUser(Intent intent, UserHandle user) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	setTheme(int resid) Set the base theme for this context.
abstract void	setWallpaper(InputStream data) This method was deprecated in API level 5. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
abstract void	setWallpaper(Bitmap bitmap) This method was deprecated in API level 5. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
abstract void	startActivities(Intent[] intents, Bundle options) Launch multiple new activities.
abstract void	startActivities(Intent[] intents) Same as `startActivities(Intent[], Bundle)` with no options specified.
abstract void	startActivity(Intent intent) Same as `startActivity(Intent, Bundle)` with no options specified.
abstract void	startActivity(Intent intent, Bundle options) Launch a new activity.
abstract boolean	startInstrumentation(ComponentName className, String profileFile, Bundle arguments) Start executing an `Instrumentation` class.
abstract void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options) Like `startActivity(Intent, Bundle)`, but taking a IntentSender to start.
abstract void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) Same as `startIntentSender(IntentSender, Intent, int, int, int, Bundle)` with no options specified.
abstract ComponentName	startService(Intent service) Request that a given application service be started.
abstract boolean	stopService(Intent service) Request that a given application service be stopped.
abstract void	unbindService(ServiceConnection conn) Disconnect from an application service.
void	unregisterComponentCallbacks(ComponentCallbacks callback) Remove a `ComponentCallbacks` object that was previously registered with `registerComponentCallbacks(ComponentCallbacks)`.
abstract void	unregisterReceiver(BroadcastReceiver receiver) Unregister a previously registered BroadcastReceiver.

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

From interface android.content.ComponentCallbacks

Constants

public static final int HINT_HOST_DISABLE_EFFECTS

Added in API level 21

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.

Constant Value: 1 (0x00000001)

public static final int INTERRUPTION_FILTER_ALARMS

Added in API level 23

Interruption filter constant - Alarms only interruption filter.

Constant Value: 4 (0x00000004)

public static final int INTERRUPTION_FILTER_ALL

Added in API level 21

Interruption filter constant - Normal interruption filter.

Constant Value: 1 (0x00000001)

public static final int INTERRUPTION_FILTER_NONE

Added in API level 21

Interruption filter constant - No interruptions filter.

Constant Value: 3 (0x00000003)

public static final int INTERRUPTION_FILTER_PRIORITY

Added in API level 21

Interruption filter constant - Priority interruption filter.

Constant Value: 2 (0x00000002)

public static final int INTERRUPTION_FILTER_UNKNOWN

Added in API level 23

Interruption filter constant - returned when the value is unavailable for any reason. For example, before the notification listener is connected.

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 pkg, String tag, int id)

Added in API level 18

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

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

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 cancelNotification (String key)

Added in API level 21

Inform the notification manager about dismissal of a single notification.

Parameters

key	Notification to dismiss from `getKey()`.

public final void cancelNotifications (String[] keys)

Added in API level 21

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 StatusBarNotification[] getActiveNotifications (String[] keys)

Added in API level 21

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.

Parameters

keys	the keys of the notifications to request

Returns

An array of notifications corresponding to the requested keys, in the same order as the key list.

public final int getCurrentInterruptionFilter ()

Added in API level 21

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 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 onInterruptionFilterChanged(int).

Returns

One of the INTERRUPTION_FILTER_ constants, or INTERRUPTION_FILTER_UNKNOWN when unavailable.

public final int getCurrentListenerHints ()

Added in API level 21

Gets the set of hints representing current state.

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.

Returns

Zero or more of the HINT_ constants.

public NotificationListenerService.RankingMap getCurrentRanking ()

Added in API level 21

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 onInterruptionFilterChanged (int interruptionFilter)

Added in API level 21

Implement this method to be notified when the interruption filter changed.

Parameters

interruptionFilter	The current `interruption filter`.

public void onListenerConnected ()

Added in API level 21

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 onListenerHintsChanged (int hints)

Added in API level 21

Implement this method to be notified when the Listener hints change.

Parameters

hints	The current `listener hints`.

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

Added in API level 21

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 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 onNotificationRankingUpdate (NotificationListenerService.RankingMap rankingMap)

Added in API level 21

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)

Added in API level 21

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.

public final void requestInterruptionFilter (int interruptionFilter)

Added in API level 21

Sets the desired 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 onInterruptionFilterChanged(int).

Parameters

interruptionFilter	One of the INTERRUPTION_FILTER_ constants.

public final void requestListenerHints (int hints)

Added in API level 21

Sets the desired 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 onListenerHintsChanged(int).

Parameters

hints	One or more of the HINT_ constants.

public final void setNotificationsShown (String[] keys)

Added in API level 23

Inform the notification manager that these notifications have been viewed by the user. This should only be called when there is sufficient confidence that the user is looking at the notifications, such as when the notifications appear on the screen due to an explicit user interaction.

Parameters

keys	Notifications to mark as seen.

Results

Classes

NotificationListenerService

Class Overview

Summary

Constants

public static final int HINT_HOST_DISABLE_EFFECTS

public static final int INTERRUPTION_FILTER_ALARMS

public static final int INTERRUPTION_FILTER_ALL

public static final int INTERRUPTION_FILTER_NONE

public static final int INTERRUPTION_FILTER_PRIORITY

public static final int INTERRUPTION_FILTER_UNKNOWN

See Also

public static final String SERVICE_INTERFACE

Public Constructors

public NotificationListenerService ()

Public Methods

public final void cancelAllNotifications ()

See Also

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

Parameters

public final void cancelNotification (String key)

Parameters

public final void cancelNotifications (String[] keys)

Parameters

public StatusBarNotification[] getActiveNotifications ()

Returns

public StatusBarNotification[] getActiveNotifications (String[] keys)

Parameters

Returns

public final int getCurrentInterruptionFilter ()

Returns

public final int getCurrentListenerHints ()

Returns

public NotificationListenerService.RankingMap getCurrentRanking ()

Returns

public IBinder onBind (Intent intent)

Parameters

Returns

public void onInterruptionFilterChanged (int interruptionFilter)

Parameters

public void onListenerConnected ()

public void onListenerHintsChanged (int hints)

Parameters

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

Parameters

public void onNotificationPosted (StatusBarNotification sbn)

Parameters

public void onNotificationRankingUpdate (NotificationListenerService.RankingMap rankingMap)

Parameters

public void onNotificationRemoved (StatusBarNotification sbn)

Parameters

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

Parameters

public final void requestInterruptionFilter (int interruptionFilter)

Parameters

public final void requestListenerHints (int hints)

Parameters

public final void setNotificationsShown (String[] keys)

Parameters