diff options
author | Andrew Solovay <asolovay@google.com> | 2014-05-02 17:42:39 -0700 |
---|---|---|
committer | Andrew Solovay <asolovay@google.com> | 2014-05-08 17:58:30 -0700 |
commit | 3701cbef0f76144d66924b1724abb856e938e340 (patch) | |
tree | 023e636a8c39943605204dee555fd3ace8edd82d /docs/html | |
parent | 937db487443171b75f321190be591c8f3d5f74bb (diff) | |
download | frameworks_base-3701cbef0f76144d66924b1724abb856e938e340.zip frameworks_base-3701cbef0f76144d66924b1724abb856e938e340.tar.gz frameworks_base-3701cbef0f76144d66924b1724abb856e938e340.tar.bz2 |
doc: Documented how to set notification priority.
This is related to change http://ag/459520, where I added info about appropriate
priority constants for setPriority(int)
Doc is staged to:
http://asolovay.mtv:8998/guide/topics/ui/notifiers/notifications.html#Priority
Bug: 13514649
Change-Id: I792e2f02614c88fbcfe1b0714a9c10da27eb6c37
Diffstat (limited to 'docs/html')
-rw-r--r-- | docs/html/guide/topics/ui/notifiers/notifications.jd | 21 |
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 |