Notification.java revision aa9db1f34fe8b4a2d143c1379ec6c0c304bbd40b
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[i].getChoices();
2635                    CharSequence[] secondCs = secondRs[i].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        private int mBackgroundColorHint = COLOR_INVALID;
3122        /**
3123         * A temporary location where actions are stored. If != null the view originally has action
3124         * but doesn't have any for this inflation.
3125         */
3126        private ArrayList<Action> mOriginalActions;
3127        private boolean mRebuildStyledRemoteViews;
3128
3129        private boolean mTintActionButtons;
3130        private boolean mInNightMode;
3131
3132        /**
3133         * Constructs a new Builder with the defaults:
3134         *
3135         * @param context
3136         *            A {@link Context} that will be used by the Builder to construct the
3137         *            RemoteViews. The Context will not be held past the lifetime of this Builder
3138         *            object.
3139         * @param channelId
3140         *            The constructed Notification will be posted on this
3141         *            {@link NotificationChannel}. To use a NotificationChannel, it must first be
3142         *            created using {@link NotificationManager#createNotificationChannel}.
3143         */
3144        public Builder(Context context, String channelId) {
3145            this(context, (Notification) null);
3146            mN.mChannelId = channelId;
3147        }
3148
3149        /**
3150         * @deprecated use {@link Notification.Builder#Notification.Builder(Context, String)}
3151         * instead. All posted Notifications must specify a NotificationChannel Id.
3152         */
3153        @Deprecated
3154        public Builder(Context context) {
3155            this(context, (Notification) null);
3156        }
3157
3158        /**
3159         * @hide
3160         */
3161        public Builder(Context context, Notification toAdopt) {
3162            mContext = context;
3163            Resources res = mContext.getResources();
3164            mTintActionButtons = res.getBoolean(R.bool.config_tintNotificationActionButtons);
3165
3166            if (res.getBoolean(R.bool.config_enableNightMode)) {
3167                Configuration currentConfig = res.getConfiguration();
3168                mInNightMode = (currentConfig.uiMode & Configuration.UI_MODE_NIGHT_MASK)
3169                        == Configuration.UI_MODE_NIGHT_YES;
3170            }
3171
3172            if (toAdopt == null) {
3173                mN = new Notification();
3174                if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
3175                    mN.extras.putBoolean(EXTRA_SHOW_WHEN, true);
3176                }
3177                mN.priority = PRIORITY_DEFAULT;
3178                mN.visibility = VISIBILITY_PRIVATE;
3179            } else {
3180                mN = toAdopt;
3181                if (mN.actions != null) {
3182                    Collections.addAll(mActions, mN.actions);
3183                }
3184
3185                if (mN.extras.containsKey(EXTRA_PEOPLE_LIST)) {
3186                    ArrayList<Person> people = mN.extras.getParcelableArrayList(EXTRA_PEOPLE_LIST);
3187                    mPersonList.addAll(people);
3188                }
3189
3190                if (mN.getSmallIcon() == null && mN.icon != 0) {
3191                    setSmallIcon(mN.icon);
3192                }
3193
3194                if (mN.getLargeIcon() == null && mN.largeIcon != null) {
3195                    setLargeIcon(mN.largeIcon);
3196                }
3197
3198                String templateClass = mN.extras.getString(EXTRA_TEMPLATE);
3199                if (!TextUtils.isEmpty(templateClass)) {
3200                    final Class<? extends Style> styleClass
3201                            = getNotificationStyleClass(templateClass);
3202                    if (styleClass == null) {
3203                        Log.d(TAG, "Unknown style class: " + templateClass);
3204                    } else {
3205                        try {
3206                            final Constructor<? extends Style> ctor =
3207                                    styleClass.getDeclaredConstructor();
3208                            ctor.setAccessible(true);
3209                            final Style style = ctor.newInstance();
3210                            style.restoreFromExtras(mN.extras);
3211
3212                            if (style != null) {
3213                                setStyle(style);
3214                            }
3215                        } catch (Throwable t) {
3216                            Log.e(TAG, "Could not create Style", t);
3217                        }
3218                    }
3219                }
3220
3221            }
3222        }
3223
3224        private NotificationColorUtil getColorUtil() {
3225            if (mColorUtil == null) {
3226                mColorUtil = NotificationColorUtil.getInstance(mContext);
3227            }
3228            return mColorUtil;
3229        }
3230
3231        /**
3232         * If this notification is duplicative of a Launcher shortcut, sets the
3233         * {@link ShortcutInfo#getId() id} of the shortcut, in case the Launcher wants to hide
3234         * the shortcut.
3235         *
3236         * This field will be ignored by Launchers that don't support badging, don't show
3237         * notification content, or don't show {@link android.content.pm.ShortcutManager shortcuts}.
3238         *
3239         * @param shortcutId the {@link ShortcutInfo#getId() id} of the shortcut this notification
3240         *                   supersedes
3241         */
3242        public Builder setShortcutId(String shortcutId) {
3243            mN.mShortcutId = shortcutId;
3244            return this;
3245        }
3246
3247        /**
3248         * Sets which icon to display as a badge for this notification.
3249         *
3250         * Must be one of {@link #BADGE_ICON_NONE}, {@link #BADGE_ICON_SMALL},
3251         * {@link #BADGE_ICON_LARGE}.
3252         *
3253         * Note: This value might be ignored, for launchers that don't support badge icons.
3254         */
3255        public Builder setBadgeIconType(int icon) {
3256            mN.mBadgeIcon = icon;
3257            return this;
3258        }
3259
3260        /**
3261         * Sets the group alert behavior for this notification. Use this method to mute this
3262         * notification if alerts for this notification's group should be handled by a different
3263         * notification. This is only applicable for notifications that belong to a
3264         * {@link #setGroup(String) group}. This must be called on all notifications you want to
3265         * mute. For example, if you want only the summary of your group to make noise, all
3266         * children in the group should have the group alert behavior {@link #GROUP_ALERT_SUMMARY}.
3267         *
3268         * <p> The default value is {@link #GROUP_ALERT_ALL}.</p>
3269         */
3270        public Builder setGroupAlertBehavior(@GroupAlertBehavior int groupAlertBehavior) {
3271            mN.mGroupAlertBehavior = groupAlertBehavior;
3272            return this;
3273        }
3274
3275        /** @removed */
3276        @Deprecated
3277        public Builder setChannel(String channelId) {
3278            mN.mChannelId = channelId;
3279            return this;
3280        }
3281
3282        /**
3283         * Specifies the channel the notification should be delivered on.
3284         */
3285        public Builder setChannelId(String channelId) {
3286            mN.mChannelId = channelId;
3287            return this;
3288        }
3289
3290        /** @removed */
3291        @Deprecated
3292        public Builder setTimeout(long durationMs) {
3293            mN.mTimeout = durationMs;
3294            return this;
3295        }
3296
3297        /**
3298         * Specifies a duration in milliseconds after which this notification should be canceled,
3299         * if it is not already canceled.
3300         */
3301        public Builder setTimeoutAfter(long durationMs) {
3302            mN.mTimeout = durationMs;
3303            return this;
3304        }
3305
3306        /**
3307         * Add a timestamp pertaining to the notification (usually the time the event occurred).
3308         *
3309         * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not
3310         * shown anymore by default and must be opted into by using
3311         * {@link android.app.Notification.Builder#setShowWhen(boolean)}
3312         *
3313         * @see Notification#when
3314         */
3315        public Builder setWhen(long when) {
3316            mN.when = when;
3317            return this;
3318        }
3319
3320        /**
3321         * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown
3322         * in the content view.
3323         * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to
3324         * {@code false}. For earlier apps, the default is {@code true}.
3325         */
3326        public Builder setShowWhen(boolean show) {
3327            mN.extras.putBoolean(EXTRA_SHOW_WHEN, show);
3328            return this;
3329        }
3330
3331        /**
3332         * Show the {@link Notification#when} field as a stopwatch.
3333         *
3334         * Instead of presenting <code>when</code> as a timestamp, the notification will show an
3335         * automatically updating display of the minutes and seconds since <code>when</code>.
3336         *
3337         * Useful when showing an elapsed time (like an ongoing phone call).
3338         *
3339         * The counter can also be set to count down to <code>when</code> when using
3340         * {@link #setChronometerCountDown(boolean)}.
3341         *
3342         * @see android.widget.Chronometer
3343         * @see Notification#when
3344         * @see #setChronometerCountDown(boolean)
3345         */
3346        public Builder setUsesChronometer(boolean b) {
3347            mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b);
3348            return this;
3349        }
3350
3351        /**
3352         * Sets the Chronometer to count down instead of counting up.
3353         *
3354         * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true.
3355         * If it isn't set the chronometer will count up.
3356         *
3357         * @see #setUsesChronometer(boolean)
3358         */
3359        public Builder setChronometerCountDown(boolean countDown) {
3360            mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, countDown);
3361            return this;
3362        }
3363
3364        /**
3365         * Set the small icon resource, which will be used to represent the notification in the
3366         * status bar.
3367         *
3368
3369         * The platform template for the expanded view will draw this icon in the left, unless a
3370         * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
3371         * icon will be moved to the right-hand side.
3372         *
3373
3374         * @param icon
3375         *            A resource ID in the application's package of the drawable to use.
3376         * @see Notification#icon
3377         */
3378        public Builder setSmallIcon(@DrawableRes int icon) {
3379            return setSmallIcon(icon != 0
3380                    ? Icon.createWithResource(mContext, icon)
3381                    : null);
3382        }
3383
3384        /**
3385         * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
3386         * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
3387         * LevelListDrawable}.
3388         *
3389         * @param icon A resource ID in the application's package of the drawable to use.
3390         * @param level The level to use for the icon.
3391         *
3392         * @see Notification#icon
3393         * @see Notification#iconLevel
3394         */
3395        public Builder setSmallIcon(@DrawableRes int icon, int level) {
3396            mN.iconLevel = level;
3397            return setSmallIcon(icon);
3398        }
3399
3400        /**
3401         * Set the small icon, which will be used to represent the notification in the
3402         * status bar and content view (unless overriden there by a
3403         * {@link #setLargeIcon(Bitmap) large icon}).
3404         *
3405         * @param icon An Icon object to use.
3406         * @see Notification#icon
3407         */
3408        public Builder setSmallIcon(Icon icon) {
3409            mN.setSmallIcon(icon);
3410            if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
3411                mN.icon = icon.getResId();
3412            }
3413            return this;
3414        }
3415
3416        /**
3417         * Set the first line of text in the platform notification template.
3418         */
3419        public Builder setContentTitle(CharSequence title) {
3420            mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title));
3421            return this;
3422        }
3423
3424        /**
3425         * Set the second line of text in the platform notification template.
3426         */
3427        public Builder setContentText(CharSequence text) {
3428            mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text));
3429            return this;
3430        }
3431
3432        /**
3433         * This provides some additional information that is displayed in the notification. No
3434         * guarantees are given where exactly it is displayed.
3435         *
3436         * <p>This information should only be provided if it provides an essential
3437         * benefit to the understanding of the notification. The more text you provide the
3438         * less readable it becomes. For example, an email client should only provide the account
3439         * name here if more than one email account has been added.</p>
3440         *
3441         * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the
3442         * notification header area.
3443         *
3444         * On Android versions before {@link android.os.Build.VERSION_CODES#N}
3445         * this will be shown in the third line of text in the platform notification template.
3446         * You should not be using {@link #setProgress(int, int, boolean)} at the
3447         * same time on those versions; they occupy the same place.
3448         * </p>
3449         */
3450        public Builder setSubText(CharSequence text) {
3451            mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text));
3452            return this;
3453        }
3454
3455        /**
3456         * Provides text that will appear as a link to your application's settings.
3457         *
3458         * <p>This text does not appear within notification {@link Style templates} but may
3459         * appear when the user uses an affordance to learn more about the notification.
3460         * Additionally, this text will not appear unless you provide a valid link target by
3461         * handling {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}.
3462         *
3463         * <p>This text is meant to be concise description about what the user can customize
3464         * when they click on this link. The recommended maximum length is 40 characters.
3465         * @param text
3466         * @return
3467         */
3468        public Builder setSettingsText(CharSequence text) {
3469            mN.mSettingsText = safeCharSequence(text);
3470            return this;
3471        }
3472
3473        /**
3474         * Set the remote input history.
3475         *
3476         * This should be set to the most recent inputs that have been sent
3477         * through a {@link RemoteInput} of this Notification and cleared once the it is no
3478         * longer relevant (e.g. for chat notifications once the other party has responded).
3479         *
3480         * The most recent input must be stored at the 0 index, the second most recent at the
3481         * 1 index, etc. Note that the system will limit both how far back the inputs will be shown
3482         * and how much of each individual input is shown.
3483         *
3484         * <p>Note: The reply text will only be shown on notifications that have least one action
3485         * with a {@code RemoteInput}.</p>
3486         */
3487        public Builder setRemoteInputHistory(CharSequence[] text) {
3488            if (text == null) {
3489                mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null);
3490            } else {
3491                final int N = Math.min(MAX_REPLY_HISTORY, text.length);
3492                CharSequence[] safe = new CharSequence[N];
3493                for (int i = 0; i < N; i++) {
3494                    safe[i] = safeCharSequence(text[i]);
3495                }
3496                mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe);
3497            }
3498            return this;
3499        }
3500
3501        /**
3502         * Sets the number of items this notification represents. May be displayed as a badge count
3503         * for Launchers that support badging.
3504         */
3505        public Builder setNumber(int number) {
3506            mN.number = number;
3507            return this;
3508        }
3509
3510        /**
3511         * A small piece of additional information pertaining to this notification.
3512         *
3513         * The platform template will draw this on the last line of the notification, at the far
3514         * right (to the right of a smallIcon if it has been placed there).
3515         *
3516         * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header.
3517         * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this
3518         * field will still show up, but the subtext will take precedence.
3519         */
3520        @Deprecated
3521        public Builder setContentInfo(CharSequence info) {
3522            mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info));
3523            return this;
3524        }
3525
3526        /**
3527         * Set the progress this notification represents.
3528         *
3529         * The platform template will represent this using a {@link ProgressBar}.
3530         */
3531        public Builder setProgress(int max, int progress, boolean indeterminate) {
3532            mN.extras.putInt(EXTRA_PROGRESS, progress);
3533            mN.extras.putInt(EXTRA_PROGRESS_MAX, max);
3534            mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate);
3535            return this;
3536        }
3537
3538        /**
3539         * Supply a custom RemoteViews to use instead of the platform template.
3540         *
3541         * Use {@link #setCustomContentView(RemoteViews)} instead.
3542         */
3543        @Deprecated
3544        public Builder setContent(RemoteViews views) {
3545            return setCustomContentView(views);
3546        }
3547
3548        /**
3549         * Supply custom RemoteViews to use instead of the platform template.
3550         *
3551         * This will override the layout that would otherwise be constructed by this Builder
3552         * object.
3553         */
3554        public Builder setCustomContentView(RemoteViews contentView) {
3555            mN.contentView = contentView;
3556            return this;
3557        }
3558
3559        /**
3560         * Supply custom RemoteViews to use instead of the platform template in the expanded form.
3561         *
3562         * This will override the expanded layout that would otherwise be constructed by this
3563         * Builder object.
3564         */
3565        public Builder setCustomBigContentView(RemoteViews contentView) {
3566            mN.bigContentView = contentView;
3567            return this;
3568        }
3569
3570        /**
3571         * Supply custom RemoteViews to use instead of the platform template in the heads up dialog.
3572         *
3573         * This will override the heads-up layout that would otherwise be constructed by this
3574         * Builder object.
3575         */
3576        public Builder setCustomHeadsUpContentView(RemoteViews contentView) {
3577            mN.headsUpContentView = contentView;
3578            return this;
3579        }
3580
3581        /**
3582         * Supply a {@link PendingIntent} to be sent when the notification is clicked.
3583         *
3584         * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
3585         * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
3586         * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
3587         * to assign PendingIntents to individual views in that custom layout (i.e., to create
3588         * clickable buttons inside the notification view).
3589         *
3590         * @see Notification#contentIntent Notification.contentIntent
3591         */
3592        public Builder setContentIntent(PendingIntent intent) {
3593            mN.contentIntent = intent;
3594            return this;
3595        }
3596
3597        /**
3598         * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
3599         *
3600         * @see Notification#deleteIntent
3601         */
3602        public Builder setDeleteIntent(PendingIntent intent) {
3603            mN.deleteIntent = intent;
3604            return this;
3605        }
3606
3607        /**
3608         * An intent to launch instead of posting the notification to the status bar.
3609         * Only for use with extremely high-priority notifications demanding the user's
3610         * <strong>immediate</strong> attention, such as an incoming phone call or
3611         * alarm clock that the user has explicitly set to a particular time.
3612         * If this facility is used for something else, please give the user an option
3613         * to turn it off and use a normal notification, as this can be extremely
3614         * disruptive.
3615         *
3616         * <p>
3617         * The system UI may choose to display a heads-up notification, instead of
3618         * launching this intent, while the user is using the device.
3619         * </p>
3620         *
3621         * @param intent The pending intent to launch.
3622         * @param highPriority Passing true will cause this notification to be sent
3623         *          even if other notifications are suppressed.
3624         *
3625         * @see Notification#fullScreenIntent
3626         */
3627        public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
3628            mN.fullScreenIntent = intent;
3629            setFlag(FLAG_HIGH_PRIORITY, highPriority);
3630            return this;
3631        }
3632
3633        /**
3634         * Set the "ticker" text which is sent to accessibility services.
3635         *
3636         * @see Notification#tickerText
3637         */
3638        public Builder setTicker(CharSequence tickerText) {
3639            mN.tickerText = safeCharSequence(tickerText);
3640            return this;
3641        }
3642
3643        /**
3644         * Obsolete version of {@link #setTicker(CharSequence)}.
3645         *
3646         */
3647        @Deprecated
3648        public Builder setTicker(CharSequence tickerText, RemoteViews views) {
3649            setTicker(tickerText);
3650            // views is ignored
3651            return this;
3652        }
3653
3654        /**
3655         * Add a large icon to the notification content view.
3656         *
3657         * In the platform template, this image will be shown on the left of the notification view
3658         * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3659         * badge atop the large icon).
3660         */
3661        public Builder setLargeIcon(Bitmap b) {
3662            return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
3663        }
3664
3665        /**
3666         * Add a large icon to the notification content view.
3667         *
3668         * In the platform template, this image will be shown on the left of the notification view
3669         * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3670         * badge atop the large icon).
3671         */
3672        public Builder setLargeIcon(Icon icon) {
3673            mN.mLargeIcon = icon;
3674            mN.extras.putParcelable(EXTRA_LARGE_ICON, icon);
3675            return this;
3676        }
3677
3678        /**
3679         * Set the sound to play.
3680         *
3681         * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes}
3682         * for notifications.
3683         *
3684         * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
3685         */
3686        @Deprecated
3687        public Builder setSound(Uri sound) {
3688            mN.sound = sound;
3689            mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
3690            return this;
3691        }
3692
3693        /**
3694         * Set the sound to play, along with a specific stream on which to play it.
3695         *
3696         * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
3697         *
3698         * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)}.
3699         */
3700        @Deprecated
3701        public Builder setSound(Uri sound, int streamType) {
3702            PlayerBase.deprecateStreamTypeForPlayback(streamType, "Notification", "setSound()");
3703            mN.sound = sound;
3704            mN.audioStreamType = streamType;
3705            return this;
3706        }
3707
3708        /**
3709         * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to
3710         * use during playback.
3711         *
3712         * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
3713         * @see Notification#sound
3714         */
3715        @Deprecated
3716        public Builder setSound(Uri sound, AudioAttributes audioAttributes) {
3717            mN.sound = sound;
3718            mN.audioAttributes = audioAttributes;
3719            return this;
3720        }
3721
3722        /**
3723         * Set the vibration pattern to use.
3724         *
3725         * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
3726         * <code>pattern</code> parameter.
3727         *
3728         * <p>
3729         * A notification that vibrates is more likely to be presented as a heads-up notification.
3730         * </p>
3731         *
3732         * @deprecated use {@link NotificationChannel#setVibrationPattern(long[])} instead.
3733         * @see Notification#vibrate
3734         */
3735        @Deprecated
3736        public Builder setVibrate(long[] pattern) {
3737            mN.vibrate = pattern;
3738            return this;
3739        }
3740
3741        /**
3742         * Set the desired color for the indicator LED on the device, as well as the
3743         * blink duty cycle (specified in milliseconds).
3744         *
3745
3746         * Not all devices will honor all (or even any) of these values.
3747         *
3748         * @deprecated use {@link NotificationChannel#enableLights(boolean)} instead.
3749         * @see Notification#ledARGB
3750         * @see Notification#ledOnMS
3751         * @see Notification#ledOffMS
3752         */
3753        @Deprecated
3754        public Builder setLights(@ColorInt int argb, int onMs, int offMs) {
3755            mN.ledARGB = argb;
3756            mN.ledOnMS = onMs;
3757            mN.ledOffMS = offMs;
3758            if (onMs != 0 || offMs != 0) {
3759                mN.flags |= FLAG_SHOW_LIGHTS;
3760            }
3761            return this;
3762        }
3763
3764        /**
3765         * Set whether this is an "ongoing" notification.
3766         *
3767
3768         * Ongoing notifications cannot be dismissed by the user, so your application or service
3769         * must take care of canceling them.
3770         *
3771
3772         * They are typically used to indicate a background task that the user is actively engaged
3773         * with (e.g., playing music) or is pending in some way and therefore occupying the device
3774         * (e.g., a file download, sync operation, active network connection).
3775         *
3776
3777         * @see Notification#FLAG_ONGOING_EVENT
3778         * @see Service#setForeground(boolean)
3779         */
3780        public Builder setOngoing(boolean ongoing) {
3781            setFlag(FLAG_ONGOING_EVENT, ongoing);
3782            return this;
3783        }
3784
3785        /**
3786         * Set whether this notification should be colorized. When set, the color set with
3787         * {@link #setColor(int)} will be used as the background color of this notification.
3788         * <p>
3789         * This should only be used for high priority ongoing tasks like navigation, an ongoing
3790         * call, or other similarly high-priority events for the user.
3791         * <p>
3792         * For most styles, the coloring will only be applied if the notification is for a
3793         * foreground service notification.
3794         * However, for {@link MediaStyle} and {@link DecoratedMediaCustomViewStyle} notifications
3795         * that have a media session attached there is no such requirement.
3796         *
3797         * @see Builder#setColor(int)
3798         * @see MediaStyle#setMediaSession(MediaSession.Token)
3799         */
3800        public Builder setColorized(boolean colorize) {
3801            mN.extras.putBoolean(EXTRA_COLORIZED, colorize);
3802            return this;
3803        }
3804
3805        /**
3806         * Set this flag if you would only like the sound, vibrate
3807         * and ticker to be played if the notification is not already showing.
3808         *
3809         * @see Notification#FLAG_ONLY_ALERT_ONCE
3810         */
3811        public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
3812            setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
3813            return this;
3814        }
3815
3816        /**
3817         * Make this notification automatically dismissed when the user touches it.
3818         *
3819         * @see Notification#FLAG_AUTO_CANCEL
3820         */
3821        public Builder setAutoCancel(boolean autoCancel) {
3822            setFlag(FLAG_AUTO_CANCEL, autoCancel);
3823            return this;
3824        }
3825
3826        /**
3827         * Set whether or not this notification should not bridge to other devices.
3828         *
3829         * <p>Some notifications can be bridged to other devices for remote display.
3830         * This hint can be set to recommend this notification not be bridged.
3831         */
3832        public Builder setLocalOnly(boolean localOnly) {
3833            setFlag(FLAG_LOCAL_ONLY, localOnly);
3834            return this;
3835        }
3836
3837        /**
3838         * Set which notification properties will be inherited from system defaults.
3839         * <p>
3840         * The value should be one or more of the following fields combined with
3841         * bitwise-or:
3842         * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
3843         * <p>
3844         * For all default values, use {@link #DEFAULT_ALL}.
3845         *
3846         * @deprecated use {@link NotificationChannel#enableVibration(boolean)} and
3847         * {@link NotificationChannel#enableLights(boolean)} and
3848         * {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
3849         */
3850        @Deprecated
3851        public Builder setDefaults(int defaults) {
3852            mN.defaults = defaults;
3853            return this;
3854        }
3855
3856        /**
3857         * Set the priority of this notification.
3858         *
3859         * @see Notification#priority
3860         * @deprecated use {@link NotificationChannel#setImportance(int)} instead.
3861         */
3862        @Deprecated
3863        public Builder setPriority(@Priority int pri) {
3864            mN.priority = pri;
3865            return this;
3866        }
3867
3868        /**
3869         * Set the notification category.
3870         *
3871         * @see Notification#category
3872         */
3873        public Builder setCategory(String category) {
3874            mN.category = category;
3875            return this;
3876        }
3877
3878        /**
3879         * Add a person that is relevant to this notification.
3880         *
3881         * <P>
3882         * Depending on user preferences, this annotation may allow the notification to pass
3883         * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3884         * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3885         * appear more prominently in the user interface.
3886         * </P>
3887         *
3888         * <P>
3889         * The person should be specified by the {@code String} representation of a
3890         * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
3891         * </P>
3892         *
3893         * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
3894         * URIs.  The path part of these URIs must exist in the contacts database, in the
3895         * appropriate column, or the reference will be discarded as invalid. Telephone schema
3896         * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
3897         * It is also possible to provide a URI with the schema {@code name:} in order to uniquely
3898         * identify a person without an entry in the contacts database.
3899         * </P>
3900         *
3901         * @param uri A URI for the person.
3902         * @see Notification#EXTRA_PEOPLE
3903         * @deprecated use {@link #addPerson(Person)}
3904         */
3905        public Builder addPerson(String uri) {
3906            addPerson(new Person().setUri(uri));
3907            return this;
3908        }
3909
3910        /**
3911         * Add a person that is relevant to this notification.
3912         *
3913         * <P>
3914         * Depending on user preferences, this annotation may allow the notification to pass
3915         * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3916         * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3917         * appear more prominently in the user interface.
3918         * </P>
3919         *
3920         * <P>
3921         * A person should usually contain a uri in order to benefit from the ranking boost.
3922         * However, even if no uri is provided, it's beneficial to provide other people in the
3923         * notification, such that listeners and voice only devices can announce and handle them
3924         * properly.
3925         * </P>
3926         *
3927         * @param person the person to add.
3928         * @see Notification#EXTRA_PEOPLE_LIST
3929         */
3930        public Builder addPerson(Person person) {
3931            mPersonList.add(person);
3932            return this;
3933        }
3934
3935        /**
3936         * Set this notification to be part of a group of notifications sharing the same key.
3937         * Grouped notifications may display in a cluster or stack on devices which
3938         * support such rendering.
3939         *
3940         * <p>To make this notification the summary for its group, also call
3941         * {@link #setGroupSummary}. A sort order can be specified for group members by using
3942         * {@link #setSortKey}.
3943         * @param groupKey The group key of the group.
3944         * @return this object for method chaining
3945         */
3946        public Builder setGroup(String groupKey) {
3947            mN.mGroupKey = groupKey;
3948            return this;
3949        }
3950
3951        /**
3952         * Set this notification to be the group summary for a group of notifications.
3953         * Grouped notifications may display in a cluster or stack on devices which
3954         * support such rendering. If thereRequires a group key also be set using {@link #setGroup}.
3955         * The group summary may be suppressed if too few notifications are included in the group.
3956         * @param isGroupSummary Whether this notification should be a group summary.
3957         * @return this object for method chaining
3958         */
3959        public Builder setGroupSummary(boolean isGroupSummary) {
3960            setFlag(FLAG_GROUP_SUMMARY, isGroupSummary);
3961            return this;
3962        }
3963
3964        /**
3965         * Set a sort key that orders this notification among other notifications from the
3966         * same package. This can be useful if an external sort was already applied and an app
3967         * would like to preserve this. Notifications will be sorted lexicographically using this
3968         * value, although providing different priorities in addition to providing sort key may
3969         * cause this value to be ignored.
3970         *
3971         * <p>This sort key can also be used to order members of a notification group. See
3972         * {@link #setGroup}.
3973         *
3974         * @see String#compareTo(String)
3975         */
3976        public Builder setSortKey(String sortKey) {
3977            mN.mSortKey = sortKey;
3978            return this;
3979        }
3980
3981        /**
3982         * Merge additional metadata into this notification.
3983         *
3984         * <p>Values within the Bundle will replace existing extras values in this Builder.
3985         *
3986         * @see Notification#extras
3987         */
3988        public Builder addExtras(Bundle extras) {
3989            if (extras != null) {
3990                mUserExtras.putAll(extras);
3991            }
3992            return this;
3993        }
3994
3995        /**
3996         * Set metadata for this notification.
3997         *
3998         * <p>A reference to the Bundle is held for the lifetime of this Builder, and the Bundle's
3999         * current contents are copied into the Notification each time {@link #build()} is
4000         * called.
4001         *
4002         * <p>Replaces any existing extras values with those from the provided Bundle.
4003         * Use {@link #addExtras} to merge in metadata instead.
4004         *
4005         * @see Notification#extras
4006         */
4007        public Builder setExtras(Bundle extras) {
4008            if (extras != null) {
4009                mUserExtras = extras;
4010            }
4011            return this;
4012        }
4013
4014        /**
4015         * Get the current metadata Bundle used by this notification Builder.
4016         *
4017         * <p>The returned Bundle is shared with this Builder.
4018         *
4019         * <p>The current contents of this Bundle are copied into the Notification each time
4020         * {@link #build()} is called.
4021         *
4022         * @see Notification#extras
4023         */
4024        public Bundle getExtras() {
4025            return mUserExtras;
4026        }
4027
4028        private Bundle getAllExtras() {
4029            final Bundle saveExtras = (Bundle) mUserExtras.clone();
4030            saveExtras.putAll(mN.extras);
4031            return saveExtras;
4032        }
4033
4034        /**
4035         * Add an action to this notification. Actions are typically displayed by
4036         * the system as a button adjacent to the notification content.
4037         * <p>
4038         * Every action must have an icon (32dp square and matching the
4039         * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4040         * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4041         * <p>
4042         * A notification in its expanded form can display up to 3 actions, from left to right in
4043         * the order they were added. Actions will not be displayed when the notification is
4044         * collapsed, however, so be sure that any essential functions may be accessed by the user
4045         * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
4046         *
4047         * @param icon Resource ID of a drawable that represents the action.
4048         * @param title Text describing the action.
4049         * @param intent PendingIntent to be fired when the action is invoked.
4050         *
4051         * @deprecated Use {@link #addAction(Action)} instead.
4052         */
4053        @Deprecated
4054        public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
4055            mActions.add(new Action(icon, safeCharSequence(title), intent));
4056            return this;
4057        }
4058
4059        /**
4060         * Add an action to this notification. Actions are typically displayed by
4061         * the system as a button adjacent to the notification content.
4062         * <p>
4063         * Every action must have an icon (32dp square and matching the
4064         * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4065         * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4066         * <p>
4067         * A notification in its expanded form can display up to 3 actions, from left to right in
4068         * the order they were added. Actions will not be displayed when the notification is
4069         * collapsed, however, so be sure that any essential functions may be accessed by the user
4070         * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
4071         *
4072         * @param action The action to add.
4073         */
4074        public Builder addAction(Action action) {
4075            if (action != null) {
4076                mActions.add(action);
4077            }
4078            return this;
4079        }
4080
4081        /**
4082         * Alter the complete list of actions attached to this notification.
4083         * @see #addAction(Action).
4084         *
4085         * @param actions
4086         * @return
4087         */
4088        public Builder setActions(Action... actions) {
4089            mActions.clear();
4090            for (int i = 0; i < actions.length; i++) {
4091                if (actions[i] != null) {
4092                    mActions.add(actions[i]);
4093                }
4094            }
4095            return this;
4096        }
4097
4098        /**
4099         * Add a rich notification style to be applied at build time.
4100         *
4101         * @param style Object responsible for modifying the notification style.
4102         */
4103        public Builder setStyle(Style style) {
4104            if (mStyle != style) {
4105                mStyle = style;
4106                if (mStyle != null) {
4107                    mStyle.setBuilder(this);
4108                    mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName());
4109                }  else {
4110                    mN.extras.remove(EXTRA_TEMPLATE);
4111                }
4112            }
4113            return this;
4114        }
4115
4116        /**
4117         * Returns the style set by {@link #setStyle(Style)}.
4118         */
4119        public Style getStyle() {
4120            return mStyle;
4121        }
4122
4123        /**
4124         * Specify the value of {@link #visibility}.
4125         *
4126         * @return The same Builder.
4127         */
4128        public Builder setVisibility(@Visibility int visibility) {
4129            mN.visibility = visibility;
4130            return this;
4131        }
4132
4133        /**
4134         * Supply a replacement Notification whose contents should be shown in insecure contexts
4135         * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}.
4136         * @param n A replacement notification, presumably with some or all info redacted.
4137         * @return The same Builder.
4138         */
4139        public Builder setPublicVersion(Notification n) {
4140            if (n != null) {
4141                mN.publicVersion = new Notification();
4142                n.cloneInto(mN.publicVersion, /*heavy=*/ true);
4143            } else {
4144                mN.publicVersion = null;
4145            }
4146            return this;
4147        }
4148
4149        /**
4150         * Apply an extender to this notification builder. Extenders may be used to add
4151         * metadata or change options on this builder.
4152         */
4153        public Builder extend(Extender extender) {
4154            extender.extend(this);
4155            return this;
4156        }
4157
4158        /**
4159         * @hide
4160         */
4161        public Builder setFlag(int mask, boolean value) {
4162            if (value) {
4163                mN.flags |= mask;
4164            } else {
4165                mN.flags &= ~mask;
4166            }
4167            return this;
4168        }
4169
4170        /**
4171         * Sets {@link Notification#color}.
4172         *
4173         * @param argb The accent color to use
4174         *
4175         * @return The same Builder.
4176         */
4177        public Builder setColor(@ColorInt int argb) {
4178            mN.color = argb;
4179            sanitizeColor();
4180            return this;
4181        }
4182
4183        private Drawable getProfileBadgeDrawable() {
4184            if (mContext.getUserId() == UserHandle.USER_SYSTEM) {
4185                // This user can never be a badged profile,
4186                // and also includes USER_ALL system notifications.
4187                return null;
4188            }
4189            // Note: This assumes that the current user can read the profile badge of the
4190            // originating user.
4191            return mContext.getPackageManager().getUserBadgeForDensityNoBackground(
4192                    new UserHandle(mContext.getUserId()), 0);
4193        }
4194
4195        private Bitmap getProfileBadge() {
4196            Drawable badge = getProfileBadgeDrawable();
4197            if (badge == null) {
4198                return null;
4199            }
4200            final int size = mContext.getResources().getDimensionPixelSize(
4201                    R.dimen.notification_badge_size);
4202            Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
4203            Canvas canvas = new Canvas(bitmap);
4204            badge.setBounds(0, 0, size, size);
4205            badge.draw(canvas);
4206            return bitmap;
4207        }
4208
4209        private void bindProfileBadge(RemoteViews contentView) {
4210            Bitmap profileBadge = getProfileBadge();
4211
4212            if (profileBadge != null) {
4213                contentView.setImageViewBitmap(R.id.profile_badge, profileBadge);
4214                contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE);
4215                if (isColorized()) {
4216                    contentView.setDrawableTint(R.id.profile_badge, false,
4217                            getPrimaryTextColor(), PorterDuff.Mode.SRC_ATOP);
4218                }
4219            }
4220        }
4221
4222        /**
4223         * @hide
4224         */
4225        public boolean usesStandardHeader() {
4226            if (mN.mUsesStandardHeader) {
4227                return true;
4228            }
4229            if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.N) {
4230                if (mN.contentView == null && mN.bigContentView == null) {
4231                    return true;
4232                }
4233            }
4234            boolean contentViewUsesHeader = mN.contentView == null
4235                    || STANDARD_LAYOUTS.contains(mN.contentView.getLayoutId());
4236            boolean bigContentViewUsesHeader = mN.bigContentView == null
4237                    || STANDARD_LAYOUTS.contains(mN.bigContentView.getLayoutId());
4238            return contentViewUsesHeader && bigContentViewUsesHeader;
4239        }
4240
4241        private void resetStandardTemplate(RemoteViews contentView) {
4242            resetNotificationHeader(contentView);
4243            resetContentMargins(contentView);
4244            contentView.setViewVisibility(R.id.right_icon, View.GONE);
4245            contentView.setViewVisibility(R.id.title, View.GONE);
4246            contentView.setTextViewText(R.id.title, null);
4247            contentView.setViewVisibility(R.id.text, View.GONE);
4248            contentView.setTextViewText(R.id.text, null);
4249            contentView.setViewVisibility(R.id.text_line_1, View.GONE);
4250            contentView.setTextViewText(R.id.text_line_1, null);
4251        }
4252
4253        /**
4254         * Resets the notification header to its original state
4255         */
4256        private void resetNotificationHeader(RemoteViews contentView) {
4257            // Small icon doesn't need to be reset, as it's always set. Resetting would prevent
4258            // re-using the drawable when the notification is updated.
4259            contentView.setBoolean(R.id.notification_header, "setExpanded", false);
4260            contentView.setTextViewText(R.id.app_name_text, null);
4261            contentView.setViewVisibility(R.id.chronometer, View.GONE);
4262            contentView.setViewVisibility(R.id.header_text, View.GONE);
4263            contentView.setTextViewText(R.id.header_text, null);
4264            contentView.setViewVisibility(R.id.header_text_secondary, View.GONE);
4265            contentView.setTextViewText(R.id.header_text_secondary, null);
4266            contentView.setViewVisibility(R.id.header_text_divider, View.GONE);
4267            contentView.setViewVisibility(R.id.header_text_secondary_divider, View.GONE);
4268            contentView.setViewVisibility(R.id.time_divider, View.GONE);
4269            contentView.setViewVisibility(R.id.time, View.GONE);
4270            contentView.setImageViewIcon(R.id.profile_badge, null);
4271            contentView.setViewVisibility(R.id.profile_badge, View.GONE);
4272            mN.mUsesStandardHeader = false;
4273        }
4274
4275        private void resetContentMargins(RemoteViews contentView) {
4276            contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
4277            contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
4278        }
4279
4280        private RemoteViews applyStandardTemplate(int resId) {
4281            return applyStandardTemplate(resId, mParams.reset().fillTextsFrom(this));
4282        }
4283
4284        /**
4285         * @param hasProgress whether the progress bar should be shown and set
4286         */
4287        private RemoteViews applyStandardTemplate(int resId, boolean hasProgress) {
4288            return applyStandardTemplate(resId, mParams.reset().hasProgress(hasProgress)
4289                    .fillTextsFrom(this));
4290        }
4291
4292        private RemoteViews applyStandardTemplate(int resId, StandardTemplateParams p) {
4293            RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId);
4294
4295            resetStandardTemplate(contentView);
4296
4297            final Bundle ex = mN.extras;
4298            updateBackgroundColor(contentView);
4299            bindNotificationHeader(contentView, p.ambient, p.headerTextSecondary);
4300            bindLargeIcon(contentView, p.hideLargeIcon || p.ambient, p.alwaysShowReply);
4301            boolean showProgress = handleProgressBar(p.hasProgress, contentView, ex);
4302            if (p.title != null) {
4303                contentView.setViewVisibility(R.id.title, View.VISIBLE);
4304                contentView.setTextViewText(R.id.title, processTextSpans(p.title));
4305                if (!p.ambient) {
4306                    setTextViewColorPrimary(contentView, R.id.title);
4307                }
4308                contentView.setViewLayoutWidth(R.id.title, showProgress
4309                        ? ViewGroup.LayoutParams.WRAP_CONTENT
4310                        : ViewGroup.LayoutParams.MATCH_PARENT);
4311            }
4312            if (p.text != null) {
4313                int textId = showProgress ? com.android.internal.R.id.text_line_1
4314                        : com.android.internal.R.id.text;
4315                contentView.setTextViewText(textId, processTextSpans(p.text));
4316                if (!p.ambient) {
4317                    setTextViewColorSecondary(contentView, textId);
4318                }
4319                contentView.setViewVisibility(textId, View.VISIBLE);
4320            }
4321
4322            setContentMinHeight(contentView, showProgress || mN.hasLargeIcon());
4323
4324            return contentView;
4325        }
4326
4327        private CharSequence processTextSpans(CharSequence text) {
4328            if (hasForegroundColor()) {
4329                return NotificationColorUtil.clearColorSpans(text);
4330            }
4331            return text;
4332        }
4333
4334        private void setTextViewColorPrimary(RemoteViews contentView, int id) {
4335            ensureColors();
4336            contentView.setTextColor(id, mPrimaryTextColor);
4337        }
4338
4339        private boolean hasForegroundColor() {
4340            return mForegroundColor != COLOR_INVALID;
4341        }
4342
4343        /**
4344         * @return the primary text color
4345         * @hide
4346         */
4347        @VisibleForTesting
4348        public int getPrimaryTextColor() {
4349            ensureColors();
4350            return mPrimaryTextColor;
4351        }
4352
4353        /**
4354         * @return the secondary text color
4355         * @hide
4356         */
4357        @VisibleForTesting
4358        public int getSecondaryTextColor() {
4359            ensureColors();
4360            return mSecondaryTextColor;
4361        }
4362
4363        private int getActionBarColor() {
4364            ensureColors();
4365            return mActionBarColor;
4366        }
4367
4368        private int getActionBarColorDeEmphasized() {
4369            int backgroundColor = getBackgroundColor();
4370            return NotificationColorUtil.getShiftedColor(backgroundColor, 12);
4371        }
4372
4373        private void setTextViewColorSecondary(RemoteViews contentView, int id) {
4374            ensureColors();
4375            contentView.setTextColor(id, mSecondaryTextColor);
4376        }
4377
4378        private void ensureColors() {
4379            int backgroundColor = getBackgroundColor();
4380            if (mPrimaryTextColor == COLOR_INVALID
4381                    || mSecondaryTextColor == COLOR_INVALID
4382                    || mActionBarColor == COLOR_INVALID
4383                    || mTextColorsAreForBackground != backgroundColor) {
4384                mTextColorsAreForBackground = backgroundColor;
4385                if (!hasForegroundColor() || !isColorized()) {
4386                    mPrimaryTextColor = NotificationColorUtil.resolvePrimaryColor(mContext,
4387                            backgroundColor);
4388                    mSecondaryTextColor = NotificationColorUtil.resolveSecondaryColor(mContext,
4389                            backgroundColor);
4390                    if (backgroundColor != COLOR_DEFAULT
4391                            && (mBackgroundColorHint != COLOR_INVALID || isColorized())) {
4392                        mPrimaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4393                                mPrimaryTextColor, backgroundColor, 4.5);
4394                        mSecondaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4395                                mSecondaryTextColor, backgroundColor, 4.5);
4396                    }
4397                } else {
4398                    double backLum = NotificationColorUtil.calculateLuminance(backgroundColor);
4399                    double textLum = NotificationColorUtil.calculateLuminance(mForegroundColor);
4400                    double contrast = NotificationColorUtil.calculateContrast(mForegroundColor,
4401                            backgroundColor);
4402                    // We only respect the given colors if worst case Black or White still has
4403                    // contrast
4404                    boolean backgroundLight = backLum > textLum
4405                                    && satisfiesTextContrast(backgroundColor, Color.BLACK)
4406                            || backLum <= textLum
4407                                    && !satisfiesTextContrast(backgroundColor, Color.WHITE);
4408                    if (contrast < 4.5f) {
4409                        if (backgroundLight) {
4410                            mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4411                                    mForegroundColor,
4412                                    backgroundColor,
4413                                    true /* findFG */,
4414                                    4.5f);
4415                            mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
4416                                    mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_LIGHT);
4417                        } else {
4418                            mSecondaryTextColor =
4419                                    NotificationColorUtil.findContrastColorAgainstDark(
4420                                    mForegroundColor,
4421                                    backgroundColor,
4422                                    true /* findFG */,
4423                                    4.5f);
4424                            mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
4425                                    mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_DARK);
4426                        }
4427                    } else {
4428                        mPrimaryTextColor = mForegroundColor;
4429                        mSecondaryTextColor = NotificationColorUtil.changeColorLightness(
4430                                mPrimaryTextColor, backgroundLight ? LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4431                                        : LIGHTNESS_TEXT_DIFFERENCE_DARK);
4432                        if (NotificationColorUtil.calculateContrast(mSecondaryTextColor,
4433                                backgroundColor) < 4.5f) {
4434                            // oh well the secondary is not good enough
4435                            if (backgroundLight) {
4436                                mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4437                                        mSecondaryTextColor,
4438                                        backgroundColor,
4439                                        true /* findFG */,
4440                                        4.5f);
4441                            } else {
4442                                mSecondaryTextColor
4443                                        = NotificationColorUtil.findContrastColorAgainstDark(
4444                                        mSecondaryTextColor,
4445                                        backgroundColor,
4446                                        true /* findFG */,
4447                                        4.5f);
4448                            }
4449                            mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
4450                                    mSecondaryTextColor, backgroundLight
4451                                            ? -LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4452                                            : -LIGHTNESS_TEXT_DIFFERENCE_DARK);
4453                        }
4454                    }
4455                }
4456                mActionBarColor = NotificationColorUtil.resolveActionBarColor(mContext,
4457                        backgroundColor);
4458            }
4459        }
4460
4461        private void updateBackgroundColor(RemoteViews contentView) {
4462            if (isColorized()) {
4463                contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundColor",
4464                        getBackgroundColor());
4465            } else {
4466                // Clear it!
4467                contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundResource",
4468                        0);
4469            }
4470        }
4471
4472        /**
4473         * @param remoteView the remote view to update the minheight in
4474         * @param hasMinHeight does it have a mimHeight
4475         * @hide
4476         */
4477        void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) {
4478            int minHeight = 0;
4479            if (hasMinHeight) {
4480                // we need to set the minHeight of the notification
4481                minHeight = mContext.getResources().getDimensionPixelSize(
4482                        com.android.internal.R.dimen.notification_min_content_height);
4483            }
4484            remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight);
4485        }
4486
4487        private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) {
4488            final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0);
4489            final int progress = ex.getInt(EXTRA_PROGRESS, 0);
4490            final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
4491            if (hasProgress && (max != 0 || ind)) {
4492                contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE);
4493                contentView.setProgressBar(
4494                        R.id.progress, max, progress, ind);
4495                contentView.setProgressBackgroundTintList(
4496                        R.id.progress, ColorStateList.valueOf(mContext.getColor(
4497                                R.color.notification_progress_background_color)));
4498                if (mN.color != COLOR_DEFAULT) {
4499                    ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor());
4500                    contentView.setProgressTintList(R.id.progress, colorStateList);
4501                    contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList);
4502                }
4503                return true;
4504            } else {
4505                contentView.setViewVisibility(R.id.progress, View.GONE);
4506                return false;
4507            }
4508        }
4509
4510        private void bindLargeIcon(RemoteViews contentView, boolean hideLargeIcon,
4511                boolean alwaysShowReply) {
4512            if (mN.mLargeIcon == null && mN.largeIcon != null) {
4513                mN.mLargeIcon = Icon.createWithBitmap(mN.largeIcon);
4514            }
4515            boolean showLargeIcon = mN.mLargeIcon != null && !hideLargeIcon;
4516            if (showLargeIcon) {
4517                contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4518                contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon);
4519                processLargeLegacyIcon(mN.mLargeIcon, contentView);
4520                int endMargin = R.dimen.notification_content_picture_margin;
4521                contentView.setViewLayoutMarginEndDimen(R.id.line1, endMargin);
4522                contentView.setViewLayoutMarginEndDimen(R.id.text, endMargin);
4523                contentView.setViewLayoutMarginEndDimen(R.id.progress, endMargin);
4524            }
4525            // Bind the reply action
4526            Action action = findReplyAction();
4527
4528            boolean actionVisible = action != null && (showLargeIcon || alwaysShowReply);
4529            int replyId = showLargeIcon ? R.id.reply_icon_action : R.id.right_icon;
4530            if (actionVisible) {
4531                // We're only showing the icon as big if we're hiding the large icon
4532                int contrastColor = resolveContrastColor();
4533                int iconColor;
4534                if (showLargeIcon) {
4535                    contentView.setDrawableTint(R.id.reply_icon_action,
4536                            true /* targetBackground */,
4537                            contrastColor, PorterDuff.Mode.SRC_ATOP);
4538                    contentView.setOnClickPendingIntent(R.id.right_icon,
4539                            action.actionIntent);
4540                    contentView.setRemoteInputs(R.id.right_icon, action.mRemoteInputs);
4541                    iconColor = NotificationColorUtil.isColorLight(contrastColor)
4542                            ? Color.BLACK : Color.WHITE;
4543                } else {
4544                    contentView.setImageViewResource(R.id.right_icon,
4545                            R.drawable.ic_reply_notification_large);
4546                    contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4547                    iconColor = contrastColor;
4548                }
4549                contentView.setDrawableTint(replyId,
4550                        false /* targetBackground */,
4551                        iconColor,
4552                        PorterDuff.Mode.SRC_ATOP);
4553                contentView.setOnClickPendingIntent(replyId,
4554                        action.actionIntent);
4555                contentView.setRemoteInputs(replyId, action.mRemoteInputs);
4556            } else {
4557                contentView.setRemoteInputs(R.id.right_icon, null);
4558            }
4559            contentView.setViewVisibility(R.id.reply_icon_action, actionVisible && showLargeIcon
4560                    ? View.VISIBLE
4561                    : View.GONE);
4562            contentView.setViewVisibility(R.id.right_icon_container, actionVisible || showLargeIcon
4563                    ? View.VISIBLE
4564                    : View.GONE);
4565        }
4566
4567        private Action findReplyAction() {
4568            ArrayList<Action> actions = mActions;
4569            if (mOriginalActions != null) {
4570                actions = mOriginalActions;
4571            }
4572            int numActions = actions.size();
4573            for (int i = 0; i < numActions; i++) {
4574                Action action = actions.get(i);
4575                if (hasValidRemoteInput(action)) {
4576                    return action;
4577                }
4578            }
4579            return null;
4580        }
4581
4582        private void bindNotificationHeader(RemoteViews contentView, boolean ambient,
4583                CharSequence secondaryHeaderText) {
4584            bindSmallIcon(contentView, ambient);
4585            bindHeaderAppName(contentView, ambient);
4586            if (!ambient) {
4587                // Ambient view does not have these
4588                bindHeaderText(contentView);
4589                bindHeaderTextSecondary(contentView, secondaryHeaderText);
4590                bindHeaderChronometerAndTime(contentView);
4591                bindProfileBadge(contentView);
4592            }
4593            bindExpandButton(contentView);
4594            mN.mUsesStandardHeader = true;
4595        }
4596
4597        private void bindExpandButton(RemoteViews contentView) {
4598            int color = getPrimaryHighlightColor();
4599            contentView.setDrawableTint(R.id.expand_button, false, color,
4600                    PorterDuff.Mode.SRC_ATOP);
4601            contentView.setInt(R.id.notification_header, "setOriginalNotificationColor",
4602                    color);
4603        }
4604
4605        /**
4606         * @return the color that is used as the first primary highlight color. This is applied
4607         * in several places like the action buttons or the app name in the header.
4608         */
4609        private int getPrimaryHighlightColor() {
4610            return isColorized() ? getPrimaryTextColor() : resolveContrastColor();
4611        }
4612
4613        private void bindHeaderChronometerAndTime(RemoteViews contentView) {
4614            if (showsTimeOrChronometer()) {
4615                contentView.setViewVisibility(R.id.time_divider, View.VISIBLE);
4616                setTextViewColorSecondary(contentView, R.id.time_divider);
4617                if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) {
4618                    contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
4619                    contentView.setLong(R.id.chronometer, "setBase",
4620                            mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
4621                    contentView.setBoolean(R.id.chronometer, "setStarted", true);
4622                    boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN);
4623                    contentView.setChronometerCountDown(R.id.chronometer, countsDown);
4624                    setTextViewColorSecondary(contentView, R.id.chronometer);
4625                } else {
4626                    contentView.setViewVisibility(R.id.time, View.VISIBLE);
4627                    contentView.setLong(R.id.time, "setTime", mN.when);
4628                    setTextViewColorSecondary(contentView, R.id.time);
4629                }
4630            } else {
4631                // We still want a time to be set but gone, such that we can show and hide it
4632                // on demand in case it's a child notification without anything in the header
4633                contentView.setLong(R.id.time, "setTime", mN.when != 0 ? mN.when : mN.creationTime);
4634            }
4635        }
4636
4637        private void bindHeaderText(RemoteViews contentView) {
4638            CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
4639            if (headerText == null && mStyle != null && mStyle.mSummaryTextSet
4640                    && mStyle.hasSummaryInHeader()) {
4641                headerText = mStyle.mSummaryText;
4642            }
4643            if (headerText == null
4644                    && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
4645                    && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) {
4646                headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT);
4647            }
4648            if (headerText != null) {
4649                // TODO: Remove the span entirely to only have the string with propper formating.
4650                contentView.setTextViewText(R.id.header_text, processTextSpans(
4651                        processLegacyText(headerText)));
4652                setTextViewColorSecondary(contentView, R.id.header_text);
4653                contentView.setViewVisibility(R.id.header_text, View.VISIBLE);
4654                contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE);
4655                setTextViewColorSecondary(contentView, R.id.header_text_divider);
4656            }
4657        }
4658
4659        private void bindHeaderTextSecondary(RemoteViews contentView, CharSequence secondaryText) {
4660            if (!TextUtils.isEmpty(secondaryText)) {
4661                contentView.setTextViewText(R.id.header_text_secondary, processTextSpans(
4662                        processLegacyText(secondaryText)));
4663                setTextViewColorSecondary(contentView, R.id.header_text_secondary);
4664                contentView.setViewVisibility(R.id.header_text_secondary, View.VISIBLE);
4665                contentView.setViewVisibility(R.id.header_text_secondary_divider, View.VISIBLE);
4666                setTextViewColorSecondary(contentView, R.id.header_text_secondary_divider);
4667            }
4668        }
4669
4670        /**
4671         * @hide
4672         */
4673        public String loadHeaderAppName() {
4674            CharSequence name = null;
4675            final PackageManager pm = mContext.getPackageManager();
4676            if (mN.extras.containsKey(EXTRA_SUBSTITUTE_APP_NAME)) {
4677                // only system packages which lump together a bunch of unrelated stuff
4678                // may substitute a different name to make the purpose of the
4679                // notification more clear. the correct package label should always
4680                // be accessible via SystemUI.
4681                final String pkg = mContext.getPackageName();
4682                final String subName = mN.extras.getString(EXTRA_SUBSTITUTE_APP_NAME);
4683                if (PackageManager.PERMISSION_GRANTED == pm.checkPermission(
4684                        android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME, pkg)) {
4685                    name = subName;
4686                } else {
4687                    Log.w(TAG, "warning: pkg "
4688                            + pkg + " attempting to substitute app name '" + subName
4689                            + "' without holding perm "
4690                            + android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME);
4691                }
4692            }
4693            if (TextUtils.isEmpty(name)) {
4694                name = pm.getApplicationLabel(mContext.getApplicationInfo());
4695            }
4696            if (TextUtils.isEmpty(name)) {
4697                // still nothing?
4698                return null;
4699            }
4700
4701            return String.valueOf(name);
4702        }
4703        private void bindHeaderAppName(RemoteViews contentView, boolean ambient) {
4704            contentView.setTextViewText(R.id.app_name_text, loadHeaderAppName());
4705            if (isColorized() && !ambient) {
4706                setTextViewColorPrimary(contentView, R.id.app_name_text);
4707            } else {
4708                contentView.setTextColor(R.id.app_name_text,
4709                        ambient ? resolveAmbientColor() : resolveContrastColor());
4710            }
4711        }
4712
4713        private void bindSmallIcon(RemoteViews contentView, boolean ambient) {
4714            if (mN.mSmallIcon == null && mN.icon != 0) {
4715                mN.mSmallIcon = Icon.createWithResource(mContext, mN.icon);
4716            }
4717            contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon);
4718            contentView.setInt(R.id.icon, "setImageLevel", mN.iconLevel);
4719            processSmallIconColor(mN.mSmallIcon, contentView, ambient);
4720        }
4721
4722        /**
4723         * @return true if the built notification will show the time or the chronometer; false
4724         *         otherwise
4725         */
4726        private boolean showsTimeOrChronometer() {
4727            return mN.showsTime() || mN.showsChronometer();
4728        }
4729
4730        private void resetStandardTemplateWithActions(RemoteViews big) {
4731            // actions_container is only reset when there are no actions to avoid focus issues with
4732            // remote inputs.
4733            big.setViewVisibility(R.id.actions, View.GONE);
4734            big.removeAllViews(R.id.actions);
4735
4736            big.setViewVisibility(R.id.notification_material_reply_container, View.GONE);
4737            big.setTextViewText(R.id.notification_material_reply_text_1, null);
4738
4739            big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE);
4740            big.setTextViewText(R.id.notification_material_reply_text_2, null);
4741            big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE);
4742            big.setTextViewText(R.id.notification_material_reply_text_3, null);
4743
4744            big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target,
4745                    R.dimen.notification_content_margin);
4746        }
4747
4748        private RemoteViews applyStandardTemplateWithActions(int layoutId) {
4749            return applyStandardTemplateWithActions(layoutId, mParams.reset().fillTextsFrom(this));
4750        }
4751
4752        private RemoteViews applyStandardTemplateWithActions(int layoutId,
4753            StandardTemplateParams p) {
4754            RemoteViews big = applyStandardTemplate(layoutId, p);
4755
4756            resetStandardTemplateWithActions(big);
4757
4758            boolean validRemoteInput = false;
4759
4760            int N = mActions.size();
4761            boolean emphazisedMode = mN.fullScreenIntent != null && !p.ambient;
4762            big.setBoolean(R.id.actions, "setEmphasizedMode", emphazisedMode);
4763            if (N > 0) {
4764                big.setViewVisibility(R.id.actions_container, View.VISIBLE);
4765                big.setViewVisibility(R.id.actions, View.VISIBLE);
4766                big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, 0);
4767                if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
4768                for (int i=0; i<N; i++) {
4769                    Action action = mActions.get(i);
4770                    boolean actionHasValidInput = hasValidRemoteInput(action);
4771                    validRemoteInput |= actionHasValidInput;
4772
4773                    final RemoteViews button = generateActionButton(action, emphazisedMode,
4774                            i % 2 != 0, p.ambient);
4775                    if (actionHasValidInput) {
4776                        // Clear the drawable
4777                        button.setInt(R.id.action0, "setBackgroundResource", 0);
4778                    }
4779                    big.addView(R.id.actions, button);
4780                }
4781            } else {
4782                big.setViewVisibility(R.id.actions_container, View.GONE);
4783            }
4784
4785            CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
4786            if (!p.ambient && validRemoteInput && replyText != null
4787                    && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])) {
4788                big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE);
4789                big.setTextViewText(R.id.notification_material_reply_text_1,
4790                        processTextSpans(replyText[0]));
4791                setTextViewColorSecondary(big, R.id.notification_material_reply_text_1);
4792
4793                if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])) {
4794                    big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE);
4795                    big.setTextViewText(R.id.notification_material_reply_text_2,
4796                            processTextSpans(replyText[1]));
4797                    setTextViewColorSecondary(big, R.id.notification_material_reply_text_2);
4798
4799                    if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])) {
4800                        big.setViewVisibility(
4801                                R.id.notification_material_reply_text_3, View.VISIBLE);
4802                        big.setTextViewText(R.id.notification_material_reply_text_3,
4803                                processTextSpans(replyText[2]));
4804                        setTextViewColorSecondary(big, R.id.notification_material_reply_text_3);
4805                    }
4806                }
4807            }
4808
4809            return big;
4810        }
4811
4812        private boolean hasValidRemoteInput(Action action) {
4813            if (TextUtils.isEmpty(action.title) || action.actionIntent == null) {
4814                // Weird actions
4815                return false;
4816            }
4817
4818            RemoteInput[] remoteInputs = action.getRemoteInputs();
4819            if (remoteInputs == null) {
4820                return false;
4821            }
4822
4823            for (RemoteInput r : remoteInputs) {
4824                CharSequence[] choices = r.getChoices();
4825                if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) {
4826                    return true;
4827                }
4828            }
4829            return false;
4830        }
4831
4832        /**
4833         * Construct a RemoteViews for the final 1U notification layout. In order:
4834         *   1. Custom contentView from the caller
4835         *   2. Style's proposed content view
4836         *   3. Standard template view
4837         */
4838        public RemoteViews createContentView() {
4839            return createContentView(false /* increasedheight */ );
4840        }
4841
4842        /**
4843         * Construct a RemoteViews for the smaller content view.
4844         *
4845         *   @param increasedHeight true if this layout be created with an increased height. Some
4846         *   styles may support showing more then just that basic 1U size
4847         *   and the system may decide to render important notifications
4848         *   slightly bigger even when collapsed.
4849         *
4850         *   @hide
4851         */
4852        public RemoteViews createContentView(boolean increasedHeight) {
4853            if (mN.contentView != null && useExistingRemoteView()) {
4854                return mN.contentView;
4855            } else if (mStyle != null) {
4856                final RemoteViews styleView = mStyle.makeContentView(increasedHeight);
4857                if (styleView != null) {
4858                    return styleView;
4859                }
4860            }
4861            return applyStandardTemplate(getBaseLayoutResource());
4862        }
4863
4864        private boolean useExistingRemoteView() {
4865            return mStyle == null || (!mStyle.displayCustomViewInline()
4866                    && !mRebuildStyledRemoteViews);
4867        }
4868
4869        /**
4870         * Construct a RemoteViews for the final big notification layout.
4871         */
4872        public RemoteViews createBigContentView() {
4873            RemoteViews result = null;
4874            if (mN.bigContentView != null && useExistingRemoteView()) {
4875                return mN.bigContentView;
4876            } else if (mStyle != null) {
4877                result = mStyle.makeBigContentView();
4878                hideLine1Text(result);
4879            } else if (mActions.size() != 0) {
4880                result = applyStandardTemplateWithActions(getBigBaseLayoutResource());
4881            }
4882            makeHeaderExpanded(result);
4883            return result;
4884        }
4885
4886        /**
4887         * Construct a RemoteViews for the final notification header only. This will not be
4888         * colorized.
4889         *
4890         * @param ambient if true, generate the header for the ambient display layout.
4891         * @hide
4892         */
4893        public RemoteViews makeNotificationHeader(boolean ambient) {
4894            Boolean colorized = (Boolean) mN.extras.get(EXTRA_COLORIZED);
4895            mN.extras.putBoolean(EXTRA_COLORIZED, false);
4896            RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(),
4897                    ambient ? R.layout.notification_template_ambient_header
4898                            : R.layout.notification_template_header);
4899            resetNotificationHeader(header);
4900            bindNotificationHeader(header, ambient, null);
4901            if (colorized != null) {
4902                mN.extras.putBoolean(EXTRA_COLORIZED, colorized);
4903            } else {
4904                mN.extras.remove(EXTRA_COLORIZED);
4905            }
4906            return header;
4907        }
4908
4909        /**
4910         * Construct a RemoteViews for the ambient version of the notification.
4911         *
4912         * @hide
4913         */
4914        public RemoteViews makeAmbientNotification() {
4915            RemoteViews ambient = applyStandardTemplateWithActions(
4916                    R.layout.notification_template_material_ambient,
4917                    mParams.reset().ambient(true).fillTextsFrom(this).hasProgress(false));
4918            return ambient;
4919        }
4920
4921        private void hideLine1Text(RemoteViews result) {
4922            if (result != null) {
4923                result.setViewVisibility(R.id.text_line_1, View.GONE);
4924            }
4925        }
4926
4927        /**
4928         * Adapt the Notification header if this view is used as an expanded view.
4929         *
4930         * @hide
4931         */
4932        public static void makeHeaderExpanded(RemoteViews result) {
4933            if (result != null) {
4934                result.setBoolean(R.id.notification_header, "setExpanded", true);
4935            }
4936        }
4937
4938        /**
4939         * Construct a RemoteViews for the final heads-up notification layout.
4940         *
4941         * @param increasedHeight true if this layout be created with an increased height. Some
4942         * styles may support showing more then just that basic 1U size
4943         * and the system may decide to render important notifications
4944         * slightly bigger even when collapsed.
4945         *
4946         * @hide
4947         */
4948        public RemoteViews createHeadsUpContentView(boolean increasedHeight) {
4949            if (mN.headsUpContentView != null && useExistingRemoteView()) {
4950                return mN.headsUpContentView;
4951            } else if (mStyle != null) {
4952                final RemoteViews styleView = mStyle.makeHeadsUpContentView(increasedHeight);
4953                if (styleView != null) {
4954                    return styleView;
4955                }
4956            } else if (mActions.size() == 0) {
4957                return null;
4958            }
4959
4960            return applyStandardTemplateWithActions(getBigBaseLayoutResource());
4961        }
4962
4963        /**
4964         * Construct a RemoteViews for the final heads-up notification layout.
4965         */
4966        public RemoteViews createHeadsUpContentView() {
4967            return createHeadsUpContentView(false /* useIncreasedHeight */);
4968        }
4969
4970        /**
4971         * Construct a RemoteViews for the display in public contexts like on the lockscreen.
4972         *
4973         * @hide
4974         */
4975        public RemoteViews makePublicContentView() {
4976            return makePublicView(false /* ambient */);
4977        }
4978
4979        /**
4980         * Construct a RemoteViews for the display in public contexts like on the lockscreen.
4981         *
4982         * @hide
4983         */
4984        public RemoteViews makePublicAmbientNotification() {
4985            return makePublicView(true /* ambient */);
4986        }
4987
4988        private RemoteViews makePublicView(boolean ambient) {
4989            if (mN.publicVersion != null) {
4990                final Builder builder = recoverBuilder(mContext, mN.publicVersion);
4991                return ambient ? builder.makeAmbientNotification() : builder.createContentView();
4992            }
4993            Bundle savedBundle = mN.extras;
4994            Style style = mStyle;
4995            mStyle = null;
4996            Icon largeIcon = mN.mLargeIcon;
4997            mN.mLargeIcon = null;
4998            Bitmap largeIconLegacy = mN.largeIcon;
4999            mN.largeIcon = null;
5000            ArrayList<Action> actions = mActions;
5001            mActions = new ArrayList<>();
5002            Bundle publicExtras = new Bundle();
5003            publicExtras.putBoolean(EXTRA_SHOW_WHEN,
5004                    savedBundle.getBoolean(EXTRA_SHOW_WHEN));
5005            publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER,
5006                    savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER));
5007            publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN,
5008                    savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN));
5009            mN.extras = publicExtras;
5010            RemoteViews view;
5011            if (ambient) {
5012                publicExtras.putCharSequence(EXTRA_TITLE,
5013                        mContext.getString(com.android.internal.R.string.notification_hidden_text));
5014                view = makeAmbientNotification();
5015            } else{
5016                view = makeNotificationHeader(false /* ambient */);
5017                view.setBoolean(R.id.notification_header, "setExpandOnlyOnButton", true);
5018            }
5019            mN.extras = savedBundle;
5020            mN.mLargeIcon = largeIcon;
5021            mN.largeIcon = largeIconLegacy;
5022            mActions = actions;
5023            mStyle = style;
5024            return view;
5025        }
5026
5027        /**
5028         * Construct a content view for the display when low - priority
5029         *
5030         * @param useRegularSubtext uses the normal subtext set if there is one available. Otherwise
5031         *                          a new subtext is created consisting of the content of the
5032         *                          notification.
5033         * @hide
5034         */
5035        public RemoteViews makeLowPriorityContentView(boolean useRegularSubtext) {
5036            int color = mN.color;
5037            mN.color = COLOR_DEFAULT;
5038            CharSequence summary = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
5039            if (!useRegularSubtext || TextUtils.isEmpty(summary)) {
5040                CharSequence newSummary = createSummaryText();
5041                if (!TextUtils.isEmpty(newSummary)) {
5042                    mN.extras.putCharSequence(EXTRA_SUB_TEXT, newSummary);
5043                }
5044            }
5045
5046            RemoteViews header = makeNotificationHeader(false /* ambient */);
5047            header.setBoolean(R.id.notification_header, "setAcceptAllTouches", true);
5048            if (summary != null) {
5049                mN.extras.putCharSequence(EXTRA_SUB_TEXT, summary);
5050            } else {
5051                mN.extras.remove(EXTRA_SUB_TEXT);
5052            }
5053            mN.color = color;
5054            return header;
5055        }
5056
5057        private CharSequence createSummaryText() {
5058            CharSequence titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE);
5059            if (USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY) {
5060                return titleText;
5061            }
5062            SpannableStringBuilder summary = new SpannableStringBuilder();
5063            if (titleText == null) {
5064                titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE_BIG);
5065            }
5066            BidiFormatter bidi = BidiFormatter.getInstance();
5067            if (titleText != null) {
5068                summary.append(bidi.unicodeWrap(titleText));
5069            }
5070            CharSequence contentText = mN.extras.getCharSequence(Notification.EXTRA_TEXT);
5071            if (titleText != null && contentText != null) {
5072                summary.append(bidi.unicodeWrap(mContext.getText(
5073                        R.string.notification_header_divider_symbol_with_spaces)));
5074            }
5075            if (contentText != null) {
5076                summary.append(bidi.unicodeWrap(contentText));
5077            }
5078            return summary;
5079        }
5080
5081        private RemoteViews generateActionButton(Action action, boolean emphazisedMode,
5082                boolean oddAction, boolean ambient) {
5083            final boolean tombstone = (action.actionIntent == null);
5084            RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(),
5085                    emphazisedMode ? getEmphasizedActionLayoutResource()
5086                            : tombstone ? getActionTombstoneLayoutResource()
5087                                    : getActionLayoutResource());
5088            if (!tombstone) {
5089                button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
5090            }
5091            button.setContentDescription(R.id.action0, action.title);
5092            if (action.mRemoteInputs != null) {
5093                button.setRemoteInputs(R.id.action0, action.mRemoteInputs);
5094            }
5095            // TODO: handle emphasized mode / actions right
5096            if (emphazisedMode) {
5097                // change the background bgColor
5098                int bgColor;
5099                if (isColorized()) {
5100                    bgColor = oddAction ? getActionBarColor() : getActionBarColorDeEmphasized();
5101                } else {
5102                    bgColor = mContext.getColor(oddAction ? R.color.notification_action_list
5103                            : R.color.notification_action_list_dark);
5104                }
5105                button.setDrawableTint(R.id.button_holder, true,
5106                        bgColor, PorterDuff.Mode.SRC_ATOP);
5107                CharSequence title = action.title;
5108                ColorStateList[] outResultColor = null;
5109                if (isLegacy()) {
5110                    title = NotificationColorUtil.clearColorSpans(title);
5111                } else {
5112                    outResultColor = new ColorStateList[1];
5113                    title = ensureColorSpanContrast(title, bgColor, outResultColor);
5114                }
5115                button.setTextViewText(R.id.action0, processTextSpans(title));
5116                setTextViewColorPrimary(button, R.id.action0);
5117                if (outResultColor != null && outResultColor[0] != null) {
5118                    // We need to set the text color as well since changing a text to uppercase
5119                    // clears its spans.
5120                    button.setTextColor(R.id.action0, outResultColor[0]);
5121                } else if (mN.color != COLOR_DEFAULT && !isColorized() && mTintActionButtons) {
5122                    button.setTextColor(R.id.action0,resolveContrastColor());
5123                }
5124            } else {
5125                button.setTextViewText(R.id.action0, processTextSpans(
5126                        processLegacyText(action.title)));
5127                if (isColorized() && !ambient) {
5128                    setTextViewColorPrimary(button, R.id.action0);
5129                } else if (mN.color != COLOR_DEFAULT && mTintActionButtons) {
5130                    button.setTextColor(R.id.action0,
5131                            ambient ? resolveAmbientColor() : resolveContrastColor());
5132                }
5133            }
5134            return button;
5135        }
5136
5137        /**
5138         * Ensures contrast on color spans against a background color. also returns the color of the
5139         * text if a span was found that spans over the whole text.
5140         *
5141         * @param charSequence the charSequence on which the spans are
5142         * @param background the background color to ensure the contrast against
5143         * @param outResultColor an array in which a color will be returned as the first element if
5144         *                    there exists a full length color span.
5145         * @return the contrasted charSequence
5146         */
5147        private CharSequence ensureColorSpanContrast(CharSequence charSequence, int background,
5148                ColorStateList[] outResultColor) {
5149            if (charSequence instanceof Spanned) {
5150                Spanned ss = (Spanned) charSequence;
5151                Object[] spans = ss.getSpans(0, ss.length(), Object.class);
5152                SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
5153                for (Object span : spans) {
5154                    Object resultSpan = span;
5155                    int spanStart = ss.getSpanStart(span);
5156                    int spanEnd = ss.getSpanEnd(span);
5157                    boolean fullLength = (spanEnd - spanStart) == charSequence.length();
5158                    if (resultSpan instanceof CharacterStyle) {
5159                        resultSpan = ((CharacterStyle) span).getUnderlying();
5160                    }
5161                    if (resultSpan instanceof TextAppearanceSpan) {
5162                        TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
5163                        ColorStateList textColor = originalSpan.getTextColor();
5164                        if (textColor != null) {
5165                            int[] colors = textColor.getColors();
5166                            int[] newColors = new int[colors.length];
5167                            for (int i = 0; i < newColors.length; i++) {
5168                                newColors[i] = NotificationColorUtil.ensureLargeTextContrast(
5169                                        colors[i], background, mInNightMode);
5170                            }
5171                            textColor = new ColorStateList(textColor.getStates().clone(),
5172                                    newColors);
5173                            resultSpan = new TextAppearanceSpan(
5174                                    originalSpan.getFamily(),
5175                                    originalSpan.getTextStyle(),
5176                                    originalSpan.getTextSize(),
5177                                    textColor,
5178                                    originalSpan.getLinkTextColor());
5179                            if (fullLength) {
5180                                outResultColor[0] = new ColorStateList(
5181                                        textColor.getStates().clone(), newColors);
5182                            }
5183                        }
5184                    } else if (resultSpan instanceof ForegroundColorSpan) {
5185                        ForegroundColorSpan originalSpan = (ForegroundColorSpan) resultSpan;
5186                        int foregroundColor = originalSpan.getForegroundColor();
5187                        foregroundColor = NotificationColorUtil.ensureLargeTextContrast(
5188                                foregroundColor, background, mInNightMode);
5189                        resultSpan = new ForegroundColorSpan(foregroundColor);
5190                        if (fullLength) {
5191                            outResultColor[0] = ColorStateList.valueOf(foregroundColor);
5192                        }
5193                    } else {
5194                        resultSpan = span;
5195                    }
5196
5197                    builder.setSpan(resultSpan, spanStart, spanEnd, ss.getSpanFlags(span));
5198                }
5199                return builder;
5200            }
5201            return charSequence;
5202        }
5203
5204        /**
5205         * @return Whether we are currently building a notification from a legacy (an app that
5206         *         doesn't create material notifications by itself) app.
5207         */
5208        private boolean isLegacy() {
5209            if (!mIsLegacyInitialized) {
5210                mIsLegacy = mContext.getApplicationInfo().targetSdkVersion
5211                        < Build.VERSION_CODES.LOLLIPOP;
5212                mIsLegacyInitialized = true;
5213            }
5214            return mIsLegacy;
5215        }
5216
5217        private CharSequence processLegacyText(CharSequence charSequence) {
5218            return processLegacyText(charSequence, false /* ambient */);
5219        }
5220
5221        private CharSequence processLegacyText(CharSequence charSequence, boolean ambient) {
5222            boolean isAlreadyLightText = isLegacy() || textColorsNeedInversion();
5223            boolean wantLightText = ambient;
5224            if (isAlreadyLightText != wantLightText) {
5225                return getColorUtil().invertCharSequenceColors(charSequence);
5226            } else {
5227                return charSequence;
5228            }
5229        }
5230
5231        /**
5232         * Apply any necessariy colors to the small icon
5233         */
5234        private void processSmallIconColor(Icon smallIcon, RemoteViews contentView,
5235                boolean ambient) {
5236            boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon);
5237            int color = ambient ? resolveAmbientColor() : getPrimaryHighlightColor();
5238            if (colorable) {
5239                contentView.setDrawableTint(R.id.icon, false, color,
5240                        PorterDuff.Mode.SRC_ATOP);
5241
5242            }
5243            contentView.setInt(R.id.notification_header, "setOriginalIconColor",
5244                    colorable ? color : NotificationHeaderView.NO_COLOR);
5245        }
5246
5247        /**
5248         * Make the largeIcon dark if it's a fake smallIcon (that is,
5249         * if it's grayscale).
5250         */
5251        // TODO: also check bounds, transparency, that sort of thing.
5252        private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) {
5253            if (largeIcon != null && isLegacy()
5254                    && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) {
5255                // resolve color will fall back to the default when legacy
5256                contentView.setDrawableTint(R.id.icon, false, resolveContrastColor(),
5257                        PorterDuff.Mode.SRC_ATOP);
5258            }
5259        }
5260
5261        private void sanitizeColor() {
5262            if (mN.color != COLOR_DEFAULT) {
5263                mN.color |= 0xFF000000; // no alpha for custom colors
5264            }
5265        }
5266
5267        int resolveContrastColor() {
5268            if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) {
5269                return mCachedContrastColor;
5270            }
5271
5272            int color;
5273            int background = mBackgroundColorHint;
5274            if (mBackgroundColorHint == COLOR_INVALID) {
5275                background = mContext.getColor(
5276                        com.android.internal.R.color.notification_material_background_color);
5277            }
5278            if (mN.color == COLOR_DEFAULT) {
5279                ensureColors();
5280                color = mSecondaryTextColor;
5281            } else {
5282                color = NotificationColorUtil.resolveContrastColor(mContext, mN.color,
5283                        background, mInNightMode);
5284            }
5285            if (Color.alpha(color) < 255) {
5286                // alpha doesn't go well for color filters, so let's blend it manually
5287                color = NotificationColorUtil.compositeColors(color, background);
5288            }
5289            mCachedContrastColorIsFor = mN.color;
5290            return mCachedContrastColor = color;
5291        }
5292
5293        int resolveAmbientColor() {
5294            if (mCachedAmbientColorIsFor == mN.color && mCachedAmbientColorIsFor != COLOR_INVALID) {
5295                return mCachedAmbientColor;
5296            }
5297            final int contrasted = NotificationColorUtil.resolveAmbientColor(mContext, mN.color);
5298
5299            mCachedAmbientColorIsFor = mN.color;
5300            return mCachedAmbientColor = contrasted;
5301        }
5302
5303        /**
5304         * Apply the unstyled operations and return a new {@link Notification} object.
5305         * @hide
5306         */
5307        public Notification buildUnstyled() {
5308            if (mActions.size() > 0) {
5309                mN.actions = new Action[mActions.size()];
5310                mActions.toArray(mN.actions);
5311            }
5312            if (!mPersonList.isEmpty()) {
5313                mN.extras.putParcelableArrayList(EXTRA_PEOPLE_LIST, mPersonList);
5314            }
5315            if (mN.bigContentView != null || mN.contentView != null
5316                    || mN.headsUpContentView != null) {
5317                mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true);
5318            }
5319            return mN;
5320        }
5321
5322        /**
5323         * Creates a Builder from an existing notification so further changes can be made.
5324         * @param context The context for your application / activity.
5325         * @param n The notification to create a Builder from.
5326         */
5327        public static Notification.Builder recoverBuilder(Context context, Notification n) {
5328            // Re-create notification context so we can access app resources.
5329            ApplicationInfo applicationInfo = n.extras.getParcelable(
5330                    EXTRA_BUILDER_APPLICATION_INFO);
5331            Context builderContext;
5332            if (applicationInfo != null) {
5333                try {
5334                    builderContext = context.createApplicationContext(applicationInfo,
5335                            Context.CONTEXT_RESTRICTED);
5336                } catch (NameNotFoundException e) {
5337                    Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found");
5338                    builderContext = context;  // try with our context
5339                }
5340            } else {
5341                builderContext = context; // try with given context
5342            }
5343
5344            return new Builder(builderContext, n);
5345        }
5346
5347        /**
5348         * @deprecated Use {@link #build()} instead.
5349         */
5350        @Deprecated
5351        public Notification getNotification() {
5352            return build();
5353        }
5354
5355        /**
5356         * Combine all of the options that have been set and return a new {@link Notification}
5357         * object.
5358         */
5359        public Notification build() {
5360            // first, add any extras from the calling code
5361            if (mUserExtras != null) {
5362                mN.extras = getAllExtras();
5363            }
5364
5365            mN.creationTime = System.currentTimeMillis();
5366
5367            // lazy stuff from mContext; see comment in Builder(Context, Notification)
5368            Notification.addFieldsFromContext(mContext, mN);
5369
5370            buildUnstyled();
5371
5372            if (mStyle != null) {
5373                mStyle.reduceImageSizes(mContext);
5374                mStyle.purgeResources();
5375                mStyle.validate(mContext);
5376                mStyle.buildStyled(mN);
5377            }
5378            mN.reduceImageSizes(mContext);
5379
5380            if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
5381                    && (useExistingRemoteView())) {
5382                if (mN.contentView == null) {
5383                    mN.contentView = createContentView();
5384                    mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT,
5385                            mN.contentView.getSequenceNumber());
5386                }
5387                if (mN.bigContentView == null) {
5388                    mN.bigContentView = createBigContentView();
5389                    if (mN.bigContentView != null) {
5390                        mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT,
5391                                mN.bigContentView.getSequenceNumber());
5392                    }
5393                }
5394                if (mN.headsUpContentView == null) {
5395                    mN.headsUpContentView = createHeadsUpContentView();
5396                    if (mN.headsUpContentView != null) {
5397                        mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT,
5398                                mN.headsUpContentView.getSequenceNumber());
5399                    }
5400                }
5401            }
5402
5403            if ((mN.defaults & DEFAULT_LIGHTS) != 0) {
5404                mN.flags |= FLAG_SHOW_LIGHTS;
5405            }
5406
5407            mN.allPendingIntents = null;
5408
5409            return mN;
5410        }
5411
5412        /**
5413         * Apply this Builder to an existing {@link Notification} object.
5414         *
5415         * @hide
5416         */
5417        public Notification buildInto(Notification n) {
5418            build().cloneInto(n, true);
5419            return n;
5420        }
5421
5422        /**
5423         * Removes RemoteViews that were created for compatibility from {@param n}, if they did not
5424         * change. Also removes extenders on low ram devices, as
5425         * {@link android.service.notification.NotificationListenerService} services are disabled.
5426         *
5427         * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}.
5428         *
5429         * @hide
5430         */
5431        public static Notification maybeCloneStrippedForDelivery(Notification n, boolean isLowRam) {
5432            String templateClass = n.extras.getString(EXTRA_TEMPLATE);
5433
5434            // Only strip views for known Styles because we won't know how to
5435            // re-create them otherwise.
5436            if (!isLowRam
5437                    && !TextUtils.isEmpty(templateClass)
5438                    && getNotificationStyleClass(templateClass) == null) {
5439                return n;
5440            }
5441
5442            // Only strip unmodified BuilderRemoteViews.
5443            boolean stripContentView = n.contentView instanceof BuilderRemoteViews &&
5444                    n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) ==
5445                            n.contentView.getSequenceNumber();
5446            boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews &&
5447                    n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) ==
5448                            n.bigContentView.getSequenceNumber();
5449            boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews &&
5450                    n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) ==
5451                            n.headsUpContentView.getSequenceNumber();
5452
5453            // Nothing to do here, no need to clone.
5454            if (!isLowRam
5455                    && !stripContentView && !stripBigContentView && !stripHeadsUpContentView) {
5456                return n;
5457            }
5458
5459            Notification clone = n.clone();
5460            if (stripContentView) {
5461                clone.contentView = null;
5462                clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT);
5463            }
5464            if (stripBigContentView) {
5465                clone.bigContentView = null;
5466                clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT);
5467            }
5468            if (stripHeadsUpContentView) {
5469                clone.headsUpContentView = null;
5470                clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT);
5471            }
5472            if (isLowRam) {
5473                clone.extras.remove(Notification.TvExtender.EXTRA_TV_EXTENDER);
5474                clone.extras.remove(WearableExtender.EXTRA_WEARABLE_EXTENSIONS);
5475                clone.extras.remove(CarExtender.EXTRA_CAR_EXTENDER);
5476            }
5477            return clone;
5478        }
5479
5480        private int getBaseLayoutResource() {
5481            return R.layout.notification_template_material_base;
5482        }
5483
5484        private int getBigBaseLayoutResource() {
5485            return R.layout.notification_template_material_big_base;
5486        }
5487
5488        private int getBigPictureLayoutResource() {
5489            return R.layout.notification_template_material_big_picture;
5490        }
5491
5492        private int getBigTextLayoutResource() {
5493            return R.layout.notification_template_material_big_text;
5494        }
5495
5496        private int getInboxLayoutResource() {
5497            return R.layout.notification_template_material_inbox;
5498        }
5499
5500        private int getMessagingLayoutResource() {
5501            return R.layout.notification_template_material_messaging;
5502        }
5503
5504        private int getActionLayoutResource() {
5505            return R.layout.notification_material_action;
5506        }
5507
5508        private int getEmphasizedActionLayoutResource() {
5509            return R.layout.notification_material_action_emphasized;
5510        }
5511
5512        private int getActionTombstoneLayoutResource() {
5513            return R.layout.notification_material_action_tombstone;
5514        }
5515
5516        private int getBackgroundColor() {
5517            if (isColorized()) {
5518                return mBackgroundColor != COLOR_INVALID ? mBackgroundColor : mN.color;
5519            } else {
5520                return mBackgroundColorHint != COLOR_INVALID ? mBackgroundColorHint
5521                        : COLOR_DEFAULT;
5522            }
5523        }
5524
5525        private boolean isColorized() {
5526            return mN.isColorized();
5527        }
5528
5529        private boolean shouldTintActionButtons() {
5530            return mTintActionButtons;
5531        }
5532
5533        private boolean textColorsNeedInversion() {
5534            if (mStyle == null || !MediaStyle.class.equals(mStyle.getClass())) {
5535                return false;
5536            }
5537            int targetSdkVersion = mContext.getApplicationInfo().targetSdkVersion;
5538            return targetSdkVersion > Build.VERSION_CODES.M
5539                    && targetSdkVersion < Build.VERSION_CODES.O;
5540        }
5541
5542        /**
5543         * Set a color palette to be used as the background and textColors
5544         *
5545         * @param backgroundColor the color to be used as the background
5546         * @param foregroundColor the color to be used as the foreground
5547         *
5548         * @hide
5549         */
5550        public void setColorPalette(int backgroundColor, int foregroundColor) {
5551            mBackgroundColor = backgroundColor;
5552            mForegroundColor = foregroundColor;
5553            mTextColorsAreForBackground = COLOR_INVALID;
5554            ensureColors();
5555        }
5556
5557        /**
5558         * Sets the background color for this notification to be a different one then the default.
5559         * This is mainly used to calculate contrast and won't necessarily be applied to the
5560         * background.
5561         *
5562         * @hide
5563         */
5564        public void setBackgroundColorHint(int backgroundColor) {
5565            mBackgroundColorHint = backgroundColor;
5566        }
5567
5568
5569        /**
5570         * Forces all styled remoteViews to be built from scratch and not use any cached
5571         * RemoteViews.
5572         * This is needed for legacy apps that are baking in their remoteviews into the
5573         * notification.
5574         *
5575         * @hide
5576         */
5577        public void setRebuildStyledRemoteViews(boolean rebuild) {
5578            mRebuildStyledRemoteViews = rebuild;
5579        }
5580
5581        /**
5582         * Get the text that should be displayed in the statusBar when heads upped. This is
5583         * usually just the app name, but may be different depending on the style.
5584         *
5585         * @param publicMode If true, return a text that is safe to display in public.
5586         *
5587         * @hide
5588         */
5589        public CharSequence getHeadsUpStatusBarText(boolean publicMode) {
5590            if (mStyle != null && !publicMode) {
5591                CharSequence text = mStyle.getHeadsUpStatusBarText();
5592                if (!TextUtils.isEmpty(text)) {
5593                    return text;
5594                }
5595            }
5596            return loadHeaderAppName();
5597        }
5598    }
5599
5600    /**
5601     * Reduces the image sizes to conform to a maximum allowed size. This also processes all custom
5602     * remote views.
5603     *
5604     * @hide
5605     */
5606    void reduceImageSizes(Context context) {
5607        if (extras.getBoolean(EXTRA_REDUCED_IMAGES)) {
5608            return;
5609        }
5610        boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
5611        if (mLargeIcon != null || largeIcon != null) {
5612            Resources resources = context.getResources();
5613            Class<? extends Style> style = getNotificationStyle();
5614            int maxWidth = resources.getDimensionPixelSize(isLowRam
5615                    ? R.dimen.notification_right_icon_size_low_ram
5616                    : R.dimen.notification_right_icon_size);
5617            int maxHeight = maxWidth;
5618            if (MediaStyle.class.equals(style)
5619                    || DecoratedMediaCustomViewStyle.class.equals(style)) {
5620                maxHeight = resources.getDimensionPixelSize(isLowRam
5621                        ? R.dimen.notification_media_image_max_height_low_ram
5622                        : R.dimen.notification_media_image_max_height);
5623                maxWidth = resources.getDimensionPixelSize(isLowRam
5624                        ? R.dimen.notification_media_image_max_width_low_ram
5625                        : R.dimen.notification_media_image_max_width);
5626            }
5627            if (mLargeIcon != null) {
5628                mLargeIcon.scaleDownIfNecessary(maxWidth, maxHeight);
5629            }
5630            if (largeIcon != null) {
5631                largeIcon = Icon.scaleDownIfNecessary(largeIcon, maxWidth, maxHeight);
5632            }
5633        }
5634        reduceImageSizesForRemoteView(contentView, context, isLowRam);
5635        reduceImageSizesForRemoteView(headsUpContentView, context, isLowRam);
5636        reduceImageSizesForRemoteView(bigContentView, context, isLowRam);
5637        extras.putBoolean(EXTRA_REDUCED_IMAGES, true);
5638    }
5639
5640    private void reduceImageSizesForRemoteView(RemoteViews remoteView, Context context,
5641            boolean isLowRam) {
5642        if (remoteView != null) {
5643            Resources resources = context.getResources();
5644            int maxWidth = resources.getDimensionPixelSize(isLowRam
5645                    ? R.dimen.notification_custom_view_max_image_width_low_ram
5646                    : R.dimen.notification_custom_view_max_image_width);
5647            int maxHeight = resources.getDimensionPixelSize(isLowRam
5648                    ? R.dimen.notification_custom_view_max_image_height_low_ram
5649                    : R.dimen.notification_custom_view_max_image_height);
5650            remoteView.reduceImageSizes(maxWidth, maxHeight);
5651        }
5652    }
5653
5654    /**
5655     * @return whether this notification is a foreground service notification
5656     */
5657    private boolean isForegroundService() {
5658        return (flags & Notification.FLAG_FOREGROUND_SERVICE) != 0;
5659    }
5660
5661    /**
5662     * @return whether this notification has a media session attached
5663     * @hide
5664     */
5665    public boolean hasMediaSession() {
5666        return extras.getParcelable(Notification.EXTRA_MEDIA_SESSION) != null;
5667    }
5668
5669    /**
5670     * @return the style class of this notification
5671     * @hide
5672     */
5673    public Class<? extends Notification.Style> getNotificationStyle() {
5674        String templateClass = extras.getString(Notification.EXTRA_TEMPLATE);
5675
5676        if (!TextUtils.isEmpty(templateClass)) {
5677            return Notification.getNotificationStyleClass(templateClass);
5678        }
5679        return null;
5680    }
5681
5682    /**
5683     * @return true if this notification is colorized.
5684     *
5685     * @hide
5686     */
5687    public boolean isColorized() {
5688        if (isColorizedMedia()) {
5689            return true;
5690        }
5691        return extras.getBoolean(EXTRA_COLORIZED)
5692                && (hasColorizedPermission() || isForegroundService());
5693    }
5694
5695    /**
5696     * Returns whether an app can colorize due to the android.permission.USE_COLORIZED_NOTIFICATIONS
5697     * permission. The permission is checked when a notification is enqueued.
5698     */
5699    private boolean hasColorizedPermission() {
5700        return (flags & Notification.FLAG_CAN_COLORIZE) != 0;
5701    }
5702
5703    /**
5704     * @return true if this notification is colorized and it is a media notification
5705     *
5706     * @hide
5707     */
5708    public boolean isColorizedMedia() {
5709        Class<? extends Style> style = getNotificationStyle();
5710        if (MediaStyle.class.equals(style)) {
5711            Boolean colorized = (Boolean) extras.get(EXTRA_COLORIZED);
5712            if ((colorized == null || colorized) && hasMediaSession()) {
5713                return true;
5714            }
5715        } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5716            if (extras.getBoolean(EXTRA_COLORIZED) && hasMediaSession()) {
5717                return true;
5718            }
5719        }
5720        return false;
5721    }
5722
5723
5724    /**
5725     * @return true if this is a media notification
5726     *
5727     * @hide
5728     */
5729    public boolean isMediaNotification() {
5730        Class<? extends Style> style = getNotificationStyle();
5731        if (MediaStyle.class.equals(style)) {
5732            return true;
5733        } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5734            return true;
5735        }
5736        return false;
5737    }
5738
5739    private boolean hasLargeIcon() {
5740        return mLargeIcon != null || largeIcon != null;
5741    }
5742
5743    /**
5744     * @return true if the notification will show the time; false otherwise
5745     * @hide
5746     */
5747    public boolean showsTime() {
5748        return when != 0 && extras.getBoolean(EXTRA_SHOW_WHEN);
5749    }
5750
5751    /**
5752     * @return true if the notification will show a chronometer; false otherwise
5753     * @hide
5754     */
5755    public boolean showsChronometer() {
5756        return when != 0 && extras.getBoolean(EXTRA_SHOW_CHRONOMETER);
5757    }
5758
5759    /**
5760     * @removed
5761     */
5762    @SystemApi
5763    public static Class<? extends Style> getNotificationStyleClass(String templateClass) {
5764        Class<? extends Style>[] classes = new Class[] {
5765                BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class,
5766                DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class,
5767                MessagingStyle.class };
5768        for (Class<? extends Style> innerClass : classes) {
5769            if (templateClass.equals(innerClass.getName())) {
5770                return innerClass;
5771            }
5772        }
5773        return null;
5774    }
5775
5776    /**
5777     * An object that can apply a rich notification style to a {@link Notification.Builder}
5778     * object.
5779     */
5780    public static abstract class Style {
5781        private CharSequence mBigContentTitle;
5782
5783        /**
5784         * @hide
5785         */
5786        protected CharSequence mSummaryText = null;
5787
5788        /**
5789         * @hide
5790         */
5791        protected boolean mSummaryTextSet = false;
5792
5793        protected Builder mBuilder;
5794
5795        /**
5796         * Overrides ContentTitle in the big form of the template.
5797         * This defaults to the value passed to setContentTitle().
5798         */
5799        protected void internalSetBigContentTitle(CharSequence title) {
5800            mBigContentTitle = title;
5801        }
5802
5803        /**
5804         * Set the first line of text after the detail section in the big form of the template.
5805         */
5806        protected void internalSetSummaryText(CharSequence cs) {
5807            mSummaryText = cs;
5808            mSummaryTextSet = true;
5809        }
5810
5811        public void setBuilder(Builder builder) {
5812            if (mBuilder != builder) {
5813                mBuilder = builder;
5814                if (mBuilder != null) {
5815                    mBuilder.setStyle(this);
5816                }
5817            }
5818        }
5819
5820        protected void checkBuilder() {
5821            if (mBuilder == null) {
5822                throw new IllegalArgumentException("Style requires a valid Builder object");
5823            }
5824        }
5825
5826        protected RemoteViews getStandardView(int layoutId) {
5827            checkBuilder();
5828
5829            // Nasty.
5830            CharSequence oldBuilderContentTitle =
5831                    mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE);
5832            if (mBigContentTitle != null) {
5833                mBuilder.setContentTitle(mBigContentTitle);
5834            }
5835
5836            RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId);
5837
5838            mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle);
5839
5840            if (mBigContentTitle != null && mBigContentTitle.equals("")) {
5841                contentView.setViewVisibility(R.id.line1, View.GONE);
5842            } else {
5843                contentView.setViewVisibility(R.id.line1, View.VISIBLE);
5844            }
5845
5846            return contentView;
5847        }
5848
5849        /**
5850         * Construct a Style-specific RemoteViews for the collapsed notification layout.
5851         * The default implementation has nothing additional to add.
5852         *
5853         * @param increasedHeight true if this layout be created with an increased height.
5854         * @hide
5855         */
5856        public RemoteViews makeContentView(boolean increasedHeight) {
5857            return null;
5858        }
5859
5860        /**
5861         * Construct a Style-specific RemoteViews for the final big notification layout.
5862         * @hide
5863         */
5864        public RemoteViews makeBigContentView() {
5865            return null;
5866        }
5867
5868        /**
5869         * Construct a Style-specific RemoteViews for the final HUN layout.
5870         *
5871         * @param increasedHeight true if this layout be created with an increased height.
5872         * @hide
5873         */
5874        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
5875            return null;
5876        }
5877
5878        /**
5879         * Apply any style-specific extras to this notification before shipping it out.
5880         * @hide
5881         */
5882        public void addExtras(Bundle extras) {
5883            if (mSummaryTextSet) {
5884                extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
5885            }
5886            if (mBigContentTitle != null) {
5887                extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
5888            }
5889            extras.putString(EXTRA_TEMPLATE, this.getClass().getName());
5890        }
5891
5892        /**
5893         * Reconstruct the internal state of this Style object from extras.
5894         * @hide
5895         */
5896        protected void restoreFromExtras(Bundle extras) {
5897            if (extras.containsKey(EXTRA_SUMMARY_TEXT)) {
5898                mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT);
5899                mSummaryTextSet = true;
5900            }
5901            if (extras.containsKey(EXTRA_TITLE_BIG)) {
5902                mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG);
5903            }
5904        }
5905
5906
5907        /**
5908         * @hide
5909         */
5910        public Notification buildStyled(Notification wip) {
5911            addExtras(wip.extras);
5912            return wip;
5913        }
5914
5915        /**
5916         * @hide
5917         */
5918        public void purgeResources() {}
5919
5920        /**
5921         * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is
5922         * attached to.
5923         *
5924         * @return the fully constructed Notification.
5925         */
5926        public Notification build() {
5927            checkBuilder();
5928            return mBuilder.build();
5929        }
5930
5931        /**
5932         * @hide
5933         * @return true if the style positions the progress bar on the second line; false if the
5934         *         style hides the progress bar
5935         */
5936        protected boolean hasProgress() {
5937            return true;
5938        }
5939
5940        /**
5941         * @hide
5942         * @return Whether we should put the summary be put into the notification header
5943         */
5944        public boolean hasSummaryInHeader() {
5945            return true;
5946        }
5947
5948        /**
5949         * @hide
5950         * @return Whether custom content views are displayed inline in the style
5951         */
5952        public boolean displayCustomViewInline() {
5953            return false;
5954        }
5955
5956        /**
5957         * Reduces the image sizes contained in this style.
5958         *
5959         * @hide
5960         */
5961        public void reduceImageSizes(Context context) {
5962        }
5963
5964        /**
5965         * Validate that this style was properly composed. This is called at build time.
5966         * @hide
5967         */
5968        public void validate(Context context) {
5969        }
5970
5971        /**
5972         * @hide
5973         */
5974        public abstract boolean areNotificationsVisiblyDifferent(Style other);
5975
5976        /**
5977         * @return the the text that should be displayed in the statusBar when heads-upped.
5978         * If {@code null} is returned, the default implementation will be used.
5979         *
5980         * @hide
5981         */
5982        public CharSequence getHeadsUpStatusBarText() {
5983            return null;
5984        }
5985    }
5986
5987    /**
5988     * Helper class for generating large-format notifications that include a large image attachment.
5989     *
5990     * Here's how you'd set the <code>BigPictureStyle</code> on a notification:
5991     * <pre class="prettyprint">
5992     * Notification notif = new Notification.Builder(mContext)
5993     *     .setContentTitle(&quot;New photo from &quot; + sender.toString())
5994     *     .setContentText(subject)
5995     *     .setSmallIcon(R.drawable.new_post)
5996     *     .setLargeIcon(aBitmap)
5997     *     .setStyle(new Notification.BigPictureStyle()
5998     *         .bigPicture(aBigBitmap))
5999     *     .build();
6000     * </pre>
6001     *
6002     * @see Notification#bigContentView
6003     */
6004    public static class BigPictureStyle extends Style {
6005        private Bitmap mPicture;
6006        private Icon mBigLargeIcon;
6007        private boolean mBigLargeIconSet = false;
6008
6009        public BigPictureStyle() {
6010        }
6011
6012        /**
6013         * @deprecated use {@code BigPictureStyle()}.
6014         */
6015        @Deprecated
6016        public BigPictureStyle(Builder builder) {
6017            setBuilder(builder);
6018        }
6019
6020        /**
6021         * Overrides ContentTitle in the big form of the template.
6022         * This defaults to the value passed to setContentTitle().
6023         */
6024        public BigPictureStyle setBigContentTitle(CharSequence title) {
6025            internalSetBigContentTitle(safeCharSequence(title));
6026            return this;
6027        }
6028
6029        /**
6030         * Set the first line of text after the detail section in the big form of the template.
6031         */
6032        public BigPictureStyle setSummaryText(CharSequence cs) {
6033            internalSetSummaryText(safeCharSequence(cs));
6034            return this;
6035        }
6036
6037        /**
6038         * @hide
6039         */
6040        public Bitmap getBigPicture() {
6041            return mPicture;
6042        }
6043
6044        /**
6045         * Provide the bitmap to be used as the payload for the BigPicture notification.
6046         */
6047        public BigPictureStyle bigPicture(Bitmap b) {
6048            mPicture = b;
6049            return this;
6050        }
6051
6052        /**
6053         * Override the large icon when the big notification is shown.
6054         */
6055        public BigPictureStyle bigLargeIcon(Bitmap b) {
6056            return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
6057        }
6058
6059        /**
6060         * Override the large icon when the big notification is shown.
6061         */
6062        public BigPictureStyle bigLargeIcon(Icon icon) {
6063            mBigLargeIconSet = true;
6064            mBigLargeIcon = icon;
6065            return this;
6066        }
6067
6068        /** @hide */
6069        public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10);
6070
6071        /**
6072         * @hide
6073         */
6074        @Override
6075        public void purgeResources() {
6076            super.purgeResources();
6077            if (mPicture != null &&
6078                mPicture.isMutable() &&
6079                mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) {
6080                mPicture = mPicture.createAshmemBitmap();
6081            }
6082            if (mBigLargeIcon != null) {
6083                mBigLargeIcon.convertToAshmem();
6084            }
6085        }
6086
6087        /**
6088         * @hide
6089         */
6090        @Override
6091        public void reduceImageSizes(Context context) {
6092            super.reduceImageSizes(context);
6093            Resources resources = context.getResources();
6094            boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
6095            if (mPicture != null) {
6096                int maxPictureWidth = resources.getDimensionPixelSize(isLowRam
6097                        ? R.dimen.notification_big_picture_max_height_low_ram
6098                        : R.dimen.notification_big_picture_max_height);
6099                int maxPictureHeight = resources.getDimensionPixelSize(isLowRam
6100                        ? R.dimen.notification_big_picture_max_width_low_ram
6101                        : R.dimen.notification_big_picture_max_width);
6102                mPicture = Icon.scaleDownIfNecessary(mPicture, maxPictureWidth, maxPictureHeight);
6103            }
6104            if (mBigLargeIcon != null) {
6105                int rightIconSize = resources.getDimensionPixelSize(isLowRam
6106                        ? R.dimen.notification_right_icon_size_low_ram
6107                        : R.dimen.notification_right_icon_size);
6108                mBigLargeIcon.scaleDownIfNecessary(rightIconSize, rightIconSize);
6109            }
6110        }
6111
6112        /**
6113         * @hide
6114         */
6115        public RemoteViews makeBigContentView() {
6116            // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet
6117            // This covers the following cases:
6118            //   1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides
6119            //          mN.mLargeIcon
6120            //   2. !mBigLargeIconSet -> mN.mLargeIcon applies
6121            Icon oldLargeIcon = null;
6122            Bitmap largeIconLegacy = null;
6123            if (mBigLargeIconSet) {
6124                oldLargeIcon = mBuilder.mN.mLargeIcon;
6125                mBuilder.mN.mLargeIcon = mBigLargeIcon;
6126                // The legacy largeIcon might not allow us to clear the image, as it's taken in
6127                // replacement if the other one is null. Because we're restoring these legacy icons
6128                // for old listeners, this is in general non-null.
6129                largeIconLegacy = mBuilder.mN.largeIcon;
6130                mBuilder.mN.largeIcon = null;
6131            }
6132
6133            RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource());
6134            if (mSummaryTextSet) {
6135                contentView.setTextViewText(R.id.text, mBuilder.processTextSpans(
6136                        mBuilder.processLegacyText(mSummaryText)));
6137                mBuilder.setTextViewColorSecondary(contentView, R.id.text);
6138                contentView.setViewVisibility(R.id.text, View.VISIBLE);
6139            }
6140            mBuilder.setContentMinHeight(contentView, mBuilder.mN.hasLargeIcon());
6141
6142            if (mBigLargeIconSet) {
6143                mBuilder.mN.mLargeIcon = oldLargeIcon;
6144                mBuilder.mN.largeIcon = largeIconLegacy;
6145            }
6146
6147            contentView.setImageViewBitmap(R.id.big_picture, mPicture);
6148            return contentView;
6149        }
6150
6151        /**
6152         * @hide
6153         */
6154        public void addExtras(Bundle extras) {
6155            super.addExtras(extras);
6156
6157            if (mBigLargeIconSet) {
6158                extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
6159            }
6160            extras.putParcelable(EXTRA_PICTURE, mPicture);
6161        }
6162
6163        /**
6164         * @hide
6165         */
6166        @Override
6167        protected void restoreFromExtras(Bundle extras) {
6168            super.restoreFromExtras(extras);
6169
6170            if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) {
6171                mBigLargeIconSet = true;
6172                mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG);
6173            }
6174            mPicture = extras.getParcelable(EXTRA_PICTURE);
6175        }
6176
6177        /**
6178         * @hide
6179         */
6180        @Override
6181        public boolean hasSummaryInHeader() {
6182            return false;
6183        }
6184
6185        /**
6186         * @hide
6187         */
6188        @Override
6189        public boolean areNotificationsVisiblyDifferent(Style other) {
6190            if (other == null || getClass() != other.getClass()) {
6191                return true;
6192            }
6193            BigPictureStyle otherS = (BigPictureStyle) other;
6194            return !Objects.equals(getBigPicture(), otherS.getBigPicture());
6195        }
6196    }
6197
6198    /**
6199     * Helper class for generating large-format notifications that include a lot of text.
6200     *
6201     * Here's how you'd set the <code>BigTextStyle</code> on a notification:
6202     * <pre class="prettyprint">
6203     * Notification notif = new Notification.Builder(mContext)
6204     *     .setContentTitle(&quot;New mail from &quot; + sender.toString())
6205     *     .setContentText(subject)
6206     *     .setSmallIcon(R.drawable.new_mail)
6207     *     .setLargeIcon(aBitmap)
6208     *     .setStyle(new Notification.BigTextStyle()
6209     *         .bigText(aVeryLongString))
6210     *     .build();
6211     * </pre>
6212     *
6213     * @see Notification#bigContentView
6214     */
6215    public static class BigTextStyle extends Style {
6216
6217        private CharSequence mBigText;
6218
6219        public BigTextStyle() {
6220        }
6221
6222        /**
6223         * @deprecated use {@code BigTextStyle()}.
6224         */
6225        @Deprecated
6226        public BigTextStyle(Builder builder) {
6227            setBuilder(builder);
6228        }
6229
6230        /**
6231         * Overrides ContentTitle in the big form of the template.
6232         * This defaults to the value passed to setContentTitle().
6233         */
6234        public BigTextStyle setBigContentTitle(CharSequence title) {
6235            internalSetBigContentTitle(safeCharSequence(title));
6236            return this;
6237        }
6238
6239        /**
6240         * Set the first line of text after the detail section in the big form of the template.
6241         */
6242        public BigTextStyle setSummaryText(CharSequence cs) {
6243            internalSetSummaryText(safeCharSequence(cs));
6244            return this;
6245        }
6246
6247        /**
6248         * Provide the longer text to be displayed in the big form of the
6249         * template in place of the content text.
6250         */
6251        public BigTextStyle bigText(CharSequence cs) {
6252            mBigText = safeCharSequence(cs);
6253            return this;
6254        }
6255
6256        /**
6257         * @hide
6258         */
6259        public CharSequence getBigText() {
6260            return mBigText;
6261        }
6262
6263        /**
6264         * @hide
6265         */
6266        public void addExtras(Bundle extras) {
6267            super.addExtras(extras);
6268
6269            extras.putCharSequence(EXTRA_BIG_TEXT, mBigText);
6270        }
6271
6272        /**
6273         * @hide
6274         */
6275        @Override
6276        protected void restoreFromExtras(Bundle extras) {
6277            super.restoreFromExtras(extras);
6278
6279            mBigText = extras.getCharSequence(EXTRA_BIG_TEXT);
6280        }
6281
6282        /**
6283         * @param increasedHeight true if this layout be created with an increased height.
6284         *
6285         * @hide
6286         */
6287        @Override
6288        public RemoteViews makeContentView(boolean increasedHeight) {
6289            if (increasedHeight) {
6290                mBuilder.mOriginalActions = mBuilder.mActions;
6291                mBuilder.mActions = new ArrayList<>();
6292                RemoteViews remoteViews = makeBigContentView();
6293                mBuilder.mActions = mBuilder.mOriginalActions;
6294                mBuilder.mOriginalActions = null;
6295                return remoteViews;
6296            }
6297            return super.makeContentView(increasedHeight);
6298        }
6299
6300        /**
6301         * @hide
6302         */
6303        @Override
6304        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
6305            if (increasedHeight && mBuilder.mActions.size() > 0) {
6306                return makeBigContentView();
6307            }
6308            return super.makeHeadsUpContentView(increasedHeight);
6309        }
6310
6311        /**
6312         * @hide
6313         */
6314        public RemoteViews makeBigContentView() {
6315
6316            // Nasty
6317            CharSequence text = mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT);
6318            mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
6319
6320            RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource());
6321
6322            mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, text);
6323
6324            CharSequence bigTextText = mBuilder.processLegacyText(mBigText);
6325            if (TextUtils.isEmpty(bigTextText)) {
6326                // In case the bigtext is null / empty fall back to the normal text to avoid a weird
6327                // experience
6328                bigTextText = mBuilder.processLegacyText(text);
6329            }
6330            applyBigTextContentView(mBuilder, contentView, bigTextText);
6331
6332            return contentView;
6333        }
6334
6335        /**
6336         * @hide
6337         */
6338        @Override
6339        public boolean areNotificationsVisiblyDifferent(Style other) {
6340            if (other == null || getClass() != other.getClass()) {
6341                return true;
6342            }
6343            BigTextStyle newS = (BigTextStyle) other;
6344            return !Objects.equals(getBigText(), newS.getBigText());
6345        }
6346
6347        static void applyBigTextContentView(Builder builder,
6348                RemoteViews contentView, CharSequence bigTextText) {
6349            contentView.setTextViewText(R.id.big_text, builder.processTextSpans(bigTextText));
6350            builder.setTextViewColorSecondary(contentView, R.id.big_text);
6351            contentView.setViewVisibility(R.id.big_text,
6352                    TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE);
6353            contentView.setBoolean(R.id.big_text, "setHasImage", builder.mN.hasLargeIcon());
6354        }
6355    }
6356
6357    /**
6358     * Helper class for generating large-format notifications that include multiple back-and-forth
6359     * messages of varying types between any number of people.
6360     *
6361     * <br>
6362     * If the platform does not provide large-format notifications, this method has no effect. The
6363     * user will always see the normal notification view.
6364     * <br>
6365     * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like
6366     * so:
6367     * <pre class="prettyprint">
6368     *
6369     * Notification noti = new Notification.Builder()
6370     *     .setContentTitle(&quot;2 new messages wtih &quot; + sender.toString())
6371     *     .setContentText(subject)
6372     *     .setSmallIcon(R.drawable.new_message)
6373     *     .setLargeIcon(aBitmap)
6374     *     .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name))
6375     *         .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender())
6376     *         .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender()))
6377     *     .build();
6378     * </pre>
6379     */
6380    public static class MessagingStyle extends Style {
6381
6382        /**
6383         * The maximum number of messages that will be retained in the Notification itself (the
6384         * number displayed is up to the platform).
6385         */
6386        public static final int MAXIMUM_RETAINED_MESSAGES = 25;
6387
6388        @NonNull Person mUser;
6389        @Nullable CharSequence mConversationTitle;
6390        List<Message> mMessages = new ArrayList<>();
6391        List<Message> mHistoricMessages = new ArrayList<>();
6392        boolean mIsGroupConversation;
6393
6394        MessagingStyle() {
6395        }
6396
6397        /**
6398         * @param userDisplayName Required - the name to be displayed for any replies sent by the
6399         * user before the posting app reposts the notification with those messages after they've
6400         * been actually sent and in previous messages sent by the user added in
6401         * {@link #addMessage(Notification.MessagingStyle.Message)}
6402         *
6403         * @deprecated use {@code MessagingStyle(Person)}
6404         */
6405        public MessagingStyle(@NonNull CharSequence userDisplayName) {
6406            this(new Person().setName(userDisplayName));
6407        }
6408
6409        /**
6410         * @param user Required - The person displayed for any messages that are sent by the
6411         * user. Any messages added with {@link #addMessage(Notification.MessagingStyle.Message)}
6412         * who don't have a Person associated with it will be displayed as if they were sent
6413         * by this user. The user also needs to have a valid name associated with it, which will
6414         * be enforced starting in Android P.
6415         */
6416        public MessagingStyle(@NonNull Person user) {
6417            mUser = user;
6418        }
6419
6420        /**
6421         * Validate that this style was properly composed. This is called at build time.
6422         * @hide
6423         */
6424        @Override
6425        public void validate(Context context) {
6426            super.validate(context);
6427            if (context.getApplicationInfo().targetSdkVersion
6428                    >= Build.VERSION_CODES.P && (mUser == null || mUser.getName() == null)) {
6429                throw new RuntimeException("User must be valid and have a name.");
6430            }
6431        }
6432
6433        /**
6434         * @return the the text that should be displayed in the statusBar when heads upped.
6435         * If {@code null} is returned, the default implementation will be used.
6436         *
6437         * @hide
6438         */
6439        @Override
6440        public CharSequence getHeadsUpStatusBarText() {
6441            CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
6442                    ? super.mBigContentTitle
6443                    : mConversationTitle;
6444            if (!TextUtils.isEmpty(conversationTitle) && !hasOnlyWhiteSpaceSenders()) {
6445                return conversationTitle;
6446            }
6447            return null;
6448        }
6449
6450        /**
6451         * @return the user to be displayed for any replies sent by the user
6452         */
6453        public Person getUser() {
6454            return mUser;
6455        }
6456
6457        /**
6458         * Returns the name to be displayed for any replies sent by the user
6459         *
6460         * @deprecated use {@link #getUser()} instead
6461         */
6462        public CharSequence getUserDisplayName() {
6463            return mUser.getName();
6464        }
6465
6466        /**
6467         * Sets the title to be displayed on this conversation. May be set to {@code null}.
6468         *
6469         * <p>This API's behavior was changed in SDK version {@link Build.VERSION_CODES#P}. If your
6470         * application's target version is less than {@link Build.VERSION_CODES#P}, setting a
6471         * conversation title to a non-null value will make {@link #isGroupConversation()} return
6472         * {@code true} and passing {@code null} will make it return {@code false}. In
6473         * {@link Build.VERSION_CODES#P} and beyond, use {@link #setGroupConversation(boolean)}
6474         * to set group conversation status.
6475         *
6476         * @param conversationTitle Title displayed for this conversation
6477         * @return this object for method chaining
6478         */
6479        public MessagingStyle setConversationTitle(@Nullable CharSequence conversationTitle) {
6480            mConversationTitle = conversationTitle;
6481            return this;
6482        }
6483
6484        /**
6485         * Return the title to be displayed on this conversation. May return {@code null}.
6486         */
6487        @Nullable
6488        public CharSequence getConversationTitle() {
6489            return mConversationTitle;
6490        }
6491
6492        /**
6493         * Adds a message for display by this notification. Convenience call for a simple
6494         * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6495         * @param text A {@link CharSequence} to be displayed as the message content
6496         * @param timestamp Time at which the message arrived
6497         * @param sender A {@link CharSequence} to be used for displaying the name of the
6498         * sender. Should be <code>null</code> for messages by the current user, in which case
6499         * the platform will insert {@link #getUserDisplayName()}.
6500         * Should be unique amongst all individuals in the conversation, and should be
6501         * consistent during re-posts of the notification.
6502         *
6503         * @see Message#Message(CharSequence, long, CharSequence)
6504         *
6505         * @return this object for method chaining
6506         *
6507         * @deprecated use {@link #addMessage(CharSequence, long, Person)}
6508         */
6509        public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) {
6510            return addMessage(text, timestamp,
6511                    sender == null ? null : new Person().setName(sender));
6512        }
6513
6514        /**
6515         * Adds a message for display by this notification. Convenience call for a simple
6516         * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6517         * @param text A {@link CharSequence} to be displayed as the message content
6518         * @param timestamp Time at which the message arrived
6519         * @param sender The {@link Person} who sent the message.
6520         * Should be <code>null</code> for messages by the current user, in which case
6521         * the platform will insert the user set in {@code MessagingStyle(Person)}.
6522         *
6523         * @see Message#Message(CharSequence, long, CharSequence)
6524         *
6525         * @return this object for method chaining
6526         */
6527        public MessagingStyle addMessage(CharSequence text, long timestamp, Person sender) {
6528            return addMessage(new Message(text, timestamp, sender));
6529        }
6530
6531        /**
6532         * Adds a {@link Message} for display in this notification.
6533         *
6534         * <p>The messages should be added in chronologic order, i.e. the oldest first,
6535         * the newest last.
6536         *
6537         * @param message The {@link Message} to be displayed
6538         * @return this object for method chaining
6539         */
6540        public MessagingStyle addMessage(Message message) {
6541            mMessages.add(message);
6542            if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6543                mMessages.remove(0);
6544            }
6545            return this;
6546        }
6547
6548        /**
6549         * Adds a {@link Message} for historic context in this notification.
6550         *
6551         * <p>Messages should be added as historic if they are not the main subject of the
6552         * notification but may give context to a conversation. The system may choose to present
6553         * them only when relevant, e.g. when replying to a message through a {@link RemoteInput}.
6554         *
6555         * <p>The messages should be added in chronologic order, i.e. the oldest first,
6556         * the newest last.
6557         *
6558         * @param message The historic {@link Message} to be added
6559         * @return this object for method chaining
6560         */
6561        public MessagingStyle addHistoricMessage(Message message) {
6562            mHistoricMessages.add(message);
6563            if (mHistoricMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6564                mHistoricMessages.remove(0);
6565            }
6566            return this;
6567        }
6568
6569        /**
6570         * Gets the list of {@code Message} objects that represent the notification
6571         */
6572        public List<Message> getMessages() {
6573            return mMessages;
6574        }
6575
6576        /**
6577         * Gets the list of historic {@code Message}s in the notification.
6578         */
6579        public List<Message> getHistoricMessages() {
6580            return mHistoricMessages;
6581        }
6582
6583        /**
6584         * Sets whether this conversation notification represents a group.
6585         *
6586         * @param isGroupConversation {@code true} if the conversation represents a group,
6587         * {@code false} otherwise.
6588         * @return this object for method chaining
6589         */
6590        public MessagingStyle setGroupConversation(boolean isGroupConversation) {
6591            mIsGroupConversation = isGroupConversation;
6592            return this;
6593        }
6594
6595        /**
6596         * Returns {@code true} if this notification represents a group conversation, otherwise
6597         * {@code false}.
6598         *
6599         * <p> If the application that generated this {@link MessagingStyle} targets an SDK version
6600         * less than {@link Build.VERSION_CODES#P}, this method becomes dependent on whether or
6601         * not the conversation title is set; returning {@code true} if the conversation title is
6602         * a non-null value, or {@code false} otherwise. From {@link Build.VERSION_CODES#P} forward,
6603         * this method returns what's set by {@link #setGroupConversation(boolean)} allowing for
6604         * named, non-group conversations.
6605         *
6606         * @see #setConversationTitle(CharSequence)
6607         */
6608        public boolean isGroupConversation() {
6609            // When target SDK version is < P, a non-null conversation title dictates if this is
6610            // as group conversation.
6611            if (mBuilder != null
6612                    && mBuilder.mContext.getApplicationInfo().targetSdkVersion
6613                            < Build.VERSION_CODES.P) {
6614                return mConversationTitle != null;
6615            }
6616
6617            return mIsGroupConversation;
6618        }
6619
6620        /**
6621         * @hide
6622         */
6623        @Override
6624        public void addExtras(Bundle extras) {
6625            super.addExtras(extras);
6626            if (mUser != null) {
6627                // For legacy usages
6628                extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUser.getName());
6629                extras.putParcelable(EXTRA_MESSAGING_PERSON, mUser);
6630            }
6631            if (mConversationTitle != null) {
6632                extras.putCharSequence(EXTRA_CONVERSATION_TITLE, mConversationTitle);
6633            }
6634            if (!mMessages.isEmpty()) { extras.putParcelableArray(EXTRA_MESSAGES,
6635                    Message.getBundleArrayForMessages(mMessages));
6636            }
6637            if (!mHistoricMessages.isEmpty()) { extras.putParcelableArray(EXTRA_HISTORIC_MESSAGES,
6638                    Message.getBundleArrayForMessages(mHistoricMessages));
6639            }
6640
6641            fixTitleAndTextExtras(extras);
6642            extras.putBoolean(EXTRA_IS_GROUP_CONVERSATION, mIsGroupConversation);
6643        }
6644
6645        private void fixTitleAndTextExtras(Bundle extras) {
6646            Message m = findLatestIncomingMessage();
6647            CharSequence text = (m == null) ? null : m.mText;
6648            CharSequence sender = m == null ? null
6649                    : m.mSender == null || TextUtils.isEmpty(m.mSender.getName())
6650                            ? mUser.getName() : m.mSender.getName();
6651            CharSequence title;
6652            if (!TextUtils.isEmpty(mConversationTitle)) {
6653                if (!TextUtils.isEmpty(sender)) {
6654                    BidiFormatter bidi = BidiFormatter.getInstance();
6655                    title = mBuilder.mContext.getString(
6656                            com.android.internal.R.string.notification_messaging_title_template,
6657                            bidi.unicodeWrap(mConversationTitle), bidi.unicodeWrap(sender));
6658                } else {
6659                    title = mConversationTitle;
6660                }
6661            } else {
6662                title = sender;
6663            }
6664
6665            if (title != null) {
6666                extras.putCharSequence(EXTRA_TITLE, title);
6667            }
6668            if (text != null) {
6669                extras.putCharSequence(EXTRA_TEXT, text);
6670            }
6671        }
6672
6673        /**
6674         * @hide
6675         */
6676        @Override
6677        protected void restoreFromExtras(Bundle extras) {
6678            super.restoreFromExtras(extras);
6679
6680            mUser = extras.getParcelable(EXTRA_MESSAGING_PERSON);
6681            if (mUser == null) {
6682                CharSequence displayName = extras.getCharSequence(EXTRA_SELF_DISPLAY_NAME);
6683                mUser = new Person().setName(displayName);
6684            }
6685            mConversationTitle = extras.getCharSequence(EXTRA_CONVERSATION_TITLE);
6686            Parcelable[] messages = extras.getParcelableArray(EXTRA_MESSAGES);
6687            mMessages = Message.getMessagesFromBundleArray(messages);
6688            Parcelable[] histMessages = extras.getParcelableArray(EXTRA_HISTORIC_MESSAGES);
6689            mHistoricMessages = Message.getMessagesFromBundleArray(histMessages);
6690            mIsGroupConversation = extras.getBoolean(EXTRA_IS_GROUP_CONVERSATION);
6691        }
6692
6693        /**
6694         * @hide
6695         */
6696        @Override
6697        public RemoteViews makeContentView(boolean increasedHeight) {
6698            mBuilder.mOriginalActions = mBuilder.mActions;
6699            mBuilder.mActions = new ArrayList<>();
6700            RemoteViews remoteViews = makeMessagingView(true /* isCollapsed */);
6701            mBuilder.mActions = mBuilder.mOriginalActions;
6702            mBuilder.mOriginalActions = null;
6703            return remoteViews;
6704        }
6705
6706        /**
6707         * @hide
6708         */
6709        @Override
6710        public boolean areNotificationsVisiblyDifferent(Style other) {
6711            if (other == null || getClass() != other.getClass()) {
6712                return true;
6713            }
6714            MessagingStyle newS = (MessagingStyle) other;
6715            List<MessagingStyle.Message> oldMs = getMessages();
6716            List<MessagingStyle.Message> newMs = newS.getMessages();
6717
6718            if (oldMs == null) {
6719                oldMs = new ArrayList<>();
6720            }
6721            if (newMs == null) {
6722                newMs = new ArrayList<>();
6723            }
6724
6725            int n = oldMs.size();
6726            if (n != newMs.size()) {
6727                return true;
6728            }
6729            for (int i = 0; i < n; i++) {
6730                MessagingStyle.Message oldM = oldMs.get(i);
6731                MessagingStyle.Message newM = newMs.get(i);
6732                if (!Objects.equals(oldM.getText(), newM.getText())) {
6733                    return true;
6734                }
6735                if (!Objects.equals(oldM.getDataUri(), newM.getDataUri())) {
6736                    return true;
6737                }
6738                CharSequence oldSender = oldM.getSenderPerson() == null ? oldM.getSender()
6739                        : oldM.getSenderPerson().getName();
6740                CharSequence newSender = newM.getSenderPerson() == null ? newM.getSender()
6741                        : newM.getSenderPerson().getName();
6742                if (!Objects.equals(oldSender, newSender)) {
6743                    return true;
6744                }
6745
6746                String oldKey = oldM.getSenderPerson() == null
6747                        ? null : oldM.getSenderPerson().getKey();
6748                String newKey = newM.getSenderPerson() == null
6749                        ? null : newM.getSenderPerson().getKey();
6750                if (!Objects.equals(oldKey, newKey)) {
6751                    return true;
6752                }
6753                // Other fields (like timestamp) intentionally excluded
6754            }
6755            return false;
6756        }
6757
6758        private Message findLatestIncomingMessage() {
6759            return findLatestIncomingMessage(mMessages);
6760        }
6761
6762        /**
6763         * @hide
6764         */
6765        @Nullable
6766        public static Message findLatestIncomingMessage(
6767                List<Message> messages) {
6768            for (int i = messages.size() - 1; i >= 0; i--) {
6769                Message m = messages.get(i);
6770                // Incoming messages have a non-empty sender.
6771                if (m.mSender != null && !TextUtils.isEmpty(m.mSender.getName())) {
6772                    return m;
6773                }
6774            }
6775            if (!messages.isEmpty()) {
6776                // No incoming messages, fall back to outgoing message
6777                return messages.get(messages.size() - 1);
6778            }
6779            return null;
6780        }
6781
6782        /**
6783         * @hide
6784         */
6785        @Override
6786        public RemoteViews makeBigContentView() {
6787            return makeMessagingView(false /* isCollapsed */);
6788        }
6789
6790        @NonNull
6791        private RemoteViews makeMessagingView(boolean isCollapsed) {
6792            CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
6793                    ? super.mBigContentTitle
6794                    : mConversationTitle;
6795            boolean isOneToOne = TextUtils.isEmpty(conversationTitle);
6796            CharSequence nameReplacement = null;
6797            if (hasOnlyWhiteSpaceSenders()) {
6798                isOneToOne = true;
6799                nameReplacement = conversationTitle;
6800                conversationTitle = null;
6801            }
6802            boolean hideLargeIcon = !isCollapsed || isOneToOne;
6803            RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
6804                    mBuilder.getMessagingLayoutResource(),
6805                    mBuilder.mParams.reset().hasProgress(false).title(conversationTitle).text(null)
6806                            .hideLargeIcon(hideLargeIcon)
6807                            .headerTextSecondary(conversationTitle)
6808                            .alwaysShowReply(isCollapsed));
6809            addExtras(mBuilder.mN.extras);
6810            // also update the end margin if there is an image
6811            int endMargin = R.dimen.notification_content_margin_end;
6812            if (isCollapsed) {
6813                endMargin = R.dimen.notification_content_plus_picture_margin_end;
6814            }
6815            contentView.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
6816            contentView.setInt(R.id.status_bar_latest_event_content, "setLayoutColor",
6817                    mBuilder.resolveContrastColor());
6818            contentView.setBoolean(R.id.status_bar_latest_event_content, "setIsCollapsed",
6819                    isCollapsed);
6820            contentView.setIcon(R.id.status_bar_latest_event_content, "setLargeIcon",
6821                    mBuilder.mN.mLargeIcon);
6822            contentView.setCharSequence(R.id.status_bar_latest_event_content, "setNameReplacement",
6823                    nameReplacement);
6824            contentView.setBoolean(R.id.status_bar_latest_event_content, "setIsOneToOne",
6825                    isOneToOne);
6826            contentView.setBundle(R.id.status_bar_latest_event_content, "setData",
6827                    mBuilder.mN.extras);
6828            return contentView;
6829        }
6830
6831        private boolean hasOnlyWhiteSpaceSenders() {
6832            for (int i = 0; i < mMessages.size(); i++) {
6833                Message m = mMessages.get(i);
6834                Person sender = m.getSenderPerson();
6835                if (sender != null && !isWhiteSpace(sender.getName())) {
6836                    return false;
6837                }
6838            }
6839            return true;
6840        }
6841
6842        private boolean isWhiteSpace(CharSequence sender) {
6843            if (TextUtils.isEmpty(sender)) {
6844                return true;
6845            }
6846            if (sender.toString().matches("^\\s*$")) {
6847                return true;
6848            }
6849            // Let's check if we only have 0 whitespace chars. Some apps did this as a workaround
6850            // For the presentation that we had.
6851            for (int i = 0; i < sender.length(); i++) {
6852                char c = sender.charAt(i);
6853                if (c != '\u200B') {
6854                    return false;
6855                }
6856            }
6857            return true;
6858        }
6859
6860        private CharSequence createConversationTitleFromMessages() {
6861            ArraySet<CharSequence> names = new ArraySet<>();
6862            for (int i = 0; i < mMessages.size(); i++) {
6863                Message m = mMessages.get(i);
6864                Person sender = m.getSenderPerson();
6865                if (sender != null) {
6866                    names.add(sender.getName());
6867                }
6868            }
6869            SpannableStringBuilder title = new SpannableStringBuilder();
6870            int size = names.size();
6871            for (int i = 0; i < size; i++) {
6872                CharSequence name = names.valueAt(i);
6873                if (!TextUtils.isEmpty(title)) {
6874                    title.append(", ");
6875                }
6876                title.append(BidiFormatter.getInstance().unicodeWrap(name));
6877            }
6878            return title;
6879        }
6880
6881        /**
6882         * @hide
6883         */
6884        @Override
6885        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
6886            RemoteViews remoteViews = makeMessagingView(true /* isCollapsed */);
6887            remoteViews.setInt(R.id.notification_messaging, "setMaxDisplayedLines", 1);
6888            return remoteViews;
6889        }
6890
6891        private static TextAppearanceSpan makeFontColorSpan(int color) {
6892            return new TextAppearanceSpan(null, 0, 0,
6893                    ColorStateList.valueOf(color), null);
6894        }
6895
6896        public static final class Message {
6897
6898            static final String KEY_TEXT = "text";
6899            static final String KEY_TIMESTAMP = "time";
6900            static final String KEY_SENDER = "sender";
6901            static final String KEY_SENDER_PERSON = "sender_person";
6902            static final String KEY_DATA_MIME_TYPE = "type";
6903            static final String KEY_DATA_URI= "uri";
6904            static final String KEY_EXTRAS_BUNDLE = "extras";
6905
6906            private final CharSequence mText;
6907            private final long mTimestamp;
6908            @Nullable
6909            private final Person mSender;
6910
6911            private Bundle mExtras = new Bundle();
6912            private String mDataMimeType;
6913            private Uri mDataUri;
6914
6915            /**
6916             * Constructor
6917             * @param text A {@link CharSequence} to be displayed as the message content
6918             * @param timestamp Time at which the message arrived
6919             * @param sender A {@link CharSequence} to be used for displaying the name of the
6920             * sender. Should be <code>null</code> for messages by the current user, in which case
6921             * the platform will insert {@link MessagingStyle#getUserDisplayName()}.
6922             * Should be unique amongst all individuals in the conversation, and should be
6923             * consistent during re-posts of the notification.
6924             *
6925             *  @deprecated use {@code Message(CharSequence, long, Person)}
6926             */
6927            public Message(CharSequence text, long timestamp, CharSequence sender){
6928                this(text, timestamp, sender == null ? null : new Person().setName(sender));
6929            }
6930
6931            /**
6932             * Constructor
6933             * @param text A {@link CharSequence} to be displayed as the message content
6934             * @param timestamp Time at which the message arrived
6935             * @param sender The {@link Person} who sent the message.
6936             * Should be <code>null</code> for messages by the current user, in which case
6937             * the platform will insert the user set in {@code MessagingStyle(Person)}.
6938             * <p>
6939             * The person provided should contain an Icon, set with {@link Person#setIcon(Icon)}
6940             * and also have a name provided with {@link Person#setName(CharSequence)}. If multiple
6941             * users have the same name, consider providing a key with {@link Person#setKey(String)}
6942             * in order to differentiate between the different users.
6943             * </p>
6944             */
6945            public Message(CharSequence text, long timestamp, @Nullable Person sender){
6946                mText = text;
6947                mTimestamp = timestamp;
6948                mSender = sender;
6949            }
6950
6951            /**
6952             * Sets a binary blob of data and an associated MIME type for a message. In the case
6953             * where the platform doesn't support the MIME type, the original text provided in the
6954             * constructor will be used.
6955             * @param dataMimeType The MIME type of the content. See
6956             * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME
6957             * types on Android and Android Wear.
6958             * @param dataUri The uri containing the content whose type is given by the MIME type.
6959             * <p class="note">
6960             * <ol>
6961             *   <li>Notification Listeners including the System UI need permission to access the
6962             *       data the Uri points to. The recommended ways to do this are:</li>
6963             *   <li>Store the data in your own ContentProvider, making sure that other apps have
6964             *       the correct permission to access your provider. The preferred mechanism for
6965             *       providing access is to use per-URI permissions which are temporary and only
6966             *       grant access to the receiving application. An easy way to create a
6967             *       ContentProvider like this is to use the FileProvider helper class.</li>
6968             *   <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio
6969             *       and image MIME types, however beginning with Android 3.0 (API level 11) it can
6970             *       also store non-media types (see MediaStore.Files for more info). Files can be
6971             *       inserted into the MediaStore using scanFile() after which a content:// style
6972             *       Uri suitable for sharing is passed to the provided onScanCompleted() callback.
6973             *       Note that once added to the system MediaStore the content is accessible to any
6974             *       app on the device.</li>
6975             * </ol>
6976             * @return this object for method chaining
6977             */
6978            public Message setData(String dataMimeType, Uri dataUri) {
6979                mDataMimeType = dataMimeType;
6980                mDataUri = dataUri;
6981                return this;
6982            }
6983
6984            /**
6985             * Get the text to be used for this message, or the fallback text if a type and content
6986             * Uri have been set
6987             */
6988            public CharSequence getText() {
6989                return mText;
6990            }
6991
6992            /**
6993             * Get the time at which this message arrived
6994             */
6995            public long getTimestamp() {
6996                return mTimestamp;
6997            }
6998
6999            /**
7000             * Get the extras Bundle for this message.
7001             */
7002            public Bundle getExtras() {
7003                return mExtras;
7004            }
7005
7006            /**
7007             * Get the text used to display the contact's name in the messaging experience
7008             *
7009             * @deprecated use {@link #getSenderPerson()}
7010             */
7011            public CharSequence getSender() {
7012                return mSender == null ? null : mSender.getName();
7013            }
7014
7015            /**
7016             * Get the sender associated with this message.
7017             */
7018            @Nullable
7019            public Person getSenderPerson() {
7020                return mSender;
7021            }
7022
7023            /**
7024             * Get the MIME type of the data pointed to by the Uri
7025             */
7026            public String getDataMimeType() {
7027                return mDataMimeType;
7028            }
7029
7030            /**
7031             * Get the the Uri pointing to the content of the message. Can be null, in which case
7032             * {@see #getText()} is used.
7033             */
7034            public Uri getDataUri() {
7035                return mDataUri;
7036            }
7037
7038            private Bundle toBundle() {
7039                Bundle bundle = new Bundle();
7040                if (mText != null) {
7041                    bundle.putCharSequence(KEY_TEXT, mText);
7042                }
7043                bundle.putLong(KEY_TIMESTAMP, mTimestamp);
7044                if (mSender != null) {
7045                    // Legacy listeners need this
7046                    bundle.putCharSequence(KEY_SENDER, mSender.getName());
7047                    bundle.putParcelable(KEY_SENDER_PERSON, mSender);
7048                }
7049                if (mDataMimeType != null) {
7050                    bundle.putString(KEY_DATA_MIME_TYPE, mDataMimeType);
7051                }
7052                if (mDataUri != null) {
7053                    bundle.putParcelable(KEY_DATA_URI, mDataUri);
7054                }
7055                if (mExtras != null) {
7056                    bundle.putBundle(KEY_EXTRAS_BUNDLE, mExtras);
7057                }
7058                return bundle;
7059            }
7060
7061            static Bundle[] getBundleArrayForMessages(List<Message> messages) {
7062                Bundle[] bundles = new Bundle[messages.size()];
7063                final int N = messages.size();
7064                for (int i = 0; i < N; i++) {
7065                    bundles[i] = messages.get(i).toBundle();
7066                }
7067                return bundles;
7068            }
7069
7070            /**
7071             * @return A list of messages read from the bundles.
7072             *
7073             * @hide
7074             */
7075            public static List<Message> getMessagesFromBundleArray(Parcelable[] bundles) {
7076                if (bundles == null) {
7077                    return new ArrayList<>();
7078                }
7079                List<Message> messages = new ArrayList<>(bundles.length);
7080                for (int i = 0; i < bundles.length; i++) {
7081                    if (bundles[i] instanceof Bundle) {
7082                        Message message = getMessageFromBundle((Bundle)bundles[i]);
7083                        if (message != null) {
7084                            messages.add(message);
7085                        }
7086                    }
7087                }
7088                return messages;
7089            }
7090
7091            static Message getMessageFromBundle(Bundle bundle) {
7092                try {
7093                    if (!bundle.containsKey(KEY_TEXT) || !bundle.containsKey(KEY_TIMESTAMP)) {
7094                        return null;
7095                    } else {
7096
7097                        Person senderPerson = bundle.getParcelable(KEY_SENDER_PERSON);
7098                        if (senderPerson == null) {
7099                            // Legacy apps that use compat don't actually provide the sender objects
7100                            // We need to fix the compat version to provide people / use
7101                            // the native api instead
7102                            CharSequence senderName = bundle.getCharSequence(KEY_SENDER);
7103                            if (senderName != null) {
7104                                senderPerson = new Person().setName(senderName);
7105                            }
7106                        }
7107                        Message message = new Message(bundle.getCharSequence(KEY_TEXT),
7108                                bundle.getLong(KEY_TIMESTAMP),
7109                                senderPerson);
7110                        if (bundle.containsKey(KEY_DATA_MIME_TYPE) &&
7111                                bundle.containsKey(KEY_DATA_URI)) {
7112                            message.setData(bundle.getString(KEY_DATA_MIME_TYPE),
7113                                    (Uri) bundle.getParcelable(KEY_DATA_URI));
7114                        }
7115                        if (bundle.containsKey(KEY_EXTRAS_BUNDLE)) {
7116                            message.getExtras().putAll(bundle.getBundle(KEY_EXTRAS_BUNDLE));
7117                        }
7118                        return message;
7119                    }
7120                } catch (ClassCastException e) {
7121                    return null;
7122                }
7123            }
7124        }
7125    }
7126
7127    /**
7128     * Helper class for generating large-format notifications that include a list of (up to 5) strings.
7129     *
7130     * Here's how you'd set the <code>InboxStyle</code> on a notification:
7131     * <pre class="prettyprint">
7132     * Notification notif = new Notification.Builder(mContext)
7133     *     .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
7134     *     .setContentText(subject)
7135     *     .setSmallIcon(R.drawable.new_mail)
7136     *     .setLargeIcon(aBitmap)
7137     *     .setStyle(new Notification.InboxStyle()
7138     *         .addLine(str1)
7139     *         .addLine(str2)
7140     *         .setContentTitle(&quot;&quot;)
7141     *         .setSummaryText(&quot;+3 more&quot;))
7142     *     .build();
7143     * </pre>
7144     *
7145     * @see Notification#bigContentView
7146     */
7147    public static class InboxStyle extends Style {
7148        private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
7149
7150        public InboxStyle() {
7151        }
7152
7153        /**
7154         * @deprecated use {@code InboxStyle()}.
7155         */
7156        @Deprecated
7157        public InboxStyle(Builder builder) {
7158            setBuilder(builder);
7159        }
7160
7161        /**
7162         * Overrides ContentTitle in the big form of the template.
7163         * This defaults to the value passed to setContentTitle().
7164         */
7165        public InboxStyle setBigContentTitle(CharSequence title) {
7166            internalSetBigContentTitle(safeCharSequence(title));
7167            return this;
7168        }
7169
7170        /**
7171         * Set the first line of text after the detail section in the big form of the template.
7172         */
7173        public InboxStyle setSummaryText(CharSequence cs) {
7174            internalSetSummaryText(safeCharSequence(cs));
7175            return this;
7176        }
7177
7178        /**
7179         * Append a line to the digest section of the Inbox notification.
7180         */
7181        public InboxStyle addLine(CharSequence cs) {
7182            mTexts.add(safeCharSequence(cs));
7183            return this;
7184        }
7185
7186        /**
7187         * @hide
7188         */
7189        public ArrayList<CharSequence> getLines() {
7190            return mTexts;
7191        }
7192
7193        /**
7194         * @hide
7195         */
7196        public void addExtras(Bundle extras) {
7197            super.addExtras(extras);
7198
7199            CharSequence[] a = new CharSequence[mTexts.size()];
7200            extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
7201        }
7202
7203        /**
7204         * @hide
7205         */
7206        @Override
7207        protected void restoreFromExtras(Bundle extras) {
7208            super.restoreFromExtras(extras);
7209
7210            mTexts.clear();
7211            if (extras.containsKey(EXTRA_TEXT_LINES)) {
7212                Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES));
7213            }
7214        }
7215
7216        /**
7217         * @hide
7218         */
7219        public RemoteViews makeBigContentView() {
7220            // Remove the content text so it disappears unless you have a summary
7221            // Nasty
7222            CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT);
7223            mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
7224
7225            RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource());
7226
7227            mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
7228
7229            int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3,
7230                    R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
7231
7232            // Make sure all rows are gone in case we reuse a view.
7233            for (int rowId : rowIds) {
7234                contentView.setViewVisibility(rowId, View.GONE);
7235            }
7236
7237            int i=0;
7238            int topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7239                    R.dimen.notification_inbox_item_top_padding);
7240            boolean first = true;
7241            int onlyViewId = 0;
7242            int maxRows = rowIds.length;
7243            if (mBuilder.mActions.size() > 0) {
7244                maxRows--;
7245            }
7246            while (i < mTexts.size() && i < maxRows) {
7247                CharSequence str = mTexts.get(i);
7248                if (!TextUtils.isEmpty(str)) {
7249                    contentView.setViewVisibility(rowIds[i], View.VISIBLE);
7250                    contentView.setTextViewText(rowIds[i],
7251                            mBuilder.processTextSpans(mBuilder.processLegacyText(str)));
7252                    mBuilder.setTextViewColorSecondary(contentView, rowIds[i]);
7253                    contentView.setViewPadding(rowIds[i], 0, topPadding, 0, 0);
7254                    handleInboxImageMargin(contentView, rowIds[i], first);
7255                    if (first) {
7256                        onlyViewId = rowIds[i];
7257                    } else {
7258                        onlyViewId = 0;
7259                    }
7260                    first = false;
7261                }
7262                i++;
7263            }
7264            if (onlyViewId != 0) {
7265                // We only have 1 entry, lets make it look like the normal Text of a Bigtext
7266                topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7267                        R.dimen.notification_text_margin_top);
7268                contentView.setViewPadding(onlyViewId, 0, topPadding, 0, 0);
7269            }
7270
7271            return contentView;
7272        }
7273
7274        /**
7275         * @hide
7276         */
7277        @Override
7278        public boolean areNotificationsVisiblyDifferent(Style other) {
7279            if (other == null || getClass() != other.getClass()) {
7280                return true;
7281            }
7282            InboxStyle newS = (InboxStyle) other;
7283            return !Objects.equals(getLines(), newS.getLines());
7284        }
7285
7286        private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first) {
7287            int endMargin = 0;
7288            if (first) {
7289                final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0);
7290                final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
7291                boolean hasProgress = max != 0 || ind;
7292                if (mBuilder.mN.hasLargeIcon() && !hasProgress) {
7293                    endMargin = R.dimen.notification_content_picture_margin;
7294                }
7295            }
7296            contentView.setViewLayoutMarginEndDimen(id, endMargin);
7297        }
7298    }
7299
7300    /**
7301     * Notification style for media playback notifications.
7302     *
7303     * In the expanded form, {@link Notification#bigContentView}, up to 5
7304     * {@link Notification.Action}s specified with
7305     * {@link Notification.Builder#addAction(Action) addAction} will be
7306     * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
7307     * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be
7308     * treated as album artwork.
7309     * <p>
7310     * Unlike the other styles provided here, MediaStyle can also modify the standard-size
7311     * {@link Notification#contentView}; by providing action indices to
7312     * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed
7313     * in the standard view alongside the usual content.
7314     * <p>
7315     * Notifications created with MediaStyle will have their category set to
7316     * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different
7317     * category using {@link Notification.Builder#setCategory(String) setCategory()}.
7318     * <p>
7319     * Finally, if you attach a {@link android.media.session.MediaSession.Token} using
7320     * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)},
7321     * the System UI can identify this as a notification representing an active media session
7322     * and respond accordingly (by showing album artwork in the lockscreen, for example).
7323     *
7324     * <p>
7325     * Starting at {@link android.os.Build.VERSION_CODES#O Android O} any notification that has a
7326     * media session attached with {@link #setMediaSession(MediaSession.Token)} will be colorized.
7327     * You can opt-out of this behavior by using {@link Notification.Builder#setColorized(boolean)}.
7328     * <p>
7329     *
7330     * To use this style with your Notification, feed it to
7331     * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7332     * <pre class="prettyprint">
7333     * Notification noti = new Notification.Builder()
7334     *     .setSmallIcon(R.drawable.ic_stat_player)
7335     *     .setContentTitle(&quot;Track title&quot;)
7336     *     .setContentText(&quot;Artist - Album&quot;)
7337     *     .setLargeIcon(albumArtBitmap))
7338     *     .setStyle(<b>new Notification.MediaStyle()</b>
7339     *         .setMediaSession(mySession))
7340     *     .build();
7341     * </pre>
7342     *
7343     * @see Notification#bigContentView
7344     * @see Notification.Builder#setColorized(boolean)
7345     */
7346    public static class MediaStyle extends Style {
7347        static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3;
7348        static final int MAX_MEDIA_BUTTONS = 5;
7349
7350        private int[] mActionsToShowInCompact = null;
7351        private MediaSession.Token mToken;
7352
7353        public MediaStyle() {
7354        }
7355
7356        /**
7357         * @deprecated use {@code MediaStyle()}.
7358         */
7359        @Deprecated
7360        public MediaStyle(Builder builder) {
7361            setBuilder(builder);
7362        }
7363
7364        /**
7365         * Request up to 3 actions (by index in the order of addition) to be shown in the compact
7366         * notification view.
7367         *
7368         * @param actions the indices of the actions to show in the compact notification view
7369         */
7370        public MediaStyle setShowActionsInCompactView(int...actions) {
7371            mActionsToShowInCompact = actions;
7372            return this;
7373        }
7374
7375        /**
7376         * Attach a {@link android.media.session.MediaSession.Token} to this Notification
7377         * to provide additional playback information and control to the SystemUI.
7378         */
7379        public MediaStyle setMediaSession(MediaSession.Token token) {
7380            mToken = token;
7381            return this;
7382        }
7383
7384        /**
7385         * @hide
7386         */
7387        @Override
7388        public Notification buildStyled(Notification wip) {
7389            super.buildStyled(wip);
7390            if (wip.category == null) {
7391                wip.category = Notification.CATEGORY_TRANSPORT;
7392            }
7393            return wip;
7394        }
7395
7396        /**
7397         * @hide
7398         */
7399        @Override
7400        public RemoteViews makeContentView(boolean increasedHeight) {
7401            return makeMediaContentView();
7402        }
7403
7404        /**
7405         * @hide
7406         */
7407        @Override
7408        public RemoteViews makeBigContentView() {
7409            return makeMediaBigContentView();
7410        }
7411
7412        /**
7413         * @hide
7414         */
7415        @Override
7416        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
7417            RemoteViews expanded = makeMediaBigContentView();
7418            return expanded != null ? expanded : makeMediaContentView();
7419        }
7420
7421        /** @hide */
7422        @Override
7423        public void addExtras(Bundle extras) {
7424            super.addExtras(extras);
7425
7426            if (mToken != null) {
7427                extras.putParcelable(EXTRA_MEDIA_SESSION, mToken);
7428            }
7429            if (mActionsToShowInCompact != null) {
7430                extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact);
7431            }
7432        }
7433
7434        /**
7435         * @hide
7436         */
7437        @Override
7438        protected void restoreFromExtras(Bundle extras) {
7439            super.restoreFromExtras(extras);
7440
7441            if (extras.containsKey(EXTRA_MEDIA_SESSION)) {
7442                mToken = extras.getParcelable(EXTRA_MEDIA_SESSION);
7443            }
7444            if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) {
7445                mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS);
7446            }
7447        }
7448
7449        /**
7450         * @hide
7451         */
7452        @Override
7453        public boolean areNotificationsVisiblyDifferent(Style other) {
7454            if (other == null || getClass() != other.getClass()) {
7455                return true;
7456            }
7457            // All fields to compare are on the Notification object
7458            return false;
7459        }
7460
7461        private RemoteViews generateMediaActionButton(Action action, int color) {
7462            final boolean tombstone = (action.actionIntent == null);
7463            RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(),
7464                    R.layout.notification_material_media_action);
7465            button.setImageViewIcon(R.id.action0, action.getIcon());
7466
7467            // If the action buttons should not be tinted, then just use the default
7468            // notification color. Otherwise, just use the passed-in color.
7469            int tintColor = mBuilder.shouldTintActionButtons() || mBuilder.isColorized()
7470                    ? color
7471                    : NotificationColorUtil.resolveColor(mBuilder.mContext,
7472                            Notification.COLOR_DEFAULT);
7473
7474            button.setDrawableTint(R.id.action0, false, tintColor,
7475                    PorterDuff.Mode.SRC_ATOP);
7476            if (!tombstone) {
7477                button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
7478            }
7479            button.setContentDescription(R.id.action0, action.title);
7480            return button;
7481        }
7482
7483        private RemoteViews makeMediaContentView() {
7484            RemoteViews view = mBuilder.applyStandardTemplate(
7485                    R.layout.notification_template_material_media, false /* hasProgress */);
7486
7487            final int numActions = mBuilder.mActions.size();
7488            final int N = mActionsToShowInCompact == null
7489                    ? 0
7490                    : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
7491            if (N > 0) {
7492                view.removeAllViews(com.android.internal.R.id.media_actions);
7493                for (int i = 0; i < N; i++) {
7494                    if (i >= numActions) {
7495                        throw new IllegalArgumentException(String.format(
7496                                "setShowActionsInCompactView: action %d out of bounds (max %d)",
7497                                i, numActions - 1));
7498                    }
7499
7500                    final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]);
7501                    final RemoteViews button = generateMediaActionButton(action,
7502                            getPrimaryHighlightColor());
7503                    view.addView(com.android.internal.R.id.media_actions, button);
7504                }
7505            }
7506            handleImage(view);
7507            // handle the content margin
7508            int endMargin = R.dimen.notification_content_margin_end;
7509            if (mBuilder.mN.hasLargeIcon()) {
7510                endMargin = R.dimen.notification_content_plus_picture_margin_end;
7511            }
7512            view.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
7513            return view;
7514        }
7515
7516        private int getPrimaryHighlightColor() {
7517            return mBuilder.getPrimaryHighlightColor();
7518        }
7519
7520        private RemoteViews makeMediaBigContentView() {
7521            final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS);
7522            // Dont add an expanded view if there is no more content to be revealed
7523            int actionsInCompact = mActionsToShowInCompact == null
7524                    ? 0
7525                    : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
7526            if (!mBuilder.mN.hasLargeIcon() && actionCount <= actionsInCompact) {
7527                return null;
7528            }
7529            RemoteViews big = mBuilder.applyStandardTemplate(
7530                    R.layout.notification_template_material_big_media,
7531                    false);
7532
7533            if (actionCount > 0) {
7534                big.removeAllViews(com.android.internal.R.id.media_actions);
7535                for (int i = 0; i < actionCount; i++) {
7536                    final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i),
7537                            getPrimaryHighlightColor());
7538                    big.addView(com.android.internal.R.id.media_actions, button);
7539                }
7540            }
7541            handleImage(big);
7542            return big;
7543        }
7544
7545        private void handleImage(RemoteViews contentView) {
7546            if (mBuilder.mN.hasLargeIcon()) {
7547                contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
7548                contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
7549            }
7550        }
7551
7552        /**
7553         * @hide
7554         */
7555        @Override
7556        protected boolean hasProgress() {
7557            return false;
7558        }
7559    }
7560
7561    /**
7562     * Notification style for custom views that are decorated by the system
7563     *
7564     * <p>Instead of providing a notification that is completely custom, a developer can set this
7565     * style and still obtain system decorations like the notification header with the expand
7566     * affordance and actions.
7567     *
7568     * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7569     * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7570     * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7571     * corresponding custom views to display.
7572     *
7573     * To use this style with your Notification, feed it to
7574     * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7575     * <pre class="prettyprint">
7576     * Notification noti = new Notification.Builder()
7577     *     .setSmallIcon(R.drawable.ic_stat_player)
7578     *     .setLargeIcon(albumArtBitmap))
7579     *     .setCustomContentView(contentView);
7580     *     .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>)
7581     *     .build();
7582     * </pre>
7583     */
7584    public static class DecoratedCustomViewStyle extends Style {
7585
7586        public DecoratedCustomViewStyle() {
7587        }
7588
7589        /**
7590         * @hide
7591         */
7592        public boolean displayCustomViewInline() {
7593            return true;
7594        }
7595
7596        /**
7597         * @hide
7598         */
7599        @Override
7600        public RemoteViews makeContentView(boolean increasedHeight) {
7601            return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView);
7602        }
7603
7604        /**
7605         * @hide
7606         */
7607        @Override
7608        public RemoteViews makeBigContentView() {
7609            return makeDecoratedBigContentView();
7610        }
7611
7612        /**
7613         * @hide
7614         */
7615        @Override
7616        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
7617            return makeDecoratedHeadsUpContentView();
7618        }
7619
7620        private RemoteViews makeDecoratedHeadsUpContentView() {
7621            RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null
7622                    ? mBuilder.mN.contentView
7623                    : mBuilder.mN.headsUpContentView;
7624            if (mBuilder.mActions.size() == 0) {
7625               return makeStandardTemplateWithCustomContent(headsUpContentView);
7626            }
7627            RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
7628                        mBuilder.getBigBaseLayoutResource());
7629            buildIntoRemoteViewContent(remoteViews, headsUpContentView);
7630            return remoteViews;
7631        }
7632
7633        private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) {
7634            RemoteViews remoteViews = mBuilder.applyStandardTemplate(
7635                    mBuilder.getBaseLayoutResource());
7636            buildIntoRemoteViewContent(remoteViews, customContent);
7637            return remoteViews;
7638        }
7639
7640        private RemoteViews makeDecoratedBigContentView() {
7641            RemoteViews bigContentView = mBuilder.mN.bigContentView == null
7642                    ? mBuilder.mN.contentView
7643                    : mBuilder.mN.bigContentView;
7644            if (mBuilder.mActions.size() == 0) {
7645                return makeStandardTemplateWithCustomContent(bigContentView);
7646            }
7647            RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
7648                    mBuilder.getBigBaseLayoutResource());
7649            buildIntoRemoteViewContent(remoteViews, bigContentView);
7650            return remoteViews;
7651        }
7652
7653        private void buildIntoRemoteViewContent(RemoteViews remoteViews,
7654                RemoteViews customContent) {
7655            if (customContent != null) {
7656                // Need to clone customContent before adding, because otherwise it can no longer be
7657                // parceled independently of remoteViews.
7658                customContent = customContent.clone();
7659                remoteViews.removeAllViewsExceptId(R.id.notification_main_column, R.id.progress);
7660                remoteViews.addView(R.id.notification_main_column, customContent, 0 /* index */);
7661                remoteViews.setReapplyDisallowed();
7662            }
7663            // also update the end margin if there is an image
7664            int endMargin = R.dimen.notification_content_margin_end;
7665            if (mBuilder.mN.hasLargeIcon()) {
7666                endMargin = R.dimen.notification_content_plus_picture_margin_end;
7667            }
7668            remoteViews.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
7669        }
7670
7671        /**
7672         * @hide
7673         */
7674        @Override
7675        public boolean areNotificationsVisiblyDifferent(Style other) {
7676            if (other == null || getClass() != other.getClass()) {
7677                return true;
7678            }
7679            // Comparison done for all custom RemoteViews, independent of style
7680            return false;
7681        }
7682    }
7683
7684    /**
7685     * Notification style for media custom views that are decorated by the system
7686     *
7687     * <p>Instead of providing a media notification that is completely custom, a developer can set
7688     * this style and still obtain system decorations like the notification header with the expand
7689     * affordance and actions.
7690     *
7691     * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7692     * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7693     * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7694     * corresponding custom views to display.
7695     * <p>
7696     * Contrary to {@link MediaStyle} a developer has to opt-in to the colorizing of the
7697     * notification by using {@link Notification.Builder#setColorized(boolean)}.
7698     * <p>
7699     * To use this style with your Notification, feed it to
7700     * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7701     * <pre class="prettyprint">
7702     * Notification noti = new Notification.Builder()
7703     *     .setSmallIcon(R.drawable.ic_stat_player)
7704     *     .setLargeIcon(albumArtBitmap))
7705     *     .setCustomContentView(contentView);
7706     *     .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b>
7707     *          .setMediaSession(mySession))
7708     *     .build();
7709     * </pre>
7710     *
7711     * @see android.app.Notification.DecoratedCustomViewStyle
7712     * @see android.app.Notification.MediaStyle
7713     */
7714    public static class DecoratedMediaCustomViewStyle extends MediaStyle {
7715
7716        public DecoratedMediaCustomViewStyle() {
7717        }
7718
7719        /**
7720         * @hide
7721         */
7722        public boolean displayCustomViewInline() {
7723            return true;
7724        }
7725
7726        /**
7727         * @hide
7728         */
7729        @Override
7730        public RemoteViews makeContentView(boolean increasedHeight) {
7731            RemoteViews remoteViews = super.makeContentView(false /* increasedHeight */);
7732            return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
7733                    mBuilder.mN.contentView);
7734        }
7735
7736        /**
7737         * @hide
7738         */
7739        @Override
7740        public RemoteViews makeBigContentView() {
7741            RemoteViews customRemoteView = mBuilder.mN.bigContentView != null
7742                    ? mBuilder.mN.bigContentView
7743                    : mBuilder.mN.contentView;
7744            return makeBigContentViewWithCustomContent(customRemoteView);
7745        }
7746
7747        private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) {
7748            RemoteViews remoteViews = super.makeBigContentView();
7749            if (remoteViews != null) {
7750                return buildIntoRemoteView(remoteViews, R.id.notification_main_column,
7751                        customRemoteView);
7752            } else if (customRemoteView != mBuilder.mN.contentView){
7753                remoteViews = super.makeContentView(false /* increasedHeight */);
7754                return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
7755                        customRemoteView);
7756            } else {
7757                return null;
7758            }
7759        }
7760
7761        /**
7762         * @hide
7763         */
7764        @Override
7765        public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
7766            RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null
7767                    ? mBuilder.mN.headsUpContentView
7768                    : mBuilder.mN.contentView;
7769            return makeBigContentViewWithCustomContent(customRemoteView);
7770        }
7771
7772        /**
7773         * @hide
7774         */
7775        @Override
7776        public boolean areNotificationsVisiblyDifferent(Style other) {
7777            if (other == null || getClass() != other.getClass()) {
7778                return true;
7779            }
7780            // Comparison done for all custom RemoteViews, independent of style
7781            return false;
7782        }
7783
7784        private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id,
7785                RemoteViews customContent) {
7786            if (customContent != null) {
7787                // Need to clone customContent before adding, because otherwise it can no longer be
7788                // parceled independently of remoteViews.
7789                customContent = customContent.clone();
7790                customContent.overrideTextColors(mBuilder.getPrimaryTextColor());
7791                remoteViews.removeAllViews(id);
7792                remoteViews.addView(id, customContent);
7793                remoteViews.setReapplyDisallowed();
7794            }
7795            return remoteViews;
7796        }
7797    }
7798
7799    /**
7800     * A Person associated with this Notification.
7801     */
7802    public static final class Person implements Parcelable {
7803        @Nullable private CharSequence mName;
7804        @Nullable private Icon mIcon;
7805        @Nullable private String mUri;
7806        @Nullable private String mKey;
7807        private boolean mBot;
7808        private boolean mImportant;
7809
7810        protected Person(Parcel in) {
7811            mName = in.readCharSequence();
7812            if (in.readInt() != 0) {
7813                mIcon = Icon.CREATOR.createFromParcel(in);
7814            }
7815            mUri = in.readString();
7816            mKey = in.readString();
7817            mImportant = in.readBoolean();
7818            mBot = in.readBoolean();
7819        }
7820
7821        /**
7822         * Create a new person.
7823         */
7824        public Person() {
7825        }
7826
7827        /**
7828         * Give this person a name.
7829         *
7830         * @param name the name of this person
7831         */
7832        public Person setName(@Nullable CharSequence name) {
7833            this.mName = name;
7834            return this;
7835        }
7836
7837        /**
7838         * Add an icon for this person.
7839         * <br />
7840         * This is currently only used for {@link MessagingStyle} notifications and should not be
7841         * provided otherwise, in order to save memory. The system will prefer this icon over any
7842         * images that are resolved from the URI.
7843         *
7844         * @param icon the icon of the person
7845         */
7846        public Person setIcon(@Nullable Icon icon) {
7847            this.mIcon = icon;
7848            return this;
7849        }
7850
7851        /**
7852         * Set a URI associated with this person.
7853         *
7854         * <P>
7855         * Depending on user preferences, adding a URI to a Person may allow the notification to
7856         * pass through interruption filters, if this notification is of
7857         * category {@link #CATEGORY_CALL} or {@link #CATEGORY_MESSAGE}.
7858         * The addition of people may also cause this notification to appear more prominently in
7859         * the user interface.
7860         * </P>
7861         *
7862         * <P>
7863         * The person should be specified by the {@code String} representation of a
7864         * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
7865         * </P>
7866         *
7867         * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
7868         * URIs.  The path part of these URIs must exist in the contacts database, in the
7869         * appropriate column, or the reference will be discarded as invalid. Telephone schema
7870         * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
7871         * </P>
7872         *
7873         * @param uri a URI for the person
7874         */
7875        public Person setUri(@Nullable String uri) {
7876            mUri = uri;
7877            return this;
7878        }
7879
7880        /**
7881         * Add a key to this person in order to uniquely identify it.
7882         * This is especially useful if the name doesn't uniquely identify this person or if the
7883         * display name is a short handle of the actual name.
7884         *
7885         * <P>If no key is provided, the name serves as as the key for the purpose of
7886         * identification.</P>
7887         *
7888         * @param key the key that uniquely identifies this person
7889         */
7890        public Person setKey(@Nullable String key) {
7891            mKey = key;
7892            return this;
7893        }
7894
7895        /**
7896         * Sets whether this is an important person. Use this method to denote users who frequently
7897         * interact with the user of this device, when it is not possible to refer to the user
7898         * by {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
7899         *
7900         * @param isImportant {@code true} if this is an important person, {@code false} otherwise.
7901         */
7902        public Person setImportant(boolean isImportant) {
7903            mImportant = isImportant;
7904            return this;
7905        }
7906
7907        /**
7908         * Sets whether this person is a machine rather than a human.
7909         *
7910         * @param isBot {@code true}  if this person is a machine, {@code false} otherwise.
7911         */
7912        public Person setBot(boolean isBot) {
7913            mBot = isBot;
7914            return this;
7915        }
7916
7917        /**
7918         * @return the uri provided for this person or {@code null} if no Uri was provided
7919         */
7920        @Nullable
7921        public String getUri() {
7922            return mUri;
7923        }
7924
7925        /**
7926         * @return the name provided for this person or {@code null} if no name was provided
7927         */
7928        @Nullable
7929        public CharSequence getName() {
7930            return mName;
7931        }
7932
7933        /**
7934         * @return the icon provided for this person or {@code null} if no icon was provided
7935         */
7936        @Nullable
7937        public Icon getIcon() {
7938            return mIcon;
7939        }
7940
7941        /**
7942         * @return the key provided for this person or {@code null} if no key was provided
7943         */
7944        @Nullable
7945        public String getKey() {
7946            return mKey;
7947        }
7948
7949        /**
7950         * @return whether this Person is a machine.
7951         */
7952        public boolean isBot() {
7953            return mBot;
7954        }
7955
7956        /**
7957         * @return whether this Person is important.
7958         */
7959        public boolean isImportant() {
7960            return mImportant;
7961        }
7962
7963        /**
7964         * @return the URI associated with this person, or "name:mName" otherwise
7965         *  @hide
7966         */
7967        public String resolveToLegacyUri() {
7968            if (mUri != null) {
7969                return mUri;
7970            }
7971            if (mName != null) {
7972                return "name:" + mName;
7973            }
7974            return "";
7975        }
7976
7977        @Override
7978        public int describeContents() {
7979            return 0;
7980        }
7981
7982        @Override
7983        public void writeToParcel(Parcel dest, @WriteFlags int flags) {
7984            dest.writeCharSequence(mName);
7985            if (mIcon != null) {
7986                dest.writeInt(1);
7987                mIcon.writeToParcel(dest, 0);
7988            } else {
7989                dest.writeInt(0);
7990            }
7991            dest.writeString(mUri);
7992            dest.writeString(mKey);
7993            dest.writeBoolean(mImportant);
7994            dest.writeBoolean(mBot);
7995        }
7996
7997        public static final Creator<Person> CREATOR = new Creator<Person>() {
7998            @Override
7999            public Person createFromParcel(Parcel in) {
8000                return new Person(in);
8001            }
8002
8003            @Override
8004            public Person[] newArray(int size) {
8005                return new Person[size];
8006            }
8007        };
8008    }
8009
8010    // When adding a new Style subclass here, don't forget to update
8011    // Builder.getNotificationStyleClass.
8012
8013    /**
8014     * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
8015     * metadata or change options on a notification builder.
8016     */
8017    public interface Extender {
8018        /**
8019         * Apply this extender to a notification builder.
8020         * @param builder the builder to be modified.
8021         * @return the build object for chaining.
8022         */
8023        public Builder extend(Builder builder);
8024    }
8025
8026    /**
8027     * Helper class to add wearable extensions to notifications.
8028     * <p class="note"> See
8029     * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications
8030     * for Android Wear</a> for more information on how to use this class.
8031     * <p>
8032     * To create a notification with wearable extensions:
8033     * <ol>
8034     *   <li>Create a {@link android.app.Notification.Builder}, setting any desired
8035     *   properties.
8036     *   <li>Create a {@link android.app.Notification.WearableExtender}.
8037     *   <li>Set wearable-specific properties using the
8038     *   {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}.
8039     *   <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a
8040     *   notification.
8041     *   <li>Post the notification to the notification system with the
8042     *   {@code NotificationManager.notify(...)} methods.
8043     * </ol>
8044     *
8045     * <pre class="prettyprint">
8046     * Notification notif = new Notification.Builder(mContext)
8047     *         .setContentTitle(&quot;New mail from &quot; + sender.toString())
8048     *         .setContentText(subject)
8049     *         .setSmallIcon(R.drawable.new_mail)
8050     *         .extend(new Notification.WearableExtender()
8051     *                 .setContentIcon(R.drawable.new_mail))
8052     *         .build();
8053     * NotificationManager notificationManger =
8054     *         (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
8055     * notificationManger.notify(0, notif);</pre>
8056     *
8057     * <p>Wearable extensions can be accessed on an existing notification by using the
8058     * {@code WearableExtender(Notification)} constructor,
8059     * and then using the {@code get} methods to access values.
8060     *
8061     * <pre class="prettyprint">
8062     * Notification.WearableExtender wearableExtender = new Notification.WearableExtender(
8063     *         notification);
8064     * List&lt;Notification&gt; pages = wearableExtender.getPages();</pre>
8065     */
8066    public static final class WearableExtender implements Extender {
8067        /**
8068         * Sentinel value for an action index that is unset.
8069         */
8070        public static final int UNSET_ACTION_INDEX = -1;
8071
8072        /**
8073         * Size value for use with {@link #setCustomSizePreset} to show this notification with
8074         * default sizing.
8075         * <p>For custom display notifications created using {@link #setDisplayIntent},
8076         * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based
8077         * on their content.
8078         */
8079        public static final int SIZE_DEFAULT = 0;
8080
8081        /**
8082         * Size value for use with {@link #setCustomSizePreset} to show this notification
8083         * with an extra small size.
8084         * <p>This value is only applicable for custom display notifications created using
8085         * {@link #setDisplayIntent}.
8086         */
8087        public static final int SIZE_XSMALL = 1;
8088
8089        /**
8090         * Size value for use with {@link #setCustomSizePreset} to show this notification
8091         * with a small size.
8092         * <p>This value is only applicable for custom display notifications created using
8093         * {@link #setDisplayIntent}.
8094         */
8095        public static final int SIZE_SMALL = 2;
8096
8097        /**
8098         * Size value for use with {@link #setCustomSizePreset} to show this notification
8099         * with a medium size.
8100         * <p>This value is only applicable for custom display notifications created using
8101         * {@link #setDisplayIntent}.
8102         */
8103        public static final int SIZE_MEDIUM = 3;
8104
8105        /**
8106         * Size value for use with {@link #setCustomSizePreset} to show this notification
8107         * with a large size.
8108         * <p>This value is only applicable for custom display notifications created using
8109         * {@link #setDisplayIntent}.
8110         */
8111        public static final int SIZE_LARGE = 4;
8112
8113        /**
8114         * Size value for use with {@link #setCustomSizePreset} to show this notification
8115         * full screen.
8116         * <p>This value is only applicable for custom display notifications created using
8117         * {@link #setDisplayIntent}.
8118         */
8119        public static final int SIZE_FULL_SCREEN = 5;
8120
8121        /**
8122         * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a
8123         * short amount of time when this notification is displayed on the screen. This
8124         * is the default value.
8125         */
8126        public static final int SCREEN_TIMEOUT_SHORT = 0;
8127
8128        /**
8129         * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on
8130         * for a longer amount of time when this notification is displayed on the screen.
8131         */
8132        public static final int SCREEN_TIMEOUT_LONG = -1;
8133
8134        /** Notification extra which contains wearable extensions */
8135        private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
8136
8137        // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
8138        private static final String KEY_ACTIONS = "actions";
8139        private static final String KEY_FLAGS = "flags";
8140        private static final String KEY_DISPLAY_INTENT = "displayIntent";
8141        private static final String KEY_PAGES = "pages";
8142        private static final String KEY_BACKGROUND = "background";
8143        private static final String KEY_CONTENT_ICON = "contentIcon";
8144        private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity";
8145        private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex";
8146        private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset";
8147        private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight";
8148        private static final String KEY_GRAVITY = "gravity";
8149        private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout";
8150        private static final String KEY_DISMISSAL_ID = "dismissalId";
8151        private static final String KEY_BRIDGE_TAG = "bridgeTag";
8152
8153        // Flags bitwise-ored to mFlags
8154        private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1;
8155        private static final int FLAG_HINT_HIDE_ICON = 1 << 1;
8156        private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2;
8157        private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3;
8158        private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4;
8159        private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5;
8160        private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6;
8161
8162        // Default value for flags integer
8163        private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE;
8164
8165        private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END;
8166        private static final int DEFAULT_GRAVITY = Gravity.BOTTOM;
8167
8168        private ArrayList<Action> mActions = new ArrayList<Action>();
8169        private int mFlags = DEFAULT_FLAGS;
8170        private PendingIntent mDisplayIntent;
8171        private ArrayList<Notification> mPages = new ArrayList<Notification>();
8172        private Bitmap mBackground;
8173        private int mContentIcon;
8174        private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY;
8175        private int mContentActionIndex = UNSET_ACTION_INDEX;
8176        private int mCustomSizePreset = SIZE_DEFAULT;
8177        private int mCustomContentHeight;
8178        private int mGravity = DEFAULT_GRAVITY;
8179        private int mHintScreenTimeout;
8180        private String mDismissalId;
8181        private String mBridgeTag;
8182
8183        /**
8184         * Create a {@link android.app.Notification.WearableExtender} with default
8185         * options.
8186         */
8187        public WearableExtender() {
8188        }
8189
8190        public WearableExtender(Notification notif) {
8191            Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS);
8192            if (wearableBundle != null) {
8193                List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS);
8194                if (actions != null) {
8195                    mActions.addAll(actions);
8196                }
8197
8198                mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
8199                mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT);
8200
8201                Notification[] pages = getNotificationArrayFromBundle(
8202                        wearableBundle, KEY_PAGES);
8203                if (pages != null) {
8204                    Collections.addAll(mPages, pages);
8205                }
8206
8207                mBackground = wearableBundle.getParcelable(KEY_BACKGROUND);
8208                mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON);
8209                mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY,
8210                        DEFAULT_CONTENT_ICON_GRAVITY);
8211                mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX,
8212                        UNSET_ACTION_INDEX);
8213                mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET,
8214                        SIZE_DEFAULT);
8215                mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT);
8216                mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY);
8217                mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT);
8218                mDismissalId = wearableBundle.getString(KEY_DISMISSAL_ID);
8219                mBridgeTag = wearableBundle.getString(KEY_BRIDGE_TAG);
8220            }
8221        }
8222
8223        /**
8224         * Apply wearable extensions to a notification that is being built. This is typically
8225         * called by the {@link android.app.Notification.Builder#extend} method of
8226         * {@link android.app.Notification.Builder}.
8227         */
8228        @Override
8229        public Notification.Builder extend(Notification.Builder builder) {
8230            Bundle wearableBundle = new Bundle();
8231
8232            if (!mActions.isEmpty()) {
8233                wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions);
8234            }
8235            if (mFlags != DEFAULT_FLAGS) {
8236                wearableBundle.putInt(KEY_FLAGS, mFlags);
8237            }
8238            if (mDisplayIntent != null) {
8239                wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent);
8240            }
8241            if (!mPages.isEmpty()) {
8242                wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray(
8243                        new Notification[mPages.size()]));
8244            }
8245            if (mBackground != null) {
8246                wearableBundle.putParcelable(KEY_BACKGROUND, mBackground);
8247            }
8248            if (mContentIcon != 0) {
8249                wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon);
8250            }
8251            if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) {
8252                wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity);
8253            }
8254            if (mContentActionIndex != UNSET_ACTION_INDEX) {
8255                wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX,
8256                        mContentActionIndex);
8257            }
8258            if (mCustomSizePreset != SIZE_DEFAULT) {
8259                wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset);
8260            }
8261            if (mCustomContentHeight != 0) {
8262                wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight);
8263            }
8264            if (mGravity != DEFAULT_GRAVITY) {
8265                wearableBundle.putInt(KEY_GRAVITY, mGravity);
8266            }
8267            if (mHintScreenTimeout != 0) {
8268                wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout);
8269            }
8270            if (mDismissalId != null) {
8271                wearableBundle.putString(KEY_DISMISSAL_ID, mDismissalId);
8272            }
8273            if (mBridgeTag != null) {
8274                wearableBundle.putString(KEY_BRIDGE_TAG, mBridgeTag);
8275            }
8276
8277            builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
8278            return builder;
8279        }
8280
8281        @Override
8282        public WearableExtender clone() {
8283            WearableExtender that = new WearableExtender();
8284            that.mActions = new ArrayList<Action>(this.mActions);
8285            that.mFlags = this.mFlags;
8286            that.mDisplayIntent = this.mDisplayIntent;
8287            that.mPages = new ArrayList<Notification>(this.mPages);
8288            that.mBackground = this.mBackground;
8289            that.mContentIcon = this.mContentIcon;
8290            that.mContentIconGravity = this.mContentIconGravity;
8291            that.mContentActionIndex = this.mContentActionIndex;
8292            that.mCustomSizePreset = this.mCustomSizePreset;
8293            that.mCustomContentHeight = this.mCustomContentHeight;
8294            that.mGravity = this.mGravity;
8295            that.mHintScreenTimeout = this.mHintScreenTimeout;
8296            that.mDismissalId = this.mDismissalId;
8297            that.mBridgeTag = this.mBridgeTag;
8298            return that;
8299        }
8300
8301        /**
8302         * Add a wearable action to this notification.
8303         *
8304         * <p>When wearable actions are added using this method, the set of actions that
8305         * show on a wearable device splits from devices that only show actions added
8306         * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8307         * of which actions display on different devices.
8308         *
8309         * @param action the action to add to this notification
8310         * @return this object for method chaining
8311         * @see android.app.Notification.Action
8312         */
8313        public WearableExtender addAction(Action action) {
8314            mActions.add(action);
8315            return this;
8316        }
8317
8318        /**
8319         * Adds wearable actions to this notification.
8320         *
8321         * <p>When wearable actions are added using this method, the set of actions that
8322         * show on a wearable device splits from devices that only show actions added
8323         * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8324         * of which actions display on different devices.
8325         *
8326         * @param actions the actions to add to this notification
8327         * @return this object for method chaining
8328         * @see android.app.Notification.Action
8329         */
8330        public WearableExtender addActions(List<Action> actions) {
8331            mActions.addAll(actions);
8332            return this;
8333        }
8334
8335        /**
8336         * Clear all wearable actions present on this builder.
8337         * @return this object for method chaining.
8338         * @see #addAction
8339         */
8340        public WearableExtender clearActions() {
8341            mActions.clear();
8342            return this;
8343        }
8344
8345        /**
8346         * Get the wearable actions present on this notification.
8347         */
8348        public List<Action> getActions() {
8349            return mActions;
8350        }
8351
8352        /**
8353         * Set an intent to launch inside of an activity view when displaying
8354         * this notification. The {@link PendingIntent} provided should be for an activity.
8355         *
8356         * <pre class="prettyprint">
8357         * Intent displayIntent = new Intent(context, MyDisplayActivity.class);
8358         * PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
8359         *         0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
8360         * Notification notif = new Notification.Builder(context)
8361         *         .extend(new Notification.WearableExtender()
8362         *                 .setDisplayIntent(displayPendingIntent)
8363         *                 .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM))
8364         *         .build();</pre>
8365         *
8366         * <p>The activity to launch needs to allow embedding, must be exported, and
8367         * should have an empty task affinity. It is also recommended to use the device
8368         * default light theme.
8369         *
8370         * <p>Example AndroidManifest.xml entry:
8371         * <pre class="prettyprint">
8372         * &lt;activity android:name=&quot;com.example.MyDisplayActivity&quot;
8373         *     android:exported=&quot;true&quot;
8374         *     android:allowEmbedded=&quot;true&quot;
8375         *     android:taskAffinity=&quot;&quot;
8376         *     android:theme=&quot;@android:style/Theme.DeviceDefault.Light&quot; /&gt;</pre>
8377         *
8378         * @param intent the {@link PendingIntent} for an activity
8379         * @return this object for method chaining
8380         * @see android.app.Notification.WearableExtender#getDisplayIntent
8381         */
8382        public WearableExtender setDisplayIntent(PendingIntent intent) {
8383            mDisplayIntent = intent;
8384            return this;
8385        }
8386
8387        /**
8388         * Get the intent to launch inside of an activity view when displaying this
8389         * notification. This {@code PendingIntent} should be for an activity.
8390         */
8391        public PendingIntent getDisplayIntent() {
8392            return mDisplayIntent;
8393        }
8394
8395        /**
8396         * Add an additional page of content to display with this notification. The current
8397         * notification forms the first page, and pages added using this function form
8398         * subsequent pages. This field can be used to separate a notification into multiple
8399         * sections.
8400         *
8401         * @param page the notification to add as another page
8402         * @return this object for method chaining
8403         * @see android.app.Notification.WearableExtender#getPages
8404         */
8405        public WearableExtender addPage(Notification page) {
8406            mPages.add(page);
8407            return this;
8408        }
8409
8410        /**
8411         * Add additional pages of content to display with this notification. The current
8412         * notification forms the first page, and pages added using this function form
8413         * subsequent pages. This field can be used to separate a notification into multiple
8414         * sections.
8415         *
8416         * @param pages a list of notifications
8417         * @return this object for method chaining
8418         * @see android.app.Notification.WearableExtender#getPages
8419         */
8420        public WearableExtender addPages(List<Notification> pages) {
8421            mPages.addAll(pages);
8422            return this;
8423        }
8424
8425        /**
8426         * Clear all additional pages present on this builder.
8427         * @return this object for method chaining.
8428         * @see #addPage
8429         */
8430        public WearableExtender clearPages() {
8431            mPages.clear();
8432            return this;
8433        }
8434
8435        /**
8436         * Get the array of additional pages of content for displaying this notification. The
8437         * current notification forms the first page, and elements within this array form
8438         * subsequent pages. This field can be used to separate a notification into multiple
8439         * sections.
8440         * @return the pages for this notification
8441         */
8442        public List<Notification> getPages() {
8443            return mPages;
8444        }
8445
8446        /**
8447         * Set a background image to be displayed behind the notification content.
8448         * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8449         * will work with any notification style.
8450         *
8451         * @param background the background bitmap
8452         * @return this object for method chaining
8453         * @see android.app.Notification.WearableExtender#getBackground
8454         */
8455        public WearableExtender setBackground(Bitmap background) {
8456            mBackground = background;
8457            return this;
8458        }
8459
8460        /**
8461         * Get a background image to be displayed behind the notification content.
8462         * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8463         * will work with any notification style.
8464         *
8465         * @return the background image
8466         * @see android.app.Notification.WearableExtender#setBackground
8467         */
8468        public Bitmap getBackground() {
8469            return mBackground;
8470        }
8471
8472        /**
8473         * Set an icon that goes with the content of this notification.
8474         */
8475        @Deprecated
8476        public WearableExtender setContentIcon(int icon) {
8477            mContentIcon = icon;
8478            return this;
8479        }
8480
8481        /**
8482         * Get an icon that goes with the content of this notification.
8483         */
8484        @Deprecated
8485        public int getContentIcon() {
8486            return mContentIcon;
8487        }
8488
8489        /**
8490         * Set the gravity that the content icon should have within the notification display.
8491         * Supported values include {@link android.view.Gravity#START} and
8492         * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8493         * @see #setContentIcon
8494         */
8495        @Deprecated
8496        public WearableExtender setContentIconGravity(int contentIconGravity) {
8497            mContentIconGravity = contentIconGravity;
8498            return this;
8499        }
8500
8501        /**
8502         * Get the gravity that the content icon should have within the notification display.
8503         * Supported values include {@link android.view.Gravity#START} and
8504         * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8505         * @see #getContentIcon
8506         */
8507        @Deprecated
8508        public int getContentIconGravity() {
8509            return mContentIconGravity;
8510        }
8511
8512        /**
8513         * Set an action from this notification's actions to be clickable with the content of
8514         * this notification. This action will no longer display separately from the
8515         * notification's content.
8516         *
8517         * <p>For notifications with multiple pages, child pages can also have content actions
8518         * set, although the list of available actions comes from the main notification and not
8519         * from the child page's notification.
8520         *
8521         * @param actionIndex The index of the action to hoist onto the current notification page.
8522         *                    If wearable actions were added to the main notification, this index
8523         *                    will apply to that list, otherwise it will apply to the regular
8524         *                    actions list.
8525         */
8526        public WearableExtender setContentAction(int actionIndex) {
8527            mContentActionIndex = actionIndex;
8528            return this;
8529        }
8530
8531        /**
8532         * Get the index of the notification action, if any, that was specified as being clickable
8533         * with the content of this notification. This action will no longer display separately
8534         * from the notification's content.
8535         *
8536         * <p>For notifications with multiple pages, child pages can also have content actions
8537         * set, although the list of available actions comes from the main notification and not
8538         * from the child page's notification.
8539         *
8540         * <p>If wearable specific actions were added to the main notification, this index will
8541         * apply to that list, otherwise it will apply to the regular actions list.
8542         *
8543         * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected.
8544         */
8545        public int getContentAction() {
8546            return mContentActionIndex;
8547        }
8548
8549        /**
8550         * Set the gravity that this notification should have within the available viewport space.
8551         * Supported values include {@link android.view.Gravity#TOP},
8552         * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8553         * The default value is {@link android.view.Gravity#BOTTOM}.
8554         */
8555        @Deprecated
8556        public WearableExtender setGravity(int gravity) {
8557            mGravity = gravity;
8558            return this;
8559        }
8560
8561        /**
8562         * Get the gravity that this notification should have within the available viewport space.
8563         * Supported values include {@link android.view.Gravity#TOP},
8564         * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8565         * The default value is {@link android.view.Gravity#BOTTOM}.
8566         */
8567        @Deprecated
8568        public int getGravity() {
8569            return mGravity;
8570        }
8571
8572        /**
8573         * Set the custom size preset for the display of this notification out of the available
8574         * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8575         * {@link #SIZE_LARGE}.
8576         * <p>Some custom size presets are only applicable for custom display notifications created
8577         * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the
8578         * documentation for the preset in question. See also
8579         * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}.
8580         */
8581        @Deprecated
8582        public WearableExtender setCustomSizePreset(int sizePreset) {
8583            mCustomSizePreset = sizePreset;
8584            return this;
8585        }
8586
8587        /**
8588         * Get the custom size preset for the display of this notification out of the available
8589         * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8590         * {@link #SIZE_LARGE}.
8591         * <p>Some custom size presets are only applicable for custom display notifications created
8592         * using {@link #setDisplayIntent}. Check the documentation for the preset in question.
8593         * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}.
8594         */
8595        @Deprecated
8596        public int getCustomSizePreset() {
8597            return mCustomSizePreset;
8598        }
8599
8600        /**
8601         * Set the custom height in pixels for the display of this notification's content.
8602         * <p>This option is only available for custom display notifications created
8603         * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also
8604         * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and
8605         * {@link #getCustomContentHeight}.
8606         */
8607        @Deprecated
8608        public WearableExtender setCustomContentHeight(int height) {
8609            mCustomContentHeight = height;
8610            return this;
8611        }
8612
8613        /**
8614         * Get the custom height in pixels for the display of this notification's content.
8615         * <p>This option is only available for custom display notifications created
8616         * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and
8617         * {@link #setCustomContentHeight}.
8618         */
8619        @Deprecated
8620        public int getCustomContentHeight() {
8621            return mCustomContentHeight;
8622        }
8623
8624        /**
8625         * Set whether the scrolling position for the contents of this notification should start
8626         * at the bottom of the contents instead of the top when the contents are too long to
8627         * display within the screen.  Default is false (start scroll at the top).
8628         */
8629        public WearableExtender setStartScrollBottom(boolean startScrollBottom) {
8630            setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom);
8631            return this;
8632        }
8633
8634        /**
8635         * Get whether the scrolling position for the contents of this notification should start
8636         * at the bottom of the contents instead of the top when the contents are too long to
8637         * display within the screen. Default is false (start scroll at the top).
8638         */
8639        public boolean getStartScrollBottom() {
8640            return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0;
8641        }
8642
8643        /**
8644         * Set whether the content intent is available when the wearable device is not connected
8645         * to a companion device.  The user can still trigger this intent when the wearable device
8646         * is offline, but a visual hint will indicate that the content intent may not be available.
8647         * Defaults to true.
8648         */
8649        public WearableExtender setContentIntentAvailableOffline(
8650                boolean contentIntentAvailableOffline) {
8651            setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline);
8652            return this;
8653        }
8654
8655        /**
8656         * Get whether the content intent is available when the wearable device is not connected
8657         * to a companion device.  The user can still trigger this intent when the wearable device
8658         * is offline, but a visual hint will indicate that the content intent may not be available.
8659         * Defaults to true.
8660         */
8661        public boolean getContentIntentAvailableOffline() {
8662            return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0;
8663        }
8664
8665        /**
8666         * Set a hint that this notification's icon should not be displayed.
8667         * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise.
8668         * @return this object for method chaining
8669         */
8670        @Deprecated
8671        public WearableExtender setHintHideIcon(boolean hintHideIcon) {
8672            setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon);
8673            return this;
8674        }
8675
8676        /**
8677         * Get a hint that this notification's icon should not be displayed.
8678         * @return {@code true} if this icon should not be displayed, false otherwise.
8679         * The default value is {@code false} if this was never set.
8680         */
8681        @Deprecated
8682        public boolean getHintHideIcon() {
8683            return (mFlags & FLAG_HINT_HIDE_ICON) != 0;
8684        }
8685
8686        /**
8687         * Set a visual hint that only the background image of this notification should be
8688         * displayed, and other semantic content should be hidden. This hint is only applicable
8689         * to sub-pages added using {@link #addPage}.
8690         */
8691        @Deprecated
8692        public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) {
8693            setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly);
8694            return this;
8695        }
8696
8697        /**
8698         * Get a visual hint that only the background image of this notification should be
8699         * displayed, and other semantic content should be hidden. This hint is only applicable
8700         * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}.
8701         */
8702        @Deprecated
8703        public boolean getHintShowBackgroundOnly() {
8704            return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0;
8705        }
8706
8707        /**
8708         * Set a hint that this notification's background should not be clipped if possible,
8709         * and should instead be resized to fully display on the screen, retaining the aspect
8710         * ratio of the image. This can be useful for images like barcodes or qr codes.
8711         * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
8712         * @return this object for method chaining
8713         */
8714        @Deprecated
8715        public WearableExtender setHintAvoidBackgroundClipping(
8716                boolean hintAvoidBackgroundClipping) {
8717            setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping);
8718            return this;
8719        }
8720
8721        /**
8722         * Get a hint that this notification's background should not be clipped if possible,
8723         * and should instead be resized to fully display on the screen, retaining the aspect
8724         * ratio of the image. This can be useful for images like barcodes or qr codes.
8725         * @return {@code true} if it's ok if the background is clipped on the screen, false
8726         * otherwise. The default value is {@code false} if this was never set.
8727         */
8728        @Deprecated
8729        public boolean getHintAvoidBackgroundClipping() {
8730            return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0;
8731        }
8732
8733        /**
8734         * Set a hint that the screen should remain on for at least this duration when
8735         * this notification is displayed on the screen.
8736         * @param timeout The requested screen timeout in milliseconds. Can also be either
8737         *     {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8738         * @return this object for method chaining
8739         */
8740        @Deprecated
8741        public WearableExtender setHintScreenTimeout(int timeout) {
8742            mHintScreenTimeout = timeout;
8743            return this;
8744        }
8745
8746        /**
8747         * Get the duration, in milliseconds, that the screen should remain on for
8748         * when this notification is displayed.
8749         * @return the duration in milliseconds if > 0, or either one of the sentinel values
8750         *     {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8751         */
8752        @Deprecated
8753        public int getHintScreenTimeout() {
8754            return mHintScreenTimeout;
8755        }
8756
8757        /**
8758         * Set a hint that this notification's {@link BigPictureStyle} (if present) should be
8759         * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8760         * qr codes, as well as other simple black-and-white tickets.
8761         * @param hintAmbientBigPicture {@code true} to enable converstion and ambient.
8762         * @return this object for method chaining
8763         */
8764        public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) {
8765            setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture);
8766            return this;
8767        }
8768
8769        /**
8770         * Get a hint that this notification's {@link BigPictureStyle} (if present) should be
8771         * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8772         * qr codes, as well as other simple black-and-white tickets.
8773         * @return {@code true} if it should be displayed in ambient, false otherwise
8774         * otherwise. The default value is {@code false} if this was never set.
8775         */
8776        public boolean getHintAmbientBigPicture() {
8777            return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0;
8778        }
8779
8780        /**
8781         * Set a hint that this notification's content intent will launch an {@link Activity}
8782         * directly, telling the platform that it can generate the appropriate transitions.
8783         * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch
8784         * an activity and transitions should be generated, false otherwise.
8785         * @return this object for method chaining
8786         */
8787        public WearableExtender setHintContentIntentLaunchesActivity(
8788                boolean hintContentIntentLaunchesActivity) {
8789            setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity);
8790            return this;
8791        }
8792
8793        /**
8794         * Get a hint that this notification's content intent will launch an {@link Activity}
8795         * directly, telling the platform that it can generate the appropriate transitions
8796         * @return {@code true} if the content intent will launch an activity and transitions should
8797         * be generated, false otherwise. The default value is {@code false} if this was never set.
8798         */
8799        public boolean getHintContentIntentLaunchesActivity() {
8800            return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0;
8801        }
8802
8803        /**
8804         * Sets the dismissal id for this notification. If a notification is posted with a
8805         * dismissal id, then when that notification is canceled, notifications on other wearables
8806         * and the paired Android phone having that same dismissal id will also be canceled. See
8807         * <a href="{@docRoot}wear/notifications/index.html">Adding Wearable Features to
8808         * Notifications</a> for more information.
8809         * @param dismissalId the dismissal id of the notification.
8810         * @return this object for method chaining
8811         */
8812        public WearableExtender setDismissalId(String dismissalId) {
8813            mDismissalId = dismissalId;
8814            return this;
8815        }
8816
8817        /**
8818         * Returns the dismissal id of the notification.
8819         * @return the dismissal id of the notification or null if it has not been set.
8820         */
8821        public String getDismissalId() {
8822            return mDismissalId;
8823        }
8824
8825        /**
8826         * Sets a bridge tag for this notification. A bridge tag can be set for notifications
8827         * posted from a phone to provide finer-grained control on what notifications are bridged
8828         * to wearables. See <a href="{@docRoot}wear/notifications/index.html">Adding Wearable
8829         * Features to Notifications</a> for more information.
8830         * @param bridgeTag the bridge tag of the notification.
8831         * @return this object for method chaining
8832         */
8833        public WearableExtender setBridgeTag(String bridgeTag) {
8834            mBridgeTag = bridgeTag;
8835            return this;
8836        }
8837
8838        /**
8839         * Returns the bridge tag of the notification.
8840         * @return the bridge tag or null if not present.
8841         */
8842        public String getBridgeTag() {
8843            return mBridgeTag;
8844        }
8845
8846        private void setFlag(int mask, boolean value) {
8847            if (value) {
8848                mFlags |= mask;
8849            } else {
8850                mFlags &= ~mask;
8851            }
8852        }
8853    }
8854
8855    /**
8856     * <p>Helper class to add Android Auto extensions to notifications. To create a notification
8857     * with car extensions:
8858     *
8859     * <ol>
8860     *  <li>Create an {@link Notification.Builder}, setting any desired
8861     *  properties.
8862     *  <li>Create a {@link CarExtender}.
8863     *  <li>Set car-specific properties using the {@code add} and {@code set} methods of
8864     *  {@link CarExtender}.
8865     *  <li>Call {@link Notification.Builder#extend(Notification.Extender)}
8866     *  to apply the extensions to a notification.
8867     * </ol>
8868     *
8869     * <pre class="prettyprint">
8870     * Notification notification = new Notification.Builder(context)
8871     *         ...
8872     *         .extend(new CarExtender()
8873     *                 .set*(...))
8874     *         .build();
8875     * </pre>
8876     *
8877     * <p>Car extensions can be accessed on an existing notification by using the
8878     * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods
8879     * to access values.
8880     */
8881    public static final class CarExtender implements Extender {
8882        private static final String TAG = "CarExtender";
8883
8884        private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS";
8885        private static final String EXTRA_LARGE_ICON = "large_icon";
8886        private static final String EXTRA_CONVERSATION = "car_conversation";
8887        private static final String EXTRA_COLOR = "app_color";
8888
8889        private Bitmap mLargeIcon;
8890        private UnreadConversation mUnreadConversation;
8891        private int mColor = Notification.COLOR_DEFAULT;
8892
8893        /**
8894         * Create a {@link CarExtender} with default options.
8895         */
8896        public CarExtender() {
8897        }
8898
8899        /**
8900         * Create a {@link CarExtender} from the CarExtender options of an existing Notification.
8901         *
8902         * @param notif The notification from which to copy options.
8903         */
8904        public CarExtender(Notification notif) {
8905            Bundle carBundle = notif.extras == null ?
8906                    null : notif.extras.getBundle(EXTRA_CAR_EXTENDER);
8907            if (carBundle != null) {
8908                mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON);
8909                mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT);
8910
8911                Bundle b = carBundle.getBundle(EXTRA_CONVERSATION);
8912                mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b);
8913            }
8914        }
8915
8916        /**
8917         * Apply car extensions to a notification that is being built. This is typically called by
8918         * the {@link Notification.Builder#extend(Notification.Extender)}
8919         * method of {@link Notification.Builder}.
8920         */
8921        @Override
8922        public Notification.Builder extend(Notification.Builder builder) {
8923            Bundle carExtensions = new Bundle();
8924
8925            if (mLargeIcon != null) {
8926                carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon);
8927            }
8928            if (mColor != Notification.COLOR_DEFAULT) {
8929                carExtensions.putInt(EXTRA_COLOR, mColor);
8930            }
8931
8932            if (mUnreadConversation != null) {
8933                Bundle b = mUnreadConversation.getBundleForUnreadConversation();
8934                carExtensions.putBundle(EXTRA_CONVERSATION, b);
8935            }
8936
8937            builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions);
8938            return builder;
8939        }
8940
8941        /**
8942         * Sets the accent color to use when Android Auto presents the notification.
8943         *
8944         * Android Auto uses the color set with {@link Notification.Builder#setColor(int)}
8945         * to accent the displayed notification. However, not all colors are acceptable in an
8946         * automotive setting. This method can be used to override the color provided in the
8947         * notification in such a situation.
8948         */
8949        public CarExtender setColor(@ColorInt int color) {
8950            mColor = color;
8951            return this;
8952        }
8953
8954        /**
8955         * Gets the accent color.
8956         *
8957         * @see #setColor
8958         */
8959        @ColorInt
8960        public int getColor() {
8961            return mColor;
8962        }
8963
8964        /**
8965         * Sets the large icon of the car notification.
8966         *
8967         * If no large icon is set in the extender, Android Auto will display the icon
8968         * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)}
8969         *
8970         * @param largeIcon The large icon to use in the car notification.
8971         * @return This object for method chaining.
8972         */
8973        public CarExtender setLargeIcon(Bitmap largeIcon) {
8974            mLargeIcon = largeIcon;
8975            return this;
8976        }
8977
8978        /**
8979         * Gets the large icon used in this car notification, or null if no icon has been set.
8980         *
8981         * @return The large icon for the car notification.
8982         * @see CarExtender#setLargeIcon
8983         */
8984        public Bitmap getLargeIcon() {
8985            return mLargeIcon;
8986        }
8987
8988        /**
8989         * Sets the unread conversation in a message notification.
8990         *
8991         * @param unreadConversation The unread part of the conversation this notification conveys.
8992         * @return This object for method chaining.
8993         */
8994        public CarExtender setUnreadConversation(UnreadConversation unreadConversation) {
8995            mUnreadConversation = unreadConversation;
8996            return this;
8997        }
8998
8999        /**
9000         * Returns the unread conversation conveyed by this notification.
9001         * @see #setUnreadConversation(UnreadConversation)
9002         */
9003        public UnreadConversation getUnreadConversation() {
9004            return mUnreadConversation;
9005        }
9006
9007        /**
9008         * A class which holds the unread messages from a conversation.
9009         */
9010        public static class UnreadConversation {
9011            private static final String KEY_AUTHOR = "author";
9012            private static final String KEY_TEXT = "text";
9013            private static final String KEY_MESSAGES = "messages";
9014            private static final String KEY_REMOTE_INPUT = "remote_input";
9015            private static final String KEY_ON_REPLY = "on_reply";
9016            private static final String KEY_ON_READ = "on_read";
9017            private static final String KEY_PARTICIPANTS = "participants";
9018            private static final String KEY_TIMESTAMP = "timestamp";
9019
9020            private final String[] mMessages;
9021            private final RemoteInput mRemoteInput;
9022            private final PendingIntent mReplyPendingIntent;
9023            private final PendingIntent mReadPendingIntent;
9024            private final String[] mParticipants;
9025            private final long mLatestTimestamp;
9026
9027            UnreadConversation(String[] messages, RemoteInput remoteInput,
9028                    PendingIntent replyPendingIntent, PendingIntent readPendingIntent,
9029                    String[] participants, long latestTimestamp) {
9030                mMessages = messages;
9031                mRemoteInput = remoteInput;
9032                mReadPendingIntent = readPendingIntent;
9033                mReplyPendingIntent = replyPendingIntent;
9034                mParticipants = participants;
9035                mLatestTimestamp = latestTimestamp;
9036            }
9037
9038            /**
9039             * Gets the list of messages conveyed by this notification.
9040             */
9041            public String[] getMessages() {
9042                return mMessages;
9043            }
9044
9045            /**
9046             * Gets the remote input that will be used to convey the response to a message list, or
9047             * null if no such remote input exists.
9048             */
9049            public RemoteInput getRemoteInput() {
9050                return mRemoteInput;
9051            }
9052
9053            /**
9054             * Gets the pending intent that will be triggered when the user replies to this
9055             * notification.
9056             */
9057            public PendingIntent getReplyPendingIntent() {
9058                return mReplyPendingIntent;
9059            }
9060
9061            /**
9062             * Gets the pending intent that Android Auto will send after it reads aloud all messages
9063             * in this object's message list.
9064             */
9065            public PendingIntent getReadPendingIntent() {
9066                return mReadPendingIntent;
9067            }
9068
9069            /**
9070             * Gets the participants in the conversation.
9071             */
9072            public String[] getParticipants() {
9073                return mParticipants;
9074            }
9075
9076            /**
9077             * Gets the firs participant in the conversation.
9078             */
9079            public String getParticipant() {
9080                return mParticipants.length > 0 ? mParticipants[0] : null;
9081            }
9082
9083            /**
9084             * Gets the timestamp of the conversation.
9085             */
9086            public long getLatestTimestamp() {
9087                return mLatestTimestamp;
9088            }
9089
9090            Bundle getBundleForUnreadConversation() {
9091                Bundle b = new Bundle();
9092                String author = null;
9093                if (mParticipants != null && mParticipants.length > 1) {
9094                    author = mParticipants[0];
9095                }
9096                Parcelable[] messages = new Parcelable[mMessages.length];
9097                for (int i = 0; i < messages.length; i++) {
9098                    Bundle m = new Bundle();
9099                    m.putString(KEY_TEXT, mMessages[i]);
9100                    m.putString(KEY_AUTHOR, author);
9101                    messages[i] = m;
9102                }
9103                b.putParcelableArray(KEY_MESSAGES, messages);
9104                if (mRemoteInput != null) {
9105                    b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput);
9106                }
9107                b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent);
9108                b.putParcelable(KEY_ON_READ, mReadPendingIntent);
9109                b.putStringArray(KEY_PARTICIPANTS, mParticipants);
9110                b.putLong(KEY_TIMESTAMP, mLatestTimestamp);
9111                return b;
9112            }
9113
9114            static UnreadConversation getUnreadConversationFromBundle(Bundle b) {
9115                if (b == null) {
9116                    return null;
9117                }
9118                Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES);
9119                String[] messages = null;
9120                if (parcelableMessages != null) {
9121                    String[] tmp = new String[parcelableMessages.length];
9122                    boolean success = true;
9123                    for (int i = 0; i < tmp.length; i++) {
9124                        if (!(parcelableMessages[i] instanceof Bundle)) {
9125                            success = false;
9126                            break;
9127                        }
9128                        tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT);
9129                        if (tmp[i] == null) {
9130                            success = false;
9131                            break;
9132                        }
9133                    }
9134                    if (success) {
9135                        messages = tmp;
9136                    } else {
9137                        return null;
9138                    }
9139                }
9140
9141                PendingIntent onRead = b.getParcelable(KEY_ON_READ);
9142                PendingIntent onReply = b.getParcelable(KEY_ON_REPLY);
9143
9144                RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT);
9145
9146                String[] participants = b.getStringArray(KEY_PARTICIPANTS);
9147                if (participants == null || participants.length != 1) {
9148                    return null;
9149                }
9150
9151                return new UnreadConversation(messages,
9152                        remoteInput,
9153                        onReply,
9154                        onRead,
9155                        participants, b.getLong(KEY_TIMESTAMP));
9156            }
9157        };
9158
9159        /**
9160         * Builder class for {@link CarExtender.UnreadConversation} objects.
9161         */
9162        public static class Builder {
9163            private final List<String> mMessages = new ArrayList<String>();
9164            private final String mParticipant;
9165            private RemoteInput mRemoteInput;
9166            private PendingIntent mReadPendingIntent;
9167            private PendingIntent mReplyPendingIntent;
9168            private long mLatestTimestamp;
9169
9170            /**
9171             * Constructs a new builder for {@link CarExtender.UnreadConversation}.
9172             *
9173             * @param name The name of the other participant in the conversation.
9174             */
9175            public Builder(String name) {
9176                mParticipant = name;
9177            }
9178
9179            /**
9180             * Appends a new unread message to the list of messages for this conversation.
9181             *
9182             * The messages should be added from oldest to newest.
9183             *
9184             * @param message The text of the new unread message.
9185             * @return This object for method chaining.
9186             */
9187            public Builder addMessage(String message) {
9188                mMessages.add(message);
9189                return this;
9190            }
9191
9192            /**
9193             * Sets the pending intent and remote input which will convey the reply to this
9194             * notification.
9195             *
9196             * @param pendingIntent The pending intent which will be triggered on a reply.
9197             * @param remoteInput The remote input parcelable which will carry the reply.
9198             * @return This object for method chaining.
9199             *
9200             * @see CarExtender.UnreadConversation#getRemoteInput
9201             * @see CarExtender.UnreadConversation#getReplyPendingIntent
9202             */
9203            public Builder setReplyAction(
9204                    PendingIntent pendingIntent, RemoteInput remoteInput) {
9205                mRemoteInput = remoteInput;
9206                mReplyPendingIntent = pendingIntent;
9207
9208                return this;
9209            }
9210
9211            /**
9212             * Sets the pending intent that will be sent once the messages in this notification
9213             * are read.
9214             *
9215             * @param pendingIntent The pending intent to use.
9216             * @return This object for method chaining.
9217             */
9218            public Builder setReadPendingIntent(PendingIntent pendingIntent) {
9219                mReadPendingIntent = pendingIntent;
9220                return this;
9221            }
9222
9223            /**
9224             * Sets the timestamp of the most recent message in an unread conversation.
9225             *
9226             * If a messaging notification has been posted by your application and has not
9227             * yet been cancelled, posting a later notification with the same id and tag
9228             * but without a newer timestamp may result in Android Auto not displaying a
9229             * heads up notification for the later notification.
9230             *
9231             * @param timestamp The timestamp of the most recent message in the conversation.
9232             * @return This object for method chaining.
9233             */
9234            public Builder setLatestTimestamp(long timestamp) {
9235                mLatestTimestamp = timestamp;
9236                return this;
9237            }
9238
9239            /**
9240             * Builds a new unread conversation object.
9241             *
9242             * @return The new unread conversation object.
9243             */
9244            public UnreadConversation build() {
9245                String[] messages = mMessages.toArray(new String[mMessages.size()]);
9246                String[] participants = { mParticipant };
9247                return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent,
9248                        mReadPendingIntent, participants, mLatestTimestamp);
9249            }
9250        }
9251    }
9252
9253    /**
9254     * <p>Helper class to add Android TV extensions to notifications. To create a notification
9255     * with a TV extension:
9256     *
9257     * <ol>
9258     *  <li>Create an {@link Notification.Builder}, setting any desired properties.
9259     *  <li>Create a {@link TvExtender}.
9260     *  <li>Set TV-specific properties using the {@code set} methods of
9261     *  {@link TvExtender}.
9262     *  <li>Call {@link Notification.Builder#extend(Notification.Extender)}
9263     *  to apply the extension to a notification.
9264     * </ol>
9265     *
9266     * <pre class="prettyprint">
9267     * Notification notification = new Notification.Builder(context)
9268     *         ...
9269     *         .extend(new TvExtender()
9270     *                 .set*(...))
9271     *         .build();
9272     * </pre>
9273     *
9274     * <p>TV extensions can be accessed on an existing notification by using the
9275     * {@code TvExtender(Notification)} constructor, and then using the {@code get} methods
9276     * to access values.
9277     *
9278     * @hide
9279     */
9280    @SystemApi
9281    public static final class TvExtender implements Extender {
9282        private static final String TAG = "TvExtender";
9283
9284        private static final String EXTRA_TV_EXTENDER = "android.tv.EXTENSIONS";
9285        private static final String EXTRA_FLAGS = "flags";
9286        private static final String EXTRA_CONTENT_INTENT = "content_intent";
9287        private static final String EXTRA_DELETE_INTENT = "delete_intent";
9288        private static final String EXTRA_CHANNEL_ID = "channel_id";
9289        private static final String EXTRA_SUPPRESS_SHOW_OVER_APPS = "suppressShowOverApps";
9290
9291        // Flags bitwise-ored to mFlags
9292        private static final int FLAG_AVAILABLE_ON_TV = 0x1;
9293
9294        private int mFlags;
9295        private String mChannelId;
9296        private PendingIntent mContentIntent;
9297        private PendingIntent mDeleteIntent;
9298        private boolean mSuppressShowOverApps;
9299
9300        /**
9301         * Create a {@link TvExtender} with default options.
9302         */
9303        public TvExtender() {
9304            mFlags = FLAG_AVAILABLE_ON_TV;
9305        }
9306
9307        /**
9308         * Create a {@link TvExtender} from the TvExtender options of an existing Notification.
9309         *
9310         * @param notif The notification from which to copy options.
9311         */
9312        public TvExtender(Notification notif) {
9313            Bundle bundle = notif.extras == null ?
9314                null : notif.extras.getBundle(EXTRA_TV_EXTENDER);
9315            if (bundle != null) {
9316                mFlags = bundle.getInt(EXTRA_FLAGS);
9317                mChannelId = bundle.getString(EXTRA_CHANNEL_ID);
9318                mSuppressShowOverApps = bundle.getBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS);
9319                mContentIntent = bundle.getParcelable(EXTRA_CONTENT_INTENT);
9320                mDeleteIntent = bundle.getParcelable(EXTRA_DELETE_INTENT);
9321            }
9322        }
9323
9324        /**
9325         * Apply a TV extension to a notification that is being built. This is typically called by
9326         * the {@link Notification.Builder#extend(Notification.Extender)}
9327         * method of {@link Notification.Builder}.
9328         */
9329        @Override
9330        public Notification.Builder extend(Notification.Builder builder) {
9331            Bundle bundle = new Bundle();
9332
9333            bundle.putInt(EXTRA_FLAGS, mFlags);
9334            bundle.putString(EXTRA_CHANNEL_ID, mChannelId);
9335            bundle.putBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS, mSuppressShowOverApps);
9336            if (mContentIntent != null) {
9337                bundle.putParcelable(EXTRA_CONTENT_INTENT, mContentIntent);
9338            }
9339
9340            if (mDeleteIntent != null) {
9341                bundle.putParcelable(EXTRA_DELETE_INTENT, mDeleteIntent);
9342            }
9343
9344            builder.getExtras().putBundle(EXTRA_TV_EXTENDER, bundle);
9345            return builder;
9346        }
9347
9348        /**
9349         * Returns true if this notification should be shown on TV. This method return true
9350         * if the notification was extended with a TvExtender.
9351         */
9352        public boolean isAvailableOnTv() {
9353            return (mFlags & FLAG_AVAILABLE_ON_TV) != 0;
9354        }
9355
9356        /**
9357         * Specifies the channel the notification should be delivered on when shown on TV.
9358         * It can be different from the channel that the notification is delivered to when
9359         * posting on a non-TV device.
9360         */
9361        public TvExtender setChannel(String channelId) {
9362            mChannelId = channelId;
9363            return this;
9364        }
9365
9366        /**
9367         * Specifies the channel the notification should be delivered on when shown on TV.
9368         * It can be different from the channel that the notification is delivered to when
9369         * posting on a non-TV device.
9370         */
9371        public TvExtender setChannelId(String channelId) {
9372            mChannelId = channelId;
9373            return this;
9374        }
9375
9376        /** @removed */
9377        @Deprecated
9378        public String getChannel() {
9379            return mChannelId;
9380        }
9381
9382        /**
9383         * Returns the id of the channel this notification posts to on TV.
9384         */
9385        public String getChannelId() {
9386            return mChannelId;
9387        }
9388
9389        /**
9390         * Supplies a {@link PendingIntent} to be sent when the notification is selected on TV.
9391         * If provided, it is used instead of the content intent specified
9392         * at the level of Notification.
9393         */
9394        public TvExtender setContentIntent(PendingIntent intent) {
9395            mContentIntent = intent;
9396            return this;
9397        }
9398
9399        /**
9400         * Returns the TV-specific content intent.  If this method returns null, the
9401         * main content intent on the notification should be used.
9402         *
9403         * @see {@link Notification#contentIntent}
9404         */
9405        public PendingIntent getContentIntent() {
9406            return mContentIntent;
9407        }
9408
9409        /**
9410         * Supplies a {@link PendingIntent} to send when the notification is cleared explicitly
9411         * by the user on TV.  If provided, it is used instead of the delete intent specified
9412         * at the level of Notification.
9413         */
9414        public TvExtender setDeleteIntent(PendingIntent intent) {
9415            mDeleteIntent = intent;
9416            return this;
9417        }
9418
9419        /**
9420         * Returns the TV-specific delete intent.  If this method returns null, the
9421         * main delete intent on the notification should be used.
9422         *
9423         * @see {@link Notification#deleteIntent}
9424         */
9425        public PendingIntent getDeleteIntent() {
9426            return mDeleteIntent;
9427        }
9428
9429        /**
9430         * Specifies whether this notification should suppress showing a message over top of apps
9431         * outside of the launcher.
9432         */
9433        public TvExtender setSuppressShowOverApps(boolean suppress) {
9434            mSuppressShowOverApps = suppress;
9435            return this;
9436        }
9437
9438        /**
9439         * Returns true if this notification should not show messages over top of apps
9440         * outside of the launcher.
9441         */
9442        public boolean getSuppressShowOverApps() {
9443            return mSuppressShowOverApps;
9444        }
9445    }
9446
9447    /**
9448     * Get an array of Notification objects from a parcelable array bundle field.
9449     * Update the bundle to have a typed array so fetches in the future don't need
9450     * to do an array copy.
9451     */
9452    private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) {
9453        Parcelable[] array = bundle.getParcelableArray(key);
9454        if (array instanceof Notification[] || array == null) {
9455            return (Notification[]) array;
9456        }
9457        Notification[] typedArray = Arrays.copyOf(array, array.length,
9458                Notification[].class);
9459        bundle.putParcelableArray(key, typedArray);
9460        return typedArray;
9461    }
9462
9463    private static class BuilderRemoteViews extends RemoteViews {
9464        public BuilderRemoteViews(Parcel parcel) {
9465            super(parcel);
9466        }
9467
9468        public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) {
9469            super(appInfo, layoutId);
9470        }
9471
9472        @Override
9473        public BuilderRemoteViews clone() {
9474            Parcel p = Parcel.obtain();
9475            writeToParcel(p, 0);
9476            p.setDataPosition(0);
9477            BuilderRemoteViews brv = new BuilderRemoteViews(p);
9478            p.recycle();
9479            return brv;
9480        }
9481    }
9482
9483    private static class StandardTemplateParams {
9484        boolean hasProgress = true;
9485        boolean ambient = false;
9486        CharSequence title;
9487        CharSequence text;
9488        CharSequence headerTextSecondary;
9489        boolean hideLargeIcon;
9490        public boolean alwaysShowReply;
9491
9492        final StandardTemplateParams reset() {
9493            hasProgress = true;
9494            ambient = false;
9495            title = null;
9496            text = null;
9497            headerTextSecondary = null;
9498            return this;
9499        }
9500
9501        final StandardTemplateParams hasProgress(boolean hasProgress) {
9502            this.hasProgress = hasProgress;
9503            return this;
9504        }
9505
9506        final StandardTemplateParams title(CharSequence title) {
9507            this.title = title;
9508            return this;
9509        }
9510
9511        final StandardTemplateParams text(CharSequence text) {
9512            this.text = text;
9513            return this;
9514        }
9515
9516        final StandardTemplateParams headerTextSecondary(CharSequence text) {
9517            this.headerTextSecondary = text;
9518            return this;
9519        }
9520
9521        final StandardTemplateParams alwaysShowReply(boolean alwaysShowReply) {
9522            this.alwaysShowReply = alwaysShowReply;
9523            return this;
9524        }
9525
9526        final StandardTemplateParams hideLargeIcon(boolean hideLargeIcon) {
9527            this.hideLargeIcon = hideLargeIcon;
9528            return this;
9529        }
9530
9531        final StandardTemplateParams ambient(boolean ambient) {
9532            Preconditions.checkState(title == null && text == null, "must set ambient before text");
9533            this.ambient = ambient;
9534            return this;
9535        }
9536
9537        final StandardTemplateParams fillTextsFrom(Builder b) {
9538            Bundle extras = b.mN.extras;
9539            this.title = b.processLegacyText(extras.getCharSequence(EXTRA_TITLE), ambient);
9540
9541            // Big text notifications should contain their content when viewed in ambient mode.
9542            CharSequence text = extras.getCharSequence(EXTRA_BIG_TEXT);
9543            if (!ambient || TextUtils.isEmpty(text)) {
9544                text = extras.getCharSequence(EXTRA_TEXT);
9545            }
9546            this.text = b.processLegacyText(text, ambient);
9547            return this;
9548        }
9549    }
9550}
9551