From b8b3645a9799c38ad68549316ebbf7a4849f2e0c Mon Sep 17 00:00:00 2001 From: Scott Main <> Date: Sun, 26 Apr 2009 15:50:49 -0700 Subject: [PATCH] AI 147803: add docs and images for docs on Toast and Notification docs also edit the Notification class doc BUG=1800118 Automated import of CL 147803 --- core/java/android/app/Notification.java | 18 +- docs/html/guide/guide_toc.cs | 4 +- docs/html/guide/topics/ui/notifiers/index.jd | 107 +++++ .../topics/ui/notifiers/notifications.jd | 432 ++++++++++++++++++ docs/html/guide/topics/ui/notifiers/toasts.jd | 154 +++++++ docs/html/images/custom_message.png | Bin 0 -> 11120 bytes docs/html/images/custom_toast.png | Bin 0 -> 19966 bytes docs/html/images/notifications_window.png | Bin 0 -> 10511 bytes docs/html/images/status_bar.png | Bin 0 -> 3719 bytes docs/html/images/toast.png | Bin 0 -> 6544 bytes 10 files changed, 703 insertions(+), 12 deletions(-) create mode 100644 docs/html/guide/topics/ui/notifiers/index.jd create mode 100644 docs/html/guide/topics/ui/notifiers/notifications.jd create mode 100644 docs/html/guide/topics/ui/notifiers/toasts.jd create mode 100755 docs/html/images/custom_message.png create mode 100755 docs/html/images/custom_toast.png create mode 100755 docs/html/images/notifications_window.png create mode 100755 docs/html/images/status_bar.png create mode 100644 docs/html/images/toast.png diff --git a/core/java/android/app/Notification.java b/core/java/android/app/Notification.java index 51fddb1145cbb..9834c75c58d4b 100644 --- a/core/java/android/app/Notification.java +++ b/core/java/android/app/Notification.java @@ -34,6 +34,9 @@ import android.widget.RemoteViews; * A class that represents how a persistent notification is to be presented to * the user using the {@link android.app.NotificationManager}. * + *

For a guide to creating notifications, see the + * Creating Status + * Bar Notifications document in the Dev Guide.

*/ public class Notification implements Parcelable { @@ -52,7 +55,8 @@ public class Notification implements Parcelable /** * Use the default notification vibrate. This will ignore any given - * {@link #vibrate}. + * {@link #vibrate}. Using phone vibration requires the + * {@link android.Manifest.permission#VIBRATE VIBRATE} permission. * * @see #defaults */ @@ -149,8 +153,7 @@ public class Notification implements Parcelable /** - * The pattern with which to vibrate. This pattern will repeat if {@link - * #FLAG_INSISTENT} bit is set in the {@link #flags} field. + * The pattern with which to vibrate. * *

* To vibrate the default pattern, see {@link #defaults}. @@ -228,13 +231,8 @@ public class Notification implements Parcelable /** * Bit to be bitwise-ored into the {@link #flags} field that if set, - * the audio and vibration will be repeated until the notification is - * cancelled. - * - *

- * NOTE: This notion will change when we have decided exactly - * what the UI will be. - *

+ * the audio will be repeated until the notification is + * cancelled or the notification window is opened. */ public static final int FLAG_INSISTENT = 0x00000004; diff --git a/docs/html/guide/guide_toc.cs b/docs/html/guide/guide_toc.cs index 39f4abffba63e..5367cb2e7ec55 100644 --- a/docs/html/guide/guide_toc.cs +++ b/docs/html/guide/guide_toc.cs @@ -19,9 +19,9 @@