Notification.java revision 85d0e6edd20f6dab6d25f9f475ee462bef85ba98
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 static com.android.internal.util.NotificationColorUtil.satisfiesTextContrast;
20
21import android.annotation.ColorInt;
22import android.annotation.DrawableRes;
23import android.annotation.IntDef;
24import android.annotation.NonNull;
25import android.annotation.Nullable;
26import android.annotation.RequiresPermission;
27import android.annotation.SdkConstant;
28import android.annotation.SdkConstant.SdkConstantType;
29import android.annotation.SystemApi;
30import android.content.Context;
31import android.content.Intent;
32import android.content.pm.ApplicationInfo;
33import android.content.pm.PackageManager;
34import android.content.pm.PackageManager.NameNotFoundException;
35import android.content.pm.ShortcutInfo;
36import android.content.res.ColorStateList;
37import android.content.res.Configuration;
38import android.content.res.Resources;
39import android.graphics.Bitmap;
40import android.graphics.Canvas;
41import android.graphics.Color;
42import android.graphics.PorterDuff;
43import android.graphics.drawable.Drawable;
44import android.graphics.drawable.Icon;
45import android.media.AudioAttributes;
46import android.media.AudioManager;
47import android.media.PlayerBase;
48import android.media.session.MediaSession;
49import android.net.Uri;
50import android.os.BadParcelableException;
51import android.os.Build;
52import android.os.Bundle;
53import android.os.IBinder;
54import android.os.Parcel;
55import android.os.Parcelable;
56import android.os.SystemClock;
57import android.os.SystemProperties;
58import android.os.UserHandle;
59import android.text.BidiFormatter;
60import android.text.SpannableStringBuilder;
61import android.text.Spanned;
62import android.text.TextUtils;
63import android.text.style.AbsoluteSizeSpan;
64import android.text.style.CharacterStyle;
65import android.text.style.ForegroundColorSpan;
66import android.text.style.RelativeSizeSpan;
67import android.text.style.TextAppearanceSpan;
68import android.util.ArraySet;
69import android.util.Log;
70import android.util.SparseArray;
71import android.util.proto.ProtoOutputStream;
72import android.view.Gravity;
73import android.view.NotificationHeaderView;
74import android.view.View;
75import android.view.ViewGroup;
76import android.widget.ProgressBar;
77import android.widget.RemoteViews;
78
79import com.android.internal.R;
80import com.android.internal.annotations.VisibleForTesting;
81import com.android.internal.util.ArrayUtils;
82import com.android.internal.util.NotificationColorUtil;
83import com.android.internal.util.Preconditions;
84
85import java.lang.annotation.Retention;
86import java.lang.annotation.RetentionPolicy;
87import java.lang.reflect.Constructor;
88import java.util.ArrayList;
89import java.util.Arrays;
90import java.util.Collections;
91import java.util.List;
92import java.util.Objects;
93import java.util.Set;
94
95/**
96 * A class that represents how a persistent notification is to be presented to
97 * the user using the {@link android.app.NotificationManager}.
98 *
99 * <p>The {@link Notification.Builder Notification.Builder} has been added to make it
100 * easier to construct Notifications.</p>
101 *
102 * <div class="special reference">
103 * <h3>Developer Guides</h3>
104 * <p>For a guide to creating notifications, read the
105 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Status Bar Notifications</a>
106 * developer guide.</p>
107 * </div>
108 */
109public class Notification implements Parcelable
110{
111    private static final String TAG = "Notification";
112
113    /**
114     * An activity that provides a user interface for adjusting notification preferences for its
115     * containing application.
116     */
117    @SdkConstant(SdkConstantType.INTENT_CATEGORY)
118    public static final String INTENT_CATEGORY_NOTIFICATION_PREFERENCES
119            = "android.intent.category.NOTIFICATION_PREFERENCES";
120
121    /**
122     * Optional extra for {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}. If provided, will
123     * contain a {@link NotificationChannel#getId() channel id} that can be used to narrow down
124     * what settings should be shown in the target app.
125     */
126    public static final String EXTRA_CHANNEL_ID = "android.intent.extra.CHANNEL_ID";
127
128    /**
129     * Optional extra for {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}. If provided, will
130     * contain a {@link NotificationChannelGroup#getId() group id} that can be used to narrow down
131     * what settings should be shown in the target app.
132     */
133    public static final String EXTRA_CHANNEL_GROUP_ID = "android.intent.extra.CHANNEL_GROUP_ID";
134
135    /**
136     * Optional extra for {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}. If provided, will
137     * contain the tag provided to {@link NotificationManager#notify(String, int, Notification)}
138     * that can be used to narrow down what settings should be shown in the target app.
139     */
140    public static final String EXTRA_NOTIFICATION_TAG = "android.intent.extra.NOTIFICATION_TAG";
141
142    /**
143     * Optional extra for {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}. If provided, will
144     * contain the id provided to {@link NotificationManager#notify(String, int, Notification)}
145     * that can be used to narrow down what settings should be shown in the target app.
146     */
147    public static final String EXTRA_NOTIFICATION_ID = "android.intent.extra.NOTIFICATION_ID";
148
149    /**
150     * Use all default values (where applicable).
151     */
152    public static final int DEFAULT_ALL = ~0;
153
154    /**
155     * Use the default notification sound. This will ignore any given
156     * {@link #sound}.
157     *
158     * <p>
159     * A notification that is noisy is more likely to be presented as a heads-up notification.
160     * </p>
161     *
162     * @see #defaults
163     */
164
165    public static final int DEFAULT_SOUND = 1;
166
167    /**
168     * Use the default notification vibrate. This will ignore any given
169     * {@link #vibrate}. Using phone vibration requires the
170     * {@link android.Manifest.permission#VIBRATE VIBRATE} permission.
171     *
172     * <p>
173     * A notification that vibrates is more likely to be presented as a heads-up notification.
174     * </p>
175     *
176     * @see #defaults
177     */
178
179    public static final int DEFAULT_VIBRATE = 2;
180
181    /**
182     * Use the default notification lights. This will ignore the
183     * {@link #FLAG_SHOW_LIGHTS} bit, and {@link #ledARGB}, {@link #ledOffMS}, or
184     * {@link #ledOnMS}.
185     *
186     * @see #defaults
187     */
188
189    public static final int DEFAULT_LIGHTS = 4;
190
191    /**
192     * Maximum length of CharSequences accepted by Builder and friends.
193     *
194     * <p>
195     * Avoids spamming the system with overly large strings such as full e-mails.
196     */
197    private static final int MAX_CHARSEQUENCE_LENGTH = 5 * 1024;
198
199    /**
200     * Maximum entries of reply text that are accepted by Builder and friends.
201     */
202    private static final int MAX_REPLY_HISTORY = 5;
203
204
205    /**
206     * If the notification contained an unsent draft for a RemoteInput when the user clicked on it,
207     * we're adding the draft as a String extra to the {@link #contentIntent} using this key.
208     *
209     * <p>Apps may use this extra to prepopulate text fields in the app, where the user usually
210     * sends messages.</p>
211     */
212    public static final String EXTRA_REMOTE_INPUT_DRAFT = "android.remoteInputDraft";
213
214    /**
215     * A timestamp related to this notification, in milliseconds since the epoch.
216     *
217     * Default value: {@link System#currentTimeMillis() Now}.
218     *
219     * Choose a timestamp that will be most relevant to the user. For most finite events, this
220     * corresponds to the time the event happened (or will happen, in the case of events that have
221     * yet to occur but about which the user is being informed). Indefinite events should be
222     * timestamped according to when the activity began.
223     *
224     * Some examples:
225     *
226     * <ul>
227     *   <li>Notification of a new chat message should be stamped when the message was received.</li>
228     *   <li>Notification of an ongoing file download (with a progress bar, for example) should be stamped when the download started.</li>
229     *   <li>Notification of a completed file download should be stamped when the download finished.</li>
230     *   <li>Notification of an upcoming meeting should be stamped with the time the meeting will begin (that is, in the future).</li>
231     *   <li>Notification of an ongoing stopwatch (increasing timer) should be stamped with the watch's start time.
232     *   <li>Notification of an ongoing countdown timer should be stamped with the timer's end time.
233     * </ul>
234     *
235     * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not shown
236     * anymore by default and must be opted into by using
237     * {@link android.app.Notification.Builder#setShowWhen(boolean)}
238     */
239    public long when;
240
241    /**
242     * The creation time of the notification
243     */
244    private long creationTime;
245
246    /**
247     * The resource id of a drawable to use as the icon in the status bar.
248     *
249     * @deprecated Use {@link Builder#setSmallIcon(Icon)} instead.
250     */
251    @Deprecated
252    @DrawableRes
253    public int icon;
254
255    /**
256     * If the icon in the status bar is to have more than one level, you can set this.  Otherwise,
257     * leave it at its default value of 0.
258     *
259     * @see android.widget.ImageView#setImageLevel
260     * @see android.graphics.drawable.Drawable#setLevel
261     */
262    public int iconLevel;
263
264    /**
265     * The number of events that this notification represents. For example, in a new mail
266     * notification, this could be the number of unread messages.
267     *
268     * The system may or may not use this field to modify the appearance of the notification.
269     * Starting with {@link android.os.Build.VERSION_CODES#O}, the number may be displayed as a
270     * badge icon in Launchers that support badging.
271     */
272    public int number = 0;
273
274    /**
275     * The intent to execute when the expanded status entry is clicked.  If
276     * this is an activity, it must include the
277     * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
278     * that you take care of task management as described in the
279     * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
280     * Stack</a> document.  In particular, make sure to read the notification section
281     * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html#HandlingNotifications">Handling
282     * Notifications</a> for the correct ways to launch an application from a
283     * notification.
284     */
285    public PendingIntent contentIntent;
286
287    /**
288     * The intent to execute when the notification is explicitly dismissed by the user, either with
289     * the "Clear All" button or by swiping it away individually.
290     *
291     * This probably shouldn't be launching an activity since several of those will be sent
292     * at the same time.
293     */
294    public PendingIntent deleteIntent;
295
296    /**
297     * An intent to launch instead of posting the notification to the status bar.
298     *
299     * <p>
300     * The system UI may choose to display a heads-up notification, instead of
301     * launching this intent, while the user is using the device.
302     * </p>
303     *
304     * @see Notification.Builder#setFullScreenIntent
305     */
306    public PendingIntent fullScreenIntent;
307
308    /**
309     * Text that summarizes this notification for accessibility services.
310     *
311     * As of the L release, this text is no longer shown on screen, but it is still useful to
312     * accessibility services (where it serves as an audible announcement of the notification's
313     * appearance).
314     *
315     * @see #tickerView
316     */
317    public CharSequence tickerText;
318
319    /**
320     * Formerly, a view showing the {@link #tickerText}.
321     *
322     * No longer displayed in the status bar as of API 21.
323     */
324    @Deprecated
325    public RemoteViews tickerView;
326
327    /**
328     * The view that will represent this notification in the notification list (which is pulled
329     * down from the status bar).
330     *
331     * As of N, this field may be null. The notification view is determined by the inputs
332     * to {@link Notification.Builder}; a custom RemoteViews can optionally be
333     * supplied with {@link Notification.Builder#setCustomContentView(RemoteViews)}.
334     */
335    @Deprecated
336    public RemoteViews contentView;
337
338    /**
339     * A large-format version of {@link #contentView}, giving the Notification an
340     * opportunity to show more detail. The system UI may choose to show this
341     * instead of the normal content view at its discretion.
342     *
343     * As of N, this field may be null. The expanded notification view is determined by the
344     * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
345     * supplied with {@link Notification.Builder#setCustomBigContentView(RemoteViews)}.
346     */
347    @Deprecated
348    public RemoteViews bigContentView;
349
350
351    /**
352     * A medium-format version of {@link #contentView}, providing the Notification an
353     * opportunity to add action buttons to contentView. At its discretion, the system UI may
354     * choose to show this as a heads-up notification, which will pop up so the user can see
355     * it without leaving their current activity.
356     *
357     * As of N, this field may be null. The heads-up notification view is determined by the
358     * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
359     * supplied with {@link Notification.Builder#setCustomHeadsUpContentView(RemoteViews)}.
360     */
361    @Deprecated
362    public RemoteViews headsUpContentView;
363
364    private boolean mUsesStandardHeader;
365
366    private static final ArraySet<Integer> STANDARD_LAYOUTS = new ArraySet<>();
367    static {
368        STANDARD_LAYOUTS.add(R.layout.notification_template_material_base);
369        STANDARD_LAYOUTS.add(R.layout.notification_template_material_big_base);
370        STANDARD_LAYOUTS.add(R.layout.notification_template_material_big_picture);
371        STANDARD_LAYOUTS.add(R.layout.notification_template_material_big_text);
372        STANDARD_LAYOUTS.add(R.layout.notification_template_material_inbox);
373        STANDARD_LAYOUTS.add(R.layout.notification_template_material_messaging);
374        STANDARD_LAYOUTS.add(R.layout.notification_template_material_media);
375        STANDARD_LAYOUTS.add(R.layout.notification_template_material_big_media);
376        STANDARD_LAYOUTS.add(R.layout.notification_template_ambient_header);
377        STANDARD_LAYOUTS.add(R.layout.notification_template_header);
378        STANDARD_LAYOUTS.add(R.layout.notification_template_material_ambient);
379    }
380
381    /**
382     * A large bitmap to be shown in the notification content area.
383     *
384     * @deprecated Use {@link Builder#setLargeIcon(Icon)} instead.
385     */
386    @Deprecated
387    public Bitmap largeIcon;
388
389    /**
390     * The sound to play.
391     *
392     * <p>
393     * A notification that is noisy is more likely to be presented as a heads-up notification.
394     * </p>
395     *
396     * <p>
397     * To play the default notification sound, see {@link #defaults}.
398     * </p>
399     * @deprecated use {@link NotificationChannel#getSound()}.
400     */
401    @Deprecated
402    public Uri sound;
403
404    /**
405     * Use this constant as the value for audioStreamType to request that
406     * the default stream type for notifications be used.  Currently the
407     * default stream type is {@link AudioManager#STREAM_NOTIFICATION}.
408     *
409     * @deprecated Use {@link NotificationChannel#getAudioAttributes()} instead.
410     */
411    @Deprecated
412    public static final int STREAM_DEFAULT = -1;
413
414    /**
415     * The audio stream type to use when playing the sound.
416     * Should be one of the STREAM_ constants from
417     * {@link android.media.AudioManager}.
418     *
419     * @deprecated Use {@link #audioAttributes} instead.
420     */
421    @Deprecated
422    public int audioStreamType = STREAM_DEFAULT;
423
424    /**
425     * The default value of {@link #audioAttributes}.
426     */
427    public static final AudioAttributes AUDIO_ATTRIBUTES_DEFAULT = new AudioAttributes.Builder()
428            .setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION)
429            .setUsage(AudioAttributes.USAGE_NOTIFICATION)
430            .build();
431
432    /**
433     * The {@link AudioAttributes audio attributes} to use when playing the sound.
434     *
435     * @deprecated use {@link NotificationChannel#getAudioAttributes()} instead.
436     */
437    @Deprecated
438    public AudioAttributes audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
439
440    /**
441     * The pattern with which to vibrate.
442     *
443     * <p>
444     * To vibrate the default pattern, see {@link #defaults}.
445     * </p>
446     *
447     * @see android.os.Vibrator#vibrate(long[],int)
448     * @deprecated use {@link NotificationChannel#getVibrationPattern()}.
449     */
450    @Deprecated
451    public long[] vibrate;
452
453    /**
454     * The color of the led.  The hardware will do its best approximation.
455     *
456     * @see #FLAG_SHOW_LIGHTS
457     * @see #flags
458     * @deprecated use {@link NotificationChannel#shouldShowLights()}.
459     */
460    @ColorInt
461    @Deprecated
462    public int ledARGB;
463
464    /**
465     * The number of milliseconds for the LED to be on while it's flashing.
466     * The hardware will do its best approximation.
467     *
468     * @see #FLAG_SHOW_LIGHTS
469     * @see #flags
470     * @deprecated use {@link NotificationChannel#shouldShowLights()}.
471     */
472    @Deprecated
473    public int ledOnMS;
474
475    /**
476     * The number of milliseconds for the LED to be off while it's flashing.
477     * The hardware will do its best approximation.
478     *
479     * @see #FLAG_SHOW_LIGHTS
480     * @see #flags
481     *
482     * @deprecated use {@link NotificationChannel#shouldShowLights()}.
483     */
484    @Deprecated
485    public int ledOffMS;
486
487    /**
488     * Specifies which values should be taken from the defaults.
489     * <p>
490     * To set, OR the desired from {@link #DEFAULT_SOUND},
491     * {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}. For all default
492     * values, use {@link #DEFAULT_ALL}.
493     * </p>
494     *
495     * @deprecated use {@link NotificationChannel#getSound()} and
496     * {@link NotificationChannel#shouldShowLights()} and
497     * {@link NotificationChannel#shouldVibrate()}.
498     */
499    @Deprecated
500    public int defaults;
501
502    /**
503     * Bit to be bitwise-ored into the {@link #flags} field that should be
504     * set if you want the LED on for this notification.
505     * <ul>
506     * <li>To turn the LED off, pass 0 in the alpha channel for colorARGB
507     *      or 0 for both ledOnMS and ledOffMS.</li>
508     * <li>To turn the LED on, pass 1 for ledOnMS and 0 for ledOffMS.</li>
509     * <li>To flash the LED, pass the number of milliseconds that it should
510     *      be on and off to ledOnMS and ledOffMS.</li>
511     * </ul>
512     * <p>
513     * Since hardware varies, you are not guaranteed that any of the values
514     * you pass are honored exactly.  Use the system defaults if possible
515     * because they will be set to values that work on any given hardware.
516     * <p>
517     * The alpha channel must be set for forward compatibility.
518     *
519     * @deprecated use {@link NotificationChannel#shouldShowLights()}.
520     */
521    @Deprecated
522    public static final int FLAG_SHOW_LIGHTS        = 0x00000001;
523
524    /**
525     * Bit to be bitwise-ored into the {@link #flags} field that should be
526     * set if this notification is in reference to something that is ongoing,
527     * like a phone call.  It should not be set if this notification is in
528     * reference to something that happened at a particular point in time,
529     * like a missed phone call.
530     */
531    public static final int FLAG_ONGOING_EVENT      = 0x00000002;
532
533    /**
534     * Bit to be bitwise-ored into the {@link #flags} field that if set,
535     * the audio will be repeated until the notification is
536     * cancelled or the notification window is opened.
537     */
538    public static final int FLAG_INSISTENT          = 0x00000004;
539
540    /**
541     * Bit to be bitwise-ored into the {@link #flags} field that should be
542     * set if you would only like the sound, vibrate and ticker to be played
543     * if the notification was not already showing.
544     */
545    public static final int FLAG_ONLY_ALERT_ONCE    = 0x00000008;
546
547    /**
548     * Bit to be bitwise-ored into the {@link #flags} field that should be
549     * set if the notification should be canceled when it is clicked by the
550     * user.
551     */
552    public static final int FLAG_AUTO_CANCEL        = 0x00000010;
553
554    /**
555     * Bit to be bitwise-ored into the {@link #flags} field that should be
556     * set if the notification should not be canceled when the user clicks
557     * the Clear all button.
558     */
559    public static final int FLAG_NO_CLEAR           = 0x00000020;
560
561    /**
562     * Bit to be bitwise-ored into the {@link #flags} field that should be
563     * set if this notification represents a currently running service.  This
564     * will normally be set for you by {@link Service#startForeground}.
565     */
566    public static final int FLAG_FOREGROUND_SERVICE = 0x00000040;
567
568    /**
569     * Obsolete flag indicating high-priority notifications; use the priority field instead.
570     *
571     * @deprecated Use {@link #priority} with a positive value.
572     */
573    @Deprecated
574    public static final int FLAG_HIGH_PRIORITY      = 0x00000080;
575
576    /**
577     * Bit to be bitswise-ored into the {@link #flags} field that should be
578     * set if this notification is relevant to the current device only
579     * and it is not recommended that it bridge to other devices.
580     */
581    public static final int FLAG_LOCAL_ONLY         = 0x00000100;
582
583    /**
584     * Bit to be bitswise-ored into the {@link #flags} field that should be
585     * set if this notification is the group summary for a group of notifications.
586     * Grouped notifications may display in a cluster or stack on devices which
587     * support such rendering. Requires a group key also be set using {@link Builder#setGroup}.
588     */
589    public static final int FLAG_GROUP_SUMMARY      = 0x00000200;
590
591    /**
592     * Bit to be bitswise-ored into the {@link #flags} field that should be
593     * set if this notification is the group summary for an auto-group of notifications.
594     *
595     * @hide
596     */
597    @SystemApi
598    public static final int FLAG_AUTOGROUP_SUMMARY  = 0x00000400;
599
600    /**
601     * @hide
602     */
603    public static final int FLAG_CAN_COLORIZE = 0x00000800;
604
605    public int flags;
606
607    /** @hide */
608    @IntDef(prefix = { "PRIORITY_" }, value = {
609            PRIORITY_DEFAULT,
610            PRIORITY_LOW,
611            PRIORITY_MIN,
612            PRIORITY_HIGH,
613            PRIORITY_MAX
614    })
615    @Retention(RetentionPolicy.SOURCE)
616    public @interface Priority {}
617
618    /**
619     * Default notification {@link #priority}. If your application does not prioritize its own
620     * notifications, use this value for all notifications.
621     *
622     * @deprecated use {@link NotificationManager#IMPORTANCE_DEFAULT} instead.
623     */
624    @Deprecated
625    public static final int PRIORITY_DEFAULT = 0;
626
627    /**
628     * Lower {@link #priority}, for items that are less important. The UI may choose to show these
629     * items smaller, or at a different position in the list, compared with your app's
630     * {@link #PRIORITY_DEFAULT} items.
631     *
632     * @deprecated use {@link NotificationManager#IMPORTANCE_LOW} instead.
633     */
634    @Deprecated
635    public static final int PRIORITY_LOW = -1;
636
637    /**
638     * Lowest {@link #priority}; these items might not be shown to the user except under special
639     * circumstances, such as detailed notification logs.
640     *
641     * @deprecated use {@link NotificationManager#IMPORTANCE_MIN} instead.
642     */
643    @Deprecated
644    public static final int PRIORITY_MIN = -2;
645
646    /**
647     * Higher {@link #priority}, for more important notifications or alerts. The UI may choose to
648     * show these items larger, or at a different position in notification lists, compared with
649     * your app's {@link #PRIORITY_DEFAULT} items.
650     *
651     * @deprecated use {@link NotificationManager#IMPORTANCE_HIGH} instead.
652     */
653    @Deprecated
654    public static final int PRIORITY_HIGH = 1;
655
656    /**
657     * Highest {@link #priority}, for your application's most important items that require the
658     * user's prompt attention or input.
659     *
660     * @deprecated use {@link NotificationManager#IMPORTANCE_HIGH} instead.
661     */
662    @Deprecated
663    public static final int PRIORITY_MAX = 2;
664
665    /**
666     * Relative priority for this notification.
667     *
668     * Priority is an indication of how much of the user's valuable attention should be consumed by
669     * this notification. Low-priority notifications may be hidden from the user in certain
670     * situations, while the user might be interrupted for a higher-priority notification. The
671     * system will make a determination about how to interpret this priority when presenting
672     * the notification.
673     *
674     * <p>
675     * A notification that is at least {@link #PRIORITY_HIGH} is more likely to be presented
676     * as a heads-up notification.
677     * </p>
678     *
679     * @deprecated use {@link NotificationChannel#getImportance()} instead.
680     */
681    @Priority
682    @Deprecated
683    public int priority;
684
685    /**
686     * Accent color (an ARGB integer like the constants in {@link android.graphics.Color})
687     * to be applied by the standard Style templates when presenting this notification.
688     *
689     * The current template design constructs a colorful header image by overlaying the
690     * {@link #icon} image (stenciled in white) atop a field of this color. Alpha components are
691     * ignored.
692     */
693    @ColorInt
694    public int color = COLOR_DEFAULT;
695
696    /**
697     * Special value of {@link #color} telling the system not to decorate this notification with
698     * any special color but instead use default colors when presenting this notification.
699     */
700    @ColorInt
701    public static final int COLOR_DEFAULT = 0; // AKA Color.TRANSPARENT
702
703    /**
704     * Special value of {@link #color} used as a place holder for an invalid color.
705     * @hide
706     */
707    @ColorInt
708    public static final int COLOR_INVALID = 1;
709
710    /**
711     * Sphere of visibility of this notification, which affects how and when the SystemUI reveals
712     * the notification's presence and contents in untrusted situations (namely, on the secure
713     * lockscreen).
714     *
715     * The default level, {@link #VISIBILITY_PRIVATE}, behaves exactly as notifications have always
716     * done on Android: The notification's {@link #icon} and {@link #tickerText} (if available) are
717     * shown in all situations, but the contents are only available if the device is unlocked for
718     * the appropriate user.
719     *
720     * A more permissive policy can be expressed by {@link #VISIBILITY_PUBLIC}; such a notification
721     * can be read even in an "insecure" context (that is, above a secure lockscreen).
722     * To modify the public version of this notification—for example, to redact some portions—see
723     * {@link Builder#setPublicVersion(Notification)}.
724     *
725     * Finally, a notification can be made {@link #VISIBILITY_SECRET}, which will suppress its icon
726     * and ticker until the user has bypassed the lockscreen.
727     */
728    public @Visibility int visibility;
729
730    /** @hide */
731    @IntDef(prefix = { "VISIBILITY_" }, value = {
732            VISIBILITY_PUBLIC,
733            VISIBILITY_PRIVATE,
734            VISIBILITY_SECRET,
735    })
736    @Retention(RetentionPolicy.SOURCE)
737    public @interface Visibility {}
738
739    /**
740     * Notification visibility: Show this notification in its entirety on all lockscreens.
741     *
742     * {@see #visibility}
743     */
744    public static final int VISIBILITY_PUBLIC = 1;
745
746    /**
747     * Notification visibility: Show this notification on all lockscreens, but conceal sensitive or
748     * private information on secure lockscreens.
749     *
750     * {@see #visibility}
751     */
752    public static final int VISIBILITY_PRIVATE = 0;
753
754    /**
755     * Notification visibility: Do not reveal any part of this notification on a secure lockscreen.
756     *
757     * {@see #visibility}
758     */
759    public static final int VISIBILITY_SECRET = -1;
760
761    /**
762     * Notification category: incoming call (voice or video) or similar synchronous communication request.
763     */
764    public static final String CATEGORY_CALL = "call";
765
766    /**
767     * Notification category: map turn-by-turn navigation.
768     */
769    public static final String CATEGORY_NAVIGATION = "navigation";
770
771    /**
772     * Notification category: incoming direct message (SMS, instant message, etc.).
773     */
774    public static final String CATEGORY_MESSAGE = "msg";
775
776    /**
777     * Notification category: asynchronous bulk message (email).
778     */
779    public static final String CATEGORY_EMAIL = "email";
780
781    /**
782     * Notification category: calendar event.
783     */
784    public static final String CATEGORY_EVENT = "event";
785
786    /**
787     * Notification category: promotion or advertisement.
788     */
789    public static final String CATEGORY_PROMO = "promo";
790
791    /**
792     * Notification category: alarm or timer.
793     */
794    public static final String CATEGORY_ALARM = "alarm";
795
796    /**
797     * Notification category: progress of a long-running background operation.
798     */
799    public static final String CATEGORY_PROGRESS = "progress";
800
801    /**
802     * Notification category: social network or sharing update.
803     */
804    public static final String CATEGORY_SOCIAL = "social";
805
806    /**
807     * Notification category: error in background operation or authentication status.
808     */
809    public static final String CATEGORY_ERROR = "err";
810
811    /**
812     * Notification category: media transport control for playback.
813     */
814    public static final String CATEGORY_TRANSPORT = "transport";
815
816    /**
817     * Notification category: system or device status update.  Reserved for system use.
818     */
819    public static final String CATEGORY_SYSTEM = "sys";
820
821    /**
822     * Notification category: indication of running background service.
823     */
824    public static final String CATEGORY_SERVICE = "service";
825
826    /**
827     * Notification category: a specific, timely recommendation for a single thing.
828     * For example, a news app might want to recommend a news story it believes the user will
829     * want to read next.
830     */
831    public static final String CATEGORY_RECOMMENDATION = "recommendation";
832
833    /**
834     * Notification category: ongoing information about device or contextual status.
835     */
836    public static final String CATEGORY_STATUS = "status";
837
838    /**
839     * Notification category: user-scheduled reminder.
840     */
841    public static final String CATEGORY_REMINDER = "reminder";
842
843    /**
844     * Notification category: extreme car emergencies.
845     * @hide
846     */
847    @SystemApi
848    public static final String CATEGORY_CAR_EMERGENCY = "car_emergency";
849
850    /**
851     * Notification category: car warnings.
852     * @hide
853     */
854    @SystemApi
855    public static final String CATEGORY_CAR_WARNING = "car_warning";
856
857    /**
858     * Notification category: general car system information.
859     * @hide
860     */
861    @SystemApi
862    public static final String CATEGORY_CAR_INFORMATION = "car_information";
863
864    /**
865     * One of the predefined notification categories (see the <code>CATEGORY_*</code> constants)
866     * that best describes this Notification.  May be used by the system for ranking and filtering.
867     */
868    public String category;
869
870    private String mGroupKey;
871
872    /**
873     * Get the key used to group this notification into a cluster or stack
874     * with other notifications on devices which support such rendering.
875     */
876    public String getGroup() {
877        return mGroupKey;
878    }
879
880    private String mSortKey;
881
882    /**
883     * Get a sort key that orders this notification among other notifications from the
884     * same package. This can be useful if an external sort was already applied and an app
885     * would like to preserve this. Notifications will be sorted lexicographically using this
886     * value, although providing different priorities in addition to providing sort key may
887     * cause this value to be ignored.
888     *
889     * <p>This sort key can also be used to order members of a notification group. See
890     * {@link Builder#setGroup}.
891     *
892     * @see String#compareTo(String)
893     */
894    public String getSortKey() {
895        return mSortKey;
896    }
897
898    /**
899     * Additional semantic data to be carried around with this Notification.
900     * <p>
901     * The extras keys defined here are intended to capture the original inputs to {@link Builder}
902     * APIs, and are intended to be used by
903     * {@link android.service.notification.NotificationListenerService} implementations to extract
904     * detailed information from notification objects.
905     */
906    public Bundle extras = new Bundle();
907
908    /**
909     * All pending intents in the notification as the system needs to be able to access them but
910     * touching the extras bundle in the system process is not safe because the bundle may contain
911     * custom parcelable objects.
912     *
913     * @hide
914     */
915    public ArraySet<PendingIntent> allPendingIntents;
916
917    /**
918     * Token identifying the notification that is applying doze/bgcheck whitelisting to the
919     * pending intents inside of it, so only those will get the behavior.
920     *
921     * @hide
922     */
923    private IBinder mWhitelistToken;
924
925    /**
926     * Must be set by a process to start associating tokens with Notification objects
927     * coming in to it.  This is set by NotificationManagerService.
928     *
929     * @hide
930     */
931    static public IBinder processWhitelistToken;
932
933    /**
934     * {@link #extras} key: this is the title of the notification,
935     * as supplied to {@link Builder#setContentTitle(CharSequence)}.
936     */
937    public static final String EXTRA_TITLE = "android.title";
938
939    /**
940     * {@link #extras} key: this is the title of the notification when shown in expanded form,
941     * e.g. as supplied to {@link BigTextStyle#setBigContentTitle(CharSequence)}.
942     */
943    public static final String EXTRA_TITLE_BIG = EXTRA_TITLE + ".big";
944
945    /**
946     * {@link #extras} key: this is the main text payload, as supplied to
947     * {@link Builder#setContentText(CharSequence)}.
948     */
949    public static final String EXTRA_TEXT = "android.text";
950
951    /**
952     * {@link #extras} key: this is a third line of text, as supplied to
953     * {@link Builder#setSubText(CharSequence)}.
954     */
955    public static final String EXTRA_SUB_TEXT = "android.subText";
956
957    /**
958     * {@link #extras} key: this is the remote input history, as supplied to
959     * {@link Builder#setRemoteInputHistory(CharSequence[])}.
960     *
961     * Apps can fill this through {@link Builder#setRemoteInputHistory(CharSequence[])}
962     * with the most recent inputs that have been sent through a {@link RemoteInput} of this
963     * Notification and are expected to clear it once the it is no longer relevant (e.g. for chat
964     * notifications once the other party has responded).
965     *
966     * The extra with this key is of type CharSequence[] and contains the most recent entry at
967     * the 0 index, the second most recent at the 1 index, etc.
968     *
969     * @see Builder#setRemoteInputHistory(CharSequence[])
970     */
971    public static final String EXTRA_REMOTE_INPUT_HISTORY = "android.remoteInputHistory";
972
973    /**
974     * {@link #extras} key: this is a small piece of additional text as supplied to
975     * {@link Builder#setContentInfo(CharSequence)}.
976     */
977    public static final String EXTRA_INFO_TEXT = "android.infoText";
978
979    /**
980     * {@link #extras} key: this is a line of summary information intended to be shown
981     * alongside expanded notifications, as supplied to (e.g.)
982     * {@link BigTextStyle#setSummaryText(CharSequence)}.
983     */
984    public static final String EXTRA_SUMMARY_TEXT = "android.summaryText";
985
986    /**
987     * {@link #extras} key: this is the longer text shown in the big form of a
988     * {@link BigTextStyle} notification, as supplied to
989     * {@link BigTextStyle#bigText(CharSequence)}.
990     */
991    public static final String EXTRA_BIG_TEXT = "android.bigText";
992
993    /**
994     * {@link #extras} key: this is the resource ID of the notification's main small icon, as
995     * supplied to {@link Builder#setSmallIcon(int)}.
996     *
997     * @deprecated Use {@link #getSmallIcon()}, which supports a wider variety of icon sources.
998     */
999    @Deprecated
1000    public static final String EXTRA_SMALL_ICON = "android.icon";
1001
1002    /**
1003     * {@link #extras} key: this is a bitmap to be used instead of the small icon when showing the
1004     * notification payload, as
1005     * supplied to {@link Builder#setLargeIcon(android.graphics.Bitmap)}.
1006     *
1007     * @deprecated Use {@link #getLargeIcon()}, which supports a wider variety of icon sources.
1008     */
1009    @Deprecated
1010    public static final String EXTRA_LARGE_ICON = "android.largeIcon";
1011
1012    /**
1013     * {@link #extras} key: this is a bitmap to be used instead of the one from
1014     * {@link Builder#setLargeIcon(android.graphics.Bitmap)} when the notification is
1015     * shown in its expanded form, as supplied to
1016     * {@link BigPictureStyle#bigLargeIcon(android.graphics.Bitmap)}.
1017     */
1018    public static final String EXTRA_LARGE_ICON_BIG = EXTRA_LARGE_ICON + ".big";
1019
1020    /**
1021     * {@link #extras} key: this is the progress value supplied to
1022     * {@link Builder#setProgress(int, int, boolean)}.
1023     */
1024    public static final String EXTRA_PROGRESS = "android.progress";
1025
1026    /**
1027     * {@link #extras} key: this is the maximum value supplied to
1028     * {@link Builder#setProgress(int, int, boolean)}.
1029     */
1030    public static final String EXTRA_PROGRESS_MAX = "android.progressMax";
1031
1032    /**
1033     * {@link #extras} key: whether the progress bar is indeterminate, supplied to
1034     * {@link Builder#setProgress(int, int, boolean)}.
1035     */
1036    public static final String EXTRA_PROGRESS_INDETERMINATE = "android.progressIndeterminate";
1037
1038    /**
1039     * {@link #extras} key: whether {@link #when} should be shown as a count-up timer (specifically
1040     * a {@link android.widget.Chronometer}) instead of a timestamp, as supplied to
1041     * {@link Builder#setUsesChronometer(boolean)}.
1042     */
1043    public static final String EXTRA_SHOW_CHRONOMETER = "android.showChronometer";
1044
1045    /**
1046     * {@link #extras} key: whether the chronometer set on the notification should count down
1047     * instead of counting up. Is only relevant if key {@link #EXTRA_SHOW_CHRONOMETER} is present.
1048     * This extra is a boolean. The default is false.
1049     */
1050    public static final String EXTRA_CHRONOMETER_COUNT_DOWN = "android.chronometerCountDown";
1051
1052    /**
1053     * {@link #extras} key: whether {@link #when} should be shown,
1054     * as supplied to {@link Builder#setShowWhen(boolean)}.
1055     */
1056    public static final String EXTRA_SHOW_WHEN = "android.showWhen";
1057
1058    /**
1059     * {@link #extras} key: this is a bitmap to be shown in {@link BigPictureStyle} expanded
1060     * notifications, supplied to {@link BigPictureStyle#bigPicture(android.graphics.Bitmap)}.
1061     */
1062    public static final String EXTRA_PICTURE = "android.picture";
1063
1064    /**
1065     * {@link #extras} key: An array of CharSequences to show in {@link InboxStyle} expanded
1066     * notifications, each of which was supplied to {@link InboxStyle#addLine(CharSequence)}.
1067     */
1068    public static final String EXTRA_TEXT_LINES = "android.textLines";
1069
1070    /**
1071     * {@link #extras} key: A string representing the name of the specific
1072     * {@link android.app.Notification.Style} used to create this notification.
1073     */
1074    public static final String EXTRA_TEMPLATE = "android.template";
1075
1076    /**
1077     * {@link #extras} key: A String array containing the people that this notification relates to,
1078     * each of which was supplied to {@link Builder#addPerson(String)}.
1079     *
1080     * @deprecated the actual objects are now in {@link #EXTRA_PEOPLE_LIST}
1081     */
1082    public static final String EXTRA_PEOPLE = "android.people";
1083
1084    /**
1085     * {@link #extras} key: An arrayList of {@link Person} objects containing the people that
1086     * this notification relates to.
1087     */
1088    public static final String EXTRA_PEOPLE_LIST = "android.people.list";
1089
1090    /**
1091     * Allow certain system-generated notifications to appear before the device is provisioned.
1092     * Only available to notifications coming from the android package.
1093     * @hide
1094     */
1095    @SystemApi
1096    @RequiresPermission(android.Manifest.permission.NOTIFICATION_DURING_SETUP)
1097    public static final String EXTRA_ALLOW_DURING_SETUP = "android.allowDuringSetup";
1098
1099    /**
1100     * {@link #extras} key: A
1101     * {@link android.content.ContentUris content URI} pointing to an image that can be displayed
1102     * in the background when the notification is selected. Used on television platforms.
1103     * The URI must point to an image stream suitable for passing into
1104     * {@link android.graphics.BitmapFactory#decodeStream(java.io.InputStream)
1105     * BitmapFactory.decodeStream}; all other content types will be ignored.
1106     */
1107    public static final String EXTRA_BACKGROUND_IMAGE_URI = "android.backgroundImageUri";
1108
1109    /**
1110     * {@link #extras} key: A
1111     * {@link android.media.session.MediaSession.Token} associated with a
1112     * {@link android.app.Notification.MediaStyle} notification.
1113     */
1114    public static final String EXTRA_MEDIA_SESSION = "android.mediaSession";
1115
1116    /**
1117     * {@link #extras} key: the indices of actions to be shown in the compact view,
1118     * as supplied to (e.g.) {@link MediaStyle#setShowActionsInCompactView(int...)}.
1119     */
1120    public static final String EXTRA_COMPACT_ACTIONS = "android.compactActions";
1121
1122    /**
1123     * {@link #extras} key: the username to be displayed for all messages sent by the user including
1124     * direct replies
1125     * {@link android.app.Notification.MessagingStyle} notification. This extra is a
1126     * {@link CharSequence}
1127     *
1128     * @deprecated use {@link #EXTRA_MESSAGING_PERSON}
1129     */
1130    public static final String EXTRA_SELF_DISPLAY_NAME = "android.selfDisplayName";
1131
1132    /**
1133     * {@link #extras} key: the person to be displayed for all messages sent by the user including
1134     * direct replies
1135     * {@link android.app.Notification.MessagingStyle} notification. This extra is a
1136     * {@link Person}
1137     */
1138    public static final String EXTRA_MESSAGING_PERSON = "android.messagingUser";
1139
1140    /**
1141     * {@link #extras} key: a {@link CharSequence} to be displayed as the title to a conversation
1142     * represented by a {@link android.app.Notification.MessagingStyle}
1143     */
1144    public static final String EXTRA_CONVERSATION_TITLE = "android.conversationTitle";
1145
1146    /**
1147     * {@link #extras} key: an array of {@link android.app.Notification.MessagingStyle.Message}
1148     * bundles provided by a
1149     * {@link android.app.Notification.MessagingStyle} notification. This extra is a parcelable
1150     * array of bundles.
1151     */
1152    public static final String EXTRA_MESSAGES = "android.messages";
1153
1154    /**
1155     * {@link #extras} key: an array of
1156     * {@link android.app.Notification.MessagingStyle#addHistoricMessage historic}
1157     * {@link android.app.Notification.MessagingStyle.Message} bundles provided by a
1158     * {@link android.app.Notification.MessagingStyle} notification. This extra is a parcelable
1159     * array of bundles.
1160     */
1161    public static final String EXTRA_HISTORIC_MESSAGES = "android.messages.historic";
1162
1163    /**
1164     * {@link #extras} key: whether the {@link android.app.Notification.MessagingStyle} notification
1165     * represents a group conversation.
1166     */
1167    public static final String EXTRA_IS_GROUP_CONVERSATION = "android.isGroupConversation";
1168
1169    /**
1170     * {@link #extras} key: whether the notification should be colorized as
1171     * supplied to {@link Builder#setColorized(boolean)}}.
1172     */
1173    public static final String EXTRA_COLORIZED = "android.colorized";
1174
1175    /**
1176     * @hide
1177     */
1178    public static final String EXTRA_BUILDER_APPLICATION_INFO = "android.appInfo";
1179
1180    /**
1181     * @hide
1182     */
1183    public static final String EXTRA_CONTAINS_CUSTOM_VIEW = "android.contains.customView";
1184
1185    /**
1186     * @hide
1187     */
1188    public static final String EXTRA_REDUCED_IMAGES = "android.reduced.images";
1189
1190    /**
1191     * {@link #extras} key: the audio contents of this notification.
1192     *
1193     * This is for use when rendering the notification on an audio-focused interface;
1194     * the audio contents are a complete sound sample that contains the contents/body of the
1195     * notification. This may be used in substitute of a Text-to-Speech reading of the
1196     * notification. For example if the notification represents a voice message this should point
1197     * to the audio of that message.
1198     *
1199     * The data stored under this key should be a String representation of a Uri that contains the
1200     * audio contents in one of the following formats: WAV, PCM 16-bit, AMR-WB.
1201     *
1202     * This extra is unnecessary if you are using {@code MessagingStyle} since each {@code Message}
1203     * has a field for holding data URI. That field can be used for audio.
1204     * See {@code Message#setData}.
1205     *
1206     * Example usage:
1207     * <pre>
1208     * {@code
1209     * Notification.Builder myBuilder = (build your Notification as normal);
1210     * myBuilder.getExtras().putString(EXTRA_AUDIO_CONTENTS_URI, myAudioUri.toString());
1211     * }
1212     * </pre>
1213     */
1214    public static final String EXTRA_AUDIO_CONTENTS_URI = "android.audioContents";
1215
1216    /** @hide */
1217    @SystemApi
1218    @RequiresPermission(android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME)
1219    public static final String EXTRA_SUBSTITUTE_APP_NAME = "android.substName";
1220
1221    /**
1222     * This is set on the notification shown by the activity manager about all apps
1223     * running in the background.  It indicates that the notification should be shown
1224     * only if any of the given apps do not already have a {@link #FLAG_FOREGROUND_SERVICE}
1225     * notification currently visible to the user.  This is a string array of all
1226     * package names of the apps.
1227     * @hide
1228     */
1229    public static final String EXTRA_FOREGROUND_APPS = "android.foregroundApps";
1230
1231    private Icon mSmallIcon;
1232    private Icon mLargeIcon;
1233
1234    private String mChannelId;
1235    private long mTimeout;
1236
1237    private String mShortcutId;
1238    private CharSequence mSettingsText;
1239
1240    /** @hide */
1241    @IntDef(prefix = { "GROUP_ALERT_" }, value = {
1242            GROUP_ALERT_ALL, GROUP_ALERT_CHILDREN, GROUP_ALERT_SUMMARY
1243    })
1244    @Retention(RetentionPolicy.SOURCE)
1245    public @interface GroupAlertBehavior {}
1246
1247    /**
1248     * Constant for {@link Builder#setGroupAlertBehavior(int)}, meaning that all notifications in a
1249     * group with sound or vibration ought to make sound or vibrate (respectively), so this
1250     * notification will not be muted when it is in a group.
1251     */
1252    public static final int GROUP_ALERT_ALL = 0;
1253
1254    /**
1255     * Constant for {@link Builder#setGroupAlertBehavior(int)}, meaning that all children
1256     * notification in a group should be silenced (no sound or vibration) even if they are posted
1257     * to a {@link NotificationChannel} that has sound and/or vibration. Use this constant to
1258     * mute this notification if this notification is a group child. This must be applied to all
1259     * children notifications you want to mute.
1260     *
1261     * <p> For example, you might want to use this constant if you post a number of children
1262     * notifications at once (say, after a periodic sync), and only need to notify the user
1263     * audibly once.
1264     */
1265    public static final int GROUP_ALERT_SUMMARY = 1;
1266
1267    /**
1268     * Constant for {@link Builder#setGroupAlertBehavior(int)}, meaning that the summary
1269     * notification in a group should be silenced (no sound or vibration) even if they are
1270     * posted to a {@link NotificationChannel} that has sound and/or vibration. Use this constant
1271     * to mute this notification if this notification is a group summary.
1272     *
1273     * <p>For example, you might want to use this constant if only the children notifications
1274     * in your group have content and the summary is only used to visually group notifications
1275     * rather than to alert the user that new information is available.
1276     */
1277    public static final int GROUP_ALERT_CHILDREN = 2;
1278
1279    private int mGroupAlertBehavior = GROUP_ALERT_ALL;
1280
1281    /**
1282     * If this notification is being shown as a badge, always show as a number.
1283     */
1284    public static final int BADGE_ICON_NONE = 0;
1285
1286    /**
1287     * If this notification is being shown as a badge, use the {@link #getSmallIcon()} to
1288     * represent this notification.
1289     */
1290    public static final int BADGE_ICON_SMALL = 1;
1291
1292    /**
1293     * If this notification is being shown as a badge, use the {@link #getLargeIcon()} to
1294     * represent this notification.
1295     */
1296    public static final int BADGE_ICON_LARGE = 2;
1297    private int mBadgeIcon = BADGE_ICON_NONE;
1298
1299    /**
1300     * Structure to encapsulate a named action that can be shown as part of this notification.
1301     * It must include an icon, a label, and a {@link PendingIntent} to be fired when the action is
1302     * selected by the user.
1303     * <p>
1304     * Apps should use {@link Notification.Builder#addAction(int, CharSequence, PendingIntent)}
1305     * or {@link Notification.Builder#addAction(Notification.Action)}
1306     * to attach actions.
1307     */
1308    public static class Action implements Parcelable {
1309        /**
1310         * {@link #extras} key: Keys to a {@link Parcelable} {@link ArrayList} of
1311         * {@link RemoteInput}s.
1312         *
1313         * This is intended for {@link RemoteInput}s that only accept data, meaning
1314         * {@link RemoteInput#getAllowFreeFormInput} is false, {@link RemoteInput#getChoices}
1315         * is null or empty, and {@link RemoteInput#getAllowedDataTypes is non-null and not
1316         * empty. These {@link RemoteInput}s will be ignored by devices that do not
1317         * support non-text-based {@link RemoteInput}s. See {@link Builder#build}.
1318         *
1319         * You can test if a RemoteInput matches these constraints using
1320         * {@link RemoteInput#isDataOnly}.
1321         */
1322        private static final String EXTRA_DATA_ONLY_INPUTS = "android.extra.DATA_ONLY_INPUTS";
1323
1324        /**
1325         * {@link }: No semantic action defined.
1326         */
1327        public static final int SEMANTIC_ACTION_NONE = 0;
1328
1329        /**
1330         * {@code SemanticAction}: Reply to a conversation, chat, group, or wherever replies
1331         * may be appropriate.
1332         */
1333        public static final int SEMANTIC_ACTION_REPLY = 1;
1334
1335        /**
1336         * {@code SemanticAction}: Mark content as read.
1337         */
1338        public static final int SEMANTIC_ACTION_MARK_AS_READ = 2;
1339
1340        /**
1341         * {@code SemanticAction}: Mark content as unread.
1342         */
1343        public static final int SEMANTIC_ACTION_MARK_AS_UNREAD = 3;
1344
1345        /**
1346         * {@code SemanticAction}: Delete the content associated with the notification. This
1347         * could mean deleting an email, message, etc.
1348         */
1349        public static final int SEMANTIC_ACTION_DELETE = 4;
1350
1351        /**
1352         * {@code SemanticAction}: Archive the content associated with the notification. This
1353         * could mean archiving an email, message, etc.
1354         */
1355        public static final int SEMANTIC_ACTION_ARCHIVE = 5;
1356
1357        /**
1358         * {@code SemanticAction}: Mute the content associated with the notification. This could
1359         * mean silencing a conversation or currently playing media.
1360         */
1361        public static final int SEMANTIC_ACTION_MUTE = 6;
1362
1363        /**
1364         * {@code SemanticAction}: Unmute the content associated with the notification. This could
1365         * mean un-silencing a conversation or currently playing media.
1366         */
1367        public static final int SEMANTIC_ACTION_UNMUTE = 7;
1368
1369        /**
1370         * {@code SemanticAction}: Mark content with a thumbs up.
1371         */
1372        public static final int SEMANTIC_ACTION_THUMBS_UP = 8;
1373
1374        /**
1375         * {@code SemanticAction}: Mark content with a thumbs down.
1376         */
1377        public static final int SEMANTIC_ACTION_THUMBS_DOWN = 9;
1378
1379        /**
1380         * {@code SemanticAction}: Call a contact, group, etc.
1381         */
1382        public static final int SEMANTIC_ACTION_CALL = 10;
1383
1384        private final Bundle mExtras;
1385        private Icon mIcon;
1386        private final RemoteInput[] mRemoteInputs;
1387        private boolean mAllowGeneratedReplies = true;
1388        private final @SemanticAction int mSemanticAction;
1389
1390        /**
1391         * Small icon representing the action.
1392         *
1393         * @deprecated Use {@link Action#getIcon()} instead.
1394         */
1395        @Deprecated
1396        public int icon;
1397
1398        /**
1399         * Title of the action.
1400         */
1401        public CharSequence title;
1402
1403        /**
1404         * Intent to send when the user invokes this action. May be null, in which case the action
1405         * may be rendered in a disabled presentation by the system UI.
1406         */
1407        public PendingIntent actionIntent;
1408
1409        private Action(Parcel in) {
1410            if (in.readInt() != 0) {
1411                mIcon = Icon.CREATOR.createFromParcel(in);
1412                if (mIcon.getType() == Icon.TYPE_RESOURCE) {
1413                    icon = mIcon.getResId();
1414                }
1415            }
1416            title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
1417            if (in.readInt() == 1) {
1418                actionIntent = PendingIntent.CREATOR.createFromParcel(in);
1419            }
1420            mExtras = Bundle.setDefusable(in.readBundle(), true);
1421            mRemoteInputs = in.createTypedArray(RemoteInput.CREATOR);
1422            mAllowGeneratedReplies = in.readInt() == 1;
1423            mSemanticAction = in.readInt();
1424        }
1425
1426        /**
1427         * @deprecated Use {@link android.app.Notification.Action.Builder}.
1428         */
1429        @Deprecated
1430        public Action(int icon, CharSequence title, PendingIntent intent) {
1431            this(Icon.createWithResource("", icon), title, intent, new Bundle(), null, true,
1432                    SEMANTIC_ACTION_NONE);
1433        }
1434
1435        /** Keep in sync with {@link Notification.Action.Builder#Builder(Action)}! */
1436        private Action(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
1437                RemoteInput[] remoteInputs, boolean allowGeneratedReplies,
1438                       @SemanticAction int semanticAction) {
1439            this.mIcon = icon;
1440            if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
1441                this.icon = icon.getResId();
1442            }
1443            this.title = title;
1444            this.actionIntent = intent;
1445            this.mExtras = extras != null ? extras : new Bundle();
1446            this.mRemoteInputs = remoteInputs;
1447            this.mAllowGeneratedReplies = allowGeneratedReplies;
1448            this.mSemanticAction = semanticAction;
1449        }
1450
1451        /**
1452         * Return an icon representing the action.
1453         */
1454        public Icon getIcon() {
1455            if (mIcon == null && icon != 0) {
1456                // you snuck an icon in here without using the builder; let's try to keep it
1457                mIcon = Icon.createWithResource("", icon);
1458            }
1459            return mIcon;
1460        }
1461
1462        /**
1463         * Get additional metadata carried around with this Action.
1464         */
1465        public Bundle getExtras() {
1466            return mExtras;
1467        }
1468
1469        /**
1470         * Return whether the platform should automatically generate possible replies for this
1471         * {@link Action}
1472         */
1473        public boolean getAllowGeneratedReplies() {
1474            return mAllowGeneratedReplies;
1475        }
1476
1477        /**
1478         * Get the list of inputs to be collected from the user when this action is sent.
1479         * May return null if no remote inputs were added. Only returns inputs which accept
1480         * a text input. For inputs which only accept data use {@link #getDataOnlyRemoteInputs}.
1481         */
1482        public RemoteInput[] getRemoteInputs() {
1483            return mRemoteInputs;
1484        }
1485
1486        /**
1487         * Returns the {@code SemanticAction} associated with this {@link Action}. A
1488         * {@code SemanticAction} denotes what an {@link Action}'s {@link PendingIntent} will do
1489         * (eg. reply, mark as read, delete, etc).
1490         */
1491        public @SemanticAction int getSemanticAction() {
1492            return mSemanticAction;
1493        }
1494
1495        /**
1496         * Get the list of inputs to be collected from the user that ONLY accept data when this
1497         * action is sent. These remote inputs are guaranteed to return true on a call to
1498         * {@link RemoteInput#isDataOnly}.
1499         *
1500         * Returns null if there are no data-only remote inputs.
1501         *
1502         * This method exists so that legacy RemoteInput collectors that pre-date the addition
1503         * of non-textual RemoteInputs do not access these remote inputs.
1504         */
1505        public RemoteInput[] getDataOnlyRemoteInputs() {
1506            return (RemoteInput[]) mExtras.getParcelableArray(EXTRA_DATA_ONLY_INPUTS);
1507        }
1508
1509        /**
1510         * Builder class for {@link Action} objects.
1511         */
1512        public static final class Builder {
1513            private final Icon mIcon;
1514            private final CharSequence mTitle;
1515            private final PendingIntent mIntent;
1516            private boolean mAllowGeneratedReplies = true;
1517            private final Bundle mExtras;
1518            private ArrayList<RemoteInput> mRemoteInputs;
1519            private @SemanticAction int mSemanticAction;
1520
1521            /**
1522             * Construct a new builder for {@link Action} object.
1523             * @param icon icon to show for this action
1524             * @param title the title of the action
1525             * @param intent the {@link PendingIntent} to fire when users trigger this action
1526             */
1527            @Deprecated
1528            public Builder(int icon, CharSequence title, PendingIntent intent) {
1529                this(Icon.createWithResource("", icon), title, intent);
1530            }
1531
1532            /**
1533             * Construct a new builder for {@link Action} object.
1534             * @param icon icon to show for this action
1535             * @param title the title of the action
1536             * @param intent the {@link PendingIntent} to fire when users trigger this action
1537             */
1538            public Builder(Icon icon, CharSequence title, PendingIntent intent) {
1539                this(icon, title, intent, new Bundle(), null, true, SEMANTIC_ACTION_NONE);
1540            }
1541
1542            /**
1543             * Construct a new builder for {@link Action} object using the fields from an
1544             * {@link Action}.
1545             * @param action the action to read fields from.
1546             */
1547            public Builder(Action action) {
1548                this(action.getIcon(), action.title, action.actionIntent,
1549                        new Bundle(action.mExtras), action.getRemoteInputs(),
1550                        action.getAllowGeneratedReplies(), action.getSemanticAction());
1551            }
1552
1553            private Builder(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
1554                    RemoteInput[] remoteInputs, boolean allowGeneratedReplies,
1555                            @SemanticAction int semanticAction) {
1556                mIcon = icon;
1557                mTitle = title;
1558                mIntent = intent;
1559                mExtras = extras;
1560                if (remoteInputs != null) {
1561                    mRemoteInputs = new ArrayList<RemoteInput>(remoteInputs.length);
1562                    Collections.addAll(mRemoteInputs, remoteInputs);
1563                }
1564                mAllowGeneratedReplies = allowGeneratedReplies;
1565                mSemanticAction = semanticAction;
1566            }
1567
1568            /**
1569             * Merge additional metadata into this builder.
1570             *
1571             * <p>Values within the Bundle will replace existing extras values in this Builder.
1572             *
1573             * @see Notification.Action#extras
1574             */
1575            public Builder addExtras(Bundle extras) {
1576                if (extras != null) {
1577                    mExtras.putAll(extras);
1578                }
1579                return this;
1580            }
1581
1582            /**
1583             * Get the metadata Bundle used by this Builder.
1584             *
1585             * <p>The returned Bundle is shared with this Builder.
1586             */
1587            public Bundle getExtras() {
1588                return mExtras;
1589            }
1590
1591            /**
1592             * Add an input to be collected from the user when this action is sent.
1593             * Response values can be retrieved from the fired intent by using the
1594             * {@link RemoteInput#getResultsFromIntent} function.
1595             * @param remoteInput a {@link RemoteInput} to add to the action
1596             * @return this object for method chaining
1597             */
1598            public Builder addRemoteInput(RemoteInput remoteInput) {
1599                if (mRemoteInputs == null) {
1600                    mRemoteInputs = new ArrayList<RemoteInput>();
1601                }
1602                mRemoteInputs.add(remoteInput);
1603                return this;
1604            }
1605
1606            /**
1607             * Set whether the platform should automatically generate possible replies to add to
1608             * {@link RemoteInput#getChoices()}. If the {@link Action} doesn't have a
1609             * {@link RemoteInput}, this has no effect.
1610             * @param allowGeneratedReplies {@code true} to allow generated replies, {@code false}
1611             * otherwise
1612             * @return this object for method chaining
1613             * The default value is {@code true}
1614             */
1615            public Builder setAllowGeneratedReplies(boolean allowGeneratedReplies) {
1616                mAllowGeneratedReplies = allowGeneratedReplies;
1617                return this;
1618            }
1619
1620            /**
1621             * Sets the {@code SemanticAction} for this {@link Action}. A
1622             * {@code SemanticAction} denotes what an {@link Action}'s
1623             * {@link PendingIntent} will do (eg. reply, mark as read, delete, etc).
1624             * @param semanticAction a SemanticAction defined within {@link Action} with
1625             * {@code SEMANTIC_ACTION_} prefixes
1626             * @return this object for method chaining
1627             */
1628            public Builder setSemanticAction(@SemanticAction int semanticAction) {
1629                mSemanticAction = semanticAction;
1630                return this;
1631            }
1632
1633            /**
1634             * Apply an extender to this action builder. Extenders may be used to add
1635             * metadata or change options on this builder.
1636             */
1637            public Builder extend(Extender extender) {
1638                extender.extend(this);
1639                return this;
1640            }
1641
1642            /**
1643             * Combine all of the options that have been set and return a new {@link Action}
1644             * object.
1645             * @return the built action
1646             */
1647            public Action build() {
1648                ArrayList<RemoteInput> dataOnlyInputs = new ArrayList<>();
1649                RemoteInput[] previousDataInputs =
1650                    (RemoteInput[]) mExtras.getParcelableArray(EXTRA_DATA_ONLY_INPUTS);
1651                if (previousDataInputs != null) {
1652                    for (RemoteInput input : previousDataInputs) {
1653                        dataOnlyInputs.add(input);
1654                    }
1655                }
1656                List<RemoteInput> textInputs = new ArrayList<>();
1657                if (mRemoteInputs != null) {
1658                    for (RemoteInput input : mRemoteInputs) {
1659                        if (input.isDataOnly()) {
1660                            dataOnlyInputs.add(input);
1661                        } else {
1662                            textInputs.add(input);
1663                        }
1664                    }
1665                }
1666                if (!dataOnlyInputs.isEmpty()) {
1667                    RemoteInput[] dataInputsArr =
1668                            dataOnlyInputs.toArray(new RemoteInput[dataOnlyInputs.size()]);
1669                    mExtras.putParcelableArray(EXTRA_DATA_ONLY_INPUTS, dataInputsArr);
1670                }
1671                RemoteInput[] textInputsArr = textInputs.isEmpty()
1672                        ? null : textInputs.toArray(new RemoteInput[textInputs.size()]);
1673                return new Action(mIcon, mTitle, mIntent, mExtras, textInputsArr,
1674                        mAllowGeneratedReplies, mSemanticAction);
1675            }
1676        }
1677
1678        @Override
1679        public Action clone() {
1680            return new Action(
1681                    getIcon(),
1682                    title,
1683                    actionIntent, // safe to alias
1684                    mExtras == null ? new Bundle() : new Bundle(mExtras),
1685                    getRemoteInputs(),
1686                    getAllowGeneratedReplies(),
1687                    getSemanticAction());
1688        }
1689
1690        @Override
1691        public int describeContents() {
1692            return 0;
1693        }
1694
1695        @Override
1696        public void writeToParcel(Parcel out, int flags) {
1697            final Icon ic = getIcon();
1698            if (ic != null) {
1699                out.writeInt(1);
1700                ic.writeToParcel(out, 0);
1701            } else {
1702                out.writeInt(0);
1703            }
1704            TextUtils.writeToParcel(title, out, flags);
1705            if (actionIntent != null) {
1706                out.writeInt(1);
1707                actionIntent.writeToParcel(out, flags);
1708            } else {
1709                out.writeInt(0);
1710            }
1711            out.writeBundle(mExtras);
1712            out.writeTypedArray(mRemoteInputs, flags);
1713            out.writeInt(mAllowGeneratedReplies ? 1 : 0);
1714            out.writeInt(mSemanticAction);
1715        }
1716
1717        public static final Parcelable.Creator<Action> CREATOR =
1718                new Parcelable.Creator<Action>() {
1719            public Action createFromParcel(Parcel in) {
1720                return new Action(in);
1721            }
1722            public Action[] newArray(int size) {
1723                return new Action[size];
1724            }
1725        };
1726
1727        /**
1728         * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
1729         * metadata or change options on an action builder.
1730         */
1731        public interface Extender {
1732            /**
1733             * Apply this extender to a notification action builder.
1734             * @param builder the builder to be modified.
1735             * @return the build object for chaining.
1736             */
1737            public Builder extend(Builder builder);
1738        }
1739
1740        /**
1741         * Wearable extender for notification actions. To add extensions to an action,
1742         * create a new {@link android.app.Notification.Action.WearableExtender} object using
1743         * the {@code WearableExtender()} constructor and apply it to a
1744         * {@link android.app.Notification.Action.Builder} using
1745         * {@link android.app.Notification.Action.Builder#extend}.
1746         *
1747         * <pre class="prettyprint">
1748         * Notification.Action action = new Notification.Action.Builder(
1749         *         R.drawable.archive_all, "Archive all", actionIntent)
1750         *         .extend(new Notification.Action.WearableExtender()
1751         *                 .setAvailableOffline(false))
1752         *         .build();</pre>
1753         */
1754        public static final class WearableExtender implements Extender {
1755            /** Notification action extra which contains wearable extensions */
1756            private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
1757
1758            // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
1759            private static final String KEY_FLAGS = "flags";
1760            private static final String KEY_IN_PROGRESS_LABEL = "inProgressLabel";
1761            private static final String KEY_CONFIRM_LABEL = "confirmLabel";
1762            private static final String KEY_CANCEL_LABEL = "cancelLabel";
1763
1764            // Flags bitwise-ored to mFlags
1765            private static final int FLAG_AVAILABLE_OFFLINE = 0x1;
1766            private static final int FLAG_HINT_LAUNCHES_ACTIVITY = 1 << 1;
1767            private static final int FLAG_HINT_DISPLAY_INLINE = 1 << 2;
1768
1769            // Default value for flags integer
1770            private static final int DEFAULT_FLAGS = FLAG_AVAILABLE_OFFLINE;
1771
1772            private int mFlags = DEFAULT_FLAGS;
1773
1774            private CharSequence mInProgressLabel;
1775            private CharSequence mConfirmLabel;
1776            private CharSequence mCancelLabel;
1777
1778            /**
1779             * Create a {@link android.app.Notification.Action.WearableExtender} with default
1780             * options.
1781             */
1782            public WearableExtender() {
1783            }
1784
1785            /**
1786             * Create a {@link android.app.Notification.Action.WearableExtender} by reading
1787             * wearable options present in an existing notification action.
1788             * @param action the notification action to inspect.
1789             */
1790            public WearableExtender(Action action) {
1791                Bundle wearableBundle = action.getExtras().getBundle(EXTRA_WEARABLE_EXTENSIONS);
1792                if (wearableBundle != null) {
1793                    mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
1794                    mInProgressLabel = wearableBundle.getCharSequence(KEY_IN_PROGRESS_LABEL);
1795                    mConfirmLabel = wearableBundle.getCharSequence(KEY_CONFIRM_LABEL);
1796                    mCancelLabel = wearableBundle.getCharSequence(KEY_CANCEL_LABEL);
1797                }
1798            }
1799
1800            /**
1801             * Apply wearable extensions to a notification action that is being built. This is
1802             * typically called by the {@link android.app.Notification.Action.Builder#extend}
1803             * method of {@link android.app.Notification.Action.Builder}.
1804             */
1805            @Override
1806            public Action.Builder extend(Action.Builder builder) {
1807                Bundle wearableBundle = new Bundle();
1808
1809                if (mFlags != DEFAULT_FLAGS) {
1810                    wearableBundle.putInt(KEY_FLAGS, mFlags);
1811                }
1812                if (mInProgressLabel != null) {
1813                    wearableBundle.putCharSequence(KEY_IN_PROGRESS_LABEL, mInProgressLabel);
1814                }
1815                if (mConfirmLabel != null) {
1816                    wearableBundle.putCharSequence(KEY_CONFIRM_LABEL, mConfirmLabel);
1817                }
1818                if (mCancelLabel != null) {
1819                    wearableBundle.putCharSequence(KEY_CANCEL_LABEL, mCancelLabel);
1820                }
1821
1822                builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
1823                return builder;
1824            }
1825
1826            @Override
1827            public WearableExtender clone() {
1828                WearableExtender that = new WearableExtender();
1829                that.mFlags = this.mFlags;
1830                that.mInProgressLabel = this.mInProgressLabel;
1831                that.mConfirmLabel = this.mConfirmLabel;
1832                that.mCancelLabel = this.mCancelLabel;
1833                return that;
1834            }
1835
1836            /**
1837             * Set whether this action is available when the wearable device is not connected to
1838             * a companion device. The user can still trigger this action when the wearable device is
1839             * offline, but a visual hint will indicate that the action may not be available.
1840             * Defaults to true.
1841             */
1842            public WearableExtender setAvailableOffline(boolean availableOffline) {
1843                setFlag(FLAG_AVAILABLE_OFFLINE, availableOffline);
1844                return this;
1845            }
1846
1847            /**
1848             * Get whether this action is available when the wearable device is not connected to
1849             * a companion device. The user can still trigger this action when the wearable device is
1850             * offline, but a visual hint will indicate that the action may not be available.
1851             * Defaults to true.
1852             */
1853            public boolean isAvailableOffline() {
1854                return (mFlags & FLAG_AVAILABLE_OFFLINE) != 0;
1855            }
1856
1857            private void setFlag(int mask, boolean value) {
1858                if (value) {
1859                    mFlags |= mask;
1860                } else {
1861                    mFlags &= ~mask;
1862                }
1863            }
1864
1865            /**
1866             * Set a label to display while the wearable is preparing to automatically execute the
1867             * action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1868             *
1869             * @param label the label to display while the action is being prepared to execute
1870             * @return this object for method chaining
1871             */
1872            @Deprecated
1873            public WearableExtender setInProgressLabel(CharSequence label) {
1874                mInProgressLabel = label;
1875                return this;
1876            }
1877
1878            /**
1879             * Get the label to display while the wearable is preparing to automatically execute
1880             * the action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1881             *
1882             * @return the label to display while the action is being prepared to execute
1883             */
1884            @Deprecated
1885            public CharSequence getInProgressLabel() {
1886                return mInProgressLabel;
1887            }
1888
1889            /**
1890             * Set a label to display to confirm that the action should be executed.
1891             * This is usually an imperative verb like "Send".
1892             *
1893             * @param label the label to confirm the action should be executed
1894             * @return this object for method chaining
1895             */
1896            @Deprecated
1897            public WearableExtender setConfirmLabel(CharSequence label) {
1898                mConfirmLabel = label;
1899                return this;
1900            }
1901
1902            /**
1903             * Get the label to display to confirm that the action should be executed.
1904             * This is usually an imperative verb like "Send".
1905             *
1906             * @return the label to confirm the action should be executed
1907             */
1908            @Deprecated
1909            public CharSequence getConfirmLabel() {
1910                return mConfirmLabel;
1911            }
1912
1913            /**
1914             * Set a label to display to cancel the action.
1915             * This is usually an imperative verb, like "Cancel".
1916             *
1917             * @param label the label to display to cancel the action
1918             * @return this object for method chaining
1919             */
1920            @Deprecated
1921            public WearableExtender setCancelLabel(CharSequence label) {
1922                mCancelLabel = label;
1923                return this;
1924            }
1925
1926            /**
1927             * Get the label to display to cancel the action.
1928             * This is usually an imperative verb like "Cancel".
1929             *
1930             * @return the label to display to cancel the action
1931             */
1932            @Deprecated
1933            public CharSequence getCancelLabel() {
1934                return mCancelLabel;
1935            }
1936
1937            /**
1938             * Set a hint that this Action will launch an {@link Activity} directly, telling the
1939             * platform that it can generate the appropriate transitions.
1940             * @param hintLaunchesActivity {@code true} if the content intent will launch
1941             * an activity and transitions should be generated, false otherwise.
1942             * @return this object for method chaining
1943             */
1944            public WearableExtender setHintLaunchesActivity(
1945                    boolean hintLaunchesActivity) {
1946                setFlag(FLAG_HINT_LAUNCHES_ACTIVITY, hintLaunchesActivity);
1947                return this;
1948            }
1949
1950            /**
1951             * Get a hint that this Action will launch an {@link Activity} directly, telling the
1952             * platform that it can generate the appropriate transitions
1953             * @return {@code true} if the content intent will launch an activity and transitions
1954             * should be generated, false otherwise. The default value is {@code false} if this was
1955             * never set.
1956             */
1957            public boolean getHintLaunchesActivity() {
1958                return (mFlags & FLAG_HINT_LAUNCHES_ACTIVITY) != 0;
1959            }
1960
1961            /**
1962             * Set a hint that this Action should be displayed inline.
1963             *
1964             * @param hintDisplayInline {@code true} if action should be displayed inline, false
1965             *        otherwise
1966             * @return this object for method chaining
1967             */
1968            public WearableExtender setHintDisplayActionInline(
1969                    boolean hintDisplayInline) {
1970                setFlag(FLAG_HINT_DISPLAY_INLINE, hintDisplayInline);
1971                return this;
1972            }
1973
1974            /**
1975             * Get a hint that this Action should be displayed inline.
1976             *
1977             * @return {@code true} if the Action should be displayed inline, {@code false}
1978             *         otherwise. The default value is {@code false} if this was never set.
1979             */
1980            public boolean getHintDisplayActionInline() {
1981                return (mFlags & FLAG_HINT_DISPLAY_INLINE) != 0;
1982            }
1983        }
1984
1985        /**
1986         * Provides meaning to an {@link Action} that hints at what the associated
1987         * {@link PendingIntent} will do. For example, an {@link Action} with a
1988         * {@link PendingIntent} that replies to a text message notification may have the
1989         * {@link #SEMANTIC_ACTION_REPLY} {@code SemanticAction} set within it.
1990         *
1991         * @hide
1992         */
1993        @IntDef(prefix = { "SEMANTIC_ACTION_" }, value = {
1994                SEMANTIC_ACTION_NONE,
1995                SEMANTIC_ACTION_REPLY,
1996                SEMANTIC_ACTION_MARK_AS_READ,
1997                SEMANTIC_ACTION_MARK_AS_UNREAD,
1998                SEMANTIC_ACTION_DELETE,
1999                SEMANTIC_ACTION_ARCHIVE,
2000                SEMANTIC_ACTION_MUTE,
2001                SEMANTIC_ACTION_UNMUTE,
2002                SEMANTIC_ACTION_THUMBS_UP,
2003                SEMANTIC_ACTION_THUMBS_DOWN,
2004                SEMANTIC_ACTION_CALL
2005        })
2006        @Retention(RetentionPolicy.SOURCE)
2007        public @interface SemanticAction {}
2008    }
2009
2010    /**
2011     * Array of all {@link Action} structures attached to this notification by
2012     * {@link Builder#addAction(int, CharSequence, PendingIntent)}. Mostly useful for instances of
2013     * {@link android.service.notification.NotificationListenerService} that provide an alternative
2014     * interface for invoking actions.
2015     */
2016    public Action[] actions;
2017
2018    /**
2019     * Replacement version of this notification whose content will be shown
2020     * in an insecure context such as atop a secure keyguard. See {@link #visibility}
2021     * and {@link #VISIBILITY_PUBLIC}.
2022     */
2023    public Notification publicVersion;
2024
2025    /**
2026     * Constructs a Notification object with default values.
2027     * You might want to consider using {@link Builder} instead.
2028     */
2029    public Notification()
2030    {
2031        this.when = System.currentTimeMillis();
2032        this.creationTime = System.currentTimeMillis();
2033        this.priority = PRIORITY_DEFAULT;
2034    }
2035
2036    /**
2037     * @hide
2038     */
2039    public Notification(Context context, int icon, CharSequence tickerText, long when,
2040            CharSequence contentTitle, CharSequence contentText, Intent contentIntent)
2041    {
2042        new Builder(context)
2043                .setWhen(when)
2044                .setSmallIcon(icon)
2045                .setTicker(tickerText)
2046                .setContentTitle(contentTitle)
2047                .setContentText(contentText)
2048                .setContentIntent(PendingIntent.getActivity(context, 0, contentIntent, 0))
2049                .buildInto(this);
2050    }
2051
2052    /**
2053     * Constructs a Notification object with the information needed to
2054     * have a status bar icon without the standard expanded view.
2055     *
2056     * @param icon          The resource id of the icon to put in the status bar.
2057     * @param tickerText    The text that flows by in the status bar when the notification first
2058     *                      activates.
2059     * @param when          The time to show in the time field.  In the System.currentTimeMillis
2060     *                      timebase.
2061     *
2062     * @deprecated Use {@link Builder} instead.
2063     */
2064    @Deprecated
2065    public Notification(int icon, CharSequence tickerText, long when)
2066    {
2067        this.icon = icon;
2068        this.tickerText = tickerText;
2069        this.when = when;
2070        this.creationTime = System.currentTimeMillis();
2071    }
2072
2073    /**
2074     * Unflatten the notification from a parcel.
2075     */
2076    @SuppressWarnings("unchecked")
2077    public Notification(Parcel parcel) {
2078        // IMPORTANT: Add unmarshaling code in readFromParcel as the pending
2079        // intents in extras are always written as the last entry.
2080        readFromParcelImpl(parcel);
2081        // Must be read last!
2082        allPendingIntents = (ArraySet<PendingIntent>) parcel.readArraySet(null);
2083    }
2084
2085    private void readFromParcelImpl(Parcel parcel)
2086    {
2087        int version = parcel.readInt();
2088
2089        mWhitelistToken = parcel.readStrongBinder();
2090        if (mWhitelistToken == null) {
2091            mWhitelistToken = processWhitelistToken;
2092        }
2093        // Propagate this token to all pending intents that are unmarshalled from the parcel.
2094        parcel.setClassCookie(PendingIntent.class, mWhitelistToken);
2095
2096        when = parcel.readLong();
2097        creationTime = parcel.readLong();
2098        if (parcel.readInt() != 0) {
2099            mSmallIcon = Icon.CREATOR.createFromParcel(parcel);
2100            if (mSmallIcon.getType() == Icon.TYPE_RESOURCE) {
2101                icon = mSmallIcon.getResId();
2102            }
2103        }
2104        number = parcel.readInt();
2105        if (parcel.readInt() != 0) {
2106            contentIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2107        }
2108        if (parcel.readInt() != 0) {
2109            deleteIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2110        }
2111        if (parcel.readInt() != 0) {
2112            tickerText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
2113        }
2114        if (parcel.readInt() != 0) {
2115            tickerView = RemoteViews.CREATOR.createFromParcel(parcel);
2116        }
2117        if (parcel.readInt() != 0) {
2118            contentView = RemoteViews.CREATOR.createFromParcel(parcel);
2119        }
2120        if (parcel.readInt() != 0) {
2121            mLargeIcon = Icon.CREATOR.createFromParcel(parcel);
2122        }
2123        defaults = parcel.readInt();
2124        flags = parcel.readInt();
2125        if (parcel.readInt() != 0) {
2126            sound = Uri.CREATOR.createFromParcel(parcel);
2127        }
2128
2129        audioStreamType = parcel.readInt();
2130        if (parcel.readInt() != 0) {
2131            audioAttributes = AudioAttributes.CREATOR.createFromParcel(parcel);
2132        }
2133        vibrate = parcel.createLongArray();
2134        ledARGB = parcel.readInt();
2135        ledOnMS = parcel.readInt();
2136        ledOffMS = parcel.readInt();
2137        iconLevel = parcel.readInt();
2138
2139        if (parcel.readInt() != 0) {
2140            fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2141        }
2142
2143        priority = parcel.readInt();
2144
2145        category = parcel.readString();
2146
2147        mGroupKey = parcel.readString();
2148
2149        mSortKey = parcel.readString();
2150
2151        extras = Bundle.setDefusable(parcel.readBundle(), true); // may be null
2152        fixDuplicateExtras();
2153
2154        actions = parcel.createTypedArray(Action.CREATOR); // may be null
2155
2156        if (parcel.readInt() != 0) {
2157            bigContentView = RemoteViews.CREATOR.createFromParcel(parcel);
2158        }
2159
2160        if (parcel.readInt() != 0) {
2161            headsUpContentView = RemoteViews.CREATOR.createFromParcel(parcel);
2162        }
2163
2164        visibility = parcel.readInt();
2165
2166        if (parcel.readInt() != 0) {
2167            publicVersion = Notification.CREATOR.createFromParcel(parcel);
2168        }
2169
2170        color = parcel.readInt();
2171
2172        if (parcel.readInt() != 0) {
2173            mChannelId = parcel.readString();
2174        }
2175        mTimeout = parcel.readLong();
2176
2177        if (parcel.readInt() != 0) {
2178            mShortcutId = parcel.readString();
2179        }
2180
2181        mBadgeIcon = parcel.readInt();
2182
2183        if (parcel.readInt() != 0) {
2184            mSettingsText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
2185        }
2186
2187        mGroupAlertBehavior = parcel.readInt();
2188    }
2189
2190    @Override
2191    public Notification clone() {
2192        Notification that = new Notification();
2193        cloneInto(that, true);
2194        return that;
2195    }
2196
2197    /**
2198     * Copy all (or if heavy is false, all except Bitmaps and RemoteViews) members
2199     * of this into that.
2200     * @hide
2201     */
2202    public void cloneInto(Notification that, boolean heavy) {
2203        that.mWhitelistToken = this.mWhitelistToken;
2204        that.when = this.when;
2205        that.creationTime = this.creationTime;
2206        that.mSmallIcon = this.mSmallIcon;
2207        that.number = this.number;
2208
2209        // PendingIntents are global, so there's no reason (or way) to clone them.
2210        that.contentIntent = this.contentIntent;
2211        that.deleteIntent = this.deleteIntent;
2212        that.fullScreenIntent = this.fullScreenIntent;
2213
2214        if (this.tickerText != null) {
2215            that.tickerText = this.tickerText.toString();
2216        }
2217        if (heavy && this.tickerView != null) {
2218            that.tickerView = this.tickerView.clone();
2219        }
2220        if (heavy && this.contentView != null) {
2221            that.contentView = this.contentView.clone();
2222        }
2223        if (heavy && this.mLargeIcon != null) {
2224            that.mLargeIcon = this.mLargeIcon;
2225        }
2226        that.iconLevel = this.iconLevel;
2227        that.sound = this.sound; // android.net.Uri is immutable
2228        that.audioStreamType = this.audioStreamType;
2229        if (this.audioAttributes != null) {
2230            that.audioAttributes = new AudioAttributes.Builder(this.audioAttributes).build();
2231        }
2232
2233        final long[] vibrate = this.vibrate;
2234        if (vibrate != null) {
2235            final int N = vibrate.length;
2236            final long[] vib = that.vibrate = new long[N];
2237            System.arraycopy(vibrate, 0, vib, 0, N);
2238        }
2239
2240        that.ledARGB = this.ledARGB;
2241        that.ledOnMS = this.ledOnMS;
2242        that.ledOffMS = this.ledOffMS;
2243        that.defaults = this.defaults;
2244
2245        that.flags = this.flags;
2246
2247        that.priority = this.priority;
2248
2249        that.category = this.category;
2250
2251        that.mGroupKey = this.mGroupKey;
2252
2253        that.mSortKey = this.mSortKey;
2254
2255        if (this.extras != null) {
2256            try {
2257                that.extras = new Bundle(this.extras);
2258                // will unparcel
2259                that.extras.size();
2260            } catch (BadParcelableException e) {
2261                Log.e(TAG, "could not unparcel extras from notification: " + this, e);
2262                that.extras = null;
2263            }
2264        }
2265
2266        if (!ArrayUtils.isEmpty(allPendingIntents)) {
2267            that.allPendingIntents = new ArraySet<>(allPendingIntents);
2268        }
2269
2270        if (this.actions != null) {
2271            that.actions = new Action[this.actions.length];
2272            for(int i=0; i<this.actions.length; i++) {
2273                if ( this.actions[i] != null) {
2274                    that.actions[i] = this.actions[i].clone();
2275                }
2276            }
2277        }
2278
2279        if (heavy && this.bigContentView != null) {
2280            that.bigContentView = this.bigContentView.clone();
2281        }
2282
2283        if (heavy && this.headsUpContentView != null) {
2284            that.headsUpContentView = this.headsUpContentView.clone();
2285        }
2286
2287        that.visibility = this.visibility;
2288
2289        if (this.publicVersion != null) {
2290            that.publicVersion = new Notification();
2291            this.publicVersion.cloneInto(that.publicVersion, heavy);
2292        }
2293
2294        that.color = this.color;
2295
2296        that.mChannelId = this.mChannelId;
2297        that.mTimeout = this.mTimeout;
2298        that.mShortcutId = this.mShortcutId;
2299        that.mBadgeIcon = this.mBadgeIcon;
2300        that.mSettingsText = this.mSettingsText;
2301        that.mGroupAlertBehavior = this.mGroupAlertBehavior;
2302
2303        if (!heavy) {
2304            that.lightenPayload(); // will clean out extras
2305        }
2306    }
2307
2308    /**
2309     * Removes heavyweight parts of the Notification object for archival or for sending to
2310     * listeners when the full contents are not necessary.
2311     * @hide
2312     */
2313    public final void lightenPayload() {
2314        tickerView = null;
2315        contentView = null;
2316        bigContentView = null;
2317        headsUpContentView = null;
2318        mLargeIcon = null;
2319        if (extras != null && !extras.isEmpty()) {
2320            final Set<String> keyset = extras.keySet();
2321            final int N = keyset.size();
2322            final String[] keys = keyset.toArray(new String[N]);
2323            for (int i=0; i<N; i++) {
2324                final String key = keys[i];
2325                if (TvExtender.EXTRA_TV_EXTENDER.equals(key)) {
2326                    continue;
2327                }
2328                final Object obj = extras.get(key);
2329                if (obj != null &&
2330                    (  obj instanceof Parcelable
2331                    || obj instanceof Parcelable[]
2332                    || obj instanceof SparseArray
2333                    || obj instanceof ArrayList)) {
2334                    extras.remove(key);
2335                }
2336            }
2337        }
2338    }
2339
2340    /**
2341     * Make sure this CharSequence is safe to put into a bundle, which basically
2342     * means it had better not be some custom Parcelable implementation.
2343     * @hide
2344     */
2345    public static CharSequence safeCharSequence(CharSequence cs) {
2346        if (cs == null) return cs;
2347        if (cs.length() > MAX_CHARSEQUENCE_LENGTH) {
2348            cs = cs.subSequence(0, MAX_CHARSEQUENCE_LENGTH);
2349        }
2350        if (cs instanceof Parcelable) {
2351            Log.e(TAG, "warning: " + cs.getClass().getCanonicalName()
2352                    + " instance is a custom Parcelable and not allowed in Notification");
2353            return cs.toString();
2354        }
2355        return removeTextSizeSpans(cs);
2356    }
2357
2358    private static CharSequence removeTextSizeSpans(CharSequence charSequence) {
2359        if (charSequence instanceof Spanned) {
2360            Spanned ss = (Spanned) charSequence;
2361            Object[] spans = ss.getSpans(0, ss.length(), Object.class);
2362            SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
2363            for (Object span : spans) {
2364                Object resultSpan = span;
2365                if (resultSpan instanceof CharacterStyle) {
2366                    resultSpan = ((CharacterStyle) span).getUnderlying();
2367                }
2368                if (resultSpan instanceof TextAppearanceSpan) {
2369                    TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
2370                    resultSpan = new TextAppearanceSpan(
2371                            originalSpan.getFamily(),
2372                            originalSpan.getTextStyle(),
2373                            -1,
2374                            originalSpan.getTextColor(),
2375                            originalSpan.getLinkTextColor());
2376                } else if (resultSpan instanceof RelativeSizeSpan
2377                        || resultSpan instanceof AbsoluteSizeSpan) {
2378                    continue;
2379                } else {
2380                    resultSpan = span;
2381                }
2382                builder.setSpan(resultSpan, ss.getSpanStart(span), ss.getSpanEnd(span),
2383                        ss.getSpanFlags(span));
2384            }
2385            return builder;
2386        }
2387        return charSequence;
2388    }
2389
2390    public int describeContents() {
2391        return 0;
2392    }
2393
2394    /**
2395     * Flatten this notification into a parcel.
2396     */
2397    public void writeToParcel(Parcel parcel, int flags) {
2398        // We need to mark all pending intents getting into the notification
2399        // system as being put there to later allow the notification ranker
2400        // to launch them and by doing so add the app to the battery saver white
2401        // list for a short period of time. The problem is that the system
2402        // cannot look into the extras as there may be parcelables there that
2403        // the platform does not know how to handle. To go around that we have
2404        // an explicit list of the pending intents in the extras bundle.
2405        final boolean collectPendingIntents = (allPendingIntents == null);
2406        if (collectPendingIntents) {
2407            PendingIntent.setOnMarshaledListener(
2408                    (PendingIntent intent, Parcel out, int outFlags) -> {
2409                if (parcel == out) {
2410                    if (allPendingIntents == null) {
2411                        allPendingIntents = new ArraySet<>();
2412                    }
2413                    allPendingIntents.add(intent);
2414                }
2415            });
2416        }
2417        try {
2418            // IMPORTANT: Add marshaling code in writeToParcelImpl as we
2419            // want to intercept all pending events written to the parcel.
2420            writeToParcelImpl(parcel, flags);
2421            // Must be written last!
2422            parcel.writeArraySet(allPendingIntents);
2423        } finally {
2424            if (collectPendingIntents) {
2425                PendingIntent.setOnMarshaledListener(null);
2426            }
2427        }
2428    }
2429
2430    private void writeToParcelImpl(Parcel parcel, int flags) {
2431        parcel.writeInt(1);
2432
2433        parcel.writeStrongBinder(mWhitelistToken);
2434        parcel.writeLong(when);
2435        parcel.writeLong(creationTime);
2436        if (mSmallIcon == null && icon != 0) {
2437            // you snuck an icon in here without using the builder; let's try to keep it
2438            mSmallIcon = Icon.createWithResource("", icon);
2439        }
2440        if (mSmallIcon != null) {
2441            parcel.writeInt(1);
2442            mSmallIcon.writeToParcel(parcel, 0);
2443        } else {
2444            parcel.writeInt(0);
2445        }
2446        parcel.writeInt(number);
2447        if (contentIntent != null) {
2448            parcel.writeInt(1);
2449            contentIntent.writeToParcel(parcel, 0);
2450        } else {
2451            parcel.writeInt(0);
2452        }
2453        if (deleteIntent != null) {
2454            parcel.writeInt(1);
2455            deleteIntent.writeToParcel(parcel, 0);
2456        } else {
2457            parcel.writeInt(0);
2458        }
2459        if (tickerText != null) {
2460            parcel.writeInt(1);
2461            TextUtils.writeToParcel(tickerText, parcel, flags);
2462        } else {
2463            parcel.writeInt(0);
2464        }
2465        if (tickerView != null) {
2466            parcel.writeInt(1);
2467            tickerView.writeToParcel(parcel, 0);
2468        } else {
2469            parcel.writeInt(0);
2470        }
2471        if (contentView != null) {
2472            parcel.writeInt(1);
2473            contentView.writeToParcel(parcel, 0);
2474        } else {
2475            parcel.writeInt(0);
2476        }
2477        if (mLargeIcon == null && largeIcon != null) {
2478            // you snuck an icon in here without using the builder; let's try to keep it
2479            mLargeIcon = Icon.createWithBitmap(largeIcon);
2480        }
2481        if (mLargeIcon != null) {
2482            parcel.writeInt(1);
2483            mLargeIcon.writeToParcel(parcel, 0);
2484        } else {
2485            parcel.writeInt(0);
2486        }
2487
2488        parcel.writeInt(defaults);
2489        parcel.writeInt(this.flags);
2490
2491        if (sound != null) {
2492            parcel.writeInt(1);
2493            sound.writeToParcel(parcel, 0);
2494        } else {
2495            parcel.writeInt(0);
2496        }
2497        parcel.writeInt(audioStreamType);
2498
2499        if (audioAttributes != null) {
2500            parcel.writeInt(1);
2501            audioAttributes.writeToParcel(parcel, 0);
2502        } else {
2503            parcel.writeInt(0);
2504        }
2505
2506        parcel.writeLongArray(vibrate);
2507        parcel.writeInt(ledARGB);
2508        parcel.writeInt(ledOnMS);
2509        parcel.writeInt(ledOffMS);
2510        parcel.writeInt(iconLevel);
2511
2512        if (fullScreenIntent != null) {
2513            parcel.writeInt(1);
2514            fullScreenIntent.writeToParcel(parcel, 0);
2515        } else {
2516            parcel.writeInt(0);
2517        }
2518
2519        parcel.writeInt(priority);
2520
2521        parcel.writeString(category);
2522
2523        parcel.writeString(mGroupKey);
2524
2525        parcel.writeString(mSortKey);
2526
2527        parcel.writeBundle(extras); // null ok
2528
2529        parcel.writeTypedArray(actions, 0); // null ok
2530
2531        if (bigContentView != null) {
2532            parcel.writeInt(1);
2533            bigContentView.writeToParcel(parcel, 0);
2534        } else {
2535            parcel.writeInt(0);
2536        }
2537
2538        if (headsUpContentView != null) {
2539            parcel.writeInt(1);
2540            headsUpContentView.writeToParcel(parcel, 0);
2541        } else {
2542            parcel.writeInt(0);
2543        }
2544
2545        parcel.writeInt(visibility);
2546
2547        if (publicVersion != null) {
2548            parcel.writeInt(1);
2549            publicVersion.writeToParcel(parcel, 0);
2550        } else {
2551            parcel.writeInt(0);
2552        }
2553
2554        parcel.writeInt(color);
2555
2556        if (mChannelId != null) {
2557            parcel.writeInt(1);
2558            parcel.writeString(mChannelId);
2559        } else {
2560            parcel.writeInt(0);
2561        }
2562        parcel.writeLong(mTimeout);
2563
2564        if (mShortcutId != null) {
2565            parcel.writeInt(1);
2566            parcel.writeString(mShortcutId);
2567        } else {
2568            parcel.writeInt(0);
2569        }
2570
2571        parcel.writeInt(mBadgeIcon);
2572
2573        if (mSettingsText != null) {
2574            parcel.writeInt(1);
2575            TextUtils.writeToParcel(mSettingsText, parcel, flags);
2576        } else {
2577            parcel.writeInt(0);
2578        }
2579
2580        parcel.writeInt(mGroupAlertBehavior);
2581
2582        // mUsesStandardHeader is not written because it should be recomputed in listeners
2583    }
2584
2585    /**
2586     * Parcelable.Creator that instantiates Notification objects
2587     */
2588    public static final Parcelable.Creator<Notification> CREATOR
2589            = new Parcelable.Creator<Notification>()
2590    {
2591        public Notification createFromParcel(Parcel parcel)
2592        {
2593            return new Notification(parcel);
2594        }
2595
2596        public Notification[] newArray(int size)
2597        {
2598            return new Notification[size];
2599        }
2600    };
2601
2602    /**
2603     * @hide
2604     */
2605    public static boolean areActionsVisiblyDifferent(Notification first, Notification second) {
2606        Notification.Action[] firstAs = first.actions;
2607        Notification.Action[] secondAs = second.actions;
2608        if (firstAs == null && secondAs != null || firstAs != null && secondAs == null) {
2609            return true;
2610        }
2611        if (firstAs != null && secondAs != null) {
2612            if (firstAs.length != secondAs.length) {
2613                return true;
2614            }
2615            for (int i = 0; i < firstAs.length; i++) {
2616                if (!Objects.equals(firstAs[i].title, secondAs[i].title)) {
2617                    return true;
2618                }
2619                RemoteInput[] firstRs = firstAs[i].getRemoteInputs();
2620                RemoteInput[] secondRs = secondAs[i].getRemoteInputs();
2621                if (firstRs == null) {
2622                    firstRs = new RemoteInput[0];
2623                }
2624                if (secondRs == null) {
2625                    secondRs = new RemoteInput[0];
2626                }
2627                if (firstRs.length != secondRs.length) {
2628                    return true;
2629                }
2630                for (int j = 0; j < firstRs.length; j++) {
2631                    if (!Objects.equals(firstRs[j].getLabel(), secondRs[j].getLabel())) {
2632                        return true;
2633                    }
2634                    CharSequence[] firstCs = firstRs[j].getChoices();
2635                    CharSequence[] secondCs = secondRs[j].getChoices();
2636                    if (firstCs == null) {
2637                        firstCs = new CharSequence[0];
2638                    }
2639                    if (secondCs == null) {
2640                        secondCs = new CharSequence[0];
2641                    }
2642                    if (firstCs.length != secondCs.length) {
2643                        return true;
2644                    }
2645                    for (int k = 0; k < firstCs.length; k++) {
2646                        if (!Objects.equals(firstCs[k], secondCs[k])) {
2647                            return true;
2648                        }
2649                    }
2650                }
2651            }
2652        }
2653        return false;
2654    }
2655
2656    /**
2657     * @hide
2658     */
2659    public static boolean areStyledNotificationsVisiblyDifferent(Builder first, Builder second) {
2660        if (first.getStyle() == null) {
2661            return second.getStyle() != null;
2662        }
2663        if (second.getStyle() == null) {
2664            return true;
2665        }
2666        return first.getStyle().areNotificationsVisiblyDifferent(second.getStyle());
2667    }
2668
2669    /**
2670     * @hide
2671     */
2672    public static boolean areRemoteViewsChanged(Builder first, Builder second) {
2673        return !first.usesStandardHeader() || !second.usesStandardHeader();
2674    }
2675
2676    /**
2677     * Parcelling creates multiple copies of objects in {@code extras}. Fix them.
2678     * <p>
2679     * For backwards compatibility {@code extras} holds some references to "real" member data such
2680     * as {@link getLargeIcon()} which is mirrored by {@link #EXTRA_LARGE_ICON}. This is mostly
2681     * fine as long as the object stays in one process.
2682     * <p>
2683     * However, once the notification goes into a parcel each reference gets marshalled separately,
2684     * wasting memory. Especially with large images on Auto and TV, this is worth fixing.
2685     */
2686    private void fixDuplicateExtras() {
2687        if (extras != null) {
2688            fixDuplicateExtra(mSmallIcon, EXTRA_SMALL_ICON);
2689            fixDuplicateExtra(mLargeIcon, EXTRA_LARGE_ICON);
2690        }
2691    }
2692
2693    /**
2694     * If we find an extra that's exactly the same as one of the "real" fields but refers to a
2695     * separate object, replace it with the field's version to avoid holding duplicate copies.
2696     */
2697    private void fixDuplicateExtra(@Nullable Parcelable original, @NonNull String extraName) {
2698        if (original != null && extras.getParcelable(extraName) != null) {
2699            extras.putParcelable(extraName, original);
2700        }
2701    }
2702
2703    /**
2704     * Sets the {@link #contentView} field to be a view with the standard "Latest Event"
2705     * layout.
2706     *
2707     * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields
2708     * in the view.</p>
2709     * @param context       The context for your application / activity.
2710     * @param contentTitle The title that goes in the expanded entry.
2711     * @param contentText  The text that goes in the expanded entry.
2712     * @param contentIntent The intent to launch when the user clicks the expanded notification.
2713     * If this is an activity, it must include the
2714     * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
2715     * that you take care of task management as described in the
2716     * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2717     * Stack</a> document.
2718     *
2719     * @deprecated Use {@link Builder} instead.
2720     * @removed
2721     */
2722    @Deprecated
2723    public void setLatestEventInfo(Context context,
2724            CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
2725        if (context.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.LOLLIPOP_MR1){
2726            Log.e(TAG, "setLatestEventInfo() is deprecated and you should feel deprecated.",
2727                    new Throwable());
2728        }
2729
2730        if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
2731            extras.putBoolean(EXTRA_SHOW_WHEN, true);
2732        }
2733
2734        // ensure that any information already set directly is preserved
2735        final Notification.Builder builder = new Notification.Builder(context, this);
2736
2737        // now apply the latestEventInfo fields
2738        if (contentTitle != null) {
2739            builder.setContentTitle(contentTitle);
2740        }
2741        if (contentText != null) {
2742            builder.setContentText(contentText);
2743        }
2744        builder.setContentIntent(contentIntent);
2745
2746        builder.build(); // callers expect this notification to be ready to use
2747    }
2748
2749    /**
2750     * @hide
2751     */
2752    public static void addFieldsFromContext(Context context, Notification notification) {
2753        addFieldsFromContext(context.getApplicationInfo(), notification);
2754    }
2755
2756    /**
2757     * @hide
2758     */
2759    public static void addFieldsFromContext(ApplicationInfo ai, Notification notification) {
2760        notification.extras.putParcelable(EXTRA_BUILDER_APPLICATION_INFO, ai);
2761    }
2762
2763    /**
2764     * @hide
2765     */
2766    public void writeToProto(ProtoOutputStream proto, long fieldId) {
2767        long token = proto.start(fieldId);
2768        proto.write(NotificationProto.CHANNEL_ID, getChannelId());
2769        proto.write(NotificationProto.HAS_TICKER_TEXT, this.tickerText != null);
2770        proto.write(NotificationProto.FLAGS, this.flags);
2771        proto.write(NotificationProto.COLOR, this.color);
2772        proto.write(NotificationProto.CATEGORY, this.category);
2773        proto.write(NotificationProto.GROUP_KEY, this.mGroupKey);
2774        proto.write(NotificationProto.SORT_KEY, this.mSortKey);
2775        if (this.actions != null) {
2776            proto.write(NotificationProto.ACTION_LENGTH, this.actions.length);
2777        }
2778        if (this.visibility >= VISIBILITY_SECRET && this.visibility <= VISIBILITY_PUBLIC) {
2779            proto.write(NotificationProto.VISIBILITY, this.visibility);
2780        }
2781        if (publicVersion != null) {
2782            publicVersion.writeToProto(proto, NotificationProto.PUBLIC_VERSION);
2783        }
2784        proto.end(token);
2785    }
2786
2787    @Override
2788    public String toString() {
2789        StringBuilder sb = new StringBuilder();
2790        sb.append("Notification(channel=");
2791        sb.append(getChannelId());
2792        sb.append(" pri=");
2793        sb.append(priority);
2794        sb.append(" contentView=");
2795        if (contentView != null) {
2796            sb.append(contentView.getPackage());
2797            sb.append("/0x");
2798            sb.append(Integer.toHexString(contentView.getLayoutId()));
2799        } else {
2800            sb.append("null");
2801        }
2802        sb.append(" vibrate=");
2803        if ((this.defaults & DEFAULT_VIBRATE) != 0) {
2804            sb.append("default");
2805        } else if (this.vibrate != null) {
2806            int N = this.vibrate.length-1;
2807            sb.append("[");
2808            for (int i=0; i<N; i++) {
2809                sb.append(this.vibrate[i]);
2810                sb.append(',');
2811            }
2812            if (N != -1) {
2813                sb.append(this.vibrate[N]);
2814            }
2815            sb.append("]");
2816        } else {
2817            sb.append("null");
2818        }
2819        sb.append(" sound=");
2820        if ((this.defaults & DEFAULT_SOUND) != 0) {
2821            sb.append("default");
2822        } else if (this.sound != null) {
2823            sb.append(this.sound.toString());
2824        } else {
2825            sb.append("null");
2826        }
2827        if (this.tickerText != null) {
2828            sb.append(" tick");
2829        }
2830        sb.append(" defaults=0x");
2831        sb.append(Integer.toHexString(this.defaults));
2832        sb.append(" flags=0x");
2833        sb.append(Integer.toHexString(this.flags));
2834        sb.append(String.format(" color=0x%08x", this.color));
2835        if (this.category != null) {
2836            sb.append(" category=");
2837            sb.append(this.category);
2838        }
2839        if (this.mGroupKey != null) {
2840            sb.append(" groupKey=");
2841            sb.append(this.mGroupKey);
2842        }
2843        if (this.mSortKey != null) {
2844            sb.append(" sortKey=");
2845            sb.append(this.mSortKey);
2846        }
2847        if (actions != null) {
2848            sb.append(" actions=");
2849            sb.append(actions.length);
2850        }
2851        sb.append(" vis=");
2852        sb.append(visibilityToString(this.visibility));
2853        if (this.publicVersion != null) {
2854            sb.append(" publicVersion=");
2855            sb.append(publicVersion.toString());
2856        }
2857        sb.append(")");
2858        return sb.toString();
2859    }
2860
2861    /**
2862     * {@hide}
2863     */
2864    public static String visibilityToString(int vis) {
2865        switch (vis) {
2866            case VISIBILITY_PRIVATE:
2867                return "PRIVATE";
2868            case VISIBILITY_PUBLIC:
2869                return "PUBLIC";
2870            case VISIBILITY_SECRET:
2871                return "SECRET";
2872            default:
2873                return "UNKNOWN(" + String.valueOf(vis) + ")";
2874        }
2875    }
2876
2877    /**
2878     * {@hide}
2879     */
2880    public static String priorityToString(@Priority int pri) {
2881        switch (pri) {
2882            case PRIORITY_MIN:
2883                return "MIN";
2884            case PRIORITY_LOW:
2885                return "LOW";
2886            case PRIORITY_DEFAULT:
2887                return "DEFAULT";
2888            case PRIORITY_HIGH:
2889                return "HIGH";
2890            case PRIORITY_MAX:
2891                return "MAX";
2892            default:
2893                return "UNKNOWN(" + String.valueOf(pri) + ")";
2894        }
2895    }
2896
2897    /**
2898     * @hide
2899     */
2900    public boolean hasCompletedProgress() {
2901        // not a progress notification; can't be complete
2902        if (!extras.containsKey(EXTRA_PROGRESS)
2903                || !extras.containsKey(EXTRA_PROGRESS_MAX)) {
2904            return false;
2905        }
2906        // many apps use max 0 for 'indeterminate'; not complete
2907        if (extras.getInt(EXTRA_PROGRESS_MAX) == 0) {
2908            return false;
2909        }
2910        return extras.getInt(EXTRA_PROGRESS) == extras.getInt(EXTRA_PROGRESS_MAX);
2911    }
2912
2913    /** @removed */
2914    @Deprecated
2915    public String getChannel() {
2916        return mChannelId;
2917    }
2918
2919    /**
2920     * Returns the id of the channel this notification posts to.
2921     */
2922    public String getChannelId() {
2923        return mChannelId;
2924    }
2925
2926    /** @removed */
2927    @Deprecated
2928    public long getTimeout() {
2929        return mTimeout;
2930    }
2931
2932    /**
2933     * Returns the duration from posting after which this notification should be canceled by the
2934     * system, if it's not canceled already.
2935     */
2936    public long getTimeoutAfter() {
2937        return mTimeout;
2938    }
2939
2940    /**
2941     * Returns what icon should be shown for this notification if it is being displayed in a
2942     * Launcher that supports badging. Will be one of {@link #BADGE_ICON_NONE},
2943     * {@link #BADGE_ICON_SMALL}, or {@link #BADGE_ICON_LARGE}.
2944     */
2945    public int getBadgeIconType() {
2946        return mBadgeIcon;
2947    }
2948
2949    /**
2950     * Returns the {@link ShortcutInfo#getId() id} that this notification supersedes, if any.
2951     *
2952     * <p>Used by some Launchers that display notification content to hide shortcuts that duplicate
2953     * notifications.
2954     */
2955    public String getShortcutId() {
2956        return mShortcutId;
2957    }
2958
2959
2960    /**
2961     * Returns the settings text provided to {@link Builder#setSettingsText(CharSequence)}.
2962     */
2963    public CharSequence getSettingsText() {
2964        return mSettingsText;
2965    }
2966
2967    /**
2968     * Returns which type of notifications in a group are responsible for audibly alerting the
2969     * user. See {@link #GROUP_ALERT_ALL}, {@link #GROUP_ALERT_CHILDREN},
2970     * {@link #GROUP_ALERT_SUMMARY}.
2971     */
2972    public @GroupAlertBehavior int getGroupAlertBehavior() {
2973        return mGroupAlertBehavior;
2974    }
2975
2976    /**
2977     * The small icon representing this notification in the status bar and content view.
2978     *
2979     * @return the small icon representing this notification.
2980     *
2981     * @see Builder#getSmallIcon()
2982     * @see Builder#setSmallIcon(Icon)
2983     */
2984    public Icon getSmallIcon() {
2985        return mSmallIcon;
2986    }
2987
2988    /**
2989     * Used when notifying to clean up legacy small icons.
2990     * @hide
2991     */
2992    public void setSmallIcon(Icon icon) {
2993        mSmallIcon = icon;
2994    }
2995
2996    /**
2997     * The large icon shown in this notification's content view.
2998     * @see Builder#getLargeIcon()
2999     * @see Builder#setLargeIcon(Icon)
3000     */
3001    public Icon getLargeIcon() {
3002        return mLargeIcon;
3003    }
3004
3005    /**
3006     * @hide
3007     */
3008    public boolean isGroupSummary() {
3009        return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) != 0;
3010    }
3011
3012    /**
3013     * @hide
3014     */
3015    public boolean isGroupChild() {
3016        return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) == 0;
3017    }
3018
3019    /**
3020     * @hide
3021     */
3022    public boolean suppressAlertingDueToGrouping() {
3023        if (isGroupSummary()
3024                && getGroupAlertBehavior() == Notification.GROUP_ALERT_CHILDREN) {
3025            return true;
3026        } else if (isGroupChild()
3027                && getGroupAlertBehavior() == Notification.GROUP_ALERT_SUMMARY) {
3028            return true;
3029        }
3030        return false;
3031    }
3032
3033    /**
3034     * Builder class for {@link Notification} objects.
3035     *
3036     * Provides a convenient way to set the various fields of a {@link Notification} and generate
3037     * content views using the platform's notification layout template. If your app supports
3038     * versions of Android as old as API level 4, you can instead use
3039     * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder},
3040     * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support
3041     * library</a>.
3042     *
3043     * <p>Example:
3044     *
3045     * <pre class="prettyprint">
3046     * Notification noti = new Notification.Builder(mContext)
3047     *         .setContentTitle(&quot;New mail from &quot; + sender.toString())
3048     *         .setContentText(subject)
3049     *         .setSmallIcon(R.drawable.new_mail)
3050     *         .setLargeIcon(aBitmap)
3051     *         .build();
3052     * </pre>
3053     */
3054    public static class Builder {
3055        /**
3056         * @hide
3057         */
3058        public static final String EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT =
3059                "android.rebuild.contentViewActionCount";
3060        /**
3061         * @hide
3062         */
3063        public static final String EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT
3064                = "android.rebuild.bigViewActionCount";
3065        /**
3066         * @hide
3067         */
3068        public static final String EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT
3069                = "android.rebuild.hudViewActionCount";
3070
3071        private static final int MAX_ACTION_BUTTONS = 3;
3072
3073        private static final boolean USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY =
3074                SystemProperties.getBoolean("notifications.only_title", true);
3075
3076        /**
3077         * The lightness difference that has to be added to the primary text color to obtain the
3078         * secondary text color when the background is light.
3079         */
3080        private static final int LIGHTNESS_TEXT_DIFFERENCE_LIGHT = 20;
3081
3082        /**
3083         * The lightness difference that has to be added to the primary text color to obtain the
3084         * secondary text color when the background is dark.
3085         * A bit less then the above value, since it looks better on dark backgrounds.
3086         */
3087        private static final int LIGHTNESS_TEXT_DIFFERENCE_DARK = -10;
3088
3089        private Context mContext;
3090        private Notification mN;
3091        private Bundle mUserExtras = new Bundle();
3092        private Style mStyle;
3093        private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS);
3094        private ArrayList<Person> mPersonList = new ArrayList<>();
3095        private NotificationColorUtil mColorUtil;
3096        private boolean mIsLegacy;
3097        private boolean mIsLegacyInitialized;
3098
3099        /**
3100         * Caches a contrast-enhanced version of {@link #mCachedContrastColorIsFor}.
3101         */
3102        private int mCachedContrastColor = COLOR_INVALID;
3103        private int mCachedContrastColorIsFor = COLOR_INVALID;
3104        /**
3105         * Caches a ambient version of {@link #mCachedContrastColorIsFor}.
3106         */
3107        private int mCachedAmbientColor = COLOR_INVALID;
3108        private int mCachedAmbientColorIsFor = COLOR_INVALID;
3109
3110        /**
3111         * Caches an instance of StandardTemplateParams. Note that this may have been used before,
3112         * so make sure to call {@link StandardTemplateParams#reset()} before using it.
3113         */
3114        StandardTemplateParams mParams = new StandardTemplateParams();
3115        private int mTextColorsAreForBackground = COLOR_INVALID;
3116        private int mPrimaryTextColor = COLOR_INVALID;
3117        private int mSecondaryTextColor = COLOR_INVALID;
3118        private int mActionBarColor = COLOR_INVALID;
3119        private int mBackgroundColor = COLOR_INVALID;
3120        private int mForegroundColor = COLOR_INVALID;
3121        /**
3122         * A temporary location where actions are stored. If != null the view originally has action
3123         * but doesn't have any for this inflation.
3124         */
3125        private ArrayList<Action> mOriginalActions;
3126        private boolean mRebuildStyledRemoteViews;
3127
3128        private boolean mTintActionButtons;
3129        private boolean mInNightMode;
3130
3131        /**
3132         * Constructs a new Builder with the defaults:
3133         *
3134         * @param context
3135         *            A {@link Context} that will be used by the Builder to construct the
3136         *            RemoteViews. The Context will not be held past the lifetime of this Builder
3137         *            object.
3138         * @param channelId
3139         *            The constructed Notification will be posted on this
3140         *            {@link NotificationChannel}. To use a NotificationChannel, it must first be
3141         *            created using {@link NotificationManager#createNotificationChannel}.
3142         */
3143        public Builder(Context context, String channelId) {
3144            this(context, (Notification) null);
3145            mN.mChannelId = channelId;
3146        }
3147
3148        /**
3149         * @deprecated use {@link Notification.Builder#Notification.Builder(Context, String)}
3150         * instead. All posted Notifications must specify a NotificationChannel Id.
3151         */
3152        @Deprecated
3153        public Builder(Context context) {
3154            this(context, (Notification) null);
3155        }
3156
3157        /**
3158         * @hide
3159         */
3160        public Builder(Context context, Notification toAdopt) {
3161            mContext = context;
3162            Resources res = mContext.getResources();
3163            mTintActionButtons = res.getBoolean(R.bool.config_tintNotificationActionButtons);
3164
3165            if (res.getBoolean(R.bool.config_enableNightMode)) {
3166                Configuration currentConfig = res.getConfiguration();
3167                mInNightMode = (currentConfig.uiMode & Configuration.UI_MODE_NIGHT_MASK)
3168                        == Configuration.UI_MODE_NIGHT_YES;
3169            }
3170
3171            if (toAdopt == null) {
3172                mN = new Notification();
3173                if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
3174                    mN.extras.putBoolean(EXTRA_SHOW_WHEN, true);
3175                }
3176                mN.priority = PRIORITY_DEFAULT;
3177                mN.visibility = VISIBILITY_PRIVATE;
3178            } else {
3179                mN = toAdopt;
3180                if (mN.actions != null) {
3181                    Collections.addAll(mActions, mN.actions);
3182                }
3183
3184                if (mN.extras.containsKey(EXTRA_PEOPLE_LIST)) {
3185                    ArrayList<Person> people = mN.extras.getParcelableArrayList(EXTRA_PEOPLE_LIST);
3186                    mPersonList.addAll(people);
3187                }
3188
3189                if (mN.getSmallIcon() == null && mN.icon != 0) {
3190                    setSmallIcon(mN.icon);
3191                }
3192
3193                if (mN.getLargeIcon() == null && mN.largeIcon != null) {
3194                    setLargeIcon(mN.largeIcon);
3195                }
3196
3197                String templateClass = mN.extras.getString(EXTRA_TEMPLATE);
3198                if (!TextUtils.isEmpty(templateClass)) {
3199                    final Class<? extends Style> styleClass
3200                            = getNotificationStyleClass(templateClass);
3201                    if (styleClass == null) {
3202                        Log.d(TAG, "Unknown style class: " + templateClass);
3203                    } else {
3204                        try {
3205                            final Constructor<? extends Style> ctor =
3206                                    styleClass.getDeclaredConstructor();
3207                            ctor.setAccessible(true);
3208                            final Style style = ctor.newInstance();
3209                            style.restoreFromExtras(mN.extras);
3210
3211                            if (style != null) {
3212                                setStyle(style);
3213                            }
3214                        } catch (Throwable t) {
3215                            Log.e(TAG, "Could not create Style", t);
3216                        }
3217                    }
3218                }
3219
3220            }
3221        }
3222
3223        private NotificationColorUtil getColorUtil() {
3224            if (mColorUtil == null) {
3225                mColorUtil = NotificationColorUtil.getInstance(mContext);
3226            }
3227            return mColorUtil;
3228        }
3229
3230        /**
3231         * If this notification is duplicative of a Launcher shortcut, sets the
3232         * {@link ShortcutInfo#getId() id} of the shortcut, in case the Launcher wants to hide
3233         * the shortcut.
3234         *
3235         * This field will be ignored by Launchers that don't support badging, don't show
3236         * notification content, or don't show {@link android.content.pm.ShortcutManager shortcuts}.
3237         *
3238         * @param shortcutId the {@link ShortcutInfo#getId() id} of the shortcut this notification
3239         *                   supersedes
3240         */
3241        public Builder setShortcutId(String shortcutId) {
3242            mN.mShortcutId = shortcutId;
3243            return this;
3244        }
3245
3246        /**
3247         * Sets which icon to display as a badge for this notification.
3248         *
3249         * Must be one of {@link #BADGE_ICON_NONE}, {@link #BADGE_ICON_SMALL},
3250         * {@link #BADGE_ICON_LARGE}.
3251         *
3252         * Note: This value might be ignored, for launchers that don't support badge icons.
3253         */
3254        public Builder setBadgeIconType(int icon) {
3255            mN.mBadgeIcon = icon;
3256            return this;
3257        }
3258
3259        /**
3260         * Sets the group alert behavior for this notification. Use this method to mute this
3261         * notification if alerts for this notification's group should be handled by a different
3262         * notification. This is only applicable for notifications that belong to a
3263         * {@link #setGroup(String) group}. This must be called on all notifications you want to
3264         * mute. For example, if you want only the summary of your group to make noise, all
3265         * children in the group should have the group alert behavior {@link #GROUP_ALERT_SUMMARY}.
3266         *
3267         * <p> The default value is {@link #GROUP_ALERT_ALL}.</p>
3268         */
3269        public Builder setGroupAlertBehavior(@GroupAlertBehavior int groupAlertBehavior) {
3270            mN.mGroupAlertBehavior = groupAlertBehavior;
3271            return this;
3272        }
3273
3274        /** @removed */
3275        @Deprecated
3276        public Builder setChannel(String channelId) {
3277            mN.mChannelId = channelId;
3278            return this;
3279        }
3280
3281        /**
3282         * Specifies the channel the notification should be delivered on.
3283         */
3284        public Builder setChannelId(String channelId) {
3285            mN.mChannelId = channelId;
3286            return this;
3287        }
3288
3289        /** @removed */
3290        @Deprecated
3291        public Builder setTimeout(long durationMs) {
3292            mN.mTimeout = durationMs;
3293            return this;
3294        }
3295
3296        /**
3297         * Specifies a duration in milliseconds after which this notification should be canceled,
3298         * if it is not already canceled.
3299         */
3300        public Builder setTimeoutAfter(long durationMs) {
3301            mN.mTimeout = durationMs;
3302            return this;
3303        }
3304
3305        /**
3306         * Add a timestamp pertaining to the notification (usually the time the event occurred).
3307         *
3308         * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not
3309         * shown anymore by default and must be opted into by using
3310         * {@link android.app.Notification.Builder#setShowWhen(boolean)}
3311         *
3312         * @see Notification#when
3313         */
3314        public Builder setWhen(long when) {
3315            mN.when = when;
3316            return this;
3317        }
3318
3319        /**
3320         * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown
3321         * in the content view.
3322         * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to
3323         * {@code false}. For earlier apps, the default is {@code true}.
3324         */
3325        public Builder setShowWhen(boolean show) {
3326            mN.extras.putBoolean(EXTRA_SHOW_WHEN, show);
3327            return this;
3328        }
3329
3330        /**
3331         * Show the {@link Notification#when} field as a stopwatch.
3332         *
3333         * Instead of presenting <code>when</code> as a timestamp, the notification will show an
3334         * automatically updating display of the minutes and seconds since <code>when</code>.
3335         *
3336         * Useful when showing an elapsed time (like an ongoing phone call).
3337         *
3338         * The counter can also be set to count down to <code>when</code> when using
3339         * {@link #setChronometerCountDown(boolean)}.
3340         *
3341         * @see android.widget.Chronometer
3342         * @see Notification#when
3343         * @see #setChronometerCountDown(boolean)
3344         */
3345        public Builder setUsesChronometer(boolean b) {
3346            mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b);
3347            return this;
3348        }
3349
3350        /**
3351         * Sets the Chronometer to count down instead of counting up.
3352         *
3353         * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true.
3354         * If it isn't set the chronometer will count up.
3355         *
3356         * @see #setUsesChronometer(boolean)
3357         */
3358        public Builder setChronometerCountDown(boolean countDown) {
3359            mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, countDown);
3360            return this;
3361        }
3362
3363        /**
3364         * Set the small icon resource, which will be used to represent the notification in the
3365         * status bar.
3366         *
3367
3368         * The platform template for the expanded view will draw this icon in the left, unless a
3369         * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
3370         * icon will be moved to the right-hand side.
3371         *
3372
3373         * @param icon
3374         *            A resource ID in the application's package of the drawable to use.
3375         * @see Notification#icon
3376         */
3377        public Builder setSmallIcon(@DrawableRes int icon) {
3378            return setSmallIcon(icon != 0
3379                    ? Icon.createWithResource(mContext, icon)
3380                    : null);
3381        }
3382
3383        /**
3384         * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
3385         * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
3386         * LevelListDrawable}.
3387         *
3388         * @param icon A resource ID in the application's package of the drawable to use.
3389         * @param level The level to use for the icon.
3390         *
3391         * @see Notification#icon
3392         * @see Notification#iconLevel
3393         */
3394        public Builder setSmallIcon(@DrawableRes int icon, int level) {
3395            mN.iconLevel = level;
3396            return setSmallIcon(icon);
3397        }
3398
3399        /**
3400         * Set the small icon, which will be used to represent the notification in the
3401         * status bar and content view (unless overriden there by a
3402         * {@link #setLargeIcon(Bitmap) large icon}).
3403         *
3404         * @param icon An Icon object to use.
3405         * @see Notification#icon
3406         */
3407        public Builder setSmallIcon(Icon icon) {
3408            mN.setSmallIcon(icon);
3409            if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
3410                mN.icon = icon.getResId();
3411            }
3412            return this;
3413        }
3414
3415        /**
3416         * Set the first line of text in the platform notification template.
3417         */
3418        public Builder setContentTitle(CharSequence title) {
3419            mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title));
3420            return this;
3421        }
3422
3423        /**
3424         * Set the second line of text in the platform notification template.
3425         */
3426        public Builder setContentText(CharSequence text) {
3427            mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text));
3428            return this;
3429        }
3430
3431        /**
3432         * This provides some additional information that is displayed in the notification. No
3433         * guarantees are given where exactly it is displayed.
3434         *
3435         * <p>This information should only be provided if it provides an essential
3436         * benefit to the understanding of the notification. The more text you provide the
3437         * less readable it becomes. For example, an email client should only provide the account
3438         * name here if more than one email account has been added.</p>
3439         *
3440         * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the
3441         * notification header area.
3442         *
3443         * On Android versions before {@link android.os.Build.VERSION_CODES#N}
3444         * this will be shown in the third line of text in the platform notification template.
3445         * You should not be using {@link #setProgress(int, int, boolean)} at the
3446         * same time on those versions; they occupy the same place.
3447         * </p>
3448         */
3449        public Builder setSubText(CharSequence text) {
3450            mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text));
3451            return this;
3452        }
3453
3454        /**
3455         * Provides text that will appear as a link to your application's settings.
3456         *
3457         * <p>This text does not appear within notification {@link Style templates} but may
3458         * appear when the user uses an affordance to learn more about the notification.
3459         * Additionally, this text will not appear unless you provide a valid link target by
3460         * handling {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}.
3461         *
3462         * <p>This text is meant to be concise description about what the user can customize
3463         * when they click on this link. The recommended maximum length is 40 characters.
3464         * @param text
3465         * @return
3466         */
3467        public Builder setSettingsText(CharSequence text) {
3468            mN.mSettingsText = safeCharSequence(text);
3469            return this;
3470        }
3471
3472        /**
3473         * Set the remote input history.
3474         *
3475         * This should be set to the most recent inputs that have been sent
3476         * through a {@link RemoteInput} of this Notification and cleared once the it is no
3477         * longer relevant (e.g. for chat notifications once the other party has responded).
3478         *
3479         * The most recent input must be stored at the 0 index, the second most recent at the
3480         * 1 index, etc. Note that the system will limit both how far back the inputs will be shown
3481         * and how much of each individual input is shown.
3482         *
3483         * <p>Note: The reply text will only be shown on notifications that have least one action
3484         * with a {@code RemoteInput}.</p>
3485         */
3486        public Builder setRemoteInputHistory(CharSequence[] text) {
3487            if (text == null) {
3488                mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null);
3489            } else {
3490                final int N = Math.min(MAX_REPLY_HISTORY, text.length);
3491                CharSequence[] safe = new CharSequence[N];
3492                for (int i = 0; i < N; i++) {
3493                    safe[i] = safeCharSequence(text[i]);
3494                }
3495                mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe);
3496            }
3497            return this;
3498        }
3499
3500        /**
3501         * Sets the number of items this notification represents. May be displayed as a badge count
3502         * for Launchers that support badging.
3503         */
3504        public Builder setNumber(int number) {
3505            mN.number = number;
3506            return this;
3507        }
3508
3509        /**
3510         * A small piece of additional information pertaining to this notification.
3511         *
3512         * The platform template will draw this on the last line of the notification, at the far
3513         * right (to the right of a smallIcon if it has been placed there).
3514         *
3515         * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header.
3516         * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this
3517         * field will still show up, but the subtext will take precedence.
3518         */
3519        @Deprecated
3520        public Builder setContentInfo(CharSequence info) {
3521            mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info));
3522            return this;
3523        }
3524
3525        /**
3526         * Set the progress this notification represents.
3527         *
3528         * The platform template will represent this using a {@link ProgressBar}.
3529         */
3530        public Builder setProgress(int max, int progress, boolean indeterminate) {
3531            mN.extras.putInt(EXTRA_PROGRESS, progress);
3532            mN.extras.putInt(EXTRA_PROGRESS_MAX, max);
3533            mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate);
3534            return this;
3535        }
3536
3537        /**
3538         * Supply a custom RemoteViews to use instead of the platform template.
3539         *
3540         * Use {@link #setCustomContentView(RemoteViews)} instead.
3541         */
3542        @Deprecated
3543        public Builder setContent(RemoteViews views) {
3544            return setCustomContentView(views);
3545        }
3546
3547        /**
3548         * Supply custom RemoteViews to use instead of the platform template.
3549         *
3550         * This will override the layout that would otherwise be constructed by this Builder
3551         * object.
3552         */
3553        public Builder setCustomContentView(RemoteViews contentView) {
3554            mN.contentView = contentView;
3555            return this;
3556        }
3557
3558        /**
3559         * Supply custom RemoteViews to use instead of the platform template in the expanded form.
3560         *
3561         * This will override the expanded layout that would otherwise be constructed by this
3562         * Builder object.
3563         */
3564        public Builder setCustomBigContentView(RemoteViews contentView) {
3565            mN.bigContentView = contentView;
3566            return this;
3567        }
3568
3569        /**
3570         * Supply custom RemoteViews to use instead of the platform template in the heads up dialog.
3571         *
3572         * This will override the heads-up layout that would otherwise be constructed by this
3573         * Builder object.
3574         */
3575        public Builder setCustomHeadsUpContentView(RemoteViews contentView) {
3576            mN.headsUpContentView = contentView;
3577            return this;
3578        }
3579
3580        /**
3581         * Supply a {@link PendingIntent} to be sent when the notification is clicked.
3582         *
3583         * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
3584         * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
3585         * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
3586         * to assign PendingIntents to individual views in that custom layout (i.e., to create
3587         * clickable buttons inside the notification view).
3588         *
3589         * @see Notification#contentIntent Notification.contentIntent
3590         */
3591        public Builder setContentIntent(PendingIntent intent) {
3592            mN.contentIntent = intent;
3593            return this;
3594        }
3595
3596        /**
3597         * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
3598         *
3599         * @see Notification#deleteIntent
3600         */
3601        public Builder setDeleteIntent(PendingIntent intent) {
3602            mN.deleteIntent = intent;
3603            return this;
3604        }
3605
3606        /**
3607         * An intent to launch instead of posting the notification to the status bar.
3608         * Only for use with extremely high-priority notifications demanding the user's
3609         * <strong>immediate</strong> attention, such as an incoming phone call or
3610         * alarm clock that the user has explicitly set to a particular time.
3611         * If this facility is used for something else, please give the user an option
3612         * to turn it off and use a normal notification, as this can be extremely
3613         * disruptive.
3614         *
3615         * <p>
3616         * The system UI may choose to display a heads-up notification, instead of
3617         * launching this intent, while the user is using the device.
3618         * </p>
3619         *
3620         * @param intent The pending intent to launch.
3621         * @param highPriority Passing true will cause this notification to be sent
3622         *          even if other notifications are suppressed.
3623         *
3624         * @see Notification#fullScreenIntent
3625         */
3626        public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
3627            mN.fullScreenIntent = intent;
3628            setFlag(FLAG_HIGH_PRIORITY, highPriority);
3629            return this;
3630        }
3631
3632        /**
3633         * Set the "ticker" text which is sent to accessibility services.
3634         *
3635         * @see Notification#tickerText
3636         */
3637        public Builder setTicker(CharSequence tickerText) {
3638            mN.tickerText = safeCharSequence(tickerText);
3639            return this;
3640        }
3641
3642        /**
3643         * Obsolete version of {@link #setTicker(CharSequence)}.
3644         *
3645         */
3646        @Deprecated
3647        public Builder setTicker(CharSequence tickerText, RemoteViews views) {
3648            setTicker(tickerText);
3649            // views is ignored
3650            return this;
3651        }
3652
3653        /**
3654         * Add a large icon to the notification content view.
3655         *
3656         * In the platform template, this image will be shown on the left of the notification view
3657         * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3658         * badge atop the large icon).
3659         */
3660        public Builder setLargeIcon(Bitmap b) {
3661            return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
3662        }
3663
3664        /**
3665         * Add a large icon to the notification content view.
3666         *
3667         * In the platform template, this image will be shown on the left of the notification view
3668         * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3669         * badge atop the large icon).
3670         */
3671        public Builder setLargeIcon(Icon icon) {
3672            mN.mLargeIcon = icon;
3673            mN.extras.putParcelable(EXTRA_LARGE_ICON, icon);
3674            return this;
3675        }
3676
3677        /**
3678         * Set the sound to play.
3679         *
3680         * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes}
3681         * for notifications.
3682         *
3683         * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
3684         */
3685        @Deprecated
3686        public Builder setSound(Uri sound) {
3687            mN.sound = sound;
3688            mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
3689            return this;
3690        }
3691
3692        /**
3693         * Set the sound to play, along with a specific stream on which to play it.
3694         *
3695         * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
3696         *
3697         * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)}.
3698         */
3699        @Deprecated
3700        public Builder setSound(Uri sound, int streamType) {
3701            PlayerBase.deprecateStreamTypeForPlayback(streamType, "Notification", "setSound()");
3702            mN.sound = sound;
3703            mN.audioStreamType = streamType;
3704            return this;
3705        }
3706
3707        /**
3708         * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to
3709         * use during playback.
3710         *
3711         * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
3712         * @see Notification#sound
3713         */
3714        @Deprecated
3715        public Builder setSound(Uri sound, AudioAttributes audioAttributes) {
3716            mN.sound = sound;
3717            mN.audioAttributes = audioAttributes;
3718            return this;
3719        }
3720
3721        /**
3722         * Set the vibration pattern to use.
3723         *
3724         * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
3725         * <code>pattern</code> parameter.
3726         *
3727         * <p>
3728         * A notification that vibrates is more likely to be presented as a heads-up notification.
3729         * </p>
3730         *
3731         * @deprecated use {@link NotificationChannel#setVibrationPattern(long[])} instead.
3732         * @see Notification#vibrate
3733         */
3734        @Deprecated
3735        public Builder setVibrate(long[] pattern) {
3736            mN.vibrate = pattern;
3737            return this;
3738        }
3739
3740        /**
3741         * Set the desired color for the indicator LED on the device, as well as the
3742         * blink duty cycle (specified in milliseconds).
3743         *
3744
3745         * Not all devices will honor all (or even any) of these values.
3746         *
3747         * @deprecated use {@link NotificationChannel#enableLights(boolean)} instead.
3748         * @see Notification#ledARGB
3749         * @see Notification#ledOnMS
3750         * @see Notification#ledOffMS
3751         */
3752        @Deprecated
3753        public Builder setLights(@ColorInt int argb, int onMs, int offMs) {
3754            mN.ledARGB = argb;
3755            mN.ledOnMS = onMs;
3756            mN.ledOffMS = offMs;
3757            if (onMs != 0 || offMs != 0) {
3758                mN.flags |= FLAG_SHOW_LIGHTS;
3759            }
3760            return this;
3761        }
3762
3763        /**
3764         * Set whether this is an "ongoing" notification.
3765         *
3766
3767         * Ongoing notifications cannot be dismissed by the user, so your application or service
3768         * must take care of canceling them.
3769         *
3770
3771         * They are typically used to indicate a background task that the user is actively engaged
3772         * with (e.g., playing music) or is pending in some way and therefore occupying the device
3773         * (e.g., a file download, sync operation, active network connection).
3774         *
3775
3776         * @see Notification#FLAG_ONGOING_EVENT
3777         * @see Service#setForeground(boolean)
3778         */
3779        public Builder setOngoing(boolean ongoing) {
3780            setFlag(FLAG_ONGOING_EVENT, ongoing);
3781            return this;
3782        }
3783
3784        /**
3785         * Set whether this notification should be colorized. When set, the color set with
3786         * {@link #setColor(int)} will be used as the background color of this notification.
3787         * <p>
3788         * This should only be used for high priority ongoing tasks like navigation, an ongoing
3789         * call, or other similarly high-priority events for the user.
3790         * <p>
3791         * For most styles, the coloring will only be applied if the notification is for a
3792         * foreground service notification.
3793         * However, for {@link MediaStyle} and {@link DecoratedMediaCustomViewStyle} notifications
3794         * that have a media session attached there is no such requirement.
3795         *
3796         * @see Builder#setColor(int)
3797         * @see MediaStyle#setMediaSession(MediaSession.Token)
3798         */
3799        public Builder setColorized(boolean colorize) {
3800            mN.extras.putBoolean(EXTRA_COLORIZED, colorize);
3801            return this;
3802        }
3803
3804        /**
3805         * Set this flag if you would only like the sound, vibrate
3806         * and ticker to be played if the notification is not already showing.
3807         *
3808         * @see Notification#FLAG_ONLY_ALERT_ONCE
3809         */
3810        public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
3811            setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
3812            return this;
3813        }
3814
3815        /**
3816         * Make this notification automatically dismissed when the user touches it.
3817         *
3818         * @see Notification#FLAG_AUTO_CANCEL
3819         */
3820        public Builder setAutoCancel(boolean autoCancel) {
3821            setFlag(FLAG_AUTO_CANCEL, autoCancel);
3822            return this;
3823        }
3824
3825        /**
3826         * Set whether or not this notification should not bridge to other devices.
3827         *
3828         * <p>Some notifications can be bridged to other devices for remote display.
3829         * This hint can be set to recommend this notification not be bridged.
3830         */
3831        public Builder setLocalOnly(boolean localOnly) {
3832            setFlag(FLAG_LOCAL_ONLY, localOnly);
3833            return this;
3834        }
3835
3836        /**
3837         * Set which notification properties will be inherited from system defaults.
3838         * <p>
3839         * The value should be one or more of the following fields combined with
3840         * bitwise-or:
3841         * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
3842         * <p>
3843         * For all default values, use {@link #DEFAULT_ALL}.
3844         *
3845         * @deprecated use {@link NotificationChannel#enableVibration(boolean)} and
3846         * {@link NotificationChannel#enableLights(boolean)} and
3847         * {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
3848         */
3849        @Deprecated
3850        public Builder setDefaults(int defaults) {
3851            mN.defaults = defaults;
3852            return this;
3853        }
3854
3855        /**
3856         * Set the priority of this notification.
3857         *
3858         * @see Notification#priority
3859         * @deprecated use {@link NotificationChannel#setImportance(int)} instead.
3860         */
3861        @Deprecated
3862        public Builder setPriority(@Priority int pri) {
3863            mN.priority = pri;
3864            return this;
3865        }
3866
3867        /**
3868         * Set the notification category.
3869         *
3870         * @see Notification#category
3871         */
3872        public Builder setCategory(String category) {
3873            mN.category = category;
3874            return this;
3875        }
3876
3877        /**
3878         * Add a person that is relevant to this notification.
3879         *
3880         * <P>
3881         * Depending on user preferences, this annotation may allow the notification to pass
3882         * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3883         * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3884         * appear more prominently in the user interface.
3885         * </P>
3886         *
3887         * <P>
3888         * The person should be specified by the {@code String} representation of a
3889         * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
3890         * </P>
3891         *
3892         * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
3893         * URIs.  The path part of these URIs must exist in the contacts database, in the
3894         * appropriate column, or the reference will be discarded as invalid. Telephone schema
3895         * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
3896         * It is also possible to provide a URI with the schema {@code name:} in order to uniquely
3897         * identify a person without an entry in the contacts database.
3898         * </P>
3899         *
3900         * @param uri A URI for the person.
3901         * @see Notification#EXTRA_PEOPLE
3902         * @deprecated use {@link #addPerson(Person)}
3903         */
3904        public Builder addPerson(String uri) {
3905            addPerson(new Person().setUri(uri));
3906            return this;
3907        }
3908
3909        /**
3910         * Add a person that is relevant to this notification.
3911         *
3912         * <P>
3913         * Depending on user preferences, this annotation may allow the notification to pass
3914         * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3915         * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3916         * appear more prominently in the user interface.
3917         * </P>
3918         *
3919         * <P>
3920         * A person should usually contain a uri in order to benefit from the ranking boost.
3921         * However, even if no uri is provided, it's beneficial to provide other people in the
3922         * notification, such that listeners and voice only devices can announce and handle them
3923         * properly.
3924         * </P>
3925         *
3926         * @param person the person to add.
3927         * @see Notification#EXTRA_PEOPLE_LIST
3928         */
3929        public Builder addPerson(Person person) {
3930            mPersonList.add(person);
3931            return this;
3932        }
3933
3934        /**
3935         * Set this notification to be part of a group of notifications sharing the same key.
3936         * Grouped notifications may display in a cluster or stack on devices which
3937         * support such rendering.
3938         *
3939         * <p>To make this notification the summary for its group, also call
3940         * {@link #setGroupSummary}. A sort order can be specified for group members by using
3941         * {@link #setSortKey}.
3942         * @param groupKey The group key of the group.
3943         * @return this object for method chaining
3944         */
3945        public Builder setGroup(String groupKey) {
3946            mN.mGroupKey = groupKey;
3947            return this;
3948        }
3949
3950        /**
3951         * Set this notification to be the group summary for a group of notifications.
3952         * Grouped notifications may display in a cluster or stack on devices which
3953         * support such rendering. If thereRequires a group key also be set using {@link #setGroup}.
3954         * The group summary may be suppressed if too few notifications are included in the group.
3955         * @param isGroupSummary Whether this notification should be a group summary.
3956         * @return this object for method chaining
3957         */
3958        public Builder setGroupSummary(boolean isGroupSummary) {
3959            setFlag(FLAG_GROUP_SUMMARY, isGroupSummary);
3960            return this;
3961        }
3962
3963        /**
3964         * Set a sort key that orders this notification among other notifications from the
3965         * same package. This can be useful if an external sort was already applied and an app
3966         * would like to preserve this. Notifications will be sorted lexicographically using this
3967         * value, although providing different priorities in addition to providing sort key may
3968         * cause this value to be ignored.
3969         *
3970         * <p>This sort key can also be used to order members of a notification group. See
3971         * {@link #setGroup}.
3972         *
3973         * @see String#compareTo(String)
3974         */
3975        public Builder setSortKey(String sortKey) {
3976            mN.mSortKey = sortKey;
3977            return this;
3978        }
3979
3980        /**
3981         * Merge additional metadata into this notification.
3982         *
3983         * <p>Values within the Bundle will replace existing extras values in this Builder.
3984         *
3985         * @see Notification#extras
3986         */
3987        public Builder addExtras(Bundle extras) {
3988            if (extras != null) {
3989                mUserExtras.putAll(extras);
3990            }
3991            return this;
3992        }
3993
3994        /**
3995         * Set metadata for this notification.
3996         *
3997         * <p>A reference to the Bundle is held for the lifetime of this Builder, and the Bundle's
3998         * current contents are copied into the Notification each time {@link #build()} is
3999         * called.
4000         *
4001         * <p>Replaces any existing extras values with those from the provided Bundle.
4002         * Use {@link #addExtras} to merge in metadata instead.
4003         *
4004         * @see Notification#extras
4005         */
4006        public Builder setExtras(Bundle extras) {
4007            if (extras != null) {
4008                mUserExtras = extras;
4009            }
4010            return this;
4011        }
4012
4013        /**
4014         * Get the current metadata Bundle used by this notification Builder.
4015         *
4016         * <p>The returned Bundle is shared with this Builder.
4017         *
4018         * <p>The current contents of this Bundle are copied into the Notification each time
4019         * {@link #build()} is called.
4020         *
4021         * @see Notification#extras
4022         */
4023        public Bundle getExtras() {
4024            return mUserExtras;
4025        }
4026
4027        private Bundle getAllExtras() {
4028            final Bundle saveExtras = (Bundle) mUserExtras.clone();
4029            saveExtras.putAll(mN.extras);
4030            return saveExtras;
4031        }
4032
4033        /**
4034         * Add an action to this notification. Actions are typically displayed by
4035         * the system as a button adjacent to the notification content.
4036         * <p>
4037         * Every action must have an icon (32dp square and matching the
4038         * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4039         * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4040         * <p>
4041         * A notification in its expanded form can display up to 3 actions, from left to right in
4042         * the order they were added. Actions will not be displayed when the notification is
4043         * collapsed, however, so be sure that any essential functions may be accessed by the user
4044         * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
4045         *
4046         * @param icon Resource ID of a drawable that represents the action.
4047         * @param title Text describing the action.
4048         * @param intent PendingIntent to be fired when the action is invoked.
4049         *
4050         * @deprecated Use {@link #addAction(Action)} instead.
4051         */
4052        @Deprecated
4053        public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
4054            mActions.add(new Action(icon, safeCharSequence(title), intent));
4055            return this;
4056        }
4057
4058        /**
4059         * Add an action to this notification. Actions are typically displayed by
4060         * the system as a button adjacent to the notification content.
4061         * <p>
4062         * Every action must have an icon (32dp square and matching the
4063         * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4064         * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4065         * <p>
4066         * A notification in its expanded form can display up to 3 actions, from left to right in
4067         * the order they were added. Actions will not be displayed when the notification is
4068         * collapsed, however, so be sure that any essential functions may be accessed by the user
4069         * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
4070         *
4071         * @param action The action to add.
4072         */
4073        public Builder addAction(Action action) {
4074            if (action != null) {
4075                mActions.add(action);
4076            }
4077            return this;
4078        }
4079
4080        /**
4081         * Alter the complete list of actions attached to this notification.
4082         * @see #addAction(Action).
4083         *
4084         * @param actions
4085         * @return
4086         */
4087        public Builder setActions(Action... actions) {
4088            mActions.clear();
4089            for (int i = 0; i < actions.length; i++) {
4090                if (actions[i] != null) {
4091                    mActions.add(actions[i]);
4092                }
4093            }
4094            return this;
4095        }
4096
4097        /**
4098         * Add a rich notification style to be applied at build time.
4099         *
4100         * @param style Object responsible for modifying the notification style.
4101         */
4102        public Builder setStyle(Style style) {
4103            if (mStyle != style) {
4104                mStyle = style;
4105                if (mStyle != null) {
4106                    mStyle.setBuilder(this);
4107                    mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName());
4108                }  else {
4109                    mN.extras.remove(EXTRA_TEMPLATE);
4110                }
4111            }
4112            return this;
4113        }
4114
4115        /**
4116         * Returns the style set by {@link #setStyle(Style)}.
4117         */
4118        public Style getStyle() {
4119            return mStyle;
4120        }
4121
4122        /**
4123         * Specify the value of {@link #visibility}.
4124         *
4125         * @return The same Builder.
4126         */
4127        public Builder setVisibility(@Visibility int visibility) {
4128            mN.visibility = visibility;
4129            return this;
4130        }
4131
4132        /**
4133         * Supply a replacement Notification whose contents should be shown in insecure contexts
4134         * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}.
4135         * @param n A replacement notification, presumably with some or all info redacted.
4136         * @return The same Builder.
4137         */
4138        public Builder setPublicVersion(Notification n) {
4139            if (n != null) {
4140                mN.publicVersion = new Notification();
4141                n.cloneInto(mN.publicVersion, /*heavy=*/ true);
4142            } else {
4143                mN.publicVersion = null;
4144            }
4145            return this;
4146        }
4147
4148        /**
4149         * Apply an extender to this notification builder. Extenders may be used to add
4150         * metadata or change options on this builder.
4151         */
4152        public Builder extend(Extender extender) {
4153            extender.extend(this);
4154            return this;
4155        }
4156
4157        /**
4158         * @hide
4159         */
4160        public Builder setFlag(int mask, boolean value) {
4161            if (value) {
4162                mN.flags |= mask;
4163            } else {
4164                mN.flags &= ~mask;
4165            }
4166            return this;
4167        }
4168
4169        /**
4170         * Sets {@link Notification#color}.
4171         *
4172         * @param argb The accent color to use
4173         *
4174         * @return The same Builder.
4175         */
4176        public Builder setColor(@ColorInt int argb) {
4177            mN.color = argb;
4178            sanitizeColor();
4179            return this;
4180        }
4181
4182        private Drawable getProfileBadgeDrawable() {
4183            if (mContext.getUserId() == UserHandle.USER_SYSTEM) {
4184                // This user can never be a badged profile,
4185                // and also includes USER_ALL system notifications.
4186                return null;
4187            }
4188            // Note: This assumes that the current user can read the profile badge of the
4189            // originating user.
4190            return mContext.getPackageManager().getUserBadgeForDensityNoBackground(
4191                    new UserHandle(mContext.getUserId()), 0);
4192        }
4193
4194        private Bitmap getProfileBadge() {
4195            Drawable badge = getProfileBadgeDrawable();
4196            if (badge == null) {
4197                return null;
4198            }
4199            final int size = mContext.getResources().getDimensionPixelSize(
4200                    R.dimen.notification_badge_size);
4201            Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
4202            Canvas canvas = new Canvas(bitmap);
4203            badge.setBounds(0, 0, size, size);
4204            badge.draw(canvas);
4205            return bitmap;
4206        }
4207
4208        private void bindProfileBadge(RemoteViews contentView) {
4209            Bitmap profileBadge = getProfileBadge();
4210
4211            if (profileBadge != null) {
4212                contentView.setImageViewBitmap(R.id.profile_badge, profileBadge);
4213                contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE);
4214                if (isColorized()) {
4215                    contentView.setDrawableTint(R.id.profile_badge, false,
4216                            getPrimaryTextColor(), PorterDuff.Mode.SRC_ATOP);
4217                }
4218            }
4219        }
4220
4221        /**
4222         * @hide
4223         */
4224        public boolean usesStandardHeader() {
4225            if (mN.mUsesStandardHeader) {
4226                return true;
4227            }
4228            if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.N) {
4229                if (mN.contentView == null && mN.bigContentView == null) {
4230                    return true;
4231                }
4232            }
4233            boolean contentViewUsesHeader = mN.contentView == null
4234                    || STANDARD_LAYOUTS.contains(mN.contentView.getLayoutId());
4235            boolean bigContentViewUsesHeader = mN.bigContentView == null
4236                    || STANDARD_LAYOUTS.contains(mN.bigContentView.getLayoutId());
4237            return contentViewUsesHeader && bigContentViewUsesHeader;
4238        }
4239
4240        private void resetStandardTemplate(RemoteViews contentView) {
4241            resetNotificationHeader(contentView);
4242            resetContentMargins(contentView);
4243            contentView.setViewVisibility(R.id.right_icon, View.GONE);
4244            contentView.setViewVisibility(R.id.title, View.GONE);
4245            contentView.setTextViewText(R.id.title, null);
4246            contentView.setViewVisibility(R.id.text, View.GONE);
4247            contentView.setTextViewText(R.id.text, null);
4248            contentView.setViewVisibility(R.id.text_line_1, View.GONE);
4249            contentView.setTextViewText(R.id.text_line_1, null);
4250        }
4251
4252        /**
4253         * Resets the notification header to its original state
4254         */
4255        private void resetNotificationHeader(RemoteViews contentView) {
4256            // Small icon doesn't need to be reset, as it's always set. Resetting would prevent
4257            // re-using the drawable when the notification is updated.
4258            contentView.setBoolean(R.id.notification_header, "setExpanded", false);
4259            contentView.setTextViewText(R.id.app_name_text, null);
4260            contentView.setViewVisibility(R.id.chronometer, View.GONE);
4261            contentView.setViewVisibility(R.id.header_text, View.GONE);
4262            contentView.setTextViewText(R.id.header_text, null);
4263            contentView.setViewVisibility(R.id.header_text_secondary, View.GONE);
4264            contentView.setTextViewText(R.id.header_text_secondary, null);
4265            contentView.setViewVisibility(R.id.header_text_divider, View.GONE);
4266            contentView.setViewVisibility(R.id.header_text_secondary_divider, View.GONE);
4267            contentView.setViewVisibility(R.id.time_divider, View.GONE);
4268            contentView.setViewVisibility(R.id.time, View.GONE);
4269            contentView.setImageViewIcon(R.id.profile_badge, null);
4270            contentView.setViewVisibility(R.id.profile_badge, View.GONE);
4271            mN.mUsesStandardHeader = false;
4272        }
4273
4274        private void resetContentMargins(RemoteViews contentView) {
4275            contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
4276            contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
4277        }
4278
4279        private RemoteViews applyStandardTemplate(int resId) {
4280            return applyStandardTemplate(resId, mParams.reset().fillTextsFrom(this));
4281        }
4282
4283        /**
4284         * @param hasProgress whether the progress bar should be shown and set
4285         */
4286        private RemoteViews applyStandardTemplate(int resId, boolean hasProgress) {
4287            return applyStandardTemplate(resId, mParams.reset().hasProgress(hasProgress)
4288                    .fillTextsFrom(this));
4289        }
4290
4291        private RemoteViews applyStandardTemplate(int resId, StandardTemplateParams p) {
4292            RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId);
4293
4294            resetStandardTemplate(contentView);
4295
4296            final Bundle ex = mN.extras;
4297            updateBackgroundColor(contentView);
4298            bindNotificationHeader(contentView, p.ambient, p.headerTextSecondary);
4299            bindLargeIcon(contentView, p.hideLargeIcon || p.ambient, p.alwaysShowReply);
4300            boolean showProgress = handleProgressBar(p.hasProgress, contentView, ex);
4301            if (p.title != null) {
4302                contentView.setViewVisibility(R.id.title, View.VISIBLE);
4303                contentView.setTextViewText(R.id.title, processTextSpans(p.title));
4304                if (!p.ambient) {
4305                    setTextViewColorPrimary(contentView, R.id.title);
4306                }
4307                contentView.setViewLayoutWidth(R.id.title, showProgress
4308                        ? ViewGroup.LayoutParams.WRAP_CONTENT
4309                        : ViewGroup.LayoutParams.MATCH_PARENT);
4310            }
4311            if (p.text != null) {
4312                int textId = showProgress ? com.android.internal.R.id.text_line_1
4313                        : com.android.internal.R.id.text;
4314                contentView.setTextViewText(textId, processTextSpans(p.text));
4315                if (!p.ambient) {
4316                    setTextViewColorSecondary(contentView, textId);
4317                }
4318                contentView.setViewVisibility(textId, View.VISIBLE);
4319            }
4320
4321            setContentMinHeight(contentView, showProgress || mN.hasLargeIcon());
4322
4323            return contentView;
4324        }
4325
4326        private CharSequence processTextSpans(CharSequence text) {
4327            if (hasForegroundColor()) {
4328                return NotificationColorUtil.clearColorSpans(text);
4329            }
4330            return text;
4331        }
4332
4333        private void setTextViewColorPrimary(RemoteViews contentView, int id) {
4334            ensureColors();
4335            contentView.setTextColor(id, mPrimaryTextColor);
4336        }
4337
4338        private boolean hasForegroundColor() {
4339            return mForegroundColor != COLOR_INVALID;
4340        }
4341
4342        /**
4343         * @return the primary text color
4344         * @hide
4345         */
4346        @VisibleForTesting
4347        public int getPrimaryTextColor() {
4348            ensureColors();
4349            return mPrimaryTextColor;
4350        }
4351
4352        /**
4353         * @return the secondary text color
4354         * @hide
4355         */
4356        @VisibleForTesting
4357        public int getSecondaryTextColor() {
4358            ensureColors();
4359            return mSecondaryTextColor;
4360        }
4361
4362        private int getActionBarColor() {
4363            ensureColors();
4364            return mActionBarColor;
4365        }
4366
4367        private int getActionBarColorDeEmphasized() {
4368            int backgroundColor = getBackgroundColor();
4369            return NotificationColorUtil.getShiftedColor(backgroundColor, 12);
4370        }
4371
4372        private void setTextViewColorSecondary(RemoteViews contentView, int id) {
4373            ensureColors();
4374            contentView.setTextColor(id, mSecondaryTextColor);
4375        }
4376
4377        private void ensureColors() {
4378            int backgroundColor = getBackgroundColor();
4379            if (mPrimaryTextColor == COLOR_INVALID
4380                    || mSecondaryTextColor == COLOR_INVALID
4381                    || mActionBarColor == COLOR_INVALID
4382                    || mTextColorsAreForBackground != backgroundColor) {
4383                mTextColorsAreForBackground = backgroundColor;
4384                if (!hasForegroundColor() || !isColorized()) {
4385                    mPrimaryTextColor = NotificationColorUtil.resolvePrimaryColor(mContext,
4386                            backgroundColor);
4387                    mSecondaryTextColor = NotificationColorUtil.resolveSecondaryColor(mContext,
4388                            backgroundColor);
4389                    if (backgroundColor != COLOR_DEFAULT && isColorized()) {
4390                        mPrimaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4391                                mPrimaryTextColor, backgroundColor, 4.5);
4392                        mSecondaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4393                                mSecondaryTextColor, backgroundColor, 4.5);
4394                    }
4395                } else {
4396                    double backLum = NotificationColorUtil.calculateLuminance(backgroundColor);
4397                    double textLum = NotificationColorUtil.calculateLuminance(mForegroundColor);
4398                    double contrast = NotificationColorUtil.calculateContrast(mForegroundColor,
4399                            backgroundColor);
4400                    // We only respect the given colors if worst case Black or White still has
4401                    // contrast
4402                    boolean backgroundLight = backLum > textLum
4403                                    && satisfiesTextContrast(backgroundColor, Color.BLACK)
4404                            || backLum <= textLum
4405                                    && !satisfiesTextContrast(backgroundColor, Color.WHITE);
4406                    if (contrast < 4.5f) {
4407                        if (backgroundLight) {
4408                            mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4409                                    mForegroundColor,
4410                                    backgroundColor,
4411                                    true /* findFG */,
4412                                    4.5f);
4413                            mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
4414                                    mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_LIGHT);
4415                        } else {
4416                            mSecondaryTextColor =
4417                                    NotificationColorUtil.findContrastColorAgainstDark(
4418                                    mForegroundColor,
4419                                    backgroundColor,
4420                                    true /* findFG */,
4421                                    4.5f);
4422                            mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
4423                                    mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_DARK);
4424                        }
4425                    } else {
4426                        mPrimaryTextColor = mForegroundColor;
4427                        mSecondaryTextColor = NotificationColorUtil.changeColorLightness(
4428                                mPrimaryTextColor, backgroundLight ? LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4429                                        : LIGHTNESS_TEXT_DIFFERENCE_DARK);
4430                        if (NotificationColorUtil.calculateContrast(mSecondaryTextColor,
4431                                backgroundColor) < 4.5f) {
4432                            // oh well the secondary is not good enough
4433                            if (backgroundLight) {
4434                                mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4435                                        mSecondaryTextColor,
4436                                        backgroundColor,
4437                                        true /* findFG */,
4438                                        4.5f);
4439                            } else {
4440                                mSecondaryTextColor
4441                                        = NotificationColorUtil.findContrastColorAgainstDark(
4442                                        mSecondaryTextColor,
4443                                        backgroundColor,
4444                                        true /* findFG */,
4445                                        4.5f);
4446                            }
4447                            mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
4448                                    mSecondaryTextColor, backgroundLight
4449                                            ? -LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4450                                            : -LIGHTNESS_TEXT_DIFFERENCE_DARK);
4451                        }
4452                    }
4453                }
4454                mActionBarColor = NotificationColorUtil.resolveActionBarColor(mContext,
4455                        backgroundColor);
4456            }
4457        }
4458
4459        private void updateBackgroundColor(RemoteViews contentView) {
4460            if (isColorized()) {
4461                contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundColor",
4462                        getBackgroundColor());
4463            } else {
4464                // Clear it!
4465                contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundResource",
4466                        0);
4467            }
4468        }
4469
4470        /**
4471         * @param remoteView the remote view to update the minheight in
4472         * @param hasMinHeight does it have a mimHeight
4473         * @hide
4474         */
4475        void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) {
4476            int minHeight = 0;
4477            if (hasMinHeight) {
4478                // we need to set the minHeight of the notification
4479                minHeight = mContext.getResources().getDimensionPixelSize(
4480                        com.android.internal.R.dimen.notification_min_content_height);
4481            }
4482            remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight);
4483        }
4484
4485        private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) {
4486            final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0);
4487            final int progress = ex.getInt(EXTRA_PROGRESS, 0);
4488            final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
4489            if (hasProgress && (max != 0 || ind)) {
4490                contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE);
4491                contentView.setProgressBar(
4492                        R.id.progress, max, progress, ind);
4493                contentView.setProgressBackgroundTintList(
4494                        R.id.progress, ColorStateList.valueOf(mContext.getColor(
4495                                R.color.notification_progress_background_color)));
4496                if (mN.color != COLOR_DEFAULT) {
4497                    ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor());
4498                    contentView.setProgressTintList(R.id.progress, colorStateList);
4499                    contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList);
4500                }
4501                return true;
4502            } else {
4503                contentView.setViewVisibility(R.id.progress, View.GONE);
4504                return false;
4505            }
4506        }
4507
4508        private void bindLargeIcon(RemoteViews contentView, boolean hideLargeIcon,
4509                boolean alwaysShowReply) {
4510            if (mN.mLargeIcon == null && mN.largeIcon != null) {
4511                mN.mLargeIcon = Icon.createWithBitmap(mN.largeIcon);
4512            }
4513            boolean showLargeIcon = mN.mLargeIcon != null && !hideLargeIcon;
4514            if (showLargeIcon) {
4515                contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4516                contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon);
4517                processLargeLegacyIcon(mN.mLargeIcon, contentView);
4518                int endMargin = R.dimen.notification_content_picture_margin;
4519                contentView.setViewLayoutMarginEndDimen(R.id.line1, endMargin);
4520                contentView.setViewLayoutMarginEndDimen(R.id.text, endMargin);
4521                contentView.setViewLayoutMarginEndDimen(R.id.progress, endMargin);
4522            }
4523            // Bind the reply action
4524            Action action = findReplyAction();
4525
4526            boolean actionVisible = action != null && (showLargeIcon || alwaysShowReply);
4527            int replyId = showLargeIcon ? R.id.reply_icon_action : R.id.right_icon;
4528            if (actionVisible) {
4529                // We're only showing the icon as big if we're hiding the large icon
4530                int contrastColor = resolveContrastColor();
4531                int iconColor;
4532                if (showLargeIcon) {
4533                    contentView.setDrawableTint(R.id.reply_icon_action,
4534                            true /* targetBackground */,
4535                            contrastColor, PorterDuff.Mode.SRC_ATOP);
4536                    contentView.setOnClickPendingIntent(R.id.right_icon,
4537                            action.actionIntent);
4538                    contentView.setRemoteInputs(R.id.right_icon, action.mRemoteInputs);
4539                    iconColor = NotificationColorUtil.isColorLight(contrastColor)
4540                            ? Color.BLACK : Color.WHITE;
4541                } else {
4542                    contentView.setImageViewResource(R.id.right_icon,
4543                            R.drawable.ic_reply_notification_large);
4544                    contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4545                    iconColor = contrastColor;
4546                }
4547                contentView.setDrawableTint(replyId,
4548                        false /* targetBackground */,
4549                        iconColor,
4550                        PorterDuff.Mode.SRC_ATOP);
4551                contentView.setOnClickPendingIntent(replyId,
4552                        action.actionIntent);
4553                contentView.setRemoteInputs(replyId, action.mRemoteInputs);
4554            } else {
4555                contentView.setRemoteInputs(R.id.right_icon, null);
4556            }
4557            contentView.setViewVisibility(R.id.reply_icon_action, actionVisible && showLargeIcon
4558                    ? View.VISIBLE
4559                    : View.GONE);
4560            contentView.setViewVisibility(R.id.right_icon_container, actionVisible || showLargeIcon
4561                    ? View.VISIBLE
4562                    : View.GONE);
4563        }
4564
4565        private Action findReplyAction() {
4566            ArrayList<Action> actions = mActions;
4567            if (mOriginalActions != null) {
4568                actions = mOriginalActions;
4569            }
4570            int numActions = actions.size();
4571            for (int i = 0; i < numActions; i++) {
4572                Action action = actions.get(i);
4573                if (hasValidRemoteInput(action)) {
4574                    return action;
4575                }
4576            }
4577            return null;
4578        }
4579
4580        private void bindNotificationHeader(RemoteViews contentView, boolean ambient,
4581                CharSequence secondaryHeaderText) {
4582            bindSmallIcon(contentView, ambient);
4583            bindHeaderAppName(contentView, ambient);
4584            if (!ambient) {
4585                // Ambient view does not have these
4586                bindHeaderText(contentView);
4587                bindHeaderTextSecondary(contentView, secondaryHeaderText);
4588                bindHeaderChronometerAndTime(contentView);
4589                bindProfileBadge(contentView);
4590            }
4591            bindExpandButton(contentView);
4592            mN.mUsesStandardHeader = true;
4593        }
4594
4595        private void bindExpandButton(RemoteViews contentView) {
4596            int color = isColorized() ? getPrimaryTextColor() : getSecondaryTextColor();
4597            contentView.setDrawableTint(R.id.expand_button, false, color,
4598                    PorterDuff.Mode.SRC_ATOP);
4599            contentView.setInt(R.id.notification_header, "setOriginalNotificationColor",
4600                    color);
4601        }
4602
4603        private void bindHeaderChronometerAndTime(RemoteViews contentView) {
4604            if (showsTimeOrChronometer()) {
4605                contentView.setViewVisibility(R.id.time_divider, View.VISIBLE);
4606                setTextViewColorSecondary(contentView, R.id.time_divider);
4607                if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) {
4608                    contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
4609                    contentView.setLong(R.id.chronometer, "setBase",
4610                            mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
4611                    contentView.setBoolean(R.id.chronometer, "setStarted", true);
4612                    boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN);
4613                    contentView.setChronometerCountDown(R.id.chronometer, countsDown);
4614                    setTextViewColorSecondary(contentView, R.id.chronometer);
4615                } else {
4616                    contentView.setViewVisibility(R.id.time, View.VISIBLE);
4617                    contentView.setLong(R.id.time, "setTime", mN.when);
4618                    setTextViewColorSecondary(contentView, R.id.time);
4619                }
4620            } else {
4621                // We still want a time to be set but gone, such that we can show and hide it
4622                // on demand in case it's a child notification without anything in the header
4623                contentView.setLong(R.id.time, "setTime", mN.when != 0 ? mN.when : mN.creationTime);
4624            }
4625        }
4626
4627        private void bindHeaderText(RemoteViews contentView) {
4628            CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
4629            if (headerText == null && mStyle != null && mStyle.mSummaryTextSet
4630                    && mStyle.hasSummaryInHeader()) {
4631                headerText = mStyle.mSummaryText;
4632            }
4633            if (headerText == null
4634                    && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
4635                    && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) {
4636                headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT);
4637            }
4638            if (headerText != null) {
4639                // TODO: Remove the span entirely to only have the string with propper formating.
4640                contentView.setTextViewText(R.id.header_text, processTextSpans(
4641                        processLegacyText(headerText)));
4642                setTextViewColorSecondary(contentView, R.id.header_text);
4643                contentView.setViewVisibility(R.id.header_text, View.VISIBLE);
4644                contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE);
4645                setTextViewColorSecondary(contentView, R.id.header_text_divider);
4646            }
4647        }
4648
4649        private void bindHeaderTextSecondary(RemoteViews contentView, CharSequence secondaryText) {
4650            if (!TextUtils.isEmpty(secondaryText)) {
4651                contentView.setTextViewText(R.id.header_text_secondary, processTextSpans(
4652                        processLegacyText(secondaryText)));
4653                setTextViewColorSecondary(contentView, R.id.header_text_secondary);
4654                contentView.setViewVisibility(R.id.header_text_secondary, View.VISIBLE);
4655                contentView.setViewVisibility(R.id.header_text_secondary_divider, View.VISIBLE);
4656                setTextViewColorSecondary(contentView, R.id.header_text_secondary_divider);
4657            }
4658        }
4659
4660        /**
4661         * @hide
4662         */
4663        public String loadHeaderAppName() {
4664            CharSequence name = null;
4665            final PackageManager pm = mContext.getPackageManager();
4666            if (mN.extras.containsKey(EXTRA_SUBSTITUTE_APP_NAME)) {
4667                // only system packages which lump together a bunch of unrelated stuff
4668                // may substitute a different name to make the purpose of the
4669                // notification more clear. the correct package label should always
4670                // be accessible via SystemUI.
4671                final String pkg = mContext.getPackageName();
4672                final String subName = mN.extras.getString(EXTRA_SUBSTITUTE_APP_NAME);
4673                if (PackageManager.PERMISSION_GRANTED == pm.checkPermission(
4674                        android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME, pkg)) {
4675                    name = subName;
4676                } else {
4677                    Log.w(TAG, "warning: pkg "
4678                            + pkg + " attempting to substitute app name '" + subName
4679                            + "' without holding perm "
4680                            + android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME);
4681                }
4682            }
4683            if (TextUtils.isEmpty(name)) {
4684                name = pm.getApplicationLabel(mContext.getApplicationInfo());
4685            }
4686            if (TextUtils.isEmpty(name)) {
4687                // still nothing?
4688                return null;
4689            }
4690
4691            return String.valueOf(name);
4692        }
4693        private void bindHeaderAppName(RemoteViews contentView, boolean ambient) {
4694            contentView.setTextViewText(R.id.app_name_text, loadHeaderAppName());
4695            if (isColorized() && !ambient) {
4696                setTextViewColorPrimary(contentView, R.id.app_name_text);
4697            } else {
4698                contentView.setTextColor(R.id.app_name_text,
4699                        ambient ? resolveAmbientColor() : getSecondaryTextColor());
4700            }
4701        }
4702
4703        private void bindSmallIcon(RemoteViews contentView, boolean ambient) {
4704            if (mN.mSmallIcon == null && mN.icon != 0) {
4705                mN.mSmallIcon = Icon.createWithResource(mContext, mN.icon);
4706            }
4707            contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon);
4708            contentView.setInt(R.id.icon, "setImageLevel", mN.iconLevel);
4709            processSmallIconColor(mN.mSmallIcon, contentView, ambient);
4710        }
4711
4712        /**
4713         * @return true if the built notification will show the time or the chronometer; false
4714         *         otherwise
4715         */
4716        private boolean showsTimeOrChronometer() {
4717            return mN.showsTime() || mN.showsChronometer();
4718        }
4719
4720        private void resetStandardTemplateWithActions(RemoteViews big) {
4721            // actions_container is only reset when there are no actions to avoid focus issues with
4722            // remote inputs.
4723            big.setViewVisibility(R.id.actions, View.GONE);
4724            big.removeAllViews(R.id.actions);
4725
4726            big.setViewVisibility(R.id.notification_material_reply_container, View.GONE);
4727            big.setTextViewText(R.id.notification_material_reply_text_1, null);
4728
4729            big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE);
4730            big.setTextViewText(R.id.notification_material_reply_text_2, null);
4731            big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE);
4732            big.setTextViewText(R.id.notification_material_reply_text_3, null);
4733
4734            big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target,
4735                    R.dimen.notification_content_margin);
4736        }
4737
4738        private RemoteViews applyStandardTemplateWithActions(int layoutId) {
4739            return applyStandardTemplateWithActions(layoutId, mParams.reset().fillTextsFrom(this));
4740        }
4741
4742        private RemoteViews applyStandardTemplateWithActions(int layoutId,
4743            StandardTemplateParams p) {
4744            RemoteViews big = applyStandardTemplate(layoutId, p);
4745
4746            resetStandardTemplateWithActions(big);
4747
4748            boolean validRemoteInput = false;
4749
4750            int N = mActions.size();
4751            boolean emphazisedMode = mN.fullScreenIntent != null && !p.ambient;
4752            big.setBoolean(R.id.actions, "setEmphasizedMode", emphazisedMode);
4753            if (N > 0) {
4754                big.setViewVisibility(R.id.actions_container, View.VISIBLE);
4755                big.setViewVisibility(R.id.actions, View.VISIBLE);
4756                big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, 0);
4757                if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
4758                for (int i=0; i<N; i++) {
4759                    Action action = mActions.get(i);
4760                    boolean actionHasValidInput = hasValidRemoteInput(action);
4761                    validRemoteInput |= actionHasValidInput;
4762
4763                    final RemoteViews button = generateActionButton(action, emphazisedMode,
4764                            i % 2 != 0, p.ambient);
4765                    if (actionHasValidInput) {
4766                        // Clear the drawable
4767                        button.setInt(R.id.action0, "setBackgroundResource", 0);
4768                    }
4769                    big.addView(R.id.actions, button);
4770                }
4771            } else {
4772                big.setViewVisibility(R.id.actions_container, View.GONE);
4773            }
4774
4775            CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
4776            if (!p.ambient && validRemoteInput && replyText != null
4777                    && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])) {
4778                big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE);
4779                big.setTextViewText(R.id.notification_material_reply_text_1,
4780                        processTextSpans(replyText[0]));
4781                setTextViewColorSecondary(big, R.id.notification_material_reply_text_1);
4782
4783                if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])) {
4784                    big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE);
4785                    big.setTextViewText(R.id.notification_material_reply_text_2,
4786                            processTextSpans(replyText[1]));
4787                    setTextViewColorSecondary(big, R.id.notification_material_reply_text_2);
4788
4789                    if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])) {
4790                        big.setViewVisibility(
4791                                R.id.notification_material_reply_text_3, View.VISIBLE);
4792                        big.setTextViewText(R.id.notification_material_reply_text_3,
4793                                processTextSpans(replyText[2]));
4794                        setTextViewColorSecondary(big, R.id.notification_material_reply_text_3);
4795                    }
4796                }
4797            }
4798
4799            return big;
4800        }
4801
4802        private boolean hasValidRemoteInput(Action action) {
4803            if (TextUtils.isEmpty(action.title) || action.actionIntent == null) {
4804                // Weird actions
4805                return false;
4806            }
4807
4808            RemoteInput[] remoteInputs = action.getRemoteInputs();
4809            if (remoteInputs == null) {
4810                return false;
4811            }
4812
4813            for (RemoteInput r : remoteInputs) {
4814                CharSequence[] choices = r.getChoices();
4815                if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) {
4816                    return true;
4817                }
4818            }
4819            return false;
4820        }
4821
4822        /**
4823         * Construct a RemoteViews for the final 1U notification layout. In order:
4824         *   1. Custom contentView from the caller
4825         *   2. Style's proposed content view
4826         *   3. Standard template view
4827         */
4828        public RemoteViews createContentView() {
4829            return createContentView(false /* increasedheight */ );
4830        }
4831
4832        /**
4833         * Construct a RemoteViews for the smaller content view.
4834         *
4835         *   @param increasedHeight true if this layout be created with an increased height. Some
4836         *   styles may support showing more then just that basic 1U size
4837         *   and the system may decide to render important notifications
4838         *   slightly bigger even when collapsed.
4839         *
4840         *   @hide
4841         */
4842        public RemoteViews createContentView(boolean increasedHeight) {
4843            if (mN.contentView != null && useExistingRemoteView()) {
4844                return mN.contentView;
4845            } else if (mStyle != null) {
4846                final RemoteViews styleView = mStyle.makeContentView(increasedHeight);
4847                if (styleView != null) {
4848                    return styleView;
4849                }
4850            }
4851            return applyStandardTemplate(getBaseLayoutResource());
4852        }
4853
4854        private boolean useExistingRemoteView() {
4855            return mStyle == null || (!mStyle.displayCustomViewInline()
4856                    && !mRebuildStyledRemoteViews);
4857        }
4858
4859        /**
4860         * Construct a RemoteViews for the final big notification layout.
4861         */
4862        public RemoteViews createBigContentView() {
4863            RemoteViews result = null;
4864            if (mN.bigContentView != null && useExistingRemoteView()) {
4865                return mN.bigContentView;
4866            } else if (mStyle != null) {
4867                result = mStyle.makeBigContentView();
4868                hideLine1Text(result);
4869            } else if (mActions.size() != 0) {
4870                result = applyStandardTemplateWithActions(getBigBaseLayoutResource());
4871            }
4872            makeHeaderExpanded(result);
4873            return result;
4874        }
4875
4876        /**
4877         * Construct a RemoteViews for the final notification header only. This will not be
4878         * colorized.
4879         *
4880         * @param ambient if true, generate the header for the ambient display layout.
4881         * @hide
4882         */
4883        public RemoteViews makeNotificationHeader(boolean ambient) {
4884            Boolean colorized = (Boolean) mN.extras.get(EXTRA_COLORIZED);
4885            mN.extras.putBoolean(EXTRA_COLORIZED, false);
4886            RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(),
4887                    ambient ? R.layout.notification_template_ambient_header
4888                            : R.layout.notification_template_header);
4889            resetNotificationHeader(header);
4890            bindNotificationHeader(header, ambient, null);
4891            if (colorized != null) {
4892                mN.extras.putBoolean(EXTRA_COLORIZED, colorized);
4893            } else {
4894                mN.extras.remove(EXTRA_COLORIZED);
4895            }
4896            return header;
4897        }
4898
4899        /**
4900         * Construct a RemoteViews for the ambient version of the notification.
4901         *
4902         * @hide
4903         */
4904        public RemoteViews makeAmbientNotification() {
4905            RemoteViews ambient = applyStandardTemplateWithActions(
4906                    R.layout.notification_template_material_ambient,
4907                    mParams.reset().ambient(true).fillTextsFrom(this).hasProgress(false));
4908            return ambient;
4909        }
4910
4911        private void hideLine1Text(RemoteViews result) {
4912            if (result != null) {
4913                result.setViewVisibility(R.id.text_line_1, View.GONE);
4914            }
4915        }
4916
4917        /**
4918         * Adapt the Notification header if this view is used as an expanded view.
4919         *
4920         * @hide
4921         */
4922        public static void makeHeaderExpanded(RemoteViews result) {
4923            if (result != null) {
4924                result.setBoolean(R.id.notification_header, "setExpanded", true);
4925            }
4926        }
4927
4928        /**
4929         * Construct a RemoteViews for the final heads-up notification layout.
4930         *
4931         * @param increasedHeight true if this layout be created with an increased height. Some
4932         * styles may support showing more then just that basic 1U size
4933         * and the system may decide to render important notifications
4934         * slightly bigger even when collapsed.
4935         *
4936         * @hide
4937         */
4938        public RemoteViews createHeadsUpContentView(boolean increasedHeight) {
4939            if (mN.headsUpContentView != null && useExistingRemoteView()) {
4940                return mN.headsUpContentView;
4941            } else if (mStyle != null) {
4942                final RemoteViews styleView = mStyle.makeHeadsUpContentView(increasedHeight);
4943                if (styleView != null) {
4944                    return styleView;
4945                }
4946            } else if (mActions.size() == 0) {
4947                return null;
4948            }
4949
4950            return applyStandardTemplateWithActions(getBigBaseLayoutResource());
4951        }
4952
4953        /**
4954         * Construct a RemoteViews for the final heads-up notification layout.
4955         */
4956        public RemoteViews createHeadsUpContentView() {
4957            return createHeadsUpContentView(false /* useIncreasedHeight */);
4958        }
4959
4960        /**
4961         * Construct a RemoteViews for the display in public contexts like on the lockscreen.
4962         *
4963         * @hide
4964         */
4965        public RemoteViews makePublicContentView() {
4966            return makePublicView(false /* ambient */);
4967        }
4968
4969        /**
4970         * Construct a RemoteViews for the display in public contexts like on the lockscreen.
4971         *
4972         * @hide
4973         */
4974        public RemoteViews makePublicAmbientNotification() {
4975            return makePublicView(true /* ambient */);
4976        }
4977
4978        private RemoteViews makePublicView(boolean ambient) {
4979            if (mN.publicVersion != null) {
4980                final Builder builder = recoverBuilder(mContext, mN.publicVersion);
4981                return ambient ? builder.makeAmbientNotification() : builder.createContentView();
4982            }
4983            Bundle savedBundle = mN.extras;
4984            Style style = mStyle;
4985            mStyle = null;
4986            Icon largeIcon = mN.mLargeIcon;
4987            mN.mLargeIcon = null;
4988            Bitmap largeIconLegacy = mN.largeIcon;
4989            mN.largeIcon = null;
4990            ArrayList<Action> actions = mActions;
4991            mActions = new ArrayList<>();
4992            Bundle publicExtras = new Bundle();
4993            publicExtras.putBoolean(EXTRA_SHOW_WHEN,
4994                    savedBundle.getBoolean(EXTRA_SHOW_WHEN));
4995            publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER,
4996                    savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER));
4997            publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN,
4998                    savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN));
4999            mN.extras = publicExtras;
5000            RemoteViews view;
5001            if (ambient) {
5002                publicExtras.putCharSequence(EXTRA_TITLE,
5003                        mContext.getString(com.android.internal.R.string.notification_hidden_text));
5004                view = makeAmbientNotification();
5005            } else{
5006                view = makeNotificationHeader(false /* ambient */);
5007                view.setBoolean(R.id.notification_header, "setExpandOnlyOnButton", true);
5008            }
5009            mN.extras = savedBundle;
5010            mN.mLargeIcon = largeIcon;
5011            mN.largeIcon = largeIconLegacy;
5012            mActions = actions;
5013            mStyle = style;
5014            return view;
5015        }
5016
5017        /**
5018         * Construct a content view for the display when low - priority
5019         *
5020         * @param useRegularSubtext uses the normal subtext set if there is one available. Otherwise
5021         *                          a new subtext is created consisting of the content of the
5022         *                          notification.
5023         * @hide
5024         */
5025        public RemoteViews makeLowPriorityContentView(boolean useRegularSubtext) {
5026            int color = mN.color;
5027            mN.color = COLOR_DEFAULT;
5028            CharSequence summary = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
5029            if (!useRegularSubtext || TextUtils.isEmpty(summary)) {
5030                CharSequence newSummary = createSummaryText();
5031                if (!TextUtils.isEmpty(newSummary)) {
5032                    mN.extras.putCharSequence(EXTRA_SUB_TEXT, newSummary);
5033                }
5034            }
5035
5036            RemoteViews header = makeNotificationHeader(false /* ambient */);
5037            header.setBoolean(R.id.notification_header, "setAcceptAllTouches", true);
5038            if (summary != null) {
5039                mN.extras.putCharSequence(EXTRA_SUB_TEXT, summary);
5040            } else {
5041                mN.extras.remove(EXTRA_SUB_TEXT);
5042            }
5043            mN.color = color;
5044            return header;
5045        }
5046
5047        private CharSequence createSummaryText() {
5048            CharSequence titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE);
5049            if (USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY) {
5050                return titleText;
5051            }
5052            SpannableStringBuilder summary = new SpannableStringBuilder();
5053            if (titleText == null) {
5054                titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE_BIG);
5055            }
5056            BidiFormatter bidi = BidiFormatter.getInstance();
5057            if (titleText != null) {
5058                summary.append(bidi.unicodeWrap(titleText));
5059            }
5060            CharSequence contentText = mN.extras.getCharSequence(Notification.EXTRA_TEXT);
5061            if (titleText != null && contentText != null) {
5062                summary.append(bidi.unicodeWrap(mContext.getText(
5063                        R.string.notification_header_divider_symbol_with_spaces)));
5064            }
5065            if (contentText != null) {
5066                summary.append(bidi.unicodeWrap(contentText));
5067            }
5068            return summary;
5069        }
5070
5071        private RemoteViews generateActionButton(Action action, boolean emphazisedMode,
5072                boolean oddAction, boolean ambient) {
5073            final boolean tombstone = (action.actionIntent == null);
5074            RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(),
5075                    emphazisedMode ? getEmphasizedActionLayoutResource()
5076                            : tombstone ? getActionTombstoneLayoutResource()
5077                                    : getActionLayoutResource());
5078            if (!tombstone) {
5079                button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
5080            }
5081            button.setContentDescription(R.id.action0, action.title);
5082            if (action.mRemoteInputs != null) {
5083                button.setRemoteInputs(R.id.action0, action.mRemoteInputs);
5084            }
5085            // TODO: handle emphasized mode / actions right
5086            if (emphazisedMode) {
5087                // change the background bgColor
5088                int bgColor;
5089                if (isColorized()) {
5090                    bgColor = oddAction ? getActionBarColor() : getActionBarColorDeEmphasized();
5091                } else {
5092                    bgColor = mContext.getColor(oddAction ? R.color.notification_action_list
5093                            : R.color.notification_action_list_dark);
5094                }
5095                button.setDrawableTint(R.id.button_holder, true,
5096                        bgColor, PorterDuff.Mode.SRC_ATOP);
5097                CharSequence title = action.title;
5098                ColorStateList[] outResultColor = null;
5099                if (isLegacy()) {
5100                    title = NotificationColorUtil.clearColorSpans(title);
5101                } else {
5102                    outResultColor = new ColorStateList[1];
5103                    title = ensureColorSpanContrast(title, bgColor, outResultColor);
5104                }
5105                button.setTextViewText(R.id.action0, processTextSpans(title));
5106                setTextViewColorPrimary(button, R.id.action0);
5107                if (outResultColor != null && outResultColor[0] != null) {
5108                    // We need to set the text color as well since changing a text to uppercase
5109                    // clears its spans.
5110                    button.setTextColor(R.id.action0, outResultColor[0]);
5111                } else if (mN.color != COLOR_DEFAULT && !isColorized() && mTintActionButtons) {
5112                    button.setTextColor(R.id.action0,resolveContrastColor());
5113                }
5114            } else {
5115                button.setTextViewText(R.id.action0, processTextSpans(
5116                        processLegacyText(action.title)));
5117                if (isColorized() && !ambient) {
5118                    setTextViewColorPrimary(button, R.id.action0);
5119                } else if (mN.color != COLOR_DEFAULT && mTintActionButtons) {
5120                    button.setTextColor(R.id.action0,
5121                            ambient ? resolveAmbientColor() : resolveContrastColor());
5122                }
5123            }
5124            return button;
5125        }
5126
5127        /**
5128         * Ensures contrast on color spans against a background color. also returns the color of the
5129         * text if a span was found that spans over the whole text.
5130         *
5131         * @param charSequence the charSequence on which the spans are
5132         * @param background the background color to ensure the contrast against
5133         * @param outResultColor an array in which a color will be returned as the first element if
5134         *                    there exists a full length color span.
5135         * @return the contrasted charSequence
5136         */
5137        private CharSequence ensureColorSpanContrast(CharSequence charSequence, int background,
5138                ColorStateList[] outResultColor) {
5139            if (charSequence instanceof Spanned) {
5140                Spanned ss = (Spanned) charSequence;
5141                Object[] spans = ss.getSpans(0, ss.length(), Object.class);
5142                SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
5143                for (Object span : spans) {
5144                    Object resultSpan = span;
5145                    int spanStart = ss.getSpanStart(span);
5146                    int spanEnd = ss.getSpanEnd(span);
5147                    boolean fullLength = (spanEnd - spanStart) == charSequence.length();
5148                    if (resultSpan instanceof CharacterStyle) {
5149                        resultSpan = ((CharacterStyle) span).getUnderlying();
5150                    }
5151                    if (resultSpan instanceof TextAppearanceSpan) {
5152                        TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
5153                        ColorStateList textColor = originalSpan.getTextColor();
5154                        if (textColor != null) {
5155                            int[] colors = textColor.getColors();
5156                            int[] newColors = new int[colors.length];
5157                            for (int i = 0; i < newColors.length; i++) {
5158                                newColors[i] = NotificationColorUtil.ensureLargeTextContrast(
5159                                        colors[i], background, mInNightMode);
5160                            }
5161                            textColor = new ColorStateList(textColor.getStates().clone(),
5162                                    newColors);
5163                            resultSpan = new TextAppearanceSpan(
5164                                    originalSpan.getFamily(),
5165                                    originalSpan.getTextStyle(),
5166                                    originalSpan.getTextSize(),
5167                                    textColor,
5168                                    originalSpan.getLinkTextColor());
5169                            if (fullLength) {
5170                                outResultColor[0] = new ColorStateList(
5171                                        textColor.getStates().clone(), newColors);
5172                            }
5173                        }
5174                    } else if (resultSpan instanceof ForegroundColorSpan) {
5175                        ForegroundColorSpan originalSpan = (ForegroundColorSpan) resultSpan;
5176                        int foregroundColor = originalSpan.getForegroundColor();
5177                        foregroundColor = NotificationColorUtil.ensureLargeTextContrast(
5178                                foregroundColor, background, mInNightMode);
5179                        resultSpan = new ForegroundColorSpan(foregroundColor);
5180                        if (fullLength) {
5181                            outResultColor[0] = ColorStateList.valueOf(foregroundColor);
5182                        }
5183                    } else {
5184                        resultSpan = span;
5185                    }
5186
5187                    builder.setSpan(resultSpan, spanStart, spanEnd, ss.getSpanFlags(span));
5188                }
5189                return builder;
5190            }
5191            return charSequence;
5192        }
5193
5194        /**
5195         * @return Whether we are currently building a notification from a legacy (an app that
5196         *         doesn't create material notifications by itself) app.
5197         */
5198        private boolean isLegacy() {
5199            if (!mIsLegacyInitialized) {
5200                mIsLegacy = mContext.getApplicationInfo().targetSdkVersion
5201                        < Build.VERSION_CODES.LOLLIPOP;
5202                mIsLegacyInitialized = true;
5203            }
5204            return mIsLegacy;
5205        }
5206
5207        private CharSequence processLegacyText(CharSequence charSequence) {
5208            return processLegacyText(charSequence, false /* ambient */);
5209        }
5210
5211        private CharSequence processLegacyText(CharSequence charSequence, boolean ambient) {
5212            boolean isAlreadyLightText = isLegacy() || textColorsNeedInversion();
5213            boolean wantLightText = ambient;
5214            if (isAlreadyLightText != wantLightText) {
5215                return getColorUtil().invertCharSequenceColors(charSequence);
5216            } else {
5217                return charSequence;
5218            }
5219        }
5220
5221        /**
5222         * Apply any necessariy colors to the small icon
5223         */
5224        private void processSmallIconColor(Icon smallIcon, RemoteViews contentView,
5225                boolean ambient) {
5226            boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon);
5227            int color;
5228            if (ambient) {
5229                color = resolveAmbientColor();
5230            } else if (isColorized()) {
5231                color = getPrimaryTextColor();
5232            } else {
5233                color = resolveContrastColor();
5234            }
5235            if (colorable) {
5236                contentView.setDrawableTint(R.id.icon, false, color,
5237                        PorterDuff.Mode.SRC_ATOP);
5238
5239            }
5240            contentView.setInt(R.id.notification_header, "setOriginalIconColor",
5241                    colorable ? color : NotificationHeaderView.NO_COLOR);
5242        }
5243
5244        /**
5245         * Make the largeIcon dark if it's a fake smallIcon (that is,
5246         * if it's grayscale).
5247         */
5248        // TODO: also check bounds, transparency, that sort of thing.
5249        private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) {
5250            if (largeIcon != null && isLegacy()
5251                    && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) {
5252                // resolve color will fall back to the default when legacy
5253                contentView.setDrawableTint(R.id.icon, false, resolveContrastColor(),
5254                        PorterDuff.Mode.SRC_ATOP);
5255            }
5256        }
5257
5258        private void sanitizeColor() {
5259            if (mN.color != COLOR_DEFAULT) {
5260                mN.color |= 0xFF000000; // no alpha for custom colors
5261            }
5262        }
5263
5264        int resolveContrastColor() {
5265            if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) {
5266                return mCachedContrastColor;
5267            }
5268
5269            int color;
5270            int background = mContext.getColor(
5271                    com.android.internal.R.color.notification_material_background_color);
5272            if (mN.color == COLOR_DEFAULT) {
5273                ensureColors();
5274                color = NotificationColorUtil.resolveDefaultColor(mContext, background);
5275            } else {
5276                color = NotificationColorUtil.resolveContrastColor(mContext, mN.color,
5277                        background, mInNightMode);
5278            }
5279            if (Color.alpha(color) < 255) {
5280                // alpha doesn't go well for color filters, so let's blend it manually
5281                color = NotificationColorUtil.compositeColors(color, background);
5282            }
5283            mCachedContrastColorIsFor = mN.color;
5284            return mCachedContrastColor = color;
5285        }
5286
5287        int resolveAmbientColor() {
5288            if (mCachedAmbientColorIsFor == mN.color && mCachedAmbientColorIsFor != COLOR_INVALID) {
5289                return mCachedAmbientColor;
5290            }
5291            final int contrasted = NotificationColorUtil.resolveAmbientColor(mContext, mN.color);
5292
5293            mCachedAmbientColorIsFor = mN.color;
5294            return mCachedAmbientColor = contrasted;
5295        }
5296
5297        /**
5298         * Apply the unstyled operations and return a new {@link Notification} object.
5299         * @hide
5300         */
5301        public Notification buildUnstyled() {
5302            if (mActions.size() > 0) {
5303                mN.actions = new Action[mActions.size()];
5304                mActions.toArray(mN.actions);
5305            }
5306            if (!mPersonList.isEmpty()) {
5307                mN.extras.putParcelableArrayList(EXTRA_PEOPLE_LIST, mPersonList);
5308            }
5309            if (mN.bigContentView != null || mN.contentView != null
5310                    || mN.headsUpContentView != null) {
5311                mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true);
5312            }
5313            return mN;
5314        }
5315
5316        /**
5317         * Creates a Builder from an existing notification so further changes can be made.
5318         * @param context The context for your application / activity.
5319         * @param n The notification to create a Builder from.
5320         */
5321        public static Notification.Builder recoverBuilder(Context context, Notification n) {
5322            // Re-create notification context so we can access app resources.
5323            ApplicationInfo applicationInfo = n.extras.getParcelable(
5324                    EXTRA_BUILDER_APPLICATION_INFO);
5325            Context builderContext;
5326            if (applicationInfo != null) {
5327                try {
5328                    builderContext = context.createApplicationContext(applicationInfo,
5329                            Context.CONTEXT_RESTRICTED);
5330                } catch (NameNotFoundException e) {
5331                    Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found");
5332                    builderContext = context;  // try with our context
5333                }
5334            } else {
5335                builderContext = context; // try with given context
5336            }
5337
5338            return new Builder(builderContext, n);
5339        }
5340
5341        /**
5342         * @deprecated Use {@link #build()} instead.
5343         */
5344        @Deprecated
5345        public Notification getNotification() {
5346            return build();
5347        }
5348
5349        /**
5350         * Combine all of the options that have been set and return a new {@link Notification}
5351         * object.
5352         */
5353        public Notification build() {
5354            // first, add any extras from the calling code
5355            if (mUserExtras != null) {
5356                mN.extras = getAllExtras();
5357            }
5358
5359            mN.creationTime = System.currentTimeMillis();
5360
5361            // lazy stuff from mContext; see comment in Builder(Context, Notification)
5362            Notification.addFieldsFromContext(mContext, mN);
5363
5364            buildUnstyled();
5365
5366            if (mStyle != null) {
5367                mStyle.reduceImageSizes(mContext);
5368                mStyle.purgeResources();
5369                mStyle.validate(mContext);
5370                mStyle.buildStyled(mN);
5371            }
5372            mN.reduceImageSizes(mContext);
5373
5374            if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
5375                    && (useExistingRemoteView())) {
5376                if (mN.contentView == null) {
5377                    mN.contentView = createContentView();
5378                    mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT,
5379                            mN.contentView.getSequenceNumber());
5380                }
5381                if (mN.bigContentView == null) {
5382                    mN.bigContentView = createBigContentView();
5383                    if (mN.bigContentView != null) {
5384                        mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT,
5385                                mN.bigContentView.getSequenceNumber());
5386                    }
5387                }
5388                if (mN.headsUpContentView == null) {
5389                    mN.headsUpContentView = createHeadsUpContentView();
5390                    if (mN.headsUpContentView != null) {
5391                        mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT,
5392                                mN.headsUpContentView.getSequenceNumber());
5393                    }
5394                }
5395            }
5396
5397            if ((mN.defaults & DEFAULT_LIGHTS) != 0) {
5398                mN.flags |= FLAG_SHOW_LIGHTS;
5399            }
5400
5401            mN.allPendingIntents = null;
5402
5403            return mN;
5404        }
5405
5406        /**
5407         * Apply this Builder to an existing {@link Notification} object.
5408         *
5409         * @hide
5410         */
5411        public Notification buildInto(Notification n) {
5412            build().cloneInto(n, true);
5413            return n;
5414        }
5415
5416        /**
5417         * Removes RemoteViews that were created for compatibility from {@param n}, if they did not
5418         * change. Also removes extenders on low ram devices, as
5419         * {@link android.service.notification.NotificationListenerService} services are disabled.
5420         *
5421         * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}.
5422         *
5423         * @hide
5424         */
5425        public static Notification maybeCloneStrippedForDelivery(Notification n, boolean isLowRam) {
5426            String templateClass = n.extras.getString(EXTRA_TEMPLATE);
5427
5428            // Only strip views for known Styles because we won't know how to
5429            // re-create them otherwise.
5430            if (!isLowRam
5431                    && !TextUtils.isEmpty(templateClass)
5432                    && getNotificationStyleClass(templateClass) == null) {
5433                return n;
5434            }
5435
5436            // Only strip unmodified BuilderRemoteViews.
5437            boolean stripContentView = n.contentView instanceof BuilderRemoteViews &&
5438                    n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) ==
5439                            n.contentView.getSequenceNumber();
5440            boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews &&
5441                    n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) ==
5442                            n.bigContentView.getSequenceNumber();
5443            boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews &&
5444                    n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) ==
5445                            n.headsUpContentView.getSequenceNumber();
5446
5447            // Nothing to do here, no need to clone.
5448            if (!isLowRam
5449                    && !stripContentView && !stripBigContentView && !stripHeadsUpContentView) {
5450                return n;
5451            }
5452
5453            Notification clone = n.clone();
5454            if (stripContentView) {
5455                clone.contentView = null;
5456                clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT);
5457            }
5458            if (stripBigContentView) {
5459                clone.bigContentView = null;
5460                clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT);
5461            }
5462            if (stripHeadsUpContentView) {
5463                clone.headsUpContentView = null;
5464                clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT);
5465            }
5466            if (isLowRam) {
5467                clone.extras.remove(Notification.TvExtender.EXTRA_TV_EXTENDER);
5468                clone.extras.remove(WearableExtender.EXTRA_WEARABLE_EXTENSIONS);
5469                clone.extras.remove(CarExtender.EXTRA_CAR_EXTENDER);
5470            }
5471            return clone;
5472        }
5473
5474        private int getBaseLayoutResource() {
5475            return R.layout.notification_template_material_base;
5476        }
5477
5478        private int getBigBaseLayoutResource() {
5479            return R.layout.notification_template_material_big_base;
5480        }
5481
5482        private int getBigPictureLayoutResource() {
5483            return R.layout.notification_template_material_big_picture;
5484        }
5485
5486        private int getBigTextLayoutResource() {
5487            return R.layout.notification_template_material_big_text;
5488        }
5489
5490        private int getInboxLayoutResource() {
5491            return R.layout.notification_template_material_inbox;
5492        }
5493
5494        private int getMessagingLayoutResource() {
5495            return R.layout.notification_template_material_messaging;
5496        }
5497
5498        private int getActionLayoutResource() {
5499            return R.layout.notification_material_action;
5500        }
5501
5502        private int getEmphasizedActionLayoutResource() {
5503            return R.layout.notification_material_action_emphasized;
5504        }
5505
5506        private int getActionTombstoneLayoutResource() {
5507            return R.layout.notification_material_action_tombstone;
5508        }
5509
5510        private int getBackgroundColor() {
5511            if (isColorized()) {
5512                return mBackgroundColor != COLOR_INVALID ? mBackgroundColor : mN.color;
5513            } else {
5514                return COLOR_DEFAULT;
5515            }
5516        }
5517
5518        private boolean isColorized() {
5519            return mN.isColorized();
5520        }
5521
5522        private boolean shouldTintActionButtons() {
5523            return mTintActionButtons;
5524        }
5525
5526        private boolean textColorsNeedInversion() {
5527            if (mStyle == null || !MediaStyle.class.equals(mStyle.getClass())) {
5528                return false;
5529            }
5530            int targetSdkVersion = mContext.getApplicationInfo().targetSdkVersion;
5531            return targetSdkVersion > Build.VERSION_CODES.M
5532                    && targetSdkVersion < Build.VERSION_CODES.O;
5533        }
5534
5535        /**
5536         * Set a color palette to be used as the background and textColors
5537         *
5538         * @param backgroundColor the color to be used as the background
5539         * @param foregroundColor the color to be used as the foreground
5540         *
5541         * @hide
5542         */
5543        public void setColorPalette(int backgroundColor, int foregroundColor) {
5544            mBackgroundColor = backgroundColor;
5545            mForegroundColor = foregroundColor;
5546            mTextColorsAreForBackground = COLOR_INVALID;
5547            ensureColors();
5548        }
5549
5550        /**
5551         * Forces all styled remoteViews to be built from scratch and not use any cached
5552         * RemoteViews.
5553         * This is needed for legacy apps that are baking in their remoteviews into the
5554         * notification.
5555         *
5556         * @hide
5557         */
5558        public void setRebuildStyledRemoteViews(boolean rebuild) {
5559            mRebuildStyledRemoteViews = rebuild;
5560        }
5561
5562        /**
5563         * Get the text that should be displayed in the statusBar when heads upped. This is
5564         * usually just the app name, but may be different depending on the style.
5565         *
5566         * @param publicMode If true, return a text that is safe to display in public.
5567         *
5568         * @hide
5569         */
5570        public CharSequence getHeadsUpStatusBarText(boolean publicMode) {
5571            if (mStyle != null && !publicMode) {
5572                CharSequence text = mStyle.getHeadsUpStatusBarText();
5573                if (!TextUtils.isEmpty(text)) {
5574                    return text;
5575                }
5576            }
5577            return loadHeaderAppName();
5578        }
5579    }
5580
5581    /**
5582     * Reduces the image sizes to conform to a maximum allowed size. This also processes all custom
5583     * remote views.
5584     *
5585     * @hide
5586     */
5587    void reduceImageSizes(Context context) {
5588        if (extras.getBoolean(EXTRA_REDUCED_IMAGES)) {
5589            return;
5590        }
5591        boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
5592        if (mLargeIcon != null || largeIcon != null) {
5593            Resources resources = context.getResources();
5594            Class<? extends Style> style = getNotificationStyle();
5595            int maxWidth = resources.getDimensionPixelSize(isLowRam
5596                    ? R.dimen.notification_right_icon_size_low_ram
5597                    : R.dimen.notification_right_icon_size);
5598            int maxHeight = maxWidth;
5599            if (MediaStyle.class.equals(style)
5600                    || DecoratedMediaCustomViewStyle.class.equals(style)) {
5601                maxHeight = resources.getDimensionPixelSize(isLowRam
5602                        ? R.dimen.notification_media_image_max_height_low_ram
5603                        : R.dimen.notification_media_image_max_height);
5604                maxWidth = resources.getDimensionPixelSize(isLowRam
5605                        ? R.dimen.notification_media_image_max_width_low_ram
5606                        : R.dimen.notification_media_image_max_width);
5607            }
5608            if (mLargeIcon != null) {
5609                mLargeIcon.scaleDownIfNecessary(maxWidth, maxHeight);
5610            }
5611            if (largeIcon != null) {
5612                largeIcon = Icon.scaleDownIfNecessary(largeIcon, maxWidth, maxHeight);
5613            }
5614        }
5615        reduceImageSizesForRemoteView(contentView, context, isLowRam);
5616        reduceImageSizesForRemoteView(headsUpContentView, context, isLowRam);
5617        reduceImageSizesForRemoteView(bigContentView, context, isLowRam);
5618        extras.putBoolean(EXTRA_REDUCED_IMAGES, true);
5619    }
5620
5621    private void reduceImageSizesForRemoteView(RemoteViews remoteView, Context context,
5622            boolean isLowRam) {
5623        if (remoteView != null) {
5624            Resources resources = context.getResources();
5625            int maxWidth = resources.getDimensionPixelSize(isLowRam
5626                    ? R.dimen.notification_custom_view_max_image_width_low_ram
5627                    : R.dimen.notification_custom_view_max_image_width);
5628            int maxHeight = resources.getDimensionPixelSize(isLowRam
5629                    ? R.dimen.notification_custom_view_max_image_height_low_ram
5630                    : R.dimen.notification_custom_view_max_image_height);
5631            remoteView.reduceImageSizes(maxWidth, maxHeight);
5632        }
5633    }
5634
5635    /**
5636     * @return whether this notification is a foreground service notification
5637     */
5638    private boolean isForegroundService() {
5639        return (flags & Notification.FLAG_FOREGROUND_SERVICE) != 0;
5640    }
5641
5642    /**
5643     * @return whether this notification has a media session attached
5644     * @hide
5645     */
5646    public boolean hasMediaSession() {
5647        return extras.getParcelable(Notification.EXTRA_MEDIA_SESSION) != null;
5648    }
5649
5650    /**
5651     * @return the style class of this notification
5652     * @hide
5653     */
5654    public Class<? extends Notification.Style> getNotificationStyle() {
5655        String templateClass = extras.getString(Notification.EXTRA_TEMPLATE);
5656
5657        if (!TextUtils.isEmpty(templateClass)) {
5658            return Notification.getNotificationStyleClass(templateClass);
5659        }
5660        return null;
5661    }
5662
5663    /**
5664     * @return true if this notification is colorized.
5665     *
5666     * @hide
5667     */
5668    public boolean isColorized() {
5669        if (isColorizedMedia()) {
5670            return true;
5671        }
5672        return extras.getBoolean(EXTRA_COLORIZED)
5673                && (hasColorizedPermission() || isForegroundService());
5674    }
5675
5676    /**
5677     * Returns whether an app can colorize due to the android.permission.USE_COLORIZED_NOTIFICATIONS
5678     * permission. The permission is checked when a notification is enqueued.
5679     */
5680    private boolean hasColorizedPermission() {
5681        return (flags & Notification.FLAG_CAN_COLORIZE) != 0;
5682    }
5683
5684    /**
5685     * @return true if this notification is colorized and it is a media notification
5686     *
5687     * @hide
5688     */
5689    public boolean isColorizedMedia() {
5690        Class<? extends Style> style = getNotificationStyle();
5691        if (MediaStyle.class.equals(style)) {
5692            Boolean colorized = (Boolean) extras.get(EXTRA_COLORIZED);
5693            if ((colorized == null || colorized) && hasMediaSession()) {
5694                return true;
5695            }
5696        } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5697            if (extras.getBoolean(EXTRA_COLORIZED) && hasMediaSession()) {
5698                return true;
5699            }
5700        }
5701        return false;
5702    }
5703
5704
5705    /**
5706     * @return true if this is a media notification
5707     *
5708     * @hide
5709     */
5710    public boolean isMediaNotification() {
5711        Class<? extends Style> style = getNotificationStyle();
5712        if (MediaStyle.class.equals(style)) {
5713            return true;
5714        } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5715            return true;
5716        }
5717        return false;
5718    }
5719
5720    private boolean hasLargeIcon() {
5721        return mLargeIcon != null || largeIcon != null;
5722    }
5723
5724    /**
5725     * @return true if the notification will show the time; false otherwise
5726     * @hide
5727     */
5728    public boolean showsTime() {
5729        return when != 0 && extras.getBoolean(EXTRA_SHOW_WHEN);
5730    }
5731
5732    /**
5733     * @return true if the notification will show a chronometer; false otherwise
5734     * @hide
5735     */
5736    public boolean showsChronometer() {
5737        return when != 0 && extras.getBoolean(EXTRA_SHOW_CHRONOMETER);
5738    }
5739
5740    /**
5741     * @removed
5742     */
5743    @SystemApi
5744    public static Class<? extends Style> getNotificationStyleClass(String templateClass) {
5745        Class<? extends Style>[] classes = new Class[] {
5746                BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class,
5747                DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class,
5748                MessagingStyle.class };
5749        for (Class<? extends Style> innerClass : classes) {
5750            if (templateClass.equals(innerClass.getName())) {
5751                return innerClass;
5752            }
5753        }
5754        return null;
5755    }
5756
5757    /**
5758     * An object that can apply a rich notification style to a {@link Notification.Builder}
5759     * object.
5760     */
5761    public static abstract class Style {
5762        private CharSequence mBigContentTitle;
5763
5764        /**
5765         * @hide
5766         */
5767        protected CharSequence mSummaryText = null;
5768
5769        /**
5770         * @hide
5771         */
5772        protected boolean mSummaryTextSet = false;
5773
5774        protected Builder mBuilder;
5775
5776        /**
5777         * Overrides ContentTitle in the big form of the template.
5778         * This defaults to the value passed to setContentTitle().
5779         */
5780        protected void internalSetBigContentTitle(CharSequence title) {
5781            mBigContentTitle = title;
5782        }
5783
5784        /**
5785         * Set the first line of text after the detail section in the big form of the template.
5786         */
5787        protected void internalSetSummaryText(CharSequence cs) {
5788            mSummaryText = cs;
5789            mSummaryTextSet = true;
5790        }
5791
5792        public void setBuilder(Builder builder) {
5793            if (mBuilder != builder) {
5794                mBuilder = builder;
5795                if (mBuilder != null) {
5796                    mBuilder.setStyle(this);
5797                }
5798            }
5799        }
5800
5801        protected void checkBuilder() {
5802            if (mBuilder == null) {
5803                throw new IllegalArgumentException("Style requires a valid Builder object");
5804            }
5805        }
5806
5807        protected RemoteViews getStandardView(int layoutId) {
5808            checkBuilder();
5809
5810            // Nasty.
5811            CharSequence oldBuilderContentTitle =
5812                    mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE);
5813            if (mBigContentTitle != null) {
5814                mBuilder.setContentTitle(mBigContentTitle);
5815            }
5816
5817            RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId);
5818
5819            mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle);
5820
5821            if (mBigContentTitle != null && mBigContentTitle.equals("")) {
5822                contentView.setViewVisibility(R.id.line1, View.GONE);
5823            } else {
5824                contentView.setViewVisibility(R.id.line1, View.VISIBLE);
5825            }
5826
5827            return contentView;
5828        }
5829
5830        /**
5831         * Construct a Style-specific RemoteViews for the collapsed notification layout.
5832         * The default implementation has nothing additional to add.
5833         *
5834         * @param increasedHeight true if this layout be created with an increased height.
5835         * @hide
5836         */
5837        public RemoteViews makeContentView(boolean increasedHeight) {
5838            return null;
5839        }
5840
5841        /**
5842         * Construct a Style-specific RemoteViews for the final big notification layout.
5843         * @hide
5844         */
5845        public RemoteViews makeBigContentView() {
5846            return null;
5847        }
5848
5849        /**
5850         * Construct a Style-specific RemoteViews for the final HUN layout.
5851         *
5852         * @param increasedHeight true if this layout be created with an increased height.
5853         * @hide
5854         */
5855        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
5856            return null;
5857        }
5858
5859        /**
5860         * Apply any style-specific extras to this notification before shipping it out.
5861         * @hide
5862         */
5863        public void addExtras(Bundle extras) {
5864            if (mSummaryTextSet) {
5865                extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
5866            }
5867            if (mBigContentTitle != null) {
5868                extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
5869            }
5870            extras.putString(EXTRA_TEMPLATE, this.getClass().getName());
5871        }
5872
5873        /**
5874         * Reconstruct the internal state of this Style object from extras.
5875         * @hide
5876         */
5877        protected void restoreFromExtras(Bundle extras) {
5878            if (extras.containsKey(EXTRA_SUMMARY_TEXT)) {
5879                mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT);
5880                mSummaryTextSet = true;
5881            }
5882            if (extras.containsKey(EXTRA_TITLE_BIG)) {
5883                mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG);
5884            }
5885        }
5886
5887
5888        /**
5889         * @hide
5890         */
5891        public Notification buildStyled(Notification wip) {
5892            addExtras(wip.extras);
5893            return wip;
5894        }
5895
5896        /**
5897         * @hide
5898         */
5899        public void purgeResources() {}
5900
5901        /**
5902         * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is
5903         * attached to.
5904         *
5905         * @return the fully constructed Notification.
5906         */
5907        public Notification build() {
5908            checkBuilder();
5909            return mBuilder.build();
5910        }
5911
5912        /**
5913         * @hide
5914         * @return true if the style positions the progress bar on the second line; false if the
5915         *         style hides the progress bar
5916         */
5917        protected boolean hasProgress() {
5918            return true;
5919        }
5920
5921        /**
5922         * @hide
5923         * @return Whether we should put the summary be put into the notification header
5924         */
5925        public boolean hasSummaryInHeader() {
5926            return true;
5927        }
5928
5929        /**
5930         * @hide
5931         * @return Whether custom content views are displayed inline in the style
5932         */
5933        public boolean displayCustomViewInline() {
5934            return false;
5935        }
5936
5937        /**
5938         * Reduces the image sizes contained in this style.
5939         *
5940         * @hide
5941         */
5942        public void reduceImageSizes(Context context) {
5943        }
5944
5945        /**
5946         * Validate that this style was properly composed. This is called at build time.
5947         * @hide
5948         */
5949        public void validate(Context context) {
5950        }
5951
5952        /**
5953         * @hide
5954         */
5955        public abstract boolean areNotificationsVisiblyDifferent(Style other);
5956
5957        /**
5958         * @return the the text that should be displayed in the statusBar when heads-upped.
5959         * If {@code null} is returned, the default implementation will be used.
5960         *
5961         * @hide
5962         */
5963        public CharSequence getHeadsUpStatusBarText() {
5964            return null;
5965        }
5966    }
5967
5968    /**
5969     * Helper class for generating large-format notifications that include a large image attachment.
5970     *
5971     * Here's how you'd set the <code>BigPictureStyle</code> on a notification:
5972     * <pre class="prettyprint">
5973     * Notification notif = new Notification.Builder(mContext)
5974     *     .setContentTitle(&quot;New photo from &quot; + sender.toString())
5975     *     .setContentText(subject)
5976     *     .setSmallIcon(R.drawable.new_post)
5977     *     .setLargeIcon(aBitmap)
5978     *     .setStyle(new Notification.BigPictureStyle()
5979     *         .bigPicture(aBigBitmap))
5980     *     .build();
5981     * </pre>
5982     *
5983     * @see Notification#bigContentView
5984     */
5985    public static class BigPictureStyle extends Style {
5986        private Bitmap mPicture;
5987        private Icon mBigLargeIcon;
5988        private boolean mBigLargeIconSet = false;
5989
5990        public BigPictureStyle() {
5991        }
5992
5993        /**
5994         * @deprecated use {@code BigPictureStyle()}.
5995         */
5996        @Deprecated
5997        public BigPictureStyle(Builder builder) {
5998            setBuilder(builder);
5999        }
6000
6001        /**
6002         * Overrides ContentTitle in the big form of the template.
6003         * This defaults to the value passed to setContentTitle().
6004         */
6005        public BigPictureStyle setBigContentTitle(CharSequence title) {
6006            internalSetBigContentTitle(safeCharSequence(title));
6007            return this;
6008        }
6009
6010        /**
6011         * Set the first line of text after the detail section in the big form of the template.
6012         */
6013        public BigPictureStyle setSummaryText(CharSequence cs) {
6014            internalSetSummaryText(safeCharSequence(cs));
6015            return this;
6016        }
6017
6018        /**
6019         * @hide
6020         */
6021        public Bitmap getBigPicture() {
6022            return mPicture;
6023        }
6024
6025        /**
6026         * Provide the bitmap to be used as the payload for the BigPicture notification.
6027         */
6028        public BigPictureStyle bigPicture(Bitmap b) {
6029            mPicture = b;
6030            return this;
6031        }
6032
6033        /**
6034         * Override the large icon when the big notification is shown.
6035         */
6036        public BigPictureStyle bigLargeIcon(Bitmap b) {
6037            return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
6038        }
6039
6040        /**
6041         * Override the large icon when the big notification is shown.
6042         */
6043        public BigPictureStyle bigLargeIcon(Icon icon) {
6044            mBigLargeIconSet = true;
6045            mBigLargeIcon = icon;
6046            return this;
6047        }
6048
6049        /** @hide */
6050        public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10);
6051
6052        /**
6053         * @hide
6054         */
6055        @Override
6056        public void purgeResources() {
6057            super.purgeResources();
6058            if (mPicture != null &&
6059                mPicture.isMutable() &&
6060                mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) {
6061                mPicture = mPicture.createAshmemBitmap();
6062            }
6063            if (mBigLargeIcon != null) {
6064                mBigLargeIcon.convertToAshmem();
6065            }
6066        }
6067
6068        /**
6069         * @hide
6070         */
6071        @Override
6072        public void reduceImageSizes(Context context) {
6073            super.reduceImageSizes(context);
6074            Resources resources = context.getResources();
6075            boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
6076            if (mPicture != null) {
6077                int maxPictureWidth = resources.getDimensionPixelSize(isLowRam
6078                        ? R.dimen.notification_big_picture_max_height_low_ram
6079                        : R.dimen.notification_big_picture_max_height);
6080                int maxPictureHeight = resources.getDimensionPixelSize(isLowRam
6081                        ? R.dimen.notification_big_picture_max_width_low_ram
6082                        : R.dimen.notification_big_picture_max_width);
6083                mPicture = Icon.scaleDownIfNecessary(mPicture, maxPictureWidth, maxPictureHeight);
6084            }
6085            if (mBigLargeIcon != null) {
6086                int rightIconSize = resources.getDimensionPixelSize(isLowRam
6087                        ? R.dimen.notification_right_icon_size_low_ram
6088                        : R.dimen.notification_right_icon_size);
6089                mBigLargeIcon.scaleDownIfNecessary(rightIconSize, rightIconSize);
6090            }
6091        }
6092
6093        /**
6094         * @hide
6095         */
6096        public RemoteViews makeBigContentView() {
6097            // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet
6098            // This covers the following cases:
6099            //   1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides
6100            //          mN.mLargeIcon
6101            //   2. !mBigLargeIconSet -> mN.mLargeIcon applies
6102            Icon oldLargeIcon = null;
6103            Bitmap largeIconLegacy = null;
6104            if (mBigLargeIconSet) {
6105                oldLargeIcon = mBuilder.mN.mLargeIcon;
6106                mBuilder.mN.mLargeIcon = mBigLargeIcon;
6107                // The legacy largeIcon might not allow us to clear the image, as it's taken in
6108                // replacement if the other one is null. Because we're restoring these legacy icons
6109                // for old listeners, this is in general non-null.
6110                largeIconLegacy = mBuilder.mN.largeIcon;
6111                mBuilder.mN.largeIcon = null;
6112            }
6113
6114            RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource());
6115            if (mSummaryTextSet) {
6116                contentView.setTextViewText(R.id.text, mBuilder.processTextSpans(
6117                        mBuilder.processLegacyText(mSummaryText)));
6118                mBuilder.setTextViewColorSecondary(contentView, R.id.text);
6119                contentView.setViewVisibility(R.id.text, View.VISIBLE);
6120            }
6121            mBuilder.setContentMinHeight(contentView, mBuilder.mN.hasLargeIcon());
6122
6123            if (mBigLargeIconSet) {
6124                mBuilder.mN.mLargeIcon = oldLargeIcon;
6125                mBuilder.mN.largeIcon = largeIconLegacy;
6126            }
6127
6128            contentView.setImageViewBitmap(R.id.big_picture, mPicture);
6129            return contentView;
6130        }
6131
6132        /**
6133         * @hide
6134         */
6135        public void addExtras(Bundle extras) {
6136            super.addExtras(extras);
6137
6138            if (mBigLargeIconSet) {
6139                extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
6140            }
6141            extras.putParcelable(EXTRA_PICTURE, mPicture);
6142        }
6143
6144        /**
6145         * @hide
6146         */
6147        @Override
6148        protected void restoreFromExtras(Bundle extras) {
6149            super.restoreFromExtras(extras);
6150
6151            if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) {
6152                mBigLargeIconSet = true;
6153                mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG);
6154            }
6155            mPicture = extras.getParcelable(EXTRA_PICTURE);
6156        }
6157
6158        /**
6159         * @hide
6160         */
6161        @Override
6162        public boolean hasSummaryInHeader() {
6163            return false;
6164        }
6165
6166        /**
6167         * @hide
6168         */
6169        @Override
6170        public boolean areNotificationsVisiblyDifferent(Style other) {
6171            if (other == null || getClass() != other.getClass()) {
6172                return true;
6173            }
6174            BigPictureStyle otherS = (BigPictureStyle) other;
6175            return !Objects.equals(getBigPicture(), otherS.getBigPicture());
6176        }
6177    }
6178
6179    /**
6180     * Helper class for generating large-format notifications that include a lot of text.
6181     *
6182     * Here's how you'd set the <code>BigTextStyle</code> on a notification:
6183     * <pre class="prettyprint">
6184     * Notification notif = new Notification.Builder(mContext)
6185     *     .setContentTitle(&quot;New mail from &quot; + sender.toString())
6186     *     .setContentText(subject)
6187     *     .setSmallIcon(R.drawable.new_mail)
6188     *     .setLargeIcon(aBitmap)
6189     *     .setStyle(new Notification.BigTextStyle()
6190     *         .bigText(aVeryLongString))
6191     *     .build();
6192     * </pre>
6193     *
6194     * @see Notification#bigContentView
6195     */
6196    public static class BigTextStyle extends Style {
6197
6198        private CharSequence mBigText;
6199
6200        public BigTextStyle() {
6201        }
6202
6203        /**
6204         * @deprecated use {@code BigTextStyle()}.
6205         */
6206        @Deprecated
6207        public BigTextStyle(Builder builder) {
6208            setBuilder(builder);
6209        }
6210
6211        /**
6212         * Overrides ContentTitle in the big form of the template.
6213         * This defaults to the value passed to setContentTitle().
6214         */
6215        public BigTextStyle setBigContentTitle(CharSequence title) {
6216            internalSetBigContentTitle(safeCharSequence(title));
6217            return this;
6218        }
6219
6220        /**
6221         * Set the first line of text after the detail section in the big form of the template.
6222         */
6223        public BigTextStyle setSummaryText(CharSequence cs) {
6224            internalSetSummaryText(safeCharSequence(cs));
6225            return this;
6226        }
6227
6228        /**
6229         * Provide the longer text to be displayed in the big form of the
6230         * template in place of the content text.
6231         */
6232        public BigTextStyle bigText(CharSequence cs) {
6233            mBigText = safeCharSequence(cs);
6234            return this;
6235        }
6236
6237        /**
6238         * @hide
6239         */
6240        public CharSequence getBigText() {
6241            return mBigText;
6242        }
6243
6244        /**
6245         * @hide
6246         */
6247        public void addExtras(Bundle extras) {
6248            super.addExtras(extras);
6249
6250            extras.putCharSequence(EXTRA_BIG_TEXT, mBigText);
6251        }
6252
6253        /**
6254         * @hide
6255         */
6256        @Override
6257        protected void restoreFromExtras(Bundle extras) {
6258            super.restoreFromExtras(extras);
6259
6260            mBigText = extras.getCharSequence(EXTRA_BIG_TEXT);
6261        }
6262
6263        /**
6264         * @param increasedHeight true if this layout be created with an increased height.
6265         *
6266         * @hide
6267         */
6268        @Override
6269        public RemoteViews makeContentView(boolean increasedHeight) {
6270            if (increasedHeight) {
6271                mBuilder.mOriginalActions = mBuilder.mActions;
6272                mBuilder.mActions = new ArrayList<>();
6273                RemoteViews remoteViews = makeBigContentView();
6274                mBuilder.mActions = mBuilder.mOriginalActions;
6275                mBuilder.mOriginalActions = null;
6276                return remoteViews;
6277            }
6278            return super.makeContentView(increasedHeight);
6279        }
6280
6281        /**
6282         * @hide
6283         */
6284        @Override
6285        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
6286            if (increasedHeight && mBuilder.mActions.size() > 0) {
6287                return makeBigContentView();
6288            }
6289            return super.makeHeadsUpContentView(increasedHeight);
6290        }
6291
6292        /**
6293         * @hide
6294         */
6295        public RemoteViews makeBigContentView() {
6296
6297            // Nasty
6298            CharSequence text = mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT);
6299            mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
6300
6301            RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource());
6302
6303            mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, text);
6304
6305            CharSequence bigTextText = mBuilder.processLegacyText(mBigText);
6306            if (TextUtils.isEmpty(bigTextText)) {
6307                // In case the bigtext is null / empty fall back to the normal text to avoid a weird
6308                // experience
6309                bigTextText = mBuilder.processLegacyText(text);
6310            }
6311            applyBigTextContentView(mBuilder, contentView, bigTextText);
6312
6313            return contentView;
6314        }
6315
6316        /**
6317         * @hide
6318         */
6319        @Override
6320        public boolean areNotificationsVisiblyDifferent(Style other) {
6321            if (other == null || getClass() != other.getClass()) {
6322                return true;
6323            }
6324            BigTextStyle newS = (BigTextStyle) other;
6325            return !Objects.equals(getBigText(), newS.getBigText());
6326        }
6327
6328        static void applyBigTextContentView(Builder builder,
6329                RemoteViews contentView, CharSequence bigTextText) {
6330            contentView.setTextViewText(R.id.big_text, builder.processTextSpans(bigTextText));
6331            builder.setTextViewColorSecondary(contentView, R.id.big_text);
6332            contentView.setViewVisibility(R.id.big_text,
6333                    TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE);
6334            contentView.setBoolean(R.id.big_text, "setHasImage", builder.mN.hasLargeIcon());
6335        }
6336    }
6337
6338    /**
6339     * Helper class for generating large-format notifications that include multiple back-and-forth
6340     * messages of varying types between any number of people.
6341     *
6342     * <br>
6343     * If the platform does not provide large-format notifications, this method has no effect. The
6344     * user will always see the normal notification view.
6345     * <br>
6346     * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like
6347     * so:
6348     * <pre class="prettyprint">
6349     *
6350     * Notification noti = new Notification.Builder()
6351     *     .setContentTitle(&quot;2 new messages wtih &quot; + sender.toString())
6352     *     .setContentText(subject)
6353     *     .setSmallIcon(R.drawable.new_message)
6354     *     .setLargeIcon(aBitmap)
6355     *     .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name))
6356     *         .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender())
6357     *         .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender()))
6358     *     .build();
6359     * </pre>
6360     */
6361    public static class MessagingStyle extends Style {
6362
6363        /**
6364         * The maximum number of messages that will be retained in the Notification itself (the
6365         * number displayed is up to the platform).
6366         */
6367        public static final int MAXIMUM_RETAINED_MESSAGES = 25;
6368
6369        @NonNull Person mUser;
6370        @Nullable CharSequence mConversationTitle;
6371        List<Message> mMessages = new ArrayList<>();
6372        List<Message> mHistoricMessages = new ArrayList<>();
6373        boolean mIsGroupConversation;
6374
6375        MessagingStyle() {
6376        }
6377
6378        /**
6379         * @param userDisplayName Required - the name to be displayed for any replies sent by the
6380         * user before the posting app reposts the notification with those messages after they've
6381         * been actually sent and in previous messages sent by the user added in
6382         * {@link #addMessage(Notification.MessagingStyle.Message)}
6383         *
6384         * @deprecated use {@code MessagingStyle(Person)}
6385         */
6386        public MessagingStyle(@NonNull CharSequence userDisplayName) {
6387            this(new Person().setName(userDisplayName));
6388        }
6389
6390        /**
6391         * @param user Required - The person displayed for any messages that are sent by the
6392         * user. Any messages added with {@link #addMessage(Notification.MessagingStyle.Message)}
6393         * who don't have a Person associated with it will be displayed as if they were sent
6394         * by this user. The user also needs to have a valid name associated with it, which will
6395         * be enforced starting in Android P.
6396         */
6397        public MessagingStyle(@NonNull Person user) {
6398            mUser = user;
6399        }
6400
6401        /**
6402         * Validate that this style was properly composed. This is called at build time.
6403         * @hide
6404         */
6405        @Override
6406        public void validate(Context context) {
6407            super.validate(context);
6408            if (context.getApplicationInfo().targetSdkVersion
6409                    >= Build.VERSION_CODES.P && (mUser == null || mUser.getName() == null)) {
6410                throw new RuntimeException("User must be valid and have a name.");
6411            }
6412        }
6413
6414        /**
6415         * @return the the text that should be displayed in the statusBar when heads upped.
6416         * If {@code null} is returned, the default implementation will be used.
6417         *
6418         * @hide
6419         */
6420        @Override
6421        public CharSequence getHeadsUpStatusBarText() {
6422            CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
6423                    ? super.mBigContentTitle
6424                    : mConversationTitle;
6425            if (!TextUtils.isEmpty(conversationTitle) && !hasOnlyWhiteSpaceSenders()) {
6426                return conversationTitle;
6427            }
6428            return null;
6429        }
6430
6431        /**
6432         * @return the user to be displayed for any replies sent by the user
6433         */
6434        public Person getUser() {
6435            return mUser;
6436        }
6437
6438        /**
6439         * Returns the name to be displayed for any replies sent by the user
6440         *
6441         * @deprecated use {@link #getUser()} instead
6442         */
6443        public CharSequence getUserDisplayName() {
6444            return mUser.getName();
6445        }
6446
6447        /**
6448         * Sets the title to be displayed on this conversation. May be set to {@code null}.
6449         *
6450         * <p>This API's behavior was changed in SDK version {@link Build.VERSION_CODES#P}. If your
6451         * application's target version is less than {@link Build.VERSION_CODES#P}, setting a
6452         * conversation title to a non-null value will make {@link #isGroupConversation()} return
6453         * {@code true} and passing {@code null} will make it return {@code false}. In
6454         * {@link Build.VERSION_CODES#P} and beyond, use {@link #setGroupConversation(boolean)}
6455         * to set group conversation status.
6456         *
6457         * @param conversationTitle Title displayed for this conversation
6458         * @return this object for method chaining
6459         */
6460        public MessagingStyle setConversationTitle(@Nullable CharSequence conversationTitle) {
6461            mConversationTitle = conversationTitle;
6462            return this;
6463        }
6464
6465        /**
6466         * Return the title to be displayed on this conversation. May return {@code null}.
6467         */
6468        @Nullable
6469        public CharSequence getConversationTitle() {
6470            return mConversationTitle;
6471        }
6472
6473        /**
6474         * Adds a message for display by this notification. Convenience call for a simple
6475         * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6476         * @param text A {@link CharSequence} to be displayed as the message content
6477         * @param timestamp Time at which the message arrived
6478         * @param sender A {@link CharSequence} to be used for displaying the name of the
6479         * sender. Should be <code>null</code> for messages by the current user, in which case
6480         * the platform will insert {@link #getUserDisplayName()}.
6481         * Should be unique amongst all individuals in the conversation, and should be
6482         * consistent during re-posts of the notification.
6483         *
6484         * @see Message#Message(CharSequence, long, CharSequence)
6485         *
6486         * @return this object for method chaining
6487         *
6488         * @deprecated use {@link #addMessage(CharSequence, long, Person)}
6489         */
6490        public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) {
6491            return addMessage(text, timestamp,
6492                    sender == null ? null : new Person().setName(sender));
6493        }
6494
6495        /**
6496         * Adds a message for display by this notification. Convenience call for a simple
6497         * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6498         * @param text A {@link CharSequence} to be displayed as the message content
6499         * @param timestamp Time at which the message arrived
6500         * @param sender The {@link Person} who sent the message.
6501         * Should be <code>null</code> for messages by the current user, in which case
6502         * the platform will insert the user set in {@code MessagingStyle(Person)}.
6503         *
6504         * @see Message#Message(CharSequence, long, CharSequence)
6505         *
6506         * @return this object for method chaining
6507         */
6508        public MessagingStyle addMessage(CharSequence text, long timestamp, Person sender) {
6509            return addMessage(new Message(text, timestamp, sender));
6510        }
6511
6512        /**
6513         * Adds a {@link Message} for display in this notification.
6514         *
6515         * <p>The messages should be added in chronologic order, i.e. the oldest first,
6516         * the newest last.
6517         *
6518         * @param message The {@link Message} to be displayed
6519         * @return this object for method chaining
6520         */
6521        public MessagingStyle addMessage(Message message) {
6522            mMessages.add(message);
6523            if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6524                mMessages.remove(0);
6525            }
6526            return this;
6527        }
6528
6529        /**
6530         * Adds a {@link Message} for historic context in this notification.
6531         *
6532         * <p>Messages should be added as historic if they are not the main subject of the
6533         * notification but may give context to a conversation. The system may choose to present
6534         * them only when relevant, e.g. when replying to a message through a {@link RemoteInput}.
6535         *
6536         * <p>The messages should be added in chronologic order, i.e. the oldest first,
6537         * the newest last.
6538         *
6539         * @param message The historic {@link Message} to be added
6540         * @return this object for method chaining
6541         */
6542        public MessagingStyle addHistoricMessage(Message message) {
6543            mHistoricMessages.add(message);
6544            if (mHistoricMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6545                mHistoricMessages.remove(0);
6546            }
6547            return this;
6548        }
6549
6550        /**
6551         * Gets the list of {@code Message} objects that represent the notification
6552         */
6553        public List<Message> getMessages() {
6554            return mMessages;
6555        }
6556
6557        /**
6558         * Gets the list of historic {@code Message}s in the notification.
6559         */
6560        public List<Message> getHistoricMessages() {
6561            return mHistoricMessages;
6562        }
6563
6564        /**
6565         * Sets whether this conversation notification represents a group.
6566         *
6567         * @param isGroupConversation {@code true} if the conversation represents a group,
6568         * {@code false} otherwise.
6569         * @return this object for method chaining
6570         */
6571        public MessagingStyle setGroupConversation(boolean isGroupConversation) {
6572            mIsGroupConversation = isGroupConversation;
6573            return this;
6574        }
6575
6576        /**
6577         * Returns {@code true} if this notification represents a group conversation, otherwise
6578         * {@code false}.
6579         *
6580         * <p> If the application that generated this {@link MessagingStyle} targets an SDK version
6581         * less than {@link Build.VERSION_CODES#P}, this method becomes dependent on whether or
6582         * not the conversation title is set; returning {@code true} if the conversation title is
6583         * a non-null value, or {@code false} otherwise. From {@link Build.VERSION_CODES#P} forward,
6584         * this method returns what's set by {@link #setGroupConversation(boolean)} allowing for
6585         * named, non-group conversations.
6586         *
6587         * @see #setConversationTitle(CharSequence)
6588         */
6589        public boolean isGroupConversation() {
6590            // When target SDK version is < P, a non-null conversation title dictates if this is
6591            // as group conversation.
6592            if (mBuilder != null
6593                    && mBuilder.mContext.getApplicationInfo().targetSdkVersion
6594                            < Build.VERSION_CODES.P) {
6595                return mConversationTitle != null;
6596            }
6597
6598            return mIsGroupConversation;
6599        }
6600
6601        /**
6602         * @hide
6603         */
6604        @Override
6605        public void addExtras(Bundle extras) {
6606            super.addExtras(extras);
6607            if (mUser != null) {
6608                // For legacy usages
6609                extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUser.getName());
6610                extras.putParcelable(EXTRA_MESSAGING_PERSON, mUser);
6611            }
6612            if (mConversationTitle != null) {
6613                extras.putCharSequence(EXTRA_CONVERSATION_TITLE, mConversationTitle);
6614            }
6615            if (!mMessages.isEmpty()) { extras.putParcelableArray(EXTRA_MESSAGES,
6616                    Message.getBundleArrayForMessages(mMessages));
6617            }
6618            if (!mHistoricMessages.isEmpty()) { extras.putParcelableArray(EXTRA_HISTORIC_MESSAGES,
6619                    Message.getBundleArrayForMessages(mHistoricMessages));
6620            }
6621
6622            fixTitleAndTextExtras(extras);
6623            extras.putBoolean(EXTRA_IS_GROUP_CONVERSATION, mIsGroupConversation);
6624        }
6625
6626        private void fixTitleAndTextExtras(Bundle extras) {
6627            Message m = findLatestIncomingMessage();
6628            CharSequence text = (m == null) ? null : m.mText;
6629            CharSequence sender = m == null ? null
6630                    : m.mSender == null || TextUtils.isEmpty(m.mSender.getName())
6631                            ? mUser.getName() : m.mSender.getName();
6632            CharSequence title;
6633            if (!TextUtils.isEmpty(mConversationTitle)) {
6634                if (!TextUtils.isEmpty(sender)) {
6635                    BidiFormatter bidi = BidiFormatter.getInstance();
6636                    title = mBuilder.mContext.getString(
6637                            com.android.internal.R.string.notification_messaging_title_template,
6638                            bidi.unicodeWrap(mConversationTitle), bidi.unicodeWrap(sender));
6639                } else {
6640                    title = mConversationTitle;
6641                }
6642            } else {
6643                title = sender;
6644            }
6645
6646            if (title != null) {
6647                extras.putCharSequence(EXTRA_TITLE, title);
6648            }
6649            if (text != null) {
6650                extras.putCharSequence(EXTRA_TEXT, text);
6651            }
6652        }
6653
6654        /**
6655         * @hide
6656         */
6657        @Override
6658        protected void restoreFromExtras(Bundle extras) {
6659            super.restoreFromExtras(extras);
6660
6661            mUser = extras.getParcelable(EXTRA_MESSAGING_PERSON);
6662            if (mUser == null) {
6663                CharSequence displayName = extras.getCharSequence(EXTRA_SELF_DISPLAY_NAME);
6664                mUser = new Person().setName(displayName);
6665            }
6666            mConversationTitle = extras.getCharSequence(EXTRA_CONVERSATION_TITLE);
6667            Parcelable[] messages = extras.getParcelableArray(EXTRA_MESSAGES);
6668            mMessages = Message.getMessagesFromBundleArray(messages);
6669            Parcelable[] histMessages = extras.getParcelableArray(EXTRA_HISTORIC_MESSAGES);
6670            mHistoricMessages = Message.getMessagesFromBundleArray(histMessages);
6671            mIsGroupConversation = extras.getBoolean(EXTRA_IS_GROUP_CONVERSATION);
6672        }
6673
6674        /**
6675         * @hide
6676         */
6677        @Override
6678        public RemoteViews makeContentView(boolean increasedHeight) {
6679            mBuilder.mOriginalActions = mBuilder.mActions;
6680            mBuilder.mActions = new ArrayList<>();
6681            RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
6682                    true /* showReplyIcon */);
6683            mBuilder.mActions = mBuilder.mOriginalActions;
6684            mBuilder.mOriginalActions = null;
6685            return remoteViews;
6686        }
6687
6688        /**
6689         * @hide
6690         */
6691        @Override
6692        public boolean areNotificationsVisiblyDifferent(Style other) {
6693            if (other == null || getClass() != other.getClass()) {
6694                return true;
6695            }
6696            MessagingStyle newS = (MessagingStyle) other;
6697            List<MessagingStyle.Message> oldMs = getMessages();
6698            List<MessagingStyle.Message> newMs = newS.getMessages();
6699
6700            if (oldMs == null) {
6701                oldMs = new ArrayList<>();
6702            }
6703            if (newMs == null) {
6704                newMs = new ArrayList<>();
6705            }
6706
6707            int n = oldMs.size();
6708            if (n != newMs.size()) {
6709                return true;
6710            }
6711            for (int i = 0; i < n; i++) {
6712                MessagingStyle.Message oldM = oldMs.get(i);
6713                MessagingStyle.Message newM = newMs.get(i);
6714                if (!Objects.equals(oldM.getText(), newM.getText())) {
6715                    return true;
6716                }
6717                if (!Objects.equals(oldM.getDataUri(), newM.getDataUri())) {
6718                    return true;
6719                }
6720                CharSequence oldSender = oldM.getSenderPerson() == null ? oldM.getSender()
6721                        : oldM.getSenderPerson().getName();
6722                CharSequence newSender = newM.getSenderPerson() == null ? newM.getSender()
6723                        : newM.getSenderPerson().getName();
6724                if (!Objects.equals(oldSender, newSender)) {
6725                    return true;
6726                }
6727
6728                String oldKey = oldM.getSenderPerson() == null
6729                        ? null : oldM.getSenderPerson().getKey();
6730                String newKey = newM.getSenderPerson() == null
6731                        ? null : newM.getSenderPerson().getKey();
6732                if (!Objects.equals(oldKey, newKey)) {
6733                    return true;
6734                }
6735                // Other fields (like timestamp) intentionally excluded
6736            }
6737            return false;
6738        }
6739
6740        private Message findLatestIncomingMessage() {
6741            return findLatestIncomingMessage(mMessages);
6742        }
6743
6744        /**
6745         * @hide
6746         */
6747        @Nullable
6748        public static Message findLatestIncomingMessage(
6749                List<Message> messages) {
6750            for (int i = messages.size() - 1; i >= 0; i--) {
6751                Message m = messages.get(i);
6752                // Incoming messages have a non-empty sender.
6753                if (m.mSender != null && !TextUtils.isEmpty(m.mSender.getName())) {
6754                    return m;
6755                }
6756            }
6757            if (!messages.isEmpty()) {
6758                // No incoming messages, fall back to outgoing message
6759                return messages.get(messages.size() - 1);
6760            }
6761            return null;
6762        }
6763
6764        /**
6765         * @hide
6766         */
6767        @Override
6768        public RemoteViews makeBigContentView() {
6769            return makeMessagingView(false /* displayImagesAtEnd */, false /* showReplyIcon */);
6770        }
6771
6772        /**
6773         * Create a messaging layout.
6774         *
6775         * @param displayImagesAtEnd should images be displayed at the end of the content instead
6776         *                           of inline.
6777         * @param showReplyIcon Should the reply affordance be shown at the end of the notification
6778         * @return the created remoteView.
6779         */
6780        @NonNull
6781        private RemoteViews makeMessagingView(boolean displayImagesAtEnd, boolean showReplyIcon) {
6782            CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
6783                    ? super.mBigContentTitle
6784                    : mConversationTitle;
6785            boolean isOneToOne = TextUtils.isEmpty(conversationTitle);
6786            CharSequence nameReplacement = null;
6787            if (hasOnlyWhiteSpaceSenders()) {
6788                isOneToOne = true;
6789                nameReplacement = conversationTitle;
6790                conversationTitle = null;
6791            }
6792            boolean hideLargeIcon = !showReplyIcon || isOneToOne;
6793            RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
6794                    mBuilder.getMessagingLayoutResource(),
6795                    mBuilder.mParams.reset().hasProgress(false).title(conversationTitle).text(null)
6796                            .hideLargeIcon(hideLargeIcon)
6797                            .headerTextSecondary(conversationTitle)
6798                            .alwaysShowReply(showReplyIcon));
6799            addExtras(mBuilder.mN.extras);
6800            // also update the end margin if there is an image
6801            int endMargin = R.dimen.notification_content_margin_end;
6802            if (showReplyIcon) {
6803                endMargin = R.dimen.notification_content_plus_picture_margin_end;
6804            }
6805            contentView.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
6806            contentView.setInt(R.id.status_bar_latest_event_content, "setLayoutColor",
6807                    mBuilder.resolveContrastColor());
6808            contentView.setBoolean(R.id.status_bar_latest_event_content, "setDisplayImagesAtEnd",
6809                    displayImagesAtEnd);
6810            contentView.setIcon(R.id.status_bar_latest_event_content, "setLargeIcon",
6811                    mBuilder.mN.mLargeIcon);
6812            contentView.setCharSequence(R.id.status_bar_latest_event_content, "setNameReplacement",
6813                    nameReplacement);
6814            contentView.setBoolean(R.id.status_bar_latest_event_content, "setIsOneToOne",
6815                    isOneToOne);
6816            contentView.setBundle(R.id.status_bar_latest_event_content, "setData",
6817                    mBuilder.mN.extras);
6818            return contentView;
6819        }
6820
6821        private boolean hasOnlyWhiteSpaceSenders() {
6822            for (int i = 0; i < mMessages.size(); i++) {
6823                Message m = mMessages.get(i);
6824                Person sender = m.getSenderPerson();
6825                if (sender != null && !isWhiteSpace(sender.getName())) {
6826                    return false;
6827                }
6828            }
6829            return true;
6830        }
6831
6832        private boolean isWhiteSpace(CharSequence sender) {
6833            if (TextUtils.isEmpty(sender)) {
6834                return true;
6835            }
6836            if (sender.toString().matches("^\\s*$")) {
6837                return true;
6838            }
6839            // Let's check if we only have 0 whitespace chars. Some apps did this as a workaround
6840            // For the presentation that we had.
6841            for (int i = 0; i < sender.length(); i++) {
6842                char c = sender.charAt(i);
6843                if (c != '\u200B') {
6844                    return false;
6845                }
6846            }
6847            return true;
6848        }
6849
6850        private CharSequence createConversationTitleFromMessages() {
6851            ArraySet<CharSequence> names = new ArraySet<>();
6852            for (int i = 0; i < mMessages.size(); i++) {
6853                Message m = mMessages.get(i);
6854                Person sender = m.getSenderPerson();
6855                if (sender != null) {
6856                    names.add(sender.getName());
6857                }
6858            }
6859            SpannableStringBuilder title = new SpannableStringBuilder();
6860            int size = names.size();
6861            for (int i = 0; i < size; i++) {
6862                CharSequence name = names.valueAt(i);
6863                if (!TextUtils.isEmpty(title)) {
6864                    title.append(", ");
6865                }
6866                title.append(BidiFormatter.getInstance().unicodeWrap(name));
6867            }
6868            return title;
6869        }
6870
6871        /**
6872         * @hide
6873         */
6874        @Override
6875        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
6876            RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
6877                    false /* showReplyIcon */);
6878            remoteViews.setInt(R.id.notification_messaging, "setMaxDisplayedLines", 1);
6879            return remoteViews;
6880        }
6881
6882        private static TextAppearanceSpan makeFontColorSpan(int color) {
6883            return new TextAppearanceSpan(null, 0, 0,
6884                    ColorStateList.valueOf(color), null);
6885        }
6886
6887        public static final class Message {
6888
6889            static final String KEY_TEXT = "text";
6890            static final String KEY_TIMESTAMP = "time";
6891            static final String KEY_SENDER = "sender";
6892            static final String KEY_SENDER_PERSON = "sender_person";
6893            static final String KEY_DATA_MIME_TYPE = "type";
6894            static final String KEY_DATA_URI= "uri";
6895            static final String KEY_EXTRAS_BUNDLE = "extras";
6896
6897            private final CharSequence mText;
6898            private final long mTimestamp;
6899            @Nullable
6900            private final Person mSender;
6901
6902            private Bundle mExtras = new Bundle();
6903            private String mDataMimeType;
6904            private Uri mDataUri;
6905
6906            /**
6907             * Constructor
6908             * @param text A {@link CharSequence} to be displayed as the message content
6909             * @param timestamp Time at which the message arrived
6910             * @param sender A {@link CharSequence} to be used for displaying the name of the
6911             * sender. Should be <code>null</code> for messages by the current user, in which case
6912             * the platform will insert {@link MessagingStyle#getUserDisplayName()}.
6913             * Should be unique amongst all individuals in the conversation, and should be
6914             * consistent during re-posts of the notification.
6915             *
6916             *  @deprecated use {@code Message(CharSequence, long, Person)}
6917             */
6918            public Message(CharSequence text, long timestamp, CharSequence sender){
6919                this(text, timestamp, sender == null ? null : new Person().setName(sender));
6920            }
6921
6922            /**
6923             * Constructor
6924             * @param text A {@link CharSequence} to be displayed as the message content
6925             * @param timestamp Time at which the message arrived
6926             * @param sender The {@link Person} who sent the message.
6927             * Should be <code>null</code> for messages by the current user, in which case
6928             * the platform will insert the user set in {@code MessagingStyle(Person)}.
6929             * <p>
6930             * The person provided should contain an Icon, set with {@link Person#setIcon(Icon)}
6931             * and also have a name provided with {@link Person#setName(CharSequence)}. If multiple
6932             * users have the same name, consider providing a key with {@link Person#setKey(String)}
6933             * in order to differentiate between the different users.
6934             * </p>
6935             */
6936            public Message(CharSequence text, long timestamp, @Nullable Person sender){
6937                mText = text;
6938                mTimestamp = timestamp;
6939                mSender = sender;
6940            }
6941
6942            /**
6943             * Sets a binary blob of data and an associated MIME type for a message. In the case
6944             * where the platform doesn't support the MIME type, the original text provided in the
6945             * constructor will be used.
6946             * @param dataMimeType The MIME type of the content. See
6947             * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME
6948             * types on Android and Android Wear.
6949             * @param dataUri The uri containing the content whose type is given by the MIME type.
6950             * <p class="note">
6951             * <ol>
6952             *   <li>Notification Listeners including the System UI need permission to access the
6953             *       data the Uri points to. The recommended ways to do this are:</li>
6954             *   <li>Store the data in your own ContentProvider, making sure that other apps have
6955             *       the correct permission to access your provider. The preferred mechanism for
6956             *       providing access is to use per-URI permissions which are temporary and only
6957             *       grant access to the receiving application. An easy way to create a
6958             *       ContentProvider like this is to use the FileProvider helper class.</li>
6959             *   <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio
6960             *       and image MIME types, however beginning with Android 3.0 (API level 11) it can
6961             *       also store non-media types (see MediaStore.Files for more info). Files can be
6962             *       inserted into the MediaStore using scanFile() after which a content:// style
6963             *       Uri suitable for sharing is passed to the provided onScanCompleted() callback.
6964             *       Note that once added to the system MediaStore the content is accessible to any
6965             *       app on the device.</li>
6966             * </ol>
6967             * @return this object for method chaining
6968             */
6969            public Message setData(String dataMimeType, Uri dataUri) {
6970                mDataMimeType = dataMimeType;
6971                mDataUri = dataUri;
6972                return this;
6973            }
6974
6975            /**
6976             * Get the text to be used for this message, or the fallback text if a type and content
6977             * Uri have been set
6978             */
6979            public CharSequence getText() {
6980                return mText;
6981            }
6982
6983            /**
6984             * Get the time at which this message arrived
6985             */
6986            public long getTimestamp() {
6987                return mTimestamp;
6988            }
6989
6990            /**
6991             * Get the extras Bundle for this message.
6992             */
6993            public Bundle getExtras() {
6994                return mExtras;
6995            }
6996
6997            /**
6998             * Get the text used to display the contact's name in the messaging experience
6999             *
7000             * @deprecated use {@link #getSenderPerson()}
7001             */
7002            public CharSequence getSender() {
7003                return mSender == null ? null : mSender.getName();
7004            }
7005
7006            /**
7007             * Get the sender associated with this message.
7008             */
7009            @Nullable
7010            public Person getSenderPerson() {
7011                return mSender;
7012            }
7013
7014            /**
7015             * Get the MIME type of the data pointed to by the Uri
7016             */
7017            public String getDataMimeType() {
7018                return mDataMimeType;
7019            }
7020
7021            /**
7022             * Get the the Uri pointing to the content of the message. Can be null, in which case
7023             * {@see #getText()} is used.
7024             */
7025            public Uri getDataUri() {
7026                return mDataUri;
7027            }
7028
7029            private Bundle toBundle() {
7030                Bundle bundle = new Bundle();
7031                if (mText != null) {
7032                    bundle.putCharSequence(KEY_TEXT, mText);
7033                }
7034                bundle.putLong(KEY_TIMESTAMP, mTimestamp);
7035                if (mSender != null) {
7036                    // Legacy listeners need this
7037                    bundle.putCharSequence(KEY_SENDER, mSender.getName());
7038                    bundle.putParcelable(KEY_SENDER_PERSON, mSender);
7039                }
7040                if (mDataMimeType != null) {
7041                    bundle.putString(KEY_DATA_MIME_TYPE, mDataMimeType);
7042                }
7043                if (mDataUri != null) {
7044                    bundle.putParcelable(KEY_DATA_URI, mDataUri);
7045                }
7046                if (mExtras != null) {
7047                    bundle.putBundle(KEY_EXTRAS_BUNDLE, mExtras);
7048                }
7049                return bundle;
7050            }
7051
7052            static Bundle[] getBundleArrayForMessages(List<Message> messages) {
7053                Bundle[] bundles = new Bundle[messages.size()];
7054                final int N = messages.size();
7055                for (int i = 0; i < N; i++) {
7056                    bundles[i] = messages.get(i).toBundle();
7057                }
7058                return bundles;
7059            }
7060
7061            /**
7062             * @return A list of messages read from the bundles.
7063             *
7064             * @hide
7065             */
7066            public static List<Message> getMessagesFromBundleArray(Parcelable[] bundles) {
7067                if (bundles == null) {
7068                    return new ArrayList<>();
7069                }
7070                List<Message> messages = new ArrayList<>(bundles.length);
7071                for (int i = 0; i < bundles.length; i++) {
7072                    if (bundles[i] instanceof Bundle) {
7073                        Message message = getMessageFromBundle((Bundle)bundles[i]);
7074                        if (message != null) {
7075                            messages.add(message);
7076                        }
7077                    }
7078                }
7079                return messages;
7080            }
7081
7082            static Message getMessageFromBundle(Bundle bundle) {
7083                try {
7084                    if (!bundle.containsKey(KEY_TEXT) || !bundle.containsKey(KEY_TIMESTAMP)) {
7085                        return null;
7086                    } else {
7087
7088                        Person senderPerson = bundle.getParcelable(KEY_SENDER_PERSON);
7089                        if (senderPerson == null) {
7090                            // Legacy apps that use compat don't actually provide the sender objects
7091                            // We need to fix the compat version to provide people / use
7092                            // the native api instead
7093                            CharSequence senderName = bundle.getCharSequence(KEY_SENDER);
7094                            if (senderName != null) {
7095                                senderPerson = new Person().setName(senderName);
7096                            }
7097                        }
7098                        Message message = new Message(bundle.getCharSequence(KEY_TEXT),
7099                                bundle.getLong(KEY_TIMESTAMP),
7100                                senderPerson);
7101                        if (bundle.containsKey(KEY_DATA_MIME_TYPE) &&
7102                                bundle.containsKey(KEY_DATA_URI)) {
7103                            message.setData(bundle.getString(KEY_DATA_MIME_TYPE),
7104                                    (Uri) bundle.getParcelable(KEY_DATA_URI));
7105                        }
7106                        if (bundle.containsKey(KEY_EXTRAS_BUNDLE)) {
7107                            message.getExtras().putAll(bundle.getBundle(KEY_EXTRAS_BUNDLE));
7108                        }
7109                        return message;
7110                    }
7111                } catch (ClassCastException e) {
7112                    return null;
7113                }
7114            }
7115        }
7116    }
7117
7118    /**
7119     * Helper class for generating large-format notifications that include a list of (up to 5) strings.
7120     *
7121     * Here's how you'd set the <code>InboxStyle</code> on a notification:
7122     * <pre class="prettyprint">
7123     * Notification notif = new Notification.Builder(mContext)
7124     *     .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
7125     *     .setContentText(subject)
7126     *     .setSmallIcon(R.drawable.new_mail)
7127     *     .setLargeIcon(aBitmap)
7128     *     .setStyle(new Notification.InboxStyle()
7129     *         .addLine(str1)
7130     *         .addLine(str2)
7131     *         .setContentTitle(&quot;&quot;)
7132     *         .setSummaryText(&quot;+3 more&quot;))
7133     *     .build();
7134     * </pre>
7135     *
7136     * @see Notification#bigContentView
7137     */
7138    public static class InboxStyle extends Style {
7139        private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
7140
7141        public InboxStyle() {
7142        }
7143
7144        /**
7145         * @deprecated use {@code InboxStyle()}.
7146         */
7147        @Deprecated
7148        public InboxStyle(Builder builder) {
7149            setBuilder(builder);
7150        }
7151
7152        /**
7153         * Overrides ContentTitle in the big form of the template.
7154         * This defaults to the value passed to setContentTitle().
7155         */
7156        public InboxStyle setBigContentTitle(CharSequence title) {
7157            internalSetBigContentTitle(safeCharSequence(title));
7158            return this;
7159        }
7160
7161        /**
7162         * Set the first line of text after the detail section in the big form of the template.
7163         */
7164        public InboxStyle setSummaryText(CharSequence cs) {
7165            internalSetSummaryText(safeCharSequence(cs));
7166            return this;
7167        }
7168
7169        /**
7170         * Append a line to the digest section of the Inbox notification.
7171         */
7172        public InboxStyle addLine(CharSequence cs) {
7173            mTexts.add(safeCharSequence(cs));
7174            return this;
7175        }
7176
7177        /**
7178         * @hide
7179         */
7180        public ArrayList<CharSequence> getLines() {
7181            return mTexts;
7182        }
7183
7184        /**
7185         * @hide
7186         */
7187        public void addExtras(Bundle extras) {
7188            super.addExtras(extras);
7189
7190            CharSequence[] a = new CharSequence[mTexts.size()];
7191            extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
7192        }
7193
7194        /**
7195         * @hide
7196         */
7197        @Override
7198        protected void restoreFromExtras(Bundle extras) {
7199            super.restoreFromExtras(extras);
7200
7201            mTexts.clear();
7202            if (extras.containsKey(EXTRA_TEXT_LINES)) {
7203                Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES));
7204            }
7205        }
7206
7207        /**
7208         * @hide
7209         */
7210        public RemoteViews makeBigContentView() {
7211            // Remove the content text so it disappears unless you have a summary
7212            // Nasty
7213            CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT);
7214            mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
7215
7216            RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource());
7217
7218            mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
7219
7220            int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3,
7221                    R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
7222
7223            // Make sure all rows are gone in case we reuse a view.
7224            for (int rowId : rowIds) {
7225                contentView.setViewVisibility(rowId, View.GONE);
7226            }
7227
7228            int i=0;
7229            int topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7230                    R.dimen.notification_inbox_item_top_padding);
7231            boolean first = true;
7232            int onlyViewId = 0;
7233            int maxRows = rowIds.length;
7234            if (mBuilder.mActions.size() > 0) {
7235                maxRows--;
7236            }
7237            while (i < mTexts.size() && i < maxRows) {
7238                CharSequence str = mTexts.get(i);
7239                if (!TextUtils.isEmpty(str)) {
7240                    contentView.setViewVisibility(rowIds[i], View.VISIBLE);
7241                    contentView.setTextViewText(rowIds[i],
7242                            mBuilder.processTextSpans(mBuilder.processLegacyText(str)));
7243                    mBuilder.setTextViewColorSecondary(contentView, rowIds[i]);
7244                    contentView.setViewPadding(rowIds[i], 0, topPadding, 0, 0);
7245                    handleInboxImageMargin(contentView, rowIds[i], first);
7246                    if (first) {
7247                        onlyViewId = rowIds[i];
7248                    } else {
7249                        onlyViewId = 0;
7250                    }
7251                    first = false;
7252                }
7253                i++;
7254            }
7255            if (onlyViewId != 0) {
7256                // We only have 1 entry, lets make it look like the normal Text of a Bigtext
7257                topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7258                        R.dimen.notification_text_margin_top);
7259                contentView.setViewPadding(onlyViewId, 0, topPadding, 0, 0);
7260            }
7261
7262            return contentView;
7263        }
7264
7265        /**
7266         * @hide
7267         */
7268        @Override
7269        public boolean areNotificationsVisiblyDifferent(Style other) {
7270            if (other == null || getClass() != other.getClass()) {
7271                return true;
7272            }
7273            InboxStyle newS = (InboxStyle) other;
7274            return !Objects.equals(getLines(), newS.getLines());
7275        }
7276
7277        private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first) {
7278            int endMargin = 0;
7279            if (first) {
7280                final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0);
7281                final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
7282                boolean hasProgress = max != 0 || ind;
7283                if (mBuilder.mN.hasLargeIcon() && !hasProgress) {
7284                    endMargin = R.dimen.notification_content_picture_margin;
7285                }
7286            }
7287            contentView.setViewLayoutMarginEndDimen(id, endMargin);
7288        }
7289    }
7290
7291    /**
7292     * Notification style for media playback notifications.
7293     *
7294     * In the expanded form, {@link Notification#bigContentView}, up to 5
7295     * {@link Notification.Action}s specified with
7296     * {@link Notification.Builder#addAction(Action) addAction} will be
7297     * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
7298     * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be
7299     * treated as album artwork.
7300     * <p>
7301     * Unlike the other styles provided here, MediaStyle can also modify the standard-size
7302     * {@link Notification#contentView}; by providing action indices to
7303     * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed
7304     * in the standard view alongside the usual content.
7305     * <p>
7306     * Notifications created with MediaStyle will have their category set to
7307     * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different
7308     * category using {@link Notification.Builder#setCategory(String) setCategory()}.
7309     * <p>
7310     * Finally, if you attach a {@link android.media.session.MediaSession.Token} using
7311     * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)},
7312     * the System UI can identify this as a notification representing an active media session
7313     * and respond accordingly (by showing album artwork in the lockscreen, for example).
7314     *
7315     * <p>
7316     * Starting at {@link android.os.Build.VERSION_CODES#O Android O} any notification that has a
7317     * media session attached with {@link #setMediaSession(MediaSession.Token)} will be colorized.
7318     * You can opt-out of this behavior by using {@link Notification.Builder#setColorized(boolean)}.
7319     * <p>
7320     *
7321     * To use this style with your Notification, feed it to
7322     * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7323     * <pre class="prettyprint">
7324     * Notification noti = new Notification.Builder()
7325     *     .setSmallIcon(R.drawable.ic_stat_player)
7326     *     .setContentTitle(&quot;Track title&quot;)
7327     *     .setContentText(&quot;Artist - Album&quot;)
7328     *     .setLargeIcon(albumArtBitmap))
7329     *     .setStyle(<b>new Notification.MediaStyle()</b>
7330     *         .setMediaSession(mySession))
7331     *     .build();
7332     * </pre>
7333     *
7334     * @see Notification#bigContentView
7335     * @see Notification.Builder#setColorized(boolean)
7336     */
7337    public static class MediaStyle extends Style {
7338        static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3;
7339        static final int MAX_MEDIA_BUTTONS = 5;
7340
7341        private int[] mActionsToShowInCompact = null;
7342        private MediaSession.Token mToken;
7343
7344        public MediaStyle() {
7345        }
7346
7347        /**
7348         * @deprecated use {@code MediaStyle()}.
7349         */
7350        @Deprecated
7351        public MediaStyle(Builder builder) {
7352            setBuilder(builder);
7353        }
7354
7355        /**
7356         * Request up to 3 actions (by index in the order of addition) to be shown in the compact
7357         * notification view.
7358         *
7359         * @param actions the indices of the actions to show in the compact notification view
7360         */
7361        public MediaStyle setShowActionsInCompactView(int...actions) {
7362            mActionsToShowInCompact = actions;
7363            return this;
7364        }
7365
7366        /**
7367         * Attach a {@link android.media.session.MediaSession.Token} to this Notification
7368         * to provide additional playback information and control to the SystemUI.
7369         */
7370        public MediaStyle setMediaSession(MediaSession.Token token) {
7371            mToken = token;
7372            return this;
7373        }
7374
7375        /**
7376         * @hide
7377         */
7378        @Override
7379        public Notification buildStyled(Notification wip) {
7380            super.buildStyled(wip);
7381            if (wip.category == null) {
7382                wip.category = Notification.CATEGORY_TRANSPORT;
7383            }
7384            return wip;
7385        }
7386
7387        /**
7388         * @hide
7389         */
7390        @Override
7391        public RemoteViews makeContentView(boolean increasedHeight) {
7392            return makeMediaContentView();
7393        }
7394
7395        /**
7396         * @hide
7397         */
7398        @Override
7399        public RemoteViews makeBigContentView() {
7400            return makeMediaBigContentView();
7401        }
7402
7403        /**
7404         * @hide
7405         */
7406        @Override
7407        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
7408            RemoteViews expanded = makeMediaBigContentView();
7409            return expanded != null ? expanded : makeMediaContentView();
7410        }
7411
7412        /** @hide */
7413        @Override
7414        public void addExtras(Bundle extras) {
7415            super.addExtras(extras);
7416
7417            if (mToken != null) {
7418                extras.putParcelable(EXTRA_MEDIA_SESSION, mToken);
7419            }
7420            if (mActionsToShowInCompact != null) {
7421                extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact);
7422            }
7423        }
7424
7425        /**
7426         * @hide
7427         */
7428        @Override
7429        protected void restoreFromExtras(Bundle extras) {
7430            super.restoreFromExtras(extras);
7431
7432            if (extras.containsKey(EXTRA_MEDIA_SESSION)) {
7433                mToken = extras.getParcelable(EXTRA_MEDIA_SESSION);
7434            }
7435            if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) {
7436                mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS);
7437            }
7438        }
7439
7440        /**
7441         * @hide
7442         */
7443        @Override
7444        public boolean areNotificationsVisiblyDifferent(Style other) {
7445            if (other == null || getClass() != other.getClass()) {
7446                return true;
7447            }
7448            // All fields to compare are on the Notification object
7449            return false;
7450        }
7451
7452        private RemoteViews generateMediaActionButton(Action action, int color) {
7453            final boolean tombstone = (action.actionIntent == null);
7454            RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(),
7455                    R.layout.notification_material_media_action);
7456            button.setImageViewIcon(R.id.action0, action.getIcon());
7457
7458            // If the action buttons should not be tinted, then just use the default
7459            // notification color. Otherwise, just use the passed-in color.
7460            int tintColor = mBuilder.shouldTintActionButtons() || mBuilder.isColorized()
7461                    ? color
7462                    : NotificationColorUtil.resolveColor(mBuilder.mContext,
7463                            Notification.COLOR_DEFAULT);
7464
7465            button.setDrawableTint(R.id.action0, false, tintColor,
7466                    PorterDuff.Mode.SRC_ATOP);
7467            if (!tombstone) {
7468                button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
7469            }
7470            button.setContentDescription(R.id.action0, action.title);
7471            return button;
7472        }
7473
7474        private RemoteViews makeMediaContentView() {
7475            RemoteViews view = mBuilder.applyStandardTemplate(
7476                    R.layout.notification_template_material_media, false /* hasProgress */);
7477
7478            final int numActions = mBuilder.mActions.size();
7479            final int N = mActionsToShowInCompact == null
7480                    ? 0
7481                    : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
7482            if (N > 0) {
7483                view.removeAllViews(com.android.internal.R.id.media_actions);
7484                for (int i = 0; i < N; i++) {
7485                    if (i >= numActions) {
7486                        throw new IllegalArgumentException(String.format(
7487                                "setShowActionsInCompactView: action %d out of bounds (max %d)",
7488                                i, numActions - 1));
7489                    }
7490
7491                    final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]);
7492                    final RemoteViews button = generateMediaActionButton(action, getActionColor());
7493                    view.addView(com.android.internal.R.id.media_actions, button);
7494                }
7495            }
7496            handleImage(view);
7497            // handle the content margin
7498            int endMargin = R.dimen.notification_content_margin_end;
7499            if (mBuilder.mN.hasLargeIcon()) {
7500                endMargin = R.dimen.notification_content_plus_picture_margin_end;
7501            }
7502            view.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
7503            return view;
7504        }
7505
7506        private int getActionColor() {
7507            return mBuilder.isColorized() ? mBuilder.getPrimaryTextColor()
7508                    : mBuilder.resolveContrastColor();
7509        }
7510
7511        private RemoteViews makeMediaBigContentView() {
7512            final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS);
7513            // Dont add an expanded view if there is no more content to be revealed
7514            int actionsInCompact = mActionsToShowInCompact == null
7515                    ? 0
7516                    : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
7517            if (!mBuilder.mN.hasLargeIcon() && actionCount <= actionsInCompact) {
7518                return null;
7519            }
7520            RemoteViews big = mBuilder.applyStandardTemplate(
7521                    R.layout.notification_template_material_big_media,
7522                    false);
7523
7524            if (actionCount > 0) {
7525                big.removeAllViews(com.android.internal.R.id.media_actions);
7526                for (int i = 0; i < actionCount; i++) {
7527                    final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i),
7528                            getActionColor());
7529                    big.addView(com.android.internal.R.id.media_actions, button);
7530                }
7531            }
7532            handleImage(big);
7533            return big;
7534        }
7535
7536        private void handleImage(RemoteViews contentView) {
7537            if (mBuilder.mN.hasLargeIcon()) {
7538                contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
7539                contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
7540            }
7541        }
7542
7543        /**
7544         * @hide
7545         */
7546        @Override
7547        protected boolean hasProgress() {
7548            return false;
7549        }
7550    }
7551
7552    /**
7553     * Notification style for custom views that are decorated by the system
7554     *
7555     * <p>Instead of providing a notification that is completely custom, a developer can set this
7556     * style and still obtain system decorations like the notification header with the expand
7557     * affordance and actions.
7558     *
7559     * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7560     * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7561     * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7562     * corresponding custom views to display.
7563     *
7564     * To use this style with your Notification, feed it to
7565     * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7566     * <pre class="prettyprint">
7567     * Notification noti = new Notification.Builder()
7568     *     .setSmallIcon(R.drawable.ic_stat_player)
7569     *     .setLargeIcon(albumArtBitmap))
7570     *     .setCustomContentView(contentView);
7571     *     .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>)
7572     *     .build();
7573     * </pre>
7574     */
7575    public static class DecoratedCustomViewStyle extends Style {
7576
7577        public DecoratedCustomViewStyle() {
7578        }
7579
7580        /**
7581         * @hide
7582         */
7583        public boolean displayCustomViewInline() {
7584            return true;
7585        }
7586
7587        /**
7588         * @hide
7589         */
7590        @Override
7591        public RemoteViews makeContentView(boolean increasedHeight) {
7592            return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView);
7593        }
7594
7595        /**
7596         * @hide
7597         */
7598        @Override
7599        public RemoteViews makeBigContentView() {
7600            return makeDecoratedBigContentView();
7601        }
7602
7603        /**
7604         * @hide
7605         */
7606        @Override
7607        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
7608            return makeDecoratedHeadsUpContentView();
7609        }
7610
7611        private RemoteViews makeDecoratedHeadsUpContentView() {
7612            RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null
7613                    ? mBuilder.mN.contentView
7614                    : mBuilder.mN.headsUpContentView;
7615            if (mBuilder.mActions.size() == 0) {
7616               return makeStandardTemplateWithCustomContent(headsUpContentView);
7617            }
7618            RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
7619                        mBuilder.getBigBaseLayoutResource());
7620            buildIntoRemoteViewContent(remoteViews, headsUpContentView);
7621            return remoteViews;
7622        }
7623
7624        private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) {
7625            RemoteViews remoteViews = mBuilder.applyStandardTemplate(
7626                    mBuilder.getBaseLayoutResource());
7627            buildIntoRemoteViewContent(remoteViews, customContent);
7628            return remoteViews;
7629        }
7630
7631        private RemoteViews makeDecoratedBigContentView() {
7632            RemoteViews bigContentView = mBuilder.mN.bigContentView == null
7633                    ? mBuilder.mN.contentView
7634                    : mBuilder.mN.bigContentView;
7635            if (mBuilder.mActions.size() == 0) {
7636                return makeStandardTemplateWithCustomContent(bigContentView);
7637            }
7638            RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
7639                    mBuilder.getBigBaseLayoutResource());
7640            buildIntoRemoteViewContent(remoteViews, bigContentView);
7641            return remoteViews;
7642        }
7643
7644        private void buildIntoRemoteViewContent(RemoteViews remoteViews,
7645                RemoteViews customContent) {
7646            if (customContent != null) {
7647                // Need to clone customContent before adding, because otherwise it can no longer be
7648                // parceled independently of remoteViews.
7649                customContent = customContent.clone();
7650                remoteViews.removeAllViewsExceptId(R.id.notification_main_column, R.id.progress);
7651                remoteViews.addView(R.id.notification_main_column, customContent, 0 /* index */);
7652                remoteViews.setReapplyDisallowed();
7653            }
7654            // also update the end margin if there is an image
7655            int endMargin = R.dimen.notification_content_margin_end;
7656            if (mBuilder.mN.hasLargeIcon()) {
7657                endMargin = R.dimen.notification_content_plus_picture_margin_end;
7658            }
7659            remoteViews.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
7660        }
7661
7662        /**
7663         * @hide
7664         */
7665        @Override
7666        public boolean areNotificationsVisiblyDifferent(Style other) {
7667            if (other == null || getClass() != other.getClass()) {
7668                return true;
7669            }
7670            // Comparison done for all custom RemoteViews, independent of style
7671            return false;
7672        }
7673    }
7674
7675    /**
7676     * Notification style for media custom views that are decorated by the system
7677     *
7678     * <p>Instead of providing a media notification that is completely custom, a developer can set
7679     * this style and still obtain system decorations like the notification header with the expand
7680     * affordance and actions.
7681     *
7682     * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7683     * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7684     * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7685     * corresponding custom views to display.
7686     * <p>
7687     * Contrary to {@link MediaStyle} a developer has to opt-in to the colorizing of the
7688     * notification by using {@link Notification.Builder#setColorized(boolean)}.
7689     * <p>
7690     * To use this style with your Notification, feed it to
7691     * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7692     * <pre class="prettyprint">
7693     * Notification noti = new Notification.Builder()
7694     *     .setSmallIcon(R.drawable.ic_stat_player)
7695     *     .setLargeIcon(albumArtBitmap))
7696     *     .setCustomContentView(contentView);
7697     *     .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b>
7698     *          .setMediaSession(mySession))
7699     *     .build();
7700     * </pre>
7701     *
7702     * @see android.app.Notification.DecoratedCustomViewStyle
7703     * @see android.app.Notification.MediaStyle
7704     */
7705    public static class DecoratedMediaCustomViewStyle extends MediaStyle {
7706
7707        public DecoratedMediaCustomViewStyle() {
7708        }
7709
7710        /**
7711         * @hide
7712         */
7713        public boolean displayCustomViewInline() {
7714            return true;
7715        }
7716
7717        /**
7718         * @hide
7719         */
7720        @Override
7721        public RemoteViews makeContentView(boolean increasedHeight) {
7722            RemoteViews remoteViews = super.makeContentView(false /* increasedHeight */);
7723            return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
7724                    mBuilder.mN.contentView);
7725        }
7726
7727        /**
7728         * @hide
7729         */
7730        @Override
7731        public RemoteViews makeBigContentView() {
7732            RemoteViews customRemoteView = mBuilder.mN.bigContentView != null
7733                    ? mBuilder.mN.bigContentView
7734                    : mBuilder.mN.contentView;
7735            return makeBigContentViewWithCustomContent(customRemoteView);
7736        }
7737
7738        private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) {
7739            RemoteViews remoteViews = super.makeBigContentView();
7740            if (remoteViews != null) {
7741                return buildIntoRemoteView(remoteViews, R.id.notification_main_column,
7742                        customRemoteView);
7743            } else if (customRemoteView != mBuilder.mN.contentView){
7744                remoteViews = super.makeContentView(false /* increasedHeight */);
7745                return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
7746                        customRemoteView);
7747            } else {
7748                return null;
7749            }
7750        }
7751
7752        /**
7753         * @hide
7754         */
7755        @Override
7756        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
7757            RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null
7758                    ? mBuilder.mN.headsUpContentView
7759                    : mBuilder.mN.contentView;
7760            return makeBigContentViewWithCustomContent(customRemoteView);
7761        }
7762
7763        /**
7764         * @hide
7765         */
7766        @Override
7767        public boolean areNotificationsVisiblyDifferent(Style other) {
7768            if (other == null || getClass() != other.getClass()) {
7769                return true;
7770            }
7771            // Comparison done for all custom RemoteViews, independent of style
7772            return false;
7773        }
7774
7775        private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id,
7776                RemoteViews customContent) {
7777            if (customContent != null) {
7778                // Need to clone customContent before adding, because otherwise it can no longer be
7779                // parceled independently of remoteViews.
7780                customContent = customContent.clone();
7781                customContent.overrideTextColors(mBuilder.getPrimaryTextColor());
7782                remoteViews.removeAllViews(id);
7783                remoteViews.addView(id, customContent);
7784                remoteViews.setReapplyDisallowed();
7785            }
7786            return remoteViews;
7787        }
7788    }
7789
7790    /**
7791     * A Person associated with this Notification.
7792     */
7793    public static final class Person implements Parcelable {
7794        @Nullable private CharSequence mName;
7795        @Nullable private Icon mIcon;
7796        @Nullable private String mUri;
7797        @Nullable private String mKey;
7798        private boolean mBot;
7799        private boolean mImportant;
7800
7801        protected Person(Parcel in) {
7802            mName = in.readCharSequence();
7803            if (in.readInt() != 0) {
7804                mIcon = Icon.CREATOR.createFromParcel(in);
7805            }
7806            mUri = in.readString();
7807            mKey = in.readString();
7808            mImportant = in.readBoolean();
7809            mBot = in.readBoolean();
7810        }
7811
7812        /**
7813         * Create a new person.
7814         */
7815        public Person() {
7816        }
7817
7818        /**
7819         * Give this person a name.
7820         *
7821         * @param name the name of this person
7822         */
7823        public Person setName(@Nullable CharSequence name) {
7824            this.mName = name;
7825            return this;
7826        }
7827
7828        /**
7829         * Add an icon for this person.
7830         * <br />
7831         * This is currently only used for {@link MessagingStyle} notifications and should not be
7832         * provided otherwise, in order to save memory. The system will prefer this icon over any
7833         * images that are resolved from the URI.
7834         *
7835         * @param icon the icon of the person
7836         */
7837        public Person setIcon(@Nullable Icon icon) {
7838            this.mIcon = icon;
7839            return this;
7840        }
7841
7842        /**
7843         * Set a URI associated with this person.
7844         *
7845         * <P>
7846         * Depending on user preferences, adding a URI to a Person may allow the notification to
7847         * pass through interruption filters, if this notification is of
7848         * category {@link #CATEGORY_CALL} or {@link #CATEGORY_MESSAGE}.
7849         * The addition of people may also cause this notification to appear more prominently in
7850         * the user interface.
7851         * </P>
7852         *
7853         * <P>
7854         * The person should be specified by the {@code String} representation of a
7855         * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
7856         * </P>
7857         *
7858         * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
7859         * URIs.  The path part of these URIs must exist in the contacts database, in the
7860         * appropriate column, or the reference will be discarded as invalid. Telephone schema
7861         * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
7862         * </P>
7863         *
7864         * @param uri a URI for the person
7865         */
7866        public Person setUri(@Nullable String uri) {
7867            mUri = uri;
7868            return this;
7869        }
7870
7871        /**
7872         * Add a key to this person in order to uniquely identify it.
7873         * This is especially useful if the name doesn't uniquely identify this person or if the
7874         * display name is a short handle of the actual name.
7875         *
7876         * <P>If no key is provided, the name serves as as the key for the purpose of
7877         * identification.</P>
7878         *
7879         * @param key the key that uniquely identifies this person
7880         */
7881        public Person setKey(@Nullable String key) {
7882            mKey = key;
7883            return this;
7884        }
7885
7886        /**
7887         * Sets whether this is an important person. Use this method to denote users who frequently
7888         * interact with the user of this device, when it is not possible to refer to the user
7889         * by {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
7890         *
7891         * @param isImportant {@code true} if this is an important person, {@code false} otherwise.
7892         */
7893        public Person setImportant(boolean isImportant) {
7894            mImportant = isImportant;
7895            return this;
7896        }
7897
7898        /**
7899         * Sets whether this person is a machine rather than a human.
7900         *
7901         * @param isBot {@code true}  if this person is a machine, {@code false} otherwise.
7902         */
7903        public Person setBot(boolean isBot) {
7904            mBot = isBot;
7905            return this;
7906        }
7907
7908        /**
7909         * @return the uri provided for this person or {@code null} if no Uri was provided
7910         */
7911        @Nullable
7912        public String getUri() {
7913            return mUri;
7914        }
7915
7916        /**
7917         * @return the name provided for this person or {@code null} if no name was provided
7918         */
7919        @Nullable
7920        public CharSequence getName() {
7921            return mName;
7922        }
7923
7924        /**
7925         * @return the icon provided for this person or {@code null} if no icon was provided
7926         */
7927        @Nullable
7928        public Icon getIcon() {
7929            return mIcon;
7930        }
7931
7932        /**
7933         * @return the key provided for this person or {@code null} if no key was provided
7934         */
7935        @Nullable
7936        public String getKey() {
7937            return mKey;
7938        }
7939
7940        /**
7941         * @return whether this Person is a machine.
7942         */
7943        public boolean isBot() {
7944            return mBot;
7945        }
7946
7947        /**
7948         * @return whether this Person is important.
7949         */
7950        public boolean isImportant() {
7951            return mImportant;
7952        }
7953
7954        /**
7955         * @return the URI associated with this person, or "name:mName" otherwise
7956         *  @hide
7957         */
7958        public String resolveToLegacyUri() {
7959            if (mUri != null) {
7960                return mUri;
7961            }
7962            if (mName != null) {
7963                return "name:" + mName;
7964            }
7965            return "";
7966        }
7967
7968        @Override
7969        public int describeContents() {
7970            return 0;
7971        }
7972
7973        @Override
7974        public void writeToParcel(Parcel dest, @WriteFlags int flags) {
7975            dest.writeCharSequence(mName);
7976            if (mIcon != null) {
7977                dest.writeInt(1);
7978                mIcon.writeToParcel(dest, 0);
7979            } else {
7980                dest.writeInt(0);
7981            }
7982            dest.writeString(mUri);
7983            dest.writeString(mKey);
7984            dest.writeBoolean(mImportant);
7985            dest.writeBoolean(mBot);
7986        }
7987
7988        public static final Creator<Person> CREATOR = new Creator<Person>() {
7989            @Override
7990            public Person createFromParcel(Parcel in) {
7991                return new Person(in);
7992            }
7993
7994            @Override
7995            public Person[] newArray(int size) {
7996                return new Person[size];
7997            }
7998        };
7999    }
8000
8001    // When adding a new Style subclass here, don't forget to update
8002    // Builder.getNotificationStyleClass.
8003
8004    /**
8005     * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
8006     * metadata or change options on a notification builder.
8007     */
8008    public interface Extender {
8009        /**
8010         * Apply this extender to a notification builder.
8011         * @param builder the builder to be modified.
8012         * @return the build object for chaining.
8013         */
8014        public Builder extend(Builder builder);
8015    }
8016
8017    /**
8018     * Helper class to add wearable extensions to notifications.
8019     * <p class="note"> See
8020     * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications
8021     * for Android Wear</a> for more information on how to use this class.
8022     * <p>
8023     * To create a notification with wearable extensions:
8024     * <ol>
8025     *   <li>Create a {@link android.app.Notification.Builder}, setting any desired
8026     *   properties.
8027     *   <li>Create a {@link android.app.Notification.WearableExtender}.
8028     *   <li>Set wearable-specific properties using the
8029     *   {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}.
8030     *   <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a
8031     *   notification.
8032     *   <li>Post the notification to the notification system with the
8033     *   {@code NotificationManager.notify(...)} methods.
8034     * </ol>
8035     *
8036     * <pre class="prettyprint">
8037     * Notification notif = new Notification.Builder(mContext)
8038     *         .setContentTitle(&quot;New mail from &quot; + sender.toString())
8039     *         .setContentText(subject)
8040     *         .setSmallIcon(R.drawable.new_mail)
8041     *         .extend(new Notification.WearableExtender()
8042     *                 .setContentIcon(R.drawable.new_mail))
8043     *         .build();
8044     * NotificationManager notificationManger =
8045     *         (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
8046     * notificationManger.notify(0, notif);</pre>
8047     *
8048     * <p>Wearable extensions can be accessed on an existing notification by using the
8049     * {@code WearableExtender(Notification)} constructor,
8050     * and then using the {@code get} methods to access values.
8051     *
8052     * <pre class="prettyprint">
8053     * Notification.WearableExtender wearableExtender = new Notification.WearableExtender(
8054     *         notification);
8055     * List&lt;Notification&gt; pages = wearableExtender.getPages();</pre>
8056     */
8057    public static final class WearableExtender implements Extender {
8058        /**
8059         * Sentinel value for an action index that is unset.
8060         */
8061        public static final int UNSET_ACTION_INDEX = -1;
8062
8063        /**
8064         * Size value for use with {@link #setCustomSizePreset} to show this notification with
8065         * default sizing.
8066         * <p>For custom display notifications created using {@link #setDisplayIntent},
8067         * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based
8068         * on their content.
8069         */
8070        public static final int SIZE_DEFAULT = 0;
8071
8072        /**
8073         * Size value for use with {@link #setCustomSizePreset} to show this notification
8074         * with an extra small size.
8075         * <p>This value is only applicable for custom display notifications created using
8076         * {@link #setDisplayIntent}.
8077         */
8078        public static final int SIZE_XSMALL = 1;
8079
8080        /**
8081         * Size value for use with {@link #setCustomSizePreset} to show this notification
8082         * with a small size.
8083         * <p>This value is only applicable for custom display notifications created using
8084         * {@link #setDisplayIntent}.
8085         */
8086        public static final int SIZE_SMALL = 2;
8087
8088        /**
8089         * Size value for use with {@link #setCustomSizePreset} to show this notification
8090         * with a medium size.
8091         * <p>This value is only applicable for custom display notifications created using
8092         * {@link #setDisplayIntent}.
8093         */
8094        public static final int SIZE_MEDIUM = 3;
8095
8096        /**
8097         * Size value for use with {@link #setCustomSizePreset} to show this notification
8098         * with a large size.
8099         * <p>This value is only applicable for custom display notifications created using
8100         * {@link #setDisplayIntent}.
8101         */
8102        public static final int SIZE_LARGE = 4;
8103
8104        /**
8105         * Size value for use with {@link #setCustomSizePreset} to show this notification
8106         * full screen.
8107         * <p>This value is only applicable for custom display notifications created using
8108         * {@link #setDisplayIntent}.
8109         */
8110        public static final int SIZE_FULL_SCREEN = 5;
8111
8112        /**
8113         * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a
8114         * short amount of time when this notification is displayed on the screen. This
8115         * is the default value.
8116         */
8117        public static final int SCREEN_TIMEOUT_SHORT = 0;
8118
8119        /**
8120         * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on
8121         * for a longer amount of time when this notification is displayed on the screen.
8122         */
8123        public static final int SCREEN_TIMEOUT_LONG = -1;
8124
8125        /** Notification extra which contains wearable extensions */
8126        private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
8127
8128        // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
8129        private static final String KEY_ACTIONS = "actions";
8130        private static final String KEY_FLAGS = "flags";
8131        private static final String KEY_DISPLAY_INTENT = "displayIntent";
8132        private static final String KEY_PAGES = "pages";
8133        private static final String KEY_BACKGROUND = "background";
8134        private static final String KEY_CONTENT_ICON = "contentIcon";
8135        private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity";
8136        private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex";
8137        private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset";
8138        private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight";
8139        private static final String KEY_GRAVITY = "gravity";
8140        private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout";
8141        private static final String KEY_DISMISSAL_ID = "dismissalId";
8142        private static final String KEY_BRIDGE_TAG = "bridgeTag";
8143
8144        // Flags bitwise-ored to mFlags
8145        private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1;
8146        private static final int FLAG_HINT_HIDE_ICON = 1 << 1;
8147        private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2;
8148        private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3;
8149        private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4;
8150        private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5;
8151        private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6;
8152
8153        // Default value for flags integer
8154        private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE;
8155
8156        private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END;
8157        private static final int DEFAULT_GRAVITY = Gravity.BOTTOM;
8158
8159        private ArrayList<Action> mActions = new ArrayList<Action>();
8160        private int mFlags = DEFAULT_FLAGS;
8161        private PendingIntent mDisplayIntent;
8162        private ArrayList<Notification> mPages = new ArrayList<Notification>();
8163        private Bitmap mBackground;
8164        private int mContentIcon;
8165        private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY;
8166        private int mContentActionIndex = UNSET_ACTION_INDEX;
8167        private int mCustomSizePreset = SIZE_DEFAULT;
8168        private int mCustomContentHeight;
8169        private int mGravity = DEFAULT_GRAVITY;
8170        private int mHintScreenTimeout;
8171        private String mDismissalId;
8172        private String mBridgeTag;
8173
8174        /**
8175         * Create a {@link android.app.Notification.WearableExtender} with default
8176         * options.
8177         */
8178        public WearableExtender() {
8179        }
8180
8181        public WearableExtender(Notification notif) {
8182            Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS);
8183            if (wearableBundle != null) {
8184                List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS);
8185                if (actions != null) {
8186                    mActions.addAll(actions);
8187                }
8188
8189                mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
8190                mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT);
8191
8192                Notification[] pages = getNotificationArrayFromBundle(
8193                        wearableBundle, KEY_PAGES);
8194                if (pages != null) {
8195                    Collections.addAll(mPages, pages);
8196                }
8197
8198                mBackground = wearableBundle.getParcelable(KEY_BACKGROUND);
8199                mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON);
8200                mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY,
8201                        DEFAULT_CONTENT_ICON_GRAVITY);
8202                mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX,
8203                        UNSET_ACTION_INDEX);
8204                mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET,
8205                        SIZE_DEFAULT);
8206                mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT);
8207                mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY);
8208                mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT);
8209                mDismissalId = wearableBundle.getString(KEY_DISMISSAL_ID);
8210                mBridgeTag = wearableBundle.getString(KEY_BRIDGE_TAG);
8211            }
8212        }
8213
8214        /**
8215         * Apply wearable extensions to a notification that is being built. This is typically
8216         * called by the {@link android.app.Notification.Builder#extend} method of
8217         * {@link android.app.Notification.Builder}.
8218         */
8219        @Override
8220        public Notification.Builder extend(Notification.Builder builder) {
8221            Bundle wearableBundle = new Bundle();
8222
8223            if (!mActions.isEmpty()) {
8224                wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions);
8225            }
8226            if (mFlags != DEFAULT_FLAGS) {
8227                wearableBundle.putInt(KEY_FLAGS, mFlags);
8228            }
8229            if (mDisplayIntent != null) {
8230                wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent);
8231            }
8232            if (!mPages.isEmpty()) {
8233                wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray(
8234                        new Notification[mPages.size()]));
8235            }
8236            if (mBackground != null) {
8237                wearableBundle.putParcelable(KEY_BACKGROUND, mBackground);
8238            }
8239            if (mContentIcon != 0) {
8240                wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon);
8241            }
8242            if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) {
8243                wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity);
8244            }
8245            if (mContentActionIndex != UNSET_ACTION_INDEX) {
8246                wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX,
8247                        mContentActionIndex);
8248            }
8249            if (mCustomSizePreset != SIZE_DEFAULT) {
8250                wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset);
8251            }
8252            if (mCustomContentHeight != 0) {
8253                wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight);
8254            }
8255            if (mGravity != DEFAULT_GRAVITY) {
8256                wearableBundle.putInt(KEY_GRAVITY, mGravity);
8257            }
8258            if (mHintScreenTimeout != 0) {
8259                wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout);
8260            }
8261            if (mDismissalId != null) {
8262                wearableBundle.putString(KEY_DISMISSAL_ID, mDismissalId);
8263            }
8264            if (mBridgeTag != null) {
8265                wearableBundle.putString(KEY_BRIDGE_TAG, mBridgeTag);
8266            }
8267
8268            builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
8269            return builder;
8270        }
8271
8272        @Override
8273        public WearableExtender clone() {
8274            WearableExtender that = new WearableExtender();
8275            that.mActions = new ArrayList<Action>(this.mActions);
8276            that.mFlags = this.mFlags;
8277            that.mDisplayIntent = this.mDisplayIntent;
8278            that.mPages = new ArrayList<Notification>(this.mPages);
8279            that.mBackground = this.mBackground;
8280            that.mContentIcon = this.mContentIcon;
8281            that.mContentIconGravity = this.mContentIconGravity;
8282            that.mContentActionIndex = this.mContentActionIndex;
8283            that.mCustomSizePreset = this.mCustomSizePreset;
8284            that.mCustomContentHeight = this.mCustomContentHeight;
8285            that.mGravity = this.mGravity;
8286            that.mHintScreenTimeout = this.mHintScreenTimeout;
8287            that.mDismissalId = this.mDismissalId;
8288            that.mBridgeTag = this.mBridgeTag;
8289            return that;
8290        }
8291
8292        /**
8293         * Add a wearable action to this notification.
8294         *
8295         * <p>When wearable actions are added using this method, the set of actions that
8296         * show on a wearable device splits from devices that only show actions added
8297         * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8298         * of which actions display on different devices.
8299         *
8300         * @param action the action to add to this notification
8301         * @return this object for method chaining
8302         * @see android.app.Notification.Action
8303         */
8304        public WearableExtender addAction(Action action) {
8305            mActions.add(action);
8306            return this;
8307        }
8308
8309        /**
8310         * Adds wearable actions to this notification.
8311         *
8312         * <p>When wearable actions are added using this method, the set of actions that
8313         * show on a wearable device splits from devices that only show actions added
8314         * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8315         * of which actions display on different devices.
8316         *
8317         * @param actions the actions to add to this notification
8318         * @return this object for method chaining
8319         * @see android.app.Notification.Action
8320         */
8321        public WearableExtender addActions(List<Action> actions) {
8322            mActions.addAll(actions);
8323            return this;
8324        }
8325
8326        /**
8327         * Clear all wearable actions present on this builder.
8328         * @return this object for method chaining.
8329         * @see #addAction
8330         */
8331        public WearableExtender clearActions() {
8332            mActions.clear();
8333            return this;
8334        }
8335
8336        /**
8337         * Get the wearable actions present on this notification.
8338         */
8339        public List<Action> getActions() {
8340            return mActions;
8341        }
8342
8343        /**
8344         * Set an intent to launch inside of an activity view when displaying
8345         * this notification. The {@link PendingIntent} provided should be for an activity.
8346         *
8347         * <pre class="prettyprint">
8348         * Intent displayIntent = new Intent(context, MyDisplayActivity.class);
8349         * PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
8350         *         0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
8351         * Notification notif = new Notification.Builder(context)
8352         *         .extend(new Notification.WearableExtender()
8353         *                 .setDisplayIntent(displayPendingIntent)
8354         *                 .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM))
8355         *         .build();</pre>
8356         *
8357         * <p>The activity to launch needs to allow embedding, must be exported, and
8358         * should have an empty task affinity. It is also recommended to use the device
8359         * default light theme.
8360         *
8361         * <p>Example AndroidManifest.xml entry:
8362         * <pre class="prettyprint">
8363         * &lt;activity android:name=&quot;com.example.MyDisplayActivity&quot;
8364         *     android:exported=&quot;true&quot;
8365         *     android:allowEmbedded=&quot;true&quot;
8366         *     android:taskAffinity=&quot;&quot;
8367         *     android:theme=&quot;@android:style/Theme.DeviceDefault.Light&quot; /&gt;</pre>
8368         *
8369         * @param intent the {@link PendingIntent} for an activity
8370         * @return this object for method chaining
8371         * @see android.app.Notification.WearableExtender#getDisplayIntent
8372         */
8373        public WearableExtender setDisplayIntent(PendingIntent intent) {
8374            mDisplayIntent = intent;
8375            return this;
8376        }
8377
8378        /**
8379         * Get the intent to launch inside of an activity view when displaying this
8380         * notification. This {@code PendingIntent} should be for an activity.
8381         */
8382        public PendingIntent getDisplayIntent() {
8383            return mDisplayIntent;
8384        }
8385
8386        /**
8387         * Add an additional page of content to display with this notification. The current
8388         * notification forms the first page, and pages added using this function form
8389         * subsequent pages. This field can be used to separate a notification into multiple
8390         * sections.
8391         *
8392         * @param page the notification to add as another page
8393         * @return this object for method chaining
8394         * @see android.app.Notification.WearableExtender#getPages
8395         */
8396        public WearableExtender addPage(Notification page) {
8397            mPages.add(page);
8398            return this;
8399        }
8400
8401        /**
8402         * Add additional pages of content to display with this notification. The current
8403         * notification forms the first page, and pages added using this function form
8404         * subsequent pages. This field can be used to separate a notification into multiple
8405         * sections.
8406         *
8407         * @param pages a list of notifications
8408         * @return this object for method chaining
8409         * @see android.app.Notification.WearableExtender#getPages
8410         */
8411        public WearableExtender addPages(List<Notification> pages) {
8412            mPages.addAll(pages);
8413            return this;
8414        }
8415
8416        /**
8417         * Clear all additional pages present on this builder.
8418         * @return this object for method chaining.
8419         * @see #addPage
8420         */
8421        public WearableExtender clearPages() {
8422            mPages.clear();
8423            return this;
8424        }
8425
8426        /**
8427         * Get the array of additional pages of content for displaying this notification. The
8428         * current notification forms the first page, and elements within this array form
8429         * subsequent pages. This field can be used to separate a notification into multiple
8430         * sections.
8431         * @return the pages for this notification
8432         */
8433        public List<Notification> getPages() {
8434            return mPages;
8435        }
8436
8437        /**
8438         * Set a background image to be displayed behind the notification content.
8439         * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8440         * will work with any notification style.
8441         *
8442         * @param background the background bitmap
8443         * @return this object for method chaining
8444         * @see android.app.Notification.WearableExtender#getBackground
8445         */
8446        public WearableExtender setBackground(Bitmap background) {
8447            mBackground = background;
8448            return this;
8449        }
8450
8451        /**
8452         * Get a background image to be displayed behind the notification content.
8453         * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8454         * will work with any notification style.
8455         *
8456         * @return the background image
8457         * @see android.app.Notification.WearableExtender#setBackground
8458         */
8459        public Bitmap getBackground() {
8460            return mBackground;
8461        }
8462
8463        /**
8464         * Set an icon that goes with the content of this notification.
8465         */
8466        @Deprecated
8467        public WearableExtender setContentIcon(int icon) {
8468            mContentIcon = icon;
8469            return this;
8470        }
8471
8472        /**
8473         * Get an icon that goes with the content of this notification.
8474         */
8475        @Deprecated
8476        public int getContentIcon() {
8477            return mContentIcon;
8478        }
8479
8480        /**
8481         * Set the gravity that the content icon should have within the notification display.
8482         * Supported values include {@link android.view.Gravity#START} and
8483         * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8484         * @see #setContentIcon
8485         */
8486        @Deprecated
8487        public WearableExtender setContentIconGravity(int contentIconGravity) {
8488            mContentIconGravity = contentIconGravity;
8489            return this;
8490        }
8491
8492        /**
8493         * Get the gravity that the content icon should have within the notification display.
8494         * Supported values include {@link android.view.Gravity#START} and
8495         * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8496         * @see #getContentIcon
8497         */
8498        @Deprecated
8499        public int getContentIconGravity() {
8500            return mContentIconGravity;
8501        }
8502
8503        /**
8504         * Set an action from this notification's actions to be clickable with the content of
8505         * this notification. This action will no longer display separately from the
8506         * notification's content.
8507         *
8508         * <p>For notifications with multiple pages, child pages can also have content actions
8509         * set, although the list of available actions comes from the main notification and not
8510         * from the child page's notification.
8511         *
8512         * @param actionIndex The index of the action to hoist onto the current notification page.
8513         *                    If wearable actions were added to the main notification, this index
8514         *                    will apply to that list, otherwise it will apply to the regular
8515         *                    actions list.
8516         */
8517        public WearableExtender setContentAction(int actionIndex) {
8518            mContentActionIndex = actionIndex;
8519            return this;
8520        }
8521
8522        /**
8523         * Get the index of the notification action, if any, that was specified as being clickable
8524         * with the content of this notification. This action will no longer display separately
8525         * from the notification's content.
8526         *
8527         * <p>For notifications with multiple pages, child pages can also have content actions
8528         * set, although the list of available actions comes from the main notification and not
8529         * from the child page's notification.
8530         *
8531         * <p>If wearable specific actions were added to the main notification, this index will
8532         * apply to that list, otherwise it will apply to the regular actions list.
8533         *
8534         * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected.
8535         */
8536        public int getContentAction() {
8537            return mContentActionIndex;
8538        }
8539
8540        /**
8541         * Set the gravity that this notification should have within the available viewport space.
8542         * Supported values include {@link android.view.Gravity#TOP},
8543         * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8544         * The default value is {@link android.view.Gravity#BOTTOM}.
8545         */
8546        @Deprecated
8547        public WearableExtender setGravity(int gravity) {
8548            mGravity = gravity;
8549            return this;
8550        }
8551
8552        /**
8553         * Get the gravity that this notification should have within the available viewport space.
8554         * Supported values include {@link android.view.Gravity#TOP},
8555         * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8556         * The default value is {@link android.view.Gravity#BOTTOM}.
8557         */
8558        @Deprecated
8559        public int getGravity() {
8560            return mGravity;
8561        }
8562
8563        /**
8564         * Set the custom size preset for the display of this notification out of the available
8565         * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8566         * {@link #SIZE_LARGE}.
8567         * <p>Some custom size presets are only applicable for custom display notifications created
8568         * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the
8569         * documentation for the preset in question. See also
8570         * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}.
8571         */
8572        @Deprecated
8573        public WearableExtender setCustomSizePreset(int sizePreset) {
8574            mCustomSizePreset = sizePreset;
8575            return this;
8576        }
8577
8578        /**
8579         * Get the custom size preset for the display of this notification out of the available
8580         * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8581         * {@link #SIZE_LARGE}.
8582         * <p>Some custom size presets are only applicable for custom display notifications created
8583         * using {@link #setDisplayIntent}. Check the documentation for the preset in question.
8584         * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}.
8585         */
8586        @Deprecated
8587        public int getCustomSizePreset() {
8588            return mCustomSizePreset;
8589        }
8590
8591        /**
8592         * Set the custom height in pixels for the display of this notification's content.
8593         * <p>This option is only available for custom display notifications created
8594         * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also
8595         * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and
8596         * {@link #getCustomContentHeight}.
8597         */
8598        @Deprecated
8599        public WearableExtender setCustomContentHeight(int height) {
8600            mCustomContentHeight = height;
8601            return this;
8602        }
8603
8604        /**
8605         * Get the custom height in pixels for the display of this notification's content.
8606         * <p>This option is only available for custom display notifications created
8607         * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and
8608         * {@link #setCustomContentHeight}.
8609         */
8610        @Deprecated
8611        public int getCustomContentHeight() {
8612            return mCustomContentHeight;
8613        }
8614
8615        /**
8616         * Set whether the scrolling position for the contents of this notification should start
8617         * at the bottom of the contents instead of the top when the contents are too long to
8618         * display within the screen.  Default is false (start scroll at the top).
8619         */
8620        public WearableExtender setStartScrollBottom(boolean startScrollBottom) {
8621            setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom);
8622            return this;
8623        }
8624
8625        /**
8626         * Get whether the scrolling position for the contents of this notification should start
8627         * at the bottom of the contents instead of the top when the contents are too long to
8628         * display within the screen. Default is false (start scroll at the top).
8629         */
8630        public boolean getStartScrollBottom() {
8631            return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0;
8632        }
8633
8634        /**
8635         * Set whether the content intent is available when the wearable device is not connected
8636         * to a companion device.  The user can still trigger this intent when the wearable device
8637         * is offline, but a visual hint will indicate that the content intent may not be available.
8638         * Defaults to true.
8639         */
8640        public WearableExtender setContentIntentAvailableOffline(
8641                boolean contentIntentAvailableOffline) {
8642            setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline);
8643            return this;
8644        }
8645
8646        /**
8647         * Get whether the content intent is available when the wearable device is not connected
8648         * to a companion device.  The user can still trigger this intent when the wearable device
8649         * is offline, but a visual hint will indicate that the content intent may not be available.
8650         * Defaults to true.
8651         */
8652        public boolean getContentIntentAvailableOffline() {
8653            return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0;
8654        }
8655
8656        /**
8657         * Set a hint that this notification's icon should not be displayed.
8658         * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise.
8659         * @return this object for method chaining
8660         */
8661        @Deprecated
8662        public WearableExtender setHintHideIcon(boolean hintHideIcon) {
8663            setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon);
8664            return this;
8665        }
8666
8667        /**
8668         * Get a hint that this notification's icon should not be displayed.
8669         * @return {@code true} if this icon should not be displayed, false otherwise.
8670         * The default value is {@code false} if this was never set.
8671         */
8672        @Deprecated
8673        public boolean getHintHideIcon() {
8674            return (mFlags & FLAG_HINT_HIDE_ICON) != 0;
8675        }
8676
8677        /**
8678         * Set a visual hint that only the background image of this notification should be
8679         * displayed, and other semantic content should be hidden. This hint is only applicable
8680         * to sub-pages added using {@link #addPage}.
8681         */
8682        @Deprecated
8683        public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) {
8684            setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly);
8685            return this;
8686        }
8687
8688        /**
8689         * Get a visual hint that only the background image of this notification should be
8690         * displayed, and other semantic content should be hidden. This hint is only applicable
8691         * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}.
8692         */
8693        @Deprecated
8694        public boolean getHintShowBackgroundOnly() {
8695            return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0;
8696        }
8697
8698        /**
8699         * Set a hint that this notification's background should not be clipped if possible,
8700         * and should instead be resized to fully display on the screen, retaining the aspect
8701         * ratio of the image. This can be useful for images like barcodes or qr codes.
8702         * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
8703         * @return this object for method chaining
8704         */
8705        @Deprecated
8706        public WearableExtender setHintAvoidBackgroundClipping(
8707                boolean hintAvoidBackgroundClipping) {
8708            setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping);
8709            return this;
8710        }
8711
8712        /**
8713         * Get a hint that this notification's background should not be clipped if possible,
8714         * and should instead be resized to fully display on the screen, retaining the aspect
8715         * ratio of the image. This can be useful for images like barcodes or qr codes.
8716         * @return {@code true} if it's ok if the background is clipped on the screen, false
8717         * otherwise. The default value is {@code false} if this was never set.
8718         */
8719        @Deprecated
8720        public boolean getHintAvoidBackgroundClipping() {
8721            return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0;
8722        }
8723
8724        /**
8725         * Set a hint that the screen should remain on for at least this duration when
8726         * this notification is displayed on the screen.
8727         * @param timeout The requested screen timeout in milliseconds. Can also be either
8728         *     {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8729         * @return this object for method chaining
8730         */
8731        @Deprecated
8732        public WearableExtender setHintScreenTimeout(int timeout) {
8733            mHintScreenTimeout = timeout;
8734            return this;
8735        }
8736
8737        /**
8738         * Get the duration, in milliseconds, that the screen should remain on for
8739         * when this notification is displayed.
8740         * @return the duration in milliseconds if > 0, or either one of the sentinel values
8741         *     {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8742         */
8743        @Deprecated
8744        public int getHintScreenTimeout() {
8745            return mHintScreenTimeout;
8746        }
8747
8748        /**
8749         * Set a hint that this notification's {@link BigPictureStyle} (if present) should be
8750         * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8751         * qr codes, as well as other simple black-and-white tickets.
8752         * @param hintAmbientBigPicture {@code true} to enable converstion and ambient.
8753         * @return this object for method chaining
8754         */
8755        public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) {
8756            setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture);
8757            return this;
8758        }
8759
8760        /**
8761         * Get a hint that this notification's {@link BigPictureStyle} (if present) should be
8762         * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8763         * qr codes, as well as other simple black-and-white tickets.
8764         * @return {@code true} if it should be displayed in ambient, false otherwise
8765         * otherwise. The default value is {@code false} if this was never set.
8766         */
8767        public boolean getHintAmbientBigPicture() {
8768            return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0;
8769        }
8770
8771        /**
8772         * Set a hint that this notification's content intent will launch an {@link Activity}
8773         * directly, telling the platform that it can generate the appropriate transitions.
8774         * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch
8775         * an activity and transitions should be generated, false otherwise.
8776         * @return this object for method chaining
8777         */
8778        public WearableExtender setHintContentIntentLaunchesActivity(
8779                boolean hintContentIntentLaunchesActivity) {
8780            setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity);
8781            return this;
8782        }
8783
8784        /**
8785         * Get a hint that this notification's content intent will launch an {@link Activity}
8786         * directly, telling the platform that it can generate the appropriate transitions
8787         * @return {@code true} if the content intent will launch an activity and transitions should
8788         * be generated, false otherwise. The default value is {@code false} if this was never set.
8789         */
8790        public boolean getHintContentIntentLaunchesActivity() {
8791            return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0;
8792        }
8793
8794        /**
8795         * Sets the dismissal id for this notification. If a notification is posted with a
8796         * dismissal id, then when that notification is canceled, notifications on other wearables
8797         * and the paired Android phone having that same dismissal id will also be canceled. See
8798         * <a href="{@docRoot}wear/notifications/index.html">Adding Wearable Features to
8799         * Notifications</a> for more information.
8800         * @param dismissalId the dismissal id of the notification.
8801         * @return this object for method chaining
8802         */
8803        public WearableExtender setDismissalId(String dismissalId) {
8804            mDismissalId = dismissalId;
8805            return this;
8806        }
8807
8808        /**
8809         * Returns the dismissal id of the notification.
8810         * @return the dismissal id of the notification or null if it has not been set.
8811         */
8812        public String getDismissalId() {
8813            return mDismissalId;
8814        }
8815
8816        /**
8817         * Sets a bridge tag for this notification. A bridge tag can be set for notifications
8818         * posted from a phone to provide finer-grained control on what notifications are bridged
8819         * to wearables. See <a href="{@docRoot}wear/notifications/index.html">Adding Wearable
8820         * Features to Notifications</a> for more information.
8821         * @param bridgeTag the bridge tag of the notification.
8822         * @return this object for method chaining
8823         */
8824        public WearableExtender setBridgeTag(String bridgeTag) {
8825            mBridgeTag = bridgeTag;
8826            return this;
8827        }
8828
8829        /**
8830         * Returns the bridge tag of the notification.
8831         * @return the bridge tag or null if not present.
8832         */
8833        public String getBridgeTag() {
8834            return mBridgeTag;
8835        }
8836
8837        private void setFlag(int mask, boolean value) {
8838            if (value) {
8839                mFlags |= mask;
8840            } else {
8841                mFlags &= ~mask;
8842            }
8843        }
8844    }
8845
8846    /**
8847     * <p>Helper class to add Android Auto extensions to notifications. To create a notification
8848     * with car extensions:
8849     *
8850     * <ol>
8851     *  <li>Create an {@link Notification.Builder}, setting any desired
8852     *  properties.
8853     *  <li>Create a {@link CarExtender}.
8854     *  <li>Set car-specific properties using the {@code add} and {@code set} methods of
8855     *  {@link CarExtender}.
8856     *  <li>Call {@link Notification.Builder#extend(Notification.Extender)}
8857     *  to apply the extensions to a notification.
8858     * </ol>
8859     *
8860     * <pre class="prettyprint">
8861     * Notification notification = new Notification.Builder(context)
8862     *         ...
8863     *         .extend(new CarExtender()
8864     *                 .set*(...))
8865     *         .build();
8866     * </pre>
8867     *
8868     * <p>Car extensions can be accessed on an existing notification by using the
8869     * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods
8870     * to access values.
8871     */
8872    public static final class CarExtender implements Extender {
8873        private static final String TAG = "CarExtender";
8874
8875        private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS";
8876        private static final String EXTRA_LARGE_ICON = "large_icon";
8877        private static final String EXTRA_CONVERSATION = "car_conversation";
8878        private static final String EXTRA_COLOR = "app_color";
8879
8880        private Bitmap mLargeIcon;
8881        private UnreadConversation mUnreadConversation;
8882        private int mColor = Notification.COLOR_DEFAULT;
8883
8884        /**
8885         * Create a {@link CarExtender} with default options.
8886         */
8887        public CarExtender() {
8888        }
8889
8890        /**
8891         * Create a {@link CarExtender} from the CarExtender options of an existing Notification.
8892         *
8893         * @param notif The notification from which to copy options.
8894         */
8895        public CarExtender(Notification notif) {
8896            Bundle carBundle = notif.extras == null ?
8897                    null : notif.extras.getBundle(EXTRA_CAR_EXTENDER);
8898            if (carBundle != null) {
8899                mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON);
8900                mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT);
8901
8902                Bundle b = carBundle.getBundle(EXTRA_CONVERSATION);
8903                mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b);
8904            }
8905        }
8906
8907        /**
8908         * Apply car extensions to a notification that is being built. This is typically called by
8909         * the {@link Notification.Builder#extend(Notification.Extender)}
8910         * method of {@link Notification.Builder}.
8911         */
8912        @Override
8913        public Notification.Builder extend(Notification.Builder builder) {
8914            Bundle carExtensions = new Bundle();
8915
8916            if (mLargeIcon != null) {
8917                carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon);
8918            }
8919            if (mColor != Notification.COLOR_DEFAULT) {
8920                carExtensions.putInt(EXTRA_COLOR, mColor);
8921            }
8922
8923            if (mUnreadConversation != null) {
8924                Bundle b = mUnreadConversation.getBundleForUnreadConversation();
8925                carExtensions.putBundle(EXTRA_CONVERSATION, b);
8926            }
8927
8928            builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions);
8929            return builder;
8930        }
8931
8932        /**
8933         * Sets the accent color to use when Android Auto presents the notification.
8934         *
8935         * Android Auto uses the color set with {@link Notification.Builder#setColor(int)}
8936         * to accent the displayed notification. However, not all colors are acceptable in an
8937         * automotive setting. This method can be used to override the color provided in the
8938         * notification in such a situation.
8939         */
8940        public CarExtender setColor(@ColorInt int color) {
8941            mColor = color;
8942            return this;
8943        }
8944
8945        /**
8946         * Gets the accent color.
8947         *
8948         * @see #setColor
8949         */
8950        @ColorInt
8951        public int getColor() {
8952            return mColor;
8953        }
8954
8955        /**
8956         * Sets the large icon of the car notification.
8957         *
8958         * If no large icon is set in the extender, Android Auto will display the icon
8959         * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)}
8960         *
8961         * @param largeIcon The large icon to use in the car notification.
8962         * @return This object for method chaining.
8963         */
8964        public CarExtender setLargeIcon(Bitmap largeIcon) {
8965            mLargeIcon = largeIcon;
8966            return this;
8967        }
8968
8969        /**
8970         * Gets the large icon used in this car notification, or null if no icon has been set.
8971         *
8972         * @return The large icon for the car notification.
8973         * @see CarExtender#setLargeIcon
8974         */
8975        public Bitmap getLargeIcon() {
8976            return mLargeIcon;
8977        }
8978
8979        /**
8980         * Sets the unread conversation in a message notification.
8981         *
8982         * @param unreadConversation The unread part of the conversation this notification conveys.
8983         * @return This object for method chaining.
8984         */
8985        public CarExtender setUnreadConversation(UnreadConversation unreadConversation) {
8986            mUnreadConversation = unreadConversation;
8987            return this;
8988        }
8989
8990        /**
8991         * Returns the unread conversation conveyed by this notification.
8992         * @see #setUnreadConversation(UnreadConversation)
8993         */
8994        public UnreadConversation getUnreadConversation() {
8995            return mUnreadConversation;
8996        }
8997
8998        /**
8999         * A class which holds the unread messages from a conversation.
9000         */
9001        public static class UnreadConversation {
9002            private static final String KEY_AUTHOR = "author";
9003            private static final String KEY_TEXT = "text";
9004            private static final String KEY_MESSAGES = "messages";
9005            private static final String KEY_REMOTE_INPUT = "remote_input";
9006            private static final String KEY_ON_REPLY = "on_reply";
9007            private static final String KEY_ON_READ = "on_read";
9008            private static final String KEY_PARTICIPANTS = "participants";
9009            private static final String KEY_TIMESTAMP = "timestamp";
9010
9011            private final String[] mMessages;
9012            private final RemoteInput mRemoteInput;
9013            private final PendingIntent mReplyPendingIntent;
9014            private final PendingIntent mReadPendingIntent;
9015            private final String[] mParticipants;
9016            private final long mLatestTimestamp;
9017
9018            UnreadConversation(String[] messages, RemoteInput remoteInput,
9019                    PendingIntent replyPendingIntent, PendingIntent readPendingIntent,
9020                    String[] participants, long latestTimestamp) {
9021                mMessages = messages;
9022                mRemoteInput = remoteInput;
9023                mReadPendingIntent = readPendingIntent;
9024                mReplyPendingIntent = replyPendingIntent;
9025                mParticipants = participants;
9026                mLatestTimestamp = latestTimestamp;
9027            }
9028
9029            /**
9030             * Gets the list of messages conveyed by this notification.
9031             */
9032            public String[] getMessages() {
9033                return mMessages;
9034            }
9035
9036            /**
9037             * Gets the remote input that will be used to convey the response to a message list, or
9038             * null if no such remote input exists.
9039             */
9040            public RemoteInput getRemoteInput() {
9041                return mRemoteInput;
9042            }
9043
9044            /**
9045             * Gets the pending intent that will be triggered when the user replies to this
9046             * notification.
9047             */
9048            public PendingIntent getReplyPendingIntent() {
9049                return mReplyPendingIntent;
9050            }
9051
9052            /**
9053             * Gets the pending intent that Android Auto will send after it reads aloud all messages
9054             * in this object's message list.
9055             */
9056            public PendingIntent getReadPendingIntent() {
9057                return mReadPendingIntent;
9058            }
9059
9060            /**
9061             * Gets the participants in the conversation.
9062             */
9063            public String[] getParticipants() {
9064                return mParticipants;
9065            }
9066
9067            /**
9068             * Gets the firs participant in the conversation.
9069             */
9070            public String getParticipant() {
9071                return mParticipants.length > 0 ? mParticipants[0] : null;
9072            }
9073
9074            /**
9075             * Gets the timestamp of the conversation.
9076             */
9077            public long getLatestTimestamp() {
9078                return mLatestTimestamp;
9079            }
9080
9081            Bundle getBundleForUnreadConversation() {
9082                Bundle b = new Bundle();
9083                String author = null;
9084                if (mParticipants != null && mParticipants.length > 1) {
9085                    author = mParticipants[0];
9086                }
9087                Parcelable[] messages = new Parcelable[mMessages.length];
9088                for (int i = 0; i < messages.length; i++) {
9089                    Bundle m = new Bundle();
9090                    m.putString(KEY_TEXT, mMessages[i]);
9091                    m.putString(KEY_AUTHOR, author);
9092                    messages[i] = m;
9093                }
9094                b.putParcelableArray(KEY_MESSAGES, messages);
9095                if (mRemoteInput != null) {
9096                    b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput);
9097                }
9098                b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent);
9099                b.putParcelable(KEY_ON_READ, mReadPendingIntent);
9100                b.putStringArray(KEY_PARTICIPANTS, mParticipants);
9101                b.putLong(KEY_TIMESTAMP, mLatestTimestamp);
9102                return b;
9103            }
9104
9105            static UnreadConversation getUnreadConversationFromBundle(Bundle b) {
9106                if (b == null) {
9107                    return null;
9108                }
9109                Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES);
9110                String[] messages = null;
9111                if (parcelableMessages != null) {
9112                    String[] tmp = new String[parcelableMessages.length];
9113                    boolean success = true;
9114                    for (int i = 0; i < tmp.length; i++) {
9115                        if (!(parcelableMessages[i] instanceof Bundle)) {
9116                            success = false;
9117                            break;
9118                        }
9119                        tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT);
9120                        if (tmp[i] == null) {
9121                            success = false;
9122                            break;
9123                        }
9124                    }
9125                    if (success) {
9126                        messages = tmp;
9127                    } else {
9128                        return null;
9129                    }
9130                }
9131
9132                PendingIntent onRead = b.getParcelable(KEY_ON_READ);
9133                PendingIntent onReply = b.getParcelable(KEY_ON_REPLY);
9134
9135                RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT);
9136
9137                String[] participants = b.getStringArray(KEY_PARTICIPANTS);
9138                if (participants == null || participants.length != 1) {
9139                    return null;
9140                }
9141
9142                return new UnreadConversation(messages,
9143                        remoteInput,
9144                        onReply,
9145                        onRead,
9146                        participants, b.getLong(KEY_TIMESTAMP));
9147            }
9148        };
9149
9150        /**
9151         * Builder class for {@link CarExtender.UnreadConversation} objects.
9152         */
9153        public static class Builder {
9154            private final List<String> mMessages = new ArrayList<String>();
9155            private final String mParticipant;
9156            private RemoteInput mRemoteInput;
9157            private PendingIntent mReadPendingIntent;
9158            private PendingIntent mReplyPendingIntent;
9159            private long mLatestTimestamp;
9160
9161            /**
9162             * Constructs a new builder for {@link CarExtender.UnreadConversation}.
9163             *
9164             * @param name The name of the other participant in the conversation.
9165             */
9166            public Builder(String name) {
9167                mParticipant = name;
9168            }
9169
9170            /**
9171             * Appends a new unread message to the list of messages for this conversation.
9172             *
9173             * The messages should be added from oldest to newest.
9174             *
9175             * @param message The text of the new unread message.
9176             * @return This object for method chaining.
9177             */
9178            public Builder addMessage(String message) {
9179                mMessages.add(message);
9180                return this;
9181            }
9182
9183            /**
9184             * Sets the pending intent and remote input which will convey the reply to this
9185             * notification.
9186             *
9187             * @param pendingIntent The pending intent which will be triggered on a reply.
9188             * @param remoteInput The remote input parcelable which will carry the reply.
9189             * @return This object for method chaining.
9190             *
9191             * @see CarExtender.UnreadConversation#getRemoteInput
9192             * @see CarExtender.UnreadConversation#getReplyPendingIntent
9193             */
9194            public Builder setReplyAction(
9195                    PendingIntent pendingIntent, RemoteInput remoteInput) {
9196                mRemoteInput = remoteInput;
9197                mReplyPendingIntent = pendingIntent;
9198
9199                return this;
9200            }
9201
9202            /**
9203             * Sets the pending intent that will be sent once the messages in this notification
9204             * are read.
9205             *
9206             * @param pendingIntent The pending intent to use.
9207             * @return This object for method chaining.
9208             */
9209            public Builder setReadPendingIntent(PendingIntent pendingIntent) {
9210                mReadPendingIntent = pendingIntent;
9211                return this;
9212            }
9213
9214            /**
9215             * Sets the timestamp of the most recent message in an unread conversation.
9216             *
9217             * If a messaging notification has been posted by your application and has not
9218             * yet been cancelled, posting a later notification with the same id and tag
9219             * but without a newer timestamp may result in Android Auto not displaying a
9220             * heads up notification for the later notification.
9221             *
9222             * @param timestamp The timestamp of the most recent message in the conversation.
9223             * @return This object for method chaining.
9224             */
9225            public Builder setLatestTimestamp(long timestamp) {
9226                mLatestTimestamp = timestamp;
9227                return this;
9228            }
9229
9230            /**
9231             * Builds a new unread conversation object.
9232             *
9233             * @return The new unread conversation object.
9234             */
9235            public UnreadConversation build() {
9236                String[] messages = mMessages.toArray(new String[mMessages.size()]);
9237                String[] participants = { mParticipant };
9238                return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent,
9239                        mReadPendingIntent, participants, mLatestTimestamp);
9240            }
9241        }
9242    }
9243
9244    /**
9245     * <p>Helper class to add Android TV extensions to notifications. To create a notification
9246     * with a TV extension:
9247     *
9248     * <ol>
9249     *  <li>Create an {@link Notification.Builder}, setting any desired properties.
9250     *  <li>Create a {@link TvExtender}.
9251     *  <li>Set TV-specific properties using the {@code set} methods of
9252     *  {@link TvExtender}.
9253     *  <li>Call {@link Notification.Builder#extend(Notification.Extender)}
9254     *  to apply the extension to a notification.
9255     * </ol>
9256     *
9257     * <pre class="prettyprint">
9258     * Notification notification = new Notification.Builder(context)
9259     *         ...
9260     *         .extend(new TvExtender()
9261     *                 .set*(...))
9262     *         .build();
9263     * </pre>
9264     *
9265     * <p>TV extensions can be accessed on an existing notification by using the
9266     * {@code TvExtender(Notification)} constructor, and then using the {@code get} methods
9267     * to access values.
9268     *
9269     * @hide
9270     */
9271    @SystemApi
9272    public static final class TvExtender implements Extender {
9273        private static final String TAG = "TvExtender";
9274
9275        private static final String EXTRA_TV_EXTENDER = "android.tv.EXTENSIONS";
9276        private static final String EXTRA_FLAGS = "flags";
9277        private static final String EXTRA_CONTENT_INTENT = "content_intent";
9278        private static final String EXTRA_DELETE_INTENT = "delete_intent";
9279        private static final String EXTRA_CHANNEL_ID = "channel_id";
9280        private static final String EXTRA_SUPPRESS_SHOW_OVER_APPS = "suppressShowOverApps";
9281
9282        // Flags bitwise-ored to mFlags
9283        private static final int FLAG_AVAILABLE_ON_TV = 0x1;
9284
9285        private int mFlags;
9286        private String mChannelId;
9287        private PendingIntent mContentIntent;
9288        private PendingIntent mDeleteIntent;
9289        private boolean mSuppressShowOverApps;
9290
9291        /**
9292         * Create a {@link TvExtender} with default options.
9293         */
9294        public TvExtender() {
9295            mFlags = FLAG_AVAILABLE_ON_TV;
9296        }
9297
9298        /**
9299         * Create a {@link TvExtender} from the TvExtender options of an existing Notification.
9300         *
9301         * @param notif The notification from which to copy options.
9302         */
9303        public TvExtender(Notification notif) {
9304            Bundle bundle = notif.extras == null ?
9305                null : notif.extras.getBundle(EXTRA_TV_EXTENDER);
9306            if (bundle != null) {
9307                mFlags = bundle.getInt(EXTRA_FLAGS);
9308                mChannelId = bundle.getString(EXTRA_CHANNEL_ID);
9309                mSuppressShowOverApps = bundle.getBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS);
9310                mContentIntent = bundle.getParcelable(EXTRA_CONTENT_INTENT);
9311                mDeleteIntent = bundle.getParcelable(EXTRA_DELETE_INTENT);
9312            }
9313        }
9314
9315        /**
9316         * Apply a TV extension to a notification that is being built. This is typically called by
9317         * the {@link Notification.Builder#extend(Notification.Extender)}
9318         * method of {@link Notification.Builder}.
9319         */
9320        @Override
9321        public Notification.Builder extend(Notification.Builder builder) {
9322            Bundle bundle = new Bundle();
9323
9324            bundle.putInt(EXTRA_FLAGS, mFlags);
9325            bundle.putString(EXTRA_CHANNEL_ID, mChannelId);
9326            bundle.putBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS, mSuppressShowOverApps);
9327            if (mContentIntent != null) {
9328                bundle.putParcelable(EXTRA_CONTENT_INTENT, mContentIntent);
9329            }
9330
9331            if (mDeleteIntent != null) {
9332                bundle.putParcelable(EXTRA_DELETE_INTENT, mDeleteIntent);
9333            }
9334
9335            builder.getExtras().putBundle(EXTRA_TV_EXTENDER, bundle);
9336            return builder;
9337        }
9338
9339        /**
9340         * Returns true if this notification should be shown on TV. This method return true
9341         * if the notification was extended with a TvExtender.
9342         */
9343        public boolean isAvailableOnTv() {
9344            return (mFlags & FLAG_AVAILABLE_ON_TV) != 0;
9345        }
9346
9347        /**
9348         * Specifies the channel the notification should be delivered on when shown on TV.
9349         * It can be different from the channel that the notification is delivered to when
9350         * posting on a non-TV device.
9351         */
9352        public TvExtender setChannel(String channelId) {
9353            mChannelId = channelId;
9354            return this;
9355        }
9356
9357        /**
9358         * Specifies the channel the notification should be delivered on when shown on TV.
9359         * It can be different from the channel that the notification is delivered to when
9360         * posting on a non-TV device.
9361         */
9362        public TvExtender setChannelId(String channelId) {
9363            mChannelId = channelId;
9364            return this;
9365        }
9366
9367        /** @removed */
9368        @Deprecated
9369        public String getChannel() {
9370            return mChannelId;
9371        }
9372
9373        /**
9374         * Returns the id of the channel this notification posts to on TV.
9375         */
9376        public String getChannelId() {
9377            return mChannelId;
9378        }
9379
9380        /**
9381         * Supplies a {@link PendingIntent} to be sent when the notification is selected on TV.
9382         * If provided, it is used instead of the content intent specified
9383         * at the level of Notification.
9384         */
9385        public TvExtender setContentIntent(PendingIntent intent) {
9386            mContentIntent = intent;
9387            return this;
9388        }
9389
9390        /**
9391         * Returns the TV-specific content intent.  If this method returns null, the
9392         * main content intent on the notification should be used.
9393         *
9394         * @see {@link Notification#contentIntent}
9395         */
9396        public PendingIntent getContentIntent() {
9397            return mContentIntent;
9398        }
9399
9400        /**
9401         * Supplies a {@link PendingIntent} to send when the notification is cleared explicitly
9402         * by the user on TV.  If provided, it is used instead of the delete intent specified
9403         * at the level of Notification.
9404         */
9405        public TvExtender setDeleteIntent(PendingIntent intent) {
9406            mDeleteIntent = intent;
9407            return this;
9408        }
9409
9410        /**
9411         * Returns the TV-specific delete intent.  If this method returns null, the
9412         * main delete intent on the notification should be used.
9413         *
9414         * @see {@link Notification#deleteIntent}
9415         */
9416        public PendingIntent getDeleteIntent() {
9417            return mDeleteIntent;
9418        }
9419
9420        /**
9421         * Specifies whether this notification should suppress showing a message over top of apps
9422         * outside of the launcher.
9423         */
9424        public TvExtender setSuppressShowOverApps(boolean suppress) {
9425            mSuppressShowOverApps = suppress;
9426            return this;
9427        }
9428
9429        /**
9430         * Returns true if this notification should not show messages over top of apps
9431         * outside of the launcher.
9432         */
9433        public boolean getSuppressShowOverApps() {
9434            return mSuppressShowOverApps;
9435        }
9436    }
9437
9438    /**
9439     * Get an array of Notification objects from a parcelable array bundle field.
9440     * Update the bundle to have a typed array so fetches in the future don't need
9441     * to do an array copy.
9442     */
9443    private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) {
9444        Parcelable[] array = bundle.getParcelableArray(key);
9445        if (array instanceof Notification[] || array == null) {
9446            return (Notification[]) array;
9447        }
9448        Notification[] typedArray = Arrays.copyOf(array, array.length,
9449                Notification[].class);
9450        bundle.putParcelableArray(key, typedArray);
9451        return typedArray;
9452    }
9453
9454    private static class BuilderRemoteViews extends RemoteViews {
9455        public BuilderRemoteViews(Parcel parcel) {
9456            super(parcel);
9457        }
9458
9459        public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) {
9460            super(appInfo, layoutId);
9461        }
9462
9463        @Override
9464        public BuilderRemoteViews clone() {
9465            Parcel p = Parcel.obtain();
9466            writeToParcel(p, 0);
9467            p.setDataPosition(0);
9468            BuilderRemoteViews brv = new BuilderRemoteViews(p);
9469            p.recycle();
9470            return brv;
9471        }
9472    }
9473
9474    private static class StandardTemplateParams {
9475        boolean hasProgress = true;
9476        boolean ambient = false;
9477        CharSequence title;
9478        CharSequence text;
9479        CharSequence headerTextSecondary;
9480        boolean hideLargeIcon;
9481        public boolean alwaysShowReply;
9482
9483        final StandardTemplateParams reset() {
9484            hasProgress = true;
9485            ambient = false;
9486            title = null;
9487            text = null;
9488            headerTextSecondary = null;
9489            return this;
9490        }
9491
9492        final StandardTemplateParams hasProgress(boolean hasProgress) {
9493            this.hasProgress = hasProgress;
9494            return this;
9495        }
9496
9497        final StandardTemplateParams title(CharSequence title) {
9498            this.title = title;
9499            return this;
9500        }
9501
9502        final StandardTemplateParams text(CharSequence text) {
9503            this.text = text;
9504            return this;
9505        }
9506
9507        final StandardTemplateParams headerTextSecondary(CharSequence text) {
9508            this.headerTextSecondary = text;
9509            return this;
9510        }
9511
9512        final StandardTemplateParams alwaysShowReply(boolean alwaysShowReply) {
9513            this.alwaysShowReply = alwaysShowReply;
9514            return this;
9515        }
9516
9517        final StandardTemplateParams hideLargeIcon(boolean hideLargeIcon) {
9518            this.hideLargeIcon = hideLargeIcon;
9519            return this;
9520        }
9521
9522        final StandardTemplateParams ambient(boolean ambient) {
9523            Preconditions.checkState(title == null && text == null, "must set ambient before text");
9524            this.ambient = ambient;
9525            return this;
9526        }
9527
9528        final StandardTemplateParams fillTextsFrom(Builder b) {
9529            Bundle extras = b.mN.extras;
9530            this.title = b.processLegacyText(extras.getCharSequence(EXTRA_TITLE), ambient);
9531
9532            // Big text notifications should contain their content when viewed in ambient mode.
9533            CharSequence text = extras.getCharSequence(EXTRA_BIG_TEXT);
9534            if (!ambient || TextUtils.isEmpty(text)) {
9535                text = extras.getCharSequence(EXTRA_TEXT);
9536            }
9537            this.text = b.processLegacyText(text, ambient);
9538            return this;
9539        }
9540    }
9541}
9542