Notification.java revision 0bf2ed8ae394b327af1bc6e853a698c2dac67aaa
1/* 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 19import com.android.internal.R; 20 21import android.annotation.IntDef; 22import android.content.Context; 23import android.content.Intent; 24import android.content.res.Resources; 25import android.graphics.Bitmap; 26import android.media.AudioManager; 27import android.net.Uri; 28import android.os.BadParcelableException; 29import android.os.Bundle; 30import android.os.Parcel; 31import android.os.Parcelable; 32import android.os.SystemClock; 33import android.os.UserHandle; 34import android.text.TextUtils; 35import android.util.Log; 36import android.util.TypedValue; 37import android.view.View; 38import android.widget.ProgressBar; 39import android.widget.RemoteViews; 40 41import java.lang.annotation.Retention; 42import java.lang.annotation.RetentionPolicy; 43import java.text.NumberFormat; 44import java.util.ArrayList; 45 46/** 47 * A class that represents how a persistent notification is to be presented to 48 * the user using the {@link android.app.NotificationManager}. 49 * 50 * <p>The {@link Notification.Builder Notification.Builder} has been added to make it 51 * easier to construct Notifications.</p> 52 * 53 * <div class="special reference"> 54 * <h3>Developer Guides</h3> 55 * <p>For a guide to creating notifications, read the 56 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Status Bar Notifications</a> 57 * developer guide.</p> 58 * </div> 59 */ 60public class Notification implements Parcelable 61{ 62 private static final String TAG = "Notification"; 63 64 /** 65 * Use all default values (where applicable). 66 */ 67 public static final int DEFAULT_ALL = ~0; 68 69 /** 70 * Use the default notification sound. This will ignore any given 71 * {@link #sound}. 72 * 73 74 * @see #defaults 75 */ 76 77 public static final int DEFAULT_SOUND = 1; 78 79 /** 80 * Use the default notification vibrate. This will ignore any given 81 * {@link #vibrate}. Using phone vibration requires the 82 * {@link android.Manifest.permission#VIBRATE VIBRATE} permission. 83 * 84 * @see #defaults 85 */ 86 87 public static final int DEFAULT_VIBRATE = 2; 88 89 /** 90 * Use the default notification lights. This will ignore the 91 * {@link #FLAG_SHOW_LIGHTS} bit, and {@link #ledARGB}, {@link #ledOffMS}, or 92 * {@link #ledOnMS}. 93 * 94 * @see #defaults 95 */ 96 97 public static final int DEFAULT_LIGHTS = 4; 98 99 /** 100 * A timestamp related to this notification, in milliseconds since the epoch. 101 * 102 * Default value: {@link System#currentTimeMillis() Now}. 103 * 104 * Choose a timestamp that will be most relevant to the user. For most finite events, this 105 * corresponds to the time the event happened (or will happen, in the case of events that have 106 * yet to occur but about which the user is being informed). Indefinite events should be 107 * timestamped according to when the activity began. 108 * 109 * Some examples: 110 * 111 * <ul> 112 * <li>Notification of a new chat message should be stamped when the message was received.</li> 113 * <li>Notification of an ongoing file download (with a progress bar, for example) should be stamped when the download started.</li> 114 * <li>Notification of a completed file download should be stamped when the download finished.</li> 115 * <li>Notification of an upcoming meeting should be stamped with the time the meeting will begin (that is, in the future).</li> 116 * <li>Notification of an ongoing stopwatch (increasing timer) should be stamped with the watch's start time. 117 * <li>Notification of an ongoing countdown timer should be stamped with the timer's end time. 118 * </ul> 119 * 120 */ 121 public long when; 122 123 /** 124 * The resource id of a drawable to use as the icon in the status bar. 125 * This is required; notifications with an invalid icon resource will not be shown. 126 */ 127 public int icon; 128 129 /** 130 * If the icon in the status bar is to have more than one level, you can set this. Otherwise, 131 * leave it at its default value of 0. 132 * 133 * @see android.widget.ImageView#setImageLevel 134 * @see android.graphics.drawable#setLevel 135 */ 136 public int iconLevel; 137 138 /** 139 * The number of events that this notification represents. For example, in a new mail 140 * notification, this could be the number of unread messages. 141 * 142 * The system may or may not use this field to modify the appearance of the notification. For 143 * example, before {@link android.os.Build.VERSION_CODES#HONEYCOMB}, this number was 144 * superimposed over the icon in the status bar. Starting with 145 * {@link android.os.Build.VERSION_CODES#HONEYCOMB}, the template used by 146 * {@link Notification.Builder} has displayed the number in the expanded notification view. 147 * 148 * If the number is 0 or negative, it is never shown. 149 */ 150 public int number; 151 152 /** 153 * The intent to execute when the expanded status entry is clicked. If 154 * this is an activity, it must include the 155 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires 156 * that you take care of task management as described in the 157 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back 158 * Stack</a> document. In particular, make sure to read the notification section 159 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html#HandlingNotifications">Handling 160 * Notifications</a> for the correct ways to launch an application from a 161 * notification. 162 */ 163 public PendingIntent contentIntent; 164 165 /** 166 * The intent to execute when the notification is explicitly dismissed by the user, either with 167 * the "Clear All" button or by swiping it away individually. 168 * 169 * This probably shouldn't be launching an activity since several of those will be sent 170 * at the same time. 171 */ 172 public PendingIntent deleteIntent; 173 174 /** 175 * An intent to launch instead of posting the notification to the status bar. 176 * 177 * @see Notification.Builder#setFullScreenIntent 178 */ 179 public PendingIntent fullScreenIntent; 180 181 /** 182 * Text to scroll across the screen when this item is added to 183 * the status bar on large and smaller devices. 184 * 185 * @see #tickerView 186 */ 187 public CharSequence tickerText; 188 189 /** 190 * The view to show as the ticker in the status bar when the notification 191 * is posted. 192 */ 193 public RemoteViews tickerView; 194 195 /** 196 * The view that will represent this notification in the expanded status bar. 197 */ 198 public RemoteViews contentView; 199 200 /** 201 * A large-format version of {@link #contentView}, giving the Notification an 202 * opportunity to show more detail. The system UI may choose to show this 203 * instead of the normal content view at its discretion. 204 */ 205 public RemoteViews bigContentView; 206 207 /** 208 * The bitmap that may escape the bounds of the panel and bar. 209 */ 210 public Bitmap largeIcon; 211 212 /** 213 * The sound to play. 214 * 215 * <p> 216 * To play the default notification sound, see {@link #defaults}. 217 * </p> 218 */ 219 public Uri sound; 220 221 /** 222 * Use this constant as the value for audioStreamType to request that 223 * the default stream type for notifications be used. Currently the 224 * default stream type is {@link AudioManager#STREAM_NOTIFICATION}. 225 */ 226 public static final int STREAM_DEFAULT = -1; 227 228 /** 229 * The audio stream type to use when playing the sound. 230 * Should be one of the STREAM_ constants from 231 * {@link android.media.AudioManager}. 232 */ 233 public int audioStreamType = STREAM_DEFAULT; 234 235 /** 236 * The pattern with which to vibrate. 237 * 238 * <p> 239 * To vibrate the default pattern, see {@link #defaults}. 240 * </p> 241 * 242 * @see android.os.Vibrator#vibrate(long[],int) 243 */ 244 public long[] vibrate; 245 246 /** 247 * The color of the led. The hardware will do its best approximation. 248 * 249 * @see #FLAG_SHOW_LIGHTS 250 * @see #flags 251 */ 252 public int ledARGB; 253 254 /** 255 * The number of milliseconds for the LED to be on while it's flashing. 256 * The hardware will do its best approximation. 257 * 258 * @see #FLAG_SHOW_LIGHTS 259 * @see #flags 260 */ 261 public int ledOnMS; 262 263 /** 264 * The number of milliseconds for the LED to be off while it's flashing. 265 * The hardware will do its best approximation. 266 * 267 * @see #FLAG_SHOW_LIGHTS 268 * @see #flags 269 */ 270 public int ledOffMS; 271 272 /** 273 * Specifies which values should be taken from the defaults. 274 * <p> 275 * To set, OR the desired from {@link #DEFAULT_SOUND}, 276 * {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}. For all default 277 * values, use {@link #DEFAULT_ALL}. 278 * </p> 279 */ 280 public int defaults; 281 282 /** 283 * Bit to be bitwise-ored into the {@link #flags} field that should be 284 * set if you want the LED on for this notification. 285 * <ul> 286 * <li>To turn the LED off, pass 0 in the alpha channel for colorARGB 287 * or 0 for both ledOnMS and ledOffMS.</li> 288 * <li>To turn the LED on, pass 1 for ledOnMS and 0 for ledOffMS.</li> 289 * <li>To flash the LED, pass the number of milliseconds that it should 290 * be on and off to ledOnMS and ledOffMS.</li> 291 * </ul> 292 * <p> 293 * Since hardware varies, you are not guaranteed that any of the values 294 * you pass are honored exactly. Use the system defaults (TODO) if possible 295 * because they will be set to values that work on any given hardware. 296 * <p> 297 * The alpha channel must be set for forward compatibility. 298 * 299 */ 300 public static final int FLAG_SHOW_LIGHTS = 0x00000001; 301 302 /** 303 * Bit to be bitwise-ored into the {@link #flags} field that should be 304 * set if this notification is in reference to something that is ongoing, 305 * like a phone call. It should not be set if this notification is in 306 * reference to something that happened at a particular point in time, 307 * like a missed phone call. 308 */ 309 public static final int FLAG_ONGOING_EVENT = 0x00000002; 310 311 /** 312 * Bit to be bitwise-ored into the {@link #flags} field that if set, 313 * the audio will be repeated until the notification is 314 * cancelled or the notification window is opened. 315 */ 316 public static final int FLAG_INSISTENT = 0x00000004; 317 318 /** 319 * Bit to be bitwise-ored into the {@link #flags} field that should be 320 * set if you want the sound and/or vibration play each time the 321 * notification is sent, even if it has not been canceled before that. 322 */ 323 public static final int FLAG_ONLY_ALERT_ONCE = 0x00000008; 324 325 /** 326 * Bit to be bitwise-ored into the {@link #flags} field that should be 327 * set if the notification should be canceled when it is clicked by the 328 * user. 329 330 */ 331 public static final int FLAG_AUTO_CANCEL = 0x00000010; 332 333 /** 334 * Bit to be bitwise-ored into the {@link #flags} field that should be 335 * set if the notification should not be canceled when the user clicks 336 * the Clear all button. 337 */ 338 public static final int FLAG_NO_CLEAR = 0x00000020; 339 340 /** 341 * Bit to be bitwise-ored into the {@link #flags} field that should be 342 * set if this notification represents a currently running service. This 343 * will normally be set for you by {@link Service#startForeground}. 344 */ 345 public static final int FLAG_FOREGROUND_SERVICE = 0x00000040; 346 347 /** 348 * Obsolete flag indicating high-priority notifications; use the priority field instead. 349 * 350 * @deprecated Use {@link #priority} with a positive value. 351 */ 352 public static final int FLAG_HIGH_PRIORITY = 0x00000080; 353 354 public int flags; 355 356 /** @hide */ 357 @IntDef({PRIORITY_DEFAULT,PRIORITY_LOW,PRIORITY_MIN,PRIORITY_HIGH,PRIORITY_MAX}) 358 @Retention(RetentionPolicy.SOURCE) 359 public @interface Priority {} 360 361 /** 362 * Default notification {@link #priority}. If your application does not prioritize its own 363 * notifications, use this value for all notifications. 364 */ 365 public static final int PRIORITY_DEFAULT = 0; 366 367 /** 368 * Lower {@link #priority}, for items that are less important. The UI may choose to show these 369 * items smaller, or at a different position in the list, compared with your app's 370 * {@link #PRIORITY_DEFAULT} items. 371 */ 372 public static final int PRIORITY_LOW = -1; 373 374 /** 375 * Lowest {@link #priority}; these items might not be shown to the user except under special 376 * circumstances, such as detailed notification logs. 377 */ 378 public static final int PRIORITY_MIN = -2; 379 380 /** 381 * Higher {@link #priority}, for more important notifications or alerts. The UI may choose to 382 * show these items larger, or at a different position in notification lists, compared with 383 * your app's {@link #PRIORITY_DEFAULT} items. 384 */ 385 public static final int PRIORITY_HIGH = 1; 386 387 /** 388 * Highest {@link #priority}, for your application's most important items that require the 389 * user's prompt attention or input. 390 */ 391 public static final int PRIORITY_MAX = 2; 392 393 /** 394 * Relative priority for this notification. 395 * 396 * Priority is an indication of how much of the user's valuable attention should be consumed by 397 * this notification. Low-priority notifications may be hidden from the user in certain 398 * situations, while the user might be interrupted for a higher-priority notification. The 399 * system will make a determination about how to interpret this priority when presenting 400 * the notification. 401 */ 402 @Priority 403 public int priority; 404 405 406 /** 407 * Sphere of visibility of this notification, which affects how and when the SystemUI reveals 408 * the notification's presence and contents in untrusted situations (namely, on the secure 409 * lockscreen). 410 * 411 * The default level, {@link #VISIBILITY_PRIVATE}, behaves exactly as notifications have always 412 * done on Android: The notification's {@link #icon} and {@link #tickerText} (if available) are 413 * shown in all situations, but the contents are only available if the device is unlocked for 414 * the appropriate user. 415 * 416 * A more permissive policy can be expressed by {@link #VISIBILITY_PUBLIC}; such a notification 417 * can be read even in an "insecure" context (that is, above a secure lockscreen). 418 * To modify the public version of this notification—for example, to redact some portions—see 419 * {@link Builder#setPublicVersion(Notification)}. 420 * 421 * Finally, a notification can be made {@link #VISIBILITY_SECRET}, which will suppress its icon 422 * and ticker until the user has bypassed the lockscreen. 423 */ 424 public int visibility; 425 426 public static final int VISIBILITY_PUBLIC = 1; 427 public static final int VISIBILITY_PRIVATE = 0; 428 public static final int VISIBILITY_SECRET = -1; 429 430 /** 431 * @hide 432 * Notification type: incoming call (voice or video) or similar synchronous communication request. 433 */ 434 public static final String KIND_CALL = "android.call"; 435 436 /** 437 * @hide 438 * Notification type: incoming direct message (SMS, instant message, etc.). 439 */ 440 public static final String KIND_MESSAGE = "android.message"; 441 442 /** 443 * @hide 444 * Notification type: asynchronous bulk message (email). 445 */ 446 public static final String KIND_EMAIL = "android.email"; 447 448 /** 449 * @hide 450 * Notification type: calendar event. 451 */ 452 public static final String KIND_EVENT = "android.event"; 453 454 /** 455 * @hide 456 * Notification type: promotion or advertisement. 457 */ 458 public static final String KIND_PROMO = "android.promo"; 459 460 /** 461 * @hide 462 * If this notification matches of one or more special types (see the <code>KIND_*</code> 463 * constants), add them here, best match first. 464 */ 465 public String[] kind; 466 467 /** 468 * Additional semantic data to be carried around with this Notification. 469 * <p> 470 * The extras keys defined here are intended to capture the original inputs to {@link Builder} 471 * APIs, and are intended to be used by 472 * {@link android.service.notification.NotificationListenerService} implementations to extract 473 * detailed information from notification objects. 474 */ 475 public Bundle extras = new Bundle(); 476 477 /** 478 * {@link #extras} key: this is the title of the notification, 479 * as supplied to {@link Builder#setContentTitle(CharSequence)}. 480 */ 481 public static final String EXTRA_TITLE = "android.title"; 482 483 /** 484 * {@link #extras} key: this is the title of the notification when shown in expanded form, 485 * e.g. as supplied to {@link BigTextStyle#setBigContentTitle(CharSequence)}. 486 */ 487 public static final String EXTRA_TITLE_BIG = EXTRA_TITLE + ".big"; 488 489 /** 490 * {@link #extras} key: this is the main text payload, as supplied to 491 * {@link Builder#setContentText(CharSequence)}. 492 */ 493 public static final String EXTRA_TEXT = "android.text"; 494 495 /** 496 * {@link #extras} key: this is a third line of text, as supplied to 497 * {@link Builder#setSubText(CharSequence)}. 498 */ 499 public static final String EXTRA_SUB_TEXT = "android.subText"; 500 501 /** 502 * {@link #extras} key: this is a small piece of additional text as supplied to 503 * {@link Builder#setContentInfo(CharSequence)}. 504 */ 505 public static final String EXTRA_INFO_TEXT = "android.infoText"; 506 507 /** 508 * {@link #extras} key: this is a line of summary information intended to be shown 509 * alongside expanded notifications, as supplied to (e.g.) 510 * {@link BigTextStyle#setSummaryText(CharSequence)}. 511 */ 512 public static final String EXTRA_SUMMARY_TEXT = "android.summaryText"; 513 514 /** 515 * {@link #extras} key: this is the resource ID of the notification's main small icon, as 516 * supplied to {@link Builder#setSmallIcon(int)}. 517 */ 518 public static final String EXTRA_SMALL_ICON = "android.icon"; 519 520 /** 521 * {@link #extras} key: this is a bitmap to be used instead of the small icon when showing the 522 * notification payload, as 523 * supplied to {@link Builder#setLargeIcon(android.graphics.Bitmap)}. 524 */ 525 public static final String EXTRA_LARGE_ICON = "android.largeIcon"; 526 527 /** 528 * {@link #extras} key: this is a bitmap to be used instead of the one from 529 * {@link Builder#setLargeIcon(android.graphics.Bitmap)} when the notification is 530 * shown in its expanded form, as supplied to 531 * {@link BigPictureStyle#bigLargeIcon(android.graphics.Bitmap)}. 532 */ 533 public static final String EXTRA_LARGE_ICON_BIG = EXTRA_LARGE_ICON + ".big"; 534 535 /** 536 * {@link #extras} key: this is the progress value supplied to 537 * {@link Builder#setProgress(int, int, boolean)}. 538 */ 539 public static final String EXTRA_PROGRESS = "android.progress"; 540 541 /** 542 * {@link #extras} key: this is the maximum value supplied to 543 * {@link Builder#setProgress(int, int, boolean)}. 544 */ 545 public static final String EXTRA_PROGRESS_MAX = "android.progressMax"; 546 547 /** 548 * {@link #extras} key: whether the progress bar is indeterminate, supplied to 549 * {@link Builder#setProgress(int, int, boolean)}. 550 */ 551 public static final String EXTRA_PROGRESS_INDETERMINATE = "android.progressIndeterminate"; 552 553 /** 554 * {@link #extras} key: whether {@link #when} should be shown as a count-up timer (specifically 555 * a {@link android.widget.Chronometer}) instead of a timestamp, as supplied to 556 * {@link Builder#setUsesChronometer(boolean)}. 557 */ 558 public static final String EXTRA_SHOW_CHRONOMETER = "android.showChronometer"; 559 560 /** 561 * {@link #extras} key: whether {@link #when} should be shown, 562 * as supplied to {@link Builder#setShowWhen(boolean)}. 563 */ 564 public static final String EXTRA_SHOW_WHEN = "android.showWhen"; 565 566 /** 567 * {@link #extras} key: this is a bitmap to be shown in {@link BigPictureStyle} expanded 568 * notifications, supplied to {@link BigPictureStyle#bigPicture(android.graphics.Bitmap)}. 569 */ 570 public static final String EXTRA_PICTURE = "android.picture"; 571 572 /** 573 * {@link #extras} key: An array of CharSequences to show in {@link InboxStyle} expanded 574 * notifications, each of which was supplied to {@link InboxStyle#addLine(CharSequence)}. 575 */ 576 public static final String EXTRA_TEXT_LINES = "android.textLines"; 577 578 /** 579 * {@link #extras} key: An array of people that this notification relates to, specified 580 * by contacts provider contact URI. 581 */ 582 public static final String EXTRA_PEOPLE = "android.people"; 583 584 /** 585 * @hide 586 * Extra added by NotificationManagerService to indicate whether a NotificationScorer 587 * modified the Notifications's score. 588 */ 589 public static final String EXTRA_SCORE_MODIFIED = "android.scoreModified"; 590 591 /** 592 * Not used. 593 * @hide 594 */ 595 public static final String EXTRA_AS_HEADS_UP = "headsup"; 596 597 /** 598 * Value for {@link #EXTRA_AS_HEADS_UP}. 599 * @hide 600 */ 601 public static final int HEADS_UP_NEVER = 0; 602 603 /** 604 * Default value for {@link #EXTRA_AS_HEADS_UP}. 605 * @hide 606 */ 607 public static final int HEADS_UP_ALLOWED = 1; 608 609 /** 610 * Value for {@link #EXTRA_AS_HEADS_UP}. 611 * @hide 612 */ 613 public static final int HEADS_UP_REQUESTED = 2; 614 615 /** 616 * Structure to encapsulate a named action that can be shown as part of this notification. 617 * It must include an icon, a label, and a {@link PendingIntent} to be fired when the action is 618 * selected by the user. 619 * <p> 620 * Apps should use {@link Builder#addAction(int, CharSequence, PendingIntent)} to create and 621 * attach actions. 622 */ 623 public static class Action implements Parcelable { 624 /** 625 * Small icon representing the action. 626 */ 627 public int icon; 628 /** 629 * Title of the action. 630 */ 631 public CharSequence title; 632 /** 633 * Intent to send when the user invokes this action. May be null, in which case the action 634 * may be rendered in a disabled presentation by the system UI. 635 */ 636 public PendingIntent actionIntent; 637 638 private Action() { } 639 private Action(Parcel in) { 640 icon = in.readInt(); 641 title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in); 642 if (in.readInt() == 1) { 643 actionIntent = PendingIntent.CREATOR.createFromParcel(in); 644 } 645 } 646 /** 647 * Use {@link Builder#addAction(int, CharSequence, PendingIntent)}. 648 */ 649 public Action(int icon, CharSequence title, PendingIntent intent) { 650 this.icon = icon; 651 this.title = title; 652 this.actionIntent = intent; 653 } 654 655 @Override 656 public Action clone() { 657 return new Action( 658 this.icon, 659 this.title, 660 this.actionIntent // safe to alias 661 ); 662 } 663 @Override 664 public int describeContents() { 665 return 0; 666 } 667 @Override 668 public void writeToParcel(Parcel out, int flags) { 669 out.writeInt(icon); 670 TextUtils.writeToParcel(title, out, flags); 671 if (actionIntent != null) { 672 out.writeInt(1); 673 actionIntent.writeToParcel(out, flags); 674 } else { 675 out.writeInt(0); 676 } 677 } 678 public static final Parcelable.Creator<Action> CREATOR 679 = new Parcelable.Creator<Action>() { 680 public Action createFromParcel(Parcel in) { 681 return new Action(in); 682 } 683 public Action[] newArray(int size) { 684 return new Action[size]; 685 } 686 }; 687 } 688 689 /** 690 * Array of all {@link Action} structures attached to this notification by 691 * {@link Builder#addAction(int, CharSequence, PendingIntent)}. Mostly useful for instances of 692 * {@link android.service.notification.NotificationListenerService} that provide an alternative 693 * interface for invoking actions. 694 */ 695 public Action[] actions; 696 697 /** 698 * Replacement version of this notification whose content will be shown 699 * in an insecure context such as atop a secure keyguard. See {@link #visibility} 700 * and {@link #VISIBILITY_PUBLIC}. 701 */ 702 public Notification publicVersion; 703 704 /** 705 * Constructs a Notification object with default values. 706 * You might want to consider using {@link Builder} instead. 707 */ 708 public Notification() 709 { 710 this.when = System.currentTimeMillis(); 711 this.priority = PRIORITY_DEFAULT; 712 } 713 714 /** 715 * @hide 716 */ 717 public Notification(Context context, int icon, CharSequence tickerText, long when, 718 CharSequence contentTitle, CharSequence contentText, Intent contentIntent) 719 { 720 this.when = when; 721 this.icon = icon; 722 this.tickerText = tickerText; 723 setLatestEventInfo(context, contentTitle, contentText, 724 PendingIntent.getActivity(context, 0, contentIntent, 0)); 725 } 726 727 /** 728 * Constructs a Notification object with the information needed to 729 * have a status bar icon without the standard expanded view. 730 * 731 * @param icon The resource id of the icon to put in the status bar. 732 * @param tickerText The text that flows by in the status bar when the notification first 733 * activates. 734 * @param when The time to show in the time field. In the System.currentTimeMillis 735 * timebase. 736 * 737 * @deprecated Use {@link Builder} instead. 738 */ 739 @Deprecated 740 public Notification(int icon, CharSequence tickerText, long when) 741 { 742 this.icon = icon; 743 this.tickerText = tickerText; 744 this.when = when; 745 } 746 747 /** 748 * Unflatten the notification from a parcel. 749 */ 750 public Notification(Parcel parcel) 751 { 752 int version = parcel.readInt(); 753 754 when = parcel.readLong(); 755 icon = parcel.readInt(); 756 number = parcel.readInt(); 757 if (parcel.readInt() != 0) { 758 contentIntent = PendingIntent.CREATOR.createFromParcel(parcel); 759 } 760 if (parcel.readInt() != 0) { 761 deleteIntent = PendingIntent.CREATOR.createFromParcel(parcel); 762 } 763 if (parcel.readInt() != 0) { 764 tickerText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel); 765 } 766 if (parcel.readInt() != 0) { 767 tickerView = RemoteViews.CREATOR.createFromParcel(parcel); 768 } 769 if (parcel.readInt() != 0) { 770 contentView = RemoteViews.CREATOR.createFromParcel(parcel); 771 } 772 if (parcel.readInt() != 0) { 773 largeIcon = Bitmap.CREATOR.createFromParcel(parcel); 774 } 775 defaults = parcel.readInt(); 776 flags = parcel.readInt(); 777 if (parcel.readInt() != 0) { 778 sound = Uri.CREATOR.createFromParcel(parcel); 779 } 780 781 audioStreamType = parcel.readInt(); 782 vibrate = parcel.createLongArray(); 783 ledARGB = parcel.readInt(); 784 ledOnMS = parcel.readInt(); 785 ledOffMS = parcel.readInt(); 786 iconLevel = parcel.readInt(); 787 788 if (parcel.readInt() != 0) { 789 fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel); 790 } 791 792 priority = parcel.readInt(); 793 794 kind = parcel.createStringArray(); // may set kind to null 795 796 extras = parcel.readBundle(); // may be null 797 798 actions = parcel.createTypedArray(Action.CREATOR); // may be null 799 800 if (parcel.readInt() != 0) { 801 bigContentView = RemoteViews.CREATOR.createFromParcel(parcel); 802 } 803 804 visibility = parcel.readInt(); 805 806 if (parcel.readInt() != 0) { 807 publicVersion = Notification.CREATOR.createFromParcel(parcel); 808 } 809 } 810 811 @Override 812 public Notification clone() { 813 Notification that = new Notification(); 814 cloneInto(that, true); 815 return that; 816 } 817 818 /** 819 * Copy all (or if heavy is false, all except Bitmaps and RemoteViews) members 820 * of this into that. 821 * @hide 822 */ 823 public void cloneInto(Notification that, boolean heavy) { 824 that.when = this.when; 825 that.icon = this.icon; 826 that.number = this.number; 827 828 // PendingIntents are global, so there's no reason (or way) to clone them. 829 that.contentIntent = this.contentIntent; 830 that.deleteIntent = this.deleteIntent; 831 that.fullScreenIntent = this.fullScreenIntent; 832 833 if (this.tickerText != null) { 834 that.tickerText = this.tickerText.toString(); 835 } 836 if (heavy && this.tickerView != null) { 837 that.tickerView = this.tickerView.clone(); 838 } 839 if (heavy && this.contentView != null) { 840 that.contentView = this.contentView.clone(); 841 } 842 if (heavy && this.largeIcon != null) { 843 that.largeIcon = Bitmap.createBitmap(this.largeIcon); 844 } 845 that.iconLevel = this.iconLevel; 846 that.sound = this.sound; // android.net.Uri is immutable 847 that.audioStreamType = this.audioStreamType; 848 849 final long[] vibrate = this.vibrate; 850 if (vibrate != null) { 851 final int N = vibrate.length; 852 final long[] vib = that.vibrate = new long[N]; 853 System.arraycopy(vibrate, 0, vib, 0, N); 854 } 855 856 that.ledARGB = this.ledARGB; 857 that.ledOnMS = this.ledOnMS; 858 that.ledOffMS = this.ledOffMS; 859 that.defaults = this.defaults; 860 861 that.flags = this.flags; 862 863 that.priority = this.priority; 864 865 final String[] thiskind = this.kind; 866 if (thiskind != null) { 867 final int N = thiskind.length; 868 final String[] thatkind = that.kind = new String[N]; 869 System.arraycopy(thiskind, 0, thatkind, 0, N); 870 } 871 872 if (this.extras != null) { 873 try { 874 that.extras = new Bundle(this.extras); 875 // will unparcel 876 that.extras.size(); 877 } catch (BadParcelableException e) { 878 Log.e(TAG, "could not unparcel extras from notification: " + this, e); 879 that.extras = null; 880 } 881 } 882 883 if (this.actions != null) { 884 that.actions = new Action[this.actions.length]; 885 for(int i=0; i<this.actions.length; i++) { 886 that.actions[i] = this.actions[i].clone(); 887 } 888 } 889 890 if (heavy && this.bigContentView != null) { 891 that.bigContentView = this.bigContentView.clone(); 892 } 893 894 that.visibility = this.visibility; 895 896 if (this.publicVersion != null) { 897 that.publicVersion = new Notification(); 898 this.publicVersion.cloneInto(that.publicVersion, heavy); 899 } 900 901 if (!heavy) { 902 that.lightenPayload(); // will clean out extras 903 } 904 } 905 906 /** 907 * Removes heavyweight parts of the Notification object for archival or for sending to 908 * listeners when the full contents are not necessary. 909 * @hide 910 */ 911 public final void lightenPayload() { 912 tickerView = null; 913 contentView = null; 914 bigContentView = null; 915 largeIcon = null; 916 if (extras != null) { 917 extras.remove(Notification.EXTRA_LARGE_ICON); 918 extras.remove(Notification.EXTRA_LARGE_ICON_BIG); 919 extras.remove(Notification.EXTRA_PICTURE); 920 } 921 } 922 923 /** 924 * Make sure this CharSequence is safe to put into a bundle, which basically 925 * means it had better not be some custom Parcelable implementation. 926 * @hide 927 */ 928 public static CharSequence safeCharSequence(CharSequence cs) { 929 if (cs instanceof Parcelable) { 930 Log.e(TAG, "warning: " + cs.getClass().getCanonicalName() 931 + " instance is a custom Parcelable and not allowed in Notification"); 932 return cs.toString(); 933 } 934 935 return cs; 936 } 937 938 public int describeContents() { 939 return 0; 940 } 941 942 /** 943 * Flatten this notification from a parcel. 944 */ 945 public void writeToParcel(Parcel parcel, int flags) 946 { 947 parcel.writeInt(1); 948 949 parcel.writeLong(when); 950 parcel.writeInt(icon); 951 parcel.writeInt(number); 952 if (contentIntent != null) { 953 parcel.writeInt(1); 954 contentIntent.writeToParcel(parcel, 0); 955 } else { 956 parcel.writeInt(0); 957 } 958 if (deleteIntent != null) { 959 parcel.writeInt(1); 960 deleteIntent.writeToParcel(parcel, 0); 961 } else { 962 parcel.writeInt(0); 963 } 964 if (tickerText != null) { 965 parcel.writeInt(1); 966 TextUtils.writeToParcel(tickerText, parcel, flags); 967 } else { 968 parcel.writeInt(0); 969 } 970 if (tickerView != null) { 971 parcel.writeInt(1); 972 tickerView.writeToParcel(parcel, 0); 973 } else { 974 parcel.writeInt(0); 975 } 976 if (contentView != null) { 977 parcel.writeInt(1); 978 contentView.writeToParcel(parcel, 0); 979 } else { 980 parcel.writeInt(0); 981 } 982 if (largeIcon != null) { 983 parcel.writeInt(1); 984 largeIcon.writeToParcel(parcel, 0); 985 } else { 986 parcel.writeInt(0); 987 } 988 989 parcel.writeInt(defaults); 990 parcel.writeInt(this.flags); 991 992 if (sound != null) { 993 parcel.writeInt(1); 994 sound.writeToParcel(parcel, 0); 995 } else { 996 parcel.writeInt(0); 997 } 998 parcel.writeInt(audioStreamType); 999 parcel.writeLongArray(vibrate); 1000 parcel.writeInt(ledARGB); 1001 parcel.writeInt(ledOnMS); 1002 parcel.writeInt(ledOffMS); 1003 parcel.writeInt(iconLevel); 1004 1005 if (fullScreenIntent != null) { 1006 parcel.writeInt(1); 1007 fullScreenIntent.writeToParcel(parcel, 0); 1008 } else { 1009 parcel.writeInt(0); 1010 } 1011 1012 parcel.writeInt(priority); 1013 1014 parcel.writeStringArray(kind); // ok for null 1015 1016 parcel.writeBundle(extras); // null ok 1017 1018 parcel.writeTypedArray(actions, 0); // null ok 1019 1020 if (bigContentView != null) { 1021 parcel.writeInt(1); 1022 bigContentView.writeToParcel(parcel, 0); 1023 } else { 1024 parcel.writeInt(0); 1025 } 1026 1027 parcel.writeInt(visibility); 1028 1029 if (publicVersion != null) { 1030 parcel.writeInt(1); 1031 publicVersion.writeToParcel(parcel, 0); 1032 } else { 1033 parcel.writeInt(0); 1034 } 1035 } 1036 1037 /** 1038 * Parcelable.Creator that instantiates Notification objects 1039 */ 1040 public static final Parcelable.Creator<Notification> CREATOR 1041 = new Parcelable.Creator<Notification>() 1042 { 1043 public Notification createFromParcel(Parcel parcel) 1044 { 1045 return new Notification(parcel); 1046 } 1047 1048 public Notification[] newArray(int size) 1049 { 1050 return new Notification[size]; 1051 } 1052 }; 1053 1054 /** 1055 * Sets the {@link #contentView} field to be a view with the standard "Latest Event" 1056 * layout. 1057 * 1058 * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields 1059 * in the view.</p> 1060 * @param context The context for your application / activity. 1061 * @param contentTitle The title that goes in the expanded entry. 1062 * @param contentText The text that goes in the expanded entry. 1063 * @param contentIntent The intent to launch when the user clicks the expanded notification. 1064 * If this is an activity, it must include the 1065 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires 1066 * that you take care of task management as described in the 1067 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back 1068 * Stack</a> document. 1069 * 1070 * @deprecated Use {@link Builder} instead. 1071 */ 1072 @Deprecated 1073 public void setLatestEventInfo(Context context, 1074 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) { 1075 Notification.Builder builder = new Notification.Builder(context); 1076 1077 // First, ensure that key pieces of information that may have been set directly 1078 // are preserved 1079 builder.setWhen(this.when); 1080 builder.setSmallIcon(this.icon); 1081 builder.setPriority(this.priority); 1082 builder.setTicker(this.tickerText); 1083 builder.setNumber(this.number); 1084 builder.mFlags = this.flags; 1085 builder.setSound(this.sound, this.audioStreamType); 1086 builder.setDefaults(this.defaults); 1087 builder.setVibrate(this.vibrate); 1088 1089 // now apply the latestEventInfo fields 1090 if (contentTitle != null) { 1091 builder.setContentTitle(contentTitle); 1092 } 1093 if (contentText != null) { 1094 builder.setContentText(contentText); 1095 } 1096 builder.setContentIntent(contentIntent); 1097 builder.buildInto(this); 1098 } 1099 1100 @Override 1101 public String toString() { 1102 StringBuilder sb = new StringBuilder(); 1103 sb.append("Notification(pri="); 1104 sb.append(priority); 1105 sb.append(" contentView="); 1106 if (contentView != null) { 1107 sb.append(contentView.getPackage()); 1108 sb.append("/0x"); 1109 sb.append(Integer.toHexString(contentView.getLayoutId())); 1110 } else { 1111 sb.append("null"); 1112 } 1113 // TODO(dsandler): defaults take precedence over local values, so reorder the branches below 1114 sb.append(" vibrate="); 1115 if ((this.defaults & DEFAULT_VIBRATE) != 0) { 1116 sb.append("default"); 1117 } else if (this.vibrate != null) { 1118 int N = this.vibrate.length-1; 1119 sb.append("["); 1120 for (int i=0; i<N; i++) { 1121 sb.append(this.vibrate[i]); 1122 sb.append(','); 1123 } 1124 if (N != -1) { 1125 sb.append(this.vibrate[N]); 1126 } 1127 sb.append("]"); 1128 } else { 1129 sb.append("null"); 1130 } 1131 sb.append(" sound="); 1132 if ((this.defaults & DEFAULT_SOUND) != 0) { 1133 sb.append("default"); 1134 } else if (this.sound != null) { 1135 sb.append(this.sound.toString()); 1136 } else { 1137 sb.append("null"); 1138 } 1139 sb.append(" defaults=0x"); 1140 sb.append(Integer.toHexString(this.defaults)); 1141 sb.append(" flags=0x"); 1142 sb.append(Integer.toHexString(this.flags)); 1143 sb.append(" kind=["); 1144 if (this.kind == null) { 1145 sb.append("null"); 1146 } else { 1147 for (int i=0; i<this.kind.length; i++) { 1148 if (i>0) sb.append(","); 1149 sb.append(this.kind[i]); 1150 } 1151 } 1152 sb.append("]"); 1153 if (actions != null) { 1154 sb.append(" "); 1155 sb.append(actions.length); 1156 sb.append(" action"); 1157 if (actions.length > 1) sb.append("s"); 1158 } 1159 sb.append(")"); 1160 return sb.toString(); 1161 } 1162 1163 /** {@hide} */ 1164 public void setUser(UserHandle user) { 1165 if (user.getIdentifier() == UserHandle.USER_ALL) { 1166 user = UserHandle.OWNER; 1167 } 1168 if (tickerView != null) { 1169 tickerView.setUser(user); 1170 } 1171 if (contentView != null) { 1172 contentView.setUser(user); 1173 } 1174 if (bigContentView != null) { 1175 bigContentView.setUser(user); 1176 } 1177 } 1178 1179 /** 1180 * Builder class for {@link Notification} objects. 1181 * 1182 * Provides a convenient way to set the various fields of a {@link Notification} and generate 1183 * content views using the platform's notification layout template. If your app supports 1184 * versions of Android as old as API level 4, you can instead use 1185 * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder}, 1186 * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support 1187 * library</a>. 1188 * 1189 * <p>Example: 1190 * 1191 * <pre class="prettyprint"> 1192 * Notification noti = new Notification.Builder(mContext) 1193 * .setContentTitle("New mail from " + sender.toString()) 1194 * .setContentText(subject) 1195 * .setSmallIcon(R.drawable.new_mail) 1196 * .setLargeIcon(aBitmap) 1197 * .build(); 1198 * </pre> 1199 */ 1200 public static class Builder { 1201 private static final int MAX_ACTION_BUTTONS = 3; 1202 1203 private Context mContext; 1204 1205 private long mWhen; 1206 private int mSmallIcon; 1207 private int mSmallIconLevel; 1208 private int mNumber; 1209 private CharSequence mContentTitle; 1210 private CharSequence mContentText; 1211 private CharSequence mContentInfo; 1212 private CharSequence mSubText; 1213 private PendingIntent mContentIntent; 1214 private RemoteViews mContentView; 1215 private PendingIntent mDeleteIntent; 1216 private PendingIntent mFullScreenIntent; 1217 private CharSequence mTickerText; 1218 private RemoteViews mTickerView; 1219 private Bitmap mLargeIcon; 1220 private Uri mSound; 1221 private int mAudioStreamType; 1222 private long[] mVibrate; 1223 private int mLedArgb; 1224 private int mLedOnMs; 1225 private int mLedOffMs; 1226 private int mDefaults; 1227 private int mFlags; 1228 private int mProgressMax; 1229 private int mProgress; 1230 private boolean mProgressIndeterminate; 1231 private ArrayList<String> mKindList = new ArrayList<String>(1); 1232 private Bundle mExtras; 1233 private int mPriority; 1234 private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS); 1235 private boolean mUseChronometer; 1236 private Style mStyle; 1237 private boolean mShowWhen = true; 1238 private int mVisibility = VISIBILITY_PRIVATE; 1239 private Notification mPublicVersion = null; 1240 1241 /** 1242 * Constructs a new Builder with the defaults: 1243 * 1244 1245 * <table> 1246 * <tr><th align=right>priority</th> 1247 * <td>{@link #PRIORITY_DEFAULT}</td></tr> 1248 * <tr><th align=right>when</th> 1249 * <td>now ({@link System#currentTimeMillis()})</td></tr> 1250 * <tr><th align=right>audio stream</th> 1251 * <td>{@link #STREAM_DEFAULT}</td></tr> 1252 * </table> 1253 * 1254 1255 * @param context 1256 * A {@link Context} that will be used by the Builder to construct the 1257 * RemoteViews. The Context will not be held past the lifetime of this Builder 1258 * object. 1259 */ 1260 public Builder(Context context) { 1261 mContext = context; 1262 1263 // Set defaults to match the defaults of a Notification 1264 mWhen = System.currentTimeMillis(); 1265 mAudioStreamType = STREAM_DEFAULT; 1266 mPriority = PRIORITY_DEFAULT; 1267 } 1268 1269 /** 1270 * Add a timestamp pertaining to the notification (usually the time the event occurred). 1271 * It will be shown in the notification content view by default; use 1272 * {@link Builder#setShowWhen(boolean) setShowWhen} to control this. 1273 * 1274 * @see Notification#when 1275 */ 1276 public Builder setWhen(long when) { 1277 mWhen = when; 1278 return this; 1279 } 1280 1281 /** 1282 * Control whether the timestamp set with {@link Builder#setWhen(long) setWhen} is shown 1283 * in the content view. 1284 */ 1285 public Builder setShowWhen(boolean show) { 1286 mShowWhen = show; 1287 return this; 1288 } 1289 1290 /** 1291 * Show the {@link Notification#when} field as a stopwatch. 1292 * 1293 * Instead of presenting <code>when</code> as a timestamp, the notification will show an 1294 * automatically updating display of the minutes and seconds since <code>when</code>. 1295 * 1296 * Useful when showing an elapsed time (like an ongoing phone call). 1297 * 1298 * @see android.widget.Chronometer 1299 * @see Notification#when 1300 */ 1301 public Builder setUsesChronometer(boolean b) { 1302 mUseChronometer = b; 1303 return this; 1304 } 1305 1306 /** 1307 * Set the small icon resource, which will be used to represent the notification in the 1308 * status bar. 1309 * 1310 1311 * The platform template for the expanded view will draw this icon in the left, unless a 1312 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small 1313 * icon will be moved to the right-hand side. 1314 * 1315 1316 * @param icon 1317 * A resource ID in the application's package of the drawable to use. 1318 * @see Notification#icon 1319 */ 1320 public Builder setSmallIcon(int icon) { 1321 mSmallIcon = icon; 1322 return this; 1323 } 1324 1325 /** 1326 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional 1327 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable 1328 * LevelListDrawable}. 1329 * 1330 * @param icon A resource ID in the application's package of the drawable to use. 1331 * @param level The level to use for the icon. 1332 * 1333 * @see Notification#icon 1334 * @see Notification#iconLevel 1335 */ 1336 public Builder setSmallIcon(int icon, int level) { 1337 mSmallIcon = icon; 1338 mSmallIconLevel = level; 1339 return this; 1340 } 1341 1342 /** 1343 * Set the first line of text in the platform notification template. 1344 */ 1345 public Builder setContentTitle(CharSequence title) { 1346 mContentTitle = safeCharSequence(title); 1347 return this; 1348 } 1349 1350 /** 1351 * Set the second line of text in the platform notification template. 1352 */ 1353 public Builder setContentText(CharSequence text) { 1354 mContentText = safeCharSequence(text); 1355 return this; 1356 } 1357 1358 /** 1359 * Set the third line of text in the platform notification template. 1360 * Don't use if you're also using {@link #setProgress(int, int, boolean)}; they occupy the 1361 * same location in the standard template. 1362 */ 1363 public Builder setSubText(CharSequence text) { 1364 mSubText = safeCharSequence(text); 1365 return this; 1366 } 1367 1368 /** 1369 * Set the large number at the right-hand side of the notification. This is 1370 * equivalent to setContentInfo, although it might show the number in a different 1371 * font size for readability. 1372 */ 1373 public Builder setNumber(int number) { 1374 mNumber = number; 1375 return this; 1376 } 1377 1378 /** 1379 * A small piece of additional information pertaining to this notification. 1380 * 1381 * The platform template will draw this on the last line of the notification, at the far 1382 * right (to the right of a smallIcon if it has been placed there). 1383 */ 1384 public Builder setContentInfo(CharSequence info) { 1385 mContentInfo = safeCharSequence(info); 1386 return this; 1387 } 1388 1389 /** 1390 * Set the progress this notification represents. 1391 * 1392 * The platform template will represent this using a {@link ProgressBar}. 1393 */ 1394 public Builder setProgress(int max, int progress, boolean indeterminate) { 1395 mProgressMax = max; 1396 mProgress = progress; 1397 mProgressIndeterminate = indeterminate; 1398 return this; 1399 } 1400 1401 /** 1402 * Supply a custom RemoteViews to use instead of the platform template. 1403 * 1404 * @see Notification#contentView 1405 */ 1406 public Builder setContent(RemoteViews views) { 1407 mContentView = views; 1408 return this; 1409 } 1410 1411 /** 1412 * Supply a {@link PendingIntent} to be sent when the notification is clicked. 1413 * 1414 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you 1415 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use 1416 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)} 1417 * to assign PendingIntents to individual views in that custom layout (i.e., to create 1418 * clickable buttons inside the notification view). 1419 * 1420 * @see Notification#contentIntent Notification.contentIntent 1421 */ 1422 public Builder setContentIntent(PendingIntent intent) { 1423 mContentIntent = intent; 1424 return this; 1425 } 1426 1427 /** 1428 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user. 1429 * 1430 * @see Notification#deleteIntent 1431 */ 1432 public Builder setDeleteIntent(PendingIntent intent) { 1433 mDeleteIntent = intent; 1434 return this; 1435 } 1436 1437 /** 1438 * An intent to launch instead of posting the notification to the status bar. 1439 * Only for use with extremely high-priority notifications demanding the user's 1440 * <strong>immediate</strong> attention, such as an incoming phone call or 1441 * alarm clock that the user has explicitly set to a particular time. 1442 * If this facility is used for something else, please give the user an option 1443 * to turn it off and use a normal notification, as this can be extremely 1444 * disruptive. 1445 * 1446 * @param intent The pending intent to launch. 1447 * @param highPriority Passing true will cause this notification to be sent 1448 * even if other notifications are suppressed. 1449 * 1450 * @see Notification#fullScreenIntent 1451 */ 1452 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) { 1453 mFullScreenIntent = intent; 1454 setFlag(FLAG_HIGH_PRIORITY, highPriority); 1455 return this; 1456 } 1457 1458 /** 1459 * Set the "ticker" text which is displayed in the status bar when the notification first 1460 * arrives. 1461 * 1462 * @see Notification#tickerText 1463 */ 1464 public Builder setTicker(CharSequence tickerText) { 1465 mTickerText = safeCharSequence(tickerText); 1466 return this; 1467 } 1468 1469 /** 1470 * Set the text that is displayed in the status bar when the notification first 1471 * arrives, and also a RemoteViews object that may be displayed instead on some 1472 * devices. 1473 * 1474 * @see Notification#tickerText 1475 * @see Notification#tickerView 1476 */ 1477 public Builder setTicker(CharSequence tickerText, RemoteViews views) { 1478 mTickerText = safeCharSequence(tickerText); 1479 mTickerView = views; 1480 return this; 1481 } 1482 1483 /** 1484 * Add a large icon to the notification (and the ticker on some devices). 1485 * 1486 * In the platform template, this image will be shown on the left of the notification view 1487 * in place of the {@link #setSmallIcon(int) small icon} (which will move to the right side). 1488 * 1489 * @see Notification#largeIcon 1490 */ 1491 public Builder setLargeIcon(Bitmap icon) { 1492 mLargeIcon = icon; 1493 return this; 1494 } 1495 1496 /** 1497 * Set the sound to play. 1498 * 1499 * It will be played on the {@link #STREAM_DEFAULT default stream} for notifications. 1500 * 1501 * @see Notification#sound 1502 */ 1503 public Builder setSound(Uri sound) { 1504 mSound = sound; 1505 mAudioStreamType = STREAM_DEFAULT; 1506 return this; 1507 } 1508 1509 /** 1510 * Set the sound to play, along with a specific stream on which to play it. 1511 * 1512 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants. 1513 * 1514 * @see Notification#sound 1515 */ 1516 public Builder setSound(Uri sound, int streamType) { 1517 mSound = sound; 1518 mAudioStreamType = streamType; 1519 return this; 1520 } 1521 1522 /** 1523 * Set the vibration pattern to use. 1524 * 1525 1526 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the 1527 * <code>pattern</code> parameter. 1528 * 1529 1530 * @see Notification#vibrate 1531 */ 1532 public Builder setVibrate(long[] pattern) { 1533 mVibrate = pattern; 1534 return this; 1535 } 1536 1537 /** 1538 * Set the desired color for the indicator LED on the device, as well as the 1539 * blink duty cycle (specified in milliseconds). 1540 * 1541 1542 * Not all devices will honor all (or even any) of these values. 1543 * 1544 1545 * @see Notification#ledARGB 1546 * @see Notification#ledOnMS 1547 * @see Notification#ledOffMS 1548 */ 1549 public Builder setLights(int argb, int onMs, int offMs) { 1550 mLedArgb = argb; 1551 mLedOnMs = onMs; 1552 mLedOffMs = offMs; 1553 return this; 1554 } 1555 1556 /** 1557 * Set whether this is an "ongoing" notification. 1558 * 1559 1560 * Ongoing notifications cannot be dismissed by the user, so your application or service 1561 * must take care of canceling them. 1562 * 1563 1564 * They are typically used to indicate a background task that the user is actively engaged 1565 * with (e.g., playing music) or is pending in some way and therefore occupying the device 1566 * (e.g., a file download, sync operation, active network connection). 1567 * 1568 1569 * @see Notification#FLAG_ONGOING_EVENT 1570 * @see Service#setForeground(boolean) 1571 */ 1572 public Builder setOngoing(boolean ongoing) { 1573 setFlag(FLAG_ONGOING_EVENT, ongoing); 1574 return this; 1575 } 1576 1577 /** 1578 * Set this flag if you would only like the sound, vibrate 1579 * and ticker to be played if the notification is not already showing. 1580 * 1581 * @see Notification#FLAG_ONLY_ALERT_ONCE 1582 */ 1583 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) { 1584 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce); 1585 return this; 1586 } 1587 1588 /** 1589 * Make this notification automatically dismissed when the user touches it. The 1590 * PendingIntent set with {@link #setDeleteIntent} will be sent when this happens. 1591 * 1592 * @see Notification#FLAG_AUTO_CANCEL 1593 */ 1594 public Builder setAutoCancel(boolean autoCancel) { 1595 setFlag(FLAG_AUTO_CANCEL, autoCancel); 1596 return this; 1597 } 1598 1599 /** 1600 * Set which notification properties will be inherited from system defaults. 1601 * <p> 1602 * The value should be one or more of the following fields combined with 1603 * bitwise-or: 1604 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}. 1605 * <p> 1606 * For all default values, use {@link #DEFAULT_ALL}. 1607 */ 1608 public Builder setDefaults(int defaults) { 1609 mDefaults = defaults; 1610 return this; 1611 } 1612 1613 /** 1614 * Set the priority of this notification. 1615 * 1616 * @see Notification#priority 1617 */ 1618 public Builder setPriority(@Priority int pri) { 1619 mPriority = pri; 1620 return this; 1621 } 1622 1623 /** 1624 * @hide 1625 * 1626 * Add a kind (category) to this notification. Optional. 1627 * 1628 * @see Notification#kind 1629 */ 1630 public Builder addKind(String k) { 1631 mKindList.add(k); 1632 return this; 1633 } 1634 1635 /** 1636 * Add metadata to this notification. 1637 * 1638 * A reference to the Bundle is held for the lifetime of this Builder, and the Bundle's 1639 * current contents are copied into the Notification each time {@link #build()} is 1640 * called. 1641 * 1642 * @see Notification#extras 1643 */ 1644 public Builder setExtras(Bundle bag) { 1645 mExtras = bag; 1646 return this; 1647 } 1648 1649 /** 1650 * Add an action to this notification. Actions are typically displayed by 1651 * the system as a button adjacent to the notification content. 1652 * <p> 1653 * Every action must have an icon (32dp square and matching the 1654 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo 1655 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}. 1656 * <p> 1657 * A notification in its expanded form can display up to 3 actions, from left to right in 1658 * the order they were added. Actions will not be displayed when the notification is 1659 * collapsed, however, so be sure that any essential functions may be accessed by the user 1660 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}). 1661 * 1662 * @param icon Resource ID of a drawable that represents the action. 1663 * @param title Text describing the action. 1664 * @param intent PendingIntent to be fired when the action is invoked. 1665 */ 1666 public Builder addAction(int icon, CharSequence title, PendingIntent intent) { 1667 mActions.add(new Action(icon, safeCharSequence(title), intent)); 1668 return this; 1669 } 1670 1671 /** 1672 * Add a rich notification style to be applied at build time. 1673 * 1674 * @param style Object responsible for modifying the notification style. 1675 */ 1676 public Builder setStyle(Style style) { 1677 if (mStyle != style) { 1678 mStyle = style; 1679 if (mStyle != null) { 1680 mStyle.setBuilder(this); 1681 } 1682 } 1683 return this; 1684 } 1685 1686 /** 1687 * Specify the value of {@link #visibility}. 1688 1689 * @param visibility One of {@link #VISIBILITY_PRIVATE} (the default), 1690 * {@link #VISIBILITY_SECRET}, or {@link #VISIBILITY_PUBLIC}. 1691 * 1692 * @return The same Builder. 1693 */ 1694 public Builder setVisibility(int visibility) { 1695 mVisibility = visibility; 1696 return this; 1697 } 1698 1699 /** 1700 * Supply a replacement Notification whose contents should be shown in insecure contexts 1701 * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}. 1702 * @param n A replacement notification, presumably with some or all info redacted. 1703 * @return The same Builder. 1704 */ 1705 public Builder setPublicVersion(Notification n) { 1706 mPublicVersion = n; 1707 return this; 1708 } 1709 1710 private void setFlag(int mask, boolean value) { 1711 if (value) { 1712 mFlags |= mask; 1713 } else { 1714 mFlags &= ~mask; 1715 } 1716 } 1717 1718 private RemoteViews applyStandardTemplate(int resId, boolean fitIn1U) { 1719 RemoteViews contentView = new RemoteViews(mContext.getPackageName(), resId); 1720 boolean showLine3 = false; 1721 boolean showLine2 = false; 1722 int smallIconImageViewId = R.id.icon; 1723 if (mLargeIcon != null) { 1724 contentView.setImageViewBitmap(R.id.icon, mLargeIcon); 1725 smallIconImageViewId = R.id.right_icon; 1726 } 1727 if (mPriority < PRIORITY_LOW) { 1728 contentView.setInt(R.id.icon, 1729 "setBackgroundResource", R.drawable.notification_template_icon_low_bg); 1730 contentView.setInt(R.id.status_bar_latest_event_content, 1731 "setBackgroundResource", R.drawable.notification_bg_low); 1732 } 1733 if (mSmallIcon != 0) { 1734 contentView.setImageViewResource(smallIconImageViewId, mSmallIcon); 1735 contentView.setViewVisibility(smallIconImageViewId, View.VISIBLE); 1736 } else { 1737 contentView.setViewVisibility(smallIconImageViewId, View.GONE); 1738 } 1739 if (mContentTitle != null) { 1740 contentView.setTextViewText(R.id.title, mContentTitle); 1741 } 1742 if (mContentText != null) { 1743 contentView.setTextViewText(R.id.text, mContentText); 1744 showLine3 = true; 1745 } 1746 if (mContentInfo != null) { 1747 contentView.setTextViewText(R.id.info, mContentInfo); 1748 contentView.setViewVisibility(R.id.info, View.VISIBLE); 1749 showLine3 = true; 1750 } else if (mNumber > 0) { 1751 final int tooBig = mContext.getResources().getInteger( 1752 R.integer.status_bar_notification_info_maxnum); 1753 if (mNumber > tooBig) { 1754 contentView.setTextViewText(R.id.info, mContext.getResources().getString( 1755 R.string.status_bar_notification_info_overflow)); 1756 } else { 1757 NumberFormat f = NumberFormat.getIntegerInstance(); 1758 contentView.setTextViewText(R.id.info, f.format(mNumber)); 1759 } 1760 contentView.setViewVisibility(R.id.info, View.VISIBLE); 1761 showLine3 = true; 1762 } else { 1763 contentView.setViewVisibility(R.id.info, View.GONE); 1764 } 1765 1766 // Need to show three lines? 1767 if (mSubText != null) { 1768 contentView.setTextViewText(R.id.text, mSubText); 1769 if (mContentText != null) { 1770 contentView.setTextViewText(R.id.text2, mContentText); 1771 contentView.setViewVisibility(R.id.text2, View.VISIBLE); 1772 showLine2 = true; 1773 } else { 1774 contentView.setViewVisibility(R.id.text2, View.GONE); 1775 } 1776 } else { 1777 contentView.setViewVisibility(R.id.text2, View.GONE); 1778 if (mProgressMax != 0 || mProgressIndeterminate) { 1779 contentView.setProgressBar( 1780 R.id.progress, mProgressMax, mProgress, mProgressIndeterminate); 1781 contentView.setViewVisibility(R.id.progress, View.VISIBLE); 1782 showLine2 = true; 1783 } else { 1784 contentView.setViewVisibility(R.id.progress, View.GONE); 1785 } 1786 } 1787 if (showLine2) { 1788 if (fitIn1U) { 1789 // need to shrink all the type to make sure everything fits 1790 final Resources res = mContext.getResources(); 1791 final float subTextSize = res.getDimensionPixelSize( 1792 R.dimen.notification_subtext_size); 1793 contentView.setTextViewTextSize(R.id.text, TypedValue.COMPLEX_UNIT_PX, subTextSize); 1794 } 1795 // vertical centering 1796 contentView.setViewPadding(R.id.line1, 0, 0, 0, 0); 1797 } 1798 1799 if (mWhen != 0 && mShowWhen) { 1800 if (mUseChronometer) { 1801 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE); 1802 contentView.setLong(R.id.chronometer, "setBase", 1803 mWhen + (SystemClock.elapsedRealtime() - System.currentTimeMillis())); 1804 contentView.setBoolean(R.id.chronometer, "setStarted", true); 1805 } else { 1806 contentView.setViewVisibility(R.id.time, View.VISIBLE); 1807 contentView.setLong(R.id.time, "setTime", mWhen); 1808 } 1809 } else { 1810 contentView.setViewVisibility(R.id.time, View.GONE); 1811 } 1812 1813 contentView.setViewVisibility(R.id.line3, showLine3 ? View.VISIBLE : View.GONE); 1814 contentView.setViewVisibility(R.id.overflow_divider, showLine3 ? View.VISIBLE : View.GONE); 1815 return contentView; 1816 } 1817 1818 private RemoteViews applyStandardTemplateWithActions(int layoutId) { 1819 RemoteViews big = applyStandardTemplate(layoutId, false); 1820 1821 int N = mActions.size(); 1822 if (N > 0) { 1823 // Log.d("Notification", "has actions: " + mContentText); 1824 big.setViewVisibility(R.id.actions, View.VISIBLE); 1825 big.setViewVisibility(R.id.action_divider, View.VISIBLE); 1826 if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS; 1827 big.removeAllViews(R.id.actions); 1828 for (int i=0; i<N; i++) { 1829 final RemoteViews button = generateActionButton(mActions.get(i)); 1830 //Log.d("Notification", "adding action " + i + ": " + mActions.get(i).title); 1831 big.addView(R.id.actions, button); 1832 } 1833 } 1834 return big; 1835 } 1836 1837 private RemoteViews makeContentView() { 1838 if (mContentView != null) { 1839 return mContentView; 1840 } else { 1841 return applyStandardTemplate(R.layout.notification_template_base, true); // no more special large_icon flavor 1842 } 1843 } 1844 1845 private RemoteViews makeTickerView() { 1846 if (mTickerView != null) { 1847 return mTickerView; 1848 } else { 1849 if (mContentView == null) { 1850 return applyStandardTemplate(mLargeIcon == null 1851 ? R.layout.status_bar_latest_event_ticker 1852 : R.layout.status_bar_latest_event_ticker_large_icon, true); 1853 } else { 1854 return null; 1855 } 1856 } 1857 } 1858 1859 private RemoteViews makeBigContentView() { 1860 if (mActions.size() == 0) return null; 1861 1862 return applyStandardTemplateWithActions(R.layout.notification_template_big_base); 1863 } 1864 1865 private RemoteViews generateActionButton(Action action) { 1866 final boolean tombstone = (action.actionIntent == null); 1867 RemoteViews button = new RemoteViews(mContext.getPackageName(), 1868 tombstone ? R.layout.notification_action_tombstone 1869 : R.layout.notification_action); 1870 button.setTextViewCompoundDrawablesRelative(R.id.action0, action.icon, 0, 0, 0); 1871 button.setTextViewText(R.id.action0, action.title); 1872 if (!tombstone) { 1873 button.setOnClickPendingIntent(R.id.action0, action.actionIntent); 1874 } 1875 button.setContentDescription(R.id.action0, action.title); 1876 return button; 1877 } 1878 1879 /** 1880 * Apply the unstyled operations and return a new {@link Notification} object. 1881 * @hide 1882 */ 1883 public Notification buildUnstyled() { 1884 Notification n = new Notification(); 1885 n.when = mWhen; 1886 n.icon = mSmallIcon; 1887 n.iconLevel = mSmallIconLevel; 1888 n.number = mNumber; 1889 n.contentView = makeContentView(); 1890 n.contentIntent = mContentIntent; 1891 n.deleteIntent = mDeleteIntent; 1892 n.fullScreenIntent = mFullScreenIntent; 1893 n.tickerText = mTickerText; 1894 n.tickerView = makeTickerView(); 1895 n.largeIcon = mLargeIcon; 1896 n.sound = mSound; 1897 n.audioStreamType = mAudioStreamType; 1898 n.vibrate = mVibrate; 1899 n.ledARGB = mLedArgb; 1900 n.ledOnMS = mLedOnMs; 1901 n.ledOffMS = mLedOffMs; 1902 n.defaults = mDefaults; 1903 n.flags = mFlags; 1904 n.bigContentView = makeBigContentView(); 1905 if (mLedOnMs != 0 || mLedOffMs != 0) { 1906 n.flags |= FLAG_SHOW_LIGHTS; 1907 } 1908 if ((mDefaults & DEFAULT_LIGHTS) != 0) { 1909 n.flags |= FLAG_SHOW_LIGHTS; 1910 } 1911 if (mKindList.size() > 0) { 1912 n.kind = new String[mKindList.size()]; 1913 mKindList.toArray(n.kind); 1914 } else { 1915 n.kind = null; 1916 } 1917 n.priority = mPriority; 1918 if (mActions.size() > 0) { 1919 n.actions = new Action[mActions.size()]; 1920 mActions.toArray(n.actions); 1921 } 1922 n.visibility = mVisibility; 1923 1924 if (mPublicVersion != null) { 1925 n.publicVersion = new Notification(); 1926 mPublicVersion.cloneInto(n.publicVersion, true); 1927 } 1928 1929 return n; 1930 } 1931 1932 /** 1933 * Capture, in the provided bundle, semantic information used in the construction of 1934 * this Notification object. 1935 * @hide 1936 */ 1937 public void addExtras(Bundle extras) { 1938 // Store original information used in the construction of this object 1939 extras.putCharSequence(EXTRA_TITLE, mContentTitle); 1940 extras.putCharSequence(EXTRA_TEXT, mContentText); 1941 extras.putCharSequence(EXTRA_SUB_TEXT, mSubText); 1942 extras.putCharSequence(EXTRA_INFO_TEXT, mContentInfo); 1943 extras.putInt(EXTRA_SMALL_ICON, mSmallIcon); 1944 extras.putInt(EXTRA_PROGRESS, mProgress); 1945 extras.putInt(EXTRA_PROGRESS_MAX, mProgressMax); 1946 extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, mProgressIndeterminate); 1947 extras.putBoolean(EXTRA_SHOW_CHRONOMETER, mUseChronometer); 1948 extras.putBoolean(EXTRA_SHOW_WHEN, mShowWhen); 1949 if (mLargeIcon != null) { 1950 extras.putParcelable(EXTRA_LARGE_ICON, mLargeIcon); 1951 } 1952 } 1953 1954 /** 1955 * @deprecated Use {@link #build()} instead. 1956 */ 1957 @Deprecated 1958 public Notification getNotification() { 1959 return build(); 1960 } 1961 1962 /** 1963 * Combine all of the options that have been set and return a new {@link Notification} 1964 * object. 1965 */ 1966 public Notification build() { 1967 Notification n = buildUnstyled(); 1968 1969 if (mStyle != null) { 1970 n = mStyle.buildStyled(n); 1971 } 1972 1973 n.extras = mExtras != null ? new Bundle(mExtras) : new Bundle(); 1974 1975 addExtras(n.extras); 1976 if (mStyle != null) { 1977 mStyle.addExtras(n.extras); 1978 } 1979 1980 return n; 1981 } 1982 1983 /** 1984 * Apply this Builder to an existing {@link Notification} object. 1985 * 1986 * @hide 1987 */ 1988 public Notification buildInto(Notification n) { 1989 build().cloneInto(n, true); 1990 return n; 1991 } 1992 } 1993 1994 /** 1995 * An object that can apply a rich notification style to a {@link Notification.Builder} 1996 * object. 1997 */ 1998 public static abstract class Style 1999 { 2000 private CharSequence mBigContentTitle; 2001 private CharSequence mSummaryText = null; 2002 private boolean mSummaryTextSet = false; 2003 2004 protected Builder mBuilder; 2005 2006 /** 2007 * Overrides ContentTitle in the big form of the template. 2008 * This defaults to the value passed to setContentTitle(). 2009 */ 2010 protected void internalSetBigContentTitle(CharSequence title) { 2011 mBigContentTitle = title; 2012 } 2013 2014 /** 2015 * Set the first line of text after the detail section in the big form of the template. 2016 */ 2017 protected void internalSetSummaryText(CharSequence cs) { 2018 mSummaryText = cs; 2019 mSummaryTextSet = true; 2020 } 2021 2022 public void setBuilder(Builder builder) { 2023 if (mBuilder != builder) { 2024 mBuilder = builder; 2025 if (mBuilder != null) { 2026 mBuilder.setStyle(this); 2027 } 2028 } 2029 } 2030 2031 protected void checkBuilder() { 2032 if (mBuilder == null) { 2033 throw new IllegalArgumentException("Style requires a valid Builder object"); 2034 } 2035 } 2036 2037 protected RemoteViews getStandardView(int layoutId) { 2038 checkBuilder(); 2039 2040 if (mBigContentTitle != null) { 2041 mBuilder.setContentTitle(mBigContentTitle); 2042 } 2043 2044 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId); 2045 2046 if (mBigContentTitle != null && mBigContentTitle.equals("")) { 2047 contentView.setViewVisibility(R.id.line1, View.GONE); 2048 } else { 2049 contentView.setViewVisibility(R.id.line1, View.VISIBLE); 2050 } 2051 2052 // The last line defaults to the subtext, but can be replaced by mSummaryText 2053 final CharSequence overflowText = 2054 mSummaryTextSet ? mSummaryText 2055 : mBuilder.mSubText; 2056 if (overflowText != null) { 2057 contentView.setTextViewText(R.id.text, overflowText); 2058 contentView.setViewVisibility(R.id.overflow_divider, View.VISIBLE); 2059 contentView.setViewVisibility(R.id.line3, View.VISIBLE); 2060 } else { 2061 contentView.setViewVisibility(R.id.overflow_divider, View.GONE); 2062 contentView.setViewVisibility(R.id.line3, View.GONE); 2063 } 2064 2065 return contentView; 2066 } 2067 2068 /** 2069 * @hide 2070 */ 2071 public void addExtras(Bundle extras) { 2072 if (mSummaryTextSet) { 2073 extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText); 2074 } 2075 if (mBigContentTitle != null) { 2076 extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle); 2077 } 2078 } 2079 2080 /** 2081 * @hide 2082 */ 2083 public abstract Notification buildStyled(Notification wip); 2084 2085 /** 2086 * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is 2087 * attached to. 2088 * 2089 * @return the fully constructed Notification. 2090 */ 2091 public Notification build() { 2092 checkBuilder(); 2093 return mBuilder.build(); 2094 } 2095 } 2096 2097 /** 2098 * Helper class for generating large-format notifications that include a large image attachment. 2099 * 2100 * This class is a "rebuilder": It consumes a Builder object and modifies its behavior, like so: 2101 * <pre class="prettyprint"> 2102 * Notification noti = new Notification.BigPictureStyle( 2103 * new Notification.Builder() 2104 * .setContentTitle("New photo from " + sender.toString()) 2105 * .setContentText(subject) 2106 * .setSmallIcon(R.drawable.new_post) 2107 * .setLargeIcon(aBitmap)) 2108 * .bigPicture(aBigBitmap) 2109 * .build(); 2110 * </pre> 2111 * 2112 * @see Notification#bigContentView 2113 */ 2114 public static class BigPictureStyle extends Style { 2115 private Bitmap mPicture; 2116 private Bitmap mBigLargeIcon; 2117 private boolean mBigLargeIconSet = false; 2118 2119 public BigPictureStyle() { 2120 } 2121 2122 public BigPictureStyle(Builder builder) { 2123 setBuilder(builder); 2124 } 2125 2126 /** 2127 * Overrides ContentTitle in the big form of the template. 2128 * This defaults to the value passed to setContentTitle(). 2129 */ 2130 public BigPictureStyle setBigContentTitle(CharSequence title) { 2131 internalSetBigContentTitle(safeCharSequence(title)); 2132 return this; 2133 } 2134 2135 /** 2136 * Set the first line of text after the detail section in the big form of the template. 2137 */ 2138 public BigPictureStyle setSummaryText(CharSequence cs) { 2139 internalSetSummaryText(safeCharSequence(cs)); 2140 return this; 2141 } 2142 2143 /** 2144 * Provide the bitmap to be used as the payload for the BigPicture notification. 2145 */ 2146 public BigPictureStyle bigPicture(Bitmap b) { 2147 mPicture = b; 2148 return this; 2149 } 2150 2151 /** 2152 * Override the large icon when the big notification is shown. 2153 */ 2154 public BigPictureStyle bigLargeIcon(Bitmap b) { 2155 mBigLargeIconSet = true; 2156 mBigLargeIcon = b; 2157 return this; 2158 } 2159 2160 private RemoteViews makeBigContentView() { 2161 RemoteViews contentView = getStandardView(R.layout.notification_template_big_picture); 2162 2163 contentView.setImageViewBitmap(R.id.big_picture, mPicture); 2164 2165 return contentView; 2166 } 2167 2168 /** 2169 * @hide 2170 */ 2171 public void addExtras(Bundle extras) { 2172 super.addExtras(extras); 2173 2174 if (mBigLargeIconSet) { 2175 extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon); 2176 } 2177 extras.putParcelable(EXTRA_PICTURE, mPicture); 2178 } 2179 2180 /** 2181 * @hide 2182 */ 2183 @Override 2184 public Notification buildStyled(Notification wip) { 2185 if (mBigLargeIconSet ) { 2186 mBuilder.mLargeIcon = mBigLargeIcon; 2187 } 2188 wip.bigContentView = makeBigContentView(); 2189 return wip; 2190 } 2191 } 2192 2193 /** 2194 * Helper class for generating large-format notifications that include a lot of text. 2195 * 2196 * This class is a "rebuilder": It consumes a Builder object and modifies its behavior, like so: 2197 * <pre class="prettyprint"> 2198 * Notification noti = new Notification.BigTextStyle( 2199 * new Notification.Builder() 2200 * .setContentTitle("New mail from " + sender.toString()) 2201 * .setContentText(subject) 2202 * .setSmallIcon(R.drawable.new_mail) 2203 * .setLargeIcon(aBitmap)) 2204 * .bigText(aVeryLongString) 2205 * .build(); 2206 * </pre> 2207 * 2208 * @see Notification#bigContentView 2209 */ 2210 public static class BigTextStyle extends Style { 2211 private CharSequence mBigText; 2212 2213 public BigTextStyle() { 2214 } 2215 2216 public BigTextStyle(Builder builder) { 2217 setBuilder(builder); 2218 } 2219 2220 /** 2221 * Overrides ContentTitle in the big form of the template. 2222 * This defaults to the value passed to setContentTitle(). 2223 */ 2224 public BigTextStyle setBigContentTitle(CharSequence title) { 2225 internalSetBigContentTitle(safeCharSequence(title)); 2226 return this; 2227 } 2228 2229 /** 2230 * Set the first line of text after the detail section in the big form of the template. 2231 */ 2232 public BigTextStyle setSummaryText(CharSequence cs) { 2233 internalSetSummaryText(safeCharSequence(cs)); 2234 return this; 2235 } 2236 2237 /** 2238 * Provide the longer text to be displayed in the big form of the 2239 * template in place of the content text. 2240 */ 2241 public BigTextStyle bigText(CharSequence cs) { 2242 mBigText = safeCharSequence(cs); 2243 return this; 2244 } 2245 2246 /** 2247 * @hide 2248 */ 2249 public void addExtras(Bundle extras) { 2250 super.addExtras(extras); 2251 2252 extras.putCharSequence(EXTRA_TEXT, mBigText); 2253 } 2254 2255 private RemoteViews makeBigContentView() { 2256 // Remove the content text so line3 only shows if you have a summary 2257 final boolean hadThreeLines = (mBuilder.mContentText != null && mBuilder.mSubText != null); 2258 mBuilder.mContentText = null; 2259 2260 RemoteViews contentView = getStandardView(R.layout.notification_template_big_text); 2261 2262 if (hadThreeLines) { 2263 // vertical centering 2264 contentView.setViewPadding(R.id.line1, 0, 0, 0, 0); 2265 } 2266 2267 contentView.setTextViewText(R.id.big_text, mBigText); 2268 contentView.setViewVisibility(R.id.big_text, View.VISIBLE); 2269 contentView.setViewVisibility(R.id.text2, View.GONE); 2270 2271 return contentView; 2272 } 2273 2274 /** 2275 * @hide 2276 */ 2277 @Override 2278 public Notification buildStyled(Notification wip) { 2279 wip.bigContentView = makeBigContentView(); 2280 2281 wip.extras.putCharSequence(EXTRA_TEXT, mBigText); 2282 2283 return wip; 2284 } 2285 } 2286 2287 /** 2288 * Helper class for generating large-format notifications that include a list of (up to 5) strings. 2289 * 2290 * This class is a "rebuilder": It consumes a Builder object and modifies its behavior, like so: 2291 * <pre class="prettyprint"> 2292 * Notification noti = new Notification.InboxStyle( 2293 * new Notification.Builder() 2294 * .setContentTitle("5 New mails from " + sender.toString()) 2295 * .setContentText(subject) 2296 * .setSmallIcon(R.drawable.new_mail) 2297 * .setLargeIcon(aBitmap)) 2298 * .addLine(str1) 2299 * .addLine(str2) 2300 * .setContentTitle("") 2301 * .setSummaryText("+3 more") 2302 * .build(); 2303 * </pre> 2304 * 2305 * @see Notification#bigContentView 2306 */ 2307 public static class InboxStyle extends Style { 2308 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5); 2309 2310 public InboxStyle() { 2311 } 2312 2313 public InboxStyle(Builder builder) { 2314 setBuilder(builder); 2315 } 2316 2317 /** 2318 * Overrides ContentTitle in the big form of the template. 2319 * This defaults to the value passed to setContentTitle(). 2320 */ 2321 public InboxStyle setBigContentTitle(CharSequence title) { 2322 internalSetBigContentTitle(safeCharSequence(title)); 2323 return this; 2324 } 2325 2326 /** 2327 * Set the first line of text after the detail section in the big form of the template. 2328 */ 2329 public InboxStyle setSummaryText(CharSequence cs) { 2330 internalSetSummaryText(safeCharSequence(cs)); 2331 return this; 2332 } 2333 2334 /** 2335 * Append a line to the digest section of the Inbox notification. 2336 */ 2337 public InboxStyle addLine(CharSequence cs) { 2338 mTexts.add(safeCharSequence(cs)); 2339 return this; 2340 } 2341 2342 /** 2343 * @hide 2344 */ 2345 public void addExtras(Bundle extras) { 2346 super.addExtras(extras); 2347 CharSequence[] a = new CharSequence[mTexts.size()]; 2348 extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a)); 2349 } 2350 2351 private RemoteViews makeBigContentView() { 2352 // Remove the content text so line3 disappears unless you have a summary 2353 mBuilder.mContentText = null; 2354 RemoteViews contentView = getStandardView(R.layout.notification_template_inbox); 2355 2356 contentView.setViewVisibility(R.id.text2, View.GONE); 2357 2358 int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3, 2359 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6}; 2360 2361 // Make sure all rows are gone in case we reuse a view. 2362 for (int rowId : rowIds) { 2363 contentView.setViewVisibility(rowId, View.GONE); 2364 } 2365 2366 2367 int i=0; 2368 while (i < mTexts.size() && i < rowIds.length) { 2369 CharSequence str = mTexts.get(i); 2370 if (str != null && !str.equals("")) { 2371 contentView.setViewVisibility(rowIds[i], View.VISIBLE); 2372 contentView.setTextViewText(rowIds[i], str); 2373 } 2374 i++; 2375 } 2376 2377 contentView.setViewVisibility(R.id.inbox_end_pad, 2378 mTexts.size() > 0 ? View.VISIBLE : View.GONE); 2379 2380 contentView.setViewVisibility(R.id.inbox_more, 2381 mTexts.size() > rowIds.length ? View.VISIBLE : View.GONE); 2382 2383 return contentView; 2384 } 2385 2386 /** 2387 * @hide 2388 */ 2389 @Override 2390 public Notification buildStyled(Notification wip) { 2391 wip.bigContentView = makeBigContentView(); 2392 2393 return wip; 2394 } 2395 } 2396} 2397