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

doc: Documented how to set notification priority.

Browse Source 
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
This commit is contained in:
Andrew Solovay
2014-05-02 17:42:39 -07:00
parent 937db48744
commit 3701cbef0f
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/html/guide/topics/ui/notifiers/notifications.jd
View File

@@ -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