blob: 8d994c43a1edaac7f9e745d992a16078a7832062 [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;
Daniel Sandler9f7936a2012-05-21 16:14:28 -040023import android.content.res.Resources;
Joe Onoratoef1e7762010-09-17 18:38:38 -040024import android.graphics.Bitmap;
Jeff Sharkey098d5802012-04-26 17:30:34 -070025import android.media.AudioManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080026import android.net.Uri;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050027import android.os.Bundle;
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;
Jeff Sharkey6d515712012-09-20 16:06:08 -070031import android.os.UserHandle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080032import android.text.TextUtils;
Daniel Sandler9f7936a2012-05-21 16:14:28 -040033import android.util.TypedValue;
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.
Joe Malin8d40d042012-11-05 11:36:40 -080094 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -050095 * 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
Joe Malin8d40d042012-11-05 11:36:40 -0800100 * timestamped according to when the activity began.
101 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500102 * Some examples:
Joe Malin8d40d042012-11-05 11:36:40 -0800103 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500104 * <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.
Joe Malin8d40d042012-11-05 11:36:40 -0800111 * </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.
Joe Malin8d40d042012-11-05 11:36:40 -0800134 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500135 * 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.
Joe Malin8d40d042012-11-05 11:36:40 -0800140 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500141 * 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 Sandler8aa9ae62012-12-04 23:31:47 -0500321 * user.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500322
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.
Joe Malin8d40d042012-11-05 11:36:40 -0800342 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500343 * @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.
Joe Malin8d40d042012-11-05 11:36:40 -0800383 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500384 * 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
Daniel Sandler6738eee2012-11-16 12:03:32 -0500387 * system will make a determination about how to interpret this priority when presenting
388 * the notification.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500389 */
390 public int priority;
Joe Malin8d40d042012-11-05 11:36:40 -0800391
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500392 /**
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 /**
Daniel Sandlera90513d2012-06-04 02:11:17 -0400417 * @hide
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500418 * Notification type: promotion or advertisement.
419 */
420 public static final String KIND_PROMO = "android.promo";
421
422 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -0400423 * @hide
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500424 * If this notification matches of one or more special types (see the <code>KIND_*</code>
425 * constants), add them here, best match first.
426 */
427 public String[] kind;
428
429 /**
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400430 * Additional semantic data to be carried around with this Notification.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500431 * @hide
432 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400433 public Bundle extras = new Bundle();
434
435 // extras keys for Builder inputs
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500436 /** @hide */
437 public static final String EXTRA_TITLE = "android.title";
438 /** @hide */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400439 public static final String EXTRA_TITLE_BIG = EXTRA_TITLE + ".big";
440 /** @hide */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500441 public static final String EXTRA_TEXT = "android.text";
442 /** @hide */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400443 public static final String EXTRA_SUB_TEXT = "android.subText";
444 /** @hide */
445 public static final String EXTRA_INFO_TEXT = "android.infoText";
446 /** @hide */
447 public static final String EXTRA_SUMMARY_TEXT = "android.summaryText";
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500448 /** @hide */
449 public static final String EXTRA_SMALL_ICON = "android.icon";
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500450 /** @hide */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400451 public static final String EXTRA_LARGE_ICON = "android.largeIcon";
452 /** @hide */
453 public static final String EXTRA_LARGE_ICON_BIG = EXTRA_LARGE_ICON + ".big";
454 /** @hide */
455 public static final String EXTRA_PROGRESS = "android.progress";
456 /** @hide */
457 public static final String EXTRA_PROGRESS_MAX = "android.progressMax";
458 /** @hide */
459 public static final String EXTRA_PROGRESS_INDETERMINATE = "android.progressIndeterminate";
460 /** @hide */
461 public static final String EXTRA_SHOW_CHRONOMETER = "android.showChronometer";
462 /** @hide */
463 public static final String EXTRA_SHOW_WHEN = "android.showWhen";
464 /** @hide from BigPictureStyle */
465 public static final String EXTRA_PICTURE = "android.picture";
466 /** @hide from InboxStyle */
467 public static final String EXTRA_TEXT_LINES = "android.textLines";
468
469 // extras keys for other interesting pieces of information
470 /** @hide */
471 public static final String EXTRA_PEOPLE = "android.people";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500472
473 /**
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400474 * Structure to encapsulate an "action", including title and icon, that can be attached to a Notification.
475 * @hide
476 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -0500477 public static class Action implements Parcelable {
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400478 public int icon;
479 public CharSequence title;
480 public PendingIntent actionIntent;
481 @SuppressWarnings("unused")
482 public Action() { }
483 private Action(Parcel in) {
484 icon = in.readInt();
485 title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
486 if (in.readInt() == 1) {
487 actionIntent = PendingIntent.CREATOR.createFromParcel(in);
488 }
489 }
490 public Action(int icon_, CharSequence title_, PendingIntent intent_) {
491 this.icon = icon_;
492 this.title = title_;
493 this.actionIntent = intent_;
494 }
495 @Override
496 public Action clone() {
497 return new Action(
498 this.icon,
499 this.title.toString(),
500 this.actionIntent // safe to alias
501 );
502 }
503 @Override
504 public int describeContents() {
505 return 0;
506 }
507 @Override
508 public void writeToParcel(Parcel out, int flags) {
509 out.writeInt(icon);
510 TextUtils.writeToParcel(title, out, flags);
511 if (actionIntent != null) {
512 out.writeInt(1);
513 actionIntent.writeToParcel(out, flags);
514 } else {
515 out.writeInt(0);
516 }
517 }
518 public static final Parcelable.Creator<Action> CREATOR
519 = new Parcelable.Creator<Action>() {
520 public Action createFromParcel(Parcel in) {
521 return new Action(in);
522 }
523 public Action[] newArray(int size) {
524 return new Action[size];
525 }
526 };
527 }
528
Daniel Sandlerea2a3172013-02-20 22:24:20 -0500529 /**
530 * @hide
531 */
532 public Action[] actions;
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400533
534 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500535 * Constructs a Notification object with default values.
Joe Onorato46439ce2010-11-19 13:56:21 -0800536 * You might want to consider using {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800537 */
538 public Notification()
539 {
540 this.when = System.currentTimeMillis();
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500541 this.priority = PRIORITY_DEFAULT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800542 }
543
544 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800545 * @hide
546 */
547 public Notification(Context context, int icon, CharSequence tickerText, long when,
548 CharSequence contentTitle, CharSequence contentText, Intent contentIntent)
549 {
550 this.when = when;
551 this.icon = icon;
552 this.tickerText = tickerText;
553 setLatestEventInfo(context, contentTitle, contentText,
554 PendingIntent.getActivity(context, 0, contentIntent, 0));
555 }
556
557 /**
558 * Constructs a Notification object with the information needed to
559 * have a status bar icon without the standard expanded view.
560 *
561 * @param icon The resource id of the icon to put in the status bar.
562 * @param tickerText The text that flows by in the status bar when the notification first
563 * activates.
564 * @param when The time to show in the time field. In the System.currentTimeMillis
565 * timebase.
Joe Onorato46439ce2010-11-19 13:56:21 -0800566 *
567 * @deprecated Use {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800568 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800569 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800570 public Notification(int icon, CharSequence tickerText, long when)
571 {
572 this.icon = icon;
573 this.tickerText = tickerText;
574 this.when = when;
575 }
576
577 /**
578 * Unflatten the notification from a parcel.
579 */
580 public Notification(Parcel parcel)
581 {
582 int version = parcel.readInt();
583
584 when = parcel.readLong();
585 icon = parcel.readInt();
586 number = parcel.readInt();
587 if (parcel.readInt() != 0) {
588 contentIntent = PendingIntent.CREATOR.createFromParcel(parcel);
589 }
590 if (parcel.readInt() != 0) {
591 deleteIntent = PendingIntent.CREATOR.createFromParcel(parcel);
592 }
593 if (parcel.readInt() != 0) {
594 tickerText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
595 }
596 if (parcel.readInt() != 0) {
Joe Onorato46439ce2010-11-19 13:56:21 -0800597 tickerView = RemoteViews.CREATOR.createFromParcel(parcel);
Joe Onoratoef1e7762010-09-17 18:38:38 -0400598 }
599 if (parcel.readInt() != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800600 contentView = RemoteViews.CREATOR.createFromParcel(parcel);
601 }
Joe Onorato561d3852010-11-20 18:09:34 -0800602 if (parcel.readInt() != 0) {
603 largeIcon = Bitmap.CREATOR.createFromParcel(parcel);
604 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800605 defaults = parcel.readInt();
606 flags = parcel.readInt();
607 if (parcel.readInt() != 0) {
608 sound = Uri.CREATOR.createFromParcel(parcel);
609 }
610
611 audioStreamType = parcel.readInt();
612 vibrate = parcel.createLongArray();
613 ledARGB = parcel.readInt();
614 ledOnMS = parcel.readInt();
615 ledOffMS = parcel.readInt();
616 iconLevel = parcel.readInt();
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400617
618 if (parcel.readInt() != 0) {
619 fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel);
620 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500621
622 priority = parcel.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400623
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500624 kind = parcel.createStringArray(); // may set kind to null
625
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500626 extras = parcel.readBundle(); // may be null
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400627
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500628 actions = parcel.createTypedArray(Action.CREATOR); // may be null
629
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400630 if (parcel.readInt() != 0) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400631 bigContentView = RemoteViews.CREATOR.createFromParcel(parcel);
632 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800633 }
634
Andy Stadler110988c2010-12-03 14:29:16 -0800635 @Override
Joe Onorato18e69df2010-05-17 22:26:12 -0700636 public Notification clone() {
637 Notification that = new Notification();
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500638 cloneInto(that);
639 return that;
640 }
Joe Onorato18e69df2010-05-17 22:26:12 -0700641
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500642 private void cloneInto(Notification that) {
Joe Onorato18e69df2010-05-17 22:26:12 -0700643 that.when = this.when;
644 that.icon = this.icon;
645 that.number = this.number;
646
647 // PendingIntents are global, so there's no reason (or way) to clone them.
648 that.contentIntent = this.contentIntent;
649 that.deleteIntent = this.deleteIntent;
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400650 that.fullScreenIntent = this.fullScreenIntent;
Joe Onorato18e69df2010-05-17 22:26:12 -0700651
652 if (this.tickerText != null) {
653 that.tickerText = this.tickerText.toString();
654 }
Joe Onorato46439ce2010-11-19 13:56:21 -0800655 if (this.tickerView != null) {
656 that.tickerView = this.tickerView.clone();
Joe Onoratoef1e7762010-09-17 18:38:38 -0400657 }
Joe Onorato18e69df2010-05-17 22:26:12 -0700658 if (this.contentView != null) {
659 that.contentView = this.contentView.clone();
660 }
Joe Onorato561d3852010-11-20 18:09:34 -0800661 if (this.largeIcon != null) {
662 that.largeIcon = Bitmap.createBitmap(this.largeIcon);
663 }
Jozef BABJAKa8b91832011-02-22 08:05:08 +0100664 that.iconLevel = this.iconLevel;
Joe Onorato18e69df2010-05-17 22:26:12 -0700665 that.sound = this.sound; // android.net.Uri is immutable
666 that.audioStreamType = this.audioStreamType;
667
668 final long[] vibrate = this.vibrate;
669 if (vibrate != null) {
670 final int N = vibrate.length;
671 final long[] vib = that.vibrate = new long[N];
672 System.arraycopy(vibrate, 0, vib, 0, N);
673 }
674
675 that.ledARGB = this.ledARGB;
676 that.ledOnMS = this.ledOnMS;
677 that.ledOffMS = this.ledOffMS;
678 that.defaults = this.defaults;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500679
Joe Onorato18e69df2010-05-17 22:26:12 -0700680 that.flags = this.flags;
681
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500682 that.priority = this.priority;
Joe Malin8d40d042012-11-05 11:36:40 -0800683
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500684 final String[] thiskind = this.kind;
685 if (thiskind != null) {
686 final int N = thiskind.length;
687 final String[] thatkind = that.kind = new String[N];
688 System.arraycopy(thiskind, 0, thatkind, 0, N);
689 }
690
691 if (this.extras != null) {
692 that.extras = new Bundle(this.extras);
693
694 }
695
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500696 if (this.actions != null) {
697 that.actions = new Action[this.actions.length];
698 for(int i=0; i<this.actions.length; i++) {
699 that.actions[i] = this.actions[i].clone();
700 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400701 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500702
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400703 if (this.bigContentView != null) {
704 that.bigContentView = this.bigContentView.clone();
705 }
Joe Onorato18e69df2010-05-17 22:26:12 -0700706 }
707
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800708 public int describeContents() {
709 return 0;
710 }
711
712 /**
713 * Flatten this notification from a parcel.
714 */
715 public void writeToParcel(Parcel parcel, int flags)
716 {
717 parcel.writeInt(1);
718
719 parcel.writeLong(when);
720 parcel.writeInt(icon);
721 parcel.writeInt(number);
722 if (contentIntent != null) {
723 parcel.writeInt(1);
724 contentIntent.writeToParcel(parcel, 0);
725 } else {
726 parcel.writeInt(0);
727 }
728 if (deleteIntent != null) {
729 parcel.writeInt(1);
730 deleteIntent.writeToParcel(parcel, 0);
731 } else {
732 parcel.writeInt(0);
733 }
734 if (tickerText != null) {
735 parcel.writeInt(1);
736 TextUtils.writeToParcel(tickerText, parcel, flags);
737 } else {
738 parcel.writeInt(0);
739 }
Joe Onorato46439ce2010-11-19 13:56:21 -0800740 if (tickerView != null) {
Joe Onoratoef1e7762010-09-17 18:38:38 -0400741 parcel.writeInt(1);
Joe Onorato46439ce2010-11-19 13:56:21 -0800742 tickerView.writeToParcel(parcel, 0);
Joe Onoratoef1e7762010-09-17 18:38:38 -0400743 } else {
744 parcel.writeInt(0);
745 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800746 if (contentView != null) {
747 parcel.writeInt(1);
748 contentView.writeToParcel(parcel, 0);
749 } else {
750 parcel.writeInt(0);
751 }
Joe Onorato561d3852010-11-20 18:09:34 -0800752 if (largeIcon != null) {
753 parcel.writeInt(1);
754 largeIcon.writeToParcel(parcel, 0);
755 } else {
756 parcel.writeInt(0);
757 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800758
759 parcel.writeInt(defaults);
760 parcel.writeInt(this.flags);
761
762 if (sound != null) {
763 parcel.writeInt(1);
764 sound.writeToParcel(parcel, 0);
765 } else {
766 parcel.writeInt(0);
767 }
768 parcel.writeInt(audioStreamType);
769 parcel.writeLongArray(vibrate);
770 parcel.writeInt(ledARGB);
771 parcel.writeInt(ledOnMS);
772 parcel.writeInt(ledOffMS);
773 parcel.writeInt(iconLevel);
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400774
775 if (fullScreenIntent != null) {
776 parcel.writeInt(1);
777 fullScreenIntent.writeToParcel(parcel, 0);
778 } else {
779 parcel.writeInt(0);
780 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500781
782 parcel.writeInt(priority);
Joe Malin8d40d042012-11-05 11:36:40 -0800783
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500784 parcel.writeStringArray(kind); // ok for null
Joe Malin8d40d042012-11-05 11:36:40 -0800785
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500786 parcel.writeBundle(extras); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400787
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500788 parcel.writeTypedArray(actions, 0); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400789
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400790 if (bigContentView != null) {
791 parcel.writeInt(1);
792 bigContentView.writeToParcel(parcel, 0);
793 } else {
794 parcel.writeInt(0);
795 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800796 }
797
798 /**
799 * Parcelable.Creator that instantiates Notification objects
800 */
801 public static final Parcelable.Creator<Notification> CREATOR
802 = new Parcelable.Creator<Notification>()
803 {
804 public Notification createFromParcel(Parcel parcel)
805 {
806 return new Notification(parcel);
807 }
808
809 public Notification[] newArray(int size)
810 {
811 return new Notification[size];
812 }
813 };
814
815 /**
816 * Sets the {@link #contentView} field to be a view with the standard "Latest Event"
817 * layout.
818 *
819 * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields
820 * in the view.</p>
821 * @param context The context for your application / activity.
822 * @param contentTitle The title that goes in the expanded entry.
823 * @param contentText The text that goes in the expanded entry.
824 * @param contentIntent The intent to launch when the user clicks the expanded notification.
825 * If this is an activity, it must include the
826 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -0800827 * that you take care of task management as described in the
828 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
829 * Stack</a> document.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500830 *
Joe Onorato46439ce2010-11-19 13:56:21 -0800831 * @deprecated Use {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800832 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800833 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800834 public void setLatestEventInfo(Context context,
835 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500836 Notification.Builder builder = new Notification.Builder(context);
837
838 // First, ensure that key pieces of information that may have been set directly
839 // are preserved
840 builder.setWhen(this.when);
841 builder.setSmallIcon(this.icon);
842 builder.setPriority(this.priority);
843 builder.setTicker(this.tickerText);
844 builder.setNumber(this.number);
845 builder.mFlags = this.flags;
846 builder.setSound(this.sound, this.audioStreamType);
847 builder.setDefaults(this.defaults);
848 builder.setVibrate(this.vibrate);
849
850 // now apply the latestEventInfo fields
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800851 if (contentTitle != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500852 builder.setContentTitle(contentTitle);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800853 }
854 if (contentText != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500855 builder.setContentText(contentText);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800856 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500857 builder.setContentIntent(contentIntent);
858 builder.buildInto(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800859 }
860
861 @Override
862 public String toString() {
863 StringBuilder sb = new StringBuilder();
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500864 sb.append("Notification(pri=");
865 sb.append(priority);
866 sb.append(" contentView=");
Joe Onoratoc9596d62011-01-12 17:03:11 -0800867 if (contentView != null) {
868 sb.append(contentView.getPackage());
869 sb.append("/0x");
870 sb.append(Integer.toHexString(contentView.getLayoutId()));
871 } else {
872 sb.append("null");
873 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500874 // TODO(dsandler): defaults take precedence over local values, so reorder the branches below
Joe Onoratoc9596d62011-01-12 17:03:11 -0800875 sb.append(" vibrate=");
Daniel Sandler6738eee2012-11-16 12:03:32 -0500876 if ((this.defaults & DEFAULT_VIBRATE) != 0) {
877 sb.append("default");
878 } else if (this.vibrate != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800879 int N = this.vibrate.length-1;
880 sb.append("[");
881 for (int i=0; i<N; i++) {
882 sb.append(this.vibrate[i]);
883 sb.append(',');
884 }
Simon Schoar8cf97d92009-06-10 22:08:37 +0200885 if (N != -1) {
886 sb.append(this.vibrate[N]);
887 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800888 sb.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800889 } else {
890 sb.append("null");
891 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500892 sb.append(" sound=");
Daniel Sandler6738eee2012-11-16 12:03:32 -0500893 if ((this.defaults & DEFAULT_SOUND) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800894 sb.append("default");
Daniel Sandler6738eee2012-11-16 12:03:32 -0500895 } else if (this.sound != null) {
896 sb.append(this.sound.toString());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800897 } else {
898 sb.append("null");
899 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500900 sb.append(" defaults=0x");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800901 sb.append(Integer.toHexString(this.defaults));
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500902 sb.append(" flags=0x");
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400903 sb.append(Integer.toHexString(this.flags));
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500904 sb.append(" kind=[");
905 if (this.kind == null) {
906 sb.append("null");
907 } else {
908 for (int i=0; i<this.kind.length; i++) {
909 if (i>0) sb.append(",");
910 sb.append(this.kind[i]);
911 }
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400912 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400913 sb.append("]");
914 if (actions != null) {
915 sb.append(" ");
916 sb.append(actions.length);
917 sb.append(" action");
918 if (actions.length > 1) sb.append("s");
919 }
920 sb.append(")");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800921 return sb.toString();
922 }
Joe Onorato46439ce2010-11-19 13:56:21 -0800923
Jeff Sharkey6d515712012-09-20 16:06:08 -0700924 /** {@hide} */
925 public void setUser(UserHandle user) {
Amith Yamasaniecbd68b2012-11-02 12:17:19 -0700926 if (user.getIdentifier() == UserHandle.USER_ALL) {
927 user = UserHandle.OWNER;
928 }
Jeff Sharkey6d515712012-09-20 16:06:08 -0700929 if (tickerView != null) {
930 tickerView.setUser(user);
931 }
932 if (contentView != null) {
933 contentView.setUser(user);
934 }
935 if (bigContentView != null) {
936 bigContentView.setUser(user);
937 }
938 }
939
Joe Onoratocb109a02011-01-18 17:57:41 -0800940 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500941 * Builder class for {@link Notification} objects.
Joe Malin8d40d042012-11-05 11:36:40 -0800942 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500943 * Provides a convenient way to set the various fields of a {@link Notification} and generate
Scott Main183bf112012-08-13 19:12:13 -0700944 * content views using the platform's notification layout template. If your app supports
945 * versions of Android as old as API level 4, you can instead use
946 * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder},
947 * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support
948 * library</a>.
Joe Malin8d40d042012-11-05 11:36:40 -0800949 *
Scott Main183bf112012-08-13 19:12:13 -0700950 * <p>Example:
Joe Malin8d40d042012-11-05 11:36:40 -0800951 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500952 * <pre class="prettyprint">
Scott Main183bf112012-08-13 19:12:13 -0700953 * Notification noti = new Notification.Builder(mContext)
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500954 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
955 * .setContentText(subject)
956 * .setSmallIcon(R.drawable.new_mail)
957 * .setLargeIcon(aBitmap)
Chris Wrenfbd96ba2012-05-01 12:03:58 -0400958 * .build();
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500959 * </pre>
Joe Onoratocb109a02011-01-18 17:57:41 -0800960 */
Joe Onorato46439ce2010-11-19 13:56:21 -0800961 public static class Builder {
Daniel Sandler602ad1c2012-06-12 16:06:27 -0400962 private static final int MAX_ACTION_BUTTONS = 3;
Daniel Sandler8680bf82012-05-15 16:52:52 -0400963
Joe Onorato46439ce2010-11-19 13:56:21 -0800964 private Context mContext;
965
966 private long mWhen;
967 private int mSmallIcon;
968 private int mSmallIconLevel;
Joe Onorato8595a3d2010-11-19 18:12:07 -0800969 private int mNumber;
Joe Onorato46439ce2010-11-19 13:56:21 -0800970 private CharSequence mContentTitle;
971 private CharSequence mContentText;
972 private CharSequence mContentInfo;
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400973 private CharSequence mSubText;
Joe Onorato46439ce2010-11-19 13:56:21 -0800974 private PendingIntent mContentIntent;
975 private RemoteViews mContentView;
976 private PendingIntent mDeleteIntent;
977 private PendingIntent mFullScreenIntent;
978 private CharSequence mTickerText;
979 private RemoteViews mTickerView;
980 private Bitmap mLargeIcon;
981 private Uri mSound;
982 private int mAudioStreamType;
983 private long[] mVibrate;
984 private int mLedArgb;
985 private int mLedOnMs;
986 private int mLedOffMs;
987 private int mDefaults;
988 private int mFlags;
Jeff Sharkey1c400132011-08-05 14:50:13 -0700989 private int mProgressMax;
990 private int mProgress;
991 private boolean mProgressIndeterminate;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500992 private ArrayList<String> mKindList = new ArrayList<String>(1);
993 private Bundle mExtras;
994 private int mPriority;
Daniel Sandler8680bf82012-05-15 16:52:52 -0400995 private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS);
Daniel Sandlera2985ed2012-04-03 16:42:00 -0400996 private boolean mUseChronometer;
Chris Wrenfbd96ba2012-05-01 12:03:58 -0400997 private Style mStyle;
Daniel Sandler0c890492012-09-12 17:23:10 -0700998 private boolean mShowWhen = true;
Joe Onorato46439ce2010-11-19 13:56:21 -0800999
Joe Onoratocb109a02011-01-18 17:57:41 -08001000 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001001 * Constructs a new Builder with the defaults:
Joe Onoratocb109a02011-01-18 17:57:41 -08001002 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001003
1004 * <table>
1005 * <tr><th align=right>priority</th>
1006 * <td>{@link #PRIORITY_DEFAULT}</td></tr>
1007 * <tr><th align=right>when</th>
1008 * <td>now ({@link System#currentTimeMillis()})</td></tr>
1009 * <tr><th align=right>audio stream</th>
1010 * <td>{@link #STREAM_DEFAULT}</td></tr>
1011 * </table>
Joe Onoratocb109a02011-01-18 17:57:41 -08001012 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001013
1014 * @param context
1015 * A {@link Context} that will be used by the Builder to construct the
1016 * RemoteViews. The Context will not be held past the lifetime of this Builder
1017 * object.
Joe Onoratocb109a02011-01-18 17:57:41 -08001018 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001019 public Builder(Context context) {
1020 mContext = context;
Andy Stadler110988c2010-12-03 14:29:16 -08001021
1022 // Set defaults to match the defaults of a Notification
Joe Onorato46439ce2010-11-19 13:56:21 -08001023 mWhen = System.currentTimeMillis();
Andy Stadler110988c2010-12-03 14:29:16 -08001024 mAudioStreamType = STREAM_DEFAULT;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001025 mPriority = PRIORITY_DEFAULT;
Joe Onorato46439ce2010-11-19 13:56:21 -08001026 }
1027
Joe Onoratocb109a02011-01-18 17:57:41 -08001028 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001029 * Add a timestamp pertaining to the notification (usually the time the event occurred).
Daniel Sandler0c890492012-09-12 17:23:10 -07001030 * It will be shown in the notification content view by default; use
1031 * {@link Builder#setShowWhen(boolean) setShowWhen} to control this.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001032 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001033 * @see Notification#when
Joe Onoratocb109a02011-01-18 17:57:41 -08001034 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001035 public Builder setWhen(long when) {
1036 mWhen = when;
1037 return this;
1038 }
1039
Joe Onoratocb109a02011-01-18 17:57:41 -08001040 /**
Daniel Sandler0c890492012-09-12 17:23:10 -07001041 * Control whether the timestamp set with {@link Builder#setWhen(long) setWhen} is shown
1042 * in the content view.
1043 */
1044 public Builder setShowWhen(boolean show) {
1045 mShowWhen = show;
1046 return this;
1047 }
1048
1049 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04001050 * Show the {@link Notification#when} field as a stopwatch.
Joe Malin8d40d042012-11-05 11:36:40 -08001051 *
1052 * Instead of presenting <code>when</code> as a timestamp, the notification will show an
Daniel Sandlerd33b8032012-05-10 11:41:48 -04001053 * automatically updating display of the minutes and seconds since <code>when</code>.
Daniel Sandlera2985ed2012-04-03 16:42:00 -04001054 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04001055 * Useful when showing an elapsed time (like an ongoing phone call).
1056 *
1057 * @see android.widget.Chronometer
Daniel Sandlera2985ed2012-04-03 16:42:00 -04001058 * @see Notification#when
1059 */
1060 public Builder setUsesChronometer(boolean b) {
1061 mUseChronometer = b;
1062 return this;
1063 }
1064
1065 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001066 * Set the small icon resource, which will be used to represent the notification in the
1067 * status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -08001068 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001069
1070 * The platform template for the expanded view will draw this icon in the left, unless a
1071 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
1072 * icon will be moved to the right-hand side.
1073 *
1074
1075 * @param icon
1076 * A resource ID in the application's package of the drawable to use.
1077 * @see Notification#icon
Joe Onoratocb109a02011-01-18 17:57:41 -08001078 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001079 public Builder setSmallIcon(int icon) {
1080 mSmallIcon = icon;
1081 return this;
1082 }
1083
Joe Onoratocb109a02011-01-18 17:57:41 -08001084 /**
1085 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
1086 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
1087 * LevelListDrawable}.
1088 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001089 * @param icon A resource ID in the application's package of the drawable to use.
Joe Onoratocb109a02011-01-18 17:57:41 -08001090 * @param level The level to use for the icon.
1091 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001092 * @see Notification#icon
1093 * @see Notification#iconLevel
Joe Onoratocb109a02011-01-18 17:57:41 -08001094 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001095 public Builder setSmallIcon(int icon, int level) {
1096 mSmallIcon = icon;
1097 mSmallIconLevel = level;
1098 return this;
1099 }
1100
Joe Onoratocb109a02011-01-18 17:57:41 -08001101 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001102 * Set the first line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08001103 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001104 public Builder setContentTitle(CharSequence title) {
1105 mContentTitle = title;
1106 return this;
1107 }
1108
Joe Onoratocb109a02011-01-18 17:57:41 -08001109 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001110 * Set the second line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08001111 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001112 public Builder setContentText(CharSequence text) {
1113 mContentText = text;
1114 return this;
1115 }
1116
Joe Onoratocb109a02011-01-18 17:57:41 -08001117 /**
Joe Malin8d40d042012-11-05 11:36:40 -08001118 * Set the third line of text in the platform notification template.
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001119 * Don't use if you're also using {@link #setProgress(int, int, boolean)}; they occupy the same location in the standard template.
1120 */
1121 public Builder setSubText(CharSequence text) {
1122 mSubText = text;
1123 return this;
1124 }
1125
1126 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08001127 * Set the large number at the right-hand side of the notification. This is
1128 * equivalent to setContentInfo, although it might show the number in a different
1129 * font size for readability.
1130 */
Joe Onorato8595a3d2010-11-19 18:12:07 -08001131 public Builder setNumber(int number) {
1132 mNumber = number;
1133 return this;
1134 }
1135
Joe Onoratocb109a02011-01-18 17:57:41 -08001136 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001137 * A small piece of additional information pertaining to this notification.
1138 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001139 * The platform template will draw this on the last line of the notification, at the far
1140 * right (to the right of a smallIcon if it has been placed there).
Joe Onoratocb109a02011-01-18 17:57:41 -08001141 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001142 public Builder setContentInfo(CharSequence info) {
1143 mContentInfo = info;
1144 return this;
1145 }
1146
Joe Onoratocb109a02011-01-18 17:57:41 -08001147 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001148 * Set the progress this notification represents.
1149 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001150 * The platform template will represent this using a {@link ProgressBar}.
Jeff Sharkey1c400132011-08-05 14:50:13 -07001151 */
1152 public Builder setProgress(int max, int progress, boolean indeterminate) {
1153 mProgressMax = max;
1154 mProgress = progress;
1155 mProgressIndeterminate = indeterminate;
1156 return this;
1157 }
1158
1159 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001160 * Supply a custom RemoteViews to use instead of the platform template.
1161 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001162 * @see Notification#contentView
Joe Onoratocb109a02011-01-18 17:57:41 -08001163 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001164 public Builder setContent(RemoteViews views) {
1165 mContentView = views;
1166 return this;
1167 }
1168
Joe Onoratocb109a02011-01-18 17:57:41 -08001169 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001170 * Supply a {@link PendingIntent} to be sent when the notification is clicked.
1171 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001172 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
1173 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
1174 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001175 * to assign PendingIntents to individual views in that custom layout (i.e., to create
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001176 * clickable buttons inside the notification view).
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001177 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001178 * @see Notification#contentIntent Notification.contentIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08001179 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001180 public Builder setContentIntent(PendingIntent intent) {
1181 mContentIntent = intent;
1182 return this;
1183 }
1184
Joe Onoratocb109a02011-01-18 17:57:41 -08001185 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001186 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
1187 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001188 * @see Notification#deleteIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08001189 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001190 public Builder setDeleteIntent(PendingIntent intent) {
1191 mDeleteIntent = intent;
1192 return this;
1193 }
1194
Joe Onoratocb109a02011-01-18 17:57:41 -08001195 /**
1196 * An intent to launch instead of posting the notification to the status bar.
1197 * Only for use with extremely high-priority notifications demanding the user's
1198 * <strong>immediate</strong> attention, such as an incoming phone call or
1199 * alarm clock that the user has explicitly set to a particular time.
1200 * If this facility is used for something else, please give the user an option
1201 * to turn it off and use a normal notification, as this can be extremely
1202 * disruptive.
1203 *
1204 * @param intent The pending intent to launch.
1205 * @param highPriority Passing true will cause this notification to be sent
1206 * even if other notifications are suppressed.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001207 *
1208 * @see Notification#fullScreenIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08001209 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001210 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
1211 mFullScreenIntent = intent;
1212 setFlag(FLAG_HIGH_PRIORITY, highPriority);
1213 return this;
1214 }
1215
Joe Onoratocb109a02011-01-18 17:57:41 -08001216 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001217 * Set the "ticker" text which is displayed in the status bar when the notification first
Joe Onoratocb109a02011-01-18 17:57:41 -08001218 * arrives.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001219 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001220 * @see Notification#tickerText
Joe Onoratocb109a02011-01-18 17:57:41 -08001221 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001222 public Builder setTicker(CharSequence tickerText) {
1223 mTickerText = tickerText;
1224 return this;
1225 }
1226
Joe Onoratocb109a02011-01-18 17:57:41 -08001227 /**
1228 * Set the text that is displayed in the status bar when the notification first
1229 * arrives, and also a RemoteViews object that may be displayed instead on some
1230 * devices.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001231 *
1232 * @see Notification#tickerText
1233 * @see Notification#tickerView
Joe Onoratocb109a02011-01-18 17:57:41 -08001234 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001235 public Builder setTicker(CharSequence tickerText, RemoteViews views) {
1236 mTickerText = tickerText;
1237 mTickerView = views;
1238 return this;
1239 }
1240
Joe Onoratocb109a02011-01-18 17:57:41 -08001241 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001242 * Add a large icon to the notification (and the ticker on some devices).
1243 *
1244 * In the platform template, this image will be shown on the left of the notification view
1245 * in place of the {@link #setSmallIcon(int) small icon} (which will move to the right side).
1246 *
1247 * @see Notification#largeIcon
Joe Onoratocb109a02011-01-18 17:57:41 -08001248 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001249 public Builder setLargeIcon(Bitmap icon) {
1250 mLargeIcon = icon;
1251 return this;
1252 }
1253
Joe Onoratocb109a02011-01-18 17:57:41 -08001254 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001255 * Set the sound to play.
1256 *
1257 * It will be played on the {@link #STREAM_DEFAULT default stream} for notifications.
1258 *
1259 * @see Notification#sound
Joe Onoratocb109a02011-01-18 17:57:41 -08001260 */
Joe Onorato52f80cd2010-11-21 15:34:48 -08001261 public Builder setSound(Uri sound) {
1262 mSound = sound;
1263 mAudioStreamType = STREAM_DEFAULT;
1264 return this;
1265 }
1266
Joe Onoratocb109a02011-01-18 17:57:41 -08001267 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001268 * Set the sound to play, along with a specific stream on which to play it.
Joe Onoratocb109a02011-01-18 17:57:41 -08001269 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001270 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
1271 *
1272 * @see Notification#sound
Joe Onoratocb109a02011-01-18 17:57:41 -08001273 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001274 public Builder setSound(Uri sound, int streamType) {
1275 mSound = sound;
1276 mAudioStreamType = streamType;
1277 return this;
1278 }
1279
Joe Onoratocb109a02011-01-18 17:57:41 -08001280 /**
1281 * Set the vibration pattern to use.
1282 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001283
1284 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
1285 * <code>pattern</code> parameter.
1286 *
1287
1288 * @see Notification#vibrate
Joe Onoratocb109a02011-01-18 17:57:41 -08001289 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001290 public Builder setVibrate(long[] pattern) {
1291 mVibrate = pattern;
1292 return this;
1293 }
1294
Joe Onoratocb109a02011-01-18 17:57:41 -08001295 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001296 * Set the desired color for the indicator LED on the device, as well as the
1297 * blink duty cycle (specified in milliseconds).
1298 *
1299
1300 * Not all devices will honor all (or even any) of these values.
1301 *
1302
1303 * @see Notification#ledARGB
1304 * @see Notification#ledOnMS
1305 * @see Notification#ledOffMS
Joe Onoratocb109a02011-01-18 17:57:41 -08001306 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001307 public Builder setLights(int argb, int onMs, int offMs) {
1308 mLedArgb = argb;
1309 mLedOnMs = onMs;
1310 mLedOffMs = offMs;
Joe Onorato46439ce2010-11-19 13:56:21 -08001311 return this;
1312 }
1313
Joe Onoratocb109a02011-01-18 17:57:41 -08001314 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001315 * Set whether this is an "ongoing" notification.
Joe Onoratocb109a02011-01-18 17:57:41 -08001316 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001317
1318 * Ongoing notifications cannot be dismissed by the user, so your application or service
1319 * must take care of canceling them.
1320 *
1321
1322 * They are typically used to indicate a background task that the user is actively engaged
1323 * with (e.g., playing music) or is pending in some way and therefore occupying the device
1324 * (e.g., a file download, sync operation, active network connection).
1325 *
1326
1327 * @see Notification#FLAG_ONGOING_EVENT
1328 * @see Service#setForeground(boolean)
Joe Onoratocb109a02011-01-18 17:57:41 -08001329 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001330 public Builder setOngoing(boolean ongoing) {
1331 setFlag(FLAG_ONGOING_EVENT, ongoing);
1332 return this;
1333 }
1334
Joe Onoratocb109a02011-01-18 17:57:41 -08001335 /**
1336 * Set this flag if you would only like the sound, vibrate
1337 * and ticker to be played if the notification is not already showing.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001338 *
1339 * @see Notification#FLAG_ONLY_ALERT_ONCE
Joe Onoratocb109a02011-01-18 17:57:41 -08001340 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001341 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
1342 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
1343 return this;
1344 }
1345
Joe Onoratocb109a02011-01-18 17:57:41 -08001346 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001347 * Make this notification automatically dismissed when the user touches it. The
1348 * PendingIntent set with {@link #setDeleteIntent} will be sent when this happens.
1349 *
1350 * @see Notification#FLAG_AUTO_CANCEL
Joe Onoratocb109a02011-01-18 17:57:41 -08001351 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001352 public Builder setAutoCancel(boolean autoCancel) {
Joe Onorato281d83f2011-01-04 17:13:10 -08001353 setFlag(FLAG_AUTO_CANCEL, autoCancel);
Joe Onorato46439ce2010-11-19 13:56:21 -08001354 return this;
1355 }
1356
Joe Onoratocb109a02011-01-18 17:57:41 -08001357 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001358 * Set which notification properties will be inherited from system defaults.
Joe Onoratocb109a02011-01-18 17:57:41 -08001359 * <p>
1360 * The value should be one or more of the following fields combined with
1361 * bitwise-or:
1362 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
1363 * <p>
1364 * For all default values, use {@link #DEFAULT_ALL}.
1365 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001366 public Builder setDefaults(int defaults) {
1367 mDefaults = defaults;
1368 return this;
1369 }
1370
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001371 /**
1372 * Set the priority of this notification.
1373 *
1374 * @see Notification#priority
1375 */
1376 public Builder setPriority(int pri) {
1377 mPriority = pri;
1378 return this;
1379 }
Joe Malin8d40d042012-11-05 11:36:40 -08001380
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001381 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04001382 * @hide
Joe Malin8d40d042012-11-05 11:36:40 -08001383 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001384 * Add a kind (category) to this notification. Optional.
Joe Malin8d40d042012-11-05 11:36:40 -08001385 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001386 * @see Notification#kind
1387 */
1388 public Builder addKind(String k) {
1389 mKindList.add(k);
1390 return this;
1391 }
1392
1393 /**
1394 * Add metadata to this notification.
1395 *
1396 * A reference to the Bundle is held for the lifetime of this Builder, and the Bundle's
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001397 * current contents are copied into the Notification each time {@link #build()} is
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001398 * called.
1399 *
1400 * @see Notification#extras
1401 * @hide
1402 */
1403 public Builder setExtras(Bundle bag) {
1404 mExtras = bag;
1405 return this;
1406 }
1407
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001408 /**
1409 * Add an action to this notification. Actions are typically displayed by
1410 * the system as a button adjacent to the notification content.
Joe Malin8d40d042012-11-05 11:36:40 -08001411 * <br>
1412 * A notification displays up to 3 actions, from left to right in the order they were added.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001413 *
1414 * @param icon Resource ID of a drawable that represents the action.
1415 * @param title Text describing the action.
1416 * @param intent PendingIntent to be fired when the action is invoked.
1417 */
1418 public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
1419 mActions.add(new Action(icon, title, intent));
1420 return this;
1421 }
1422
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001423 /**
1424 * Add a rich notification style to be applied at build time.
1425 *
1426 * @param style Object responsible for modifying the notification style.
1427 */
1428 public Builder setStyle(Style style) {
1429 if (mStyle != style) {
1430 mStyle = style;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07001431 if (mStyle != null) {
1432 mStyle.setBuilder(this);
1433 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001434 }
1435 return this;
1436 }
1437
Joe Onorato46439ce2010-11-19 13:56:21 -08001438 private void setFlag(int mask, boolean value) {
1439 if (value) {
1440 mFlags |= mask;
1441 } else {
1442 mFlags &= ~mask;
1443 }
1444 }
1445
Daniel Sandler6387d2f2012-05-22 13:44:09 -04001446 private RemoteViews applyStandardTemplate(int resId, boolean fitIn1U) {
Joe Onorato561d3852010-11-20 18:09:34 -08001447 RemoteViews contentView = new RemoteViews(mContext.getPackageName(), resId);
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001448 boolean showLine3 = false;
1449 boolean showLine2 = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001450 int smallIconImageViewId = R.id.icon;
1451 if (mLargeIcon != null) {
1452 contentView.setImageViewBitmap(R.id.icon, mLargeIcon);
1453 smallIconImageViewId = R.id.right_icon;
1454 }
Daniel Sandlere95658c2012-05-10 00:33:54 -04001455 if (mPriority < PRIORITY_LOW) {
1456 contentView.setInt(R.id.icon,
1457 "setBackgroundResource", R.drawable.notification_template_icon_low_bg);
1458 contentView.setInt(R.id.status_bar_latest_event_content,
1459 "setBackgroundResource", R.drawable.notification_bg_low);
1460 }
Joe Onorato561d3852010-11-20 18:09:34 -08001461 if (mSmallIcon != 0) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001462 contentView.setImageViewResource(smallIconImageViewId, mSmallIcon);
1463 contentView.setViewVisibility(smallIconImageViewId, View.VISIBLE);
Jeff Sharkey1c400132011-08-05 14:50:13 -07001464 } else {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001465 contentView.setViewVisibility(smallIconImageViewId, View.GONE);
Joe Onorato561d3852010-11-20 18:09:34 -08001466 }
1467 if (mContentTitle != null) {
1468 contentView.setTextViewText(R.id.title, mContentTitle);
1469 }
1470 if (mContentText != null) {
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001471 contentView.setTextViewText(R.id.text, mContentText);
1472 showLine3 = true;
Joe Onorato561d3852010-11-20 18:09:34 -08001473 }
1474 if (mContentInfo != null) {
1475 contentView.setTextViewText(R.id.info, mContentInfo);
Jeff Sharkey1c400132011-08-05 14:50:13 -07001476 contentView.setViewVisibility(R.id.info, View.VISIBLE);
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001477 showLine3 = true;
Joe Onorato561d3852010-11-20 18:09:34 -08001478 } else if (mNumber > 0) {
Daniel Sandlerebce0112011-06-16 16:44:51 -04001479 final int tooBig = mContext.getResources().getInteger(
1480 R.integer.status_bar_notification_info_maxnum);
1481 if (mNumber > tooBig) {
1482 contentView.setTextViewText(R.id.info, mContext.getResources().getString(
1483 R.string.status_bar_notification_info_overflow));
Joe Onorato059a2f82011-01-04 10:27:01 -08001484 } else {
1485 NumberFormat f = NumberFormat.getIntegerInstance();
1486 contentView.setTextViewText(R.id.info, f.format(mNumber));
1487 }
Jeff Sharkey1c400132011-08-05 14:50:13 -07001488 contentView.setViewVisibility(R.id.info, View.VISIBLE);
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001489 showLine3 = true;
Joe Onorato561d3852010-11-20 18:09:34 -08001490 } else {
1491 contentView.setViewVisibility(R.id.info, View.GONE);
1492 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001493
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001494 // Need to show three lines?
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001495 if (mSubText != null) {
1496 contentView.setTextViewText(R.id.text, mSubText);
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001497 if (mContentText != null) {
1498 contentView.setTextViewText(R.id.text2, mContentText);
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001499 contentView.setViewVisibility(R.id.text2, View.VISIBLE);
1500 showLine2 = true;
1501 } else {
1502 contentView.setViewVisibility(R.id.text2, View.GONE);
1503 }
Jeff Sharkey1c400132011-08-05 14:50:13 -07001504 } else {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001505 contentView.setViewVisibility(R.id.text2, View.GONE);
1506 if (mProgressMax != 0 || mProgressIndeterminate) {
1507 contentView.setProgressBar(
1508 R.id.progress, mProgressMax, mProgress, mProgressIndeterminate);
1509 contentView.setViewVisibility(R.id.progress, View.VISIBLE);
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001510 showLine2 = true;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001511 } else {
1512 contentView.setViewVisibility(R.id.progress, View.GONE);
1513 }
Jeff Sharkey1c400132011-08-05 14:50:13 -07001514 }
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001515 if (showLine2) {
Daniel Sandler6387d2f2012-05-22 13:44:09 -04001516 if (fitIn1U) {
1517 // need to shrink all the type to make sure everything fits
1518 final Resources res = mContext.getResources();
1519 final float subTextSize = res.getDimensionPixelSize(
1520 R.dimen.notification_subtext_size);
1521 contentView.setTextViewTextSize(R.id.text, TypedValue.COMPLEX_UNIT_PX, subTextSize);
1522 }
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001523 // vertical centering
1524 contentView.setViewPadding(R.id.line1, 0, 0, 0, 0);
1525 }
1526
Daniel Sandler0c890492012-09-12 17:23:10 -07001527 if (mWhen != 0 && mShowWhen) {
Daniel Sandlera2985ed2012-04-03 16:42:00 -04001528 if (mUseChronometer) {
1529 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
1530 contentView.setLong(R.id.chronometer, "setBase",
1531 mWhen + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
1532 contentView.setBoolean(R.id.chronometer, "setStarted", true);
1533 } else {
1534 contentView.setViewVisibility(R.id.time, View.VISIBLE);
1535 contentView.setLong(R.id.time, "setTime", mWhen);
1536 }
Daniel Sandler0c890492012-09-12 17:23:10 -07001537 } else {
1538 contentView.setViewVisibility(R.id.time, View.GONE);
Joe Onorato561d3852010-11-20 18:09:34 -08001539 }
Daniel Sandler0c890492012-09-12 17:23:10 -07001540
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001541 contentView.setViewVisibility(R.id.line3, showLine3 ? View.VISIBLE : View.GONE);
Daniel Sandler6387d2f2012-05-22 13:44:09 -04001542 contentView.setViewVisibility(R.id.overflow_divider, showLine3 ? View.VISIBLE : View.GONE);
Joe Onorato561d3852010-11-20 18:09:34 -08001543 return contentView;
1544 }
1545
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001546 private RemoteViews applyStandardTemplateWithActions(int layoutId) {
Daniel Sandler6387d2f2012-05-22 13:44:09 -04001547 RemoteViews big = applyStandardTemplate(layoutId, false);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001548
1549 int N = mActions.size();
1550 if (N > 0) {
Chris Wrend6297db2012-05-03 16:20:13 -04001551 // Log.d("Notification", "has actions: " + mContentText);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001552 big.setViewVisibility(R.id.actions, View.VISIBLE);
Daniel Sandler6387d2f2012-05-22 13:44:09 -04001553 big.setViewVisibility(R.id.action_divider, View.VISIBLE);
Daniel Sandler8680bf82012-05-15 16:52:52 -04001554 if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
Chris Wren2c22eb02012-05-08 09:49:13 -04001555 big.removeAllViews(R.id.actions);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001556 for (int i=0; i<N; i++) {
1557 final RemoteViews button = generateActionButton(mActions.get(i));
Chris Wrend6297db2012-05-03 16:20:13 -04001558 //Log.d("Notification", "adding action " + i + ": " + mActions.get(i).title);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001559 big.addView(R.id.actions, button);
1560 }
1561 }
1562 return big;
1563 }
1564
Joe Onorato46439ce2010-11-19 13:56:21 -08001565 private RemoteViews makeContentView() {
1566 if (mContentView != null) {
1567 return mContentView;
1568 } else {
Daniel Sandler6387d2f2012-05-22 13:44:09 -04001569 return applyStandardTemplate(R.layout.notification_template_base, true); // no more special large_icon flavor
Joe Onorato46439ce2010-11-19 13:56:21 -08001570 }
1571 }
1572
1573 private RemoteViews makeTickerView() {
1574 if (mTickerView != null) {
1575 return mTickerView;
1576 } else {
Joe Onorato561d3852010-11-20 18:09:34 -08001577 if (mContentView == null) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001578 return applyStandardTemplate(mLargeIcon == null
Joe Onorato561d3852010-11-20 18:09:34 -08001579 ? R.layout.status_bar_latest_event_ticker
Daniel Sandler6387d2f2012-05-22 13:44:09 -04001580 : R.layout.status_bar_latest_event_ticker_large_icon, true);
Joe Onorato561d3852010-11-20 18:09:34 -08001581 } else {
1582 return null;
1583 }
Joe Onorato46439ce2010-11-19 13:56:21 -08001584 }
1585 }
1586
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001587 private RemoteViews makeBigContentView() {
1588 if (mActions.size() == 0) return null;
1589
Chris Wrenb023bf82012-04-23 16:05:42 -04001590 return applyStandardTemplateWithActions(R.layout.notification_template_big_base);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001591 }
1592
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001593 private RemoteViews generateActionButton(Action action) {
Daniel Sandler8680bf82012-05-15 16:52:52 -04001594 final boolean tombstone = (action.actionIntent == null);
Joe Malin8d40d042012-11-05 11:36:40 -08001595 RemoteViews button = new RemoteViews(mContext.getPackageName(),
Daniel Sandler8680bf82012-05-15 16:52:52 -04001596 tombstone ? R.layout.notification_action_tombstone
1597 : R.layout.notification_action);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001598 button.setTextViewCompoundDrawables(R.id.action0, action.icon, 0, 0, 0);
1599 button.setTextViewText(R.id.action0, action.title);
Daniel Sandler8680bf82012-05-15 16:52:52 -04001600 if (!tombstone) {
Daniel Sandlere5518842012-05-10 16:20:40 -04001601 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
Daniel Sandlere5518842012-05-10 16:20:40 -04001602 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001603 button.setContentDescription(R.id.action0, action.title);
1604 return button;
1605 }
1606
Joe Onoratocb109a02011-01-18 17:57:41 -08001607 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001608 * Apply the unstyled operations and return a new {@link Notification} object.
Joe Onoratocb109a02011-01-18 17:57:41 -08001609 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001610 private Notification buildUnstyled() {
Joe Onorato46439ce2010-11-19 13:56:21 -08001611 Notification n = new Notification();
1612 n.when = mWhen;
1613 n.icon = mSmallIcon;
1614 n.iconLevel = mSmallIconLevel;
Joe Onorato8595a3d2010-11-19 18:12:07 -08001615 n.number = mNumber;
Joe Onorato46439ce2010-11-19 13:56:21 -08001616 n.contentView = makeContentView();
1617 n.contentIntent = mContentIntent;
1618 n.deleteIntent = mDeleteIntent;
1619 n.fullScreenIntent = mFullScreenIntent;
1620 n.tickerText = mTickerText;
1621 n.tickerView = makeTickerView();
1622 n.largeIcon = mLargeIcon;
1623 n.sound = mSound;
1624 n.audioStreamType = mAudioStreamType;
1625 n.vibrate = mVibrate;
1626 n.ledARGB = mLedArgb;
1627 n.ledOnMS = mLedOnMs;
1628 n.ledOffMS = mLedOffMs;
1629 n.defaults = mDefaults;
1630 n.flags = mFlags;
Daniel Sandler96fd7c12012-03-30 16:37:36 -04001631 n.bigContentView = makeBigContentView();
Daniel Sandler26c13432013-04-04 11:01:04 -04001632 if (mLedOnMs != 0 || mLedOffMs != 0) {
Joe Onorato8d0b6552010-11-22 16:09:29 -08001633 n.flags |= FLAG_SHOW_LIGHTS;
1634 }
1635 if ((mDefaults & DEFAULT_LIGHTS) != 0) {
1636 n.flags |= FLAG_SHOW_LIGHTS;
1637 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001638 if (mKindList.size() > 0) {
1639 n.kind = new String[mKindList.size()];
1640 mKindList.toArray(n.kind);
1641 } else {
1642 n.kind = null;
1643 }
1644 n.priority = mPriority;
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001645 if (mActions.size() > 0) {
1646 n.actions = new Action[mActions.size()];
1647 mActions.toArray(n.actions);
1648 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001649
Joe Onorato46439ce2010-11-19 13:56:21 -08001650 return n;
1651 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001652
1653 /**
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001654 * Capture, in the provided bundle, semantic information used in the construction of
1655 * this Notification object.
1656 * @hide
1657 */
1658 public void addExtras(Bundle extras) {
1659 // Store original information used in the construction of this object
1660 extras.putCharSequence(EXTRA_TITLE, mContentTitle);
1661 extras.putCharSequence(EXTRA_TEXT, mContentText);
1662 extras.putCharSequence(EXTRA_SUB_TEXT, mSubText);
1663 extras.putCharSequence(EXTRA_INFO_TEXT, mContentInfo);
1664 extras.putInt(EXTRA_SMALL_ICON, mSmallIcon);
1665 extras.putInt(EXTRA_PROGRESS, mProgress);
1666 extras.putInt(EXTRA_PROGRESS_MAX, mProgressMax);
1667 extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, mProgressIndeterminate);
1668 extras.putBoolean(EXTRA_SHOW_CHRONOMETER, mUseChronometer);
1669 extras.putBoolean(EXTRA_SHOW_WHEN, mShowWhen);
1670 }
1671
1672 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001673 * @deprecated Use {@link #build()} instead.
1674 */
1675 @Deprecated
1676 public Notification getNotification() {
1677 return build();
1678 }
1679
1680 /**
1681 * Combine all of the options that have been set and return a new {@link Notification}
1682 * object.
1683 */
1684 public Notification build() {
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001685 final Notification n;
1686
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001687 if (mStyle != null) {
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001688 n = mStyle.build();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001689 } else {
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001690 n = buildUnstyled();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001691 }
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001692
1693 n.extras = mExtras != null ? new Bundle(mExtras) : new Bundle();
1694
1695 addExtras(n.extras);
1696 if (mStyle != null) {
1697 mStyle.addExtras(n.extras);
1698 }
1699
1700 return n;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001701 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001702
1703 /**
1704 * Apply this Builder to an existing {@link Notification} object.
1705 *
1706 * @hide
1707 */
1708 public Notification buildInto(Notification n) {
1709 build().cloneInto(n);
1710 return n;
1711 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001712 }
1713
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001714 /**
1715 * An object that can apply a rich notification style to a {@link Notification.Builder}
1716 * object.
1717 */
Chris Wrend6297db2012-05-03 16:20:13 -04001718 public static abstract class Style
1719 {
1720 private CharSequence mBigContentTitle;
1721 private CharSequence mSummaryText = null;
Daniel Sandler619738c2012-06-07 16:33:08 -04001722 private boolean mSummaryTextSet = false;
Chris Wrend6297db2012-05-03 16:20:13 -04001723
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001724 protected Builder mBuilder;
1725
Chris Wrend6297db2012-05-03 16:20:13 -04001726 /**
1727 * Overrides ContentTitle in the big form of the template.
1728 * This defaults to the value passed to setContentTitle().
1729 */
1730 protected void internalSetBigContentTitle(CharSequence title) {
1731 mBigContentTitle = title;
1732 }
1733
1734 /**
1735 * Set the first line of text after the detail section in the big form of the template.
1736 */
1737 protected void internalSetSummaryText(CharSequence cs) {
1738 mSummaryText = cs;
Daniel Sandler619738c2012-06-07 16:33:08 -04001739 mSummaryTextSet = true;
Chris Wrend6297db2012-05-03 16:20:13 -04001740 }
1741
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001742 public void setBuilder(Builder builder) {
1743 if (mBuilder != builder) {
1744 mBuilder = builder;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07001745 if (mBuilder != null) {
1746 mBuilder.setStyle(this);
1747 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001748 }
1749 }
1750
Chris Wrend6297db2012-05-03 16:20:13 -04001751 protected void checkBuilder() {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001752 if (mBuilder == null) {
1753 throw new IllegalArgumentException("Style requires a valid Builder object");
1754 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001755 }
Chris Wrend6297db2012-05-03 16:20:13 -04001756
1757 protected RemoteViews getStandardView(int layoutId) {
1758 checkBuilder();
1759
1760 if (mBigContentTitle != null) {
1761 mBuilder.setContentTitle(mBigContentTitle);
1762 }
1763
Chris Wrend6297db2012-05-03 16:20:13 -04001764 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId);
1765
Chris Wrend6297db2012-05-03 16:20:13 -04001766 if (mBigContentTitle != null && mBigContentTitle.equals("")) {
1767 contentView.setViewVisibility(R.id.line1, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04001768 } else {
1769 contentView.setViewVisibility(R.id.line1, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04001770 }
1771
Daniel Sandler619738c2012-06-07 16:33:08 -04001772 // The last line defaults to the subtext, but can be replaced by mSummaryText
1773 final CharSequence overflowText =
1774 mSummaryTextSet ? mSummaryText
1775 : mBuilder.mSubText;
1776 if (overflowText != null) {
1777 contentView.setTextViewText(R.id.text, overflowText);
1778 contentView.setViewVisibility(R.id.overflow_divider, View.VISIBLE);
Daniel Sandler9f7936a2012-05-21 16:14:28 -04001779 contentView.setViewVisibility(R.id.line3, View.VISIBLE);
Daniel Sandler916ad912012-06-13 12:17:07 -04001780 } else {
1781 contentView.setViewVisibility(R.id.overflow_divider, View.GONE);
1782 contentView.setViewVisibility(R.id.line3, View.GONE);
Chris Wrend6297db2012-05-03 16:20:13 -04001783 }
1784
1785 return contentView;
1786 }
1787
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001788 /**
1789 * @hide
1790 */
1791 public void addExtras(Bundle extras) {
1792 if (mSummaryTextSet) {
1793 extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
1794 }
1795 if (mBigContentTitle != null) {
1796 extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
1797 }
1798 }
1799
Chris Wrend6297db2012-05-03 16:20:13 -04001800 public abstract Notification build();
Joe Onorato46439ce2010-11-19 13:56:21 -08001801 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001802
1803 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001804 * Helper class for generating large-format notifications that include a large image attachment.
Joe Malin8d40d042012-11-05 11:36:40 -08001805 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001806 * This class is a "rebuilder": It consumes a Builder object and modifies its behavior, like so:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001807 * <pre class="prettyprint">
1808 * Notification noti = new Notification.BigPictureStyle(
1809 * new Notification.Builder()
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001810 * .setContentTitle(&quot;New photo from &quot; + sender.toString())
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001811 * .setContentText(subject)
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001812 * .setSmallIcon(R.drawable.new_post)
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001813 * .setLargeIcon(aBitmap))
1814 * .bigPicture(aBigBitmap)
1815 * .build();
1816 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08001817 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001818 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001819 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001820 public static class BigPictureStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001821 private Bitmap mPicture;
Chris Wren3745a3d2012-05-22 15:11:52 -04001822 private Bitmap mBigLargeIcon;
1823 private boolean mBigLargeIconSet = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001824
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001825 public BigPictureStyle() {
1826 }
1827
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001828 public BigPictureStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001829 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001830 }
1831
Chris Wrend6297db2012-05-03 16:20:13 -04001832 /**
1833 * Overrides ContentTitle in the big form of the template.
1834 * This defaults to the value passed to setContentTitle().
1835 */
1836 public BigPictureStyle setBigContentTitle(CharSequence title) {
1837 internalSetBigContentTitle(title);
1838 return this;
1839 }
1840
1841 /**
1842 * Set the first line of text after the detail section in the big form of the template.
1843 */
1844 public BigPictureStyle setSummaryText(CharSequence cs) {
1845 internalSetSummaryText(cs);
1846 return this;
1847 }
1848
Chris Wren0bd664d2012-08-01 13:56:56 -04001849 /**
1850 * Provide the bitmap to be used as the payload for the BigPicture notification.
1851 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001852 public BigPictureStyle bigPicture(Bitmap b) {
1853 mPicture = b;
1854 return this;
1855 }
1856
Chris Wren3745a3d2012-05-22 15:11:52 -04001857 /**
Chris Wren3745a3d2012-05-22 15:11:52 -04001858 * Override the large icon when the big notification is shown.
1859 */
1860 public BigPictureStyle bigLargeIcon(Bitmap b) {
1861 mBigLargeIconSet = true;
1862 mBigLargeIcon = b;
1863 return this;
1864 }
1865
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001866 private RemoteViews makeBigContentView() {
Chris Wrend6297db2012-05-03 16:20:13 -04001867 RemoteViews contentView = getStandardView(R.layout.notification_template_big_picture);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001868
1869 contentView.setImageViewBitmap(R.id.big_picture, mPicture);
1870
1871 return contentView;
1872 }
1873
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001874 /**
1875 * @hide
1876 */
1877 public void addExtras(Bundle extras) {
1878 super.addExtras(extras);
1879
1880 if (mBigLargeIconSet) {
1881 extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
1882 }
1883 extras.putParcelable(EXTRA_PICTURE, mPicture);
1884 }
1885
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001886 @Override
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001887 public Notification build() {
Chris Wrend6297db2012-05-03 16:20:13 -04001888 checkBuilder();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001889 Notification wip = mBuilder.buildUnstyled();
Chris Wren3745a3d2012-05-22 15:11:52 -04001890 if (mBigLargeIconSet ) {
1891 mBuilder.mLargeIcon = mBigLargeIcon;
1892 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001893 wip.bigContentView = makeBigContentView();
1894 return wip;
1895 }
1896 }
1897
1898 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001899 * Helper class for generating large-format notifications that include a lot of text.
Joe Malin8d40d042012-11-05 11:36:40 -08001900 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001901 * This class is a "rebuilder": It consumes a Builder object and modifies its behavior, like so:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001902 * <pre class="prettyprint">
Daniel Sandler87682782012-11-07 14:04:42 -05001903 * Notification noti = new Notification.BigTextStyle(
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001904 * new Notification.Builder()
1905 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
1906 * .setContentText(subject)
1907 * .setSmallIcon(R.drawable.new_mail)
1908 * .setLargeIcon(aBitmap))
1909 * .bigText(aVeryLongString)
1910 * .build();
1911 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08001912 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04001913 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001914 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001915 public static class BigTextStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001916 private CharSequence mBigText;
1917
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001918 public BigTextStyle() {
1919 }
1920
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001921 public BigTextStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001922 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001923 }
1924
Chris Wrend6297db2012-05-03 16:20:13 -04001925 /**
1926 * Overrides ContentTitle in the big form of the template.
1927 * This defaults to the value passed to setContentTitle().
1928 */
1929 public BigTextStyle setBigContentTitle(CharSequence title) {
1930 internalSetBigContentTitle(title);
1931 return this;
1932 }
1933
1934 /**
1935 * Set the first line of text after the detail section in the big form of the template.
1936 */
1937 public BigTextStyle setSummaryText(CharSequence cs) {
1938 internalSetSummaryText(cs);
1939 return this;
1940 }
1941
Chris Wren0bd664d2012-08-01 13:56:56 -04001942 /**
1943 * Provide the longer text to be displayed in the big form of the
1944 * template in place of the content text.
1945 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001946 public BigTextStyle bigText(CharSequence cs) {
1947 mBigText = cs;
1948 return this;
1949 }
1950
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001951 /**
1952 * @hide
1953 */
1954 public void addExtras(Bundle extras) {
1955 super.addExtras(extras);
1956
1957 extras.putCharSequence(EXTRA_TEXT, mBigText);
1958 }
1959
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001960 private RemoteViews makeBigContentView() {
Daniel Sandler619738c2012-06-07 16:33:08 -04001961 // Remove the content text so line3 only shows if you have a summary
1962 final boolean hadThreeLines = (mBuilder.mContentText != null && mBuilder.mSubText != null);
Daniel Sandler6387d2f2012-05-22 13:44:09 -04001963 mBuilder.mContentText = null;
Daniel Sandler916ad912012-06-13 12:17:07 -04001964
Chris Wrend6297db2012-05-03 16:20:13 -04001965 RemoteViews contentView = getStandardView(R.layout.notification_template_big_text);
Joe Malin8d40d042012-11-05 11:36:40 -08001966
Daniel Sandler619738c2012-06-07 16:33:08 -04001967 if (hadThreeLines) {
1968 // vertical centering
1969 contentView.setViewPadding(R.id.line1, 0, 0, 0, 0);
1970 }
1971
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001972 contentView.setTextViewText(R.id.big_text, mBigText);
1973 contentView.setViewVisibility(R.id.big_text, View.VISIBLE);
Chris Wren3c5f92432012-05-04 16:31:17 -04001974 contentView.setViewVisibility(R.id.text2, View.GONE);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001975
1976 return contentView;
1977 }
1978
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001979 @Override
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001980 public Notification build() {
Chris Wrend6297db2012-05-03 16:20:13 -04001981 checkBuilder();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001982 Notification wip = mBuilder.buildUnstyled();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001983 wip.bigContentView = makeBigContentView();
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001984
1985 wip.extras.putCharSequence(EXTRA_TEXT, mBigText);
1986
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001987 return wip;
1988 }
1989 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04001990
1991 /**
1992 * Helper class for generating large-format notifications that include a list of (up to 5) strings.
Joe Malin8d40d042012-11-05 11:36:40 -08001993 *
Daniel Sandler879c5e02012-04-17 16:46:51 -04001994 * This class is a "rebuilder": It consumes a Builder object and modifies its behavior, like so:
1995 * <pre class="prettyprint">
Chris Wrenfbd96ba2012-05-01 12:03:58 -04001996 * Notification noti = new Notification.InboxStyle(
Daniel Sandler879c5e02012-04-17 16:46:51 -04001997 * new Notification.Builder()
Chris Wrend6297db2012-05-03 16:20:13 -04001998 * .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
Daniel Sandler879c5e02012-04-17 16:46:51 -04001999 * .setContentText(subject)
2000 * .setSmallIcon(R.drawable.new_mail)
2001 * .setLargeIcon(aBitmap))
2002 * .addLine(str1)
2003 * .addLine(str2)
Chris Wrend6297db2012-05-03 16:20:13 -04002004 * .setContentTitle("")
2005 * .setSummaryText(&quot;+3 more&quot;)
Daniel Sandler879c5e02012-04-17 16:46:51 -04002006 * .build();
2007 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08002008 *
Daniel Sandler879c5e02012-04-17 16:46:51 -04002009 * @see Notification#bigContentView
2010 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002011 public static class InboxStyle extends Style {
Daniel Sandler879c5e02012-04-17 16:46:51 -04002012 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
2013
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002014 public InboxStyle() {
2015 }
2016
Daniel Sandler879c5e02012-04-17 16:46:51 -04002017 public InboxStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002018 setBuilder(builder);
Daniel Sandler879c5e02012-04-17 16:46:51 -04002019 }
2020
Chris Wrend6297db2012-05-03 16:20:13 -04002021 /**
2022 * Overrides ContentTitle in the big form of the template.
2023 * This defaults to the value passed to setContentTitle().
2024 */
2025 public InboxStyle setBigContentTitle(CharSequence title) {
2026 internalSetBigContentTitle(title);
2027 return this;
2028 }
2029
2030 /**
2031 * Set the first line of text after the detail section in the big form of the template.
2032 */
2033 public InboxStyle setSummaryText(CharSequence cs) {
2034 internalSetSummaryText(cs);
2035 return this;
2036 }
2037
Chris Wren0bd664d2012-08-01 13:56:56 -04002038 /**
2039 * Append a line to the digest section of the Inbox notification.
2040 */
Daniel Sandler879c5e02012-04-17 16:46:51 -04002041 public InboxStyle addLine(CharSequence cs) {
2042 mTexts.add(cs);
2043 return this;
2044 }
2045
Daniel Sandlerf45564e2013-04-15 15:05:08 -04002046 /**
2047 * @hide
2048 */
2049 public void addExtras(Bundle extras) {
2050 super.addExtras(extras);
2051 CharSequence[] a = new CharSequence[mTexts.size()];
2052 extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
2053 }
2054
Daniel Sandler879c5e02012-04-17 16:46:51 -04002055 private RemoteViews makeBigContentView() {
Daniel Sandler619738c2012-06-07 16:33:08 -04002056 // Remove the content text so line3 disappears unless you have a summary
2057 mBuilder.mContentText = null;
Chris Wrend6297db2012-05-03 16:20:13 -04002058 RemoteViews contentView = getStandardView(R.layout.notification_template_inbox);
Daniel Sandler619738c2012-06-07 16:33:08 -04002059
Chris Wrend6297db2012-05-03 16:20:13 -04002060 contentView.setViewVisibility(R.id.text2, View.GONE);
Daniel Sandler879c5e02012-04-17 16:46:51 -04002061
Chris Wrend6297db2012-05-03 16:20:13 -04002062 int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3,
Chris Wren29bb6d92012-05-17 18:09:42 -04002063 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
Chris Wrend6297db2012-05-03 16:20:13 -04002064
Chris Wren4ed80d52012-05-17 09:30:03 -04002065 // Make sure all rows are gone in case we reuse a view.
2066 for (int rowId : rowIds) {
2067 contentView.setViewVisibility(rowId, View.GONE);
2068 }
2069
Chris Wren683ab002012-09-20 10:35:54 -04002070
Daniel Sandler879c5e02012-04-17 16:46:51 -04002071 int i=0;
2072 while (i < mTexts.size() && i < rowIds.length) {
2073 CharSequence str = mTexts.get(i);
2074 if (str != null && !str.equals("")) {
2075 contentView.setViewVisibility(rowIds[i], View.VISIBLE);
2076 contentView.setTextViewText(rowIds[i], str);
2077 }
2078 i++;
2079 }
2080
Chris Wren683ab002012-09-20 10:35:54 -04002081 contentView.setViewVisibility(R.id.inbox_end_pad,
2082 mTexts.size() > 0 ? View.VISIBLE : View.GONE);
2083
2084 contentView.setViewVisibility(R.id.inbox_more,
2085 mTexts.size() > rowIds.length ? View.VISIBLE : View.GONE);
Chris Wren29bb6d92012-05-17 18:09:42 -04002086
Daniel Sandler879c5e02012-04-17 16:46:51 -04002087 return contentView;
2088 }
2089
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002090 @Override
Daniel Sandler879c5e02012-04-17 16:46:51 -04002091 public Notification build() {
Chris Wrend6297db2012-05-03 16:20:13 -04002092 checkBuilder();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002093 Notification wip = mBuilder.buildUnstyled();
Daniel Sandler879c5e02012-04-17 16:46:51 -04002094 wip.bigContentView = makeBigContentView();
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002095
Daniel Sandler879c5e02012-04-17 16:46:51 -04002096 return wip;
2097 }
2098 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002099}