summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Sandler <dsandler@android.com>2012-05-10 11:41:48 -0400
committerDaniel Sandler <dsandler@android.com>2012-05-10 13:15:37 -0400
commitd33b803b6bfcbc509dd7cee3ee23f819dfff296e (patch)
treefa8d90aa890f47c160a8de3872a7ebcd602a352d
parente95658c98e4154a2daf0ed70d15d24f8bf3153f0 (diff)
downloadframeworks_base-d33b803b6bfcbc509dd7cee3ee23f819dfff296e.zip
frameworks_base-d33b803b6bfcbc509dd7cee3ee23f819dfff296e.tar.gz
frameworks_base-d33b803b6bfcbc509dd7cee3ee23f819dfff296e.tar.bz2
Clean up API docs for Notification.
Bug: 6427241 Bug: 6427245 Bug: 6427814 Change-Id: I91d741513e3b345d2b9f28ad0a1bf11b0a898076
-rw-r--r--api/current.txt6
-rw-r--r--core/java/android/app/Notification.java15
2 files changed, 14 insertions, 7 deletions
diff --git a/api/current.txt b/api/current.txt
index b10c107..4b10577 100644
--- a/api/current.txt
+++ b/api/current.txt
@@ -3722,10 +3722,6 @@ package android.app {
field public static final int FLAG_ONGOING_EVENT = 2; // 0x2
field public static final int FLAG_ONLY_ALERT_ONCE = 8; // 0x8
field public static final int FLAG_SHOW_LIGHTS = 1; // 0x1
- field public static final java.lang.String KIND_CALL = "android.call";
- field public static final java.lang.String KIND_EMAIL = "android.email";
- field public static final java.lang.String KIND_EVENT = "android.event";
- field public static final java.lang.String KIND_MESSAGE = "android.message";
field public static final java.lang.String KIND_PROMO = "android.promo";
field public static final int PRIORITY_DEFAULT = 0; // 0x0
field public static final int PRIORITY_HIGH = 1; // 0x1
@@ -3743,7 +3739,6 @@ package android.app {
field public android.app.PendingIntent fullScreenIntent;
field public int icon;
field public int iconLevel;
- field public java.lang.String[] kind;
field public android.graphics.Bitmap largeIcon;
field public int ledARGB;
field public int ledOffMS;
@@ -3778,7 +3773,6 @@ package android.app {
public static class Notification.Builder {
ctor public Notification.Builder(android.content.Context);
method public android.app.Notification.Builder addAction(int, java.lang.CharSequence, android.app.PendingIntent);
- method public android.app.Notification.Builder addKind(java.lang.String);
method public android.app.Notification build();
method public deprecated android.app.Notification getNotification();
method public android.app.Notification.Builder setAutoCancel(boolean);
diff --git a/core/java/android/app/Notification.java b/core/java/android/app/Notification.java
index edeeee2..ed9babf 100644
--- a/core/java/android/app/Notification.java
+++ b/core/java/android/app/Notification.java
@@ -390,21 +390,25 @@ public class Notification implements Parcelable
public int priority;
/**
+ * @hide
* Notification type: incoming call (voice or video) or similar synchronous communication request.
*/
public static final String KIND_CALL = "android.call";
/**
+ * @hide
* Notification type: incoming direct message (SMS, instant message, etc.).
*/
public static final String KIND_MESSAGE = "android.message";
/**
+ * @hide
* Notification type: asynchronous bulk message (email).
*/
public static final String KIND_EMAIL = "android.email";
/**
+ * @hide
* Notification type: calendar event.
*/
public static final String KIND_EVENT = "android.event";
@@ -415,6 +419,7 @@ public class Notification implements Parcelable
public static final String KIND_PROMO = "android.promo";
/**
+ * @hide
* If this notification matches of one or more special types (see the <code>KIND_*</code>
* constants), add them here, best match first.
*/
@@ -977,8 +982,14 @@ public class Notification implements Parcelable
}
/**
- * Show the {@link Notification#when} field as a countdown (or count-up) timer instead of a timestamp.
+ * Show the {@link Notification#when} field as a stopwatch.
+ *
+ * Instead of presenting <code>when</code> as a timestamp, the notification will show an
+ * automatically updating display of the minutes and seconds since <code>when</code>.
+ *
+ * Useful when showing an elapsed time (like an ongoing phone call).
*
+ * @see android.widget.Chronometer
* @see Notification#when
*/
public Builder setUsesChronometer(boolean b) {
@@ -1303,6 +1314,8 @@ public class Notification implements Parcelable
}
/**
+ * @hide
+ *
* Add a kind (category) to this notification. Optional.
*
* @see Notification#kind