| java.lang.Object | |
| ↳ | android.app.NotificationManager |
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:
Each of the notify methods takes an int id parameter and optionally a
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) or cancel(String, int) method to clear
this notification.
You do not instantiate this class directly; instead, retrieve it through
getSystemService(Class.
For a guide to creating notifications, read the Status Bar Notifications developer guide.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| NotificationManager.Policy | Notification policy configuration. | ||||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | ACTION_INTERRUPTION_FILTER_CHANGED | Intent that is broadcast when the state of getCurrentInterruptionFilter() changes. | |||||||||
| String | ACTION_NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED |
Intent that is broadcast when the state of isNotificationPolicyAccessGranted()
changes.
|
|||||||||
| String | ACTION_NOTIFICATION_POLICY_CHANGED | Intent that is broadcast when the state of getNotificationPolicy() changes. | |||||||||
| 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.
|
|||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Cancel a previously shown notification.
| |||||||||||
Cancel a previously shown notification.
| |||||||||||
Cancel all previously shown notifications.
| |||||||||||
Recover a list of active notifications: ones that have been posted by the calling app that
have not yet been dismissed by the user or
cancel(String, int)ed by the app.
| |||||||||||
Gets the current notification interruption filter.
| |||||||||||
Gets the current notification policy.
| |||||||||||
Checks the ability to read/modify notification policy for the calling package.
| |||||||||||
Post a notification to be shown in the status bar.
| |||||||||||
Post a notification to be shown in the status bar.
| |||||||||||
Sets the current notification interruption filter.
| |||||||||||
Sets the current notification policy.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Intent that is broadcast when the state of getCurrentInterruptionFilter() changes. This broadcast is only sent to registered receivers.
Intent that is broadcast when the state of isNotificationPolicyAccessGranted()
changes.
This broadcast is only sent to registered receivers, and only to the apps that have changed.
Intent that is broadcast when the state of getNotificationPolicy() changes. This broadcast is only sent to registered receivers.
Interruption filter constant -
Alarms only interruption filter.
Interruption filter constant -
Normal interruption filter.
Interruption filter constant -
No interruptions filter.
Interruption filter constant -
Priority interruption filter.
Interruption filter constant - returned when
the value is unavailable for any reason.
Cancel a previously shown notification. If it's transient, the view will be hidden. If it's persistent, it will be removed from the status bar.
Cancel a previously shown notification. If it's transient, the view will be hidden. If it's persistent, it will be removed from the status bar.
Cancel all previously shown notifications. See cancel(int) for the
detailed behavior.
Recover a list of active notifications: ones that have been posted by the calling app that
have not yet been dismissed by the user or cancel(String, int)ed by the app.
Each notification is embedded in a StatusBarNotification object, including the
original tag and id supplied to
notify()
(via getTag() and
getId()) as well as a copy of the original
Notification object (via getNotification()).
Developers
StatusBarNotification.
Gets the current notification interruption filter.
The interruption filter defines which notifications are allowed to interrupt the user (e.g. via sound & vibration) and is applied globally.
Only available if policy access is granted to this package.
See isNotificationPolicyAccessGranted().
Gets the current notification policy.
Only available if policy access is granted to this package.
See isNotificationPolicyAccessGranted().
Checks the ability to read/modify notification policy for the calling package.
Returns true if the calling package can read/modify notification policy.
Request policy access by sending the user to the activity that matches the system intent
action ACTION_NOTIFICATION_POLICY_ACCESS_SETTINGS.
Use ACTION_NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED to listen for
user grant or denial of this access.
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.
| id | An identifier for this notification unique within your application. |
|---|---|
| notification | A Notification object describing what to show the user. Must not
be null.
|
Post 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.
| tag | A string identifier for this notification. May be null. |
|---|---|
| id | An identifier for this notification. The pair (tag, id) must be unique within your application. |
| notification | A Notification object describing what to
show the user. Must not be null.
|
Sets the current notification interruption filter.
The interruption filter defines which notifications are allowed to interrupt the user (e.g. via sound & vibration) and is applied globally.
Only available if policy access is granted to this package.
See isNotificationPolicyAccessGranted().
Sets the current notification policy.
Only available if policy access is granted to this package.
See isNotificationPolicyAccessGranted().
| policy | The new desired policy. |
|---|