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