NotificationManager  |  Android Developers (original) (raw)

public class NotificationManager
extends [Object](/reference/java/lang/Object) ``

Class to notify the user of events that happen. This is how you tell the user that something has happened in the background.

Notifications can take different forms:

• A persistent icon that goes in the status bar and is accessible through the launcher, (when the user selects it, a designated Intent can be launched),
• Turning on or flashing LEDs on the device, or
• Alerting the user by flashing the backlight, playing a sound, or vibrating.

Each of the notify methods takes an int id parameter and optionally a[String](/reference/java/lang/String) tag parameter, which may be null. These parameters are used to form a pair (tag, id), or (null, id) if tag is unspecified. This pair identifies this notification from your app to the system, so that pair should be unique within your app. If you call one of the notify methods with a (tag, id) pair that is currently active and a new set of notification parameters, it will be updated. For example, if you pass a new status bar icon, the old icon in the status bar will be replaced with the new one. This is also the same tag and id you pass to the [cancel(int)](/reference/android/app/NotificationManager#cancel%28int%29) or [cancel(java.lang.String, int)](/reference/android/app/NotificationManager#cancel%28java.lang.String,%20int%29) method to clear this notification.

Summary

Constants

ACTION_APP_BLOCK_STATE_CHANGED

public static final String ACTION_APP_BLOCK_STATE_CHANGED

Intent that is broadcast when an application is blocked or unblocked. This broadcast is only sent to the app whose block state has changed. Input: nothing Output: [EXTRA_BLOCKED_STATE](/reference/android/app/NotificationManager#EXTRA%5FBLOCKED%5FSTATE)

Constant Value: "android.app.action.APP_BLOCK_STATE_CHANGED"

ACTION_AUTOMATIC_ZEN_RULE

public static final String ACTION_AUTOMATIC_ZEN_RULE

Activity Action: Launch an Automatic Zen Rule configuration screen

Input: Optionally, [EXTRA_AUTOMATIC_RULE_ID](/reference/android/app/NotificationManager#EXTRA%5FAUTOMATIC%5FRULE%5FID), if the configuration screen for an existing rule should be displayed. If the rule id is missing or null, apps should display a configuration screen where users can create a new instance of the rule.

Output: Nothing

You can have multiple activities handling this intent, if you support multiple[rules](/reference/android/app/AutomaticZenRule). In order for the system to properly display all of your rule types so that users can create new instances or configure existing ones, you need to add some extra metadata ([META_DATA_AUTOMATIC_RULE_TYPE](/reference/android/app/NotificationManager#META%5FDATA%5FAUTOMATIC%5FRULE%5FTYPE)) to your activity tag in your manifest. If you'd like to limit the number of rules a user can create from this flow, you can additionally optionally include[META_DATA_RULE_INSTANCE_LIMIT](/reference/android/app/NotificationManager#META%5FDATA%5FRULE%5FINSTANCE%5FLIMIT). For example,

Constant Value: "android.app.action.AUTOMATIC_ZEN_RULE"

ACTION_CONSOLIDATED_NOTIFICATION_POLICY_CHANGED

public static final String ACTION_CONSOLIDATED_NOTIFICATION_POLICY_CHANGED

Intent that is broadcast when the state of [getConsolidatedNotificationPolicy()](/reference/android/app/NotificationManager#getConsolidatedNotificationPolicy%28%29) changes.

This broadcast is only sent to registered receivers and receivers in packages that have been granted Do Not Disturb access (see [isNotificationPolicyAccessGranted()](/reference/android/app/NotificationManager#isNotificationPolicyAccessGranted%28%29)).

Constant Value: "android.app.action.CONSOLIDATED_NOTIFICATION_POLICY_CHANGED"

ACTION_INTERRUPTION_FILTER_CHANGED

public static final String ACTION_INTERRUPTION_FILTER_CHANGED

Intent that is broadcast when the state of getCurrentInterruptionFilter() changes.

This broadcast is only sent to registered receivers and (starting from[Build.VERSION_CODES#Q](/reference/android/os/Build.VERSION%5FCODES#Q)) receivers in packages that have been granted Do Not Disturb access (see [isNotificationPolicyAccessGranted()](/reference/android/app/NotificationManager#isNotificationPolicyAccessGranted%28%29)).

Constant Value: "android.app.action.INTERRUPTION_FILTER_CHANGED"

ACTION_NOTIFICATION_CHANNEL_GROUP_BLOCK_STATE_CHANGED

public static final String ACTION_NOTIFICATION_CHANNEL_GROUP_BLOCK_STATE_CHANGED

Intent that is broadcast when a [NotificationChannelGroup](/reference/android/app/NotificationChannelGroup) is[blocked](/reference/android/app/NotificationChannelGroup#isBlocked%28%29) or unblocked. This broadcast is only sent to the app that owns the channel group that has changed. Input: nothing Output: [EXTRA_NOTIFICATION_CHANNEL_GROUP_ID](/reference/android/app/NotificationManager#EXTRA%5FNOTIFICATION%5FCHANNEL%5FGROUP%5FID) Output: [EXTRA_BLOCKED_STATE](/reference/android/app/NotificationManager#EXTRA%5FBLOCKED%5FSTATE)

Constant Value: "android.app.action.NOTIFICATION_CHANNEL_GROUP_BLOCK_STATE_CHANGED"

ACTION_NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED

public static final String ACTION_NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED

Intent that is broadcast when the state of [isNotificationPolicyAccessGranted()](/reference/android/app/NotificationManager#isNotificationPolicyAccessGranted%28%29) changes. This broadcast is only sent to registered receivers, and only to the apps that have changed.

Constant Value: "android.app.action.NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED"

AUTOMATIC_RULE_STATUS_ACTIVATED

public static final int AUTOMATIC_RULE_STATUS_ACTIVATED

Constant value for [EXTRA_AUTOMATIC_ZEN_RULE_STATUS](/reference/android/app/NotificationManager#EXTRA%5FAUTOMATIC%5FZEN%5FRULE%5FSTATUS) - the given rule has been activated by the user or cross device sync. Sent from[Build.VERSION_CODES#VANILLA_ICE_CREAM](/reference/android/os/Build.VERSION%5FCODES#VANILLA%5FICE%5FCREAM). If the rule owner has a mode that includes a DND component, the rule owner should activate any extra behavior that's part of that mode in response to this broadcast.

Constant Value: 4 (0x00000004)

BUBBLE_PREFERENCE_ALL

public static final int BUBBLE_PREFERENCE_ALL

Indicates that all bubbles are allowed from the app. If the app sends bubbles, the bubble will appear along with the notification.

Constant Value: 1 (0x00000001)

BUBBLE_PREFERENCE_NONE

public static final int BUBBLE_PREFERENCE_NONE

Indicates that the no bubbles are allowed from the app. If the app sends bubbles, only the notification will appear. The notification will have an affordance allowing the user to bubble it. If the user selects this affordance, that notification is approved to bubble and the apps' bubble preference will be upgraded to [BUBBLE_PREFERENCE_SELECTED](/reference/android/app/NotificationManager#BUBBLE%5FPREFERENCE%5FSELECTED).

Constant Value: 0 (0x00000000)

BUBBLE_PREFERENCE_SELECTED

public static final int BUBBLE_PREFERENCE_SELECTED

Indicates that only notifications selected by the user will appear as bubbles. If the app sends bubbles that haven't been selected, only the notification appear. If the bubble has been approved by the user, it will appear along with the notification.

Constant Value: 2 (0x00000002)

IMPORTANCE_DEFAULT

public static final int IMPORTANCE_DEFAULT

Default notification importance: shows everywhere, makes noise, but does not visually intrude.

Constant Value: 3 (0x00000003)

IMPORTANCE_HIGH

public static final int IMPORTANCE_HIGH

Higher notification importance: shows everywhere, makes noise and peeks. May use full screen intents.

Constant Value: 4 (0x00000004)

IMPORTANCE_LOW

public static final int IMPORTANCE_LOW

Low notification importance: Shows in the shade, and potentially in the status bar (see [shouldHideSilentStatusBarIcons()](/reference/android/app/NotificationManager#shouldHideSilentStatusBarIcons%28%29)), but is not audibly intrusive.

Constant Value: 2 (0x00000002)

IMPORTANCE_MAX

public static final int IMPORTANCE_MAX

Unused.

Constant Value: 5 (0x00000005)

IMPORTANCE_MIN

public static final int IMPORTANCE_MIN

Min notification importance: only shows in the shade, below the fold. This should not be used with [Service.startForeground](/reference/android/app/Service#startForeground%28int,%20android.app.Notification%29) since a foreground service is supposed to be something the user cares about so it does not make semantic sense to mark its notification as minimum importance. If you do this as of Android version [Build.VERSION_CODES.O](/reference/android/os/Build.VERSION%5FCODES#O), the system will show a higher-priority notification about your app running in the background.

Constant Value: 1 (0x00000001)

IMPORTANCE_NONE

public static final int IMPORTANCE_NONE

A notification with no importance: does not show in the shade.

Constant Value: 0 (0x00000000)

IMPORTANCE_UNSPECIFIED

public static final int IMPORTANCE_UNSPECIFIED

Value signifying that the user has not expressed an importance. This value is for persisting preferences, and should never be associated with an actual notification.

Constant Value: -1000 (0xfffffc18)

INTERRUPTION_FILTER_ALARMS

public static final int INTERRUPTION_FILTER_ALARMS

[Interruption filter](/reference/android/app/NotificationManager#getCurrentInterruptionFilter%28%29) constant - Alarms only interruption filter - all notifications except those of category[Notification#CATEGORY_ALARM](/reference/android/app/Notification#CATEGORY%5FALARM) are suppressed. Some audio streams are muted.

Constant Value: 4 (0x00000004)

INTERRUPTION_FILTER_ALL

public static final int INTERRUPTION_FILTER_ALL

[Interruption filter](/reference/android/app/NotificationManager#getCurrentInterruptionFilter%28%29) constant - Normal interruption filter - no notifications are suppressed.

Constant Value: 1 (0x00000001)

INTERRUPTION_FILTER_NONE

public static final int INTERRUPTION_FILTER_NONE

[Interruption filter](/reference/android/app/NotificationManager#getCurrentInterruptionFilter%28%29) constant - No interruptions filter - all notifications are suppressed and all audio streams (except those used for phone calls) and vibrations are muted.

Constant Value: 3 (0x00000003)

INTERRUPTION_FILTER_UNKNOWN

public static final int INTERRUPTION_FILTER_UNKNOWN

[Interruption filter](/reference/android/app/NotificationManager#getCurrentInterruptionFilter%28%29) constant - returned when the value is unavailable for any reason.

Constant Value: 0 (0x00000000)

META_DATA_AUTOMATIC_RULE_TYPE

public static final String META_DATA_AUTOMATIC_RULE_TYPE

A required meta-data tag for activities that handle[ACTION_AUTOMATIC_ZEN_RULE](/reference/android/app/NotificationManager#ACTION%5FAUTOMATIC%5FZEN%5FRULE). This tag should contain a localized name of the type of the zen rule provided by the activity.

Constant Value: "android.service.zen.automatic.ruleType"

META_DATA_RULE_INSTANCE_LIMIT

public static final String META_DATA_RULE_INSTANCE_LIMIT

An optional meta-data tag for activities that handle[ACTION_AUTOMATIC_ZEN_RULE](/reference/android/app/NotificationManager#ACTION%5FAUTOMATIC%5FZEN%5FRULE). This tag should contain the maximum number of rule instances that can be created for this rule type. Omit or enter a value <= 0 to allow unlimited instances.

Constant Value: "android.service.zen.automatic.ruleInstanceLimit"

Public methods

addAutomaticZenRule

public String addAutomaticZenRule (AutomaticZenRule automaticZenRule)

Creates the given zen rule.

Throws a SecurityException if policy access is not granted to this package. See [isNotificationPolicyAccessGranted()](/reference/android/app/NotificationManager#isNotificationPolicyAccessGranted%28%29).

areBubblesAllowed

public boolean areBubblesAllowed ()

This method was deprecated in API level 31.
use [getBubblePreference()](/reference/android/app/NotificationManager#getBubblePreference%28%29) instead.

Gets whether all notifications posted by this app can appear outside of the notification shade, floating over other apps' content.

This value will be ignored for notifications that are posted to channels that do not allow bubbles ([NotificationChannel#canBubble()](/reference/android/app/NotificationChannel#canBubble%28%29)).

areBubblesEnabled

public boolean areBubblesEnabled ()

Returns whether bubbles are enabled at the feature level for the current user. When enabled, notifications able to bubble will display an affordance allowing the user to bubble them.

areNotificationsEnabled

public boolean areNotificationsEnabled ()

Returns whether notifications from the calling package are enabled.

areNotificationsPaused

public boolean areNotificationsPaused ()

Returns whether notifications from this package are temporarily hidden. This could be done because the package was marked as distracting to the user viaPackageManager#setDistractingPackageRestrictions(String[], int) or because the package is PackageManager#setPackagesSuspended(String[], boolean, PersistableBundle, PersistableBundle, SuspendDialogInfo) suspended.

cancel

public void cancel (int id)

Cancels a previously posted notification.

If the notification does not currently represent a[foreground service](/reference/android/app/Service#startForeground%28int,%20android.app.Notification%29) or a[user-initiated job](/reference/android/app/job/JobInfo.Builder#setUserInitiated%28boolean%29), it will be removed from the UI and live[notification listeners](/reference/android/service/notification/NotificationListenerService) will be informed so they can remove the notification from their UIs.

cancel

public void cancel (String tag, int id)

Cancels a previously posted notification.

If the notification does not currently represent a[foreground service](/reference/android/app/Service#startForeground%28int,%20android.app.Notification%29) or a[user-initiated job](/reference/android/app/job/JobInfo.Builder#setUserInitiated%28boolean%29), it will be removed from the UI and live[notification listeners](/reference/android/service/notification/NotificationListenerService) will be informed so they can remove the notification from their UIs.

cancelAll

public void cancelAll ()

Cancel all previously shown notifications. See [cancel(int)](/reference/android/app/NotificationManager#cancel%28int%29) for the detailed behavior.

cancelAsPackage

public void cancelAsPackage (String targetPackage, String tag, int id)

Cancels a previously posted notification.

If the notification does not currently represent a[foreground service](/reference/android/app/Service#startForeground%28int,%20android.app.Notification%29) or a[user-initiated job](/reference/android/app/job/JobInfo.Builder#setUserInitiated%28boolean%29), it will be removed from the UI and live[notification listeners](/reference/android/service/notification/NotificationListenerService) will be informed so they can remove the notification from their UIs.

This method may be used by [a notification delegate](/reference/android/app/NotificationManager#getNotificationDelegate%28%29) to cancel notifications that they have posted via [notifyAsPackage(java.lang.String, java.lang.String, int, android.app.Notification)](/reference/android/app/NotificationManager#notifyAsPackage%28java.lang.String,%20java.lang.String,%20int,%20android.app.Notification%29).

createNotificationChannel

public void createNotificationChannel (NotificationChannel channel)

Creates a notification channel that notifications can be posted to. This can also be used to restore a deleted channel and to update an existing channel's name, description, group, and/or importance.

The name and description should only be changed if the locale changes or in response to the user renaming this channel. For example, if a user has a channel named 'Messages' and the user changes their locale, this channel's name should be updated with the translation of 'Messages' in the new locale.

The importance of an existing channel will only be changed if the new importance is lower than the current value and the user has not altered any settings on this channel.

The group an existing channel will only be changed if the channel does not already belong to a group. All other fields are ignored for channels that already exist.

createNotificationChannelGroup

public void createNotificationChannelGroup (NotificationChannelGroup group)

Creates a group container for [NotificationChannel](/reference/android/app/NotificationChannel) objects. This can be used to rename an existing group.

Group information is only used for presentation, not for behavior. Groups are optional for channels, and you can have a mix of channels that belong to groups and channels that do not.

For example, if your application supports multiple accounts, and those accounts will have similar channels, you can create a group for each account with account specific labels instead of appending account information to each channel's label.

createNotificationChannelGroups

public void createNotificationChannelGroups (List<NotificationChannelGroup> groups)

Creates multiple notification channel groups.

deleteNotificationChannel

public void deleteNotificationChannel (String channelId)

Deletes the given notification channel.

If you [create](/reference/android/app/NotificationManager#createNotificationChannel%28android.app.NotificationChannel%29) a new channel with this same id, the deleted channel will be un-deleted with all of the same settings it had before it was deleted.

deleteNotificationChannelGroup

public void deleteNotificationChannelGroup (String groupId)

Deletes the given notification channel group, and all notification channels that belong to it.

getNotificationChannelGroup

public NotificationChannelGroup getNotificationChannelGroup (String channelGroupId)

Returns the notification channel group settings for a given channel group id. The channel group must belong to your package, or null will be returned.

getNotificationDelegate

public String getNotificationDelegate ()

Returns the [delegate](/reference/android/app/NotificationManager#setNotificationDelegate%28java.lang.String%29) that can post notifications on your behalf, if there currently is one.

isNotificationListenerAccessGranted

public boolean isNotificationListenerAccessGranted (ComponentName listener)

Checks whether the user has approved a given[NotificationListenerService](/reference/android/service/notification/NotificationListenerService).

The listener service must belong to the calling app.

Apps can request notification listener access by sending the user to the activity that matches the system intent action[Settings.ACTION_NOTIFICATION_LISTENER_SETTINGS](/reference/android/provider/Settings#ACTION%5FNOTIFICATION%5FLISTENER%5FSETTINGS).

isNotificationPolicyAccessGranted

public boolean isNotificationPolicyAccessGranted ()

Checks the ability to modify notification do not disturb policy for the calling package.

Returns true if the calling package can modify notification policy.

Apps can request policy access by sending the user to the activity that matches the system intent action [Settings.ACTION_NOTIFICATION_POLICY_ACCESS_SETTINGS](/reference/android/provider/Settings#ACTION%5FNOTIFICATION%5FPOLICY%5FACCESS%5FSETTINGS).

Use [ACTION_NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED](/reference/android/app/NotificationManager#ACTION%5FNOTIFICATION%5FPOLICY%5FACCESS%5FGRANTED%5FCHANGED) to listen for user grant or denial of this access.

matchesCallFilter

public boolean matchesCallFilter (Uri uri)

Returns whether a call from the provided URI is permitted to notify the user.

A true return value indicates one of the following: Do Not Disturb is not currently active; or the caller is a repeat caller and the current policy allows interruptions from repeat callers; or the caller is in the user's set of contacts whose calls are allowed to interrupt Do Not Disturb.

If Do Not Disturb is enabled and either no interruptions or only alarms are allowed, this method will return false regardless of input.

The provided URI should be a tel: or mailto: schema URI indicating the source of the call. For an accurate answer regarding whether the caller matches the user's permitted contacts, the path part of the URI must match an entry the Contacts database in the appropriate column.

Passing in a [ContactsContract.Contacts.CONTENT_LOOKUP_URI](/reference/android/provider/ContactsContract.Contacts#CONTENT%5FLOOKUP%5FURI) is also permissible, but should only be used for priority contact interruptions and may not provide accurate results in the case of repeat callers.

See also [Person.Builder#setUri](/reference/android/app/Person.Builder#setUri%28java.lang.String%29) and[ContactsContract.Contacts.CONTENT_LOOKUP_URI](/reference/android/provider/ContactsContract.Contacts#CONTENT%5FLOOKUP%5FURI) for more information.

Callers of this method must have notification listener access, permission to read contacts, or have system permissions.

NOTE: This method calls into Contacts, which may take some time, and should not be called on the main thread.

This method may take several seconds to complete, so it should only be called from a worker thread.

notify

public void notify (int id, Notification notification)

Post a notification to be shown in the status bar. If a notification with the same id has already been posted by your application and has not yet been canceled, it will be replaced by the updated information.

notify

public void notify (String tag, int id, Notification notification)

Posts a notification to be shown in the status bar. If a notification with the same tag and id has already been posted by your application and has not yet been canceled, it will be replaced by the updated information. All [listener services](/reference/android/service/notification/NotificationListenerService) will be granted [Intent#FLAG_GRANT_READ_URI_PERMISSION](/reference/android/content/Intent#FLAG%5FGRANT%5FREAD%5FURI%5FPERMISSION) access to any [uris](/reference/android/net/Uri) provided on this notification or the[NotificationChannel](/reference/android/app/NotificationChannel) this notification is posted to using[Context#grantUriPermission(String, Uri, int)](/reference/android/content/Context#grantUriPermission%28java.lang.String,%20android.net.Uri,%20int%29). Permission will be revoked when the notification is canceled, or you can revoke permissions with[Context#revokeUriPermission(Uri, int)](/reference/android/content/Context#revokeUriPermission%28android.net.Uri,%20int%29).

notifyAsPackage

public void notifyAsPackage (String targetPackage, String tag, int id, Notification notification)

Posts a notification as a specified package to be shown in the status bar. If a notification with the same tag and id has already been posted for that package and has not yet been canceled, it will be replaced by the updated information. All [listener services](/reference/android/service/notification/NotificationListenerService) will be granted [Intent#FLAG_GRANT_READ_URI_PERMISSION](/reference/android/content/Intent#FLAG%5FGRANT%5FREAD%5FURI%5FPERMISSION) access to any [uris](/reference/android/net/Uri) provided on this notification or the[NotificationChannel](/reference/android/app/NotificationChannel) this notification is posted to using[Context#grantUriPermission(String, Uri, int)](/reference/android/content/Context#grantUriPermission%28java.lang.String,%20android.net.Uri,%20int%29). Permission will be revoked when the notification is canceled, or you can revoke permissions with[Context#revokeUriPermission(Uri, int)](/reference/android/content/Context#revokeUriPermission%28android.net.Uri,%20int%29).

removeAutomaticZenRule

public boolean removeAutomaticZenRule (String id)

Deletes the automatic zen rule with the given id.

Throws a SecurityException if policy access is not granted to this package. See [isNotificationPolicyAccessGranted()](/reference/android/app/NotificationManager#isNotificationPolicyAccessGranted%28%29).

Callers can only delete rules that they own. See [AutomaticZenRule#getOwner](/reference/android/app/AutomaticZenRule#getOwner%28%29).

setAutomaticZenRuleState

public void setAutomaticZenRuleState (String id, Condition condition)

Informs the notification manager that the state of an [AutomaticZenRule](/reference/android/app/AutomaticZenRule) has changed. Use this method to put the system into Do Not Disturb mode or request that it exits Do Not Disturb mode. The calling app must own the provided [AutomaticZenRule](/reference/android/app/AutomaticZenRule).

This method can be used in conjunction with or as a replacement to[ConditionProviderService.notifyCondition(Condition)](/reference/android/service/notification/ConditionProviderService#notifyCondition%28android.service.notification.Condition%29).

setNotificationDelegate

public void setNotificationDelegate (String delegate)

Allows a package to post notifications on your behalf using[notifyAsPackage(java.lang.String, java.lang.String, int, android.app.Notification)](/reference/android/app/NotificationManager#notifyAsPackage%28java.lang.String,%20java.lang.String,%20int,%20android.app.Notification%29). This can be used to allow persistent processes to post notifications based on messages received on your behalf from the cloud, without your process having to wake up. You can check if you have an allowed delegate with [getNotificationDelegate()](/reference/android/app/NotificationManager#getNotificationDelegate%28%29) and revoke your delegate by passing null to this method.

shouldHideSilentStatusBarIcons

public boolean shouldHideSilentStatusBarIcons ()

Returns whether the user wants silent notifications (see [IMPORTANCE_LOW](/reference/android/app/NotificationManager#IMPORTANCE%5FLOW) to appear in the status bar.

Only available for [notification listeners](/reference/android/app/NotificationManager#isNotificationListenerAccessGranted%28android.content.ComponentName%29).