summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAndrew Solovay <asolovay@google.com>2014-05-09 21:10:28 +0000
committerAndroid Git Automerger <android-git-automerger@android.com>2014-05-09 21:10:28 +0000
commit5119f6e6db1cd7254ee71537a56bd133eb7e6a09 (patch)
treeb3a46cc088796187512ef13f570578b1072576cd /docs
parentc4ebd014cec31a2d5a18c2339681ca71bd1f5d0e (diff)
parent3f22f22aab7d641b9d56e57a2ceec6614e09a5d8 (diff)
downloadframeworks_base-5119f6e6db1cd7254ee71537a56bd133eb7e6a09.zip
frameworks_base-5119f6e6db1cd7254ee71537a56bd133eb7e6a09.tar.gz
frameworks_base-5119f6e6db1cd7254ee71537a56bd133eb7e6a09.tar.bz2
am 3f22f22a: am bff632c8: Merge "doc: Documented how to set notification priority." into klp-docs
* commit '3f22f22aab7d641b9d56e57a2ceec6614e09a5d8': doc: Documented how to set notification priority.
Diffstat (limited to 'docs')
-rw-r--r--docs/html/guide/topics/ui/notifiers/notifications.jd21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/html/guide/topics/ui/notifiers/notifications.jd b/docs/html/guide/topics/ui/notifiers/notifications.jd
index 3b1292e..59c2269 100644
--- a/docs/html/guide/topics/ui/notifiers/notifications.jd
+++ b/docs/html/guide/topics/ui/notifiers/notifications.jd
@@ -16,6 +16,7 @@ page.title=Notifications
<li><a href="#Required">Required notification contents</a></li>
<li><a href="#Optional">Optional notification contents and settings</a></li>
<li><a href="#Actions">Notification actions</a></li>
+ <li><a href="#Priority">Notification priority</a></li>
<li><a href="#SimpleNotification">Creating a simple notification</a></li>
<li><a href="#ApplyStyle">Applying a big view style to a notification</a></li>
<li><a href="#Compatibility">Handling compatibility</a></li>
@@ -290,6 +291,26 @@ page.title=Notifications
{@link android.support.v4.app.NotificationCompat.Builder}.
</p>
<!-- ------------------------------------------------------------------------------------------ -->
+<h3 id="Priority">Notification priority</h3>
+<p>
+ If you wish, you can set the priority of a notification. The priority acts
+ as a hint to the device UI about how the notification should be displayed.
+ To set a notification's priority, call {@link
+ android.support.v4.app.NotificationCompat.Builder#setPriority(int)
+ NotificationCompat.Builder.setPriority()} and pass in one of the {@link
+ android.support.v4.app.NotificationCompat} priority constants. There are
+ five priority levels, ranging from {@link
+ android.support.v4.app.NotificationCompat#PRIORITY_MIN} (-2) to {@link
+ android.support.v4.app.NotificationCompat#PRIORITY_MAX} (2); if not set, the
+ priority defaults to {@link
+ android.support.v4.app.NotificationCompat#PRIORITY_DEFAULT} (0).
+</p>
+<p> For information about setting an appropriate priority level, see "Correctly
+ set and manage notification priority" in the <a
+ href="{@docRoot}design/patterns/notifications.html">Notifications</a> Design
+ guide.
+</p>
+<!-- ------------------------------------------------------------------------------------------ -->
<h3 id="SimpleNotification">Creating a simple notification</h3>
<p>
The following snippet illustrates a simple notification that specifies an activity to open when