Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "NotificationManager: droiddoc documentation improvements"

Browse Source
This commit is contained in:
Brad Fitzpatrick
2010-11-02 14:55:21 -07:00
committed by Android Code Review
parent ef8a810b3b b97c34948e
commit 9df48a0305
1 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
core/java/android/app/NotificationManager.java
View File

@@ -38,13 +38,17 @@ import android.util.Log;
* </ul> * </ul>
* *
* <p> * <p>
* Each of the notify methods takes an int id parameter. This id identifies * Each of the notify methods takes an int id parameter and optionally a
* this notification from your app to the system, so that id should be unique * {@link String} tag parameter, which may be {@code null}. These parameters
* within your app. If you call one of the notify methods with an id that is * are used to form a pair (tag, id), or ({@code null}, id) if tag is
* currently active and a new set of notification parameters, it will be * unspecified. This pair identifies this notification from your app to the
* updated. For example, if you pass a new status bar icon, the old icon in * system, so that pair should be unique within your app. If you call one
* the status bar will be replaced with the new one. This is also the same * of the notify methods with a (tag, id) pair that is currently active and
* id you pass to the {@link #cancel} method to clear this notification. * 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 {@link #cancel(int)} or {@link #cancel(String, int)} method to clear
* this notification.
* *
* <p> * <p>
* You do not instantiate this class directly; instead, retrieve it through * You do not instantiate this class directly; instead, retrieve it through
@@ -93,12 +97,11 @@ public class NotificationManager
/** /**
* Persistent notification on the status bar, * Persistent notification on the status bar,
* *
* @param tag An string identifier for this notification unique within your * @param tag A string identifier for this notification. May be {@code null}.
* application. * @param id An identifier for this notification. The pair (tag, id) must be unique
* within your application.
* @param notification A {@link Notification} object describing how to * @param notification A {@link Notification} object describing how to
* notify the user, other than the view you're providing. Must not be null. * notify the user, other than the view you're providing. Must not be null.
* @return the id of the notification that is associated with the string identifier that
* can be used to cancel the notification
*/ */
public void notify(String tag, int id, Notification notification) public void notify(String tag, int id, Notification notification)
{ {