blob: 0d19bd1fbdd9588b3d18c4a15327520c4d61d295 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.app;
18
Andy Stadler110988c2010-12-03 14:29:16 -080019import com.android.internal.R;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080020
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080021import android.content.Context;
22import android.content.Intent;
Joe Onoratoef1e7762010-09-17 18:38:38 -040023import android.graphics.Bitmap;
Jeff Sharkey098d5802012-04-26 17:30:34 -070024import android.media.AudioManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080025import android.net.Uri;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050026import android.os.Bundle;
Daniel Sandlera0a938c2012-03-15 08:42:37 -040027import android.os.IBinder;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080028import android.os.Parcel;
29import android.os.Parcelable;
Daniel Sandlera2985ed2012-04-03 16:42:00 -040030import android.os.SystemClock;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080031import android.text.TextUtils;
Daniel Sandlera0a938c2012-03-15 08:42:37 -040032import android.util.IntProperty;
Daniel Sandler96fd7c12012-03-30 16:37:36 -040033import android.util.Log;
Joe Onorato8595a3d2010-11-19 18:12:07 -080034import android.view.View;
Jeff Sharkey1c400132011-08-05 14:50:13 -070035import android.widget.ProgressBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080036import android.widget.RemoteViews;
37
Andy Stadler110988c2010-12-03 14:29:16 -080038import java.text.NumberFormat;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050039import java.util.ArrayList;
Joe Onorato561d3852010-11-20 18:09:34 -080040
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080041/**
42 * A class that represents how a persistent notification is to be presented to
43 * the user using the {@link android.app.NotificationManager}.
44 *
Joe Onoratocb109a02011-01-18 17:57:41 -080045 * <p>The {@link Notification.Builder Notification.Builder} has been added to make it
46 * easier to construct Notifications.</p>
47 *
Joe Fernandez558459f2011-10-13 16:47:36 -070048 * <div class="special reference">
49 * <h3>Developer Guides</h3>
50 * <p>For a guide to creating notifications, read the
51 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Status Bar Notifications</a>
52 * developer guide.</p>
53 * </div>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080054 */
55public class Notification implements Parcelable
56{
57 /**
58 * Use all default values (where applicable).
59 */
60 public static final int DEFAULT_ALL = ~0;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050061
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080062 /**
63 * Use the default notification sound. This will ignore any given
64 * {@link #sound}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -050065 *
66
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080067 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -050068 */
69
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080070 public static final int DEFAULT_SOUND = 1;
71
72 /**
73 * Use the default notification vibrate. This will ignore any given
Daniel Sandler2561b0b2012-02-13 21:04:12 -050074 * {@link #vibrate}. Using phone vibration requires the
Scott Mainb8b36452009-04-26 15:50:49 -070075 * {@link android.Manifest.permission#VIBRATE VIBRATE} permission.
Daniel Sandler2561b0b2012-02-13 21:04:12 -050076 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080077 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -050078 */
79
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080080 public static final int DEFAULT_VIBRATE = 2;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050081
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080082 /**
83 * Use the default notification lights. This will ignore the
84 * {@link #FLAG_SHOW_LIGHTS} bit, and {@link #ledARGB}, {@link #ledOffMS}, or
85 * {@link #ledOnMS}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -050086 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080087 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -050088 */
89
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080090 public static final int DEFAULT_LIGHTS = 4;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050091
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080092 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -050093 * A timestamp related to this notification, in milliseconds since the epoch.
94 *
95 * Default value: {@link System#currentTimeMillis() Now}.
96 *
97 * Choose a timestamp that will be most relevant to the user. For most finite events, this
98 * corresponds to the time the event happened (or will happen, in the case of events that have
99 * yet to occur but about which the user is being informed). Indefinite events should be
100 * timestamped according to when the activity began.
101 *
102 * Some examples:
103 *
104 * <ul>
105 * <li>Notification of a new chat message should be stamped when the message was received.</li>
106 * <li>Notification of an ongoing file download (with a progress bar, for example) should be stamped when the download started.</li>
107 * <li>Notification of a completed file download should be stamped when the download finished.</li>
108 * <li>Notification of an upcoming meeting should be stamped with the time the meeting will begin (that is, in the future).</li>
109 * <li>Notification of an ongoing stopwatch (increasing timer) should be stamped with the watch's start time.
110 * <li>Notification of an ongoing countdown timer should be stamped with the timer's end time.
111 * </ul>
112 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800113 */
114 public long when;
115
116 /**
117 * The resource id of a drawable to use as the icon in the status bar.
Daniel Sandlerd952dae2011-02-07 16:33:36 -0500118 * This is required; notifications with an invalid icon resource will not be shown.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800119 */
120 public int icon;
121
122 /**
Joe Onorato46439ce2010-11-19 13:56:21 -0800123 * If the icon in the status bar is to have more than one level, you can set this. Otherwise,
124 * leave it at its default value of 0.
125 *
126 * @see android.widget.ImageView#setImageLevel
127 * @see android.graphics.drawable#setLevel
128 */
129 public int iconLevel;
130
131 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500132 * The number of events that this notification represents. For example, in a new mail
133 * notification, this could be the number of unread messages.
134 *
135 * The system may or may not use this field to modify the appearance of the notification. For
136 * example, before {@link android.os.Build.VERSION_CODES#HONEYCOMB}, this number was
137 * superimposed over the icon in the status bar. Starting with
138 * {@link android.os.Build.VERSION_CODES#HONEYCOMB}, the template used by
139 * {@link Notification.Builder} has displayed the number in the expanded notification view.
140 *
141 * If the number is 0 or negative, it is never shown.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800142 */
143 public int number;
144
145 /**
146 * The intent to execute when the expanded status entry is clicked. If
147 * this is an activity, it must include the
148 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -0800149 * that you take care of task management as described in the
150 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
Dianne Hackborn6ceca582012-01-10 15:24:26 -0800151 * Stack</a> document. In particular, make sure to read the notification section
152 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html#HandlingNotifications">Handling
153 * Notifications</a> for the correct ways to launch an application from a
154 * notification.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800155 */
156 public PendingIntent contentIntent;
157
158 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500159 * The intent to execute when the notification is explicitly dismissed by the user, either with
160 * the "Clear All" button or by swiping it away individually.
161 *
162 * This probably shouldn't be launching an activity since several of those will be sent
163 * at the same time.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800164 */
165 public PendingIntent deleteIntent;
166
167 /**
Dianne Hackborn170bae72010-09-03 15:14:28 -0700168 * An intent to launch instead of posting the notification to the status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -0800169 *
170 * @see Notification.Builder#setFullScreenIntent
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400171 */
172 public PendingIntent fullScreenIntent;
173
174 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800175 * Text to scroll across the screen when this item is added to
Joe Onoratoef1e7762010-09-17 18:38:38 -0400176 * the status bar on large and smaller devices.
177 *
Joe Onorato46439ce2010-11-19 13:56:21 -0800178 * @see #tickerView
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800179 */
180 public CharSequence tickerText;
181
182 /**
Joe Onorato46439ce2010-11-19 13:56:21 -0800183 * The view to show as the ticker in the status bar when the notification
184 * is posted.
Joe Onoratoef1e7762010-09-17 18:38:38 -0400185 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800186 public RemoteViews tickerView;
Joe Onoratoef1e7762010-09-17 18:38:38 -0400187
188 /**
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400189 * The view that will represent this notification in the expanded status bar.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800190 */
191 public RemoteViews contentView;
192
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400193 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -0400194 * A large-format version of {@link #contentView}, giving the Notification an
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400195 * opportunity to show more detail. The system UI may choose to show this
196 * instead of the normal content view at its discretion.
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400197 */
198 public RemoteViews bigContentView;
199
200 /**
Joe Onorato46439ce2010-11-19 13:56:21 -0800201 * The bitmap that may escape the bounds of the panel and bar.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800202 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800203 public Bitmap largeIcon;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800204
205 /**
206 * The sound to play.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500207 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800208 * <p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500209 * To play the default notification sound, see {@link #defaults}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800210 * </p>
211 */
212 public Uri sound;
213
214 /**
215 * Use this constant as the value for audioStreamType to request that
216 * the default stream type for notifications be used. Currently the
Jeff Sharkey098d5802012-04-26 17:30:34 -0700217 * default stream type is {@link AudioManager#STREAM_NOTIFICATION}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800218 */
219 public static final int STREAM_DEFAULT = -1;
220
221 /**
222 * The audio stream type to use when playing the sound.
223 * Should be one of the STREAM_ constants from
224 * {@link android.media.AudioManager}.
225 */
226 public int audioStreamType = STREAM_DEFAULT;
227
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800228 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500229 * The pattern with which to vibrate.
230 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800231 * <p>
232 * To vibrate the default pattern, see {@link #defaults}.
233 * </p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500234 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800235 * @see android.os.Vibrator#vibrate(long[],int)
236 */
237 public long[] vibrate;
238
239 /**
240 * The color of the led. The hardware will do its best approximation.
241 *
242 * @see #FLAG_SHOW_LIGHTS
243 * @see #flags
244 */
245 public int ledARGB;
246
247 /**
248 * The number of milliseconds for the LED to be on while it's flashing.
249 * The hardware will do its best approximation.
250 *
251 * @see #FLAG_SHOW_LIGHTS
252 * @see #flags
253 */
254 public int ledOnMS;
255
256 /**
257 * The number of milliseconds for the LED to be off while it's flashing.
258 * The hardware will do its best approximation.
259 *
260 * @see #FLAG_SHOW_LIGHTS
261 * @see #flags
262 */
263 public int ledOffMS;
264
265 /**
266 * Specifies which values should be taken from the defaults.
267 * <p>
268 * To set, OR the desired from {@link #DEFAULT_SOUND},
269 * {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}. For all default
270 * values, use {@link #DEFAULT_ALL}.
271 * </p>
272 */
273 public int defaults;
274
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800275 /**
276 * Bit to be bitwise-ored into the {@link #flags} field that should be
277 * set if you want the LED on for this notification.
278 * <ul>
279 * <li>To turn the LED off, pass 0 in the alpha channel for colorARGB
280 * or 0 for both ledOnMS and ledOffMS.</li>
281 * <li>To turn the LED on, pass 1 for ledOnMS and 0 for ledOffMS.</li>
282 * <li>To flash the LED, pass the number of milliseconds that it should
283 * be on and off to ledOnMS and ledOffMS.</li>
284 * </ul>
285 * <p>
286 * Since hardware varies, you are not guaranteed that any of the values
287 * you pass are honored exactly. Use the system defaults (TODO) if possible
288 * because they will be set to values that work on any given hardware.
289 * <p>
290 * The alpha channel must be set for forward compatibility.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500291 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800292 */
293 public static final int FLAG_SHOW_LIGHTS = 0x00000001;
294
295 /**
296 * Bit to be bitwise-ored into the {@link #flags} field that should be
297 * set if this notification is in reference to something that is ongoing,
298 * like a phone call. It should not be set if this notification is in
299 * reference to something that happened at a particular point in time,
300 * like a missed phone call.
301 */
302 public static final int FLAG_ONGOING_EVENT = 0x00000002;
303
304 /**
305 * Bit to be bitwise-ored into the {@link #flags} field that if set,
Scott Mainb8b36452009-04-26 15:50:49 -0700306 * the audio will be repeated until the notification is
307 * cancelled or the notification window is opened.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800308 */
309 public static final int FLAG_INSISTENT = 0x00000004;
310
311 /**
312 * Bit to be bitwise-ored into the {@link #flags} field that should be
313 * set if you want the sound and/or vibration play each time the
314 * notification is sent, even if it has not been canceled before that.
315 */
316 public static final int FLAG_ONLY_ALERT_ONCE = 0x00000008;
317
318 /**
319 * Bit to be bitwise-ored into the {@link #flags} field that should be
320 * set if the notification should be canceled when it is clicked by the
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500321 * user. On tablets, the
322
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800323 */
324 public static final int FLAG_AUTO_CANCEL = 0x00000010;
325
326 /**
327 * Bit to be bitwise-ored into the {@link #flags} field that should be
328 * set if the notification should not be canceled when the user clicks
329 * the Clear all button.
330 */
331 public static final int FLAG_NO_CLEAR = 0x00000020;
332
Dianne Hackbornd8a43f62009-08-17 23:33:56 -0700333 /**
334 * Bit to be bitwise-ored into the {@link #flags} field that should be
335 * set if this notification represents a currently running service. This
336 * will normally be set for you by {@link Service#startForeground}.
337 */
338 public static final int FLAG_FOREGROUND_SERVICE = 0x00000040;
339
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400340 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500341 * Obsolete flag indicating high-priority notifications; use the priority field instead.
342 *
343 * @deprecated Use {@link #priority} with a positive value.
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400344 */
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500345 public static final int FLAG_HIGH_PRIORITY = 0x00000080;
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400346
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800347 public int flags;
348
349 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500350 * Default notification {@link #priority}. If your application does not prioritize its own
351 * notifications, use this value for all notifications.
352 */
353 public static final int PRIORITY_DEFAULT = 0;
354
355 /**
356 * Lower {@link #priority}, for items that are less important. The UI may choose to show these
357 * items smaller, or at a different position in the list, compared with your app's
358 * {@link #PRIORITY_DEFAULT} items.
359 */
360 public static final int PRIORITY_LOW = -1;
361
362 /**
363 * Lowest {@link #priority}; these items might not be shown to the user except under special
364 * circumstances, such as detailed notification logs.
365 */
366 public static final int PRIORITY_MIN = -2;
367
368 /**
369 * Higher {@link #priority}, for more important notifications or alerts. The UI may choose to
370 * show these items larger, or at a different position in notification lists, compared with
371 * your app's {@link #PRIORITY_DEFAULT} items.
372 */
373 public static final int PRIORITY_HIGH = 1;
374
375 /**
376 * Highest {@link #priority}, for your application's most important items that require the
377 * user's prompt attention or input.
378 */
379 public static final int PRIORITY_MAX = 2;
380
381 /**
382 * Relative priority for this notification.
383 *
384 * Priority is an indication of how much of the user's valuable attention should be consumed by
385 * this notification. Low-priority notifications may be hidden from the user in certain
386 * situations, while the user might be interrupted for a higher-priority notification. The
387 * system will make a determination about how to interpret notification priority as described in
388 * MUMBLE MUMBLE.
389 */
390 public int priority;
391
392 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -0400393 * @hide
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500394 * Notification type: incoming call (voice or video) or similar synchronous communication request.
395 */
396 public static final String KIND_CALL = "android.call";
397
398 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -0400399 * @hide
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500400 * Notification type: incoming direct message (SMS, instant message, etc.).
401 */
402 public static final String KIND_MESSAGE = "android.message";
403
404 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -0400405 * @hide
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500406 * Notification type: asynchronous bulk message (email).
407 */
408 public static final String KIND_EMAIL = "android.email";
409
410 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -0400411 * @hide
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500412 * Notification type: calendar event.
413 */
414 public static final String KIND_EVENT = "android.event";
415
416 /**
417 * Notification type: promotion or advertisement.
418 */
419 public static final String KIND_PROMO = "android.promo";
420
421 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -0400422 * @hide
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500423 * If this notification matches of one or more special types (see the <code>KIND_*</code>
424 * constants), add them here, best match first.
425 */
426 public String[] kind;
427
428 /**
429 * Extra key for people values (type TBD).
430 *
431 * @hide
432 */
433 public static final String EXTRA_PEOPLE = "android.people";
434
435 private Bundle extras;
436
437 /**
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400438 * Structure to encapsulate an "action", including title and icon, that can be attached to a Notification.
439 * @hide
440 */
441 private static class Action implements Parcelable {
442 public int icon;
443 public CharSequence title;
444 public PendingIntent actionIntent;
445 @SuppressWarnings("unused")
446 public Action() { }
447 private Action(Parcel in) {
448 icon = in.readInt();
449 title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
450 if (in.readInt() == 1) {
451 actionIntent = PendingIntent.CREATOR.createFromParcel(in);
452 }
453 }
454 public Action(int icon_, CharSequence title_, PendingIntent intent_) {
455 this.icon = icon_;
456 this.title = title_;
457 this.actionIntent = intent_;
458 }
459 @Override
460 public Action clone() {
461 return new Action(
462 this.icon,
463 this.title.toString(),
464 this.actionIntent // safe to alias
465 );
466 }
467 @Override
468 public int describeContents() {
469 return 0;
470 }
471 @Override
472 public void writeToParcel(Parcel out, int flags) {
473 out.writeInt(icon);
474 TextUtils.writeToParcel(title, out, flags);
475 if (actionIntent != null) {
476 out.writeInt(1);
477 actionIntent.writeToParcel(out, flags);
478 } else {
479 out.writeInt(0);
480 }
481 }
482 public static final Parcelable.Creator<Action> CREATOR
483 = new Parcelable.Creator<Action>() {
484 public Action createFromParcel(Parcel in) {
485 return new Action(in);
486 }
487 public Action[] newArray(int size) {
488 return new Action[size];
489 }
490 };
491 }
492
493 private Action[] actions;
494
495 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500496 * Constructs a Notification object with default values.
Joe Onorato46439ce2010-11-19 13:56:21 -0800497 * You might want to consider using {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800498 */
499 public Notification()
500 {
501 this.when = System.currentTimeMillis();
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500502 this.priority = PRIORITY_DEFAULT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800503 }
504
505 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800506 * @hide
507 */
508 public Notification(Context context, int icon, CharSequence tickerText, long when,
509 CharSequence contentTitle, CharSequence contentText, Intent contentIntent)
510 {
511 this.when = when;
512 this.icon = icon;
513 this.tickerText = tickerText;
514 setLatestEventInfo(context, contentTitle, contentText,
515 PendingIntent.getActivity(context, 0, contentIntent, 0));
516 }
517
518 /**
519 * Constructs a Notification object with the information needed to
520 * have a status bar icon without the standard expanded view.
521 *
522 * @param icon The resource id of the icon to put in the status bar.
523 * @param tickerText The text that flows by in the status bar when the notification first
524 * activates.
525 * @param when The time to show in the time field. In the System.currentTimeMillis
526 * timebase.
Joe Onorato46439ce2010-11-19 13:56:21 -0800527 *
528 * @deprecated Use {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800529 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800530 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800531 public Notification(int icon, CharSequence tickerText, long when)
532 {
533 this.icon = icon;
534 this.tickerText = tickerText;
535 this.when = when;
536 }
537
538 /**
539 * Unflatten the notification from a parcel.
540 */
541 public Notification(Parcel parcel)
542 {
543 int version = parcel.readInt();
544
545 when = parcel.readLong();
546 icon = parcel.readInt();
547 number = parcel.readInt();
548 if (parcel.readInt() != 0) {
549 contentIntent = PendingIntent.CREATOR.createFromParcel(parcel);
550 }
551 if (parcel.readInt() != 0) {
552 deleteIntent = PendingIntent.CREATOR.createFromParcel(parcel);
553 }
554 if (parcel.readInt() != 0) {
555 tickerText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
556 }
557 if (parcel.readInt() != 0) {
Joe Onorato46439ce2010-11-19 13:56:21 -0800558 tickerView = RemoteViews.CREATOR.createFromParcel(parcel);
Joe Onoratoef1e7762010-09-17 18:38:38 -0400559 }
560 if (parcel.readInt() != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800561 contentView = RemoteViews.CREATOR.createFromParcel(parcel);
562 }
Joe Onorato561d3852010-11-20 18:09:34 -0800563 if (parcel.readInt() != 0) {
564 largeIcon = Bitmap.CREATOR.createFromParcel(parcel);
565 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800566 defaults = parcel.readInt();
567 flags = parcel.readInt();
568 if (parcel.readInt() != 0) {
569 sound = Uri.CREATOR.createFromParcel(parcel);
570 }
571
572 audioStreamType = parcel.readInt();
573 vibrate = parcel.createLongArray();
574 ledARGB = parcel.readInt();
575 ledOnMS = parcel.readInt();
576 ledOffMS = parcel.readInt();
577 iconLevel = parcel.readInt();
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400578
579 if (parcel.readInt() != 0) {
580 fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel);
581 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500582
583 priority = parcel.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400584
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500585 kind = parcel.createStringArray(); // may set kind to null
586
587 if (parcel.readInt() != 0) {
588 extras = parcel.readBundle();
589 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400590
591 actions = parcel.createTypedArray(Action.CREATOR);
592 if (parcel.readInt() != 0) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400593 bigContentView = RemoteViews.CREATOR.createFromParcel(parcel);
594 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800595 }
596
Andy Stadler110988c2010-12-03 14:29:16 -0800597 @Override
Joe Onorato18e69df2010-05-17 22:26:12 -0700598 public Notification clone() {
599 Notification that = new Notification();
600
601 that.when = this.when;
602 that.icon = this.icon;
603 that.number = this.number;
604
605 // PendingIntents are global, so there's no reason (or way) to clone them.
606 that.contentIntent = this.contentIntent;
607 that.deleteIntent = this.deleteIntent;
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400608 that.fullScreenIntent = this.fullScreenIntent;
Joe Onorato18e69df2010-05-17 22:26:12 -0700609
610 if (this.tickerText != null) {
611 that.tickerText = this.tickerText.toString();
612 }
Joe Onorato46439ce2010-11-19 13:56:21 -0800613 if (this.tickerView != null) {
614 that.tickerView = this.tickerView.clone();
Joe Onoratoef1e7762010-09-17 18:38:38 -0400615 }
Joe Onorato18e69df2010-05-17 22:26:12 -0700616 if (this.contentView != null) {
617 that.contentView = this.contentView.clone();
618 }
Joe Onorato561d3852010-11-20 18:09:34 -0800619 if (this.largeIcon != null) {
620 that.largeIcon = Bitmap.createBitmap(this.largeIcon);
621 }
Jozef BABJAKa8b91832011-02-22 08:05:08 +0100622 that.iconLevel = this.iconLevel;
Joe Onorato18e69df2010-05-17 22:26:12 -0700623 that.sound = this.sound; // android.net.Uri is immutable
624 that.audioStreamType = this.audioStreamType;
625
626 final long[] vibrate = this.vibrate;
627 if (vibrate != null) {
628 final int N = vibrate.length;
629 final long[] vib = that.vibrate = new long[N];
630 System.arraycopy(vibrate, 0, vib, 0, N);
631 }
632
633 that.ledARGB = this.ledARGB;
634 that.ledOnMS = this.ledOnMS;
635 that.ledOffMS = this.ledOffMS;
636 that.defaults = this.defaults;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500637
Joe Onorato18e69df2010-05-17 22:26:12 -0700638 that.flags = this.flags;
639
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500640 that.priority = this.priority;
641
642 final String[] thiskind = this.kind;
643 if (thiskind != null) {
644 final int N = thiskind.length;
645 final String[] thatkind = that.kind = new String[N];
646 System.arraycopy(thiskind, 0, thatkind, 0, N);
647 }
648
649 if (this.extras != null) {
650 that.extras = new Bundle(this.extras);
651
652 }
653
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400654 that.actions = new Action[this.actions.length];
655 for(int i=0; i<this.actions.length; i++) {
656 that.actions[i] = this.actions[i].clone();
657 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400658 if (this.bigContentView != null) {
659 that.bigContentView = this.bigContentView.clone();
660 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400661
Joe Onorato18e69df2010-05-17 22:26:12 -0700662 return that;
663 }
664
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800665 public int describeContents() {
666 return 0;
667 }
668
669 /**
670 * Flatten this notification from a parcel.
671 */
672 public void writeToParcel(Parcel parcel, int flags)
673 {
674 parcel.writeInt(1);
675
676 parcel.writeLong(when);
677 parcel.writeInt(icon);
678 parcel.writeInt(number);
679 if (contentIntent != null) {
680 parcel.writeInt(1);
681 contentIntent.writeToParcel(parcel, 0);
682 } else {
683 parcel.writeInt(0);
684 }
685 if (deleteIntent != null) {
686 parcel.writeInt(1);
687 deleteIntent.writeToParcel(parcel, 0);
688 } else {
689 parcel.writeInt(0);
690 }
691 if (tickerText != null) {
692 parcel.writeInt(1);
693 TextUtils.writeToParcel(tickerText, parcel, flags);
694 } else {
695 parcel.writeInt(0);
696 }
Joe Onorato46439ce2010-11-19 13:56:21 -0800697 if (tickerView != null) {
Joe Onoratoef1e7762010-09-17 18:38:38 -0400698 parcel.writeInt(1);
Joe Onorato46439ce2010-11-19 13:56:21 -0800699 tickerView.writeToParcel(parcel, 0);
Joe Onoratoef1e7762010-09-17 18:38:38 -0400700 } else {
701 parcel.writeInt(0);
702 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800703 if (contentView != null) {
704 parcel.writeInt(1);
705 contentView.writeToParcel(parcel, 0);
706 } else {
707 parcel.writeInt(0);
708 }
Joe Onorato561d3852010-11-20 18:09:34 -0800709 if (largeIcon != null) {
710 parcel.writeInt(1);
711 largeIcon.writeToParcel(parcel, 0);
712 } else {
713 parcel.writeInt(0);
714 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800715
716 parcel.writeInt(defaults);
717 parcel.writeInt(this.flags);
718
719 if (sound != null) {
720 parcel.writeInt(1);
721 sound.writeToParcel(parcel, 0);
722 } else {
723 parcel.writeInt(0);
724 }
725 parcel.writeInt(audioStreamType);
726 parcel.writeLongArray(vibrate);
727 parcel.writeInt(ledARGB);
728 parcel.writeInt(ledOnMS);
729 parcel.writeInt(ledOffMS);
730 parcel.writeInt(iconLevel);
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400731
732 if (fullScreenIntent != null) {
733 parcel.writeInt(1);
734 fullScreenIntent.writeToParcel(parcel, 0);
735 } else {
736 parcel.writeInt(0);
737 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500738
739 parcel.writeInt(priority);
740
741 parcel.writeStringArray(kind); // ok for null
742
743 if (extras != null) {
744 parcel.writeInt(1);
745 extras.writeToParcel(parcel, 0);
746 } else {
747 parcel.writeInt(0);
748 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400749
750 parcel.writeTypedArray(actions, 0);
751
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400752 if (bigContentView != null) {
753 parcel.writeInt(1);
754 bigContentView.writeToParcel(parcel, 0);
755 } else {
756 parcel.writeInt(0);
757 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800758 }
759
760 /**
761 * Parcelable.Creator that instantiates Notification objects
762 */
763 public static final Parcelable.Creator<Notification> CREATOR
764 = new Parcelable.Creator<Notification>()
765 {
766 public Notification createFromParcel(Parcel parcel)
767 {
768 return new Notification(parcel);
769 }
770
771 public Notification[] newArray(int size)
772 {
773 return new Notification[size];
774 }
775 };
776
777 /**
778 * Sets the {@link #contentView} field to be a view with the standard "Latest Event"
779 * layout.
780 *
781 * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields
782 * in the view.</p>
783 * @param context The context for your application / activity.
784 * @param contentTitle The title that goes in the expanded entry.
785 * @param contentText The text that goes in the expanded entry.
786 * @param contentIntent The intent to launch when the user clicks the expanded notification.
787 * If this is an activity, it must include the
788 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -0800789 * that you take care of task management as described in the
790 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
791 * Stack</a> document.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500792 *
Joe Onorato46439ce2010-11-19 13:56:21 -0800793 * @deprecated Use {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800794 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800795 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800796 public void setLatestEventInfo(Context context,
797 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
Daniel Sandlercde8aae2012-04-04 23:40:22 -0400798 // TODO: rewrite this to use Builder
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800799 RemoteViews contentView = new RemoteViews(context.getPackageName(),
Daniel Sandler96fd7c12012-03-30 16:37:36 -0400800 R.layout.notification_template_base);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800801 if (this.icon != 0) {
Joe Onorato561d3852010-11-20 18:09:34 -0800802 contentView.setImageViewResource(R.id.icon, this.icon);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800803 }
Daniel Sandlere95658c2012-05-10 00:33:54 -0400804 if (priority < PRIORITY_LOW) {
805 contentView.setInt(R.id.icon,
806 "setBackgroundResource", R.drawable.notification_template_icon_low_bg);
807 contentView.setInt(R.id.status_bar_latest_event_content,
808 "setBackgroundResource", R.drawable.notification_bg_low);
809 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800810 if (contentTitle != null) {
Joe Onorato561d3852010-11-20 18:09:34 -0800811 contentView.setTextViewText(R.id.title, contentTitle);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800812 }
813 if (contentText != null) {
Joe Onorato561d3852010-11-20 18:09:34 -0800814 contentView.setTextViewText(R.id.text, contentText);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800815 }
816 if (this.when != 0) {
Daniel Sandlercde8aae2012-04-04 23:40:22 -0400817 contentView.setViewVisibility(R.id.time, View.VISIBLE);
Joe Onorato561d3852010-11-20 18:09:34 -0800818 contentView.setLong(R.id.time, "setTime", when);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800819 }
Daniel Sandlerb4b22232012-04-30 10:38:31 -0400820 if (this.number != 0) {
821 NumberFormat f = NumberFormat.getIntegerInstance();
822 contentView.setTextViewText(R.id.info, f.format(this.number));
823 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800824
825 this.contentView = contentView;
826 this.contentIntent = contentIntent;
827 }
828
829 @Override
830 public String toString() {
831 StringBuilder sb = new StringBuilder();
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500832 sb.append("Notification(pri=");
833 sb.append(priority);
834 sb.append(" contentView=");
Joe Onoratoc9596d62011-01-12 17:03:11 -0800835 if (contentView != null) {
836 sb.append(contentView.getPackage());
837 sb.append("/0x");
838 sb.append(Integer.toHexString(contentView.getLayoutId()));
839 } else {
840 sb.append("null");
841 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500842 // TODO(dsandler): defaults take precedence over local values, so reorder the branches below
Joe Onoratoc9596d62011-01-12 17:03:11 -0800843 sb.append(" vibrate=");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800844 if (this.vibrate != null) {
845 int N = this.vibrate.length-1;
846 sb.append("[");
847 for (int i=0; i<N; i++) {
848 sb.append(this.vibrate[i]);
849 sb.append(',');
850 }
Simon Schoar8cf97d92009-06-10 22:08:37 +0200851 if (N != -1) {
852 sb.append(this.vibrate[N]);
853 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800854 sb.append("]");
855 } else if ((this.defaults & DEFAULT_VIBRATE) != 0) {
856 sb.append("default");
857 } else {
858 sb.append("null");
859 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500860 sb.append(" sound=");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800861 if (this.sound != null) {
862 sb.append(this.sound.toString());
863 } else if ((this.defaults & DEFAULT_SOUND) != 0) {
864 sb.append("default");
865 } else {
866 sb.append("null");
867 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500868 sb.append(" defaults=0x");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800869 sb.append(Integer.toHexString(this.defaults));
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500870 sb.append(" flags=0x");
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400871 sb.append(Integer.toHexString(this.flags));
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500872 sb.append(" kind=[");
873 if (this.kind == null) {
874 sb.append("null");
875 } else {
876 for (int i=0; i<this.kind.length; i++) {
877 if (i>0) sb.append(",");
878 sb.append(this.kind[i]);
879 }
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400880 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400881 sb.append("]");
882 if (actions != null) {
883 sb.append(" ");
884 sb.append(actions.length);
885 sb.append(" action");
886 if (actions.length > 1) sb.append("s");
887 }
888 sb.append(")");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800889 return sb.toString();
890 }
Joe Onorato46439ce2010-11-19 13:56:21 -0800891
Joe Onoratocb109a02011-01-18 17:57:41 -0800892 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500893 * Builder class for {@link Notification} objects.
894 *
895 * Provides a convenient way to set the various fields of a {@link Notification} and generate
896 * content views using the platform's notification layout template.
897 *
898 * Example:
899 *
900 * <pre class="prettyprint">
901 * Notification noti = new Notification.Builder()
902 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
903 * .setContentText(subject)
904 * .setSmallIcon(R.drawable.new_mail)
905 * .setLargeIcon(aBitmap)
Chris Wrenfbd96ba2012-05-01 12:03:58 -0400906 * .build();
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500907 * </pre>
Joe Onoratocb109a02011-01-18 17:57:41 -0800908 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800909 public static class Builder {
910 private Context mContext;
911
912 private long mWhen;
913 private int mSmallIcon;
914 private int mSmallIconLevel;
Joe Onorato8595a3d2010-11-19 18:12:07 -0800915 private int mNumber;
Joe Onorato46439ce2010-11-19 13:56:21 -0800916 private CharSequence mContentTitle;
917 private CharSequence mContentText;
918 private CharSequence mContentInfo;
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400919 private CharSequence mSubText;
Joe Onorato46439ce2010-11-19 13:56:21 -0800920 private PendingIntent mContentIntent;
921 private RemoteViews mContentView;
922 private PendingIntent mDeleteIntent;
923 private PendingIntent mFullScreenIntent;
924 private CharSequence mTickerText;
925 private RemoteViews mTickerView;
926 private Bitmap mLargeIcon;
927 private Uri mSound;
928 private int mAudioStreamType;
929 private long[] mVibrate;
930 private int mLedArgb;
931 private int mLedOnMs;
932 private int mLedOffMs;
933 private int mDefaults;
934 private int mFlags;
Jeff Sharkey1c400132011-08-05 14:50:13 -0700935 private int mProgressMax;
936 private int mProgress;
937 private boolean mProgressIndeterminate;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500938 private ArrayList<String> mKindList = new ArrayList<String>(1);
939 private Bundle mExtras;
940 private int mPriority;
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400941 private ArrayList<Action> mActions = new ArrayList<Action>(3);
Daniel Sandlera2985ed2012-04-03 16:42:00 -0400942 private boolean mUseChronometer;
Chris Wrenfbd96ba2012-05-01 12:03:58 -0400943 private Style mStyle;
Joe Onorato46439ce2010-11-19 13:56:21 -0800944
Joe Onoratocb109a02011-01-18 17:57:41 -0800945 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500946 * Constructs a new Builder with the defaults:
Joe Onoratocb109a02011-01-18 17:57:41 -0800947 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500948
949 * <table>
950 * <tr><th align=right>priority</th>
951 * <td>{@link #PRIORITY_DEFAULT}</td></tr>
952 * <tr><th align=right>when</th>
953 * <td>now ({@link System#currentTimeMillis()})</td></tr>
954 * <tr><th align=right>audio stream</th>
955 * <td>{@link #STREAM_DEFAULT}</td></tr>
956 * </table>
Joe Onoratocb109a02011-01-18 17:57:41 -0800957 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500958
959 * @param context
960 * A {@link Context} that will be used by the Builder to construct the
961 * RemoteViews. The Context will not be held past the lifetime of this Builder
962 * object.
Joe Onoratocb109a02011-01-18 17:57:41 -0800963 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800964 public Builder(Context context) {
965 mContext = context;
Andy Stadler110988c2010-12-03 14:29:16 -0800966
967 // Set defaults to match the defaults of a Notification
Joe Onorato46439ce2010-11-19 13:56:21 -0800968 mWhen = System.currentTimeMillis();
Andy Stadler110988c2010-12-03 14:29:16 -0800969 mAudioStreamType = STREAM_DEFAULT;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500970 mPriority = PRIORITY_DEFAULT;
Joe Onorato46439ce2010-11-19 13:56:21 -0800971 }
972
Joe Onoratocb109a02011-01-18 17:57:41 -0800973 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500974 * Add a timestamp pertaining to the notification (usually the time the event occurred).
975 *
976
977 * @see Notification#when
Joe Onoratocb109a02011-01-18 17:57:41 -0800978 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800979 public Builder setWhen(long when) {
980 mWhen = when;
981 return this;
982 }
983
Joe Onoratocb109a02011-01-18 17:57:41 -0800984 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -0400985 * Show the {@link Notification#when} field as a stopwatch.
986 *
987 * Instead of presenting <code>when</code> as a timestamp, the notification will show an
988 * automatically updating display of the minutes and seconds since <code>when</code>.
Daniel Sandlera2985ed2012-04-03 16:42:00 -0400989 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -0400990 * Useful when showing an elapsed time (like an ongoing phone call).
991 *
992 * @see android.widget.Chronometer
Daniel Sandlera2985ed2012-04-03 16:42:00 -0400993 * @see Notification#when
994 */
995 public Builder setUsesChronometer(boolean b) {
996 mUseChronometer = b;
997 return this;
998 }
999
1000 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001001 * Set the small icon resource, which will be used to represent the notification in the
1002 * status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -08001003 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001004
1005 * The platform template for the expanded view will draw this icon in the left, unless a
1006 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
1007 * icon will be moved to the right-hand side.
1008 *
1009
1010 * @param icon
1011 * A resource ID in the application's package of the drawable to use.
1012 * @see Notification#icon
Joe Onoratocb109a02011-01-18 17:57:41 -08001013 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001014 public Builder setSmallIcon(int icon) {
1015 mSmallIcon = icon;
1016 return this;
1017 }
1018
Joe Onoratocb109a02011-01-18 17:57:41 -08001019 /**
1020 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
1021 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
1022 * LevelListDrawable}.
1023 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001024 * @param icon A resource ID in the application's package of the drawable to use.
Joe Onoratocb109a02011-01-18 17:57:41 -08001025 * @param level The level to use for the icon.
1026 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001027 * @see Notification#icon
1028 * @see Notification#iconLevel
Joe Onoratocb109a02011-01-18 17:57:41 -08001029 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001030 public Builder setSmallIcon(int icon, int level) {
1031 mSmallIcon = icon;
1032 mSmallIconLevel = level;
1033 return this;
1034 }
1035
Joe Onoratocb109a02011-01-18 17:57:41 -08001036 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001037 * Set the first line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08001038 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001039 public Builder setContentTitle(CharSequence title) {
1040 mContentTitle = title;
1041 return this;
1042 }
1043
Joe Onoratocb109a02011-01-18 17:57:41 -08001044 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001045 * Set the second line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08001046 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001047 public Builder setContentText(CharSequence text) {
1048 mContentText = text;
1049 return this;
1050 }
1051
Joe Onoratocb109a02011-01-18 17:57:41 -08001052 /**
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001053 * Set the third line of text in the platform notification template.
1054 * Don't use if you're also using {@link #setProgress(int, int, boolean)}; they occupy the same location in the standard template.
1055 */
1056 public Builder setSubText(CharSequence text) {
1057 mSubText = text;
1058 return this;
1059 }
1060
1061 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08001062 * Set the large number at the right-hand side of the notification. This is
1063 * equivalent to setContentInfo, although it might show the number in a different
1064 * font size for readability.
1065 */
Joe Onorato8595a3d2010-11-19 18:12:07 -08001066 public Builder setNumber(int number) {
1067 mNumber = number;
1068 return this;
1069 }
1070
Joe Onoratocb109a02011-01-18 17:57:41 -08001071 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001072 * A small piece of additional information pertaining to this notification.
1073 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001074 * The platform template will draw this on the last line of the notification, at the far
1075 * right (to the right of a smallIcon if it has been placed there).
Joe Onoratocb109a02011-01-18 17:57:41 -08001076 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001077 public Builder setContentInfo(CharSequence info) {
1078 mContentInfo = info;
1079 return this;
1080 }
1081
Joe Onoratocb109a02011-01-18 17:57:41 -08001082 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001083 * Set the progress this notification represents.
1084 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001085 * The platform template will represent this using a {@link ProgressBar}.
Jeff Sharkey1c400132011-08-05 14:50:13 -07001086 */
1087 public Builder setProgress(int max, int progress, boolean indeterminate) {
1088 mProgressMax = max;
1089 mProgress = progress;
1090 mProgressIndeterminate = indeterminate;
1091 return this;
1092 }
1093
1094 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001095 * Supply a custom RemoteViews to use instead of the platform template.
1096 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001097 * @see Notification#contentView
Joe Onoratocb109a02011-01-18 17:57:41 -08001098 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001099 public Builder setContent(RemoteViews views) {
1100 mContentView = views;
1101 return this;
1102 }
1103
Joe Onoratocb109a02011-01-18 17:57:41 -08001104 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001105 * Supply a {@link PendingIntent} to be sent when the notification is clicked.
1106 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001107 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
1108 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
1109 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001110 * to assign PendingIntents to individual views in that custom layout (i.e., to create
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001111 * clickable buttons inside the notification view).
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001112 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001113 * @see Notification#contentIntent Notification.contentIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08001114 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001115 public Builder setContentIntent(PendingIntent intent) {
1116 mContentIntent = intent;
1117 return this;
1118 }
1119
Joe Onoratocb109a02011-01-18 17:57:41 -08001120 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001121 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
1122 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001123 * @see Notification#deleteIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08001124 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001125 public Builder setDeleteIntent(PendingIntent intent) {
1126 mDeleteIntent = intent;
1127 return this;
1128 }
1129
Joe Onoratocb109a02011-01-18 17:57:41 -08001130 /**
1131 * An intent to launch instead of posting the notification to the status bar.
1132 * Only for use with extremely high-priority notifications demanding the user's
1133 * <strong>immediate</strong> attention, such as an incoming phone call or
1134 * alarm clock that the user has explicitly set to a particular time.
1135 * If this facility is used for something else, please give the user an option
1136 * to turn it off and use a normal notification, as this can be extremely
1137 * disruptive.
1138 *
1139 * @param intent The pending intent to launch.
1140 * @param highPriority Passing true will cause this notification to be sent
1141 * even if other notifications are suppressed.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001142 *
1143 * @see Notification#fullScreenIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08001144 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001145 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
1146 mFullScreenIntent = intent;
1147 setFlag(FLAG_HIGH_PRIORITY, highPriority);
1148 return this;
1149 }
1150
Joe Onoratocb109a02011-01-18 17:57:41 -08001151 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001152 * Set the "ticker" text which is displayed in the status bar when the notification first
Joe Onoratocb109a02011-01-18 17:57:41 -08001153 * arrives.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001154 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001155 * @see Notification#tickerText
Joe Onoratocb109a02011-01-18 17:57:41 -08001156 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001157 public Builder setTicker(CharSequence tickerText) {
1158 mTickerText = tickerText;
1159 return this;
1160 }
1161
Joe Onoratocb109a02011-01-18 17:57:41 -08001162 /**
1163 * Set the text that is displayed in the status bar when the notification first
1164 * arrives, and also a RemoteViews object that may be displayed instead on some
1165 * devices.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001166 *
1167 * @see Notification#tickerText
1168 * @see Notification#tickerView
Joe Onoratocb109a02011-01-18 17:57:41 -08001169 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001170 public Builder setTicker(CharSequence tickerText, RemoteViews views) {
1171 mTickerText = tickerText;
1172 mTickerView = views;
1173 return this;
1174 }
1175
Joe Onoratocb109a02011-01-18 17:57:41 -08001176 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001177 * Add a large icon to the notification (and the ticker on some devices).
1178 *
1179 * In the platform template, this image will be shown on the left of the notification view
1180 * in place of the {@link #setSmallIcon(int) small icon} (which will move to the right side).
1181 *
1182 * @see Notification#largeIcon
Joe Onoratocb109a02011-01-18 17:57:41 -08001183 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001184 public Builder setLargeIcon(Bitmap icon) {
1185 mLargeIcon = icon;
1186 return this;
1187 }
1188
Joe Onoratocb109a02011-01-18 17:57:41 -08001189 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001190 * Set the sound to play.
1191 *
1192 * It will be played on the {@link #STREAM_DEFAULT default stream} for notifications.
1193 *
1194 * @see Notification#sound
Joe Onoratocb109a02011-01-18 17:57:41 -08001195 */
Joe Onorato52f80cd2010-11-21 15:34:48 -08001196 public Builder setSound(Uri sound) {
1197 mSound = sound;
1198 mAudioStreamType = STREAM_DEFAULT;
1199 return this;
1200 }
1201
Joe Onoratocb109a02011-01-18 17:57:41 -08001202 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001203 * Set the sound to play, along with a specific stream on which to play it.
Joe Onoratocb109a02011-01-18 17:57:41 -08001204 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001205 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
1206 *
1207 * @see Notification#sound
Joe Onoratocb109a02011-01-18 17:57:41 -08001208 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001209 public Builder setSound(Uri sound, int streamType) {
1210 mSound = sound;
1211 mAudioStreamType = streamType;
1212 return this;
1213 }
1214
Joe Onoratocb109a02011-01-18 17:57:41 -08001215 /**
1216 * Set the vibration pattern to use.
1217 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001218
1219 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
1220 * <code>pattern</code> parameter.
1221 *
1222
1223 * @see Notification#vibrate
Joe Onoratocb109a02011-01-18 17:57:41 -08001224 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001225 public Builder setVibrate(long[] pattern) {
1226 mVibrate = pattern;
1227 return this;
1228 }
1229
Joe Onoratocb109a02011-01-18 17:57:41 -08001230 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001231 * Set the desired color for the indicator LED on the device, as well as the
1232 * blink duty cycle (specified in milliseconds).
1233 *
1234
1235 * Not all devices will honor all (or even any) of these values.
1236 *
1237
1238 * @see Notification#ledARGB
1239 * @see Notification#ledOnMS
1240 * @see Notification#ledOffMS
Joe Onoratocb109a02011-01-18 17:57:41 -08001241 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001242 public Builder setLights(int argb, int onMs, int offMs) {
1243 mLedArgb = argb;
1244 mLedOnMs = onMs;
1245 mLedOffMs = offMs;
Joe Onorato46439ce2010-11-19 13:56:21 -08001246 return this;
1247 }
1248
Joe Onoratocb109a02011-01-18 17:57:41 -08001249 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001250 * Set whether this is an "ongoing" notification.
Joe Onoratocb109a02011-01-18 17:57:41 -08001251 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001252
1253 * Ongoing notifications cannot be dismissed by the user, so your application or service
1254 * must take care of canceling them.
1255 *
1256
1257 * They are typically used to indicate a background task that the user is actively engaged
1258 * with (e.g., playing music) or is pending in some way and therefore occupying the device
1259 * (e.g., a file download, sync operation, active network connection).
1260 *
1261
1262 * @see Notification#FLAG_ONGOING_EVENT
1263 * @see Service#setForeground(boolean)
Joe Onoratocb109a02011-01-18 17:57:41 -08001264 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001265 public Builder setOngoing(boolean ongoing) {
1266 setFlag(FLAG_ONGOING_EVENT, ongoing);
1267 return this;
1268 }
1269
Joe Onoratocb109a02011-01-18 17:57:41 -08001270 /**
1271 * Set this flag if you would only like the sound, vibrate
1272 * and ticker to be played if the notification is not already showing.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001273 *
1274 * @see Notification#FLAG_ONLY_ALERT_ONCE
Joe Onoratocb109a02011-01-18 17:57:41 -08001275 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001276 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
1277 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
1278 return this;
1279 }
1280
Joe Onoratocb109a02011-01-18 17:57:41 -08001281 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001282 * Make this notification automatically dismissed when the user touches it. The
1283 * PendingIntent set with {@link #setDeleteIntent} will be sent when this happens.
1284 *
1285 * @see Notification#FLAG_AUTO_CANCEL
Joe Onoratocb109a02011-01-18 17:57:41 -08001286 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001287 public Builder setAutoCancel(boolean autoCancel) {
Joe Onorato281d83f2011-01-04 17:13:10 -08001288 setFlag(FLAG_AUTO_CANCEL, autoCancel);
Joe Onorato46439ce2010-11-19 13:56:21 -08001289 return this;
1290 }
1291
Joe Onoratocb109a02011-01-18 17:57:41 -08001292 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001293 * Set which notification properties will be inherited from system defaults.
Joe Onoratocb109a02011-01-18 17:57:41 -08001294 * <p>
1295 * The value should be one or more of the following fields combined with
1296 * bitwise-or:
1297 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
1298 * <p>
1299 * For all default values, use {@link #DEFAULT_ALL}.
1300 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001301 public Builder setDefaults(int defaults) {
1302 mDefaults = defaults;
1303 return this;
1304 }
1305
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001306 /**
1307 * Set the priority of this notification.
1308 *
1309 * @see Notification#priority
1310 */
1311 public Builder setPriority(int pri) {
1312 mPriority = pri;
1313 return this;
1314 }
1315
1316 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04001317 * @hide
1318 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001319 * Add a kind (category) to this notification. Optional.
1320 *
1321 * @see Notification#kind
1322 */
1323 public Builder addKind(String k) {
1324 mKindList.add(k);
1325 return this;
1326 }
1327
1328 /**
1329 * Add metadata to this notification.
1330 *
1331 * A reference to the Bundle is held for the lifetime of this Builder, and the Bundle's
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001332 * current contents are copied into the Notification each time {@link #build()} is
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001333 * called.
1334 *
1335 * @see Notification#extras
1336 * @hide
1337 */
1338 public Builder setExtras(Bundle bag) {
1339 mExtras = bag;
1340 return this;
1341 }
1342
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001343 /**
1344 * Add an action to this notification. Actions are typically displayed by
1345 * the system as a button adjacent to the notification content.
1346 *
1347 * @param icon Resource ID of a drawable that represents the action.
1348 * @param title Text describing the action.
1349 * @param intent PendingIntent to be fired when the action is invoked.
1350 */
1351 public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
1352 mActions.add(new Action(icon, title, intent));
1353 return this;
1354 }
1355
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001356 /**
1357 * Add a rich notification style to be applied at build time.
1358 *
1359 * @param style Object responsible for modifying the notification style.
1360 */
1361 public Builder setStyle(Style style) {
1362 if (mStyle != style) {
1363 mStyle = style;
1364 mStyle.setBuilder(this);
1365 }
1366 return this;
1367 }
1368
Joe Onorato46439ce2010-11-19 13:56:21 -08001369 private void setFlag(int mask, boolean value) {
1370 if (value) {
1371 mFlags |= mask;
1372 } else {
1373 mFlags &= ~mask;
1374 }
1375 }
1376
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001377 private RemoteViews applyStandardTemplate(int resId) {
Joe Onorato561d3852010-11-20 18:09:34 -08001378 RemoteViews contentView = new RemoteViews(mContext.getPackageName(), resId);
Jeff Sharkey1c400132011-08-05 14:50:13 -07001379 boolean hasLine3 = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001380 boolean hasLine2 = false;
1381 int smallIconImageViewId = R.id.icon;
1382 if (mLargeIcon != null) {
1383 contentView.setImageViewBitmap(R.id.icon, mLargeIcon);
1384 smallIconImageViewId = R.id.right_icon;
1385 }
Daniel Sandlere95658c2012-05-10 00:33:54 -04001386 if (mPriority < PRIORITY_LOW) {
1387 contentView.setInt(R.id.icon,
1388 "setBackgroundResource", R.drawable.notification_template_icon_low_bg);
1389 contentView.setInt(R.id.status_bar_latest_event_content,
1390 "setBackgroundResource", R.drawable.notification_bg_low);
1391 }
Joe Onorato561d3852010-11-20 18:09:34 -08001392 if (mSmallIcon != 0) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001393 contentView.setImageViewResource(smallIconImageViewId, mSmallIcon);
1394 contentView.setViewVisibility(smallIconImageViewId, View.VISIBLE);
Jeff Sharkey1c400132011-08-05 14:50:13 -07001395 } else {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001396 contentView.setViewVisibility(smallIconImageViewId, View.GONE);
Joe Onorato561d3852010-11-20 18:09:34 -08001397 }
1398 if (mContentTitle != null) {
1399 contentView.setTextViewText(R.id.title, mContentTitle);
1400 }
1401 if (mContentText != null) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001402 contentView.setTextViewText(
1403 (mSubText != null) ? R.id.text2 : R.id.text,
1404 mContentText);
Jeff Sharkey1c400132011-08-05 14:50:13 -07001405 hasLine3 = true;
Joe Onorato561d3852010-11-20 18:09:34 -08001406 }
1407 if (mContentInfo != null) {
1408 contentView.setTextViewText(R.id.info, mContentInfo);
Jeff Sharkey1c400132011-08-05 14:50:13 -07001409 contentView.setViewVisibility(R.id.info, View.VISIBLE);
1410 hasLine3 = true;
Joe Onorato561d3852010-11-20 18:09:34 -08001411 } else if (mNumber > 0) {
Daniel Sandlerebce0112011-06-16 16:44:51 -04001412 final int tooBig = mContext.getResources().getInteger(
1413 R.integer.status_bar_notification_info_maxnum);
1414 if (mNumber > tooBig) {
1415 contentView.setTextViewText(R.id.info, mContext.getResources().getString(
1416 R.string.status_bar_notification_info_overflow));
Joe Onorato059a2f82011-01-04 10:27:01 -08001417 } else {
1418 NumberFormat f = NumberFormat.getIntegerInstance();
1419 contentView.setTextViewText(R.id.info, f.format(mNumber));
1420 }
Jeff Sharkey1c400132011-08-05 14:50:13 -07001421 contentView.setViewVisibility(R.id.info, View.VISIBLE);
1422 hasLine3 = true;
Joe Onorato561d3852010-11-20 18:09:34 -08001423 } else {
1424 contentView.setViewVisibility(R.id.info, View.GONE);
1425 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001426
1427 if (mSubText != null) {
1428 contentView.setTextViewText(R.id.text, mSubText);
Chris Wrend6297db2012-05-03 16:20:13 -04001429 contentView.setViewVisibility(R.id.text2,
1430 mContentText != null ? View.VISIBLE : View.GONE);
Jeff Sharkey1c400132011-08-05 14:50:13 -07001431 } else {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001432 contentView.setViewVisibility(R.id.text2, View.GONE);
1433 if (mProgressMax != 0 || mProgressIndeterminate) {
1434 contentView.setProgressBar(
1435 R.id.progress, mProgressMax, mProgress, mProgressIndeterminate);
1436 contentView.setViewVisibility(R.id.progress, View.VISIBLE);
1437 } else {
1438 contentView.setViewVisibility(R.id.progress, View.GONE);
1439 }
Jeff Sharkey1c400132011-08-05 14:50:13 -07001440 }
Joe Onorato561d3852010-11-20 18:09:34 -08001441 if (mWhen != 0) {
Daniel Sandlera2985ed2012-04-03 16:42:00 -04001442 if (mUseChronometer) {
1443 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
1444 contentView.setLong(R.id.chronometer, "setBase",
1445 mWhen + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
1446 contentView.setBoolean(R.id.chronometer, "setStarted", true);
1447 } else {
1448 contentView.setViewVisibility(R.id.time, View.VISIBLE);
1449 contentView.setLong(R.id.time, "setTime", mWhen);
1450 }
Joe Onorato561d3852010-11-20 18:09:34 -08001451 }
Jeff Sharkey1c400132011-08-05 14:50:13 -07001452 contentView.setViewVisibility(R.id.line3, hasLine3 ? View.VISIBLE : View.GONE);
Joe Onorato561d3852010-11-20 18:09:34 -08001453 return contentView;
1454 }
1455
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001456 private RemoteViews applyStandardTemplateWithActions(int layoutId) {
1457 RemoteViews big = applyStandardTemplate(layoutId);
1458
1459 int N = mActions.size();
1460 if (N > 0) {
Chris Wrend6297db2012-05-03 16:20:13 -04001461 // Log.d("Notification", "has actions: " + mContentText);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001462 big.setViewVisibility(R.id.actions, View.VISIBLE);
1463 if (N>3) N=3;
Chris Wren2c22eb02012-05-08 09:49:13 -04001464 big.removeAllViews(R.id.actions);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001465 for (int i=0; i<N; i++) {
1466 final RemoteViews button = generateActionButton(mActions.get(i));
Chris Wrend6297db2012-05-03 16:20:13 -04001467 //Log.d("Notification", "adding action " + i + ": " + mActions.get(i).title);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001468 big.addView(R.id.actions, button);
1469 }
1470 }
1471 return big;
1472 }
1473
Joe Onorato46439ce2010-11-19 13:56:21 -08001474 private RemoteViews makeContentView() {
1475 if (mContentView != null) {
1476 return mContentView;
1477 } else {
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001478 return applyStandardTemplate(R.layout.notification_template_base); // no more special large_icon flavor
Joe Onorato46439ce2010-11-19 13:56:21 -08001479 }
1480 }
1481
1482 private RemoteViews makeTickerView() {
1483 if (mTickerView != null) {
1484 return mTickerView;
1485 } else {
Joe Onorato561d3852010-11-20 18:09:34 -08001486 if (mContentView == null) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001487 return applyStandardTemplate(mLargeIcon == null
Joe Onorato561d3852010-11-20 18:09:34 -08001488 ? R.layout.status_bar_latest_event_ticker
1489 : R.layout.status_bar_latest_event_ticker_large_icon);
1490 } else {
1491 return null;
1492 }
Joe Onorato46439ce2010-11-19 13:56:21 -08001493 }
1494 }
1495
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001496 private RemoteViews makeBigContentView() {
1497 if (mActions.size() == 0) return null;
1498
Chris Wrenb023bf82012-04-23 16:05:42 -04001499 return applyStandardTemplateWithActions(R.layout.notification_template_big_base);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001500 }
1501
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001502 private RemoteViews generateActionButton(Action action) {
1503 RemoteViews button = new RemoteViews(mContext.getPackageName(), R.layout.notification_action);
1504 button.setTextViewCompoundDrawables(R.id.action0, action.icon, 0, 0, 0);
1505 button.setTextViewText(R.id.action0, action.title);
Daniel Sandlere5518842012-05-10 16:20:40 -04001506 if (action.actionIntent != null) {
1507 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
1508 //button.setBoolean(R.id.action0, "setEnabled", true);
1509 button.setFloat(R.id.button0, "setAlpha", 1.0f);
1510 button.setBoolean(R.id.button0, "setClickable", true);
1511 } else {
1512 //button.setBoolean(R.id.action0, "setEnabled", false);
1513 button.setFloat(R.id.button0, "setAlpha", 0.5f);
1514 button.setBoolean(R.id.button0, "setClickable", false);
1515 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001516 button.setContentDescription(R.id.action0, action.title);
1517 return button;
1518 }
1519
Joe Onoratocb109a02011-01-18 17:57:41 -08001520 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001521 * Apply the unstyled operations and return a new {@link Notification} object.
Joe Onoratocb109a02011-01-18 17:57:41 -08001522 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001523 private Notification buildUnstyled() {
Joe Onorato46439ce2010-11-19 13:56:21 -08001524 Notification n = new Notification();
1525 n.when = mWhen;
1526 n.icon = mSmallIcon;
1527 n.iconLevel = mSmallIconLevel;
Joe Onorato8595a3d2010-11-19 18:12:07 -08001528 n.number = mNumber;
Joe Onorato46439ce2010-11-19 13:56:21 -08001529 n.contentView = makeContentView();
1530 n.contentIntent = mContentIntent;
1531 n.deleteIntent = mDeleteIntent;
1532 n.fullScreenIntent = mFullScreenIntent;
1533 n.tickerText = mTickerText;
1534 n.tickerView = makeTickerView();
1535 n.largeIcon = mLargeIcon;
1536 n.sound = mSound;
1537 n.audioStreamType = mAudioStreamType;
1538 n.vibrate = mVibrate;
1539 n.ledARGB = mLedArgb;
1540 n.ledOnMS = mLedOnMs;
1541 n.ledOffMS = mLedOffMs;
1542 n.defaults = mDefaults;
1543 n.flags = mFlags;
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001544 n.bigContentView = makeBigContentView();
Joe Onorato8d0b6552010-11-22 16:09:29 -08001545 if (mLedOnMs != 0 && mLedOffMs != 0) {
1546 n.flags |= FLAG_SHOW_LIGHTS;
1547 }
1548 if ((mDefaults & DEFAULT_LIGHTS) != 0) {
1549 n.flags |= FLAG_SHOW_LIGHTS;
1550 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001551 if (mKindList.size() > 0) {
1552 n.kind = new String[mKindList.size()];
1553 mKindList.toArray(n.kind);
1554 } else {
1555 n.kind = null;
1556 }
1557 n.priority = mPriority;
1558 n.extras = mExtras != null ? new Bundle(mExtras) : null;
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001559 if (mActions.size() > 0) {
1560 n.actions = new Action[mActions.size()];
1561 mActions.toArray(n.actions);
1562 }
Joe Onorato46439ce2010-11-19 13:56:21 -08001563 return n;
1564 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001565
1566 /**
1567 * @deprecated Use {@link #build()} instead.
1568 */
1569 @Deprecated
1570 public Notification getNotification() {
1571 return build();
1572 }
1573
1574 /**
1575 * Combine all of the options that have been set and return a new {@link Notification}
1576 * object.
1577 */
1578 public Notification build() {
1579 if (mStyle != null) {
1580 return mStyle.build();
1581 } else {
1582 return buildUnstyled();
1583 }
1584 }
1585 }
1586
1587
1588 /**
1589 * An object that can apply a rich notification style to a {@link Notification.Builder}
1590 * object.
1591 */
Chris Wrend6297db2012-05-03 16:20:13 -04001592 public static abstract class Style
1593 {
1594 private CharSequence mBigContentTitle;
1595 private CharSequence mSummaryText = null;
1596
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001597 protected Builder mBuilder;
1598
Chris Wrend6297db2012-05-03 16:20:13 -04001599 /**
1600 * Overrides ContentTitle in the big form of the template.
1601 * This defaults to the value passed to setContentTitle().
1602 */
1603 protected void internalSetBigContentTitle(CharSequence title) {
1604 mBigContentTitle = title;
1605 }
1606
1607 /**
1608 * Set the first line of text after the detail section in the big form of the template.
1609 */
1610 protected void internalSetSummaryText(CharSequence cs) {
1611 mSummaryText = cs;
1612 }
1613
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001614 public void setBuilder(Builder builder) {
1615 if (mBuilder != builder) {
1616 mBuilder = builder;
1617 mBuilder.setStyle(this);
1618 }
1619 }
1620
Chris Wrend6297db2012-05-03 16:20:13 -04001621 protected void checkBuilder() {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001622 if (mBuilder == null) {
1623 throw new IllegalArgumentException("Style requires a valid Builder object");
1624 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001625 }
Chris Wrend6297db2012-05-03 16:20:13 -04001626
1627 protected RemoteViews getStandardView(int layoutId) {
1628 checkBuilder();
1629
1630 if (mBigContentTitle != null) {
1631 mBuilder.setContentTitle(mBigContentTitle);
1632 }
1633
1634 if (mBuilder.mSubText == null) {
1635 mBuilder.setContentText(null);
1636 }
1637
1638 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId);
1639
1640 if (mBuilder.mSubText == null) {
1641 contentView.setViewVisibility(R.id.line3, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04001642 } else {
1643 contentView.setViewVisibility(R.id.line3, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04001644 }
1645
1646 if (mBigContentTitle != null && mBigContentTitle.equals("")) {
1647 contentView.setViewVisibility(R.id.line1, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04001648 } else {
1649 contentView.setViewVisibility(R.id.line1, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04001650 }
1651
1652 if (mSummaryText != null && !mSummaryText.equals("")) {
1653 contentView.setViewVisibility(R.id.overflow_title, View.VISIBLE);
1654 contentView.setTextViewText(R.id.overflow_title, mSummaryText);
Chris Wren67dc9a02012-05-16 01:03:20 -04001655 } else {
1656 contentView.setViewVisibility(R.id.overflow_title, View.GONE);
Chris Wrend6297db2012-05-03 16:20:13 -04001657 }
1658
1659 return contentView;
1660 }
1661
1662 public abstract Notification build();
Joe Onorato46439ce2010-11-19 13:56:21 -08001663 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001664
1665 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001666 * Helper class for generating large-format notifications that include a large image attachment.
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001667 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001668 * This class is a "rebuilder": It consumes a Builder object and modifies its behavior, like so:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001669 * <pre class="prettyprint">
1670 * Notification noti = new Notification.BigPictureStyle(
1671 * new Notification.Builder()
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001672 * .setContentTitle(&quot;New photo from &quot; + sender.toString())
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001673 * .setContentText(subject)
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001674 * .setSmallIcon(R.drawable.new_post)
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001675 * .setLargeIcon(aBitmap))
1676 * .bigPicture(aBigBitmap)
1677 * .build();
1678 * </pre>
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001679 *
1680 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001681 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001682 public static class BigPictureStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001683 private Bitmap mPicture;
1684
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001685 public BigPictureStyle() {
1686 }
1687
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001688 public BigPictureStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001689 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001690 }
1691
Chris Wrend6297db2012-05-03 16:20:13 -04001692 /**
1693 * Overrides ContentTitle in the big form of the template.
1694 * This defaults to the value passed to setContentTitle().
1695 */
1696 public BigPictureStyle setBigContentTitle(CharSequence title) {
1697 internalSetBigContentTitle(title);
1698 return this;
1699 }
1700
1701 /**
1702 * Set the first line of text after the detail section in the big form of the template.
1703 */
1704 public BigPictureStyle setSummaryText(CharSequence cs) {
1705 internalSetSummaryText(cs);
1706 return this;
1707 }
1708
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001709 public BigPictureStyle bigPicture(Bitmap b) {
1710 mPicture = b;
1711 return this;
1712 }
1713
1714 private RemoteViews makeBigContentView() {
Chris Wrend6297db2012-05-03 16:20:13 -04001715 RemoteViews contentView = getStandardView(R.layout.notification_template_big_picture);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001716
1717 contentView.setImageViewBitmap(R.id.big_picture, mPicture);
1718
1719 return contentView;
1720 }
1721
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001722 @Override
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001723 public Notification build() {
Chris Wrend6297db2012-05-03 16:20:13 -04001724 checkBuilder();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001725 Notification wip = mBuilder.buildUnstyled();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001726 wip.bigContentView = makeBigContentView();
1727 return wip;
1728 }
1729 }
1730
1731 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001732 * Helper class for generating large-format notifications that include a lot of text.
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001733 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001734 * This class is a "rebuilder": It consumes a Builder object and modifies its behavior, like so:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001735 * <pre class="prettyprint">
1736 * Notification noti = new Notification.BigPictureStyle(
1737 * new Notification.Builder()
1738 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
1739 * .setContentText(subject)
1740 * .setSmallIcon(R.drawable.new_mail)
1741 * .setLargeIcon(aBitmap))
1742 * .bigText(aVeryLongString)
1743 * .build();
1744 * </pre>
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001745 *
1746 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001747 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001748 public static class BigTextStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001749 private CharSequence mBigText;
1750
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001751 public BigTextStyle() {
1752 }
1753
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001754 public BigTextStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001755 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001756 }
1757
Chris Wrend6297db2012-05-03 16:20:13 -04001758 /**
1759 * Overrides ContentTitle in the big form of the template.
1760 * This defaults to the value passed to setContentTitle().
1761 */
1762 public BigTextStyle setBigContentTitle(CharSequence title) {
1763 internalSetBigContentTitle(title);
1764 return this;
1765 }
1766
1767 /**
1768 * Set the first line of text after the detail section in the big form of the template.
1769 */
1770 public BigTextStyle setSummaryText(CharSequence cs) {
1771 internalSetSummaryText(cs);
1772 return this;
1773 }
1774
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001775 public BigTextStyle bigText(CharSequence cs) {
1776 mBigText = cs;
1777 return this;
1778 }
1779
1780 private RemoteViews makeBigContentView() {
Chris Wrend6297db2012-05-03 16:20:13 -04001781 RemoteViews contentView = getStandardView(R.layout.notification_template_big_text);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001782 contentView.setTextViewText(R.id.big_text, mBigText);
1783 contentView.setViewVisibility(R.id.big_text, View.VISIBLE);
Chris Wren3c5f92432012-05-04 16:31:17 -04001784 contentView.setViewVisibility(R.id.text2, View.GONE);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001785
1786 return contentView;
1787 }
1788
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001789 @Override
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001790 public Notification build() {
Chris Wrend6297db2012-05-03 16:20:13 -04001791 checkBuilder();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001792 Notification wip = mBuilder.buildUnstyled();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001793 wip.bigContentView = makeBigContentView();
1794 return wip;
1795 }
1796 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04001797
1798 /**
1799 * Helper class for generating large-format notifications that include a list of (up to 5) strings.
1800 *
1801 * This class is a "rebuilder": It consumes a Builder object and modifies its behavior, like so:
1802 * <pre class="prettyprint">
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001803 * Notification noti = new Notification.InboxStyle(
Daniel Sandler879c5e02012-04-17 16:46:51 -04001804 * new Notification.Builder()
Chris Wrend6297db2012-05-03 16:20:13 -04001805 * .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
Daniel Sandler879c5e02012-04-17 16:46:51 -04001806 * .setContentText(subject)
1807 * .setSmallIcon(R.drawable.new_mail)
1808 * .setLargeIcon(aBitmap))
1809 * .addLine(str1)
1810 * .addLine(str2)
Chris Wrend6297db2012-05-03 16:20:13 -04001811 * .setContentTitle("")
1812 * .setSummaryText(&quot;+3 more&quot;)
Daniel Sandler879c5e02012-04-17 16:46:51 -04001813 * .build();
1814 * </pre>
1815 *
1816 * @see Notification#bigContentView
1817 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001818 public static class InboxStyle extends Style {
Daniel Sandler879c5e02012-04-17 16:46:51 -04001819 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
1820
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001821 public InboxStyle() {
1822 }
1823
Daniel Sandler879c5e02012-04-17 16:46:51 -04001824 public InboxStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001825 setBuilder(builder);
Daniel Sandler879c5e02012-04-17 16:46:51 -04001826 }
1827
Chris Wrend6297db2012-05-03 16:20:13 -04001828 /**
1829 * Overrides ContentTitle in the big form of the template.
1830 * This defaults to the value passed to setContentTitle().
1831 */
1832 public InboxStyle setBigContentTitle(CharSequence title) {
1833 internalSetBigContentTitle(title);
1834 return this;
1835 }
1836
1837 /**
1838 * Set the first line of text after the detail section in the big form of the template.
1839 */
1840 public InboxStyle setSummaryText(CharSequence cs) {
1841 internalSetSummaryText(cs);
1842 return this;
1843 }
1844
Daniel Sandler879c5e02012-04-17 16:46:51 -04001845 public InboxStyle addLine(CharSequence cs) {
1846 mTexts.add(cs);
1847 return this;
1848 }
1849
1850 private RemoteViews makeBigContentView() {
Chris Wrend6297db2012-05-03 16:20:13 -04001851 RemoteViews contentView = getStandardView(R.layout.notification_template_inbox);
1852 contentView.setViewVisibility(R.id.text2, View.GONE);
Daniel Sandler879c5e02012-04-17 16:46:51 -04001853
Chris Wrend6297db2012-05-03 16:20:13 -04001854 int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3,
1855 R.id.inbox_text4};
1856
Daniel Sandler879c5e02012-04-17 16:46:51 -04001857 int i=0;
1858 while (i < mTexts.size() && i < rowIds.length) {
1859 CharSequence str = mTexts.get(i);
1860 if (str != null && !str.equals("")) {
1861 contentView.setViewVisibility(rowIds[i], View.VISIBLE);
1862 contentView.setTextViewText(rowIds[i], str);
Chris Wren67dc9a02012-05-16 01:03:20 -04001863 } else {
1864 contentView.setViewVisibility(rowIds[i], View.GONE);
Daniel Sandler879c5e02012-04-17 16:46:51 -04001865 }
1866 i++;
1867 }
1868
1869 return contentView;
1870 }
1871
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001872 @Override
Daniel Sandler879c5e02012-04-17 16:46:51 -04001873 public Notification build() {
Chris Wrend6297db2012-05-03 16:20:13 -04001874 checkBuilder();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001875 Notification wip = mBuilder.buildUnstyled();
Daniel Sandler879c5e02012-04-17 16:46:51 -04001876 wip.bigContentView = makeBigContentView();
1877 return wip;
1878 }
1879 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001880}