blob: 6e38e28122f8df83e8567456dd38d7eb3209d768 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.app;
18
Selim Cinek389edcd2017-05-11 19:16:44 -070019import static com.android.internal.util.NotificationColorUtil.satisfiesTextContrast;
20
Tor Norbye80756e32015-03-02 09:39:27 -080021import android.annotation.ColorInt;
Tor Norbye7b9c9122013-05-30 16:48:33 -070022import android.annotation.DrawableRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070023import android.annotation.IntDef;
Alex Hillsfd590442016-10-07 09:52:44 -040024import android.annotation.NonNull;
Selim Cinek88188f22017-09-19 16:46:56 -070025import android.annotation.Nullable;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060026import android.annotation.RequiresPermission;
Daniel Sandler01df1c62014-06-09 10:54:01 -040027import android.annotation.SdkConstant;
28import android.annotation.SdkConstant.SdkConstantType;
Julia Reynoldse46bb372016-03-17 11:05:58 -040029import android.annotation.SystemApi;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030import android.content.Context;
31import android.content.Intent;
Kenny Guy77320062014-08-27 21:37:15 +010032import android.content.pm.ApplicationInfo;
Dan Sandler732bd6c2016-04-12 14:20:32 -040033import android.content.pm.PackageManager;
Christoph Studer4600f9b2014-07-22 22:44:43 +020034import android.content.pm.PackageManager.NameNotFoundException;
Julia Reynolds13d898c2017-02-02 12:22:05 -050035import android.content.pm.ShortcutInfo;
Jorim Jaggief72a192014-08-26 21:57:46 +020036import android.content.res.ColorStateList;
Anthony Chenad4d1582017-04-10 16:07:58 -070037import android.content.res.Configuration;
38import android.content.res.Resources;
Joe Onoratoef1e7762010-09-17 18:38:38 -040039import android.graphics.Bitmap;
Kenny Guy8a0101b2014-05-08 23:34:12 +010040import android.graphics.Canvas;
Adrian Roosc1a80b02016-04-05 14:54:55 -070041import android.graphics.Color;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +010042import android.graphics.PorterDuff;
Kenny Guy8a0101b2014-05-08 23:34:12 +010043import android.graphics.drawable.Drawable;
Dan Sandlerd63f9322015-05-06 15:18:49 -040044import android.graphics.drawable.Icon;
John Spurlockc0650f022014-07-19 13:22:39 -040045import android.media.AudioAttributes;
Jeff Sharkey098d5802012-04-26 17:30:34 -070046import android.media.AudioManager;
Jean-Michel Trivi2f7511f2016-11-28 15:40:27 -080047import android.media.PlayerBase;
Jeff Browndba34ba2014-06-24 20:46:03 -070048import android.media.session.MediaSession;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080049import android.net.Uri;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -040050import android.os.BadParcelableException;
Christoph Studer239f8352014-08-25 15:13:18 +020051import android.os.Build;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050052import android.os.Bundle;
Dianne Hackborn98305522017-05-05 17:53:53 -070053import android.os.IBinder;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080054import android.os.Parcel;
55import android.os.Parcelable;
Daniel Sandlera2985ed2012-04-03 16:42:00 -040056import android.os.SystemClock;
Selim Cinek6743c0b2017-01-18 18:24:01 -080057import android.os.SystemProperties;
Jeff Sharkey6d515712012-09-20 16:06:08 -070058import android.os.UserHandle;
Adrian Roosc1a80b02016-04-05 14:54:55 -070059import android.text.BidiFormatter;
Selim Cinek60a54252016-02-26 17:03:25 -080060import android.text.SpannableStringBuilder;
61import android.text.Spanned;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080062import android.text.TextUtils;
Selim Cinek60a54252016-02-26 17:03:25 -080063import android.text.style.AbsoluteSizeSpan;
Selim Cinek89991a22016-03-07 19:51:54 -080064import android.text.style.CharacterStyle;
Selim Cinek981962e2016-07-20 20:41:58 -070065import android.text.style.ForegroundColorSpan;
Selim Cinek60a54252016-02-26 17:03:25 -080066import android.text.style.RelativeSizeSpan;
67import android.text.style.TextAppearanceSpan;
Svet Ganovddb94882016-06-23 19:55:24 -070068import android.util.ArraySet;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -040069import android.util.Log;
Dan Sandler50128532015-12-08 15:42:41 -050070import android.util.SparseArray;
Yi Jin6b514142017-10-30 14:54:12 -070071import android.util.proto.ProtoOutputStream;
Griff Hazen61a9e862014-05-22 16:05:19 -070072import android.view.Gravity;
Selim Cinekea4bef72015-12-02 15:51:10 -080073import android.view.NotificationHeaderView;
Joe Onorato8595a3d2010-11-19 18:12:07 -080074import android.view.View;
Selim Cinek954cc232016-05-20 13:29:23 -070075import android.view.ViewGroup;
Jeff Sharkey1c400132011-08-05 14:50:13 -070076import android.widget.ProgressBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080077import android.widget.RemoteViews;
78
Griff Hazen959591e2014-05-15 22:26:18 -070079import com.android.internal.R;
Selim Cinek389edcd2017-05-11 19:16:44 -070080import com.android.internal.annotations.VisibleForTesting;
Svet Ganovddb94882016-06-23 19:55:24 -070081import com.android.internal.util.ArrayUtils;
Griff Hazenc091ba82014-05-16 10:13:26 -070082import com.android.internal.util.NotificationColorUtil;
Adrian Roos0bc3f6a2017-03-06 11:54:05 -080083import com.android.internal.util.Preconditions;
Griff Hazen959591e2014-05-15 22:26:18 -070084
Tor Norbyed9273d62013-05-30 15:59:53 -070085import java.lang.annotation.Retention;
86import java.lang.annotation.RetentionPolicy;
Christoph Studer4600f9b2014-07-22 22:44:43 +020087import java.lang.reflect.Constructor;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050088import java.util.ArrayList;
Griff Hazen61a9e862014-05-22 16:05:19 -070089import java.util.Arrays;
Griff Hazen5cadc3b2014-05-20 09:55:39 -070090import java.util.Collections;
Griff Hazen61a9e862014-05-22 16:05:19 -070091import java.util.List;
Julia Reynolds7217dc92018-03-07 12:12:09 -050092import java.util.Objects;
Dan Sandler50128532015-12-08 15:42:41 -050093import java.util.Set;
Joe Onorato561d3852010-11-20 18:09:34 -080094
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080095/**
96 * A class that represents how a persistent notification is to be presented to
97 * the user using the {@link android.app.NotificationManager}.
98 *
Joe Onoratocb109a02011-01-18 17:57:41 -080099 * <p>The {@link Notification.Builder Notification.Builder} has been added to make it
100 * easier to construct Notifications.</p>
101 *
Joe Fernandez558459f2011-10-13 16:47:36 -0700102 * <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>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800108 */
109public class Notification implements Parcelable
110{
Daniel Sandlerdcbaf662013-04-26 16:23:09 -0400111 private static final String TAG = "Notification";
112
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800113 /**
Daniel Sandler01df1c62014-06-09 10:54:01 -0400114 * An activity that provides a user interface for adjusting notification preferences for its
Julia Reynolds3aedded2017-03-31 14:42:09 -0400115 * containing application.
Daniel Sandler01df1c62014-06-09 10:54:01 -0400116 */
117 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
118 public static final String INTENT_CATEGORY_NOTIFICATION_PREFERENCES
119 = "android.intent.category.NOTIFICATION_PREFERENCES";
120
121 /**
Julia Reynolds2619b5e2017-02-09 09:58:15 -0500122 * 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
Julia Reynolds3aedded2017-03-31 14:42:09 -0400124 * what settings should be shown in the target app.
Julia Reynolds2619b5e2017-02-09 09:58:15 -0500125 */
126 public static final String EXTRA_CHANNEL_ID = "android.intent.extra.CHANNEL_ID";
127
128 /**
Julia Reynolds3aedded2017-03-31 14:42:09 -0400129 * Optional extra for {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}. If provided, will
Julia Reynolds005c8b92017-08-24 10:35:53 -0400130 * 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
Julia Reynolds3aedded2017-03-31 14:42:09 -0400137 * 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 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800150 * Use all default values (where applicable).
151 */
152 public static final int DEFAULT_ALL = ~0;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500153
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800154 /**
155 * Use the default notification sound. This will ignore any given
156 * {@link #sound}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500157 *
Chris Wren47c20a12014-06-18 17:27:29 -0400158 * <p>
159 * A notification that is noisy is more likely to be presented as a heads-up notification.
160 * </p>
161 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800162 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500163 */
164
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800165 public static final int DEFAULT_SOUND = 1;
166
167 /**
168 * Use the default notification vibrate. This will ignore any given
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500169 * {@link #vibrate}. Using phone vibration requires the
Scott Mainb8b36452009-04-26 15:50:49 -0700170 * {@link android.Manifest.permission#VIBRATE VIBRATE} permission.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500171 *
Chris Wren47c20a12014-06-18 17:27:29 -0400172 * <p>
173 * A notification that vibrates is more likely to be presented as a heads-up notification.
174 * </p>
175 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800176 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500177 */
178
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800179 public static final int DEFAULT_VIBRATE = 2;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500180
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800181 /**
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}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500185 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800186 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500187 */
188
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800189 public static final int DEFAULT_LIGHTS = 4;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500190
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800191 /**
Christoph Studer535ec612014-09-03 15:47:47 +0200192 * 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 /**
Adrian Roose458aa82015-12-08 16:17:19 -0800200 * Maximum entries of reply text that are accepted by Builder and friends.
201 */
202 private static final int MAX_REPLY_HISTORY = 5;
203
Selim Cinekde4de0e2018-01-24 16:21:07 -0800204
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
Adrian Roose458aa82015-12-08 16:17:19 -0800214 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500215 * A timestamp related to this notification, in milliseconds since the epoch.
Joe Malin8d40d042012-11-05 11:36:40 -0800216 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500217 * 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
Joe Malin8d40d042012-11-05 11:36:40 -0800222 * timestamped according to when the activity began.
223 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500224 * Some examples:
Joe Malin8d40d042012-11-05 11:36:40 -0800225 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500226 * <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.
Joe Malin8d40d042012-11-05 11:36:40 -0800233 * </ul>
234 *
Selim Cinek0ff1ce602016-04-05 18:27:16 -0700235 * 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)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800238 */
239 public long when;
240
241 /**
Selim Cinekb85f36fd2016-04-20 18:46:36 -0700242 * The creation time of the notification
243 */
244 private long creationTime;
245
246 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800247 * The resource id of a drawable to use as the icon in the status bar.
Dan Sandler86647982015-05-13 23:41:13 -0400248 *
249 * @deprecated Use {@link Builder#setSmallIcon(Icon)} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800250 */
Dan Sandler86647982015-05-13 23:41:13 -0400251 @Deprecated
Tor Norbye7b9c9122013-05-30 16:48:33 -0700252 @DrawableRes
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800253 public int icon;
254
255 /**
Joe Onorato46439ce2010-11-19 13:56:21 -0800256 * 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
Griff Hazen959591e2014-05-15 22:26:18 -0700260 * @see android.graphics.drawable.Drawable#setLevel
Joe Onorato46439ce2010-11-19 13:56:21 -0800261 */
262 public int iconLevel;
263
264 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500265 * The number of events that this notification represents. For example, in a new mail
266 * notification, this could be the number of unread messages.
Joe Malin8d40d042012-11-05 11:36:40 -0800267 *
Julia Reynolds30331982017-04-27 10:12:50 -0400268 * The system may or may not use this field to modify the appearance of the notification.
Julia Reynolds13d898c2017-02-02 12:22:05 -0500269 * Starting with {@link android.os.Build.VERSION_CODES#O}, the number may be displayed as a
270 * badge icon in Launchers that support badging.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800271 */
Julia Reynolds30331982017-04-27 10:12:50 -0400272 public int number = 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800273
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
Scott Main7aee61f2011-02-08 11:25:01 -0800278 * 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
Dianne Hackborn6ceca582012-01-10 15:24:26 -0800280 * 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.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800284 */
285 public PendingIntent contentIntent;
286
287 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500288 * 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.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800293 */
294 public PendingIntent deleteIntent;
295
296 /**
Dianne Hackborn170bae72010-09-03 15:14:28 -0700297 * An intent to launch instead of posting the notification to the status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -0800298 *
Chris Wren47c20a12014-06-18 17:27:29 -0400299 * <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 *
Joe Onoratocb109a02011-01-18 17:57:41 -0800304 * @see Notification.Builder#setFullScreenIntent
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400305 */
306 public PendingIntent fullScreenIntent;
307
308 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400309 * 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).
Joe Onoratoef1e7762010-09-17 18:38:38 -0400314 *
Joe Onorato46439ce2010-11-19 13:56:21 -0800315 * @see #tickerView
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800316 */
317 public CharSequence tickerText;
318
319 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400320 * Formerly, a view showing the {@link #tickerText}.
321 *
322 * No longer displayed in the status bar as of API 21.
Joe Onoratoef1e7762010-09-17 18:38:38 -0400323 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400324 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -0800325 public RemoteViews tickerView;
Joe Onoratoef1e7762010-09-17 18:38:38 -0400326
327 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400328 * The view that will represent this notification in the notification list (which is pulled
329 * down from the status bar).
330 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500331 * 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
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400333 * supplied with {@link Notification.Builder#setCustomContentView(RemoteViews)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800334 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400335 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800336 public RemoteViews contentView;
337
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400338 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -0400339 * A large-format version of {@link #contentView}, giving the Notification an
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400340 * opportunity to show more detail. The system UI may choose to show this
341 * instead of the normal content view at its discretion.
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400342 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500343 * As of N, this field may be null. The expanded notification view is determined by the
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400344 * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
345 * supplied with {@link Notification.Builder#setCustomBigContentView(RemoteViews)}.
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400346 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400347 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400348 public RemoteViews bigContentView;
349
Chris Wren8fd39ec2014-02-27 17:43:26 -0500350
351 /**
Chris Wren47c20a12014-06-18 17:27:29 -0400352 * 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.
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400356 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500357 * As of N, this field may be null. The heads-up notification view is determined by the
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400358 * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
359 * supplied with {@link Notification.Builder#setCustomHeadsUpContentView(RemoteViews)}.
Chris Wren8fd39ec2014-02-27 17:43:26 -0500360 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400361 @Deprecated
Chris Wren8fd39ec2014-02-27 17:43:26 -0500362 public RemoteViews headsUpContentView;
363
Julia Reynoldsfc640012018-02-21 12:25:27 -0500364 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
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400381 /**
Dan Sandler86647982015-05-13 23:41:13 -0400382 * A large bitmap to be shown in the notification content area.
383 *
384 * @deprecated Use {@link Builder#setLargeIcon(Icon)} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800385 */
Dan Sandler86647982015-05-13 23:41:13 -0400386 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -0800387 public Bitmap largeIcon;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800388
389 /**
390 * The sound to play.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500391 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800392 * <p>
Chris Wren47c20a12014-06-18 17:27:29 -0400393 * A notification that is noisy is more likely to be presented as a heads-up notification.
394 * </p>
395 *
396 * <p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500397 * To play the default notification sound, see {@link #defaults}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800398 * </p>
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500399 * @deprecated use {@link NotificationChannel#getSound()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800400 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500401 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800402 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
Jeff Sharkey098d5802012-04-26 17:30:34 -0700407 * default stream type is {@link AudioManager#STREAM_NOTIFICATION}.
John Spurlockc0650f022014-07-19 13:22:39 -0400408 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500409 * @deprecated Use {@link NotificationChannel#getAudioAttributes()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800410 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -0700411 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800412 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}.
John Spurlockc0650f022014-07-19 13:22:39 -0400418 *
419 * @deprecated Use {@link #audioAttributes} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800420 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -0700421 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800422 public int audioStreamType = STREAM_DEFAULT;
423
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800424 /**
John Spurlockc0650f022014-07-19 13:22:39 -0400425 * 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.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500434 *
435 * @deprecated use {@link NotificationChannel#getAudioAttributes()} instead.
John Spurlockc0650f022014-07-19 13:22:39 -0400436 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500437 @Deprecated
John Spurlockc0650f022014-07-19 13:22:39 -0400438 public AudioAttributes audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
439
440 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500441 * The pattern with which to vibrate.
442 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800443 * <p>
444 * To vibrate the default pattern, see {@link #defaults}.
445 * </p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500446 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800447 * @see android.os.Vibrator#vibrate(long[],int)
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500448 * @deprecated use {@link NotificationChannel#getVibrationPattern()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800449 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500450 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800451 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
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500458 * @deprecated use {@link NotificationChannel#shouldShowLights()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800459 */
Tor Norbye80756e32015-03-02 09:39:27 -0800460 @ColorInt
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500461 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800462 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
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500470 * @deprecated use {@link NotificationChannel#shouldShowLights()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800471 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500472 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800473 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
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500481 *
482 * @deprecated use {@link NotificationChannel#shouldShowLights()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800483 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500484 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800485 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>
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500494 *
495 * @deprecated use {@link NotificationChannel#getSound()} and
496 * {@link NotificationChannel#shouldShowLights()} and
497 * {@link NotificationChannel#shouldVibrate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800498 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500499 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800500 public int defaults;
501
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800502 /**
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
Ricardo Loo Forondaf8f6d0a2018-01-25 08:42:43 -0800514 * you pass are honored exactly. Use the system defaults if possible
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800515 * 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.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500518 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500519 * @deprecated use {@link NotificationChannel#shouldShowLights()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800520 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500521 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800522 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,
Scott Mainb8b36452009-04-26 15:50:49 -0700535 * the audio will be repeated until the notification is
536 * cancelled or the notification window is opened.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800537 */
538 public static final int FLAG_INSISTENT = 0x00000004;
539
540 /**
541 * Bit to be bitwise-ored into the {@link #flags} field that should be
Griff Hazen293977b2014-04-28 08:37:20 -0700542 * set if you would only like the sound, vibrate and ticker to be played
543 * if the notification was not already showing.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800544 */
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
Daniel Sandler8aa9ae62012-12-04 23:31:47 -0500550 * user.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800551 */
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
Dianne Hackbornd8a43f62009-08-17 23:33:56 -0700561 /**
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
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400568 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500569 * Obsolete flag indicating high-priority notifications; use the priority field instead.
Joe Malin8d40d042012-11-05 11:36:40 -0800570 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500571 * @deprecated Use {@link #priority} with a positive value.
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400572 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700573 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500574 public static final int FLAG_HIGH_PRIORITY = 0x00000080;
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400575
Griff Hazendfcb0802014-02-11 12:00:00 -0800576 /**
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
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700583 /**
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
Julia Reynoldse46bb372016-03-17 11:05:58 -0400591 /**
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
Julia Reynolds4db59552017-06-30 13:34:01 -0400600 /**
601 * @hide
602 */
603 public static final int FLAG_CAN_COLORIZE = 0x00000800;
604
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800605 public int flags;
606
Tor Norbyed9273d62013-05-30 15:59:53 -0700607 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -0700608 @IntDef(prefix = { "PRIORITY_" }, value = {
609 PRIORITY_DEFAULT,
610 PRIORITY_LOW,
611 PRIORITY_MIN,
612 PRIORITY_HIGH,
613 PRIORITY_MAX
614 })
Tor Norbyed9273d62013-05-30 15:59:53 -0700615 @Retention(RetentionPolicy.SOURCE)
616 public @interface Priority {}
617
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800618 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500619 * Default notification {@link #priority}. If your application does not prioritize its own
620 * notifications, use this value for all notifications.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500621 *
622 * @deprecated use {@link NotificationManager#IMPORTANCE_DEFAULT} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500623 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500624 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500625 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.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500631 *
632 * @deprecated use {@link NotificationManager#IMPORTANCE_LOW} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500633 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500634 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500635 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.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500640 *
641 * @deprecated use {@link NotificationManager#IMPORTANCE_MIN} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500642 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500643 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500644 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.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500650 *
651 * @deprecated use {@link NotificationManager#IMPORTANCE_HIGH} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500652 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500653 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500654 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.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500659 *
660 * @deprecated use {@link NotificationManager#IMPORTANCE_HIGH} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500661 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500662 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500663 public static final int PRIORITY_MAX = 2;
664
665 /**
666 * Relative priority for this notification.
Joe Malin8d40d042012-11-05 11:36:40 -0800667 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500668 * 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
Daniel Sandler6738eee2012-11-16 12:03:32 -0500671 * system will make a determination about how to interpret this priority when presenting
672 * the notification.
Chris Wren47c20a12014-06-18 17:27:29 -0400673 *
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 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500679 * @deprecated use {@link NotificationChannel#getImportance()} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500680 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700681 @Priority
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500682 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500683 public int priority;
Joe Malin8d40d042012-11-05 11:36:40 -0800684
Dan Sandler26e81cf2014-05-06 10:01:27 -0400685 /**
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 */
Tor Norbye80756e32015-03-02 09:39:27 -0800693 @ColorInt
Dan Sandler26e81cf2014-05-06 10:01:27 -0400694 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 */
Tor Norbye80756e32015-03-02 09:39:27 -0800700 @ColorInt
Dan Sandler26e81cf2014-05-06 10:01:27 -0400701 public static final int COLOR_DEFAULT = 0; // AKA Color.TRANSPARENT
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600702
703 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -0800704 * Special value of {@link #color} used as a place holder for an invalid color.
Selim Cinek99104832017-01-25 14:47:33 -0800705 * @hide
Adrian Roos4ff3b122016-02-01 12:26:13 -0800706 */
707 @ColorInt
Selim Cinek99104832017-01-25 14:47:33 -0800708 public static final int COLOR_INVALID = 1;
Adrian Roos4ff3b122016-02-01 12:26:13 -0800709
710 /**
Adrian Roosc1a80b02016-04-05 14:54:55 -0700711 * 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
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600713 * 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 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600728 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 {}
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600738
Griff Hazenfc3922d2014-08-20 11:56:44 -0700739 /**
740 * Notification visibility: Show this notification in its entirety on all lockscreens.
741 *
742 * {@see #visibility}
743 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600744 public static final int VISIBILITY_PUBLIC = 1;
Griff Hazenfc3922d2014-08-20 11:56:44 -0700745
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 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600752 public static final int VISIBILITY_PRIVATE = 0;
Griff Hazenfc3922d2014-08-20 11:56:44 -0700753
754 /**
755 * Notification visibility: Do not reveal any part of this notification on a secure lockscreen.
756 *
757 * {@see #visibility}
758 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600759 public static final int VISIBILITY_SECRET = -1;
760
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500761 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400762 * Notification category: incoming call (voice or video) or similar synchronous communication request.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500763 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400764 public static final String CATEGORY_CALL = "call";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500765
766 /**
Adora Zhangaa90e872018-03-12 14:07:50 -0700767 * Notification category: map turn-by-turn navigation.
768 */
769 public static final String CATEGORY_NAVIGATION = "navigation";
770
771 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400772 * Notification category: incoming direct message (SMS, instant message, etc.).
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500773 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400774 public static final String CATEGORY_MESSAGE = "msg";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500775
776 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400777 * Notification category: asynchronous bulk message (email).
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500778 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400779 public static final String CATEGORY_EMAIL = "email";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500780
781 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400782 * Notification category: calendar event.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500783 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400784 public static final String CATEGORY_EVENT = "event";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500785
786 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400787 * Notification category: promotion or advertisement.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500788 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400789 public static final String CATEGORY_PROMO = "promo";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500790
791 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400792 * Notification category: alarm or timer.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500793 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400794 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 /**
John Spurlock0a69c8c2014-03-21 13:30:57 -0400827 * 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 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400834 * Notification category: ongoing information about device or contextual status.
835 */
836 public static final String CATEGORY_STATUS = "status";
837
838 /**
John Spurlock24d3dad2015-04-02 12:24:02 -0400839 * Notification category: user-scheduled reminder.
840 */
841 public static final String CATEGORY_REMINDER = "reminder";
842
843 /**
Adora Zhangaa90e872018-03-12 14:07:50 -0700844 * 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 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400865 * 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;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500869
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700870 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
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500898 /**
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400899 * Additional semantic data to be carried around with this Notification.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400900 * <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.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500905 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400906 public Bundle extras = new Bundle();
907
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400908 /**
Felipe Lemedd85da62016-06-28 11:29:54 -0700909 * 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
Svet Ganovddb94882016-06-23 19:55:24 -0700911 * custom parcelable objects.
912 *
913 * @hide
914 */
Felipe Lemedd85da62016-06-28 11:29:54 -0700915 public ArraySet<PendingIntent> allPendingIntents;
Svet Ganovddb94882016-06-23 19:55:24 -0700916
917 /**
Dianne Hackborn98305522017-05-05 17:53:53 -0700918 * 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 */
Adrian Roosfb921842017-10-26 14:49:56 +0200923 private IBinder mWhitelistToken;
Dianne Hackborn98305522017-05-05 17:53:53 -0700924
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 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400934 * {@link #extras} key: this is the title of the notification,
935 * as supplied to {@link Builder#setContentTitle(CharSequence)}.
936 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500937 public static final String EXTRA_TITLE = "android.title";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400938
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 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400943 public static final String EXTRA_TITLE_BIG = EXTRA_TITLE + ".big";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400944
945 /**
946 * {@link #extras} key: this is the main text payload, as supplied to
947 * {@link Builder#setContentText(CharSequence)}.
948 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500949 public static final String EXTRA_TEXT = "android.text";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400950
951 /**
952 * {@link #extras} key: this is a third line of text, as supplied to
953 * {@link Builder#setSubText(CharSequence)}.
954 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400955 public static final String EXTRA_SUB_TEXT = "android.subText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400956
957 /**
Adrian Roose458aa82015-12-08 16:17:19 -0800958 * {@link #extras} key: this is the remote input history, as supplied to
959 * {@link Builder#setRemoteInputHistory(CharSequence[])}.
Adrian Roos005e7742016-04-13 15:02:20 -0700960 *
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[])
Adrian Roose458aa82015-12-08 16:17:19 -0800970 */
971 public static final String EXTRA_REMOTE_INPUT_HISTORY = "android.remoteInputHistory";
972
973 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400974 * {@link #extras} key: this is a small piece of additional text as supplied to
975 * {@link Builder#setContentInfo(CharSequence)}.
976 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400977 public static final String EXTRA_INFO_TEXT = "android.infoText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400978
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 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400984 public static final String EXTRA_SUMMARY_TEXT = "android.summaryText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400985
986 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +0200987 * {@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 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400994 * {@link #extras} key: this is the resource ID of the notification's main small icon, as
995 * supplied to {@link Builder#setSmallIcon(int)}.
Julia Reynoldse071abd2017-03-22 10:52:11 -0400996 *
997 * @deprecated Use {@link #getSmallIcon()}, which supports a wider variety of icon sources.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400998 */
Julia Reynoldse071abd2017-03-22 10:52:11 -0400999 @Deprecated
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001000 public static final String EXTRA_SMALL_ICON = "android.icon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001001
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)}.
Julia Reynoldse071abd2017-03-22 10:52:11 -04001006 *
1007 * @deprecated Use {@link #getLargeIcon()}, which supports a wider variety of icon sources.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001008 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04001009 @Deprecated
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001010 public static final String EXTRA_LARGE_ICON = "android.largeIcon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001011
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 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001018 public static final String EXTRA_LARGE_ICON_BIG = EXTRA_LARGE_ICON + ".big";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001019
1020 /**
1021 * {@link #extras} key: this is the progress value supplied to
1022 * {@link Builder#setProgress(int, int, boolean)}.
1023 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001024 public static final String EXTRA_PROGRESS = "android.progress";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001025
1026 /**
1027 * {@link #extras} key: this is the maximum value supplied to
1028 * {@link Builder#setProgress(int, int, boolean)}.
1029 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001030 public static final String EXTRA_PROGRESS_MAX = "android.progressMax";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001031
1032 /**
1033 * {@link #extras} key: whether the progress bar is indeterminate, supplied to
1034 * {@link Builder#setProgress(int, int, boolean)}.
1035 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001036 public static final String EXTRA_PROGRESS_INDETERMINATE = "android.progressIndeterminate";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001037
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 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001043 public static final String EXTRA_SHOW_CHRONOMETER = "android.showChronometer";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001044
1045 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08001046 * {@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.
Adrian Roos96b7e202016-05-17 13:50:38 -07001048 * This extra is a boolean. The default is false.
Selim Cinek81c23aa2016-02-25 16:23:13 -08001049 */
Adrian Roos96b7e202016-05-17 13:50:38 -07001050 public static final String EXTRA_CHRONOMETER_COUNT_DOWN = "android.chronometerCountDown";
Selim Cinek81c23aa2016-02-25 16:23:13 -08001051
1052 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001053 * {@link #extras} key: whether {@link #when} should be shown,
1054 * as supplied to {@link Builder#setShowWhen(boolean)}.
1055 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001056 public static final String EXTRA_SHOW_WHEN = "android.showWhen";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001057
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 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001062 public static final String EXTRA_PICTURE = "android.picture";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001063
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 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001068 public static final String EXTRA_TEXT_LINES = "android.textLines";
Dan Sandler842dd772014-05-15 09:36:47 -04001069
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 */
Chris Wren91ad5632013-06-05 15:05:57 -04001074 public static final String EXTRA_TEMPLATE = "android.template";
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001075
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001076 /**
Chris Wrene6c48932014-09-29 17:19:27 -04001077 * {@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)}.
Selim Cineke7238dd2017-12-14 17:48:32 -08001079 *
1080 * @deprecated the actual objects are now in {@link #EXTRA_PEOPLE_LIST}
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001081 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001082 public static final String EXTRA_PEOPLE = "android.people";
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001083
1084 /**
Selim Cineke7238dd2017-12-14 17:48:32 -08001085 * {@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 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04001091 * 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 */
Maurice Lam96c10032017-03-29 15:42:38 -07001095 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001096 @RequiresPermission(android.Manifest.permission.NOTIFICATION_DURING_SETUP)
John Spurlockfd7f1e02014-03-18 16:41:57 -04001097 public static final String EXTRA_ALLOW_DURING_SETUP = "android.allowDuringSetup";
1098
1099 /**
Jose Limae9e3b3b2014-05-18 23:44:50 -07001100 * {@link #extras} key: A
1101 * {@link android.content.ContentUris content URI} pointing to an image that can be displayed
Julia Reynoldse0d711f2017-09-01 08:50:47 -04001102 * 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
Jose Limae9e3b3b2014-05-18 23:44:50 -07001104 * {@link android.graphics.BitmapFactory#decodeStream(java.io.InputStream)
Julia Reynoldse0d711f2017-09-01 08:50:47 -04001105 * BitmapFactory.decodeStream}; all other content types will be ignored.
Jose Limae9e3b3b2014-05-18 23:44:50 -07001106 */
1107 public static final String EXTRA_BACKGROUND_IMAGE_URI = "android.backgroundImageUri";
1108
1109 /**
Dan Sandler842dd772014-05-15 09:36:47 -04001110 * {@link #extras} key: A
Jeff Browndba34ba2014-06-24 20:46:03 -07001111 * {@link android.media.session.MediaSession.Token} associated with a
Dan Sandler842dd772014-05-15 09:36:47 -04001112 * {@link android.app.Notification.MediaStyle} notification.
1113 */
1114 public static final String EXTRA_MEDIA_SESSION = "android.mediaSession";
1115
1116 /**
Bryan Mawhinneye191f902014-07-22 12:50:09 +01001117 * {@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
Christoph Studer943aa672014-08-03 20:31:16 +02001122 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04001123 * {@link #extras} key: the username to be displayed for all messages sent by the user including
1124 * direct replies
Adrian Roos96b7e202016-05-17 13:50:38 -07001125 * {@link android.app.Notification.MessagingStyle} notification. This extra is a
1126 * {@link CharSequence}
Selim Cinekcb8b9852017-12-15 18:01:52 -08001127 *
1128 * @deprecated use {@link #EXTRA_MESSAGING_PERSON}
Alex Hillsfc737de2016-03-23 17:33:02 -04001129 */
1130 public static final String EXTRA_SELF_DISPLAY_NAME = "android.selfDisplayName";
1131
1132 /**
Selim Cinekcb8b9852017-12-15 18:01:52 -08001133 * {@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 /**
Adrian Roos96b7e202016-05-17 13:50:38 -07001141 * {@link #extras} key: a {@link CharSequence} to be displayed as the title to a conversation
Alex Hillsd9b04d92016-04-11 16:38:16 -04001142 * represented by a {@link android.app.Notification.MessagingStyle}
Alex Hillsfc737de2016-03-23 17:33:02 -04001143 */
Alex Hillsd9b04d92016-04-11 16:38:16 -04001144 public static final String EXTRA_CONVERSATION_TITLE = "android.conversationTitle";
Alex Hillsfc737de2016-03-23 17:33:02 -04001145
1146 /**
1147 * {@link #extras} key: an array of {@link android.app.Notification.MessagingStyle.Message}
1148 * bundles provided by a
Adrian Roos96b7e202016-05-17 13:50:38 -07001149 * {@link android.app.Notification.MessagingStyle} notification. This extra is a parcelable
1150 * array of bundles.
Alex Hillsfc737de2016-03-23 17:33:02 -04001151 */
1152 public static final String EXTRA_MESSAGES = "android.messages";
1153
1154 /**
Adrian Roos437cd562017-01-18 15:47:03 -08001155 * {@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 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08001164 * {@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 /**
Selim Cinek7b9605b2017-01-19 17:36:00 -08001170 * {@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 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04001176 * @hide
1177 */
1178 public static final String EXTRA_BUILDER_APPLICATION_INFO = "android.appInfo";
1179
Selim Cinek247fa012016-02-18 09:50:48 -08001180 /**
1181 * @hide
1182 */
1183 public static final String EXTRA_CONTAINS_CUSTOM_VIEW = "android.contains.customView";
1184
Shane Brennan472a3b32016-12-12 15:28:10 -08001185 /**
Selim Cinekd0426622017-07-11 13:19:59 +02001186 * @hide
1187 */
1188 public static final String EXTRA_REDUCED_IMAGES = "android.reduced.images";
1189
1190 /**
Shane Brennan472a3b32016-12-12 15:28:10 -08001191 * {@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
Dan Sandler80eaa592016-04-14 23:34:54 -04001216 /** @hide */
1217 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001218 @RequiresPermission(android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME)
Dan Sandler732bd6c2016-04-12 14:20:32 -04001219 public static final String EXTRA_SUBSTITUTE_APP_NAME = "android.substName";
1220
Dianne Hackbornfb5d4b52017-05-16 17:03:44 -07001221 /**
Julia Reynolds3c7de112018-03-28 09:33:13 -04001222 * 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.
Dianne Hackbornfb5d4b52017-05-16 17:03:44 -07001227 * @hide
1228 */
1229 public static final String EXTRA_FOREGROUND_APPS = "android.foregroundApps";
1230
Dan Sandlerd63f9322015-05-06 15:18:49 -04001231 private Icon mSmallIcon;
1232 private Icon mLargeIcon;
1233
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04001234 private String mChannelId;
Julia Reynolds2a128742016-11-28 14:29:25 -05001235 private long mTimeout;
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04001236
Julia Reynolds13d898c2017-02-02 12:22:05 -05001237 private String mShortcutId;
Julia Reynolds3aedded2017-03-31 14:42:09 -04001238 private CharSequence mSettingsText;
Julia Reynolds13d898c2017-02-02 12:22:05 -05001239
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001240 /** @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
Julia Reynolds399d9bf2017-08-11 12:52:14 -04001258 * mute this notification if this notification is a group child. This must be applied to all
1259 * children notifications you want to mute.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001260 *
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
Julia Reynolds399d9bf2017-08-11 12:52:14 -04001274 * 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.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001276 */
1277 public static final int GROUP_ALERT_CHILDREN = 2;
1278
Julia Reynolds2f431e22017-06-07 14:12:09 +00001279 private int mGroupAlertBehavior = GROUP_ALERT_ALL;
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001280
Julia Reynolds13d898c2017-02-02 12:22:05 -05001281 /**
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;
Julia Reynolds7d5b4da2017-03-20 10:18:49 -04001297 private int mBadgeIcon = BADGE_ICON_NONE;
Julia Reynolds13d898c2017-02-02 12:22:05 -05001298
Chris Wren51c75102013-07-16 20:49:17 -04001299 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001300 * 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>
Griff Hazen959591e2014-05-15 22:26:18 -07001304 * Apps should use {@link Notification.Builder#addAction(int, CharSequence, PendingIntent)}
1305 * or {@link Notification.Builder#addAction(Notification.Action)}
1306 * to attach actions.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001307 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -05001308 public static class Action implements Parcelable {
Shane Brennan472a3b32016-12-12 15:28:10 -08001309 /**
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
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001324 /**
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
Kodlee Yincda5b092018-02-15 15:34:53 -08001379 /**
1380 * {@code SemanticAction}: Call a contact, group, etc.
1381 */
1382 public static final int SEMANTIC_ACTION_CALL = 10;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001383
Griff Hazen959591e2014-05-15 22:26:18 -07001384 private final Bundle mExtras;
Dan Sandler86647982015-05-13 23:41:13 -04001385 private Icon mIcon;
Griff Hazen61a9e862014-05-22 16:05:19 -07001386 private final RemoteInput[] mRemoteInputs;
Alex Hills1f27f882017-01-12 11:24:46 -05001387 private boolean mAllowGeneratedReplies = true;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001388 private final @SemanticAction int mSemanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001389
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001390 /**
1391 * Small icon representing the action.
Dan Sandler86647982015-05-13 23:41:13 -04001392 *
1393 * @deprecated Use {@link Action#getIcon()} instead.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001394 */
Dan Sandler86647982015-05-13 23:41:13 -04001395 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001396 public int icon;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001397
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001398 /**
1399 * Title of the action.
1400 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001401 public CharSequence title;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001402
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001403 /**
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 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001407 public PendingIntent actionIntent;
Griff Hazen959591e2014-05-15 22:26:18 -07001408
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001409 private Action(Parcel in) {
Dan Sandler86647982015-05-13 23:41:13 -04001410 if (in.readInt() != 0) {
1411 mIcon = Icon.CREATOR.createFromParcel(in);
Dan Sandler68079d52015-07-22 10:45:30 -04001412 if (mIcon.getType() == Icon.TYPE_RESOURCE) {
1413 icon = mIcon.getResId();
1414 }
Dan Sandler86647982015-05-13 23:41:13 -04001415 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001416 title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
1417 if (in.readInt() == 1) {
1418 actionIntent = PendingIntent.CREATOR.createFromParcel(in);
1419 }
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06001420 mExtras = Bundle.setDefusable(in.readBundle(), true);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001421 mRemoteInputs = in.createTypedArray(RemoteInput.CREATOR);
Alex Hills42b0c4d2016-04-26 13:35:36 -04001422 mAllowGeneratedReplies = in.readInt() == 1;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001423 mSemanticAction = in.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001424 }
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001425
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001426 /**
Dan Sandler86647982015-05-13 23:41:13 -04001427 * @deprecated Use {@link android.app.Notification.Action.Builder}.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001428 */
Dan Sandler86647982015-05-13 23:41:13 -04001429 @Deprecated
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001430 public Action(int icon, CharSequence title, PendingIntent intent) {
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001431 this(Icon.createWithResource("", icon), title, intent, new Bundle(), null, true,
1432 SEMANTIC_ACTION_NONE);
Griff Hazen959591e2014-05-15 22:26:18 -07001433 }
1434
Adrian Roos7af53622016-10-12 13:44:05 -07001435 /** Keep in sync with {@link Notification.Action.Builder#Builder(Action)}! */
Dan Sandler86647982015-05-13 23:41:13 -04001436 private Action(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001437 RemoteInput[] remoteInputs, boolean allowGeneratedReplies,
1438 @SemanticAction int semanticAction) {
Dan Sandler86647982015-05-13 23:41:13 -04001439 this.mIcon = icon;
Gus Prevasf5bff46f2015-08-24 10:34:28 -04001440 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
1441 this.icon = icon.getResId();
1442 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001443 this.title = title;
1444 this.actionIntent = intent;
Griff Hazen959591e2014-05-15 22:26:18 -07001445 this.mExtras = extras != null ? extras : new Bundle();
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001446 this.mRemoteInputs = remoteInputs;
Alex Hills42b0c4d2016-04-26 13:35:36 -04001447 this.mAllowGeneratedReplies = allowGeneratedReplies;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001448 this.mSemanticAction = semanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001449 }
1450
1451 /**
Dan Sandler86647982015-05-13 23:41:13 -04001452 * 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 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001463 * Get additional metadata carried around with this Action.
1464 */
1465 public Bundle getExtras() {
1466 return mExtras;
1467 }
1468
1469 /**
Alex Hills42b0c4d2016-04-26 13:35:36 -04001470 * 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 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001478 * Get the list of inputs to be collected from the user when this action is sent.
Shane Brennan472a3b32016-12-12 15:28:10 -08001479 * 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}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001481 */
1482 public RemoteInput[] getRemoteInputs() {
1483 return mRemoteInputs;
1484 }
1485
1486 /**
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001487 * 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 /**
Shane Brennan472a3b32016-12-12 15:28:10 -08001496 * 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 *
Shane Brennanf670d6c2017-04-25 13:05:45 -07001500 * Returns null if there are no data-only remote inputs.
Shane Brennan472a3b32016-12-12 15:28:10 -08001501 *
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 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001510 * Builder class for {@link Action} objects.
1511 */
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001512 public static final class Builder {
Dan Sandler86647982015-05-13 23:41:13 -04001513 private final Icon mIcon;
Griff Hazen959591e2014-05-15 22:26:18 -07001514 private final CharSequence mTitle;
1515 private final PendingIntent mIntent;
Alex Hills1f27f882017-01-12 11:24:46 -05001516 private boolean mAllowGeneratedReplies = true;
Griff Hazen959591e2014-05-15 22:26:18 -07001517 private final Bundle mExtras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001518 private ArrayList<RemoteInput> mRemoteInputs;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001519 private @SemanticAction int mSemanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001520
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 */
Dan Sandler86647982015-05-13 23:41:13 -04001527 @Deprecated
Griff Hazen959591e2014-05-15 22:26:18 -07001528 public Builder(int icon, CharSequence title, PendingIntent intent) {
Adrian Roos7af53622016-10-12 13:44:05 -07001529 this(Icon.createWithResource("", icon), title, intent);
Dan Sandler86647982015-05-13 23:41:13 -04001530 }
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) {
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001539 this(icon, title, intent, new Bundle(), null, true, SEMANTIC_ACTION_NONE);
Griff Hazen959591e2014-05-15 22:26:18 -07001540 }
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) {
Adrian Roos7af53622016-10-12 13:44:05 -07001548 this(action.getIcon(), action.title, action.actionIntent,
1549 new Bundle(action.mExtras), action.getRemoteInputs(),
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001550 action.getAllowGeneratedReplies(), action.getSemanticAction());
Griff Hazen959591e2014-05-15 22:26:18 -07001551 }
1552
Dan Sandler86647982015-05-13 23:41:13 -04001553 private Builder(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001554 RemoteInput[] remoteInputs, boolean allowGeneratedReplies,
1555 @SemanticAction int semanticAction) {
Griff Hazen959591e2014-05-15 22:26:18 -07001556 mIcon = icon;
1557 mTitle = title;
1558 mIntent = intent;
1559 mExtras = extras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001560 if (remoteInputs != null) {
1561 mRemoteInputs = new ArrayList<RemoteInput>(remoteInputs.length);
1562 Collections.addAll(mRemoteInputs, remoteInputs);
1563 }
Adrian Roos7af53622016-10-12 13:44:05 -07001564 mAllowGeneratedReplies = allowGeneratedReplies;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001565 mSemanticAction = semanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001566 }
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 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001592 * 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 /**
Alex Hills42b0c4d2016-04-26 13:35:36 -04001607 * 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
Alex Hills1f27f882017-01-12 11:24:46 -05001613 * The default value is {@code true}
Alex Hills42b0c4d2016-04-26 13:35:36 -04001614 */
1615 public Builder setAllowGeneratedReplies(boolean allowGeneratedReplies) {
1616 mAllowGeneratedReplies = allowGeneratedReplies;
1617 return this;
1618 }
1619
1620 /**
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001621 * 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 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001634 * Apply an extender to this action builder. Extenders may be used to add
1635 * metadata or change options on this builder.
1636 */
Griff Hazen61a9e862014-05-22 16:05:19 -07001637 public Builder extend(Extender extender) {
1638 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001639 return this;
1640 }
1641
1642 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001643 * 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() {
Shane Brennan472a3b32016-12-12 15:28:10 -08001648 ArrayList<RemoteInput> dataOnlyInputs = new ArrayList<>();
1649 RemoteInput[] previousDataInputs =
1650 (RemoteInput[]) mExtras.getParcelableArray(EXTRA_DATA_ONLY_INPUTS);
Felipe Lemedfd11962017-01-18 18:38:46 -08001651 if (previousDataInputs != null) {
Shane Brennan472a3b32016-12-12 15:28:10 -08001652 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,
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001674 mAllowGeneratedReplies, mSemanticAction);
Griff Hazen959591e2014-05-15 22:26:18 -07001675 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001676 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001677
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001678 @Override
1679 public Action clone() {
1680 return new Action(
Dan Sandler86647982015-05-13 23:41:13 -04001681 getIcon(),
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001682 title,
1683 actionIntent, // safe to alias
Julia Reynolds53c934c2016-09-16 14:03:43 -04001684 mExtras == null ? new Bundle() : new Bundle(mExtras),
Alex Hills42b0c4d2016-04-26 13:35:36 -04001685 getRemoteInputs(),
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001686 getAllowGeneratedReplies(),
1687 getSemanticAction());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001688 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001689
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001690 @Override
1691 public int describeContents() {
1692 return 0;
1693 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001694
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001695 @Override
1696 public void writeToParcel(Parcel out, int flags) {
Dan Sandler86647982015-05-13 23:41:13 -04001697 final Icon ic = getIcon();
1698 if (ic != null) {
1699 out.writeInt(1);
1700 ic.writeToParcel(out, 0);
1701 } else {
1702 out.writeInt(0);
1703 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001704 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 }
Griff Hazen959591e2014-05-15 22:26:18 -07001711 out.writeBundle(mExtras);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001712 out.writeTypedArray(mRemoteInputs, flags);
Alex Hills42b0c4d2016-04-26 13:35:36 -04001713 out.writeInt(mAllowGeneratedReplies ? 1 : 0);
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001714 out.writeInt(mSemanticAction);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001715 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001716
Griff Hazen959591e2014-05-15 22:26:18 -07001717 public static final Parcelable.Creator<Action> CREATOR =
1718 new Parcelable.Creator<Action>() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001719 public Action createFromParcel(Parcel in) {
1720 return new Action(in);
1721 }
1722 public Action[] newArray(int size) {
1723 return new Action[size];
1724 }
1725 };
Griff Hazen61a9e862014-05-22 16:05:19 -07001726
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)
Griff Hazen14f57992014-05-26 09:07:14 -07001750 * .extend(new Notification.Action.WearableExtender()
Griff Hazen61a9e862014-05-22 16:05:19 -07001751 * .setAvailableOffline(false))
Griff Hazen14f57992014-05-26 09:07:14 -07001752 * .build();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07001753 */
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
Pete Gastaf6781d2014-10-07 15:17:05 -04001758 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07001759 private static final String KEY_FLAGS = "flags";
Pete Gastaf6781d2014-10-07 15:17:05 -04001760 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";
Griff Hazen61a9e862014-05-22 16:05:19 -07001763
1764 // Flags bitwise-ored to mFlags
1765 private static final int FLAG_AVAILABLE_OFFLINE = 0x1;
Alex Hills9ab3a232016-04-05 14:54:56 -04001766 private static final int FLAG_HINT_LAUNCHES_ACTIVITY = 1 << 1;
Alex Hills9f087612016-06-07 09:08:59 -04001767 private static final int FLAG_HINT_DISPLAY_INLINE = 1 << 2;
Griff Hazen61a9e862014-05-22 16:05:19 -07001768
1769 // Default value for flags integer
1770 private static final int DEFAULT_FLAGS = FLAG_AVAILABLE_OFFLINE;
1771
1772 private int mFlags = DEFAULT_FLAGS;
1773
Pete Gastaf6781d2014-10-07 15:17:05 -04001774 private CharSequence mInProgressLabel;
1775 private CharSequence mConfirmLabel;
1776 private CharSequence mCancelLabel;
1777
Griff Hazen61a9e862014-05-22 16:05:19 -07001778 /**
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);
Pete Gastaf6781d2014-10-07 15:17:05 -04001794 mInProgressLabel = wearableBundle.getCharSequence(KEY_IN_PROGRESS_LABEL);
1795 mConfirmLabel = wearableBundle.getCharSequence(KEY_CONFIRM_LABEL);
1796 mCancelLabel = wearableBundle.getCharSequence(KEY_CANCEL_LABEL);
Griff Hazen61a9e862014-05-22 16:05:19 -07001797 }
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 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001812 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 }
Griff Hazen61a9e862014-05-22 16:05:19 -07001821
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;
Pete Gastaf6781d2014-10-07 15:17:05 -04001830 that.mInProgressLabel = this.mInProgressLabel;
1831 that.mConfirmLabel = this.mConfirmLabel;
1832 that.mCancelLabel = this.mCancelLabel;
Griff Hazen61a9e862014-05-22 16:05:19 -07001833 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 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001864
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 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001872 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001873 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 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001884 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001885 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 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001896 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001897 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 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001908 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001909 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 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001920 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001921 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 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001932 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001933 public CharSequence getCancelLabel() {
1934 return mCancelLabel;
1935 }
Alex Hills9ab3a232016-04-05 14:54:56 -04001936
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 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001944 public WearableExtender setHintLaunchesActivity(
Alex Hills9ab3a232016-04-05 14:54:56 -04001945 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 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001957 public boolean getHintLaunchesActivity() {
Alex Hills9ab3a232016-04-05 14:54:56 -04001958 return (mFlags & FLAG_HINT_LAUNCHES_ACTIVITY) != 0;
1959 }
Alex Hills9f087612016-06-07 09:08:59 -04001960
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 *
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08001977 * @return {@code true} if the Action should be displayed inline, {@code false}
Alex Hills9f087612016-06-07 09:08:59 -04001978 * 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 }
Griff Hazen61a9e862014-05-22 16:05:19 -07001983 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001984
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,
Kodlee Yincda5b092018-02-15 15:34:53 -08002003 SEMANTIC_ACTION_THUMBS_DOWN,
2004 SEMANTIC_ACTION_CALL
Kodlee Yinc72c44d2017-12-21 22:07:15 +00002005 })
2006 @Retention(RetentionPolicy.SOURCE)
2007 public @interface SemanticAction {}
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002008 }
2009
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04002010 /**
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 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -05002016 public Action[] actions;
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002017
2018 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002019 * 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 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002026 * Constructs a Notification object with default values.
Joe Onorato46439ce2010-11-19 13:56:21 -08002027 * You might want to consider using {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002028 */
2029 public Notification()
2030 {
2031 this.when = System.currentTimeMillis();
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002032 this.creationTime = System.currentTimeMillis();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002033 this.priority = PRIORITY_DEFAULT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002034 }
2035
2036 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002037 * @hide
2038 */
2039 public Notification(Context context, int icon, CharSequence tickerText, long when,
2040 CharSequence contentTitle, CharSequence contentText, Intent contentIntent)
2041 {
Chris Wren1ce4b6d2015-06-11 10:19:43 -04002042 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);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002050 }
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.
Joe Onorato46439ce2010-11-19 13:56:21 -08002061 *
2062 * @deprecated Use {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002063 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002064 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002065 public Notification(int icon, CharSequence tickerText, long when)
2066 {
2067 this.icon = icon;
2068 this.tickerText = tickerText;
2069 this.when = when;
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002070 this.creationTime = System.currentTimeMillis();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002071 }
2072
2073 /**
2074 * Unflatten the notification from a parcel.
2075 */
Svet Ganovddb94882016-06-23 19:55:24 -07002076 @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!
Felipe Lemedd85da62016-06-28 11:29:54 -07002082 allPendingIntents = (ArraySet<PendingIntent>) parcel.readArraySet(null);
Svet Ganovddb94882016-06-23 19:55:24 -07002083 }
2084
2085 private void readFromParcelImpl(Parcel parcel)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002086 {
2087 int version = parcel.readInt();
2088
Adrian Roosfb921842017-10-26 14:49:56 +02002089 mWhitelistToken = parcel.readStrongBinder();
2090 if (mWhitelistToken == null) {
2091 mWhitelistToken = processWhitelistToken;
Dianne Hackborn98305522017-05-05 17:53:53 -07002092 }
2093 // Propagate this token to all pending intents that are unmarshalled from the parcel.
Adrian Roosfb921842017-10-26 14:49:56 +02002094 parcel.setClassCookie(PendingIntent.class, mWhitelistToken);
Dianne Hackborn98305522017-05-05 17:53:53 -07002095
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002096 when = parcel.readLong();
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002097 creationTime = parcel.readLong();
Dan Sandler3936e7a2015-05-19 20:59:12 -04002098 if (parcel.readInt() != 0) {
2099 mSmallIcon = Icon.CREATOR.createFromParcel(parcel);
Dan Sandler4e787062015-06-17 15:09:48 -04002100 if (mSmallIcon.getType() == Icon.TYPE_RESOURCE) {
2101 icon = mSmallIcon.getResId();
2102 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04002103 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002104 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) {
Joe Onorato46439ce2010-11-19 13:56:21 -08002115 tickerView = RemoteViews.CREATOR.createFromParcel(parcel);
Joe Onoratoef1e7762010-09-17 18:38:38 -04002116 }
2117 if (parcel.readInt() != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002118 contentView = RemoteViews.CREATOR.createFromParcel(parcel);
2119 }
Joe Onorato561d3852010-11-20 18:09:34 -08002120 if (parcel.readInt() != 0) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04002121 mLargeIcon = Icon.CREATOR.createFromParcel(parcel);
Joe Onorato561d3852010-11-20 18:09:34 -08002122 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002123 defaults = parcel.readInt();
2124 flags = parcel.readInt();
2125 if (parcel.readInt() != 0) {
2126 sound = Uri.CREATOR.createFromParcel(parcel);
2127 }
2128
2129 audioStreamType = parcel.readInt();
John Spurlockc0650f022014-07-19 13:22:39 -04002130 if (parcel.readInt() != 0) {
2131 audioAttributes = AudioAttributes.CREATOR.createFromParcel(parcel);
2132 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002133 vibrate = parcel.createLongArray();
2134 ledARGB = parcel.readInt();
2135 ledOnMS = parcel.readInt();
2136 ledOffMS = parcel.readInt();
2137 iconLevel = parcel.readInt();
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002138
2139 if (parcel.readInt() != 0) {
2140 fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2141 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002142
2143 priority = parcel.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002144
John Spurlockfd7f1e02014-03-18 16:41:57 -04002145 category = parcel.readString();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002146
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002147 mGroupKey = parcel.readString();
2148
2149 mSortKey = parcel.readString();
2150
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06002151 extras = Bundle.setDefusable(parcel.readBundle(), true); // may be null
Robin Leead7e72a2017-12-04 15:45:46 +01002152 fixDuplicateExtras();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002153
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002154 actions = parcel.createTypedArray(Action.CREATOR); // may be null
2155
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002156 if (parcel.readInt() != 0) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002157 bigContentView = RemoteViews.CREATOR.createFromParcel(parcel);
2158 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002159
Chris Wren8fd39ec2014-02-27 17:43:26 -05002160 if (parcel.readInt() != 0) {
2161 headsUpContentView = RemoteViews.CREATOR.createFromParcel(parcel);
2162 }
2163
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002164 visibility = parcel.readInt();
2165
2166 if (parcel.readInt() != 0) {
2167 publicVersion = Notification.CREATOR.createFromParcel(parcel);
2168 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04002169
2170 color = parcel.readInt();
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002171
2172 if (parcel.readInt() != 0) {
2173 mChannelId = parcel.readString();
2174 }
Julia Reynolds2a128742016-11-28 14:29:25 -05002175 mTimeout = parcel.readLong();
Julia Reynolds13d898c2017-02-02 12:22:05 -05002176
2177 if (parcel.readInt() != 0) {
2178 mShortcutId = parcel.readString();
2179 }
2180
2181 mBadgeIcon = parcel.readInt();
Julia Reynolds3aedded2017-03-31 14:42:09 -04002182
2183 if (parcel.readInt() != 0) {
2184 mSettingsText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
2185 }
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002186
2187 mGroupAlertBehavior = parcel.readInt();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002188 }
2189
Andy Stadler110988c2010-12-03 14:29:16 -08002190 @Override
Joe Onorato18e69df2010-05-17 22:26:12 -07002191 public Notification clone() {
2192 Notification that = new Notification();
Daniel Sandler1a497d32013-04-18 14:52:45 -04002193 cloneInto(that, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002194 return that;
2195 }
Joe Onorato18e69df2010-05-17 22:26:12 -07002196
Daniel Sandler1a497d32013-04-18 14:52:45 -04002197 /**
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) {
Adrian Roosfb921842017-10-26 14:49:56 +02002203 that.mWhitelistToken = this.mWhitelistToken;
Joe Onorato18e69df2010-05-17 22:26:12 -07002204 that.when = this.when;
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002205 that.creationTime = this.creationTime;
Dan Sandlerd63f9322015-05-06 15:18:49 -04002206 that.mSmallIcon = this.mSmallIcon;
Joe Onorato18e69df2010-05-17 22:26:12 -07002207 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;
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002212 that.fullScreenIntent = this.fullScreenIntent;
Joe Onorato18e69df2010-05-17 22:26:12 -07002213
2214 if (this.tickerText != null) {
2215 that.tickerText = this.tickerText.toString();
2216 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002217 if (heavy && this.tickerView != null) {
Joe Onorato46439ce2010-11-19 13:56:21 -08002218 that.tickerView = this.tickerView.clone();
Joe Onoratoef1e7762010-09-17 18:38:38 -04002219 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002220 if (heavy && this.contentView != null) {
Joe Onorato18e69df2010-05-17 22:26:12 -07002221 that.contentView = this.contentView.clone();
2222 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04002223 if (heavy && this.mLargeIcon != null) {
2224 that.mLargeIcon = this.mLargeIcon;
Joe Onorato561d3852010-11-20 18:09:34 -08002225 }
Jozef BABJAKa8b91832011-02-22 08:05:08 +01002226 that.iconLevel = this.iconLevel;
Joe Onorato18e69df2010-05-17 22:26:12 -07002227 that.sound = this.sound; // android.net.Uri is immutable
2228 that.audioStreamType = this.audioStreamType;
John Spurlockc0650f022014-07-19 13:22:39 -04002229 if (this.audioAttributes != null) {
2230 that.audioAttributes = new AudioAttributes.Builder(this.audioAttributes).build();
2231 }
Joe Onorato18e69df2010-05-17 22:26:12 -07002232
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;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002244
Joe Onorato18e69df2010-05-17 22:26:12 -07002245 that.flags = this.flags;
2246
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002247 that.priority = this.priority;
Joe Malin8d40d042012-11-05 11:36:40 -08002248
John Spurlockfd7f1e02014-03-18 16:41:57 -04002249 that.category = this.category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002250
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002251 that.mGroupKey = this.mGroupKey;
2252
2253 that.mSortKey = this.mSortKey;
2254
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002255 if (this.extras != null) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002256 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 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002264 }
2265
Felipe Lemedd85da62016-06-28 11:29:54 -07002266 if (!ArrayUtils.isEmpty(allPendingIntents)) {
2267 that.allPendingIntents = new ArraySet<>(allPendingIntents);
Svet Ganovddb94882016-06-23 19:55:24 -07002268 }
2269
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002270 if (this.actions != null) {
2271 that.actions = new Action[this.actions.length];
2272 for(int i=0; i<this.actions.length; i++) {
liangweikang63b03b52017-03-16 19:22:15 +08002273 if ( this.actions[i] != null) {
2274 that.actions[i] = this.actions[i].clone();
2275 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002276 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002277 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002278
Daniel Sandler1a497d32013-04-18 14:52:45 -04002279 if (heavy && this.bigContentView != null) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002280 that.bigContentView = this.bigContentView.clone();
2281 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002282
Chris Wren8fd39ec2014-02-27 17:43:26 -05002283 if (heavy && this.headsUpContentView != null) {
2284 that.headsUpContentView = this.headsUpContentView.clone();
2285 }
2286
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002287 that.visibility = this.visibility;
2288
2289 if (this.publicVersion != null) {
2290 that.publicVersion = new Notification();
2291 this.publicVersion.cloneInto(that.publicVersion, heavy);
2292 }
2293
Dan Sandler26e81cf2014-05-06 10:01:27 -04002294 that.color = this.color;
2295
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002296 that.mChannelId = this.mChannelId;
Julia Reynolds2a128742016-11-28 14:29:25 -05002297 that.mTimeout = this.mTimeout;
Julia Reynolds3aedded2017-03-31 14:42:09 -04002298 that.mShortcutId = this.mShortcutId;
2299 that.mBadgeIcon = this.mBadgeIcon;
2300 that.mSettingsText = this.mSettingsText;
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002301 that.mGroupAlertBehavior = this.mGroupAlertBehavior;
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002302
Daniel Sandler1a497d32013-04-18 14:52:45 -04002303 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;
Chris Wren8fd39ec2014-02-27 17:43:26 -05002317 headsUpContentView = null;
Dan Sandlerd63f9322015-05-06 15:18:49 -04002318 mLargeIcon = null;
Dan Sandler50128532015-12-08 15:42:41 -05002319 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];
Dmitri Plotnikov22281362017-01-30 11:16:21 -08002325 if (TvExtender.EXTRA_TV_EXTENDER.equals(key)) {
2326 continue;
2327 }
Dan Sandler50128532015-12-08 15:42:41 -05002328 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 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002337 }
Joe Onorato18e69df2010-05-17 22:26:12 -07002338 }
2339
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002340 /**
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) {
Christoph Studer535ec612014-09-03 15:47:47 +02002346 if (cs == null) return cs;
2347 if (cs.length() > MAX_CHARSEQUENCE_LENGTH) {
2348 cs = cs.subSequence(0, MAX_CHARSEQUENCE_LENGTH);
2349 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002350 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 }
Selim Cinek60a54252016-02-26 17:03:25 -08002355 return removeTextSizeSpans(cs);
2356 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002357
Selim Cinek60a54252016-02-26 17:03:25 -08002358 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;
Selim Cinek89991a22016-03-07 19:51:54 -08002365 if (resultSpan instanceof CharacterStyle) {
2366 resultSpan = ((CharacterStyle) span).getUnderlying();
2367 }
2368 if (resultSpan instanceof TextAppearanceSpan) {
2369 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
Selim Cinek60a54252016-02-26 17:03:25 -08002370 resultSpan = new TextAppearanceSpan(
2371 originalSpan.getFamily(),
2372 originalSpan.getTextStyle(),
2373 -1,
2374 originalSpan.getTextColor(),
2375 originalSpan.getLinkTextColor());
Selim Cinek89991a22016-03-07 19:51:54 -08002376 } else if (resultSpan instanceof RelativeSizeSpan
2377 || resultSpan instanceof AbsoluteSizeSpan) {
Selim Cinek60a54252016-02-26 17:03:25 -08002378 continue;
Selim Cinek89991a22016-03-07 19:51:54 -08002379 } else {
2380 resultSpan = span;
Selim Cinek60a54252016-02-26 17:03:25 -08002381 }
2382 builder.setSpan(resultSpan, ss.getSpanStart(span), ss.getSpanEnd(span),
2383 ss.getSpanFlags(span));
2384 }
2385 return builder;
2386 }
2387 return charSequence;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002388 }
2389
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002390 public int describeContents() {
2391 return 0;
2392 }
2393
2394 /**
Dan Sandler4e787062015-06-17 15:09:48 -04002395 * Flatten this notification into a parcel.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002396 */
Svet Ganovddb94882016-06-23 19:55:24 -07002397 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.
Felipe Lemedd85da62016-06-28 11:29:54 -07002405 final boolean collectPendingIntents = (allPendingIntents == null);
Svet Ganovddb94882016-06-23 19:55:24 -07002406 if (collectPendingIntents) {
2407 PendingIntent.setOnMarshaledListener(
2408 (PendingIntent intent, Parcel out, int outFlags) -> {
2409 if (parcel == out) {
Felipe Lemedd85da62016-06-28 11:29:54 -07002410 if (allPendingIntents == null) {
2411 allPendingIntents = new ArraySet<>();
Svet Ganovddb94882016-06-23 19:55:24 -07002412 }
Felipe Lemedd85da62016-06-28 11:29:54 -07002413 allPendingIntents.add(intent);
Svet Ganovddb94882016-06-23 19:55:24 -07002414 }
2415 });
2416 }
2417 try {
2418 // IMPORTANT: Add marshaling code in writeToParcelImpl as we
Julia Reynolds13d898c2017-02-02 12:22:05 -05002419 // want to intercept all pending events written to the parcel.
Svet Ganovddb94882016-06-23 19:55:24 -07002420 writeToParcelImpl(parcel, flags);
2421 // Must be written last!
Felipe Lemedd85da62016-06-28 11:29:54 -07002422 parcel.writeArraySet(allPendingIntents);
Svet Ganovddb94882016-06-23 19:55:24 -07002423 } finally {
2424 if (collectPendingIntents) {
2425 PendingIntent.setOnMarshaledListener(null);
2426 }
2427 }
2428 }
2429
2430 private void writeToParcelImpl(Parcel parcel, int flags) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002431 parcel.writeInt(1);
2432
Adrian Roosfb921842017-10-26 14:49:56 +02002433 parcel.writeStrongBinder(mWhitelistToken);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002434 parcel.writeLong(when);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002435 parcel.writeLong(creationTime);
Dan Sandler4e787062015-06-17 15:09:48 -04002436 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 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04002440 if (mSmallIcon != null) {
2441 parcel.writeInt(1);
2442 mSmallIcon.writeToParcel(parcel, 0);
2443 } else {
2444 parcel.writeInt(0);
2445 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002446 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 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002465 if (tickerView != null) {
Joe Onoratoef1e7762010-09-17 18:38:38 -04002466 parcel.writeInt(1);
Joe Onorato46439ce2010-11-19 13:56:21 -08002467 tickerView.writeToParcel(parcel, 0);
Joe Onoratoef1e7762010-09-17 18:38:38 -04002468 } else {
2469 parcel.writeInt(0);
2470 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002471 if (contentView != null) {
2472 parcel.writeInt(1);
2473 contentView.writeToParcel(parcel, 0);
2474 } else {
2475 parcel.writeInt(0);
2476 }
Selim Cinek279fa862016-06-14 10:57:25 -07002477 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 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04002481 if (mLargeIcon != null) {
Joe Onorato561d3852010-11-20 18:09:34 -08002482 parcel.writeInt(1);
Dan Sandlerd63f9322015-05-06 15:18:49 -04002483 mLargeIcon.writeToParcel(parcel, 0);
Joe Onorato561d3852010-11-20 18:09:34 -08002484 } else {
2485 parcel.writeInt(0);
2486 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002487
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);
John Spurlockc0650f022014-07-19 13:22:39 -04002498
2499 if (audioAttributes != null) {
2500 parcel.writeInt(1);
2501 audioAttributes.writeToParcel(parcel, 0);
2502 } else {
2503 parcel.writeInt(0);
2504 }
2505
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002506 parcel.writeLongArray(vibrate);
2507 parcel.writeInt(ledARGB);
2508 parcel.writeInt(ledOnMS);
2509 parcel.writeInt(ledOffMS);
2510 parcel.writeInt(iconLevel);
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002511
2512 if (fullScreenIntent != null) {
2513 parcel.writeInt(1);
2514 fullScreenIntent.writeToParcel(parcel, 0);
2515 } else {
2516 parcel.writeInt(0);
2517 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002518
2519 parcel.writeInt(priority);
Joe Malin8d40d042012-11-05 11:36:40 -08002520
John Spurlockfd7f1e02014-03-18 16:41:57 -04002521 parcel.writeString(category);
Joe Malin8d40d042012-11-05 11:36:40 -08002522
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002523 parcel.writeString(mGroupKey);
2524
2525 parcel.writeString(mSortKey);
2526
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002527 parcel.writeBundle(extras); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002528
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002529 parcel.writeTypedArray(actions, 0); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002530
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002531 if (bigContentView != null) {
2532 parcel.writeInt(1);
2533 bigContentView.writeToParcel(parcel, 0);
2534 } else {
2535 parcel.writeInt(0);
2536 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002537
Chris Wren8fd39ec2014-02-27 17:43:26 -05002538 if (headsUpContentView != null) {
2539 parcel.writeInt(1);
2540 headsUpContentView.writeToParcel(parcel, 0);
2541 } else {
2542 parcel.writeInt(0);
2543 }
2544
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002545 parcel.writeInt(visibility);
2546
2547 if (publicVersion != null) {
2548 parcel.writeInt(1);
2549 publicVersion.writeToParcel(parcel, 0);
2550 } else {
2551 parcel.writeInt(0);
2552 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04002553
2554 parcel.writeInt(color);
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002555
2556 if (mChannelId != null) {
2557 parcel.writeInt(1);
2558 parcel.writeString(mChannelId);
2559 } else {
2560 parcel.writeInt(0);
2561 }
Julia Reynolds2a128742016-11-28 14:29:25 -05002562 parcel.writeLong(mTimeout);
Julia Reynolds13d898c2017-02-02 12:22:05 -05002563
2564 if (mShortcutId != null) {
2565 parcel.writeInt(1);
2566 parcel.writeString(mShortcutId);
2567 } else {
2568 parcel.writeInt(0);
2569 }
2570
2571 parcel.writeInt(mBadgeIcon);
Julia Reynolds3aedded2017-03-31 14:42:09 -04002572
2573 if (mSettingsText != null) {
2574 parcel.writeInt(1);
2575 TextUtils.writeToParcel(mSettingsText, parcel, flags);
2576 } else {
2577 parcel.writeInt(0);
2578 }
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002579
2580 parcel.writeInt(mGroupAlertBehavior);
Julia Reynoldsfc640012018-02-21 12:25:27 -05002581
2582 // mUsesStandardHeader is not written because it should be recomputed in listeners
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002583 }
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 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05002603 * @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 }
Julia Reynolds5a366fb2018-03-21 15:40:53 -04002634 CharSequence[] firstCs = firstRs[j].getChoices();
2635 CharSequence[] secondCs = secondRs[j].getChoices();
Julia Reynolds7217dc92018-03-07 12:12:09 -05002636 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 /**
Robin Leead7e72a2017-12-04 15:45:46 +01002677 * 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 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002704 * 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
Scott Main7aee61f2011-02-08 11:25:01 -08002715 * 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.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002718 *
Joe Onorato46439ce2010-11-19 13:56:21 -08002719 * @deprecated Use {@link Builder} instead.
Chris Wrena05db382015-06-24 15:18:34 -04002720 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002721 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002722 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002723 public void setLatestEventInfo(Context context,
2724 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002725 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 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002729
Selim Cinek4ac6f602016-06-13 15:47:03 -07002730 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
2731 extras.putBoolean(EXTRA_SHOW_WHEN, true);
2732 }
2733
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002734 // ensure that any information already set directly is preserved
2735 final Notification.Builder builder = new Notification.Builder(context, this);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002736
2737 // now apply the latestEventInfo fields
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002738 if (contentTitle != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002739 builder.setContentTitle(contentTitle);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002740 }
2741 if (contentText != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002742 builder.setContentText(contentText);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002743 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002744 builder.setContentIntent(contentIntent);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002745
2746 builder.build(); // callers expect this notification to be ready to use
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002747 }
2748
Julia Reynoldsda303542015-11-23 14:00:20 -05002749 /**
2750 * @hide
2751 */
2752 public static void addFieldsFromContext(Context context, Notification notification) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04002753 addFieldsFromContext(context.getApplicationInfo(), notification);
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002754 }
2755
2756 /**
2757 * @hide
2758 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04002759 public static void addFieldsFromContext(ApplicationInfo ai, Notification notification) {
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002760 notification.extras.putParcelable(EXTRA_BUILDER_APPLICATION_INFO, ai);
Julia Reynoldsda303542015-11-23 14:00:20 -05002761 }
2762
Yi Jin6b514142017-10-30 14:54:12 -07002763 /**
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
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002787 @Override
2788 public String toString() {
2789 StringBuilder sb = new StringBuilder();
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002790 sb.append("Notification(channel=");
Julia Reynoldsbad42972017-04-25 13:52:49 -04002791 sb.append(getChannelId());
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002792 sb.append(" pri=");
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002793 sb.append(priority);
2794 sb.append(" contentView=");
Joe Onoratoc9596d62011-01-12 17:03:11 -08002795 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=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002803 if ((this.defaults & DEFAULT_VIBRATE) != 0) {
2804 sb.append("default");
2805 } else if (this.vibrate != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002806 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 }
Simon Schoar8cf97d92009-06-10 22:08:37 +02002812 if (N != -1) {
2813 sb.append(this.vibrate[N]);
2814 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002815 sb.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002816 } else {
2817 sb.append("null");
2818 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002819 sb.append(" sound=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002820 if ((this.defaults & DEFAULT_SOUND) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002821 sb.append("default");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002822 } else if (this.sound != null) {
2823 sb.append(this.sound.toString());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002824 } else {
2825 sb.append("null");
2826 }
Chris Wren365b6d32015-07-16 10:39:26 -04002827 if (this.tickerText != null) {
2828 sb.append(" tick");
2829 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002830 sb.append(" defaults=0x");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002831 sb.append(Integer.toHexString(this.defaults));
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002832 sb.append(" flags=0x");
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002833 sb.append(Integer.toHexString(this.flags));
Dan Sandler26e81cf2014-05-06 10:01:27 -04002834 sb.append(String.format(" color=0x%08x", this.color));
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002835 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 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002847 if (actions != null) {
Dan Sandler1b718782014-07-18 12:43:45 -04002848 sb.append(" actions=");
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002849 sb.append(actions.length);
Dan Sandler1b718782014-07-18 12:43:45 -04002850 }
2851 sb.append(" vis=");
2852 sb.append(visibilityToString(this.visibility));
2853 if (this.publicVersion != null) {
2854 sb.append(" publicVersion=");
2855 sb.append(publicVersion.toString());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002856 }
2857 sb.append(")");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002858 return sb.toString();
2859 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002860
Dan Sandler1b718782014-07-18 12:43:45 -04002861 /**
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
Joe Onoratocb109a02011-01-18 17:57:41 -08002877 /**
John Spurlock1d881a12015-03-18 19:21:54 -04002878 * {@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
Julia Reynolds6ad0aec2017-07-05 08:47:03 -04002897 /**
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
Jeff Sharkey000ce802017-04-29 13:13:27 -06002913 /** @removed */
2914 @Deprecated
Julia Reynolds37856052016-11-11 09:20:07 -05002915 public String getChannel() {
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002916 return mChannelId;
2917 }
2918
2919 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04002920 * Returns the id of the channel this notification posts to.
2921 */
2922 public String getChannelId() {
2923 return mChannelId;
2924 }
2925
Jeff Sharkey000ce802017-04-29 13:13:27 -06002926 /** @removed */
2927 @Deprecated
Julia Reynolds2a128742016-11-28 14:29:25 -05002928 public long getTimeout() {
2929 return mTimeout;
2930 }
2931
2932 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04002933 * 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 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04002941 * 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 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05002950 * Returns the {@link ShortcutInfo#getId() id} that this notification supersedes, if any.
Julia Reynoldsbad42972017-04-25 13:52:49 -04002951 *
2952 * <p>Used by some Launchers that display notification content to hide shortcuts that duplicate
2953 * notifications.
Julia Reynolds13d898c2017-02-02 12:22:05 -05002954 */
2955 public String getShortcutId() {
2956 return mShortcutId;
2957 }
2958
Julia Reynolds3aedded2017-03-31 14:42:09 -04002959
2960 /**
2961 * Returns the settings text provided to {@link Builder#setSettingsText(CharSequence)}.
2962 */
2963 public CharSequence getSettingsText() {
2964 return mSettingsText;
2965 }
2966
Julia Reynolds13d898c2017-02-02 12:22:05 -05002967 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002968 * 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 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04002977 * 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 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +02003006 * @hide
3007 */
Christoph Studerc8db24b2014-07-25 17:50:30 +02003008 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 /**
Julia Reynolds30203152017-05-26 13:36:31 -04003020 * @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 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003034 * Builder class for {@link Notification} objects.
Joe Malin8d40d042012-11-05 11:36:40 -08003035 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003036 * Provides a convenient way to set the various fields of a {@link Notification} and generate
Scott Main183bf112012-08-13 19:12:13 -07003037 * 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>.
Joe Malin8d40d042012-11-05 11:36:40 -08003042 *
Scott Main183bf112012-08-13 19:12:13 -07003043 * <p>Example:
Joe Malin8d40d042012-11-05 11:36:40 -08003044 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003045 * <pre class="prettyprint">
Scott Main183bf112012-08-13 19:12:13 -07003046 * Notification noti = new Notification.Builder(mContext)
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003047 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
3048 * .setContentText(subject)
3049 * .setSmallIcon(R.drawable.new_mail)
3050 * .setLargeIcon(aBitmap)
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003051 * .build();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003052 * </pre>
Joe Onoratocb109a02011-01-18 17:57:41 -08003053 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003054 public static class Builder {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003055 /**
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
Daniel Sandler602ad1c2012-06-12 16:06:27 -04003071 private static final int MAX_ACTION_BUTTONS = 3;
Daniel Sandler8680bf82012-05-15 16:52:52 -04003072
Selim Cinek6743c0b2017-01-18 18:24:01 -08003073 private static final boolean USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY =
3074 SystemProperties.getBoolean("notifications.only_title", true);
3075
Selim Cinek389edcd2017-05-11 19:16:44 -07003076 /**
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
Joe Onorato46439ce2010-11-19 13:56:21 -08003089 private Context mContext;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003090 private Notification mN;
3091 private Bundle mUserExtras = new Bundle();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003092 private Style mStyle;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003093 private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS);
Selim Cineke7238dd2017-12-14 17:48:32 -08003094 private ArrayList<Person> mPersonList = new ArrayList<>();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003095 private NotificationColorUtil mColorUtil;
Selim Cinek7b9605b2017-01-19 17:36:00 -08003096 private boolean mIsLegacy;
3097 private boolean mIsLegacyInitialized;
Christoph Studer7ac80e62014-08-04 16:01:57 +02003098
3099 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -08003100 * Caches a contrast-enhanced version of {@link #mCachedContrastColorIsFor}.
3101 */
3102 private int mCachedContrastColor = COLOR_INVALID;
3103 private int mCachedContrastColorIsFor = COLOR_INVALID;
Adrian Roos487374f2017-01-11 15:48:14 -08003104 /**
3105 * Caches a ambient version of {@link #mCachedContrastColorIsFor}.
3106 */
3107 private int mCachedAmbientColor = COLOR_INVALID;
3108 private int mCachedAmbientColorIsFor = COLOR_INVALID;
Adrian Roos4ff3b122016-02-01 12:26:13 -08003109
3110 /**
Adrian Roos70d7aa32017-01-11 15:39:06 -08003111 * 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();
Selim Cinek7b9605b2017-01-19 17:36:00 -08003115 private int mTextColorsAreForBackground = COLOR_INVALID;
3116 private int mPrimaryTextColor = COLOR_INVALID;
3117 private int mSecondaryTextColor = COLOR_INVALID;
Selim Cinek5fb73f82017-04-20 16:55:38 -07003118 private int mBackgroundColor = COLOR_INVALID;
3119 private int mForegroundColor = COLOR_INVALID;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07003120 /**
3121 * A temporary location where actions are stored. If != null the view originally has action
3122 * but doesn't have any for this inflation.
3123 */
3124 private ArrayList<Action> mOriginalActions;
Selim Cineka7679b62017-05-10 16:33:25 -07003125 private boolean mRebuildStyledRemoteViews;
Adrian Roos70d7aa32017-01-11 15:39:06 -08003126
Anthony Chenad4d1582017-04-10 16:07:58 -07003127 private boolean mTintActionButtons;
3128 private boolean mInNightMode;
3129
Adrian Roos70d7aa32017-01-11 15:39:06 -08003130 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003131 * Constructs a new Builder with the defaults:
Joe Onoratocb109a02011-01-18 17:57:41 -08003132 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003133 * @param context
3134 * A {@link Context} that will be used by the Builder to construct the
3135 * RemoteViews. The Context will not be held past the lifetime of this Builder
3136 * object.
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003137 * @param channelId
3138 * The constructed Notification will be posted on this
3139 * {@link NotificationChannel}. To use a NotificationChannel, it must first be
3140 * created using {@link NotificationManager#createNotificationChannel}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003141 */
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003142 public Builder(Context context, String channelId) {
3143 this(context, (Notification) null);
3144 mN.mChannelId = channelId;
3145 }
3146
3147 /**
3148 * @deprecated use {@link Notification.Builder#Notification.Builder(Context, String)}
3149 * instead. All posted Notifications must specify a NotificationChannel Id.
3150 */
3151 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003152 public Builder(Context context) {
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003153 this(context, (Notification) null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003154 }
3155
Joe Onoratocb109a02011-01-18 17:57:41 -08003156 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003157 * @hide
Christoph Studer4600f9b2014-07-22 22:44:43 +02003158 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003159 public Builder(Context context, Notification toAdopt) {
3160 mContext = context;
Anthony Chenad4d1582017-04-10 16:07:58 -07003161 Resources res = mContext.getResources();
3162 mTintActionButtons = res.getBoolean(R.bool.config_tintNotificationActionButtons);
3163
3164 if (res.getBoolean(R.bool.config_enableNightMode)) {
3165 Configuration currentConfig = res.getConfiguration();
3166 mInNightMode = (currentConfig.uiMode & Configuration.UI_MODE_NIGHT_MASK)
3167 == Configuration.UI_MODE_NIGHT_YES;
3168 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02003169
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003170 if (toAdopt == null) {
3171 mN = new Notification();
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003172 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
3173 mN.extras.putBoolean(EXTRA_SHOW_WHEN, true);
3174 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003175 mN.priority = PRIORITY_DEFAULT;
3176 mN.visibility = VISIBILITY_PRIVATE;
3177 } else {
3178 mN = toAdopt;
3179 if (mN.actions != null) {
3180 Collections.addAll(mActions, mN.actions);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003181 }
3182
Selim Cineke7238dd2017-12-14 17:48:32 -08003183 if (mN.extras.containsKey(EXTRA_PEOPLE_LIST)) {
3184 ArrayList<Person> people = mN.extras.getParcelableArrayList(EXTRA_PEOPLE_LIST);
3185 mPersonList.addAll(people);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003186 }
3187
Selim Cinek4ac6f602016-06-13 15:47:03 -07003188 if (mN.getSmallIcon() == null && mN.icon != 0) {
3189 setSmallIcon(mN.icon);
3190 }
3191
3192 if (mN.getLargeIcon() == null && mN.largeIcon != null) {
3193 setLargeIcon(mN.largeIcon);
3194 }
3195
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003196 String templateClass = mN.extras.getString(EXTRA_TEMPLATE);
3197 if (!TextUtils.isEmpty(templateClass)) {
3198 final Class<? extends Style> styleClass
3199 = getNotificationStyleClass(templateClass);
3200 if (styleClass == null) {
3201 Log.d(TAG, "Unknown style class: " + templateClass);
3202 } else {
3203 try {
Adrian Roosc1a80b02016-04-05 14:54:55 -07003204 final Constructor<? extends Style> ctor =
3205 styleClass.getDeclaredConstructor();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003206 ctor.setAccessible(true);
3207 final Style style = ctor.newInstance();
3208 style.restoreFromExtras(mN.extras);
3209
3210 if (style != null) {
3211 setStyle(style);
3212 }
3213 } catch (Throwable t) {
3214 Log.e(TAG, "Could not create Style", t);
3215 }
3216 }
3217 }
3218
3219 }
3220 }
3221
3222 private NotificationColorUtil getColorUtil() {
Selim Cinek99104832017-01-25 14:47:33 -08003223 if (mColorUtil == null) {
3224 mColorUtil = NotificationColorUtil.getInstance(mContext);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003225 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003226 return mColorUtil;
Christoph Studer4600f9b2014-07-22 22:44:43 +02003227 }
3228
3229 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003230 * If this notification is duplicative of a Launcher shortcut, sets the
3231 * {@link ShortcutInfo#getId() id} of the shortcut, in case the Launcher wants to hide
3232 * the shortcut.
3233 *
Julia Reynoldsbad42972017-04-25 13:52:49 -04003234 * This field will be ignored by Launchers that don't support badging, don't show
3235 * notification content, or don't show {@link android.content.pm.ShortcutManager shortcuts}.
Julia Reynolds13d898c2017-02-02 12:22:05 -05003236 *
3237 * @param shortcutId the {@link ShortcutInfo#getId() id} of the shortcut this notification
3238 * supersedes
3239 */
3240 public Builder setShortcutId(String shortcutId) {
3241 mN.mShortcutId = shortcutId;
3242 return this;
3243 }
3244
3245 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04003246 * Sets which icon to display as a badge for this notification.
3247 *
3248 * Must be one of {@link #BADGE_ICON_NONE}, {@link #BADGE_ICON_SMALL},
3249 * {@link #BADGE_ICON_LARGE}.
3250 *
3251 * Note: This value might be ignored, for launchers that don't support badge icons.
3252 */
Julia Reynolds612beb22017-03-30 10:48:30 -04003253 public Builder setBadgeIconType(int icon) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04003254 mN.mBadgeIcon = icon;
3255 return this;
3256 }
3257
3258 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003259 * Sets the group alert behavior for this notification. Use this method to mute this
3260 * notification if alerts for this notification's group should be handled by a different
3261 * notification. This is only applicable for notifications that belong to a
Julia Reynolds399d9bf2017-08-11 12:52:14 -04003262 * {@link #setGroup(String) group}. This must be called on all notifications you want to
3263 * mute. For example, if you want only the summary of your group to make noise, all
3264 * children in the group should have the group alert behavior {@link #GROUP_ALERT_SUMMARY}.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003265 *
3266 * <p> The default value is {@link #GROUP_ALERT_ALL}.</p>
3267 */
3268 public Builder setGroupAlertBehavior(@GroupAlertBehavior int groupAlertBehavior) {
3269 mN.mGroupAlertBehavior = groupAlertBehavior;
3270 return this;
3271 }
3272
Jeff Sharkey000ce802017-04-29 13:13:27 -06003273 /** @removed */
3274 @Deprecated
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04003275 public Builder setChannel(String channelId) {
3276 mN.mChannelId = channelId;
3277 return this;
3278 }
3279
3280 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003281 * Specifies the channel the notification should be delivered on.
3282 */
3283 public Builder setChannelId(String channelId) {
3284 mN.mChannelId = channelId;
3285 return this;
3286 }
3287
Jeff Sharkey000ce802017-04-29 13:13:27 -06003288 /** @removed */
3289 @Deprecated
Julia Reynolds50989772017-02-23 14:32:16 -05003290 public Builder setTimeout(long durationMs) {
3291 mN.mTimeout = durationMs;
Julia Reynolds2a128742016-11-28 14:29:25 -05003292 return this;
3293 }
3294
3295 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003296 * Specifies a duration in milliseconds after which this notification should be canceled,
3297 * if it is not already canceled.
3298 */
3299 public Builder setTimeoutAfter(long durationMs) {
3300 mN.mTimeout = durationMs;
3301 return this;
3302 }
3303
3304 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003305 * Add a timestamp pertaining to the notification (usually the time the event occurred).
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003306 *
3307 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not
3308 * shown anymore by default and must be opted into by using
3309 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003310 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003311 * @see Notification#when
Joe Onoratocb109a02011-01-18 17:57:41 -08003312 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003313 public Builder setWhen(long when) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003314 mN.when = when;
Joe Onorato46439ce2010-11-19 13:56:21 -08003315 return this;
3316 }
3317
Joe Onoratocb109a02011-01-18 17:57:41 -08003318 /**
Griff Hazen50c11652014-05-16 09:46:31 -07003319 * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown
Daniel Sandler0c890492012-09-12 17:23:10 -07003320 * in the content view.
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003321 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to
3322 * {@code false}. For earlier apps, the default is {@code true}.
Daniel Sandler0c890492012-09-12 17:23:10 -07003323 */
3324 public Builder setShowWhen(boolean show) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003325 mN.extras.putBoolean(EXTRA_SHOW_WHEN, show);
Daniel Sandler0c890492012-09-12 17:23:10 -07003326 return this;
3327 }
3328
3329 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003330 * Show the {@link Notification#when} field as a stopwatch.
Joe Malin8d40d042012-11-05 11:36:40 -08003331 *
3332 * Instead of presenting <code>when</code> as a timestamp, the notification will show an
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003333 * automatically updating display of the minutes and seconds since <code>when</code>.
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003334 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003335 * Useful when showing an elapsed time (like an ongoing phone call).
3336 *
Selim Cinek81c23aa2016-02-25 16:23:13 -08003337 * The counter can also be set to count down to <code>when</code> when using
Adrian Roos96b7e202016-05-17 13:50:38 -07003338 * {@link #setChronometerCountDown(boolean)}.
Selim Cinek81c23aa2016-02-25 16:23:13 -08003339 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003340 * @see android.widget.Chronometer
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003341 * @see Notification#when
Adrian Roos96b7e202016-05-17 13:50:38 -07003342 * @see #setChronometerCountDown(boolean)
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003343 */
3344 public Builder setUsesChronometer(boolean b) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003345 mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b);
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003346 return this;
3347 }
3348
3349 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08003350 * Sets the Chronometer to count down instead of counting up.
3351 *
3352 * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true.
3353 * If it isn't set the chronometer will count up.
3354 *
3355 * @see #setUsesChronometer(boolean)
3356 */
Adrian Roos96b7e202016-05-17 13:50:38 -07003357 public Builder setChronometerCountDown(boolean countDown) {
3358 mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, countDown);
Selim Cinek81c23aa2016-02-25 16:23:13 -08003359 return this;
3360 }
3361
3362 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003363 * Set the small icon resource, which will be used to represent the notification in the
3364 * status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -08003365 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003366
3367 * The platform template for the expanded view will draw this icon in the left, unless a
3368 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
3369 * icon will be moved to the right-hand side.
3370 *
3371
3372 * @param icon
3373 * A resource ID in the application's package of the drawable to use.
3374 * @see Notification#icon
Joe Onoratocb109a02011-01-18 17:57:41 -08003375 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003376 public Builder setSmallIcon(@DrawableRes int icon) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04003377 return setSmallIcon(icon != 0
3378 ? Icon.createWithResource(mContext, icon)
3379 : null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003380 }
3381
Joe Onoratocb109a02011-01-18 17:57:41 -08003382 /**
3383 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
3384 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
3385 * LevelListDrawable}.
3386 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003387 * @param icon A resource ID in the application's package of the drawable to use.
Joe Onoratocb109a02011-01-18 17:57:41 -08003388 * @param level The level to use for the icon.
3389 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003390 * @see Notification#icon
3391 * @see Notification#iconLevel
Joe Onoratocb109a02011-01-18 17:57:41 -08003392 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003393 public Builder setSmallIcon(@DrawableRes int icon, int level) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003394 mN.iconLevel = level;
Dan Sandlerd63f9322015-05-06 15:18:49 -04003395 return setSmallIcon(icon);
3396 }
3397
3398 /**
3399 * Set the small icon, which will be used to represent the notification in the
3400 * status bar and content view (unless overriden there by a
3401 * {@link #setLargeIcon(Bitmap) large icon}).
3402 *
3403 * @param icon An Icon object to use.
3404 * @see Notification#icon
3405 */
3406 public Builder setSmallIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003407 mN.setSmallIcon(icon);
3408 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
3409 mN.icon = icon.getResId();
3410 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003411 return this;
3412 }
3413
Joe Onoratocb109a02011-01-18 17:57:41 -08003414 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003415 * Set the first line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003416 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003417 public Builder setContentTitle(CharSequence title) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003418 mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title));
Joe Onorato46439ce2010-11-19 13:56:21 -08003419 return this;
3420 }
3421
Joe Onoratocb109a02011-01-18 17:57:41 -08003422 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003423 * Set the second line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003424 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003425 public Builder setContentText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003426 mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text));
Joe Onorato46439ce2010-11-19 13:56:21 -08003427 return this;
3428 }
3429
Joe Onoratocb109a02011-01-18 17:57:41 -08003430 /**
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003431 * This provides some additional information that is displayed in the notification. No
3432 * guarantees are given where exactly it is displayed.
3433 *
3434 * <p>This information should only be provided if it provides an essential
3435 * benefit to the understanding of the notification. The more text you provide the
3436 * less readable it becomes. For example, an email client should only provide the account
3437 * name here if more than one email account has been added.</p>
3438 *
3439 * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the
3440 * notification header area.
3441 *
3442 * On Android versions before {@link android.os.Build.VERSION_CODES#N}
3443 * this will be shown in the third line of text in the platform notification template.
3444 * You should not be using {@link #setProgress(int, int, boolean)} at the
3445 * same time on those versions; they occupy the same place.
3446 * </p>
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003447 */
3448 public Builder setSubText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003449 mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text));
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003450 return this;
3451 }
3452
3453 /**
Julia Reynolds3aedded2017-03-31 14:42:09 -04003454 * Provides text that will appear as a link to your application's settings.
3455 *
3456 * <p>This text does not appear within notification {@link Style templates} but may
3457 * appear when the user uses an affordance to learn more about the notification.
3458 * Additionally, this text will not appear unless you provide a valid link target by
3459 * handling {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}.
3460 *
3461 * <p>This text is meant to be concise description about what the user can customize
3462 * when they click on this link. The recommended maximum length is 40 characters.
3463 * @param text
3464 * @return
3465 */
3466 public Builder setSettingsText(CharSequence text) {
3467 mN.mSettingsText = safeCharSequence(text);
3468 return this;
3469 }
3470
3471 /**
Adrian Roose458aa82015-12-08 16:17:19 -08003472 * Set the remote input history.
3473 *
3474 * This should be set to the most recent inputs that have been sent
3475 * through a {@link RemoteInput} of this Notification and cleared once the it is no
3476 * longer relevant (e.g. for chat notifications once the other party has responded).
3477 *
3478 * The most recent input must be stored at the 0 index, the second most recent at the
3479 * 1 index, etc. Note that the system will limit both how far back the inputs will be shown
3480 * and how much of each individual input is shown.
3481 *
3482 * <p>Note: The reply text will only be shown on notifications that have least one action
3483 * with a {@code RemoteInput}.</p>
3484 */
3485 public Builder setRemoteInputHistory(CharSequence[] text) {
3486 if (text == null) {
3487 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null);
3488 } else {
3489 final int N = Math.min(MAX_REPLY_HISTORY, text.length);
3490 CharSequence[] safe = new CharSequence[N];
3491 for (int i = 0; i < N; i++) {
3492 safe[i] = safeCharSequence(text[i]);
3493 }
3494 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe);
3495 }
3496 return this;
3497 }
3498
3499 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003500 * Sets the number of items this notification represents. May be displayed as a badge count
3501 * for Launchers that support badging.
Joe Onoratocb109a02011-01-18 17:57:41 -08003502 */
Joe Onorato8595a3d2010-11-19 18:12:07 -08003503 public Builder setNumber(int number) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003504 mN.number = number;
Joe Onorato8595a3d2010-11-19 18:12:07 -08003505 return this;
3506 }
3507
Joe Onoratocb109a02011-01-18 17:57:41 -08003508 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003509 * A small piece of additional information pertaining to this notification.
3510 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003511 * The platform template will draw this on the last line of the notification, at the far
3512 * right (to the right of a smallIcon if it has been placed there).
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003513 *
3514 * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header.
3515 * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this
3516 * field will still show up, but the subtext will take precedence.
Joe Onoratocb109a02011-01-18 17:57:41 -08003517 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003518 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003519 public Builder setContentInfo(CharSequence info) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003520 mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info));
Joe Onorato46439ce2010-11-19 13:56:21 -08003521 return this;
3522 }
3523
Joe Onoratocb109a02011-01-18 17:57:41 -08003524 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003525 * Set the progress this notification represents.
3526 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003527 * The platform template will represent this using a {@link ProgressBar}.
Jeff Sharkey1c400132011-08-05 14:50:13 -07003528 */
3529 public Builder setProgress(int max, int progress, boolean indeterminate) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003530 mN.extras.putInt(EXTRA_PROGRESS, progress);
3531 mN.extras.putInt(EXTRA_PROGRESS_MAX, max);
3532 mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate);
Jeff Sharkey1c400132011-08-05 14:50:13 -07003533 return this;
3534 }
3535
3536 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003537 * Supply a custom RemoteViews to use instead of the platform template.
3538 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003539 * Use {@link #setCustomContentView(RemoteViews)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003540 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003541 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003542 public Builder setContent(RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003543 return setCustomContentView(views);
3544 }
3545
3546 /**
3547 * Supply custom RemoteViews to use instead of the platform template.
3548 *
3549 * This will override the layout that would otherwise be constructed by this Builder
3550 * object.
3551 */
3552 public Builder setCustomContentView(RemoteViews contentView) {
3553 mN.contentView = contentView;
3554 return this;
3555 }
3556
3557 /**
3558 * Supply custom RemoteViews to use instead of the platform template in the expanded form.
3559 *
3560 * This will override the expanded layout that would otherwise be constructed by this
3561 * Builder object.
3562 */
3563 public Builder setCustomBigContentView(RemoteViews contentView) {
3564 mN.bigContentView = contentView;
3565 return this;
3566 }
3567
3568 /**
3569 * Supply custom RemoteViews to use instead of the platform template in the heads up dialog.
3570 *
3571 * This will override the heads-up layout that would otherwise be constructed by this
3572 * Builder object.
3573 */
3574 public Builder setCustomHeadsUpContentView(RemoteViews contentView) {
3575 mN.headsUpContentView = contentView;
Joe Onorato46439ce2010-11-19 13:56:21 -08003576 return this;
3577 }
3578
Joe Onoratocb109a02011-01-18 17:57:41 -08003579 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003580 * Supply a {@link PendingIntent} to be sent when the notification is clicked.
3581 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003582 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
3583 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
3584 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003585 * to assign PendingIntents to individual views in that custom layout (i.e., to create
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003586 * clickable buttons inside the notification view).
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003587 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003588 * @see Notification#contentIntent Notification.contentIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003589 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003590 public Builder setContentIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003591 mN.contentIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003592 return this;
3593 }
3594
Joe Onoratocb109a02011-01-18 17:57:41 -08003595 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003596 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
3597 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003598 * @see Notification#deleteIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003599 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003600 public Builder setDeleteIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003601 mN.deleteIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003602 return this;
3603 }
3604
Joe Onoratocb109a02011-01-18 17:57:41 -08003605 /**
3606 * An intent to launch instead of posting the notification to the status bar.
3607 * Only for use with extremely high-priority notifications demanding the user's
3608 * <strong>immediate</strong> attention, such as an incoming phone call or
3609 * alarm clock that the user has explicitly set to a particular time.
3610 * If this facility is used for something else, please give the user an option
3611 * to turn it off and use a normal notification, as this can be extremely
3612 * disruptive.
3613 *
Chris Wren47c20a12014-06-18 17:27:29 -04003614 * <p>
3615 * The system UI may choose to display a heads-up notification, instead of
3616 * launching this intent, while the user is using the device.
3617 * </p>
3618 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003619 * @param intent The pending intent to launch.
3620 * @param highPriority Passing true will cause this notification to be sent
3621 * even if other notifications are suppressed.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003622 *
3623 * @see Notification#fullScreenIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003624 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003625 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003626 mN.fullScreenIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003627 setFlag(FLAG_HIGH_PRIORITY, highPriority);
3628 return this;
3629 }
3630
Joe Onoratocb109a02011-01-18 17:57:41 -08003631 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003632 * Set the "ticker" text which is sent to accessibility services.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003633 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003634 * @see Notification#tickerText
Joe Onoratocb109a02011-01-18 17:57:41 -08003635 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003636 public Builder setTicker(CharSequence tickerText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003637 mN.tickerText = safeCharSequence(tickerText);
Joe Onorato46439ce2010-11-19 13:56:21 -08003638 return this;
3639 }
3640
Joe Onoratocb109a02011-01-18 17:57:41 -08003641 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003642 * Obsolete version of {@link #setTicker(CharSequence)}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003643 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003644 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003645 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003646 public Builder setTicker(CharSequence tickerText, RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003647 setTicker(tickerText);
3648 // views is ignored
Joe Onorato46439ce2010-11-19 13:56:21 -08003649 return this;
3650 }
3651
Joe Onoratocb109a02011-01-18 17:57:41 -08003652 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04003653 * Add a large icon to the notification content view.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003654 *
3655 * In the platform template, this image will be shown on the left of the notification view
Dan Sandlerd63f9322015-05-06 15:18:49 -04003656 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3657 * badge atop the large icon).
Dan Sandler08a04c12015-05-06 15:18:49 -04003658 */
Dan Sandlerd63f9322015-05-06 15:18:49 -04003659 public Builder setLargeIcon(Bitmap b) {
3660 return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
3661 }
3662
3663 /**
3664 * Add a large icon to the notification content view.
3665 *
3666 * In the platform template, this image will be shown on the left of the notification view
3667 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3668 * badge atop the large icon).
3669 */
3670 public Builder setLargeIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003671 mN.mLargeIcon = icon;
3672 mN.extras.putParcelable(EXTRA_LARGE_ICON, icon);
Joe Onorato46439ce2010-11-19 13:56:21 -08003673 return this;
3674 }
3675
Joe Onoratocb109a02011-01-18 17:57:41 -08003676 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003677 * Set the sound to play.
3678 *
John Spurlockc0650f022014-07-19 13:22:39 -04003679 * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes}
3680 * for notifications.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003681 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003682 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003683 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003684 @Deprecated
Joe Onorato52f80cd2010-11-21 15:34:48 -08003685 public Builder setSound(Uri sound) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003686 mN.sound = sound;
3687 mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
Joe Onorato52f80cd2010-11-21 15:34:48 -08003688 return this;
3689 }
3690
Joe Onoratocb109a02011-01-18 17:57:41 -08003691 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003692 * Set the sound to play, along with a specific stream on which to play it.
Joe Onoratocb109a02011-01-18 17:57:41 -08003693 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003694 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
3695 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003696 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003697 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -07003698 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003699 public Builder setSound(Uri sound, int streamType) {
Jean-Michel Trivi2f7511f2016-11-28 15:40:27 -08003700 PlayerBase.deprecateStreamTypeForPlayback(streamType, "Notification", "setSound()");
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003701 mN.sound = sound;
3702 mN.audioStreamType = streamType;
Joe Onorato46439ce2010-11-19 13:56:21 -08003703 return this;
3704 }
3705
Joe Onoratocb109a02011-01-18 17:57:41 -08003706 /**
John Spurlockc0650f022014-07-19 13:22:39 -04003707 * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to
3708 * use during playback.
3709 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003710 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
John Spurlockc0650f022014-07-19 13:22:39 -04003711 * @see Notification#sound
3712 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003713 @Deprecated
John Spurlockc0650f022014-07-19 13:22:39 -04003714 public Builder setSound(Uri sound, AudioAttributes audioAttributes) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003715 mN.sound = sound;
3716 mN.audioAttributes = audioAttributes;
John Spurlockc0650f022014-07-19 13:22:39 -04003717 return this;
3718 }
3719
3720 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003721 * Set the vibration pattern to use.
3722 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003723 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
3724 * <code>pattern</code> parameter.
3725 *
Chris Wren47c20a12014-06-18 17:27:29 -04003726 * <p>
3727 * A notification that vibrates is more likely to be presented as a heads-up notification.
3728 * </p>
3729 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003730 * @deprecated use {@link NotificationChannel#setVibrationPattern(long[])} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003731 * @see Notification#vibrate
Joe Onoratocb109a02011-01-18 17:57:41 -08003732 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003733 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003734 public Builder setVibrate(long[] pattern) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003735 mN.vibrate = pattern;
Joe Onorato46439ce2010-11-19 13:56:21 -08003736 return this;
3737 }
3738
Joe Onoratocb109a02011-01-18 17:57:41 -08003739 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003740 * Set the desired color for the indicator LED on the device, as well as the
3741 * blink duty cycle (specified in milliseconds).
3742 *
3743
3744 * Not all devices will honor all (or even any) of these values.
3745 *
Julia Reynolds529e3322017-02-06 08:33:01 -05003746 * @deprecated use {@link NotificationChannel#enableLights(boolean)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003747 * @see Notification#ledARGB
3748 * @see Notification#ledOnMS
3749 * @see Notification#ledOffMS
Joe Onoratocb109a02011-01-18 17:57:41 -08003750 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003751 @Deprecated
Tor Norbye80756e32015-03-02 09:39:27 -08003752 public Builder setLights(@ColorInt int argb, int onMs, int offMs) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003753 mN.ledARGB = argb;
3754 mN.ledOnMS = onMs;
3755 mN.ledOffMS = offMs;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05003756 if (onMs != 0 || offMs != 0) {
3757 mN.flags |= FLAG_SHOW_LIGHTS;
3758 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003759 return this;
3760 }
3761
Joe Onoratocb109a02011-01-18 17:57:41 -08003762 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003763 * Set whether this is an "ongoing" notification.
Joe Onoratocb109a02011-01-18 17:57:41 -08003764 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003765
3766 * Ongoing notifications cannot be dismissed by the user, so your application or service
3767 * must take care of canceling them.
3768 *
3769
3770 * They are typically used to indicate a background task that the user is actively engaged
3771 * with (e.g., playing music) or is pending in some way and therefore occupying the device
3772 * (e.g., a file download, sync operation, active network connection).
3773 *
3774
3775 * @see Notification#FLAG_ONGOING_EVENT
3776 * @see Service#setForeground(boolean)
Joe Onoratocb109a02011-01-18 17:57:41 -08003777 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003778 public Builder setOngoing(boolean ongoing) {
3779 setFlag(FLAG_ONGOING_EVENT, ongoing);
3780 return this;
3781 }
3782
Joe Onoratocb109a02011-01-18 17:57:41 -08003783 /**
Selim Cinek7b9605b2017-01-19 17:36:00 -08003784 * Set whether this notification should be colorized. When set, the color set with
3785 * {@link #setColor(int)} will be used as the background color of this notification.
3786 * <p>
Selim Cinek7b9605b2017-01-19 17:36:00 -08003787 * This should only be used for high priority ongoing tasks like navigation, an ongoing
3788 * call, or other similarly high-priority events for the user.
Selim Cinek99104832017-01-25 14:47:33 -08003789 * <p>
Selim Cinek22714f12017-04-13 16:23:53 -07003790 * For most styles, the coloring will only be applied if the notification is for a
3791 * foreground service notification.
Selim Cinek99104832017-01-25 14:47:33 -08003792 * However, for {@link MediaStyle} and {@link DecoratedMediaCustomViewStyle} notifications
Selim Cinek22714f12017-04-13 16:23:53 -07003793 * that have a media session attached there is no such requirement.
Selim Cinek7b9605b2017-01-19 17:36:00 -08003794 *
Selim Cinek7b9605b2017-01-19 17:36:00 -08003795 * @see Builder#setColor(int)
Selim Cinek99104832017-01-25 14:47:33 -08003796 * @see MediaStyle#setMediaSession(MediaSession.Token)
Selim Cinek7b9605b2017-01-19 17:36:00 -08003797 */
3798 public Builder setColorized(boolean colorize) {
3799 mN.extras.putBoolean(EXTRA_COLORIZED, colorize);
3800 return this;
3801 }
3802
3803 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003804 * Set this flag if you would only like the sound, vibrate
3805 * and ticker to be played if the notification is not already showing.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003806 *
3807 * @see Notification#FLAG_ONLY_ALERT_ONCE
Joe Onoratocb109a02011-01-18 17:57:41 -08003808 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003809 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
3810 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
3811 return this;
3812 }
3813
Joe Onoratocb109a02011-01-18 17:57:41 -08003814 /**
Julia Reynolds04499532016-09-13 14:04:53 -04003815 * Make this notification automatically dismissed when the user touches it.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003816 *
3817 * @see Notification#FLAG_AUTO_CANCEL
Joe Onoratocb109a02011-01-18 17:57:41 -08003818 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003819 public Builder setAutoCancel(boolean autoCancel) {
Joe Onorato281d83f2011-01-04 17:13:10 -08003820 setFlag(FLAG_AUTO_CANCEL, autoCancel);
Joe Onorato46439ce2010-11-19 13:56:21 -08003821 return this;
3822 }
3823
Joe Onoratocb109a02011-01-18 17:57:41 -08003824 /**
Griff Hazendfcb0802014-02-11 12:00:00 -08003825 * Set whether or not this notification should not bridge to other devices.
3826 *
3827 * <p>Some notifications can be bridged to other devices for remote display.
3828 * This hint can be set to recommend this notification not be bridged.
3829 */
3830 public Builder setLocalOnly(boolean localOnly) {
3831 setFlag(FLAG_LOCAL_ONLY, localOnly);
3832 return this;
3833 }
3834
3835 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003836 * Set which notification properties will be inherited from system defaults.
Joe Onoratocb109a02011-01-18 17:57:41 -08003837 * <p>
3838 * The value should be one or more of the following fields combined with
3839 * bitwise-or:
3840 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
3841 * <p>
3842 * For all default values, use {@link #DEFAULT_ALL}.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003843 *
3844 * @deprecated use {@link NotificationChannel#enableVibration(boolean)} and
Julia Reynolds529e3322017-02-06 08:33:01 -05003845 * {@link NotificationChannel#enableLights(boolean)} and
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003846 * {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003847 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003848 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003849 public Builder setDefaults(int defaults) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003850 mN.defaults = defaults;
Joe Onorato46439ce2010-11-19 13:56:21 -08003851 return this;
3852 }
3853
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003854 /**
3855 * Set the priority of this notification.
3856 *
3857 * @see Notification#priority
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003858 * @deprecated use {@link NotificationChannel#setImportance(int)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003859 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003860 @Deprecated
Tor Norbyed9273d62013-05-30 15:59:53 -07003861 public Builder setPriority(@Priority int pri) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003862 mN.priority = pri;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003863 return this;
3864 }
Joe Malin8d40d042012-11-05 11:36:40 -08003865
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003866 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04003867 * Set the notification category.
Joe Malin8d40d042012-11-05 11:36:40 -08003868 *
John Spurlockfd7f1e02014-03-18 16:41:57 -04003869 * @see Notification#category
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003870 */
John Spurlockfd7f1e02014-03-18 16:41:57 -04003871 public Builder setCategory(String category) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003872 mN.category = category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003873 return this;
3874 }
3875
3876 /**
Chris Wrendde75302014-03-26 17:24:15 -04003877 * Add a person that is relevant to this notification.
3878 *
Chris Wrene6c48932014-09-29 17:19:27 -04003879 * <P>
3880 * Depending on user preferences, this annotation may allow the notification to pass
Julia Reynoldse071abd2017-03-22 10:52:11 -04003881 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3882 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3883 * appear more prominently in the user interface.
Chris Wrene6c48932014-09-29 17:19:27 -04003884 * </P>
3885 *
3886 * <P>
3887 * The person should be specified by the {@code String} representation of a
3888 * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
3889 * </P>
3890 *
3891 * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
3892 * URIs. The path part of these URIs must exist in the contacts database, in the
3893 * appropriate column, or the reference will be discarded as invalid. Telephone schema
3894 * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
Selim Cineke7238dd2017-12-14 17:48:32 -08003895 * It is also possible to provide a URI with the schema {@code name:} in order to uniquely
3896 * identify a person without an entry in the contacts database.
Chris Wrene6c48932014-09-29 17:19:27 -04003897 * </P>
3898 *
3899 * @param uri A URI for the person.
Chris Wrendde75302014-03-26 17:24:15 -04003900 * @see Notification#EXTRA_PEOPLE
Selim Cineke7238dd2017-12-14 17:48:32 -08003901 * @deprecated use {@link #addPerson(Person)}
Chris Wrendde75302014-03-26 17:24:15 -04003902 */
Chris Wrene6c48932014-09-29 17:19:27 -04003903 public Builder addPerson(String uri) {
Selim Cinek9acd6732018-03-23 16:39:02 -07003904 addPerson(new Person.Builder().setUri(uri).build());
Selim Cineke7238dd2017-12-14 17:48:32 -08003905 return this;
3906 }
3907
3908 /**
3909 * Add a person that is relevant to this notification.
3910 *
3911 * <P>
3912 * Depending on user preferences, this annotation may allow the notification to pass
3913 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3914 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3915 * appear more prominently in the user interface.
3916 * </P>
3917 *
3918 * <P>
3919 * A person should usually contain a uri in order to benefit from the ranking boost.
3920 * However, even if no uri is provided, it's beneficial to provide other people in the
3921 * notification, such that listeners and voice only devices can announce and handle them
3922 * properly.
3923 * </P>
3924 *
3925 * @param person the person to add.
3926 * @see Notification#EXTRA_PEOPLE_LIST
3927 */
3928 public Builder addPerson(Person person) {
3929 mPersonList.add(person);
Chris Wrendde75302014-03-26 17:24:15 -04003930 return this;
3931 }
3932
3933 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003934 * Set this notification to be part of a group of notifications sharing the same key.
3935 * Grouped notifications may display in a cluster or stack on devices which
3936 * support such rendering.
3937 *
3938 * <p>To make this notification the summary for its group, also call
3939 * {@link #setGroupSummary}. A sort order can be specified for group members by using
3940 * {@link #setSortKey}.
3941 * @param groupKey The group key of the group.
3942 * @return this object for method chaining
3943 */
3944 public Builder setGroup(String groupKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003945 mN.mGroupKey = groupKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003946 return this;
3947 }
3948
3949 /**
3950 * Set this notification to be the group summary for a group of notifications.
3951 * Grouped notifications may display in a cluster or stack on devices which
Julia Reynolds04499532016-09-13 14:04:53 -04003952 * support such rendering. If thereRequires a group key also be set using {@link #setGroup}.
3953 * The group summary may be suppressed if too few notifications are included in the group.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003954 * @param isGroupSummary Whether this notification should be a group summary.
3955 * @return this object for method chaining
3956 */
3957 public Builder setGroupSummary(boolean isGroupSummary) {
3958 setFlag(FLAG_GROUP_SUMMARY, isGroupSummary);
3959 return this;
3960 }
3961
3962 /**
3963 * Set a sort key that orders this notification among other notifications from the
3964 * same package. This can be useful if an external sort was already applied and an app
3965 * would like to preserve this. Notifications will be sorted lexicographically using this
3966 * value, although providing different priorities in addition to providing sort key may
3967 * cause this value to be ignored.
3968 *
3969 * <p>This sort key can also be used to order members of a notification group. See
Griff Hazen9e1379f2014-05-20 12:50:51 -07003970 * {@link #setGroup}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003971 *
3972 * @see String#compareTo(String)
3973 */
3974 public Builder setSortKey(String sortKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003975 mN.mSortKey = sortKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003976 return this;
3977 }
3978
3979 /**
Griff Hazen720042b2014-02-24 15:46:56 -08003980 * Merge additional metadata into this notification.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003981 *
Griff Hazen720042b2014-02-24 15:46:56 -08003982 * <p>Values within the Bundle will replace existing extras values in this Builder.
3983 *
3984 * @see Notification#extras
3985 */
Griff Hazen959591e2014-05-15 22:26:18 -07003986 public Builder addExtras(Bundle extras) {
3987 if (extras != null) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003988 mUserExtras.putAll(extras);
Griff Hazen720042b2014-02-24 15:46:56 -08003989 }
3990 return this;
3991 }
3992
3993 /**
3994 * Set metadata for this notification.
3995 *
3996 * <p>A reference to the Bundle is held for the lifetime of this Builder, and the Bundle's
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003997 * current contents are copied into the Notification each time {@link #build()} is
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003998 * called.
3999 *
Griff Hazen720042b2014-02-24 15:46:56 -08004000 * <p>Replaces any existing extras values with those from the provided Bundle.
4001 * Use {@link #addExtras} to merge in metadata instead.
4002 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004003 * @see Notification#extras
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004004 */
Griff Hazen959591e2014-05-15 22:26:18 -07004005 public Builder setExtras(Bundle extras) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004006 if (extras != null) {
4007 mUserExtras = extras;
4008 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004009 return this;
4010 }
4011
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004012 /**
Griff Hazen720042b2014-02-24 15:46:56 -08004013 * Get the current metadata Bundle used by this notification Builder.
4014 *
4015 * <p>The returned Bundle is shared with this Builder.
4016 *
4017 * <p>The current contents of this Bundle are copied into the Notification each time
4018 * {@link #build()} is called.
4019 *
4020 * @see Notification#extras
4021 */
4022 public Bundle getExtras() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004023 return mUserExtras;
4024 }
4025
4026 private Bundle getAllExtras() {
4027 final Bundle saveExtras = (Bundle) mUserExtras.clone();
4028 saveExtras.putAll(mN.extras);
4029 return saveExtras;
Griff Hazen720042b2014-02-24 15:46:56 -08004030 }
4031
4032 /**
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004033 * Add an action to this notification. Actions are typically displayed by
4034 * the system as a button adjacent to the notification content.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004035 * <p>
4036 * Every action must have an icon (32dp square and matching the
4037 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4038 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4039 * <p>
4040 * A notification in its expanded form can display up to 3 actions, from left to right in
4041 * the order they were added. Actions will not be displayed when the notification is
4042 * collapsed, however, so be sure that any essential functions may be accessed by the user
4043 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004044 *
4045 * @param icon Resource ID of a drawable that represents the action.
4046 * @param title Text describing the action.
4047 * @param intent PendingIntent to be fired when the action is invoked.
Dan Sandler86647982015-05-13 23:41:13 -04004048 *
4049 * @deprecated Use {@link #addAction(Action)} instead.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004050 */
Dan Sandler86647982015-05-13 23:41:13 -04004051 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004052 public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004053 mActions.add(new Action(icon, safeCharSequence(title), intent));
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004054 return this;
4055 }
4056
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004057 /**
Griff Hazen959591e2014-05-15 22:26:18 -07004058 * Add an action to this notification. Actions are typically displayed by
4059 * the system as a button adjacent to the notification content.
4060 * <p>
4061 * Every action must have an icon (32dp square and matching the
4062 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4063 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4064 * <p>
4065 * A notification in its expanded form can display up to 3 actions, from left to right in
4066 * the order they were added. Actions will not be displayed when the notification is
4067 * collapsed, however, so be sure that any essential functions may be accessed by the user
4068 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
4069 *
4070 * @param action The action to add.
4071 */
4072 public Builder addAction(Action action) {
liangweikang63b03b52017-03-16 19:22:15 +08004073 if (action != null) {
4074 mActions.add(action);
4075 }
Griff Hazen959591e2014-05-15 22:26:18 -07004076 return this;
4077 }
4078
4079 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004080 * Alter the complete list of actions attached to this notification.
4081 * @see #addAction(Action).
4082 *
4083 * @param actions
4084 * @return
4085 */
4086 public Builder setActions(Action... actions) {
4087 mActions.clear();
4088 for (int i = 0; i < actions.length; i++) {
liangweikang63b03b52017-03-16 19:22:15 +08004089 if (actions[i] != null) {
4090 mActions.add(actions[i]);
4091 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004092 }
4093 return this;
4094 }
4095
4096 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004097 * Add a rich notification style to be applied at build time.
4098 *
4099 * @param style Object responsible for modifying the notification style.
4100 */
4101 public Builder setStyle(Style style) {
4102 if (mStyle != style) {
4103 mStyle = style;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004104 if (mStyle != null) {
4105 mStyle.setBuilder(this);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004106 mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName());
4107 } else {
4108 mN.extras.remove(EXTRA_TEMPLATE);
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004109 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004110 }
4111 return this;
4112 }
4113
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004114 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05004115 * Returns the style set by {@link #setStyle(Style)}.
4116 */
4117 public Style getStyle() {
4118 return mStyle;
4119 }
4120
4121 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004122 * Specify the value of {@link #visibility}.
Griff Hazenb720abe2014-05-20 13:15:30 -07004123 *
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004124 * @return The same Builder.
4125 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004126 public Builder setVisibility(@Visibility int visibility) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004127 mN.visibility = visibility;
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004128 return this;
4129 }
4130
4131 /**
4132 * Supply a replacement Notification whose contents should be shown in insecure contexts
4133 * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}.
4134 * @param n A replacement notification, presumably with some or all info redacted.
4135 * @return The same Builder.
4136 */
4137 public Builder setPublicVersion(Notification n) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004138 if (n != null) {
4139 mN.publicVersion = new Notification();
4140 n.cloneInto(mN.publicVersion, /*heavy=*/ true);
4141 } else {
4142 mN.publicVersion = null;
4143 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004144 return this;
4145 }
4146
Griff Hazenb720abe2014-05-20 13:15:30 -07004147 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004148 * Apply an extender to this notification builder. Extenders may be used to add
4149 * metadata or change options on this builder.
4150 */
Griff Hazen61a9e862014-05-22 16:05:19 -07004151 public Builder extend(Extender extender) {
4152 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004153 return this;
4154 }
4155
Dan Sandler4e787062015-06-17 15:09:48 -04004156 /**
4157 * @hide
4158 */
Julia Reynoldse46bb372016-03-17 11:05:58 -04004159 public Builder setFlag(int mask, boolean value) {
Joe Onorato46439ce2010-11-19 13:56:21 -08004160 if (value) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004161 mN.flags |= mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004162 } else {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004163 mN.flags &= ~mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004164 }
Julia Reynoldse46bb372016-03-17 11:05:58 -04004165 return this;
Joe Onorato46439ce2010-11-19 13:56:21 -08004166 }
4167
Dan Sandler26e81cf2014-05-06 10:01:27 -04004168 /**
4169 * Sets {@link Notification#color}.
4170 *
4171 * @param argb The accent color to use
4172 *
4173 * @return The same Builder.
4174 */
Tor Norbye80756e32015-03-02 09:39:27 -08004175 public Builder setColor(@ColorInt int argb) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004176 mN.color = argb;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05004177 sanitizeColor();
Dan Sandler26e81cf2014-05-06 10:01:27 -04004178 return this;
4179 }
4180
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004181 private Drawable getProfileBadgeDrawable() {
Chris Wren66619a22016-05-12 16:42:37 -04004182 if (mContext.getUserId() == UserHandle.USER_SYSTEM) {
4183 // This user can never be a badged profile,
4184 // and also includes USER_ALL system notifications.
4185 return null;
4186 }
Christoph Studer7ac80e62014-08-04 16:01:57 +02004187 // Note: This assumes that the current user can read the profile badge of the
4188 // originating user.
Selim Cineke6ff9462016-01-15 15:07:06 -08004189 return mContext.getPackageManager().getUserBadgeForDensityNoBackground(
Julia Reynoldsda303542015-11-23 14:00:20 -05004190 new UserHandle(mContext.getUserId()), 0);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004191 }
4192
4193 private Bitmap getProfileBadge() {
4194 Drawable badge = getProfileBadgeDrawable();
Kenny Guy8a0101b2014-05-08 23:34:12 +01004195 if (badge == null) {
4196 return null;
4197 }
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004198 final int size = mContext.getResources().getDimensionPixelSize(
4199 R.dimen.notification_badge_size);
4200 Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004201 Canvas canvas = new Canvas(bitmap);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004202 badge.setBounds(0, 0, size, size);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004203 badge.draw(canvas);
4204 return bitmap;
4205 }
4206
Selim Cinekc848c3a2016-01-13 15:27:30 -08004207 private void bindProfileBadge(RemoteViews contentView) {
Kenny Guy98193ea2014-07-24 19:54:37 +01004208 Bitmap profileBadge = getProfileBadge();
4209
Kenny Guy98193ea2014-07-24 19:54:37 +01004210 if (profileBadge != null) {
Selim Cinekc848c3a2016-01-13 15:27:30 -08004211 contentView.setImageViewBitmap(R.id.profile_badge, profileBadge);
4212 contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004213 if (isColorized()) {
Sunny Goyal5b153922017-09-21 21:00:36 -07004214 contentView.setDrawableTint(R.id.profile_badge, false,
4215 getPrimaryTextColor(), PorterDuff.Mode.SRC_ATOP);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004216 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004217 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004218 }
4219
Julia Reynoldsfc640012018-02-21 12:25:27 -05004220 /**
4221 * @hide
4222 */
4223 public boolean usesStandardHeader() {
4224 if (mN.mUsesStandardHeader) {
4225 return true;
4226 }
4227 if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.N) {
4228 if (mN.contentView == null && mN.bigContentView == null) {
4229 return true;
4230 }
4231 }
4232 boolean contentViewUsesHeader = mN.contentView == null
4233 || STANDARD_LAYOUTS.contains(mN.contentView.getLayoutId());
4234 boolean bigContentViewUsesHeader = mN.bigContentView == null
4235 || STANDARD_LAYOUTS.contains(mN.bigContentView.getLayoutId());
4236 return contentViewUsesHeader && bigContentViewUsesHeader;
4237 }
4238
Christoph Studerfe718432014-09-01 18:21:18 +02004239 private void resetStandardTemplate(RemoteViews contentView) {
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004240 resetNotificationHeader(contentView);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004241 resetContentMargins(contentView);
Christoph Studerfe718432014-09-01 18:21:18 +02004242 contentView.setViewVisibility(R.id.right_icon, View.GONE);
Selim Cinek860b6da2015-12-16 19:02:19 -08004243 contentView.setViewVisibility(R.id.title, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004244 contentView.setTextViewText(R.id.title, null);
Selim Cinek41598732016-01-11 16:58:37 -08004245 contentView.setViewVisibility(R.id.text, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004246 contentView.setTextViewText(R.id.text, null);
Selim Cinek29603462015-11-17 19:04:39 -08004247 contentView.setViewVisibility(R.id.text_line_1, View.GONE);
Selim Cinek41598732016-01-11 16:58:37 -08004248 contentView.setTextViewText(R.id.text_line_1, null);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004249 }
4250
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004251 /**
4252 * Resets the notification header to its original state
4253 */
4254 private void resetNotificationHeader(RemoteViews contentView) {
Adrian Roosc4337a32016-08-02 18:30:34 -07004255 // Small icon doesn't need to be reset, as it's always set. Resetting would prevent
4256 // re-using the drawable when the notification is updated.
Selim Cinek7b836392015-12-04 20:02:59 -08004257 contentView.setBoolean(R.id.notification_header, "setExpanded", false);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004258 contentView.setTextViewText(R.id.app_name_text, null);
Christoph Studerca1db712014-09-10 17:31:33 +02004259 contentView.setViewVisibility(R.id.chronometer, View.GONE);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004260 contentView.setViewVisibility(R.id.header_text, View.GONE);
Adrian Roos9dfb78f2016-06-30 15:43:44 -07004261 contentView.setTextViewText(R.id.header_text, null);
Selim Cinekafeed292017-12-12 17:32:44 -08004262 contentView.setViewVisibility(R.id.header_text_secondary, View.GONE);
4263 contentView.setTextViewText(R.id.header_text_secondary, null);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004264 contentView.setViewVisibility(R.id.header_text_divider, View.GONE);
Selim Cinekafeed292017-12-12 17:32:44 -08004265 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004266 contentView.setViewVisibility(R.id.time_divider, View.GONE);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004267 contentView.setViewVisibility(R.id.time, View.GONE);
Selim Cinekc848c3a2016-01-13 15:27:30 -08004268 contentView.setImageViewIcon(R.id.profile_badge, null);
4269 contentView.setViewVisibility(R.id.profile_badge, View.GONE);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004270 mN.mUsesStandardHeader = false;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004271 }
4272
4273 private void resetContentMargins(RemoteViews contentView) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07004274 contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
4275 contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
Christoph Studerfe718432014-09-01 18:21:18 +02004276 }
4277
Jorim Jaggi445d3c02014-08-19 22:33:42 +02004278 private RemoteViews applyStandardTemplate(int resId) {
Adrian Roos70d7aa32017-01-11 15:39:06 -08004279 return applyStandardTemplate(resId, mParams.reset().fillTextsFrom(this));
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004280 }
4281
4282 /**
4283 * @param hasProgress whether the progress bar should be shown and set
4284 */
4285 private RemoteViews applyStandardTemplate(int resId, boolean hasProgress) {
Adrian Roos70d7aa32017-01-11 15:39:06 -08004286 return applyStandardTemplate(resId, mParams.reset().hasProgress(hasProgress)
4287 .fillTextsFrom(this));
Adrian Roosc1a80b02016-04-05 14:54:55 -07004288 }
4289
Adrian Roos70d7aa32017-01-11 15:39:06 -08004290 private RemoteViews applyStandardTemplate(int resId, StandardTemplateParams p) {
Kenny Guy77320062014-08-27 21:37:15 +01004291 RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId);
Dan Sandler539aad42014-08-04 00:43:39 -04004292
Christoph Studerfe718432014-09-01 18:21:18 +02004293 resetStandardTemplate(contentView);
4294
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004295 final Bundle ex = mN.extras;
Selim Cinek7b9605b2017-01-19 17:36:00 -08004296 updateBackgroundColor(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004297 bindNotificationHeader(contentView, p.ambient, p.headerTextSecondary);
Lucas Dupin90158d02018-01-23 16:36:12 -08004298 bindLargeIcon(contentView, p.hideLargeIcon || p.ambient, p.alwaysShowReply);
Adrian Roos70d7aa32017-01-11 15:39:06 -08004299 boolean showProgress = handleProgressBar(p.hasProgress, contentView, ex);
4300 if (p.title != null) {
Selim Cinek860b6da2015-12-16 19:02:19 -08004301 contentView.setViewVisibility(R.id.title, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004302 contentView.setTextViewText(R.id.title, processTextSpans(p.title));
Adrian Roos72171622017-01-27 10:32:06 -08004303 if (!p.ambient) {
4304 setTextViewColorPrimary(contentView, R.id.title);
4305 }
Selim Cinek954cc232016-05-20 13:29:23 -07004306 contentView.setViewLayoutWidth(R.id.title, showProgress
4307 ? ViewGroup.LayoutParams.WRAP_CONTENT
4308 : ViewGroup.LayoutParams.MATCH_PARENT);
Joe Onorato561d3852010-11-20 18:09:34 -08004309 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08004310 if (p.text != null) {
Selim Cinek41598732016-01-11 16:58:37 -08004311 int textId = showProgress ? com.android.internal.R.id.text_line_1
4312 : com.android.internal.R.id.text;
Selim Cinek48f66b72017-08-18 16:17:51 -07004313 contentView.setTextViewText(textId, processTextSpans(p.text));
Adrian Roos72171622017-01-27 10:32:06 -08004314 if (!p.ambient) {
4315 setTextViewColorSecondary(contentView, textId);
4316 }
Selim Cinek41598732016-01-11 16:58:37 -08004317 contentView.setViewVisibility(textId, View.VISIBLE);
Joe Onorato561d3852010-11-20 18:09:34 -08004318 }
Selim Cinekc848c3a2016-01-13 15:27:30 -08004319
Selim Cinek279fa862016-06-14 10:57:25 -07004320 setContentMinHeight(contentView, showProgress || mN.hasLargeIcon());
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004321
Selim Cinek29603462015-11-17 19:04:39 -08004322 return contentView;
4323 }
4324
Selim Cinek48f66b72017-08-18 16:17:51 -07004325 private CharSequence processTextSpans(CharSequence text) {
4326 if (hasForegroundColor()) {
Selim Cinek87c31532017-08-18 18:53:44 -07004327 return NotificationColorUtil.clearColorSpans(text);
Selim Cinek48f66b72017-08-18 16:17:51 -07004328 }
4329 return text;
4330 }
4331
Selim Cinek7b9605b2017-01-19 17:36:00 -08004332 private void setTextViewColorPrimary(RemoteViews contentView, int id) {
4333 ensureColors();
4334 contentView.setTextColor(id, mPrimaryTextColor);
4335 }
4336
Selim Cinek48f66b72017-08-18 16:17:51 -07004337 private boolean hasForegroundColor() {
4338 return mForegroundColor != COLOR_INVALID;
4339 }
4340
Selim Cinek389edcd2017-05-11 19:16:44 -07004341 /**
4342 * @return the primary text color
4343 * @hide
4344 */
4345 @VisibleForTesting
4346 public int getPrimaryTextColor() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004347 ensureColors();
4348 return mPrimaryTextColor;
4349 }
4350
Selim Cinek389edcd2017-05-11 19:16:44 -07004351 /**
4352 * @return the secondary text color
4353 * @hide
4354 */
4355 @VisibleForTesting
4356 public int getSecondaryTextColor() {
4357 ensureColors();
4358 return mSecondaryTextColor;
4359 }
4360
Selim Cinek7b9605b2017-01-19 17:36:00 -08004361 private void setTextViewColorSecondary(RemoteViews contentView, int id) {
4362 ensureColors();
4363 contentView.setTextColor(id, mSecondaryTextColor);
4364 }
4365
4366 private void ensureColors() {
4367 int backgroundColor = getBackgroundColor();
4368 if (mPrimaryTextColor == COLOR_INVALID
4369 || mSecondaryTextColor == COLOR_INVALID
Selim Cinek7b9605b2017-01-19 17:36:00 -08004370 || mTextColorsAreForBackground != backgroundColor) {
4371 mTextColorsAreForBackground = backgroundColor;
Selim Cinek48f66b72017-08-18 16:17:51 -07004372 if (!hasForegroundColor() || !isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004373 mPrimaryTextColor = NotificationColorUtil.resolvePrimaryColor(mContext,
4374 backgroundColor);
4375 mSecondaryTextColor = NotificationColorUtil.resolveSecondaryColor(mContext,
4376 backgroundColor);
Selim Cinekc7f5a822018-03-20 19:32:06 -07004377 if (backgroundColor != COLOR_DEFAULT && isColorized()) {
Selim Cinekac5f0272017-05-02 16:05:41 -07004378 mPrimaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4379 mPrimaryTextColor, backgroundColor, 4.5);
4380 mSecondaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4381 mSecondaryTextColor, backgroundColor, 4.5);
4382 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07004383 } else {
4384 double backLum = NotificationColorUtil.calculateLuminance(backgroundColor);
4385 double textLum = NotificationColorUtil.calculateLuminance(mForegroundColor);
4386 double contrast = NotificationColorUtil.calculateContrast(mForegroundColor,
4387 backgroundColor);
Selim Cinek389edcd2017-05-11 19:16:44 -07004388 // We only respect the given colors if worst case Black or White still has
4389 // contrast
4390 boolean backgroundLight = backLum > textLum
4391 && satisfiesTextContrast(backgroundColor, Color.BLACK)
4392 || backLum <= textLum
4393 && !satisfiesTextContrast(backgroundColor, Color.WHITE);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004394 if (contrast < 4.5f) {
Selim Cinek389edcd2017-05-11 19:16:44 -07004395 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004396 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4397 mForegroundColor,
4398 backgroundColor,
4399 true /* findFG */,
4400 4.5f);
4401 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004402 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_LIGHT);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004403 } else {
4404 mSecondaryTextColor =
4405 NotificationColorUtil.findContrastColorAgainstDark(
4406 mForegroundColor,
4407 backgroundColor,
4408 true /* findFG */,
4409 4.5f);
4410 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004411 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004412 }
4413 } else {
4414 mPrimaryTextColor = mForegroundColor;
4415 mSecondaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004416 mPrimaryTextColor, backgroundLight ? LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4417 : LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004418 if (NotificationColorUtil.calculateContrast(mSecondaryTextColor,
4419 backgroundColor) < 4.5f) {
4420 // oh well the secondary is not good enough
Selim Cinek389edcd2017-05-11 19:16:44 -07004421 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004422 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4423 mSecondaryTextColor,
4424 backgroundColor,
4425 true /* findFG */,
4426 4.5f);
4427 } else {
4428 mSecondaryTextColor
4429 = NotificationColorUtil.findContrastColorAgainstDark(
4430 mSecondaryTextColor,
4431 backgroundColor,
4432 true /* findFG */,
4433 4.5f);
4434 }
4435 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004436 mSecondaryTextColor, backgroundLight
4437 ? -LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4438 : -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004439 }
4440 }
4441 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08004442 }
4443 }
4444
4445 private void updateBackgroundColor(RemoteViews contentView) {
4446 if (isColorized()) {
4447 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundColor",
4448 getBackgroundColor());
4449 } else {
4450 // Clear it!
4451 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundResource",
4452 0);
4453 }
4454 }
4455
Selim Cinek860b6da2015-12-16 19:02:19 -08004456 /**
4457 * @param remoteView the remote view to update the minheight in
4458 * @param hasMinHeight does it have a mimHeight
4459 * @hide
4460 */
4461 void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) {
4462 int minHeight = 0;
4463 if (hasMinHeight) {
4464 // we need to set the minHeight of the notification
4465 minHeight = mContext.getResources().getDimensionPixelSize(
4466 com.android.internal.R.dimen.notification_min_content_height);
4467 }
4468 remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight);
4469 }
4470
Selim Cinek29603462015-11-17 19:04:39 -08004471 private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004472 final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0);
4473 final int progress = ex.getInt(EXTRA_PROGRESS, 0);
4474 final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
4475 if (hasProgress && (max != 0 || ind)) {
Selim Cinek29603462015-11-17 19:04:39 -08004476 contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004477 contentView.setProgressBar(
Selim Cinek29603462015-11-17 19:04:39 -08004478 R.id.progress, max, progress, ind);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004479 contentView.setProgressBackgroundTintList(
4480 R.id.progress, ColorStateList.valueOf(mContext.getColor(
4481 R.color.notification_progress_background_color)));
Selim Cinek29603462015-11-17 19:04:39 -08004482 if (mN.color != COLOR_DEFAULT) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08004483 ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004484 contentView.setProgressTintList(R.id.progress, colorStateList);
4485 contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004486 }
Selim Cinek29603462015-11-17 19:04:39 -08004487 return true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004488 } else {
4489 contentView.setViewVisibility(R.id.progress, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004490 return false;
Jeff Sharkey1c400132011-08-05 14:50:13 -07004491 }
Joe Onorato561d3852010-11-20 18:09:34 -08004492 }
4493
Selim Cinek88188f22017-09-19 16:46:56 -07004494 private void bindLargeIcon(RemoteViews contentView, boolean hideLargeIcon,
4495 boolean alwaysShowReply) {
Selim Cinek279fa862016-06-14 10:57:25 -07004496 if (mN.mLargeIcon == null && mN.largeIcon != null) {
4497 mN.mLargeIcon = Icon.createWithBitmap(mN.largeIcon);
4498 }
Selim Cinek88188f22017-09-19 16:46:56 -07004499 boolean showLargeIcon = mN.mLargeIcon != null && !hideLargeIcon;
4500 if (showLargeIcon) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004501 contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4502 contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon);
4503 processLargeLegacyIcon(mN.mLargeIcon, contentView);
Adrian Roos2d5dbba2016-06-08 17:11:53 -07004504 int endMargin = R.dimen.notification_content_picture_margin;
4505 contentView.setViewLayoutMarginEndDimen(R.id.line1, endMargin);
4506 contentView.setViewLayoutMarginEndDimen(R.id.text, endMargin);
4507 contentView.setViewLayoutMarginEndDimen(R.id.progress, endMargin);
Selim Cinek88188f22017-09-19 16:46:56 -07004508 }
4509 // Bind the reply action
4510 Action action = findReplyAction();
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004511
Selim Cinek88188f22017-09-19 16:46:56 -07004512 boolean actionVisible = action != null && (showLargeIcon || alwaysShowReply);
4513 int replyId = showLargeIcon ? R.id.reply_icon_action : R.id.right_icon;
4514 if (actionVisible) {
4515 // We're only showing the icon as big if we're hiding the large icon
4516 int contrastColor = resolveContrastColor();
4517 int iconColor;
4518 if (showLargeIcon) {
Sunny Goyal5b153922017-09-21 21:00:36 -07004519 contentView.setDrawableTint(R.id.reply_icon_action,
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004520 true /* targetBackground */,
Sunny Goyal5b153922017-09-21 21:00:36 -07004521 contrastColor, PorterDuff.Mode.SRC_ATOP);
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004522 contentView.setOnClickPendingIntent(R.id.right_icon,
4523 action.actionIntent);
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004524 contentView.setRemoteInputs(R.id.right_icon, action.mRemoteInputs);
Selim Cinek88188f22017-09-19 16:46:56 -07004525 iconColor = NotificationColorUtil.isColorLight(contrastColor)
4526 ? Color.BLACK : Color.WHITE;
4527 } else {
4528 contentView.setImageViewResource(R.id.right_icon,
4529 R.drawable.ic_reply_notification_large);
4530 contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4531 iconColor = contrastColor;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004532 }
Selim Cinek88188f22017-09-19 16:46:56 -07004533 contentView.setDrawableTint(replyId,
4534 false /* targetBackground */,
4535 iconColor,
4536 PorterDuff.Mode.SRC_ATOP);
4537 contentView.setOnClickPendingIntent(replyId,
4538 action.actionIntent);
4539 contentView.setRemoteInputs(replyId, action.mRemoteInputs);
4540 } else {
4541 contentView.setRemoteInputs(R.id.right_icon, null);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004542 }
Selim Cinek88188f22017-09-19 16:46:56 -07004543 contentView.setViewVisibility(R.id.reply_icon_action, actionVisible && showLargeIcon
4544 ? View.VISIBLE
4545 : View.GONE);
4546 contentView.setViewVisibility(R.id.right_icon_container, actionVisible || showLargeIcon
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004547 ? View.VISIBLE
4548 : View.GONE);
4549 }
4550
4551 private Action findReplyAction() {
4552 ArrayList<Action> actions = mActions;
4553 if (mOriginalActions != null) {
4554 actions = mOriginalActions;
4555 }
4556 int numActions = actions.size();
4557 for (int i = 0; i < numActions; i++) {
4558 Action action = actions.get(i);
4559 if (hasValidRemoteInput(action)) {
4560 return action;
4561 }
4562 }
4563 return null;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004564 }
4565
Selim Cinekafeed292017-12-12 17:32:44 -08004566 private void bindNotificationHeader(RemoteViews contentView, boolean ambient,
4567 CharSequence secondaryHeaderText) {
Adrian Roos487374f2017-01-11 15:48:14 -08004568 bindSmallIcon(contentView, ambient);
4569 bindHeaderAppName(contentView, ambient);
4570 if (!ambient) {
4571 // Ambient view does not have these
4572 bindHeaderText(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004573 bindHeaderTextSecondary(contentView, secondaryHeaderText);
Adrian Roos487374f2017-01-11 15:48:14 -08004574 bindHeaderChronometerAndTime(contentView);
Adrian Roos487374f2017-01-11 15:48:14 -08004575 bindProfileBadge(contentView);
4576 }
Julia Reynoldsb887b232018-04-10 16:38:08 -04004577 bindActivePermissions(contentView);
Adrian Roosd83e9992017-03-16 15:17:57 -07004578 bindExpandButton(contentView);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004579 mN.mUsesStandardHeader = true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004580 }
4581
Julia Reynoldsb887b232018-04-10 16:38:08 -04004582 private void bindActivePermissions(RemoteViews contentView) {
4583 int color = isColorized() ? getPrimaryTextColor() : getSecondaryTextColor();
4584 contentView.setDrawableTint(R.id.camera, false, color, PorterDuff.Mode.SRC_ATOP);
4585 contentView.setDrawableTint(R.id.mic, false, color, PorterDuff.Mode.SRC_ATOP);
4586 contentView.setDrawableTint(R.id.overlay, false, color, PorterDuff.Mode.SRC_ATOP);
4587 }
4588
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004589 private void bindExpandButton(RemoteViews contentView) {
Selim Cinekc7f5a822018-03-20 19:32:06 -07004590 int color = isColorized() ? getPrimaryTextColor() : getSecondaryTextColor();
Sunny Goyal5b153922017-09-21 21:00:36 -07004591 contentView.setDrawableTint(R.id.expand_button, false, color,
4592 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08004593 contentView.setInt(R.id.notification_header, "setOriginalNotificationColor",
Selim Cinek7b9605b2017-01-19 17:36:00 -08004594 color);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004595 }
4596
4597 private void bindHeaderChronometerAndTime(RemoteViews contentView) {
4598 if (showsTimeOrChronometer()) {
Selim Cinek29603462015-11-17 19:04:39 -08004599 contentView.setViewVisibility(R.id.time_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004600 setTextViewColorSecondary(contentView, R.id.time_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004601 if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) {
4602 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
4603 contentView.setLong(R.id.chronometer, "setBase",
4604 mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
4605 contentView.setBoolean(R.id.chronometer, "setStarted", true);
Adrian Roos96b7e202016-05-17 13:50:38 -07004606 boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN);
Selim Cinekc3b752e2016-04-20 16:13:59 -07004607 contentView.setChronometerCountDown(R.id.chronometer, countsDown);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004608 setTextViewColorSecondary(contentView, R.id.chronometer);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004609 } else {
4610 contentView.setViewVisibility(R.id.time, View.VISIBLE);
4611 contentView.setLong(R.id.time, "setTime", mN.when);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004612 setTextViewColorSecondary(contentView, R.id.time);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004613 }
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004614 } else {
4615 // We still want a time to be set but gone, such that we can show and hide it
4616 // on demand in case it's a child notification without anything in the header
4617 contentView.setLong(R.id.time, "setTime", mN.when != 0 ? mN.when : mN.creationTime);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004618 }
4619 }
4620
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004621 private void bindHeaderText(RemoteViews contentView) {
4622 CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
4623 if (headerText == null && mStyle != null && mStyle.mSummaryTextSet
Selim Cinek03d0d652015-11-13 13:18:09 -05004624 && mStyle.hasSummaryInHeader()) {
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004625 headerText = mStyle.mSummaryText;
Selim Cinek03d0d652015-11-13 13:18:09 -05004626 }
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004627 if (headerText == null
4628 && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
4629 && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) {
4630 headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT);
4631 }
4632 if (headerText != null) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004633 // TODO: Remove the span entirely to only have the string with propper formating.
Selim Cinek48f66b72017-08-18 16:17:51 -07004634 contentView.setTextViewText(R.id.header_text, processTextSpans(
4635 processLegacyText(headerText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004636 setTextViewColorSecondary(contentView, R.id.header_text);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004637 contentView.setViewVisibility(R.id.header_text, View.VISIBLE);
4638 contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004639 setTextViewColorSecondary(contentView, R.id.header_text_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004640 }
4641 }
4642
Selim Cinekafeed292017-12-12 17:32:44 -08004643 private void bindHeaderTextSecondary(RemoteViews contentView, CharSequence secondaryText) {
4644 if (!TextUtils.isEmpty(secondaryText)) {
4645 contentView.setTextViewText(R.id.header_text_secondary, processTextSpans(
4646 processLegacyText(secondaryText)));
4647 setTextViewColorSecondary(contentView, R.id.header_text_secondary);
4648 contentView.setViewVisibility(R.id.header_text_secondary, View.VISIBLE);
4649 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.VISIBLE);
4650 setTextViewColorSecondary(contentView, R.id.header_text_secondary_divider);
4651 }
4652 }
4653
Adrian Rooseba05822016-04-22 17:09:27 -07004654 /**
4655 * @hide
4656 */
4657 public String loadHeaderAppName() {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004658 CharSequence name = null;
4659 final PackageManager pm = mContext.getPackageManager();
4660 if (mN.extras.containsKey(EXTRA_SUBSTITUTE_APP_NAME)) {
4661 // only system packages which lump together a bunch of unrelated stuff
4662 // may substitute a different name to make the purpose of the
4663 // notification more clear. the correct package label should always
4664 // be accessible via SystemUI.
4665 final String pkg = mContext.getPackageName();
4666 final String subName = mN.extras.getString(EXTRA_SUBSTITUTE_APP_NAME);
4667 if (PackageManager.PERMISSION_GRANTED == pm.checkPermission(
4668 android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME, pkg)) {
4669 name = subName;
4670 } else {
4671 Log.w(TAG, "warning: pkg "
4672 + pkg + " attempting to substitute app name '" + subName
4673 + "' without holding perm "
4674 + android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME);
4675 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004676 }
Dan Sandler732bd6c2016-04-12 14:20:32 -04004677 if (TextUtils.isEmpty(name)) {
4678 name = pm.getApplicationLabel(mContext.getApplicationInfo());
4679 }
4680 if (TextUtils.isEmpty(name)) {
4681 // still nothing?
4682 return null;
4683 }
4684
4685 return String.valueOf(name);
4686 }
Adrian Roos487374f2017-01-11 15:48:14 -08004687 private void bindHeaderAppName(RemoteViews contentView, boolean ambient) {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004688 contentView.setTextViewText(R.id.app_name_text, loadHeaderAppName());
Adrian Roos72171622017-01-27 10:32:06 -08004689 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004690 setTextViewColorPrimary(contentView, R.id.app_name_text);
4691 } else {
4692 contentView.setTextColor(R.id.app_name_text,
Selim Cinekc7f5a822018-03-20 19:32:06 -07004693 ambient ? resolveAmbientColor() : getSecondaryTextColor());
Selim Cinek7b9605b2017-01-19 17:36:00 -08004694 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004695 }
4696
Adrian Roos487374f2017-01-11 15:48:14 -08004697 private void bindSmallIcon(RemoteViews contentView, boolean ambient) {
Selim Cinek279fa862016-06-14 10:57:25 -07004698 if (mN.mSmallIcon == null && mN.icon != 0) {
4699 mN.mSmallIcon = Icon.createWithResource(mContext, mN.icon);
4700 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004701 contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon);
Sunny Goyal5b153922017-09-21 21:00:36 -07004702 contentView.setInt(R.id.icon, "setImageLevel", mN.iconLevel);
Adrian Roos487374f2017-01-11 15:48:14 -08004703 processSmallIconColor(mN.mSmallIcon, contentView, ambient);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004704 }
4705
Jorim Jaggi445d3c02014-08-19 22:33:42 +02004706 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004707 * @return true if the built notification will show the time or the chronometer; false
4708 * otherwise
4709 */
4710 private boolean showsTimeOrChronometer() {
Selim Cinekc2c0b042016-05-18 17:13:46 -07004711 return mN.showsTime() || mN.showsChronometer();
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004712 }
4713
Christoph Studerfe718432014-09-01 18:21:18 +02004714 private void resetStandardTemplateWithActions(RemoteViews big) {
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004715 // actions_container is only reset when there are no actions to avoid focus issues with
4716 // remote inputs.
Christoph Studerfe718432014-09-01 18:21:18 +02004717 big.setViewVisibility(R.id.actions, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004718 big.removeAllViews(R.id.actions);
Adrian Roose458aa82015-12-08 16:17:19 -08004719
4720 big.setViewVisibility(R.id.notification_material_reply_container, View.GONE);
4721 big.setTextViewText(R.id.notification_material_reply_text_1, null);
4722
4723 big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE);
4724 big.setTextViewText(R.id.notification_material_reply_text_2, null);
4725 big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE);
4726 big.setTextViewText(R.id.notification_material_reply_text_3, null);
Adrian Roosf852a422016-06-03 13:33:43 -07004727
Selim Cineked64a142018-02-06 18:06:01 -08004728 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target,
4729 R.dimen.notification_content_margin);
Christoph Studerfe718432014-09-01 18:21:18 +02004730 }
4731
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004732 private RemoteViews applyStandardTemplateWithActions(int layoutId) {
Adrian Roos70d7aa32017-01-11 15:39:06 -08004733 return applyStandardTemplateWithActions(layoutId, mParams.reset().fillTextsFrom(this));
Adrian Roos48d746a2016-04-12 14:57:28 -07004734 }
4735
Adrian Roos70d7aa32017-01-11 15:39:06 -08004736 private RemoteViews applyStandardTemplateWithActions(int layoutId,
4737 StandardTemplateParams p) {
4738 RemoteViews big = applyStandardTemplate(layoutId, p);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004739
Christoph Studerfe718432014-09-01 18:21:18 +02004740 resetStandardTemplateWithActions(big);
4741
Adrian Roose458aa82015-12-08 16:17:19 -08004742 boolean validRemoteInput = false;
4743
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004744 int N = mActions.size();
Adrian Roos487374f2017-01-11 15:48:14 -08004745 boolean emphazisedMode = mN.fullScreenIntent != null && !p.ambient;
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004746 big.setBoolean(R.id.actions, "setEmphasizedMode", emphazisedMode);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004747 if (N > 0) {
Adrian Roos7052de52016-03-03 15:53:34 -08004748 big.setViewVisibility(R.id.actions_container, View.VISIBLE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004749 big.setViewVisibility(R.id.actions, View.VISIBLE);
Selim Cineked64a142018-02-06 18:06:01 -08004750 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, 0);
Daniel Sandler8680bf82012-05-15 16:52:52 -04004751 if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004752 for (int i=0; i<N; i++) {
Adrian Roose458aa82015-12-08 16:17:19 -08004753 Action action = mActions.get(i);
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004754 boolean actionHasValidInput = hasValidRemoteInput(action);
4755 validRemoteInput |= actionHasValidInput;
Adrian Roose458aa82015-12-08 16:17:19 -08004756
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004757 final RemoteViews button = generateActionButton(action, emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07004758 p.ambient);
4759 if (actionHasValidInput && !emphazisedMode) {
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004760 // Clear the drawable
4761 button.setInt(R.id.action0, "setBackgroundResource", 0);
4762 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004763 big.addView(R.id.actions, button);
4764 }
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004765 } else {
4766 big.setViewVisibility(R.id.actions_container, View.GONE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004767 }
Adrian Roose458aa82015-12-08 16:17:19 -08004768
4769 CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
Adrian Roos487374f2017-01-11 15:48:14 -08004770 if (!p.ambient && validRemoteInput && replyText != null
Adrian Roose458aa82015-12-08 16:17:19 -08004771 && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])) {
4772 big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004773 big.setTextViewText(R.id.notification_material_reply_text_1,
4774 processTextSpans(replyText[0]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004775 setTextViewColorSecondary(big, R.id.notification_material_reply_text_1);
Adrian Roose458aa82015-12-08 16:17:19 -08004776
4777 if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])) {
4778 big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004779 big.setTextViewText(R.id.notification_material_reply_text_2,
4780 processTextSpans(replyText[1]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004781 setTextViewColorSecondary(big, R.id.notification_material_reply_text_2);
Adrian Roose458aa82015-12-08 16:17:19 -08004782
4783 if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])) {
4784 big.setViewVisibility(
4785 R.id.notification_material_reply_text_3, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004786 big.setTextViewText(R.id.notification_material_reply_text_3,
4787 processTextSpans(replyText[2]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004788 setTextViewColorSecondary(big, R.id.notification_material_reply_text_3);
Adrian Roose458aa82015-12-08 16:17:19 -08004789 }
4790 }
4791 }
4792
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004793 return big;
4794 }
4795
Adrian Roose458aa82015-12-08 16:17:19 -08004796 private boolean hasValidRemoteInput(Action action) {
4797 if (TextUtils.isEmpty(action.title) || action.actionIntent == null) {
4798 // Weird actions
4799 return false;
4800 }
4801
4802 RemoteInput[] remoteInputs = action.getRemoteInputs();
4803 if (remoteInputs == null) {
4804 return false;
4805 }
4806
4807 for (RemoteInput r : remoteInputs) {
4808 CharSequence[] choices = r.getChoices();
4809 if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) {
4810 return true;
4811 }
4812 }
4813 return false;
4814 }
4815
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004816 /**
4817 * Construct a RemoteViews for the final 1U notification layout. In order:
4818 * 1. Custom contentView from the caller
4819 * 2. Style's proposed content view
4820 * 3. Standard template view
4821 */
Julia Reynolds3b848122016-02-26 10:45:32 -05004822 public RemoteViews createContentView() {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004823 return createContentView(false /* increasedheight */ );
4824 }
4825
4826 /**
4827 * Construct a RemoteViews for the smaller content view.
4828 *
4829 * @param increasedHeight true if this layout be created with an increased height. Some
4830 * styles may support showing more then just that basic 1U size
4831 * and the system may decide to render important notifications
4832 * slightly bigger even when collapsed.
4833 *
4834 * @hide
4835 */
4836 public RemoteViews createContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07004837 if (mN.contentView != null && useExistingRemoteView()) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004838 return mN.contentView;
4839 } else if (mStyle != null) {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004840 final RemoteViews styleView = mStyle.makeContentView(increasedHeight);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004841 if (styleView != null) {
4842 return styleView;
4843 }
Joe Onorato46439ce2010-11-19 13:56:21 -08004844 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004845 return applyStandardTemplate(getBaseLayoutResource());
Joe Onorato46439ce2010-11-19 13:56:21 -08004846 }
4847
Selim Cineka7679b62017-05-10 16:33:25 -07004848 private boolean useExistingRemoteView() {
4849 return mStyle == null || (!mStyle.displayCustomViewInline()
4850 && !mRebuildStyledRemoteViews);
4851 }
4852
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004853 /**
4854 * Construct a RemoteViews for the final big notification layout.
4855 */
Julia Reynolds3b848122016-02-26 10:45:32 -05004856 public RemoteViews createBigContentView() {
Selim Cinek850a8542015-11-11 11:48:36 -05004857 RemoteViews result = null;
Selim Cineka7679b62017-05-10 16:33:25 -07004858 if (mN.bigContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05004859 return mN.bigContentView;
4860 } else if (mStyle != null) {
Selim Cinek850a8542015-11-11 11:48:36 -05004861 result = mStyle.makeBigContentView();
Selim Cinek90dcf6d2015-11-18 20:24:13 -08004862 hideLine1Text(result);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08004863 } else if (mActions.size() != 0) {
4864 result = applyStandardTemplateWithActions(getBigBaseLayoutResource());
Selim Cinek850a8542015-11-11 11:48:36 -05004865 }
Selim Cinek6743c0b2017-01-18 18:24:01 -08004866 makeHeaderExpanded(result);
Selim Cinek850a8542015-11-11 11:48:36 -05004867 return result;
4868 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004869
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004870 /**
Selim Cinek414ad332017-02-24 19:06:12 -08004871 * Construct a RemoteViews for the final notification header only. This will not be
4872 * colorized.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004873 *
Adrian Roos6f6e1592017-05-02 16:22:53 -07004874 * @param ambient if true, generate the header for the ambient display layout.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004875 * @hide
4876 */
Adrian Roos6f6e1592017-05-02 16:22:53 -07004877 public RemoteViews makeNotificationHeader(boolean ambient) {
Selim Cinek414ad332017-02-24 19:06:12 -08004878 Boolean colorized = (Boolean) mN.extras.get(EXTRA_COLORIZED);
4879 mN.extras.putBoolean(EXTRA_COLORIZED, false);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004880 RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(),
Adrian Roos6f6e1592017-05-02 16:22:53 -07004881 ambient ? R.layout.notification_template_ambient_header
4882 : R.layout.notification_template_header);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004883 resetNotificationHeader(header);
Selim Cinekafeed292017-12-12 17:32:44 -08004884 bindNotificationHeader(header, ambient, null);
Selim Cinek414ad332017-02-24 19:06:12 -08004885 if (colorized != null) {
4886 mN.extras.putBoolean(EXTRA_COLORIZED, colorized);
4887 } else {
4888 mN.extras.remove(EXTRA_COLORIZED);
4889 }
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004890 return header;
4891 }
4892
Adrian Roos487374f2017-01-11 15:48:14 -08004893 /**
4894 * Construct a RemoteViews for the ambient version of the notification.
4895 *
4896 * @hide
4897 */
4898 public RemoteViews makeAmbientNotification() {
4899 RemoteViews ambient = applyStandardTemplateWithActions(
4900 R.layout.notification_template_material_ambient,
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08004901 mParams.reset().ambient(true).fillTextsFrom(this).hasProgress(false));
Adrian Roos487374f2017-01-11 15:48:14 -08004902 return ambient;
4903 }
4904
Selim Cinek29603462015-11-17 19:04:39 -08004905 private void hideLine1Text(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08004906 if (result != null) {
4907 result.setViewVisibility(R.id.text_line_1, View.GONE);
4908 }
Selim Cinek29603462015-11-17 19:04:39 -08004909 }
4910
Selim Cinek6743c0b2017-01-18 18:24:01 -08004911 /**
4912 * Adapt the Notification header if this view is used as an expanded view.
4913 *
4914 * @hide
4915 */
4916 public static void makeHeaderExpanded(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08004917 if (result != null) {
4918 result.setBoolean(R.id.notification_header, "setExpanded", true);
4919 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004920 }
4921
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004922 /**
4923 * Construct a RemoteViews for the final heads-up notification layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08004924 *
4925 * @param increasedHeight true if this layout be created with an increased height. Some
4926 * styles may support showing more then just that basic 1U size
4927 * and the system may decide to render important notifications
4928 * slightly bigger even when collapsed.
4929 *
4930 * @hide
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004931 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08004932 public RemoteViews createHeadsUpContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07004933 if (mN.headsUpContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05004934 return mN.headsUpContentView;
4935 } else if (mStyle != null) {
Selim Cinek87ed69b2017-02-09 15:59:43 -08004936 final RemoteViews styleView = mStyle.makeHeadsUpContentView(increasedHeight);
4937 if (styleView != null) {
4938 return styleView;
4939 }
Julia Reynolds089e3e42015-11-18 09:59:57 -05004940 } else if (mActions.size() == 0) {
4941 return null;
4942 }
4943
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01004944 return applyStandardTemplateWithActions(getBigBaseLayoutResource());
Chris Wren8fd39ec2014-02-27 17:43:26 -05004945 }
4946
Selim Cinek624c02db2015-12-14 21:00:02 -08004947 /**
Selim Cinek87ed69b2017-02-09 15:59:43 -08004948 * Construct a RemoteViews for the final heads-up notification layout.
4949 */
4950 public RemoteViews createHeadsUpContentView() {
4951 return createHeadsUpContentView(false /* useIncreasedHeight */);
4952 }
4953
4954 /**
Selim Cinek624c02db2015-12-14 21:00:02 -08004955 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
4956 *
4957 * @hide
4958 */
4959 public RemoteViews makePublicContentView() {
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07004960 return makePublicView(false /* ambient */);
4961 }
4962
4963 /**
4964 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
4965 *
4966 * @hide
4967 */
4968 public RemoteViews makePublicAmbientNotification() {
4969 return makePublicView(true /* ambient */);
4970 }
4971
4972 private RemoteViews makePublicView(boolean ambient) {
Selim Cinek624c02db2015-12-14 21:00:02 -08004973 if (mN.publicVersion != null) {
4974 final Builder builder = recoverBuilder(mContext, mN.publicVersion);
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07004975 return ambient ? builder.makeAmbientNotification() : builder.createContentView();
Selim Cinek624c02db2015-12-14 21:00:02 -08004976 }
4977 Bundle savedBundle = mN.extras;
4978 Style style = mStyle;
4979 mStyle = null;
4980 Icon largeIcon = mN.mLargeIcon;
4981 mN.mLargeIcon = null;
Selim Cinek279fa862016-06-14 10:57:25 -07004982 Bitmap largeIconLegacy = mN.largeIcon;
4983 mN.largeIcon = null;
Adrian Roosb19b06b2017-05-02 18:54:40 -07004984 ArrayList<Action> actions = mActions;
4985 mActions = new ArrayList<>();
Selim Cinek624c02db2015-12-14 21:00:02 -08004986 Bundle publicExtras = new Bundle();
4987 publicExtras.putBoolean(EXTRA_SHOW_WHEN,
4988 savedBundle.getBoolean(EXTRA_SHOW_WHEN));
4989 publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER,
4990 savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER));
Adrian Roos96b7e202016-05-17 13:50:38 -07004991 publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN,
4992 savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN));
Selim Cinek624c02db2015-12-14 21:00:02 -08004993 mN.extras = publicExtras;
Selim Cinek499c20f2017-07-20 14:06:09 -07004994 RemoteViews view;
4995 if (ambient) {
4996 publicExtras.putCharSequence(EXTRA_TITLE,
4997 mContext.getString(com.android.internal.R.string.notification_hidden_text));
4998 view = makeAmbientNotification();
4999 } else{
5000 view = makeNotificationHeader(false /* ambient */);
5001 view.setBoolean(R.id.notification_header, "setExpandOnlyOnButton", true);
5002 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005003 mN.extras = savedBundle;
5004 mN.mLargeIcon = largeIcon;
Selim Cinek279fa862016-06-14 10:57:25 -07005005 mN.largeIcon = largeIconLegacy;
Adrian Roosb19b06b2017-05-02 18:54:40 -07005006 mActions = actions;
Selim Cinek624c02db2015-12-14 21:00:02 -08005007 mStyle = style;
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005008 return view;
Selim Cinek624c02db2015-12-14 21:00:02 -08005009 }
5010
Selim Cinek6743c0b2017-01-18 18:24:01 -08005011 /**
5012 * Construct a content view for the display when low - priority
5013 *
5014 * @param useRegularSubtext uses the normal subtext set if there is one available. Otherwise
5015 * a new subtext is created consisting of the content of the
5016 * notification.
5017 * @hide
5018 */
5019 public RemoteViews makeLowPriorityContentView(boolean useRegularSubtext) {
5020 int color = mN.color;
5021 mN.color = COLOR_DEFAULT;
5022 CharSequence summary = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
5023 if (!useRegularSubtext || TextUtils.isEmpty(summary)) {
5024 CharSequence newSummary = createSummaryText();
5025 if (!TextUtils.isEmpty(newSummary)) {
5026 mN.extras.putCharSequence(EXTRA_SUB_TEXT, newSummary);
5027 }
5028 }
Selim Cinek875ba9b2017-02-13 16:20:17 -08005029
Adrian Roos6f6e1592017-05-02 16:22:53 -07005030 RemoteViews header = makeNotificationHeader(false /* ambient */);
Selim Cinek1b554392017-02-28 17:22:49 -08005031 header.setBoolean(R.id.notification_header, "setAcceptAllTouches", true);
Selim Cinek6743c0b2017-01-18 18:24:01 -08005032 if (summary != null) {
5033 mN.extras.putCharSequence(EXTRA_SUB_TEXT, summary);
5034 } else {
5035 mN.extras.remove(EXTRA_SUB_TEXT);
5036 }
5037 mN.color = color;
5038 return header;
5039 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005040
Selim Cinek6743c0b2017-01-18 18:24:01 -08005041 private CharSequence createSummaryText() {
5042 CharSequence titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE);
5043 if (USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY) {
5044 return titleText;
5045 }
5046 SpannableStringBuilder summary = new SpannableStringBuilder();
5047 if (titleText == null) {
5048 titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE_BIG);
5049 }
5050 BidiFormatter bidi = BidiFormatter.getInstance();
5051 if (titleText != null) {
5052 summary.append(bidi.unicodeWrap(titleText));
5053 }
5054 CharSequence contentText = mN.extras.getCharSequence(Notification.EXTRA_TEXT);
5055 if (titleText != null && contentText != null) {
5056 summary.append(bidi.unicodeWrap(mContext.getText(
5057 R.string.notification_header_divider_symbol_with_spaces)));
5058 }
5059 if (contentText != null) {
5060 summary.append(bidi.unicodeWrap(contentText));
5061 }
5062 return summary;
5063 }
Chris Wren8fd39ec2014-02-27 17:43:26 -05005064
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005065 private RemoteViews generateActionButton(Action action, boolean emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07005066 boolean ambient) {
Daniel Sandler8680bf82012-05-15 16:52:52 -04005067 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07005068 RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(),
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005069 emphazisedMode ? getEmphasizedActionLayoutResource()
5070 : tombstone ? getActionTombstoneLayoutResource()
5071 : getActionLayoutResource());
Daniel Sandler8680bf82012-05-15 16:52:52 -04005072 if (!tombstone) {
Daniel Sandlere5518842012-05-10 16:20:40 -04005073 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
Daniel Sandlere5518842012-05-10 16:20:40 -04005074 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005075 button.setContentDescription(R.id.action0, action.title);
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005076 if (action.mRemoteInputs != null) {
5077 button.setRemoteInputs(R.id.action0, action.mRemoteInputs);
5078 }
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005079 if (emphazisedMode) {
Selim Cinek981962e2016-07-20 20:41:58 -07005080 // change the background bgColor
Selim Cinek981962e2016-07-20 20:41:58 -07005081 CharSequence title = action.title;
5082 ColorStateList[] outResultColor = null;
Selim Cinek396caca2018-04-10 17:46:46 -07005083 int background = resolveBackgroundColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005084 if (isLegacy()) {
Selim Cinek87c31532017-08-18 18:53:44 -07005085 title = NotificationColorUtil.clearColorSpans(title);
Selim Cinek981962e2016-07-20 20:41:58 -07005086 } else {
5087 outResultColor = new ColorStateList[1];
Selim Cinek396caca2018-04-10 17:46:46 -07005088 title = ensureColorSpanContrast(title, background, outResultColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005089 }
Selim Cinek48f66b72017-08-18 16:17:51 -07005090 button.setTextViewText(R.id.action0, processTextSpans(title));
Selim Cinek7b9605b2017-01-19 17:36:00 -08005091 setTextViewColorPrimary(button, R.id.action0);
Selim Cinek396caca2018-04-10 17:46:46 -07005092 int rippleColor;
5093 boolean hasColorOverride = outResultColor != null && outResultColor[0] != null;
5094 if (hasColorOverride) {
5095 // There's a span spanning the full text, let's take it and use it as the
5096 // background color
5097 background = outResultColor[0].getDefaultColor();
5098 int textColor = NotificationColorUtil.resolvePrimaryColor(mContext,
5099 background);
5100 button.setTextColor(R.id.action0, textColor);
5101 rippleColor = textColor;
Anthony Chenad4d1582017-04-10 16:07:58 -07005102 } else if (mN.color != COLOR_DEFAULT && !isColorized() && mTintActionButtons) {
Selim Cinek396caca2018-04-10 17:46:46 -07005103 rippleColor = resolveContrastColor();
5104 button.setTextColor(R.id.action0, rippleColor);
5105 } else {
5106 rippleColor = getPrimaryTextColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005107 }
Selim Cinek396caca2018-04-10 17:46:46 -07005108 // We only want about 20% alpha for the ripple
5109 rippleColor = (rippleColor & 0x00ffffff) | 0x33000000;
5110 button.setColorStateList(R.id.action0, "setRippleColor",
5111 ColorStateList.valueOf(rippleColor));
5112 button.setColorStateList(R.id.action0, "setButtonBackground",
5113 ColorStateList.valueOf(background));
5114 button.setBoolean(R.id.action0, "setHasStroke", !hasColorOverride);
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005115 } else {
Selim Cinek48f66b72017-08-18 16:17:51 -07005116 button.setTextViewText(R.id.action0, processTextSpans(
5117 processLegacyText(action.title)));
Adrian Roos72171622017-01-27 10:32:06 -08005118 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005119 setTextViewColorPrimary(button, R.id.action0);
Anthony Chenad4d1582017-04-10 16:07:58 -07005120 } else if (mN.color != COLOR_DEFAULT && mTintActionButtons) {
Adrian Roos487374f2017-01-11 15:48:14 -08005121 button.setTextColor(R.id.action0,
5122 ambient ? resolveAmbientColor() : resolveContrastColor());
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005123 }
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005124 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005125 return button;
5126 }
5127
Joe Onoratocb109a02011-01-18 17:57:41 -08005128 /**
Selim Cinek981962e2016-07-20 20:41:58 -07005129 * Ensures contrast on color spans against a background color. also returns the color of the
5130 * text if a span was found that spans over the whole text.
5131 *
5132 * @param charSequence the charSequence on which the spans are
5133 * @param background the background color to ensure the contrast against
5134 * @param outResultColor an array in which a color will be returned as the first element if
5135 * there exists a full length color span.
5136 * @return the contrasted charSequence
5137 */
5138 private CharSequence ensureColorSpanContrast(CharSequence charSequence, int background,
5139 ColorStateList[] outResultColor) {
5140 if (charSequence instanceof Spanned) {
5141 Spanned ss = (Spanned) charSequence;
5142 Object[] spans = ss.getSpans(0, ss.length(), Object.class);
5143 SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
5144 for (Object span : spans) {
5145 Object resultSpan = span;
5146 int spanStart = ss.getSpanStart(span);
5147 int spanEnd = ss.getSpanEnd(span);
5148 boolean fullLength = (spanEnd - spanStart) == charSequence.length();
5149 if (resultSpan instanceof CharacterStyle) {
5150 resultSpan = ((CharacterStyle) span).getUnderlying();
5151 }
5152 if (resultSpan instanceof TextAppearanceSpan) {
5153 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
5154 ColorStateList textColor = originalSpan.getTextColor();
5155 if (textColor != null) {
5156 int[] colors = textColor.getColors();
5157 int[] newColors = new int[colors.length];
5158 for (int i = 0; i < newColors.length; i++) {
5159 newColors[i] = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005160 colors[i], background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005161 }
5162 textColor = new ColorStateList(textColor.getStates().clone(),
5163 newColors);
Selim Cinek396caca2018-04-10 17:46:46 -07005164 if (fullLength) {
5165 outResultColor[0] = textColor;
5166 // Let's drop the color from the span
5167 textColor = null;
5168 }
Selim Cinek981962e2016-07-20 20:41:58 -07005169 resultSpan = new TextAppearanceSpan(
5170 originalSpan.getFamily(),
5171 originalSpan.getTextStyle(),
5172 originalSpan.getTextSize(),
5173 textColor,
5174 originalSpan.getLinkTextColor());
Selim Cinek981962e2016-07-20 20:41:58 -07005175 }
5176 } else if (resultSpan instanceof ForegroundColorSpan) {
5177 ForegroundColorSpan originalSpan = (ForegroundColorSpan) resultSpan;
5178 int foregroundColor = originalSpan.getForegroundColor();
5179 foregroundColor = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005180 foregroundColor, background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005181 if (fullLength) {
5182 outResultColor[0] = ColorStateList.valueOf(foregroundColor);
Selim Cinek396caca2018-04-10 17:46:46 -07005183 resultSpan = null;
5184 } else {
5185 resultSpan = new ForegroundColorSpan(foregroundColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005186 }
5187 } else {
5188 resultSpan = span;
5189 }
Selim Cinek396caca2018-04-10 17:46:46 -07005190 if (resultSpan != null) {
5191 builder.setSpan(resultSpan, spanStart, spanEnd, ss.getSpanFlags(span));
5192 }
Selim Cinek981962e2016-07-20 20:41:58 -07005193 }
5194 return builder;
5195 }
5196 return charSequence;
5197 }
5198
5199 /**
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005200 * @return Whether we are currently building a notification from a legacy (an app that
Alan Viverette3cb07a462014-06-06 14:19:53 -07005201 * doesn't create material notifications by itself) app.
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005202 */
5203 private boolean isLegacy() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005204 if (!mIsLegacyInitialized) {
5205 mIsLegacy = mContext.getApplicationInfo().targetSdkVersion
5206 < Build.VERSION_CODES.LOLLIPOP;
5207 mIsLegacyInitialized = true;
5208 }
5209 return mIsLegacy;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005210 }
5211
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005212 private CharSequence processLegacyText(CharSequence charSequence) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08005213 return processLegacyText(charSequence, false /* ambient */);
5214 }
5215
5216 private CharSequence processLegacyText(CharSequence charSequence, boolean ambient) {
5217 boolean isAlreadyLightText = isLegacy() || textColorsNeedInversion();
5218 boolean wantLightText = ambient;
5219 if (isAlreadyLightText != wantLightText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005220 return getColorUtil().invertCharSequenceColors(charSequence);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005221 } else {
5222 return charSequence;
5223 }
5224 }
5225
Dan Sandler26e81cf2014-05-06 10:01:27 -04005226 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005227 * Apply any necessariy colors to the small icon
Dan Sandler26e81cf2014-05-06 10:01:27 -04005228 */
Adrian Roos487374f2017-01-11 15:48:14 -08005229 private void processSmallIconColor(Icon smallIcon, RemoteViews contentView,
5230 boolean ambient) {
Selim Cinekea4bef72015-12-02 15:51:10 -08005231 boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon);
Selim Cinekc7f5a822018-03-20 19:32:06 -07005232 int color;
5233 if (ambient) {
5234 color = resolveAmbientColor();
5235 } else if (isColorized()) {
5236 color = getPrimaryTextColor();
5237 } else {
5238 color = resolveContrastColor();
5239 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005240 if (colorable) {
Sunny Goyal5b153922017-09-21 21:00:36 -07005241 contentView.setDrawableTint(R.id.icon, false, color,
5242 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08005243
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005244 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005245 contentView.setInt(R.id.notification_header, "setOriginalIconColor",
Adrian Roos487374f2017-01-11 15:48:14 -08005246 colorable ? color : NotificationHeaderView.NO_COLOR);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005247 }
5248
Dan Sandler26e81cf2014-05-06 10:01:27 -04005249 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005250 * Make the largeIcon dark if it's a fake smallIcon (that is,
Dan Sandler26e81cf2014-05-06 10:01:27 -04005251 * if it's grayscale).
5252 */
5253 // TODO: also check bounds, transparency, that sort of thing.
Dan Sandlerd63f9322015-05-06 15:18:49 -04005254 private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) {
5255 if (largeIcon != null && isLegacy()
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005256 && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005257 // resolve color will fall back to the default when legacy
Sunny Goyal5b153922017-09-21 21:00:36 -07005258 contentView.setDrawableTint(R.id.icon, false, resolveContrastColor(),
5259 PorterDuff.Mode.SRC_ATOP);
Jorim Jaggi92df1f22014-12-16 19:44:41 +01005260 }
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005261 }
5262
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05005263 private void sanitizeColor() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005264 if (mN.color != COLOR_DEFAULT) {
5265 mN.color |= 0xFF000000; // no alpha for custom colors
Jorim Jaggi74419312014-06-10 20:57:21 +02005266 }
Jorim Jaggi74419312014-06-10 20:57:21 +02005267 }
5268
Adrian Roos4ff3b122016-02-01 12:26:13 -08005269 int resolveContrastColor() {
5270 if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) {
5271 return mCachedContrastColor;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005272 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005273
Selim Cinekac5f0272017-05-02 16:05:41 -07005274 int color;
Selim Cinekc7f5a822018-03-20 19:32:06 -07005275 int background = mContext.getColor(
5276 com.android.internal.R.color.notification_material_background_color);
Selim Cinekac5f0272017-05-02 16:05:41 -07005277 if (mN.color == COLOR_DEFAULT) {
5278 ensureColors();
Selim Cinekc7f5a822018-03-20 19:32:06 -07005279 color = NotificationColorUtil.resolveDefaultColor(mContext, background);
Selim Cinekac5f0272017-05-02 16:05:41 -07005280 } else {
5281 color = NotificationColorUtil.resolveContrastColor(mContext, mN.color,
Anthony Chenad4d1582017-04-10 16:07:58 -07005282 background, mInNightMode);
Selim Cinekac5f0272017-05-02 16:05:41 -07005283 }
5284 if (Color.alpha(color) < 255) {
5285 // alpha doesn't go well for color filters, so let's blend it manually
5286 color = NotificationColorUtil.compositeColors(color, background);
5287 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005288 mCachedContrastColorIsFor = mN.color;
Selim Cinekac5f0272017-05-02 16:05:41 -07005289 return mCachedContrastColor = color;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005290 }
5291
Adrian Roos487374f2017-01-11 15:48:14 -08005292 int resolveAmbientColor() {
5293 if (mCachedAmbientColorIsFor == mN.color && mCachedAmbientColorIsFor != COLOR_INVALID) {
5294 return mCachedAmbientColor;
5295 }
5296 final int contrasted = NotificationColorUtil.resolveAmbientColor(mContext, mN.color);
5297
5298 mCachedAmbientColorIsFor = mN.color;
5299 return mCachedAmbientColor = contrasted;
5300 }
5301
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005302 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005303 * Apply the unstyled operations and return a new {@link Notification} object.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005304 * @hide
Joe Onoratocb109a02011-01-18 17:57:41 -08005305 */
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005306 public Notification buildUnstyled() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005307 if (mActions.size() > 0) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005308 mN.actions = new Action[mActions.size()];
5309 mActions.toArray(mN.actions);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005310 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005311 if (!mPersonList.isEmpty()) {
Selim Cineke7238dd2017-12-14 17:48:32 -08005312 mN.extras.putParcelableArrayList(EXTRA_PEOPLE_LIST, mPersonList);
Dan Sandler0bf2ed82013-12-21 23:33:41 -06005313 }
Selim Cinek247fa012016-02-18 09:50:48 -08005314 if (mN.bigContentView != null || mN.contentView != null
5315 || mN.headsUpContentView != null) {
5316 mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true);
5317 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005318 return mN;
Joe Onorato46439ce2010-11-19 13:56:21 -08005319 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005320
Julia Reynolds3b848122016-02-26 10:45:32 -05005321 /**
5322 * Creates a Builder from an existing notification so further changes can be made.
5323 * @param context The context for your application / activity.
5324 * @param n The notification to create a Builder from.
5325 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005326 public static Notification.Builder recoverBuilder(Context context, Notification n) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02005327 // Re-create notification context so we can access app resources.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005328 ApplicationInfo applicationInfo = n.extras.getParcelable(
5329 EXTRA_BUILDER_APPLICATION_INFO);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005330 Context builderContext;
Julia Reynoldsda303542015-11-23 14:00:20 -05005331 if (applicationInfo != null) {
5332 try {
5333 builderContext = context.createApplicationContext(applicationInfo,
5334 Context.CONTEXT_RESTRICTED);
5335 } catch (NameNotFoundException e) {
5336 Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found");
5337 builderContext = context; // try with our context
5338 }
5339 } else {
5340 builderContext = context; // try with given context
Christoph Studer4600f9b2014-07-22 22:44:43 +02005341 }
5342
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005343 return new Builder(builderContext, n);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005344 }
5345
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005346 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005347 * @deprecated Use {@link #build()} instead.
5348 */
5349 @Deprecated
5350 public Notification getNotification() {
5351 return build();
5352 }
5353
5354 /**
5355 * Combine all of the options that have been set and return a new {@link Notification}
5356 * object.
5357 */
5358 public Notification build() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005359 // first, add any extras from the calling code
5360 if (mUserExtras != null) {
5361 mN.extras = getAllExtras();
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07005362 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005363
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005364 mN.creationTime = System.currentTimeMillis();
5365
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005366 // lazy stuff from mContext; see comment in Builder(Context, Notification)
Julia Reynoldsda303542015-11-23 14:00:20 -05005367 Notification.addFieldsFromContext(mContext, mN);
Christoph Studer943aa672014-08-03 20:31:16 +02005368
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005369 buildUnstyled();
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005370
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005371 if (mStyle != null) {
Selim Cinekd0426622017-07-11 13:19:59 +02005372 mStyle.reduceImageSizes(mContext);
5373 mStyle.purgeResources();
Selim Cinek90343862018-02-01 11:07:11 -08005374 mStyle.validate(mContext);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005375 mStyle.buildStyled(mN);
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005376 }
Selim Cinekd0426622017-07-11 13:19:59 +02005377 mN.reduceImageSizes(mContext);
5378
Adrian Roos5081c0d2016-02-26 16:04:19 -08005379 if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
Selim Cineka7679b62017-05-10 16:33:25 -07005380 && (useExistingRemoteView())) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005381 if (mN.contentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005382 mN.contentView = createContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005383 mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT,
5384 mN.contentView.getSequenceNumber());
5385 }
5386 if (mN.bigContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005387 mN.bigContentView = createBigContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005388 if (mN.bigContentView != null) {
5389 mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT,
5390 mN.bigContentView.getSequenceNumber());
5391 }
5392 }
5393 if (mN.headsUpContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005394 mN.headsUpContentView = createHeadsUpContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005395 if (mN.headsUpContentView != null) {
5396 mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT,
5397 mN.headsUpContentView.getSequenceNumber());
5398 }
5399 }
5400 }
5401
Julia Reynolds4c0c2022016-02-02 15:11:59 -05005402 if ((mN.defaults & DEFAULT_LIGHTS) != 0) {
5403 mN.flags |= FLAG_SHOW_LIGHTS;
5404 }
5405
Adrian Roosfb921842017-10-26 14:49:56 +02005406 mN.allPendingIntents = null;
5407
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005408 return mN;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005409 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005410
5411 /**
5412 * Apply this Builder to an existing {@link Notification} object.
5413 *
5414 * @hide
5415 */
5416 public Notification buildInto(Notification n) {
Daniel Sandler1a497d32013-04-18 14:52:45 -04005417 build().cloneInto(n, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005418 return n;
5419 }
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005420
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005421 /**
Adrian Roos184bfe022016-03-03 13:41:44 -08005422 * Removes RemoteViews that were created for compatibility from {@param n}, if they did not
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005423 * change. Also removes extenders on low ram devices, as
5424 * {@link android.service.notification.NotificationListenerService} services are disabled.
Adrian Roos184bfe022016-03-03 13:41:44 -08005425 *
5426 * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}.
5427 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005428 * @hide
5429 */
Kristian Monsen05f34792018-04-09 10:27:16 +02005430 public static Notification maybeCloneStrippedForDelivery(Notification n, boolean isLowRam,
5431 Context context) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005432 String templateClass = n.extras.getString(EXTRA_TEMPLATE);
Adrian Roos184bfe022016-03-03 13:41:44 -08005433
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005434 // Only strip views for known Styles because we won't know how to
5435 // re-create them otherwise.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005436 if (!isLowRam
5437 && !TextUtils.isEmpty(templateClass)
Adrian Roos184bfe022016-03-03 13:41:44 -08005438 && getNotificationStyleClass(templateClass) == null) {
5439 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005440 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005441
5442 // Only strip unmodified BuilderRemoteViews.
5443 boolean stripContentView = n.contentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005444 n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005445 n.contentView.getSequenceNumber();
5446 boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005447 n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005448 n.bigContentView.getSequenceNumber();
5449 boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005450 n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005451 n.headsUpContentView.getSequenceNumber();
5452
5453 // Nothing to do here, no need to clone.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005454 if (!isLowRam
5455 && !stripContentView && !stripBigContentView && !stripHeadsUpContentView) {
Adrian Roos184bfe022016-03-03 13:41:44 -08005456 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005457 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005458
5459 Notification clone = n.clone();
5460 if (stripContentView) {
5461 clone.contentView = null;
5462 clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT);
5463 }
5464 if (stripBigContentView) {
5465 clone.bigContentView = null;
5466 clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT);
5467 }
5468 if (stripHeadsUpContentView) {
5469 clone.headsUpContentView = null;
5470 clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT);
5471 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005472 if (isLowRam) {
Kristian Monsen05f34792018-04-09 10:27:16 +02005473 String[] allowedServices = context.getResources().getStringArray(
5474 R.array.config_allowedManagedServicesOnLowRamDevices);
5475 if (allowedServices.length == 0) {
5476 clone.extras.remove(Notification.TvExtender.EXTRA_TV_EXTENDER);
5477 clone.extras.remove(WearableExtender.EXTRA_WEARABLE_EXTENSIONS);
5478 clone.extras.remove(CarExtender.EXTRA_CAR_EXTENDER);
5479 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005480 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005481 return clone;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005482 }
5483
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005484 private int getBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005485 return R.layout.notification_template_material_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005486 }
5487
5488 private int getBigBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005489 return R.layout.notification_template_material_big_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005490 }
5491
5492 private int getBigPictureLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005493 return R.layout.notification_template_material_big_picture;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005494 }
5495
5496 private int getBigTextLayoutResource() {
Jorim Jaggi445d3c02014-08-19 22:33:42 +02005497 return R.layout.notification_template_material_big_text;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005498 }
5499
5500 private int getInboxLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005501 return R.layout.notification_template_material_inbox;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005502 }
5503
Adrian Roosc1a80b02016-04-05 14:54:55 -07005504 private int getMessagingLayoutResource() {
5505 return R.layout.notification_template_material_messaging;
5506 }
5507
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005508 private int getActionLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005509 return R.layout.notification_material_action;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005510 }
5511
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005512 private int getEmphasizedActionLayoutResource() {
5513 return R.layout.notification_material_action_emphasized;
5514 }
5515
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005516 private int getActionTombstoneLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005517 return R.layout.notification_material_action_tombstone;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005518 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005519
5520 private int getBackgroundColor() {
5521 if (isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005522 return mBackgroundColor != COLOR_INVALID ? mBackgroundColor : mN.color;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005523 } else {
Selim Cinekc7f5a822018-03-20 19:32:06 -07005524 return COLOR_DEFAULT;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005525 }
5526 }
5527
Selim Cinek396caca2018-04-10 17:46:46 -07005528 /**
5529 * Same as getBackgroundColor but also resolved the default color to the background.
5530 */
5531 private int resolveBackgroundColor() {
5532 int backgroundColor = getBackgroundColor();
5533 if (backgroundColor == COLOR_DEFAULT) {
5534 backgroundColor = mContext.getColor(
5535 com.android.internal.R.color.notification_material_background_color);
5536 }
5537 return backgroundColor;
5538 }
5539
Selim Cinek7b9605b2017-01-19 17:36:00 -08005540 private boolean isColorized() {
5541 return mN.isColorized();
5542 }
Selim Cinek99104832017-01-25 14:47:33 -08005543
Anthony Chenad4d1582017-04-10 16:07:58 -07005544 private boolean shouldTintActionButtons() {
5545 return mTintActionButtons;
5546 }
5547
Selim Cinek99104832017-01-25 14:47:33 -08005548 private boolean textColorsNeedInversion() {
5549 if (mStyle == null || !MediaStyle.class.equals(mStyle.getClass())) {
5550 return false;
5551 }
5552 int targetSdkVersion = mContext.getApplicationInfo().targetSdkVersion;
5553 return targetSdkVersion > Build.VERSION_CODES.M
5554 && targetSdkVersion < Build.VERSION_CODES.O;
5555 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005556
5557 /**
5558 * Set a color palette to be used as the background and textColors
5559 *
5560 * @param backgroundColor the color to be used as the background
5561 * @param foregroundColor the color to be used as the foreground
5562 *
5563 * @hide
5564 */
5565 public void setColorPalette(int backgroundColor, int foregroundColor) {
5566 mBackgroundColor = backgroundColor;
5567 mForegroundColor = foregroundColor;
5568 mTextColorsAreForBackground = COLOR_INVALID;
5569 ensureColors();
5570 }
Selim Cinekac5f0272017-05-02 16:05:41 -07005571
5572 /**
Selim Cineka7679b62017-05-10 16:33:25 -07005573 * Forces all styled remoteViews to be built from scratch and not use any cached
5574 * RemoteViews.
5575 * This is needed for legacy apps that are baking in their remoteviews into the
5576 * notification.
5577 *
5578 * @hide
5579 */
5580 public void setRebuildStyledRemoteViews(boolean rebuild) {
5581 mRebuildStyledRemoteViews = rebuild;
5582 }
Selim Cinekaa9db1f2018-02-27 17:35:47 -08005583
5584 /**
5585 * Get the text that should be displayed in the statusBar when heads upped. This is
5586 * usually just the app name, but may be different depending on the style.
5587 *
5588 * @param publicMode If true, return a text that is safe to display in public.
5589 *
5590 * @hide
5591 */
5592 public CharSequence getHeadsUpStatusBarText(boolean publicMode) {
5593 if (mStyle != null && !publicMode) {
5594 CharSequence text = mStyle.getHeadsUpStatusBarText();
5595 if (!TextUtils.isEmpty(text)) {
5596 return text;
5597 }
5598 }
5599 return loadHeaderAppName();
5600 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005601 }
5602
5603 /**
Selim Cinekd0426622017-07-11 13:19:59 +02005604 * Reduces the image sizes to conform to a maximum allowed size. This also processes all custom
5605 * remote views.
5606 *
5607 * @hide
5608 */
5609 void reduceImageSizes(Context context) {
5610 if (extras.getBoolean(EXTRA_REDUCED_IMAGES)) {
5611 return;
5612 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005613 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02005614 if (mLargeIcon != null || largeIcon != null) {
5615 Resources resources = context.getResources();
5616 Class<? extends Style> style = getNotificationStyle();
Selim Cineka8cb1262017-08-15 16:53:44 -07005617 int maxWidth = resources.getDimensionPixelSize(isLowRam
5618 ? R.dimen.notification_right_icon_size_low_ram
5619 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02005620 int maxHeight = maxWidth;
5621 if (MediaStyle.class.equals(style)
5622 || DecoratedMediaCustomViewStyle.class.equals(style)) {
Selim Cineka8cb1262017-08-15 16:53:44 -07005623 maxHeight = resources.getDimensionPixelSize(isLowRam
5624 ? R.dimen.notification_media_image_max_height_low_ram
5625 : R.dimen.notification_media_image_max_height);
5626 maxWidth = resources.getDimensionPixelSize(isLowRam
5627 ? R.dimen.notification_media_image_max_width_low_ram
5628 : R.dimen.notification_media_image_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02005629 }
5630 if (mLargeIcon != null) {
5631 mLargeIcon.scaleDownIfNecessary(maxWidth, maxHeight);
5632 }
5633 if (largeIcon != null) {
5634 largeIcon = Icon.scaleDownIfNecessary(largeIcon, maxWidth, maxHeight);
5635 }
5636 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005637 reduceImageSizesForRemoteView(contentView, context, isLowRam);
5638 reduceImageSizesForRemoteView(headsUpContentView, context, isLowRam);
5639 reduceImageSizesForRemoteView(bigContentView, context, isLowRam);
Selim Cinekd0426622017-07-11 13:19:59 +02005640 extras.putBoolean(EXTRA_REDUCED_IMAGES, true);
5641 }
5642
Selim Cineka8cb1262017-08-15 16:53:44 -07005643 private void reduceImageSizesForRemoteView(RemoteViews remoteView, Context context,
5644 boolean isLowRam) {
Selim Cinekd0426622017-07-11 13:19:59 +02005645 if (remoteView != null) {
5646 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07005647 int maxWidth = resources.getDimensionPixelSize(isLowRam
5648 ? R.dimen.notification_custom_view_max_image_width_low_ram
5649 : R.dimen.notification_custom_view_max_image_width);
5650 int maxHeight = resources.getDimensionPixelSize(isLowRam
5651 ? R.dimen.notification_custom_view_max_image_height_low_ram
5652 : R.dimen.notification_custom_view_max_image_height);
Selim Cinekd0426622017-07-11 13:19:59 +02005653 remoteView.reduceImageSizes(maxWidth, maxHeight);
5654 }
5655 }
5656
5657 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005658 * @return whether this notification is a foreground service notification
Selim Cinek7b9605b2017-01-19 17:36:00 -08005659 */
Selim Cinek22714f12017-04-13 16:23:53 -07005660 private boolean isForegroundService() {
5661 return (flags & Notification.FLAG_FOREGROUND_SERVICE) != 0;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005662 }
5663
5664 /**
Selim Cinek99104832017-01-25 14:47:33 -08005665 * @return whether this notification has a media session attached
5666 * @hide
5667 */
5668 public boolean hasMediaSession() {
5669 return extras.getParcelable(Notification.EXTRA_MEDIA_SESSION) != null;
5670 }
5671
5672 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08005673 * @return the style class of this notification
5674 * @hide
5675 */
5676 public Class<? extends Notification.Style> getNotificationStyle() {
5677 String templateClass = extras.getString(Notification.EXTRA_TEMPLATE);
5678
5679 if (!TextUtils.isEmpty(templateClass)) {
5680 return Notification.getNotificationStyleClass(templateClass);
5681 }
5682 return null;
5683 }
5684
5685 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005686 * @return true if this notification is colorized.
Selim Cinek7b9605b2017-01-19 17:36:00 -08005687 *
5688 * @hide
5689 */
5690 public boolean isColorized() {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005691 if (isColorizedMedia()) {
5692 return true;
5693 }
Julia Reynolds4db59552017-06-30 13:34:01 -04005694 return extras.getBoolean(EXTRA_COLORIZED)
5695 && (hasColorizedPermission() || isForegroundService());
5696 }
5697
5698 /**
5699 * Returns whether an app can colorize due to the android.permission.USE_COLORIZED_NOTIFICATIONS
5700 * permission. The permission is checked when a notification is enqueued.
5701 */
5702 private boolean hasColorizedPermission() {
5703 return (flags & Notification.FLAG_CAN_COLORIZE) != 0;
Selim Cinek5fb73f82017-04-20 16:55:38 -07005704 }
5705
5706 /**
5707 * @return true if this notification is colorized and it is a media notification
5708 *
5709 * @hide
5710 */
5711 public boolean isColorizedMedia() {
Selim Cinek99104832017-01-25 14:47:33 -08005712 Class<? extends Style> style = getNotificationStyle();
5713 if (MediaStyle.class.equals(style)) {
5714 Boolean colorized = (Boolean) extras.get(EXTRA_COLORIZED);
5715 if ((colorized == null || colorized) && hasMediaSession()) {
5716 return true;
5717 }
5718 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5719 if (extras.getBoolean(EXTRA_COLORIZED) && hasMediaSession()) {
5720 return true;
5721 }
5722 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005723 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005724 }
5725
Selim Cinek0847acd2017-04-24 19:48:29 -07005726
5727 /**
5728 * @return true if this is a media notification
5729 *
5730 * @hide
5731 */
5732 public boolean isMediaNotification() {
5733 Class<? extends Style> style = getNotificationStyle();
5734 if (MediaStyle.class.equals(style)) {
5735 return true;
5736 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5737 return true;
5738 }
5739 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005740 }
5741
Selim Cinek279fa862016-06-14 10:57:25 -07005742 private boolean hasLargeIcon() {
5743 return mLargeIcon != null || largeIcon != null;
5744 }
5745
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005746 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005747 * @return true if the notification will show the time; false otherwise
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005748 * @hide
5749 */
Selim Cinekc2c0b042016-05-18 17:13:46 -07005750 public boolean showsTime() {
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005751 return when != 0 && extras.getBoolean(EXTRA_SHOW_WHEN);
5752 }
5753
5754 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005755 * @return true if the notification will show a chronometer; false otherwise
5756 * @hide
5757 */
5758 public boolean showsChronometer() {
5759 return when != 0 && extras.getBoolean(EXTRA_SHOW_CHRONOMETER);
5760 }
5761
5762 /**
Julia Reynolds7ca33072017-06-29 13:58:24 -04005763 * @removed
Julia Reynolds4a02afb2016-12-13 13:39:52 -05005764 */
5765 @SystemApi
5766 public static Class<? extends Style> getNotificationStyleClass(String templateClass) {
5767 Class<? extends Style>[] classes = new Class[] {
5768 BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class,
5769 DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class,
5770 MessagingStyle.class };
5771 for (Class<? extends Style> innerClass : classes) {
5772 if (templateClass.equals(innerClass.getName())) {
5773 return innerClass;
5774 }
5775 }
5776 return null;
5777 }
5778
5779 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005780 * An object that can apply a rich notification style to a {@link Notification.Builder}
5781 * object.
5782 */
Griff Hazendfcb0802014-02-11 12:00:00 -08005783 public static abstract class Style {
Chris Wrend6297db2012-05-03 16:20:13 -04005784 private CharSequence mBigContentTitle;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02005785
5786 /**
5787 * @hide
5788 */
5789 protected CharSequence mSummaryText = null;
5790
5791 /**
5792 * @hide
5793 */
5794 protected boolean mSummaryTextSet = false;
Chris Wrend6297db2012-05-03 16:20:13 -04005795
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005796 protected Builder mBuilder;
5797
Chris Wrend6297db2012-05-03 16:20:13 -04005798 /**
5799 * Overrides ContentTitle in the big form of the template.
5800 * This defaults to the value passed to setContentTitle().
5801 */
5802 protected void internalSetBigContentTitle(CharSequence title) {
5803 mBigContentTitle = title;
5804 }
5805
5806 /**
5807 * Set the first line of text after the detail section in the big form of the template.
5808 */
5809 protected void internalSetSummaryText(CharSequence cs) {
5810 mSummaryText = cs;
Daniel Sandler619738c2012-06-07 16:33:08 -04005811 mSummaryTextSet = true;
Chris Wrend6297db2012-05-03 16:20:13 -04005812 }
5813
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005814 public void setBuilder(Builder builder) {
5815 if (mBuilder != builder) {
5816 mBuilder = builder;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07005817 if (mBuilder != null) {
5818 mBuilder.setStyle(this);
5819 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005820 }
5821 }
5822
Chris Wrend6297db2012-05-03 16:20:13 -04005823 protected void checkBuilder() {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005824 if (mBuilder == null) {
5825 throw new IllegalArgumentException("Style requires a valid Builder object");
5826 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005827 }
Chris Wrend6297db2012-05-03 16:20:13 -04005828
5829 protected RemoteViews getStandardView(int layoutId) {
5830 checkBuilder();
5831
Christoph Studer4600f9b2014-07-22 22:44:43 +02005832 // Nasty.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005833 CharSequence oldBuilderContentTitle =
5834 mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE);
Chris Wrend6297db2012-05-03 16:20:13 -04005835 if (mBigContentTitle != null) {
5836 mBuilder.setContentTitle(mBigContentTitle);
5837 }
5838
Chris Wrend6297db2012-05-03 16:20:13 -04005839 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId);
5840
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005841 mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005842
Chris Wrend6297db2012-05-03 16:20:13 -04005843 if (mBigContentTitle != null && mBigContentTitle.equals("")) {
5844 contentView.setViewVisibility(R.id.line1, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04005845 } else {
5846 contentView.setViewVisibility(R.id.line1, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04005847 }
5848
Chris Wrend6297db2012-05-03 16:20:13 -04005849 return contentView;
5850 }
5851
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005852 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08005853 * Construct a Style-specific RemoteViews for the collapsed notification layout.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005854 * The default implementation has nothing additional to add.
Selim Cinek7d1009b2017-01-25 15:28:28 -08005855 *
5856 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005857 * @hide
5858 */
Selim Cinek7d1009b2017-01-25 15:28:28 -08005859 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005860 return null;
5861 }
5862
5863 /**
5864 * Construct a Style-specific RemoteViews for the final big notification layout.
5865 * @hide
5866 */
5867 public RemoteViews makeBigContentView() {
5868 return null;
5869 }
5870
5871 /**
5872 * Construct a Style-specific RemoteViews for the final HUN layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08005873 *
5874 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005875 * @hide
5876 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08005877 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005878 return null;
5879 }
5880
5881 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005882 * Apply any style-specific extras to this notification before shipping it out.
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005883 * @hide
5884 */
5885 public void addExtras(Bundle extras) {
5886 if (mSummaryTextSet) {
5887 extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
5888 }
5889 if (mBigContentTitle != null) {
5890 extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
5891 }
Chris Wren91ad5632013-06-05 15:05:57 -04005892 extras.putString(EXTRA_TEMPLATE, this.getClass().getName());
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005893 }
5894
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005895 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005896 * Reconstruct the internal state of this Style object from extras.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005897 * @hide
5898 */
Christoph Studer4600f9b2014-07-22 22:44:43 +02005899 protected void restoreFromExtras(Bundle extras) {
5900 if (extras.containsKey(EXTRA_SUMMARY_TEXT)) {
5901 mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT);
5902 mSummaryTextSet = true;
5903 }
5904 if (extras.containsKey(EXTRA_TITLE_BIG)) {
5905 mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG);
5906 }
5907 }
5908
5909
5910 /**
5911 * @hide
5912 */
5913 public Notification buildStyled(Notification wip) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005914 addExtras(wip.extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005915 return wip;
5916 }
5917
Daniel Sandler0ec46202015-06-24 01:27:05 -04005918 /**
5919 * @hide
5920 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07005921 public void purgeResources() {}
5922
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005923 /**
5924 * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is
5925 * attached to.
5926 *
5927 * @return the fully constructed Notification.
5928 */
5929 public Notification build() {
5930 checkBuilder();
5931 return mBuilder.build();
5932 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005933
5934 /**
5935 * @hide
5936 * @return true if the style positions the progress bar on the second line; false if the
5937 * style hides the progress bar
5938 */
5939 protected boolean hasProgress() {
5940 return true;
5941 }
Selim Cinek03d0d652015-11-13 13:18:09 -05005942
5943 /**
5944 * @hide
5945 * @return Whether we should put the summary be put into the notification header
5946 */
5947 public boolean hasSummaryInHeader() {
5948 return true;
5949 }
Selim Cinek593610c2016-02-16 18:42:57 -08005950
5951 /**
5952 * @hide
5953 * @return Whether custom content views are displayed inline in the style
5954 */
5955 public boolean displayCustomViewInline() {
5956 return false;
5957 }
Selim Cinekd0426622017-07-11 13:19:59 +02005958
5959 /**
5960 * Reduces the image sizes contained in this style.
5961 *
5962 * @hide
5963 */
5964 public void reduceImageSizes(Context context) {
5965 }
Selim Cinek90343862018-02-01 11:07:11 -08005966
5967 /**
5968 * Validate that this style was properly composed. This is called at build time.
5969 * @hide
5970 */
5971 public void validate(Context context) {
5972 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05005973
5974 /**
5975 * @hide
5976 */
5977 public abstract boolean areNotificationsVisiblyDifferent(Style other);
Selim Cinekc7f5a822018-03-20 19:32:06 -07005978
Selim Cinekaa9db1f2018-02-27 17:35:47 -08005979 /**
5980 * @return the the text that should be displayed in the statusBar when heads-upped.
5981 * If {@code null} is returned, the default implementation will be used.
5982 *
5983 * @hide
5984 */
5985 public CharSequence getHeadsUpStatusBarText() {
5986 return null;
5987 }
Joe Onorato46439ce2010-11-19 13:56:21 -08005988 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04005989
5990 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04005991 * Helper class for generating large-format notifications that include a large image attachment.
Joe Malin8d40d042012-11-05 11:36:40 -08005992 *
Robert Ly91c5ce32014-06-08 15:37:00 -07005993 * Here's how you'd set the <code>BigPictureStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04005994 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07005995 * Notification notif = new Notification.Builder(mContext)
5996 * .setContentTitle(&quot;New photo from &quot; + sender.toString())
5997 * .setContentText(subject)
5998 * .setSmallIcon(R.drawable.new_post)
5999 * .setLargeIcon(aBitmap)
6000 * .setStyle(new Notification.BigPictureStyle()
6001 * .bigPicture(aBigBitmap))
6002 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006003 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006004 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006005 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006006 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006007 public static class BigPictureStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006008 private Bitmap mPicture;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006009 private Icon mBigLargeIcon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006010 private boolean mBigLargeIconSet = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006011
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006012 public BigPictureStyle() {
6013 }
6014
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006015 /**
6016 * @deprecated use {@code BigPictureStyle()}.
6017 */
6018 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006019 public BigPictureStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006020 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006021 }
6022
Chris Wrend6297db2012-05-03 16:20:13 -04006023 /**
6024 * Overrides ContentTitle in the big form of the template.
6025 * This defaults to the value passed to setContentTitle().
6026 */
6027 public BigPictureStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006028 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006029 return this;
6030 }
6031
6032 /**
6033 * Set the first line of text after the detail section in the big form of the template.
6034 */
6035 public BigPictureStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006036 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006037 return this;
6038 }
6039
Chris Wren0bd664d2012-08-01 13:56:56 -04006040 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05006041 * @hide
6042 */
6043 public Bitmap getBigPicture() {
6044 return mPicture;
6045 }
6046
6047 /**
Chris Wren0bd664d2012-08-01 13:56:56 -04006048 * Provide the bitmap to be used as the payload for the BigPicture notification.
6049 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006050 public BigPictureStyle bigPicture(Bitmap b) {
6051 mPicture = b;
6052 return this;
6053 }
6054
Chris Wren3745a3d2012-05-22 15:11:52 -04006055 /**
Chris Wren3745a3d2012-05-22 15:11:52 -04006056 * Override the large icon when the big notification is shown.
6057 */
6058 public BigPictureStyle bigLargeIcon(Bitmap b) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04006059 return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
6060 }
6061
6062 /**
6063 * Override the large icon when the big notification is shown.
6064 */
6065 public BigPictureStyle bigLargeIcon(Icon icon) {
Chris Wren3745a3d2012-05-22 15:11:52 -04006066 mBigLargeIconSet = true;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006067 mBigLargeIcon = icon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006068 return this;
6069 }
6070
Riley Andrews0394a0c2015-11-03 23:36:52 -08006071 /** @hide */
6072 public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10);
6073
Daniel Sandler0ec46202015-06-24 01:27:05 -04006074 /**
6075 * @hide
6076 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006077 @Override
6078 public void purgeResources() {
6079 super.purgeResources();
Riley Andrews8cee7c12015-11-01 23:36:04 -08006080 if (mPicture != null &&
6081 mPicture.isMutable() &&
Riley Andrews0394a0c2015-11-03 23:36:52 -08006082 mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) {
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006083 mPicture = mPicture.createAshmemBitmap();
6084 }
6085 if (mBigLargeIcon != null) {
6086 mBigLargeIcon.convertToAshmem();
6087 }
6088 }
Christoph Studer5c510ee2014-12-15 16:32:27 +01006089
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006090 /**
6091 * @hide
6092 */
Selim Cinekd0426622017-07-11 13:19:59 +02006093 @Override
6094 public void reduceImageSizes(Context context) {
6095 super.reduceImageSizes(context);
6096 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07006097 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02006098 if (mPicture != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006099 int maxPictureWidth = resources.getDimensionPixelSize(isLowRam
6100 ? R.dimen.notification_big_picture_max_height_low_ram
6101 : R.dimen.notification_big_picture_max_height);
6102 int maxPictureHeight = resources.getDimensionPixelSize(isLowRam
6103 ? R.dimen.notification_big_picture_max_width_low_ram
6104 : R.dimen.notification_big_picture_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02006105 mPicture = Icon.scaleDownIfNecessary(mPicture, maxPictureWidth, maxPictureHeight);
6106 }
6107 if (mBigLargeIcon != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006108 int rightIconSize = resources.getDimensionPixelSize(isLowRam
6109 ? R.dimen.notification_right_icon_size_low_ram
6110 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02006111 mBigLargeIcon.scaleDownIfNecessary(rightIconSize, rightIconSize);
6112 }
6113 }
6114
6115 /**
6116 * @hide
6117 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006118 public RemoteViews makeBigContentView() {
6119 // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet
Christoph Studer5c510ee2014-12-15 16:32:27 +01006120 // This covers the following cases:
6121 // 1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006122 // mN.mLargeIcon
6123 // 2. !mBigLargeIconSet -> mN.mLargeIcon applies
Dan Sandlerd63f9322015-05-06 15:18:49 -04006124 Icon oldLargeIcon = null;
Selim Cineke99acb22016-08-04 12:55:48 -07006125 Bitmap largeIconLegacy = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006126 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006127 oldLargeIcon = mBuilder.mN.mLargeIcon;
6128 mBuilder.mN.mLargeIcon = mBigLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006129 // The legacy largeIcon might not allow us to clear the image, as it's taken in
6130 // replacement if the other one is null. Because we're restoring these legacy icons
6131 // for old listeners, this is in general non-null.
6132 largeIconLegacy = mBuilder.mN.largeIcon;
6133 mBuilder.mN.largeIcon = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006134 }
6135
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01006136 RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource());
Selim Cinek03d0d652015-11-13 13:18:09 -05006137 if (mSummaryTextSet) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006138 contentView.setTextViewText(R.id.text, mBuilder.processTextSpans(
6139 mBuilder.processLegacyText(mSummaryText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006140 mBuilder.setTextViewColorSecondary(contentView, R.id.text);
Selim Cinekc848c3a2016-01-13 15:27:30 -08006141 contentView.setViewVisibility(R.id.text, View.VISIBLE);
Selim Cinek03d0d652015-11-13 13:18:09 -05006142 }
Selim Cinek279fa862016-06-14 10:57:25 -07006143 mBuilder.setContentMinHeight(contentView, mBuilder.mN.hasLargeIcon());
Selim Cinek53e64a42015-11-16 10:40:56 -08006144
Christoph Studer5c510ee2014-12-15 16:32:27 +01006145 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006146 mBuilder.mN.mLargeIcon = oldLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006147 mBuilder.mN.largeIcon = largeIconLegacy;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006148 }
6149
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006150 contentView.setImageViewBitmap(R.id.big_picture, mPicture);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006151 return contentView;
6152 }
6153
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006154 /**
6155 * @hide
6156 */
6157 public void addExtras(Bundle extras) {
6158 super.addExtras(extras);
6159
6160 if (mBigLargeIconSet) {
6161 extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
6162 }
6163 extras.putParcelable(EXTRA_PICTURE, mPicture);
6164 }
6165
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006166 /**
6167 * @hide
6168 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006169 @Override
Christoph Studer4600f9b2014-07-22 22:44:43 +02006170 protected void restoreFromExtras(Bundle extras) {
6171 super.restoreFromExtras(extras);
6172
6173 if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) {
Christoph Studer5c510ee2014-12-15 16:32:27 +01006174 mBigLargeIconSet = true;
Christoph Studer4600f9b2014-07-22 22:44:43 +02006175 mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG);
Chris Wren3745a3d2012-05-22 15:11:52 -04006176 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02006177 mPicture = extras.getParcelable(EXTRA_PICTURE);
6178 }
Selim Cinek03d0d652015-11-13 13:18:09 -05006179
6180 /**
6181 * @hide
6182 */
6183 @Override
6184 public boolean hasSummaryInHeader() {
6185 return false;
6186 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05006187
6188 /**
6189 * @hide
6190 */
6191 @Override
6192 public boolean areNotificationsVisiblyDifferent(Style other) {
6193 if (other == null || getClass() != other.getClass()) {
6194 return true;
6195 }
6196 BigPictureStyle otherS = (BigPictureStyle) other;
6197 return !Objects.equals(getBigPicture(), otherS.getBigPicture());
6198 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006199 }
6200
6201 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006202 * Helper class for generating large-format notifications that include a lot of text.
Joe Malin8d40d042012-11-05 11:36:40 -08006203 *
Robert Ly91c5ce32014-06-08 15:37:00 -07006204 * Here's how you'd set the <code>BigTextStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006205 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07006206 * Notification notif = new Notification.Builder(mContext)
6207 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
6208 * .setContentText(subject)
6209 * .setSmallIcon(R.drawable.new_mail)
6210 * .setLargeIcon(aBitmap)
6211 * .setStyle(new Notification.BigTextStyle()
6212 * .bigText(aVeryLongString))
6213 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006214 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006215 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006216 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006217 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006218 public static class BigTextStyle extends Style {
Jorim Jaggi457a10d2014-09-08 16:18:23 +02006219
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006220 private CharSequence mBigText;
6221
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006222 public BigTextStyle() {
6223 }
6224
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006225 /**
6226 * @deprecated use {@code BigTextStyle()}.
6227 */
6228 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006229 public BigTextStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006230 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006231 }
6232
Chris Wrend6297db2012-05-03 16:20:13 -04006233 /**
6234 * Overrides ContentTitle in the big form of the template.
6235 * This defaults to the value passed to setContentTitle().
6236 */
6237 public BigTextStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006238 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006239 return this;
6240 }
6241
6242 /**
6243 * Set the first line of text after the detail section in the big form of the template.
6244 */
6245 public BigTextStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006246 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006247 return this;
6248 }
6249
Chris Wren0bd664d2012-08-01 13:56:56 -04006250 /**
6251 * Provide the longer text to be displayed in the big form of the
6252 * template in place of the content text.
6253 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006254 public BigTextStyle bigText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006255 mBigText = safeCharSequence(cs);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006256 return this;
6257 }
6258
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006259 /**
6260 * @hide
6261 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05006262 public CharSequence getBigText() {
6263 return mBigText;
6264 }
6265
6266 /**
6267 * @hide
6268 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006269 public void addExtras(Bundle extras) {
6270 super.addExtras(extras);
6271
Christoph Studer4600f9b2014-07-22 22:44:43 +02006272 extras.putCharSequence(EXTRA_BIG_TEXT, mBigText);
6273 }
6274
6275 /**
6276 * @hide
6277 */
6278 @Override
6279 protected void restoreFromExtras(Bundle extras) {
6280 super.restoreFromExtras(extras);
6281
6282 mBigText = extras.getCharSequence(EXTRA_BIG_TEXT);
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006283 }
6284
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006285 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08006286 * @param increasedHeight true if this layout be created with an increased height.
6287 *
6288 * @hide
6289 */
6290 @Override
6291 public RemoteViews makeContentView(boolean increasedHeight) {
6292 if (increasedHeight) {
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006293 mBuilder.mOriginalActions = mBuilder.mActions;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006294 mBuilder.mActions = new ArrayList<>();
6295 RemoteViews remoteViews = makeBigContentView();
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006296 mBuilder.mActions = mBuilder.mOriginalActions;
6297 mBuilder.mOriginalActions = null;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006298 return remoteViews;
6299 }
6300 return super.makeContentView(increasedHeight);
6301 }
6302
6303 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006304 * @hide
6305 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08006306 @Override
6307 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
6308 if (increasedHeight && mBuilder.mActions.size() > 0) {
6309 return makeBigContentView();
6310 }
6311 return super.makeHeadsUpContentView(increasedHeight);
6312 }
6313
6314 /**
6315 * @hide
6316 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006317 public RemoteViews makeBigContentView() {
Christoph Studer4600f9b2014-07-22 22:44:43 +02006318
6319 // Nasty
Selim Cinek75998782016-04-26 10:39:17 -07006320 CharSequence text = mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006321 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Daniel Sandler916ad912012-06-13 12:17:07 -04006322
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01006323 RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource());
Joe Malin8d40d042012-11-05 11:36:40 -08006324
Selim Cinek75998782016-04-26 10:39:17 -07006325 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, text);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006326
Selim Cinek3a2c4b92015-12-17 17:01:17 -08006327 CharSequence bigTextText = mBuilder.processLegacyText(mBigText);
Selim Cinek75998782016-04-26 10:39:17 -07006328 if (TextUtils.isEmpty(bigTextText)) {
6329 // In case the bigtext is null / empty fall back to the normal text to avoid a weird
6330 // experience
6331 bigTextText = mBuilder.processLegacyText(text);
6332 }
Adrian Roosb1f427c2016-05-26 12:27:15 -07006333 applyBigTextContentView(mBuilder, contentView, bigTextText);
Selim Cinek4fb12d32015-11-19 18:10:48 -08006334
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006335 return contentView;
6336 }
6337
Julia Reynolds7217dc92018-03-07 12:12:09 -05006338 /**
6339 * @hide
6340 */
6341 @Override
6342 public boolean areNotificationsVisiblyDifferent(Style other) {
6343 if (other == null || getClass() != other.getClass()) {
6344 return true;
6345 }
6346 BigTextStyle newS = (BigTextStyle) other;
6347 return !Objects.equals(getBigText(), newS.getBigText());
6348 }
6349
Adrian Roosb1f427c2016-05-26 12:27:15 -07006350 static void applyBigTextContentView(Builder builder,
6351 RemoteViews contentView, CharSequence bigTextText) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006352 contentView.setTextViewText(R.id.big_text, builder.processTextSpans(bigTextText));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006353 builder.setTextViewColorSecondary(contentView, R.id.big_text);
Adrian Roosb1f427c2016-05-26 12:27:15 -07006354 contentView.setViewVisibility(R.id.big_text,
6355 TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE);
Selim Cinek279fa862016-06-14 10:57:25 -07006356 contentView.setBoolean(R.id.big_text, "setHasImage", builder.mN.hasLargeIcon());
Adrian Roosb1f427c2016-05-26 12:27:15 -07006357 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006358 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04006359
6360 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006361 * Helper class for generating large-format notifications that include multiple back-and-forth
6362 * messages of varying types between any number of people.
6363 *
6364 * <br>
6365 * If the platform does not provide large-format notifications, this method has no effect. The
6366 * user will always see the normal notification view.
6367 * <br>
6368 * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like
6369 * so:
6370 * <pre class="prettyprint">
6371 *
6372 * Notification noti = new Notification.Builder()
6373 * .setContentTitle(&quot;2 new messages wtih &quot; + sender.toString())
6374 * .setContentText(subject)
6375 * .setSmallIcon(R.drawable.new_message)
6376 * .setLargeIcon(aBitmap)
6377 * .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name))
6378 * .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender())
6379 * .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender()))
6380 * .build();
6381 * </pre>
6382 */
6383 public static class MessagingStyle extends Style {
6384
6385 /**
6386 * The maximum number of messages that will be retained in the Notification itself (the
6387 * number displayed is up to the platform).
6388 */
6389 public static final int MAXIMUM_RETAINED_MESSAGES = 25;
6390
Selim Cinekcb8b9852017-12-15 18:01:52 -08006391 @NonNull Person mUser;
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006392 @Nullable CharSequence mConversationTitle;
Alex Hillsd9b04d92016-04-11 16:38:16 -04006393 List<Message> mMessages = new ArrayList<>();
Adrian Roos437cd562017-01-18 15:47:03 -08006394 List<Message> mHistoricMessages = new ArrayList<>();
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006395 boolean mIsGroupConversation;
Alex Hillsfc737de2016-03-23 17:33:02 -04006396
6397 MessagingStyle() {
6398 }
6399
6400 /**
Alex Hillsfd590442016-10-07 09:52:44 -04006401 * @param userDisplayName Required - the name to be displayed for any replies sent by the
6402 * user before the posting app reposts the notification with those messages after they've
6403 * been actually sent and in previous messages sent by the user added in
Alex Hillsfc737de2016-03-23 17:33:02 -04006404 * {@link #addMessage(Notification.MessagingStyle.Message)}
Selim Cinekcb8b9852017-12-15 18:01:52 -08006405 *
6406 * @deprecated use {@code MessagingStyle(Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006407 */
Alex Hillsfd590442016-10-07 09:52:44 -04006408 public MessagingStyle(@NonNull CharSequence userDisplayName) {
Selim Cinek9acd6732018-03-23 16:39:02 -07006409 this(new Person.Builder().setName(userDisplayName).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006410 }
6411
6412 /**
6413 * @param user Required - The person displayed for any messages that are sent by the
6414 * user. Any messages added with {@link #addMessage(Notification.MessagingStyle.Message)}
6415 * who don't have a Person associated with it will be displayed as if they were sent
Selim Cinek90343862018-02-01 11:07:11 -08006416 * by this user. The user also needs to have a valid name associated with it, which will
6417 * be enforced starting in Android P.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006418 */
6419 public MessagingStyle(@NonNull Person user) {
6420 mUser = user;
Selim Cinek90343862018-02-01 11:07:11 -08006421 }
6422
6423 /**
6424 * Validate that this style was properly composed. This is called at build time.
6425 * @hide
6426 */
6427 @Override
6428 public void validate(Context context) {
6429 super.validate(context);
6430 if (context.getApplicationInfo().targetSdkVersion
6431 >= Build.VERSION_CODES.P && (mUser == null || mUser.getName() == null)) {
6432 throw new RuntimeException("User must be valid and have a name.");
Selim Cinekcb8b9852017-12-15 18:01:52 -08006433 }
6434 }
6435
6436 /**
Selim Cinekaa9db1f2018-02-27 17:35:47 -08006437 * @return the the text that should be displayed in the statusBar when heads upped.
6438 * If {@code null} is returned, the default implementation will be used.
6439 *
6440 * @hide
6441 */
6442 @Override
6443 public CharSequence getHeadsUpStatusBarText() {
6444 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
6445 ? super.mBigContentTitle
6446 : mConversationTitle;
6447 if (!TextUtils.isEmpty(conversationTitle) && !hasOnlyWhiteSpaceSenders()) {
6448 return conversationTitle;
6449 }
6450 return null;
6451 }
6452
6453 /**
Selim Cinekcb8b9852017-12-15 18:01:52 -08006454 * @return the user to be displayed for any replies sent by the user
6455 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006456 @NonNull
Selim Cinekcb8b9852017-12-15 18:01:52 -08006457 public Person getUser() {
6458 return mUser;
Alex Hillsfc737de2016-03-23 17:33:02 -04006459 }
6460
6461 /**
6462 * Returns the name to be displayed for any replies sent by the user
Selim Cinekcb8b9852017-12-15 18:01:52 -08006463 *
6464 * @deprecated use {@link #getUser()} instead
Alex Hillsfc737de2016-03-23 17:33:02 -04006465 */
6466 public CharSequence getUserDisplayName() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006467 return mUser.getName();
Alex Hillsfc737de2016-03-23 17:33:02 -04006468 }
6469
6470 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006471 * Sets the title to be displayed on this conversation. May be set to {@code null}.
6472 *
Kodlee Yin14656422017-12-22 17:00:46 -08006473 * <p>This API's behavior was changed in SDK version {@link Build.VERSION_CODES#P}. If your
6474 * application's target version is less than {@link Build.VERSION_CODES#P}, setting a
6475 * conversation title to a non-null value will make {@link #isGroupConversation()} return
6476 * {@code true} and passing {@code null} will make it return {@code false}. In
6477 * {@link Build.VERSION_CODES#P} and beyond, use {@link #setGroupConversation(boolean)}
6478 * to set group conversation status.
6479 *
6480 * @param conversationTitle Title displayed for this conversation
6481 * @return this object for method chaining
Alex Hillsfc737de2016-03-23 17:33:02 -04006482 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006483 public MessagingStyle setConversationTitle(@Nullable CharSequence conversationTitle) {
Alex Hillsfc737de2016-03-23 17:33:02 -04006484 mConversationTitle = conversationTitle;
6485 return this;
6486 }
6487
6488 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006489 * Return the title to be displayed on this conversation. May return {@code null}.
Alex Hillsfc737de2016-03-23 17:33:02 -04006490 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006491 @Nullable
Alex Hillsfc737de2016-03-23 17:33:02 -04006492 public CharSequence getConversationTitle() {
6493 return mConversationTitle;
6494 }
6495
6496 /**
6497 * Adds a message for display by this notification. Convenience call for a simple
6498 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6499 * @param text A {@link CharSequence} to be displayed as the message content
6500 * @param timestamp Time at which the message arrived
6501 * @param sender A {@link CharSequence} to be used for displaying the name of the
6502 * sender. Should be <code>null</code> for messages by the current user, in which case
6503 * the platform will insert {@link #getUserDisplayName()}.
6504 * Should be unique amongst all individuals in the conversation, and should be
6505 * consistent during re-posts of the notification.
6506 *
6507 * @see Message#Message(CharSequence, long, CharSequence)
6508 *
6509 * @return this object for method chaining
Selim Cinekcb8b9852017-12-15 18:01:52 -08006510 *
6511 * @deprecated use {@link #addMessage(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006512 */
6513 public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006514 return addMessage(text, timestamp,
Selim Cinek9acd6732018-03-23 16:39:02 -07006515 sender == null ? null : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006516 }
6517
6518 /**
6519 * Adds a message for display by this notification. Convenience call for a simple
6520 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6521 * @param text A {@link CharSequence} to be displayed as the message content
6522 * @param timestamp Time at which the message arrived
6523 * @param sender The {@link Person} who sent the message.
6524 * Should be <code>null</code> for messages by the current user, in which case
6525 * the platform will insert the user set in {@code MessagingStyle(Person)}.
6526 *
6527 * @see Message#Message(CharSequence, long, CharSequence)
6528 *
6529 * @return this object for method chaining
6530 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006531 public MessagingStyle addMessage(@NonNull CharSequence text, long timestamp,
6532 @Nullable Person sender) {
Adrian Roos437cd562017-01-18 15:47:03 -08006533 return addMessage(new Message(text, timestamp, sender));
Alex Hillsfc737de2016-03-23 17:33:02 -04006534 }
6535
6536 /**
6537 * Adds a {@link Message} for display in this notification.
Adrian Roos437cd562017-01-18 15:47:03 -08006538 *
6539 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6540 * the newest last.
6541 *
Alex Hillsfc737de2016-03-23 17:33:02 -04006542 * @param message The {@link Message} to be displayed
6543 * @return this object for method chaining
6544 */
6545 public MessagingStyle addMessage(Message message) {
6546 mMessages.add(message);
6547 if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6548 mMessages.remove(0);
6549 }
6550 return this;
6551 }
6552
6553 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006554 * Adds a {@link Message} for historic context in this notification.
6555 *
6556 * <p>Messages should be added as historic if they are not the main subject of the
6557 * notification but may give context to a conversation. The system may choose to present
6558 * them only when relevant, e.g. when replying to a message through a {@link RemoteInput}.
6559 *
6560 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6561 * the newest last.
6562 *
6563 * @param message The historic {@link Message} to be added
6564 * @return this object for method chaining
6565 */
6566 public MessagingStyle addHistoricMessage(Message message) {
6567 mHistoricMessages.add(message);
6568 if (mHistoricMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6569 mHistoricMessages.remove(0);
6570 }
6571 return this;
6572 }
6573
6574 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006575 * Gets the list of {@code Message} objects that represent the notification
6576 */
6577 public List<Message> getMessages() {
6578 return mMessages;
6579 }
6580
6581 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006582 * Gets the list of historic {@code Message}s in the notification.
6583 */
6584 public List<Message> getHistoricMessages() {
6585 return mHistoricMessages;
6586 }
6587
6588 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006589 * Sets whether this conversation notification represents a group.
Kodlee Yin14656422017-12-22 17:00:46 -08006590 *
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006591 * @param isGroupConversation {@code true} if the conversation represents a group,
6592 * {@code false} otherwise.
6593 * @return this object for method chaining
6594 */
6595 public MessagingStyle setGroupConversation(boolean isGroupConversation) {
6596 mIsGroupConversation = isGroupConversation;
6597 return this;
6598 }
6599
6600 /**
Kodlee Yin14656422017-12-22 17:00:46 -08006601 * Returns {@code true} if this notification represents a group conversation, otherwise
6602 * {@code false}.
6603 *
6604 * <p> If the application that generated this {@link MessagingStyle} targets an SDK version
6605 * less than {@link Build.VERSION_CODES#P}, this method becomes dependent on whether or
6606 * not the conversation title is set; returning {@code true} if the conversation title is
6607 * a non-null value, or {@code false} otherwise. From {@link Build.VERSION_CODES#P} forward,
6608 * this method returns what's set by {@link #setGroupConversation(boolean)} allowing for
6609 * named, non-group conversations.
6610 *
6611 * @see #setConversationTitle(CharSequence)
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006612 */
6613 public boolean isGroupConversation() {
Kodlee Yin14656422017-12-22 17:00:46 -08006614 // When target SDK version is < P, a non-null conversation title dictates if this is
6615 // as group conversation.
6616 if (mBuilder != null
6617 && mBuilder.mContext.getApplicationInfo().targetSdkVersion
6618 < Build.VERSION_CODES.P) {
6619 return mConversationTitle != null;
6620 }
6621
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006622 return mIsGroupConversation;
6623 }
6624
6625 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006626 * @hide
6627 */
6628 @Override
6629 public void addExtras(Bundle extras) {
6630 super.addExtras(extras);
Selim Cinekcb8b9852017-12-15 18:01:52 -08006631 if (mUser != null) {
6632 // For legacy usages
6633 extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUser.getName());
6634 extras.putParcelable(EXTRA_MESSAGING_PERSON, mUser);
Alex Hillsfc737de2016-03-23 17:33:02 -04006635 }
6636 if (mConversationTitle != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04006637 extras.putCharSequence(EXTRA_CONVERSATION_TITLE, mConversationTitle);
Alex Hillsfc737de2016-03-23 17:33:02 -04006638 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04006639 if (!mMessages.isEmpty()) { extras.putParcelableArray(EXTRA_MESSAGES,
6640 Message.getBundleArrayForMessages(mMessages));
Alex Hillsfc737de2016-03-23 17:33:02 -04006641 }
Adrian Roos437cd562017-01-18 15:47:03 -08006642 if (!mHistoricMessages.isEmpty()) { extras.putParcelableArray(EXTRA_HISTORIC_MESSAGES,
6643 Message.getBundleArrayForMessages(mHistoricMessages));
6644 }
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006645
6646 fixTitleAndTextExtras(extras);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006647 extras.putBoolean(EXTRA_IS_GROUP_CONVERSATION, mIsGroupConversation);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006648 }
6649
6650 private void fixTitleAndTextExtras(Bundle extras) {
6651 Message m = findLatestIncomingMessage();
6652 CharSequence text = (m == null) ? null : m.mText;
6653 CharSequence sender = m == null ? null
Selim Cinekcb8b9852017-12-15 18:01:52 -08006654 : m.mSender == null || TextUtils.isEmpty(m.mSender.getName())
6655 ? mUser.getName() : m.mSender.getName();
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006656 CharSequence title;
6657 if (!TextUtils.isEmpty(mConversationTitle)) {
6658 if (!TextUtils.isEmpty(sender)) {
6659 BidiFormatter bidi = BidiFormatter.getInstance();
6660 title = mBuilder.mContext.getString(
6661 com.android.internal.R.string.notification_messaging_title_template,
Selim Cinekcb8b9852017-12-15 18:01:52 -08006662 bidi.unicodeWrap(mConversationTitle), bidi.unicodeWrap(sender));
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006663 } else {
6664 title = mConversationTitle;
6665 }
6666 } else {
6667 title = sender;
6668 }
6669
6670 if (title != null) {
6671 extras.putCharSequence(EXTRA_TITLE, title);
6672 }
6673 if (text != null) {
6674 extras.putCharSequence(EXTRA_TEXT, text);
6675 }
Alex Hillsfc737de2016-03-23 17:33:02 -04006676 }
6677
6678 /**
6679 * @hide
6680 */
6681 @Override
6682 protected void restoreFromExtras(Bundle extras) {
6683 super.restoreFromExtras(extras);
6684
Selim Cinekcb8b9852017-12-15 18:01:52 -08006685 mUser = extras.getParcelable(EXTRA_MESSAGING_PERSON);
6686 if (mUser == null) {
6687 CharSequence displayName = extras.getCharSequence(EXTRA_SELF_DISPLAY_NAME);
Selim Cinek9acd6732018-03-23 16:39:02 -07006688 mUser = new Person.Builder().setName(displayName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08006689 }
Adrian Roos96b7e202016-05-17 13:50:38 -07006690 mConversationTitle = extras.getCharSequence(EXTRA_CONVERSATION_TITLE);
Adrian Roos437cd562017-01-18 15:47:03 -08006691 Parcelable[] messages = extras.getParcelableArray(EXTRA_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006692 mMessages = Message.getMessagesFromBundleArray(messages);
Adrian Roos437cd562017-01-18 15:47:03 -08006693 Parcelable[] histMessages = extras.getParcelableArray(EXTRA_HISTORIC_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006694 mHistoricMessages = Message.getMessagesFromBundleArray(histMessages);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006695 mIsGroupConversation = extras.getBoolean(EXTRA_IS_GROUP_CONVERSATION);
Alex Hillsfc737de2016-03-23 17:33:02 -04006696 }
6697
6698 /**
6699 * @hide
6700 */
Adrian Roosc1a80b02016-04-05 14:54:55 -07006701 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08006702 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cineke62255c2017-09-28 18:23:23 -07006703 mBuilder.mOriginalActions = mBuilder.mActions;
6704 mBuilder.mActions = new ArrayList<>();
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006705 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
6706 true /* showReplyIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07006707 mBuilder.mActions = mBuilder.mOriginalActions;
6708 mBuilder.mOriginalActions = null;
6709 return remoteViews;
Adrian Roosc1a80b02016-04-05 14:54:55 -07006710 }
6711
Julia Reynolds7217dc92018-03-07 12:12:09 -05006712 /**
6713 * @hide
6714 */
6715 @Override
6716 public boolean areNotificationsVisiblyDifferent(Style other) {
6717 if (other == null || getClass() != other.getClass()) {
6718 return true;
6719 }
6720 MessagingStyle newS = (MessagingStyle) other;
6721 List<MessagingStyle.Message> oldMs = getMessages();
6722 List<MessagingStyle.Message> newMs = newS.getMessages();
6723
6724 if (oldMs == null) {
6725 oldMs = new ArrayList<>();
6726 }
6727 if (newMs == null) {
6728 newMs = new ArrayList<>();
6729 }
6730
6731 int n = oldMs.size();
6732 if (n != newMs.size()) {
6733 return true;
6734 }
6735 for (int i = 0; i < n; i++) {
6736 MessagingStyle.Message oldM = oldMs.get(i);
6737 MessagingStyle.Message newM = newMs.get(i);
6738 if (!Objects.equals(oldM.getText(), newM.getText())) {
6739 return true;
6740 }
6741 if (!Objects.equals(oldM.getDataUri(), newM.getDataUri())) {
6742 return true;
6743 }
6744 CharSequence oldSender = oldM.getSenderPerson() == null ? oldM.getSender()
6745 : oldM.getSenderPerson().getName();
6746 CharSequence newSender = newM.getSenderPerson() == null ? newM.getSender()
6747 : newM.getSenderPerson().getName();
6748 if (!Objects.equals(oldSender, newSender)) {
6749 return true;
6750 }
6751
6752 String oldKey = oldM.getSenderPerson() == null
6753 ? null : oldM.getSenderPerson().getKey();
6754 String newKey = newM.getSenderPerson() == null
6755 ? null : newM.getSenderPerson().getKey();
6756 if (!Objects.equals(oldKey, newKey)) {
6757 return true;
6758 }
6759 // Other fields (like timestamp) intentionally excluded
6760 }
6761 return false;
6762 }
6763
Adrian Roosc1a80b02016-04-05 14:54:55 -07006764 private Message findLatestIncomingMessage() {
Selim Cinek88188f22017-09-19 16:46:56 -07006765 return findLatestIncomingMessage(mMessages);
6766 }
6767
6768 /**
6769 * @hide
6770 */
6771 @Nullable
6772 public static Message findLatestIncomingMessage(
6773 List<Message> messages) {
6774 for (int i = messages.size() - 1; i >= 0; i--) {
6775 Message m = messages.get(i);
Adrian Roosc1a80b02016-04-05 14:54:55 -07006776 // Incoming messages have a non-empty sender.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006777 if (m.mSender != null && !TextUtils.isEmpty(m.mSender.getName())) {
Adrian Roosc1a80b02016-04-05 14:54:55 -07006778 return m;
6779 }
6780 }
Selim Cinek88188f22017-09-19 16:46:56 -07006781 if (!messages.isEmpty()) {
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006782 // No incoming messages, fall back to outgoing message
Selim Cinek88188f22017-09-19 16:46:56 -07006783 return messages.get(messages.size() - 1);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006784 }
Adrian Roosc1a80b02016-04-05 14:54:55 -07006785 return null;
6786 }
6787
6788 /**
6789 * @hide
6790 */
6791 @Override
6792 public RemoteViews makeBigContentView() {
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006793 return makeMessagingView(false /* displayImagesAtEnd */, false /* showReplyIcon */);
Selim Cinekafeed292017-12-12 17:32:44 -08006794 }
6795
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006796 /**
6797 * Create a messaging layout.
6798 *
6799 * @param displayImagesAtEnd should images be displayed at the end of the content instead
6800 * of inline.
6801 * @param showReplyIcon Should the reply affordance be shown at the end of the notification
6802 * @return the created remoteView.
6803 */
Selim Cinekafeed292017-12-12 17:32:44 -08006804 @NonNull
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006805 private RemoteViews makeMessagingView(boolean displayImagesAtEnd, boolean showReplyIcon) {
Selim Cinek88188f22017-09-19 16:46:56 -07006806 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
Adrian Roosc1a80b02016-04-05 14:54:55 -07006807 ? super.mBigContentTitle
6808 : mConversationTitle;
Selim Cinek88188f22017-09-19 16:46:56 -07006809 boolean isOneToOne = TextUtils.isEmpty(conversationTitle);
Selim Cinek2dd3e722018-01-19 11:06:06 -08006810 CharSequence nameReplacement = null;
Selim Cinekafeed292017-12-12 17:32:44 -08006811 if (hasOnlyWhiteSpaceSenders()) {
Selim Cinekf7409db2017-10-24 16:17:14 -07006812 isOneToOne = true;
Selim Cinek2dd3e722018-01-19 11:06:06 -08006813 nameReplacement = conversationTitle;
6814 conversationTitle = null;
Adrian Roosb1f427c2016-05-26 12:27:15 -07006815 }
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006816 boolean hideLargeIcon = !showReplyIcon || isOneToOne;
Adrian Roos48d746a2016-04-12 14:57:28 -07006817 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
Adrian Roosc1a80b02016-04-05 14:54:55 -07006818 mBuilder.getMessagingLayoutResource(),
Selim Cinek88188f22017-09-19 16:46:56 -07006819 mBuilder.mParams.reset().hasProgress(false).title(conversationTitle).text(null)
Selim Cinek7199ed92018-01-26 13:36:43 -08006820 .hideLargeIcon(hideLargeIcon)
Selim Cinekafeed292017-12-12 17:32:44 -08006821 .headerTextSecondary(conversationTitle)
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006822 .alwaysShowReply(showReplyIcon));
Selim Cinek88188f22017-09-19 16:46:56 -07006823 addExtras(mBuilder.mN.extras);
Selim Cinekafeed292017-12-12 17:32:44 -08006824 // also update the end margin if there is an image
6825 int endMargin = R.dimen.notification_content_margin_end;
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006826 if (showReplyIcon) {
Selim Cinekafeed292017-12-12 17:32:44 -08006827 endMargin = R.dimen.notification_content_plus_picture_margin_end;
6828 }
6829 contentView.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
Selim Cinek88188f22017-09-19 16:46:56 -07006830 contentView.setInt(R.id.status_bar_latest_event_content, "setLayoutColor",
6831 mBuilder.resolveContrastColor());
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006832 contentView.setBoolean(R.id.status_bar_latest_event_content, "setDisplayImagesAtEnd",
6833 displayImagesAtEnd);
Selim Cinek88188f22017-09-19 16:46:56 -07006834 contentView.setIcon(R.id.status_bar_latest_event_content, "setLargeIcon",
6835 mBuilder.mN.mLargeIcon);
Selim Cinek2dd3e722018-01-19 11:06:06 -08006836 contentView.setCharSequence(R.id.status_bar_latest_event_content, "setNameReplacement",
6837 nameReplacement);
Selim Cinek88188f22017-09-19 16:46:56 -07006838 contentView.setBoolean(R.id.status_bar_latest_event_content, "setIsOneToOne",
6839 isOneToOne);
6840 contentView.setBundle(R.id.status_bar_latest_event_content, "setData",
6841 mBuilder.mN.extras);
Alex Hillsfc737de2016-03-23 17:33:02 -04006842 return contentView;
6843 }
6844
Selim Cinekf7409db2017-10-24 16:17:14 -07006845 private boolean hasOnlyWhiteSpaceSenders() {
6846 for (int i = 0; i < mMessages.size(); i++) {
6847 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08006848 Person sender = m.getSenderPerson();
6849 if (sender != null && !isWhiteSpace(sender.getName())) {
Selim Cinekf7409db2017-10-24 16:17:14 -07006850 return false;
6851 }
6852 }
6853 return true;
6854 }
6855
6856 private boolean isWhiteSpace(CharSequence sender) {
6857 if (TextUtils.isEmpty(sender)) {
6858 return true;
6859 }
6860 if (sender.toString().matches("^\\s*$")) {
6861 return true;
6862 }
6863 // Let's check if we only have 0 whitespace chars. Some apps did this as a workaround
6864 // For the presentation that we had.
6865 for (int i = 0; i < sender.length(); i++) {
6866 char c = sender.charAt(i);
6867 if (c != '\u200B') {
6868 return false;
6869 }
6870 }
6871 return true;
6872 }
6873
Selim Cinek88188f22017-09-19 16:46:56 -07006874 private CharSequence createConversationTitleFromMessages() {
6875 ArraySet<CharSequence> names = new ArraySet<>();
6876 for (int i = 0; i < mMessages.size(); i++) {
6877 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08006878 Person sender = m.getSenderPerson();
Selim Cinek88188f22017-09-19 16:46:56 -07006879 if (sender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006880 names.add(sender.getName());
Selim Cinek88188f22017-09-19 16:46:56 -07006881 }
6882 }
6883 SpannableStringBuilder title = new SpannableStringBuilder();
6884 int size = names.size();
6885 for (int i = 0; i < size; i++) {
6886 CharSequence name = names.valueAt(i);
6887 if (!TextUtils.isEmpty(title)) {
6888 title.append(", ");
6889 }
6890 title.append(BidiFormatter.getInstance().unicodeWrap(name));
6891 }
6892 return title;
6893 }
6894
Adrian Roosdedd1df2016-04-26 16:38:47 -07006895 /**
6896 * @hide
6897 */
6898 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08006899 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006900 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
6901 false /* showReplyIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07006902 remoteViews.setInt(R.id.notification_messaging, "setMaxDisplayedLines", 1);
6903 return remoteViews;
Adrian Roosdedd1df2016-04-26 16:38:47 -07006904 }
6905
Adrian Roosc1a80b02016-04-05 14:54:55 -07006906 private static TextAppearanceSpan makeFontColorSpan(int color) {
6907 return new TextAppearanceSpan(null, 0, 0,
6908 ColorStateList.valueOf(color), null);
6909 }
6910
Alex Hillsd9b04d92016-04-11 16:38:16 -04006911 public static final class Message {
6912
6913 static final String KEY_TEXT = "text";
6914 static final String KEY_TIMESTAMP = "time";
6915 static final String KEY_SENDER = "sender";
Selim Cinekcb8b9852017-12-15 18:01:52 -08006916 static final String KEY_SENDER_PERSON = "sender_person";
Alex Hillsd9b04d92016-04-11 16:38:16 -04006917 static final String KEY_DATA_MIME_TYPE = "type";
6918 static final String KEY_DATA_URI= "uri";
Shane Brennan5a871862017-03-11 13:14:17 -08006919 static final String KEY_EXTRAS_BUNDLE = "extras";
Alex Hillsfc737de2016-03-23 17:33:02 -04006920
6921 private final CharSequence mText;
6922 private final long mTimestamp;
Selim Cinekcb8b9852017-12-15 18:01:52 -08006923 @Nullable
6924 private final Person mSender;
Alex Hillsfc737de2016-03-23 17:33:02 -04006925
Shane Brennan5a871862017-03-11 13:14:17 -08006926 private Bundle mExtras = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04006927 private String mDataMimeType;
6928 private Uri mDataUri;
6929
6930 /**
6931 * Constructor
6932 * @param text A {@link CharSequence} to be displayed as the message content
6933 * @param timestamp Time at which the message arrived
6934 * @param sender A {@link CharSequence} to be used for displaying the name of the
6935 * sender. Should be <code>null</code> for messages by the current user, in which case
6936 * the platform will insert {@link MessagingStyle#getUserDisplayName()}.
6937 * Should be unique amongst all individuals in the conversation, and should be
6938 * consistent during re-posts of the notification.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006939 *
6940 * @deprecated use {@code Message(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006941 */
6942 public Message(CharSequence text, long timestamp, CharSequence sender){
Selim Cinek9acd6732018-03-23 16:39:02 -07006943 this(text, timestamp, sender == null ? null
6944 : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006945 }
6946
6947 /**
6948 * Constructor
6949 * @param text A {@link CharSequence} to be displayed as the message content
6950 * @param timestamp Time at which the message arrived
6951 * @param sender The {@link Person} who sent the message.
6952 * Should be <code>null</code> for messages by the current user, in which case
6953 * the platform will insert the user set in {@code MessagingStyle(Person)}.
6954 * <p>
Selim Cinek9acd6732018-03-23 16:39:02 -07006955 * The person provided should contain an Icon, set with
6956 * {@link Person.Builder#setIcon(Icon)} and also have a name provided
6957 * with {@link Person.Builder#setName(CharSequence)}. If multiple users have the same
6958 * name, consider providing a key with {@link Person.Builder#setKey(String)} in order
6959 * to differentiate between the different users.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006960 * </p>
6961 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006962 public Message(@NonNull CharSequence text, long timestamp, @Nullable Person sender) {
Alex Hillsfc737de2016-03-23 17:33:02 -04006963 mText = text;
6964 mTimestamp = timestamp;
6965 mSender = sender;
6966 }
6967
6968 /**
6969 * Sets a binary blob of data and an associated MIME type for a message. In the case
6970 * where the platform doesn't support the MIME type, the original text provided in the
6971 * constructor will be used.
6972 * @param dataMimeType The MIME type of the content. See
6973 * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME
6974 * types on Android and Android Wear.
6975 * @param dataUri The uri containing the content whose type is given by the MIME type.
6976 * <p class="note">
6977 * <ol>
6978 * <li>Notification Listeners including the System UI need permission to access the
6979 * data the Uri points to. The recommended ways to do this are:</li>
6980 * <li>Store the data in your own ContentProvider, making sure that other apps have
6981 * the correct permission to access your provider. The preferred mechanism for
6982 * providing access is to use per-URI permissions which are temporary and only
6983 * grant access to the receiving application. An easy way to create a
6984 * ContentProvider like this is to use the FileProvider helper class.</li>
6985 * <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio
6986 * and image MIME types, however beginning with Android 3.0 (API level 11) it can
6987 * also store non-media types (see MediaStore.Files for more info). Files can be
6988 * inserted into the MediaStore using scanFile() after which a content:// style
6989 * Uri suitable for sharing is passed to the provided onScanCompleted() callback.
6990 * Note that once added to the system MediaStore the content is accessible to any
6991 * app on the device.</li>
6992 * </ol>
6993 * @return this object for method chaining
6994 */
6995 public Message setData(String dataMimeType, Uri dataUri) {
6996 mDataMimeType = dataMimeType;
6997 mDataUri = dataUri;
6998 return this;
6999 }
7000
Alex Hillsfc737de2016-03-23 17:33:02 -04007001 /**
7002 * Get the text to be used for this message, or the fallback text if a type and content
7003 * Uri have been set
7004 */
7005 public CharSequence getText() {
7006 return mText;
7007 }
7008
7009 /**
7010 * Get the time at which this message arrived
7011 */
7012 public long getTimestamp() {
7013 return mTimestamp;
7014 }
7015
7016 /**
Shane Brennan5a871862017-03-11 13:14:17 -08007017 * Get the extras Bundle for this message.
7018 */
7019 public Bundle getExtras() {
7020 return mExtras;
7021 }
7022
7023 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04007024 * Get the text used to display the contact's name in the messaging experience
Selim Cinekcb8b9852017-12-15 18:01:52 -08007025 *
7026 * @deprecated use {@link #getSenderPerson()}
Alex Hillsfc737de2016-03-23 17:33:02 -04007027 */
7028 public CharSequence getSender() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007029 return mSender == null ? null : mSender.getName();
7030 }
7031
7032 /**
7033 * Get the sender associated with this message.
7034 */
7035 @Nullable
7036 public Person getSenderPerson() {
Alex Hillsfc737de2016-03-23 17:33:02 -04007037 return mSender;
7038 }
7039
7040 /**
7041 * Get the MIME type of the data pointed to by the Uri
7042 */
7043 public String getDataMimeType() {
7044 return mDataMimeType;
7045 }
7046
7047 /**
7048 * Get the the Uri pointing to the content of the message. Can be null, in which case
7049 * {@see #getText()} is used.
7050 */
7051 public Uri getDataUri() {
7052 return mDataUri;
7053 }
7054
Alex Hillsd9b04d92016-04-11 16:38:16 -04007055 private Bundle toBundle() {
7056 Bundle bundle = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04007057 if (mText != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007058 bundle.putCharSequence(KEY_TEXT, mText);
Alex Hillsfc737de2016-03-23 17:33:02 -04007059 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007060 bundle.putLong(KEY_TIMESTAMP, mTimestamp);
Alex Hillsfc737de2016-03-23 17:33:02 -04007061 if (mSender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007062 // Legacy listeners need this
7063 bundle.putCharSequence(KEY_SENDER, mSender.getName());
7064 bundle.putParcelable(KEY_SENDER_PERSON, mSender);
Alex Hillsfc737de2016-03-23 17:33:02 -04007065 }
7066 if (mDataMimeType != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007067 bundle.putString(KEY_DATA_MIME_TYPE, mDataMimeType);
Alex Hillsfc737de2016-03-23 17:33:02 -04007068 }
7069 if (mDataUri != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007070 bundle.putParcelable(KEY_DATA_URI, mDataUri);
Alex Hillsfc737de2016-03-23 17:33:02 -04007071 }
Shane Brennan5a871862017-03-11 13:14:17 -08007072 if (mExtras != null) {
7073 bundle.putBundle(KEY_EXTRAS_BUNDLE, mExtras);
7074 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007075 return bundle;
Alex Hillsfc737de2016-03-23 17:33:02 -04007076 }
7077
Alex Hillsd9b04d92016-04-11 16:38:16 -04007078 static Bundle[] getBundleArrayForMessages(List<Message> messages) {
7079 Bundle[] bundles = new Bundle[messages.size()];
7080 final int N = messages.size();
7081 for (int i = 0; i < N; i++) {
7082 bundles[i] = messages.get(i).toBundle();
7083 }
7084 return bundles;
7085 }
7086
Selim Cinek88188f22017-09-19 16:46:56 -07007087 /**
7088 * @return A list of messages read from the bundles.
7089 *
7090 * @hide
7091 */
7092 public static List<Message> getMessagesFromBundleArray(Parcelable[] bundles) {
7093 if (bundles == null) {
7094 return new ArrayList<>();
7095 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007096 List<Message> messages = new ArrayList<>(bundles.length);
7097 for (int i = 0; i < bundles.length; i++) {
Adrian Roosdedd1df2016-04-26 16:38:47 -07007098 if (bundles[i] instanceof Bundle) {
7099 Message message = getMessageFromBundle((Bundle)bundles[i]);
7100 if (message != null) {
7101 messages.add(message);
7102 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007103 }
7104 }
7105 return messages;
7106 }
7107
7108 static Message getMessageFromBundle(Bundle bundle) {
7109 try {
Adrian Roosfbddd2c2016-05-13 12:57:20 -07007110 if (!bundle.containsKey(KEY_TEXT) || !bundle.containsKey(KEY_TIMESTAMP)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007111 return null;
7112 } else {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007113
7114 Person senderPerson = bundle.getParcelable(KEY_SENDER_PERSON);
7115 if (senderPerson == null) {
7116 // Legacy apps that use compat don't actually provide the sender objects
7117 // We need to fix the compat version to provide people / use
7118 // the native api instead
7119 CharSequence senderName = bundle.getCharSequence(KEY_SENDER);
7120 if (senderName != null) {
Selim Cinek9acd6732018-03-23 16:39:02 -07007121 senderPerson = new Person.Builder().setName(senderName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08007122 }
7123 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007124 Message message = new Message(bundle.getCharSequence(KEY_TEXT),
Selim Cinekcb8b9852017-12-15 18:01:52 -08007125 bundle.getLong(KEY_TIMESTAMP),
7126 senderPerson);
Alex Hillsd9b04d92016-04-11 16:38:16 -04007127 if (bundle.containsKey(KEY_DATA_MIME_TYPE) &&
7128 bundle.containsKey(KEY_DATA_URI)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007129 message.setData(bundle.getString(KEY_DATA_MIME_TYPE),
7130 (Uri) bundle.getParcelable(KEY_DATA_URI));
Alex Hillsfc737de2016-03-23 17:33:02 -04007131 }
Shane Brennan5a871862017-03-11 13:14:17 -08007132 if (bundle.containsKey(KEY_EXTRAS_BUNDLE)) {
7133 message.getExtras().putAll(bundle.getBundle(KEY_EXTRAS_BUNDLE));
7134 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007135 return message;
7136 }
7137 } catch (ClassCastException e) {
7138 return null;
7139 }
7140 }
Alex Hillsfc737de2016-03-23 17:33:02 -04007141 }
7142 }
7143
7144 /**
Daniel Sandler879c5e02012-04-17 16:46:51 -04007145 * Helper class for generating large-format notifications that include a list of (up to 5) strings.
Joe Malin8d40d042012-11-05 11:36:40 -08007146 *
Robert Ly91c5ce32014-06-08 15:37:00 -07007147 * Here's how you'd set the <code>InboxStyle</code> on a notification:
Daniel Sandler879c5e02012-04-17 16:46:51 -04007148 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07007149 * Notification notif = new Notification.Builder(mContext)
7150 * .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
7151 * .setContentText(subject)
7152 * .setSmallIcon(R.drawable.new_mail)
7153 * .setLargeIcon(aBitmap)
7154 * .setStyle(new Notification.InboxStyle()
7155 * .addLine(str1)
7156 * .addLine(str2)
7157 * .setContentTitle(&quot;&quot;)
7158 * .setSummaryText(&quot;+3 more&quot;))
7159 * .build();
Daniel Sandler879c5e02012-04-17 16:46:51 -04007160 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08007161 *
Daniel Sandler879c5e02012-04-17 16:46:51 -04007162 * @see Notification#bigContentView
7163 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007164 public static class InboxStyle extends Style {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007165 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
7166
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007167 public InboxStyle() {
7168 }
7169
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007170 /**
7171 * @deprecated use {@code InboxStyle()}.
7172 */
7173 @Deprecated
Daniel Sandler879c5e02012-04-17 16:46:51 -04007174 public InboxStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007175 setBuilder(builder);
Daniel Sandler879c5e02012-04-17 16:46:51 -04007176 }
7177
Chris Wrend6297db2012-05-03 16:20:13 -04007178 /**
7179 * Overrides ContentTitle in the big form of the template.
7180 * This defaults to the value passed to setContentTitle().
7181 */
7182 public InboxStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007183 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04007184 return this;
7185 }
7186
7187 /**
7188 * Set the first line of text after the detail section in the big form of the template.
7189 */
7190 public InboxStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007191 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04007192 return this;
7193 }
7194
Chris Wren0bd664d2012-08-01 13:56:56 -04007195 /**
7196 * Append a line to the digest section of the Inbox notification.
7197 */
Daniel Sandler879c5e02012-04-17 16:46:51 -04007198 public InboxStyle addLine(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007199 mTexts.add(safeCharSequence(cs));
Daniel Sandler879c5e02012-04-17 16:46:51 -04007200 return this;
7201 }
7202
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007203 /**
7204 * @hide
7205 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05007206 public ArrayList<CharSequence> getLines() {
7207 return mTexts;
7208 }
7209
7210 /**
7211 * @hide
7212 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007213 public void addExtras(Bundle extras) {
7214 super.addExtras(extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007215
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007216 CharSequence[] a = new CharSequence[mTexts.size()];
7217 extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
7218 }
7219
Christoph Studer4600f9b2014-07-22 22:44:43 +02007220 /**
7221 * @hide
7222 */
7223 @Override
7224 protected void restoreFromExtras(Bundle extras) {
7225 super.restoreFromExtras(extras);
7226
7227 mTexts.clear();
7228 if (extras.containsKey(EXTRA_TEXT_LINES)) {
7229 Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES));
7230 }
7231 }
7232
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007233 /**
7234 * @hide
7235 */
7236 public RemoteViews makeBigContentView() {
Selim Cinekc848c3a2016-01-13 15:27:30 -08007237 // Remove the content text so it disappears unless you have a summary
Christoph Studer4600f9b2014-07-22 22:44:43 +02007238 // Nasty
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007239 CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT);
7240 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007241
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01007242 RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource());
Daniel Sandler619738c2012-06-07 16:33:08 -04007243
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007244 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007245
Chris Wrend6297db2012-05-03 16:20:13 -04007246 int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3,
Chris Wren29bb6d92012-05-17 18:09:42 -04007247 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
Chris Wrend6297db2012-05-03 16:20:13 -04007248
Chris Wren4ed80d52012-05-17 09:30:03 -04007249 // Make sure all rows are gone in case we reuse a view.
7250 for (int rowId : rowIds) {
7251 contentView.setViewVisibility(rowId, View.GONE);
7252 }
7253
Daniel Sandler879c5e02012-04-17 16:46:51 -04007254 int i=0;
Selim Cinek07c80172016-04-21 16:40:47 -07007255 int topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7256 R.dimen.notification_inbox_item_top_padding);
Selim Cinek247fa012016-02-18 09:50:48 -08007257 boolean first = true;
Selim Cinek07c80172016-04-21 16:40:47 -07007258 int onlyViewId = 0;
7259 int maxRows = rowIds.length;
7260 if (mBuilder.mActions.size() > 0) {
7261 maxRows--;
7262 }
7263 while (i < mTexts.size() && i < maxRows) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007264 CharSequence str = mTexts.get(i);
Selim Cinek07c80172016-04-21 16:40:47 -07007265 if (!TextUtils.isEmpty(str)) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007266 contentView.setViewVisibility(rowIds[i], View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07007267 contentView.setTextViewText(rowIds[i],
7268 mBuilder.processTextSpans(mBuilder.processLegacyText(str)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08007269 mBuilder.setTextViewColorSecondary(contentView, rowIds[i]);
Selim Cinek07c80172016-04-21 16:40:47 -07007270 contentView.setViewPadding(rowIds[i], 0, topPadding, 0, 0);
Selim Cinek247fa012016-02-18 09:50:48 -08007271 handleInboxImageMargin(contentView, rowIds[i], first);
Selim Cinek07c80172016-04-21 16:40:47 -07007272 if (first) {
7273 onlyViewId = rowIds[i];
7274 } else {
7275 onlyViewId = 0;
7276 }
Selim Cinek247fa012016-02-18 09:50:48 -08007277 first = false;
Daniel Sandler879c5e02012-04-17 16:46:51 -04007278 }
7279 i++;
7280 }
Selim Cinek07c80172016-04-21 16:40:47 -07007281 if (onlyViewId != 0) {
7282 // We only have 1 entry, lets make it look like the normal Text of a Bigtext
7283 topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7284 R.dimen.notification_text_margin_top);
7285 contentView.setViewPadding(onlyViewId, 0, topPadding, 0, 0);
7286 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007287
Daniel Sandler879c5e02012-04-17 16:46:51 -04007288 return contentView;
7289 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007290
Julia Reynolds7217dc92018-03-07 12:12:09 -05007291 /**
7292 * @hide
7293 */
7294 @Override
7295 public boolean areNotificationsVisiblyDifferent(Style other) {
7296 if (other == null || getClass() != other.getClass()) {
7297 return true;
7298 }
7299 InboxStyle newS = (InboxStyle) other;
7300 return !Objects.equals(getLines(), newS.getLines());
7301 }
7302
Selim Cinek247fa012016-02-18 09:50:48 -08007303 private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first) {
Selim Cinek1e0bf612015-11-20 15:57:26 -08007304 int endMargin = 0;
Selim Cinek247fa012016-02-18 09:50:48 -08007305 if (first) {
7306 final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0);
7307 final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
7308 boolean hasProgress = max != 0 || ind;
Selim Cinek279fa862016-06-14 10:57:25 -07007309 if (mBuilder.mN.hasLargeIcon() && !hasProgress) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007310 endMargin = R.dimen.notification_content_picture_margin;
Selim Cinek247fa012016-02-18 09:50:48 -08007311 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007312 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007313 contentView.setViewLayoutMarginEndDimen(id, endMargin);
Selim Cinek1e0bf612015-11-20 15:57:26 -08007314 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04007315 }
Dan Sandler842dd772014-05-15 09:36:47 -04007316
7317 /**
7318 * Notification style for media playback notifications.
7319 *
7320 * In the expanded form, {@link Notification#bigContentView}, up to 5
7321 * {@link Notification.Action}s specified with
Dan Sandler86647982015-05-13 23:41:13 -04007322 * {@link Notification.Builder#addAction(Action) addAction} will be
Dan Sandler842dd772014-05-15 09:36:47 -04007323 * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
7324 * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be
7325 * treated as album artwork.
Selim Cinek99104832017-01-25 14:47:33 -08007326 * <p>
Dan Sandler842dd772014-05-15 09:36:47 -04007327 * Unlike the other styles provided here, MediaStyle can also modify the standard-size
7328 * {@link Notification#contentView}; by providing action indices to
Christoph Studerfde6f4d2014-12-12 13:23:26 +01007329 * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed
Dan Sandler842dd772014-05-15 09:36:47 -04007330 * in the standard view alongside the usual content.
Selim Cinek99104832017-01-25 14:47:33 -08007331 * <p>
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007332 * Notifications created with MediaStyle will have their category set to
7333 * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different
7334 * category using {@link Notification.Builder#setCategory(String) setCategory()}.
Selim Cinek99104832017-01-25 14:47:33 -08007335 * <p>
Jeff Browndba34ba2014-06-24 20:46:03 -07007336 * Finally, if you attach a {@link android.media.session.MediaSession.Token} using
7337 * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)},
Dan Sandler842dd772014-05-15 09:36:47 -04007338 * the System UI can identify this as a notification representing an active media session
7339 * and respond accordingly (by showing album artwork in the lockscreen, for example).
7340 *
Selim Cinek99104832017-01-25 14:47:33 -08007341 * <p>
7342 * Starting at {@link android.os.Build.VERSION_CODES#O Android O} any notification that has a
7343 * media session attached with {@link #setMediaSession(MediaSession.Token)} will be colorized.
7344 * You can opt-out of this behavior by using {@link Notification.Builder#setColorized(boolean)}.
7345 * <p>
7346 *
Dan Sandler842dd772014-05-15 09:36:47 -04007347 * To use this style with your Notification, feed it to
7348 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7349 * <pre class="prettyprint">
7350 * Notification noti = new Notification.Builder()
7351 * .setSmallIcon(R.drawable.ic_stat_player)
Christoph Studere935fe92014-11-24 14:18:06 +01007352 * .setContentTitle(&quot;Track title&quot;)
7353 * .setContentText(&quot;Artist - Album&quot;)
7354 * .setLargeIcon(albumArtBitmap))
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007355 * .setStyle(<b>new Notification.MediaStyle()</b>
7356 * .setMediaSession(mySession))
Dan Sandler842dd772014-05-15 09:36:47 -04007357 * .build();
7358 * </pre>
7359 *
7360 * @see Notification#bigContentView
Selim Cinek99104832017-01-25 14:47:33 -08007361 * @see Notification.Builder#setColorized(boolean)
Dan Sandler842dd772014-05-15 09:36:47 -04007362 */
7363 public static class MediaStyle extends Style {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007364 static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3;
Dan Sandler842dd772014-05-15 09:36:47 -04007365 static final int MAX_MEDIA_BUTTONS = 5;
7366
7367 private int[] mActionsToShowInCompact = null;
Jeff Browndba34ba2014-06-24 20:46:03 -07007368 private MediaSession.Token mToken;
Dan Sandler842dd772014-05-15 09:36:47 -04007369
7370 public MediaStyle() {
7371 }
7372
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007373 /**
7374 * @deprecated use {@code MediaStyle()}.
7375 */
7376 @Deprecated
Dan Sandler842dd772014-05-15 09:36:47 -04007377 public MediaStyle(Builder builder) {
7378 setBuilder(builder);
7379 }
7380
7381 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007382 * Request up to 3 actions (by index in the order of addition) to be shown in the compact
Dan Sandler842dd772014-05-15 09:36:47 -04007383 * notification view.
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007384 *
7385 * @param actions the indices of the actions to show in the compact notification view
Dan Sandler842dd772014-05-15 09:36:47 -04007386 */
7387 public MediaStyle setShowActionsInCompactView(int...actions) {
7388 mActionsToShowInCompact = actions;
7389 return this;
7390 }
7391
7392 /**
Jeff Browndba34ba2014-06-24 20:46:03 -07007393 * Attach a {@link android.media.session.MediaSession.Token} to this Notification
7394 * to provide additional playback information and control to the SystemUI.
Dan Sandler842dd772014-05-15 09:36:47 -04007395 */
Jeff Browndba34ba2014-06-24 20:46:03 -07007396 public MediaStyle setMediaSession(MediaSession.Token token) {
Dan Sandler842dd772014-05-15 09:36:47 -04007397 mToken = token;
7398 return this;
7399 }
7400
Christoph Studer4600f9b2014-07-22 22:44:43 +02007401 /**
7402 * @hide
7403 */
Dan Sandler842dd772014-05-15 09:36:47 -04007404 @Override
7405 public Notification buildStyled(Notification wip) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02007406 super.buildStyled(wip);
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007407 if (wip.category == null) {
7408 wip.category = Notification.CATEGORY_TRANSPORT;
7409 }
Dan Sandler842dd772014-05-15 09:36:47 -04007410 return wip;
7411 }
7412
Christoph Studer4600f9b2014-07-22 22:44:43 +02007413 /**
7414 * @hide
7415 */
7416 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007417 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007418 return makeMediaContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007419 }
7420
7421 /**
7422 * @hide
7423 */
7424 @Override
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007425 public RemoteViews makeBigContentView() {
7426 return makeMediaBigContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007427 }
7428
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007429 /**
7430 * @hide
7431 */
7432 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007433 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007434 RemoteViews expanded = makeMediaBigContentView();
7435 return expanded != null ? expanded : makeMediaContentView();
7436 }
7437
Dan Sandler842dd772014-05-15 09:36:47 -04007438 /** @hide */
7439 @Override
7440 public void addExtras(Bundle extras) {
7441 super.addExtras(extras);
7442
7443 if (mToken != null) {
7444 extras.putParcelable(EXTRA_MEDIA_SESSION, mToken);
7445 }
Bryan Mawhinneye191f902014-07-22 12:50:09 +01007446 if (mActionsToShowInCompact != null) {
7447 extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact);
7448 }
Dan Sandler842dd772014-05-15 09:36:47 -04007449 }
7450
Christoph Studer4600f9b2014-07-22 22:44:43 +02007451 /**
7452 * @hide
7453 */
7454 @Override
7455 protected void restoreFromExtras(Bundle extras) {
7456 super.restoreFromExtras(extras);
7457
7458 if (extras.containsKey(EXTRA_MEDIA_SESSION)) {
7459 mToken = extras.getParcelable(EXTRA_MEDIA_SESSION);
7460 }
7461 if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) {
7462 mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS);
7463 }
7464 }
7465
Julia Reynolds7217dc92018-03-07 12:12:09 -05007466 /**
7467 * @hide
7468 */
7469 @Override
7470 public boolean areNotificationsVisiblyDifferent(Style other) {
7471 if (other == null || getClass() != other.getClass()) {
7472 return true;
7473 }
7474 // All fields to compare are on the Notification object
7475 return false;
7476 }
7477
Selim Cinek5bf069a2015-11-10 19:14:27 -05007478 private RemoteViews generateMediaActionButton(Action action, int color) {
Dan Sandler842dd772014-05-15 09:36:47 -04007479 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07007480 RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(),
Alan Viverette3cb07a462014-06-06 14:19:53 -07007481 R.layout.notification_material_media_action);
Dan Sandler68079d52015-07-22 10:45:30 -04007482 button.setImageViewIcon(R.id.action0, action.getIcon());
Anthony Chenad4d1582017-04-10 16:07:58 -07007483
7484 // If the action buttons should not be tinted, then just use the default
7485 // notification color. Otherwise, just use the passed-in color.
7486 int tintColor = mBuilder.shouldTintActionButtons() || mBuilder.isColorized()
7487 ? color
7488 : NotificationColorUtil.resolveColor(mBuilder.mContext,
7489 Notification.COLOR_DEFAULT);
7490
Sunny Goyal5b153922017-09-21 21:00:36 -07007491 button.setDrawableTint(R.id.action0, false, tintColor,
7492 PorterDuff.Mode.SRC_ATOP);
Dan Sandler842dd772014-05-15 09:36:47 -04007493 if (!tombstone) {
7494 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
7495 }
7496 button.setContentDescription(R.id.action0, action.title);
7497 return button;
7498 }
7499
7500 private RemoteViews makeMediaContentView() {
7501 RemoteViews view = mBuilder.applyStandardTemplate(
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007502 R.layout.notification_template_material_media, false /* hasProgress */);
Dan Sandler842dd772014-05-15 09:36:47 -04007503
7504 final int numActions = mBuilder.mActions.size();
7505 final int N = mActionsToShowInCompact == null
7506 ? 0
7507 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
7508 if (N > 0) {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007509 view.removeAllViews(com.android.internal.R.id.media_actions);
Dan Sandler842dd772014-05-15 09:36:47 -04007510 for (int i = 0; i < N; i++) {
7511 if (i >= numActions) {
7512 throw new IllegalArgumentException(String.format(
7513 "setShowActionsInCompactView: action %d out of bounds (max %d)",
7514 i, numActions - 1));
7515 }
7516
7517 final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]);
Selim Cinekc7f5a822018-03-20 19:32:06 -07007518 final RemoteViews button = generateMediaActionButton(action, getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007519 view.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007520 }
7521 }
Selim Cinekfdc738f2016-01-27 20:04:27 -08007522 handleImage(view);
7523 // handle the content margin
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007524 int endMargin = R.dimen.notification_content_margin_end;
Selim Cinek279fa862016-06-14 10:57:25 -07007525 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007526 endMargin = R.dimen.notification_content_plus_picture_margin_end;
Selim Cinekfdc738f2016-01-27 20:04:27 -08007527 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007528 view.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
Dan Sandler842dd772014-05-15 09:36:47 -04007529 return view;
7530 }
7531
Selim Cinekc7f5a822018-03-20 19:32:06 -07007532 private int getActionColor() {
7533 return mBuilder.isColorized() ? mBuilder.getPrimaryTextColor()
7534 : mBuilder.resolveContrastColor();
Selim Cinek99104832017-01-25 14:47:33 -08007535 }
7536
Dan Sandler842dd772014-05-15 09:36:47 -04007537 private RemoteViews makeMediaBigContentView() {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007538 final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007539 // Dont add an expanded view if there is no more content to be revealed
7540 int actionsInCompact = mActionsToShowInCompact == null
7541 ? 0
7542 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
Selim Cinek279fa862016-06-14 10:57:25 -07007543 if (!mBuilder.mN.hasLargeIcon() && actionCount <= actionsInCompact) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007544 return null;
7545 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007546 RemoteViews big = mBuilder.applyStandardTemplate(
7547 R.layout.notification_template_material_big_media,
7548 false);
Dan Sandler842dd772014-05-15 09:36:47 -04007549
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007550 if (actionCount > 0) {
7551 big.removeAllViews(com.android.internal.R.id.media_actions);
7552 for (int i = 0; i < actionCount; i++) {
Selim Cinek5bf069a2015-11-10 19:14:27 -05007553 final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i),
Selim Cinekc7f5a822018-03-20 19:32:06 -07007554 getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007555 big.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007556 }
7557 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007558 handleImage(big);
Dan Sandler842dd772014-05-15 09:36:47 -04007559 return big;
7560 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007561
Selim Cinek5bf069a2015-11-10 19:14:27 -05007562 private void handleImage(RemoteViews contentView) {
Selim Cinek279fa862016-06-14 10:57:25 -07007563 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007564 contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
7565 contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007566 }
7567 }
7568
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007569 /**
7570 * @hide
7571 */
7572 @Override
7573 protected boolean hasProgress() {
7574 return false;
7575 }
Dan Sandler842dd772014-05-15 09:36:47 -04007576 }
Griff Hazen61a9e862014-05-22 16:05:19 -07007577
Selim Cinek593610c2016-02-16 18:42:57 -08007578 /**
7579 * Notification style for custom views that are decorated by the system
7580 *
7581 * <p>Instead of providing a notification that is completely custom, a developer can set this
7582 * style and still obtain system decorations like the notification header with the expand
7583 * affordance and actions.
7584 *
7585 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7586 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7587 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7588 * corresponding custom views to display.
7589 *
7590 * To use this style with your Notification, feed it to
7591 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7592 * <pre class="prettyprint">
7593 * Notification noti = new Notification.Builder()
7594 * .setSmallIcon(R.drawable.ic_stat_player)
7595 * .setLargeIcon(albumArtBitmap))
7596 * .setCustomContentView(contentView);
7597 * .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>)
7598 * .build();
7599 * </pre>
7600 */
7601 public static class DecoratedCustomViewStyle extends Style {
7602
7603 public DecoratedCustomViewStyle() {
7604 }
7605
Selim Cinek593610c2016-02-16 18:42:57 -08007606 /**
7607 * @hide
7608 */
7609 public boolean displayCustomViewInline() {
7610 return true;
7611 }
7612
7613 /**
7614 * @hide
7615 */
7616 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007617 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007618 return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView);
7619 }
7620
7621 /**
7622 * @hide
7623 */
7624 @Override
7625 public RemoteViews makeBigContentView() {
7626 return makeDecoratedBigContentView();
7627 }
7628
7629 /**
7630 * @hide
7631 */
7632 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007633 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007634 return makeDecoratedHeadsUpContentView();
7635 }
7636
Selim Cinek593610c2016-02-16 18:42:57 -08007637 private RemoteViews makeDecoratedHeadsUpContentView() {
7638 RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null
7639 ? mBuilder.mN.contentView
7640 : mBuilder.mN.headsUpContentView;
7641 if (mBuilder.mActions.size() == 0) {
7642 return makeStandardTemplateWithCustomContent(headsUpContentView);
7643 }
7644 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
7645 mBuilder.getBigBaseLayoutResource());
Selim Cinek247fa012016-02-18 09:50:48 -08007646 buildIntoRemoteViewContent(remoteViews, headsUpContentView);
Selim Cinek593610c2016-02-16 18:42:57 -08007647 return remoteViews;
7648 }
7649
Selim Cinek593610c2016-02-16 18:42:57 -08007650 private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) {
7651 RemoteViews remoteViews = mBuilder.applyStandardTemplate(
7652 mBuilder.getBaseLayoutResource());
Selim Cinek247fa012016-02-18 09:50:48 -08007653 buildIntoRemoteViewContent(remoteViews, customContent);
Selim Cinek593610c2016-02-16 18:42:57 -08007654 return remoteViews;
7655 }
7656
Selim Cinek593610c2016-02-16 18:42:57 -08007657 private RemoteViews makeDecoratedBigContentView() {
7658 RemoteViews bigContentView = mBuilder.mN.bigContentView == null
7659 ? mBuilder.mN.contentView
7660 : mBuilder.mN.bigContentView;
7661 if (mBuilder.mActions.size() == 0) {
7662 return makeStandardTemplateWithCustomContent(bigContentView);
7663 }
7664 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
7665 mBuilder.getBigBaseLayoutResource());
Selim Cinek247fa012016-02-18 09:50:48 -08007666 buildIntoRemoteViewContent(remoteViews, bigContentView);
Selim Cinek593610c2016-02-16 18:42:57 -08007667 return remoteViews;
7668 }
Selim Cinek247fa012016-02-18 09:50:48 -08007669
7670 private void buildIntoRemoteViewContent(RemoteViews remoteViews,
7671 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08007672 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07007673 // Need to clone customContent before adding, because otherwise it can no longer be
7674 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08007675 customContent = customContent.clone();
Anthony Chen8f5f3582017-04-11 11:18:37 -07007676 remoteViews.removeAllViewsExceptId(R.id.notification_main_column, R.id.progress);
7677 remoteViews.addView(R.id.notification_main_column, customContent, 0 /* index */);
Selim Cinekfc8073c2017-08-16 17:50:20 -07007678 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08007679 }
Selim Cinek247fa012016-02-18 09:50:48 -08007680 // also update the end margin if there is an image
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007681 int endMargin = R.dimen.notification_content_margin_end;
Selim Cinek279fa862016-06-14 10:57:25 -07007682 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007683 endMargin = R.dimen.notification_content_plus_picture_margin_end;
Selim Cinek247fa012016-02-18 09:50:48 -08007684 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007685 remoteViews.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
Selim Cinek247fa012016-02-18 09:50:48 -08007686 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05007687
7688 /**
7689 * @hide
7690 */
7691 @Override
7692 public boolean areNotificationsVisiblyDifferent(Style other) {
7693 if (other == null || getClass() != other.getClass()) {
7694 return true;
7695 }
7696 // Comparison done for all custom RemoteViews, independent of style
7697 return false;
7698 }
Selim Cinek593610c2016-02-16 18:42:57 -08007699 }
7700
Selim Cinek03eb3b72016-02-18 10:39:45 -08007701 /**
7702 * Notification style for media custom views that are decorated by the system
7703 *
7704 * <p>Instead of providing a media notification that is completely custom, a developer can set
7705 * this style and still obtain system decorations like the notification header with the expand
7706 * affordance and actions.
7707 *
7708 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7709 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7710 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7711 * corresponding custom views to display.
Selim Cinek99104832017-01-25 14:47:33 -08007712 * <p>
7713 * Contrary to {@link MediaStyle} a developer has to opt-in to the colorizing of the
7714 * notification by using {@link Notification.Builder#setColorized(boolean)}.
7715 * <p>
Selim Cinek03eb3b72016-02-18 10:39:45 -08007716 * To use this style with your Notification, feed it to
7717 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7718 * <pre class="prettyprint">
7719 * Notification noti = new Notification.Builder()
7720 * .setSmallIcon(R.drawable.ic_stat_player)
7721 * .setLargeIcon(albumArtBitmap))
7722 * .setCustomContentView(contentView);
7723 * .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b>
7724 * .setMediaSession(mySession))
7725 * .build();
7726 * </pre>
7727 *
7728 * @see android.app.Notification.DecoratedCustomViewStyle
7729 * @see android.app.Notification.MediaStyle
7730 */
7731 public static class DecoratedMediaCustomViewStyle extends MediaStyle {
7732
7733 public DecoratedMediaCustomViewStyle() {
7734 }
7735
Selim Cinek03eb3b72016-02-18 10:39:45 -08007736 /**
7737 * @hide
7738 */
7739 public boolean displayCustomViewInline() {
7740 return true;
7741 }
7742
7743 /**
7744 * @hide
7745 */
7746 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007747 public RemoteViews makeContentView(boolean increasedHeight) {
7748 RemoteViews remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08007749 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
7750 mBuilder.mN.contentView);
7751 }
7752
7753 /**
7754 * @hide
7755 */
7756 @Override
7757 public RemoteViews makeBigContentView() {
7758 RemoteViews customRemoteView = mBuilder.mN.bigContentView != null
7759 ? mBuilder.mN.bigContentView
7760 : mBuilder.mN.contentView;
7761 return makeBigContentViewWithCustomContent(customRemoteView);
7762 }
7763
7764 private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) {
7765 RemoteViews remoteViews = super.makeBigContentView();
7766 if (remoteViews != null) {
7767 return buildIntoRemoteView(remoteViews, R.id.notification_main_column,
7768 customRemoteView);
7769 } else if (customRemoteView != mBuilder.mN.contentView){
Selim Cinek7d1009b2017-01-25 15:28:28 -08007770 remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08007771 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
7772 customRemoteView);
7773 } else {
7774 return null;
7775 }
7776 }
7777
7778 /**
7779 * @hide
7780 */
7781 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007782 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek03eb3b72016-02-18 10:39:45 -08007783 RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null
7784 ? mBuilder.mN.headsUpContentView
7785 : mBuilder.mN.contentView;
7786 return makeBigContentViewWithCustomContent(customRemoteView);
7787 }
7788
Julia Reynolds7217dc92018-03-07 12:12:09 -05007789 /**
7790 * @hide
7791 */
7792 @Override
7793 public boolean areNotificationsVisiblyDifferent(Style other) {
7794 if (other == null || getClass() != other.getClass()) {
7795 return true;
7796 }
7797 // Comparison done for all custom RemoteViews, independent of style
7798 return false;
7799 }
7800
Selim Cinek03eb3b72016-02-18 10:39:45 -08007801 private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id,
7802 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08007803 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07007804 // Need to clone customContent before adding, because otherwise it can no longer be
7805 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08007806 customContent = customContent.clone();
Selim Cinek87c31532017-08-18 18:53:44 -07007807 customContent.overrideTextColors(mBuilder.getPrimaryTextColor());
Selim Cinekf91017e2016-03-14 12:25:09 -07007808 remoteViews.removeAllViews(id);
7809 remoteViews.addView(id, customContent);
Selim Cinekfc8073c2017-08-16 17:50:20 -07007810 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08007811 }
Selim Cinek03eb3b72016-02-18 10:39:45 -08007812 return remoteViews;
7813 }
7814 }
7815
Christoph Studer4600f9b2014-07-22 22:44:43 +02007816 // When adding a new Style subclass here, don't forget to update
7817 // Builder.getNotificationStyleClass.
7818
Griff Hazen61a9e862014-05-22 16:05:19 -07007819 /**
7820 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
7821 * metadata or change options on a notification builder.
7822 */
7823 public interface Extender {
7824 /**
7825 * Apply this extender to a notification builder.
7826 * @param builder the builder to be modified.
7827 * @return the build object for chaining.
7828 */
7829 public Builder extend(Builder builder);
7830 }
7831
7832 /**
7833 * Helper class to add wearable extensions to notifications.
7834 * <p class="note"> See
7835 * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications
7836 * for Android Wear</a> for more information on how to use this class.
7837 * <p>
7838 * To create a notification with wearable extensions:
7839 * <ol>
7840 * <li>Create a {@link android.app.Notification.Builder}, setting any desired
7841 * properties.
7842 * <li>Create a {@link android.app.Notification.WearableExtender}.
7843 * <li>Set wearable-specific properties using the
7844 * {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}.
7845 * <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a
7846 * notification.
7847 * <li>Post the notification to the notification system with the
7848 * {@code NotificationManager.notify(...)} methods.
7849 * </ol>
7850 *
7851 * <pre class="prettyprint">
7852 * Notification notif = new Notification.Builder(mContext)
7853 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
7854 * .setContentText(subject)
7855 * .setSmallIcon(R.drawable.new_mail)
7856 * .extend(new Notification.WearableExtender()
7857 * .setContentIcon(R.drawable.new_mail))
7858 * .build();
7859 * NotificationManager notificationManger =
7860 * (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
7861 * notificationManger.notify(0, notif);</pre>
7862 *
7863 * <p>Wearable extensions can be accessed on an existing notification by using the
7864 * {@code WearableExtender(Notification)} constructor,
7865 * and then using the {@code get} methods to access values.
7866 *
7867 * <pre class="prettyprint">
7868 * Notification.WearableExtender wearableExtender = new Notification.WearableExtender(
7869 * notification);
Griff Hazen14f57992014-05-26 09:07:14 -07007870 * List&lt;Notification&gt; pages = wearableExtender.getPages();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07007871 */
7872 public static final class WearableExtender implements Extender {
7873 /**
7874 * Sentinel value for an action index that is unset.
7875 */
7876 public static final int UNSET_ACTION_INDEX = -1;
7877
7878 /**
7879 * Size value for use with {@link #setCustomSizePreset} to show this notification with
7880 * default sizing.
7881 * <p>For custom display notifications created using {@link #setDisplayIntent},
Paul Soulosaa4f4bf2015-08-04 11:59:45 -07007882 * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based
Griff Hazen61a9e862014-05-22 16:05:19 -07007883 * on their content.
7884 */
7885 public static final int SIZE_DEFAULT = 0;
7886
7887 /**
7888 * Size value for use with {@link #setCustomSizePreset} to show this notification
7889 * with an extra small size.
7890 * <p>This value is only applicable for custom display notifications created using
7891 * {@link #setDisplayIntent}.
7892 */
7893 public static final int SIZE_XSMALL = 1;
7894
7895 /**
7896 * Size value for use with {@link #setCustomSizePreset} to show this notification
7897 * with a small size.
7898 * <p>This value is only applicable for custom display notifications created using
7899 * {@link #setDisplayIntent}.
7900 */
7901 public static final int SIZE_SMALL = 2;
7902
7903 /**
7904 * Size value for use with {@link #setCustomSizePreset} to show this notification
7905 * with a medium size.
7906 * <p>This value is only applicable for custom display notifications created using
7907 * {@link #setDisplayIntent}.
7908 */
7909 public static final int SIZE_MEDIUM = 3;
7910
7911 /**
7912 * Size value for use with {@link #setCustomSizePreset} to show this notification
7913 * with a large size.
7914 * <p>This value is only applicable for custom display notifications created using
7915 * {@link #setDisplayIntent}.
7916 */
7917 public static final int SIZE_LARGE = 4;
7918
Griff Hazend5f11f92014-05-27 15:40:09 -07007919 /**
7920 * Size value for use with {@link #setCustomSizePreset} to show this notification
7921 * full screen.
7922 * <p>This value is only applicable for custom display notifications created using
7923 * {@link #setDisplayIntent}.
7924 */
7925 public static final int SIZE_FULL_SCREEN = 5;
7926
Griff Hazen5f2edfc2014-09-29 16:28:44 -07007927 /**
7928 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a
7929 * short amount of time when this notification is displayed on the screen. This
7930 * is the default value.
7931 */
7932 public static final int SCREEN_TIMEOUT_SHORT = 0;
7933
7934 /**
7935 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on
7936 * for a longer amount of time when this notification is displayed on the screen.
7937 */
7938 public static final int SCREEN_TIMEOUT_LONG = -1;
7939
Griff Hazen61a9e862014-05-22 16:05:19 -07007940 /** Notification extra which contains wearable extensions */
7941 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
7942
Pete Gastaf6781d2014-10-07 15:17:05 -04007943 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07007944 private static final String KEY_ACTIONS = "actions";
7945 private static final String KEY_FLAGS = "flags";
7946 private static final String KEY_DISPLAY_INTENT = "displayIntent";
7947 private static final String KEY_PAGES = "pages";
7948 private static final String KEY_BACKGROUND = "background";
7949 private static final String KEY_CONTENT_ICON = "contentIcon";
7950 private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity";
7951 private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex";
7952 private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset";
7953 private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight";
7954 private static final String KEY_GRAVITY = "gravity";
Griff Hazen5f2edfc2014-09-29 16:28:44 -07007955 private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout";
Nadia Benbernou948627e2016-04-14 14:41:08 -04007956 private static final String KEY_DISMISSAL_ID = "dismissalId";
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04007957 private static final String KEY_BRIDGE_TAG = "bridgeTag";
Griff Hazen61a9e862014-05-22 16:05:19 -07007958
7959 // Flags bitwise-ored to mFlags
7960 private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1;
7961 private static final int FLAG_HINT_HIDE_ICON = 1 << 1;
7962 private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2;
7963 private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07007964 private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4;
Alex Hills4bcb06b2016-04-05 14:26:25 -04007965 private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5;
Alex Hills9ab3a232016-04-05 14:54:56 -04007966 private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6;
Griff Hazen61a9e862014-05-22 16:05:19 -07007967
7968 // Default value for flags integer
7969 private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE;
7970
7971 private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END;
7972 private static final int DEFAULT_GRAVITY = Gravity.BOTTOM;
7973
7974 private ArrayList<Action> mActions = new ArrayList<Action>();
7975 private int mFlags = DEFAULT_FLAGS;
7976 private PendingIntent mDisplayIntent;
7977 private ArrayList<Notification> mPages = new ArrayList<Notification>();
7978 private Bitmap mBackground;
7979 private int mContentIcon;
7980 private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY;
7981 private int mContentActionIndex = UNSET_ACTION_INDEX;
7982 private int mCustomSizePreset = SIZE_DEFAULT;
7983 private int mCustomContentHeight;
7984 private int mGravity = DEFAULT_GRAVITY;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07007985 private int mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04007986 private String mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04007987 private String mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07007988
7989 /**
7990 * Create a {@link android.app.Notification.WearableExtender} with default
7991 * options.
7992 */
7993 public WearableExtender() {
7994 }
7995
7996 public WearableExtender(Notification notif) {
7997 Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS);
7998 if (wearableBundle != null) {
7999 List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS);
8000 if (actions != null) {
8001 mActions.addAll(actions);
8002 }
8003
8004 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
8005 mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT);
8006
8007 Notification[] pages = getNotificationArrayFromBundle(
8008 wearableBundle, KEY_PAGES);
8009 if (pages != null) {
8010 Collections.addAll(mPages, pages);
8011 }
8012
8013 mBackground = wearableBundle.getParcelable(KEY_BACKGROUND);
8014 mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON);
8015 mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY,
8016 DEFAULT_CONTENT_ICON_GRAVITY);
8017 mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX,
8018 UNSET_ACTION_INDEX);
8019 mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET,
8020 SIZE_DEFAULT);
8021 mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT);
8022 mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY);
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008023 mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT);
Nadia Benbernou948627e2016-04-14 14:41:08 -04008024 mDismissalId = wearableBundle.getString(KEY_DISMISSAL_ID);
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008025 mBridgeTag = wearableBundle.getString(KEY_BRIDGE_TAG);
Griff Hazen61a9e862014-05-22 16:05:19 -07008026 }
8027 }
8028
8029 /**
8030 * Apply wearable extensions to a notification that is being built. This is typically
8031 * called by the {@link android.app.Notification.Builder#extend} method of
8032 * {@link android.app.Notification.Builder}.
8033 */
8034 @Override
8035 public Notification.Builder extend(Notification.Builder builder) {
8036 Bundle wearableBundle = new Bundle();
8037
8038 if (!mActions.isEmpty()) {
8039 wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions);
8040 }
8041 if (mFlags != DEFAULT_FLAGS) {
8042 wearableBundle.putInt(KEY_FLAGS, mFlags);
8043 }
8044 if (mDisplayIntent != null) {
8045 wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent);
8046 }
8047 if (!mPages.isEmpty()) {
8048 wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray(
8049 new Notification[mPages.size()]));
8050 }
8051 if (mBackground != null) {
8052 wearableBundle.putParcelable(KEY_BACKGROUND, mBackground);
8053 }
8054 if (mContentIcon != 0) {
8055 wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon);
8056 }
8057 if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) {
8058 wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity);
8059 }
8060 if (mContentActionIndex != UNSET_ACTION_INDEX) {
8061 wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX,
8062 mContentActionIndex);
8063 }
8064 if (mCustomSizePreset != SIZE_DEFAULT) {
8065 wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset);
8066 }
8067 if (mCustomContentHeight != 0) {
8068 wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight);
8069 }
8070 if (mGravity != DEFAULT_GRAVITY) {
8071 wearableBundle.putInt(KEY_GRAVITY, mGravity);
8072 }
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008073 if (mHintScreenTimeout != 0) {
8074 wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout);
8075 }
Nadia Benbernou948627e2016-04-14 14:41:08 -04008076 if (mDismissalId != null) {
8077 wearableBundle.putString(KEY_DISMISSAL_ID, mDismissalId);
8078 }
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008079 if (mBridgeTag != null) {
8080 wearableBundle.putString(KEY_BRIDGE_TAG, mBridgeTag);
8081 }
Griff Hazen61a9e862014-05-22 16:05:19 -07008082
8083 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
8084 return builder;
8085 }
8086
8087 @Override
8088 public WearableExtender clone() {
8089 WearableExtender that = new WearableExtender();
8090 that.mActions = new ArrayList<Action>(this.mActions);
8091 that.mFlags = this.mFlags;
8092 that.mDisplayIntent = this.mDisplayIntent;
8093 that.mPages = new ArrayList<Notification>(this.mPages);
8094 that.mBackground = this.mBackground;
8095 that.mContentIcon = this.mContentIcon;
8096 that.mContentIconGravity = this.mContentIconGravity;
8097 that.mContentActionIndex = this.mContentActionIndex;
8098 that.mCustomSizePreset = this.mCustomSizePreset;
8099 that.mCustomContentHeight = this.mCustomContentHeight;
8100 that.mGravity = this.mGravity;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008101 that.mHintScreenTimeout = this.mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04008102 that.mDismissalId = this.mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008103 that.mBridgeTag = this.mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07008104 return that;
8105 }
8106
8107 /**
8108 * Add a wearable action to this notification.
8109 *
8110 * <p>When wearable actions are added using this method, the set of actions that
8111 * show on a wearable device splits from devices that only show actions added
8112 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8113 * of which actions display on different devices.
8114 *
8115 * @param action the action to add to this notification
8116 * @return this object for method chaining
8117 * @see android.app.Notification.Action
8118 */
8119 public WearableExtender addAction(Action action) {
8120 mActions.add(action);
8121 return this;
8122 }
8123
8124 /**
8125 * Adds wearable actions to this notification.
8126 *
8127 * <p>When wearable actions are added using this method, the set of actions that
8128 * show on a wearable device splits from devices that only show actions added
8129 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8130 * of which actions display on different devices.
8131 *
8132 * @param actions the actions to add to this notification
8133 * @return this object for method chaining
8134 * @see android.app.Notification.Action
8135 */
8136 public WearableExtender addActions(List<Action> actions) {
8137 mActions.addAll(actions);
8138 return this;
8139 }
8140
8141 /**
8142 * Clear all wearable actions present on this builder.
8143 * @return this object for method chaining.
8144 * @see #addAction
8145 */
8146 public WearableExtender clearActions() {
8147 mActions.clear();
8148 return this;
8149 }
8150
8151 /**
8152 * Get the wearable actions present on this notification.
8153 */
8154 public List<Action> getActions() {
8155 return mActions;
8156 }
8157
8158 /**
8159 * Set an intent to launch inside of an activity view when displaying
Griff Hazen14f57992014-05-26 09:07:14 -07008160 * this notification. The {@link PendingIntent} provided should be for an activity.
8161 *
8162 * <pre class="prettyprint">
8163 * Intent displayIntent = new Intent(context, MyDisplayActivity.class);
8164 * PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
8165 * 0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
8166 * Notification notif = new Notification.Builder(context)
8167 * .extend(new Notification.WearableExtender()
8168 * .setDisplayIntent(displayPendingIntent)
8169 * .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM))
8170 * .build();</pre>
8171 *
8172 * <p>The activity to launch needs to allow embedding, must be exported, and
Griff Hazen831ca9d2014-06-17 00:38:38 -07008173 * should have an empty task affinity. It is also recommended to use the device
8174 * default light theme.
Griff Hazen14f57992014-05-26 09:07:14 -07008175 *
8176 * <p>Example AndroidManifest.xml entry:
8177 * <pre class="prettyprint">
8178 * &lt;activity android:name=&quot;com.example.MyDisplayActivity&quot;
8179 * android:exported=&quot;true&quot;
8180 * android:allowEmbedded=&quot;true&quot;
Griff Hazen831ca9d2014-06-17 00:38:38 -07008181 * android:taskAffinity=&quot;&quot;
8182 * android:theme=&quot;@android:style/Theme.DeviceDefault.Light&quot; /&gt;</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07008183 *
8184 * @param intent the {@link PendingIntent} for an activity
8185 * @return this object for method chaining
8186 * @see android.app.Notification.WearableExtender#getDisplayIntent
8187 */
8188 public WearableExtender setDisplayIntent(PendingIntent intent) {
8189 mDisplayIntent = intent;
8190 return this;
8191 }
8192
8193 /**
8194 * Get the intent to launch inside of an activity view when displaying this
8195 * notification. This {@code PendingIntent} should be for an activity.
8196 */
8197 public PendingIntent getDisplayIntent() {
8198 return mDisplayIntent;
8199 }
8200
8201 /**
8202 * Add an additional page of content to display with this notification. The current
8203 * notification forms the first page, and pages added using this function form
8204 * subsequent pages. This field can be used to separate a notification into multiple
8205 * sections.
8206 *
8207 * @param page the notification to add as another page
8208 * @return this object for method chaining
8209 * @see android.app.Notification.WearableExtender#getPages
8210 */
8211 public WearableExtender addPage(Notification page) {
8212 mPages.add(page);
8213 return this;
8214 }
8215
8216 /**
8217 * Add additional pages of content to display with this notification. The current
8218 * notification forms the first page, and pages added using this function form
8219 * subsequent pages. This field can be used to separate a notification into multiple
8220 * sections.
8221 *
8222 * @param pages a list of notifications
8223 * @return this object for method chaining
8224 * @see android.app.Notification.WearableExtender#getPages
8225 */
8226 public WearableExtender addPages(List<Notification> pages) {
8227 mPages.addAll(pages);
8228 return this;
8229 }
8230
8231 /**
8232 * Clear all additional pages present on this builder.
8233 * @return this object for method chaining.
8234 * @see #addPage
8235 */
8236 public WearableExtender clearPages() {
8237 mPages.clear();
8238 return this;
8239 }
8240
8241 /**
8242 * Get the array of additional pages of content for displaying this notification. The
8243 * current notification forms the first page, and elements within this array form
8244 * subsequent pages. This field can be used to separate a notification into multiple
8245 * sections.
8246 * @return the pages for this notification
8247 */
8248 public List<Notification> getPages() {
8249 return mPages;
8250 }
8251
8252 /**
8253 * Set 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 * @param background the background bitmap
8258 * @return this object for method chaining
8259 * @see android.app.Notification.WearableExtender#getBackground
8260 */
8261 public WearableExtender setBackground(Bitmap background) {
8262 mBackground = background;
8263 return this;
8264 }
8265
8266 /**
8267 * Get a background image to be displayed behind the notification content.
8268 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8269 * will work with any notification style.
8270 *
8271 * @return the background image
8272 * @see android.app.Notification.WearableExtender#setBackground
8273 */
8274 public Bitmap getBackground() {
8275 return mBackground;
8276 }
8277
8278 /**
8279 * Set an icon that goes with the content of this notification.
8280 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008281 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008282 public WearableExtender setContentIcon(int icon) {
8283 mContentIcon = icon;
8284 return this;
8285 }
8286
8287 /**
8288 * Get an icon that goes with the content of this notification.
8289 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008290 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008291 public int getContentIcon() {
8292 return mContentIcon;
8293 }
8294
8295 /**
8296 * Set the gravity that the content icon should have within the notification display.
8297 * Supported values include {@link android.view.Gravity#START} and
8298 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8299 * @see #setContentIcon
8300 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008301 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008302 public WearableExtender setContentIconGravity(int contentIconGravity) {
8303 mContentIconGravity = contentIconGravity;
8304 return this;
8305 }
8306
8307 /**
8308 * Get the gravity that the content icon should have within the notification display.
8309 * Supported values include {@link android.view.Gravity#START} and
8310 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8311 * @see #getContentIcon
8312 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008313 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008314 public int getContentIconGravity() {
8315 return mContentIconGravity;
8316 }
8317
8318 /**
8319 * Set an action from this notification's actions to be clickable with the content of
Griff Hazen14f57992014-05-26 09:07:14 -07008320 * this notification. This action will no longer display separately from the
8321 * notification's content.
8322 *
Griff Hazenca48d352014-05-28 22:37:13 -07008323 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008324 * set, although the list of available actions comes from the main notification and not
8325 * from the child page's notification.
8326 *
8327 * @param actionIndex The index of the action to hoist onto the current notification page.
8328 * If wearable actions were added to the main notification, this index
8329 * will apply to that list, otherwise it will apply to the regular
8330 * actions list.
Griff Hazen61a9e862014-05-22 16:05:19 -07008331 */
8332 public WearableExtender setContentAction(int actionIndex) {
8333 mContentActionIndex = actionIndex;
8334 return this;
8335 }
8336
8337 /**
Griff Hazenca48d352014-05-28 22:37:13 -07008338 * Get the index of the notification action, if any, that was specified as being clickable
8339 * with the content of this notification. This action will no longer display separately
Griff Hazen14f57992014-05-26 09:07:14 -07008340 * from the notification's content.
Griff Hazen61a9e862014-05-22 16:05:19 -07008341 *
Griff Hazenca48d352014-05-28 22:37:13 -07008342 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008343 * set, although the list of available actions comes from the main notification and not
8344 * from the child page's notification.
8345 *
8346 * <p>If wearable specific actions were added to the main notification, this index will
8347 * apply to that list, otherwise it will apply to the regular actions list.
Griff Hazenca48d352014-05-28 22:37:13 -07008348 *
8349 * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected.
Griff Hazen61a9e862014-05-22 16:05:19 -07008350 */
8351 public int getContentAction() {
8352 return mContentActionIndex;
8353 }
8354
8355 /**
8356 * Set the gravity that this notification should have within the available viewport space.
8357 * Supported values include {@link android.view.Gravity#TOP},
8358 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8359 * The default value is {@link android.view.Gravity#BOTTOM}.
8360 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008361 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008362 public WearableExtender setGravity(int gravity) {
8363 mGravity = gravity;
8364 return this;
8365 }
8366
8367 /**
8368 * Get the gravity that this notification should have within the available viewport space.
8369 * Supported values include {@link android.view.Gravity#TOP},
8370 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8371 * The default value is {@link android.view.Gravity#BOTTOM}.
8372 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008373 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008374 public int getGravity() {
8375 return mGravity;
8376 }
8377
8378 /**
8379 * Set the custom size preset for the display of this notification out of the available
8380 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8381 * {@link #SIZE_LARGE}.
8382 * <p>Some custom size presets are only applicable for custom display notifications created
8383 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the
8384 * documentation for the preset in question. See also
8385 * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}.
8386 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008387 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008388 public WearableExtender setCustomSizePreset(int sizePreset) {
8389 mCustomSizePreset = sizePreset;
8390 return this;
8391 }
8392
8393 /**
8394 * Get the custom size preset for the display of this notification out of the available
8395 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8396 * {@link #SIZE_LARGE}.
8397 * <p>Some custom size presets are only applicable for custom display notifications created
8398 * using {@link #setDisplayIntent}. Check the documentation for the preset in question.
8399 * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}.
8400 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008401 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008402 public int getCustomSizePreset() {
8403 return mCustomSizePreset;
8404 }
8405
8406 /**
8407 * Set the custom height in pixels for the display of this notification's content.
8408 * <p>This option is only available for custom display notifications created
8409 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also
8410 * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and
8411 * {@link #getCustomContentHeight}.
8412 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008413 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008414 public WearableExtender setCustomContentHeight(int height) {
8415 mCustomContentHeight = height;
8416 return this;
8417 }
8418
8419 /**
8420 * Get the custom height in pixels for the display of this notification's content.
8421 * <p>This option is only available for custom display notifications created
8422 * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and
8423 * {@link #setCustomContentHeight}.
8424 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008425 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008426 public int getCustomContentHeight() {
8427 return mCustomContentHeight;
8428 }
8429
8430 /**
8431 * Set whether the scrolling position for the contents of this notification should start
8432 * at the bottom of the contents instead of the top when the contents are too long to
8433 * display within the screen. Default is false (start scroll at the top).
8434 */
8435 public WearableExtender setStartScrollBottom(boolean startScrollBottom) {
8436 setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom);
8437 return this;
8438 }
8439
8440 /**
8441 * Get whether the scrolling position for the contents of this notification should start
8442 * at the bottom of the contents instead of the top when the contents are too long to
8443 * display within the screen. Default is false (start scroll at the top).
8444 */
8445 public boolean getStartScrollBottom() {
8446 return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0;
8447 }
8448
8449 /**
8450 * Set whether the content intent is available when the wearable device is not connected
8451 * to a companion device. The user can still trigger this intent when the wearable device
8452 * is offline, but a visual hint will indicate that the content intent may not be available.
8453 * Defaults to true.
8454 */
8455 public WearableExtender setContentIntentAvailableOffline(
8456 boolean contentIntentAvailableOffline) {
8457 setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline);
8458 return this;
8459 }
8460
8461 /**
8462 * Get whether the content intent is available when the wearable device is not connected
8463 * to a companion device. The user can still trigger this intent when the wearable device
8464 * is offline, but a visual hint will indicate that the content intent may not be available.
8465 * Defaults to true.
8466 */
8467 public boolean getContentIntentAvailableOffline() {
8468 return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0;
8469 }
8470
8471 /**
8472 * Set a hint that this notification's icon should not be displayed.
8473 * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise.
8474 * @return this object for method chaining
8475 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008476 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008477 public WearableExtender setHintHideIcon(boolean hintHideIcon) {
8478 setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon);
8479 return this;
8480 }
8481
8482 /**
8483 * Get a hint that this notification's icon should not be displayed.
8484 * @return {@code true} if this icon should not be displayed, false otherwise.
8485 * The default value is {@code false} if this was never set.
8486 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008487 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008488 public boolean getHintHideIcon() {
8489 return (mFlags & FLAG_HINT_HIDE_ICON) != 0;
8490 }
8491
8492 /**
8493 * Set a visual hint that only the background image of this notification should be
8494 * displayed, and other semantic content should be hidden. This hint is only applicable
8495 * to sub-pages added using {@link #addPage}.
8496 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008497 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008498 public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) {
8499 setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly);
8500 return this;
8501 }
8502
8503 /**
8504 * Get a visual hint that only the background image of this notification should be
8505 * displayed, and other semantic content should be hidden. This hint is only applicable
8506 * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}.
8507 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008508 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008509 public boolean getHintShowBackgroundOnly() {
8510 return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0;
8511 }
8512
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008513 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008514 * Set 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.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008517 * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
8518 * @return this object for method chaining
8519 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008520 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008521 public WearableExtender setHintAvoidBackgroundClipping(
8522 boolean hintAvoidBackgroundClipping) {
8523 setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping);
8524 return this;
8525 }
8526
8527 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008528 * Get a hint that this notification's background should not be clipped if possible,
8529 * and should instead be resized to fully display on the screen, retaining the aspect
8530 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008531 * @return {@code true} if it's ok if the background is clipped on the screen, false
8532 * otherwise. The default value is {@code false} if this was never set.
8533 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008534 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008535 public boolean getHintAvoidBackgroundClipping() {
8536 return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0;
8537 }
8538
8539 /**
8540 * Set a hint that the screen should remain on for at least this duration when
8541 * this notification is displayed on the screen.
8542 * @param timeout The requested screen timeout in milliseconds. Can also be either
8543 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8544 * @return this object for method chaining
8545 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008546 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008547 public WearableExtender setHintScreenTimeout(int timeout) {
8548 mHintScreenTimeout = timeout;
8549 return this;
8550 }
8551
8552 /**
8553 * Get the duration, in milliseconds, that the screen should remain on for
8554 * when this notification is displayed.
8555 * @return the duration in milliseconds if > 0, or either one of the sentinel values
8556 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8557 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008558 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008559 public int getHintScreenTimeout() {
8560 return mHintScreenTimeout;
8561 }
8562
Alex Hills9ab3a232016-04-05 14:54:56 -04008563 /**
Alex Hills4bcb06b2016-04-05 14:26:25 -04008564 * Set a hint that this notification's {@link BigPictureStyle} (if present) should be
8565 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8566 * qr codes, as well as other simple black-and-white tickets.
8567 * @param hintAmbientBigPicture {@code true} to enable converstion and ambient.
8568 * @return this object for method chaining
8569 */
8570 public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) {
8571 setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture);
8572 return this;
8573 }
8574
8575 /**
8576 * Get a hint that this notification's {@link BigPictureStyle} (if present) should be
8577 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8578 * qr codes, as well as other simple black-and-white tickets.
8579 * @return {@code true} if it should be displayed in ambient, false otherwise
8580 * otherwise. The default value is {@code false} if this was never set.
8581 */
8582 public boolean getHintAmbientBigPicture() {
8583 return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0;
8584 }
8585
8586 /**
Alex Hills9ab3a232016-04-05 14:54:56 -04008587 * Set a hint that this notification's content intent will launch an {@link Activity}
8588 * directly, telling the platform that it can generate the appropriate transitions.
8589 * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch
8590 * an activity and transitions should be generated, false otherwise.
8591 * @return this object for method chaining
8592 */
8593 public WearableExtender setHintContentIntentLaunchesActivity(
8594 boolean hintContentIntentLaunchesActivity) {
8595 setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity);
8596 return this;
8597 }
8598
8599 /**
8600 * Get a hint that this notification's content intent will launch an {@link Activity}
8601 * directly, telling the platform that it can generate the appropriate transitions
8602 * @return {@code true} if the content intent will launch an activity and transitions should
8603 * be generated, false otherwise. The default value is {@code false} if this was never set.
8604 */
8605 public boolean getHintContentIntentLaunchesActivity() {
8606 return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0;
8607 }
8608
Nadia Benbernou948627e2016-04-14 14:41:08 -04008609 /**
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008610 * Sets the dismissal id for this notification. If a notification is posted with a
8611 * dismissal id, then when that notification is canceled, notifications on other wearables
8612 * and the paired Android phone having that same dismissal id will also be canceled. See
Nadia Benbernou948627e2016-04-14 14:41:08 -04008613 * <a href="{@docRoot}wear/notifications/index.html">Adding Wearable Features to
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008614 * Notifications</a> for more information.
Nadia Benbernou948627e2016-04-14 14:41:08 -04008615 * @param dismissalId the dismissal id of the notification.
8616 * @return this object for method chaining
8617 */
8618 public WearableExtender setDismissalId(String dismissalId) {
8619 mDismissalId = dismissalId;
8620 return this;
8621 }
8622
8623 /**
8624 * Returns the dismissal id of the notification.
8625 * @return the dismissal id of the notification or null if it has not been set.
8626 */
8627 public String getDismissalId() {
8628 return mDismissalId;
8629 }
8630
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008631 /**
8632 * Sets a bridge tag for this notification. A bridge tag can be set for notifications
8633 * posted from a phone to provide finer-grained control on what notifications are bridged
8634 * to wearables. See <a href="{@docRoot}wear/notifications/index.html">Adding Wearable
8635 * Features to Notifications</a> for more information.
8636 * @param bridgeTag the bridge tag of the notification.
8637 * @return this object for method chaining
8638 */
8639 public WearableExtender setBridgeTag(String bridgeTag) {
8640 mBridgeTag = bridgeTag;
8641 return this;
8642 }
8643
8644 /**
8645 * Returns the bridge tag of the notification.
8646 * @return the bridge tag or null if not present.
8647 */
8648 public String getBridgeTag() {
8649 return mBridgeTag;
8650 }
8651
Griff Hazen61a9e862014-05-22 16:05:19 -07008652 private void setFlag(int mask, boolean value) {
8653 if (value) {
8654 mFlags |= mask;
8655 } else {
8656 mFlags &= ~mask;
8657 }
8658 }
8659 }
8660
8661 /**
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008662 * <p>Helper class to add Android Auto extensions to notifications. To create a notification
8663 * with car extensions:
8664 *
8665 * <ol>
8666 * <li>Create an {@link Notification.Builder}, setting any desired
8667 * properties.
8668 * <li>Create a {@link CarExtender}.
8669 * <li>Set car-specific properties using the {@code add} and {@code set} methods of
8670 * {@link CarExtender}.
8671 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
8672 * to apply the extensions to a notification.
8673 * </ol>
8674 *
8675 * <pre class="prettyprint">
8676 * Notification notification = new Notification.Builder(context)
8677 * ...
8678 * .extend(new CarExtender()
8679 * .set*(...))
8680 * .build();
8681 * </pre>
8682 *
8683 * <p>Car extensions can be accessed on an existing notification by using the
8684 * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods
8685 * to access values.
8686 */
8687 public static final class CarExtender implements Extender {
8688 private static final String TAG = "CarExtender";
8689
8690 private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS";
8691 private static final String EXTRA_LARGE_ICON = "large_icon";
8692 private static final String EXTRA_CONVERSATION = "car_conversation";
8693 private static final String EXTRA_COLOR = "app_color";
8694
8695 private Bitmap mLargeIcon;
8696 private UnreadConversation mUnreadConversation;
8697 private int mColor = Notification.COLOR_DEFAULT;
8698
8699 /**
8700 * Create a {@link CarExtender} with default options.
8701 */
8702 public CarExtender() {
8703 }
8704
8705 /**
8706 * Create a {@link CarExtender} from the CarExtender options of an existing Notification.
8707 *
8708 * @param notif The notification from which to copy options.
8709 */
8710 public CarExtender(Notification notif) {
8711 Bundle carBundle = notif.extras == null ?
8712 null : notif.extras.getBundle(EXTRA_CAR_EXTENDER);
8713 if (carBundle != null) {
8714 mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON);
8715 mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT);
8716
8717 Bundle b = carBundle.getBundle(EXTRA_CONVERSATION);
8718 mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b);
8719 }
8720 }
8721
8722 /**
8723 * Apply car extensions to a notification that is being built. This is typically called by
8724 * the {@link Notification.Builder#extend(Notification.Extender)}
8725 * method of {@link Notification.Builder}.
8726 */
8727 @Override
8728 public Notification.Builder extend(Notification.Builder builder) {
8729 Bundle carExtensions = new Bundle();
8730
8731 if (mLargeIcon != null) {
8732 carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon);
8733 }
8734 if (mColor != Notification.COLOR_DEFAULT) {
8735 carExtensions.putInt(EXTRA_COLOR, mColor);
8736 }
8737
8738 if (mUnreadConversation != null) {
8739 Bundle b = mUnreadConversation.getBundleForUnreadConversation();
8740 carExtensions.putBundle(EXTRA_CONVERSATION, b);
8741 }
8742
8743 builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions);
8744 return builder;
8745 }
8746
8747 /**
8748 * Sets the accent color to use when Android Auto presents the notification.
8749 *
8750 * Android Auto uses the color set with {@link Notification.Builder#setColor(int)}
8751 * to accent the displayed notification. However, not all colors are acceptable in an
8752 * automotive setting. This method can be used to override the color provided in the
8753 * notification in such a situation.
8754 */
Tor Norbye80756e32015-03-02 09:39:27 -08008755 public CarExtender setColor(@ColorInt int color) {
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008756 mColor = color;
8757 return this;
8758 }
8759
8760 /**
8761 * Gets the accent color.
8762 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04008763 * @see #setColor
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008764 */
Tor Norbye80756e32015-03-02 09:39:27 -08008765 @ColorInt
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008766 public int getColor() {
8767 return mColor;
8768 }
8769
8770 /**
8771 * Sets the large icon of the car notification.
8772 *
8773 * If no large icon is set in the extender, Android Auto will display the icon
8774 * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)}
8775 *
8776 * @param largeIcon The large icon to use in the car notification.
8777 * @return This object for method chaining.
8778 */
8779 public CarExtender setLargeIcon(Bitmap largeIcon) {
8780 mLargeIcon = largeIcon;
8781 return this;
8782 }
8783
8784 /**
8785 * Gets the large icon used in this car notification, or null if no icon has been set.
8786 *
8787 * @return The large icon for the car notification.
8788 * @see CarExtender#setLargeIcon
8789 */
8790 public Bitmap getLargeIcon() {
8791 return mLargeIcon;
8792 }
8793
8794 /**
8795 * Sets the unread conversation in a message notification.
8796 *
8797 * @param unreadConversation The unread part of the conversation this notification conveys.
8798 * @return This object for method chaining.
8799 */
8800 public CarExtender setUnreadConversation(UnreadConversation unreadConversation) {
8801 mUnreadConversation = unreadConversation;
8802 return this;
8803 }
8804
8805 /**
8806 * Returns the unread conversation conveyed by this notification.
8807 * @see #setUnreadConversation(UnreadConversation)
8808 */
8809 public UnreadConversation getUnreadConversation() {
8810 return mUnreadConversation;
8811 }
8812
8813 /**
8814 * A class which holds the unread messages from a conversation.
8815 */
8816 public static class UnreadConversation {
8817 private static final String KEY_AUTHOR = "author";
8818 private static final String KEY_TEXT = "text";
8819 private static final String KEY_MESSAGES = "messages";
8820 private static final String KEY_REMOTE_INPUT = "remote_input";
8821 private static final String KEY_ON_REPLY = "on_reply";
8822 private static final String KEY_ON_READ = "on_read";
8823 private static final String KEY_PARTICIPANTS = "participants";
8824 private static final String KEY_TIMESTAMP = "timestamp";
8825
8826 private final String[] mMessages;
8827 private final RemoteInput mRemoteInput;
8828 private final PendingIntent mReplyPendingIntent;
8829 private final PendingIntent mReadPendingIntent;
8830 private final String[] mParticipants;
8831 private final long mLatestTimestamp;
8832
8833 UnreadConversation(String[] messages, RemoteInput remoteInput,
8834 PendingIntent replyPendingIntent, PendingIntent readPendingIntent,
8835 String[] participants, long latestTimestamp) {
8836 mMessages = messages;
8837 mRemoteInput = remoteInput;
8838 mReadPendingIntent = readPendingIntent;
8839 mReplyPendingIntent = replyPendingIntent;
8840 mParticipants = participants;
8841 mLatestTimestamp = latestTimestamp;
8842 }
8843
8844 /**
8845 * Gets the list of messages conveyed by this notification.
8846 */
8847 public String[] getMessages() {
8848 return mMessages;
8849 }
8850
8851 /**
8852 * Gets the remote input that will be used to convey the response to a message list, or
8853 * null if no such remote input exists.
8854 */
8855 public RemoteInput getRemoteInput() {
8856 return mRemoteInput;
8857 }
8858
8859 /**
8860 * Gets the pending intent that will be triggered when the user replies to this
8861 * notification.
8862 */
8863 public PendingIntent getReplyPendingIntent() {
8864 return mReplyPendingIntent;
8865 }
8866
8867 /**
8868 * Gets the pending intent that Android Auto will send after it reads aloud all messages
8869 * in this object's message list.
8870 */
8871 public PendingIntent getReadPendingIntent() {
8872 return mReadPendingIntent;
8873 }
8874
8875 /**
8876 * Gets the participants in the conversation.
8877 */
8878 public String[] getParticipants() {
8879 return mParticipants;
8880 }
8881
8882 /**
8883 * Gets the firs participant in the conversation.
8884 */
8885 public String getParticipant() {
8886 return mParticipants.length > 0 ? mParticipants[0] : null;
8887 }
8888
8889 /**
8890 * Gets the timestamp of the conversation.
8891 */
8892 public long getLatestTimestamp() {
8893 return mLatestTimestamp;
8894 }
8895
8896 Bundle getBundleForUnreadConversation() {
8897 Bundle b = new Bundle();
8898 String author = null;
8899 if (mParticipants != null && mParticipants.length > 1) {
8900 author = mParticipants[0];
8901 }
8902 Parcelable[] messages = new Parcelable[mMessages.length];
8903 for (int i = 0; i < messages.length; i++) {
8904 Bundle m = new Bundle();
8905 m.putString(KEY_TEXT, mMessages[i]);
8906 m.putString(KEY_AUTHOR, author);
8907 messages[i] = m;
8908 }
8909 b.putParcelableArray(KEY_MESSAGES, messages);
8910 if (mRemoteInput != null) {
8911 b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput);
8912 }
8913 b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent);
8914 b.putParcelable(KEY_ON_READ, mReadPendingIntent);
8915 b.putStringArray(KEY_PARTICIPANTS, mParticipants);
8916 b.putLong(KEY_TIMESTAMP, mLatestTimestamp);
8917 return b;
8918 }
8919
8920 static UnreadConversation getUnreadConversationFromBundle(Bundle b) {
8921 if (b == null) {
8922 return null;
8923 }
8924 Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES);
8925 String[] messages = null;
8926 if (parcelableMessages != null) {
8927 String[] tmp = new String[parcelableMessages.length];
8928 boolean success = true;
8929 for (int i = 0; i < tmp.length; i++) {
8930 if (!(parcelableMessages[i] instanceof Bundle)) {
8931 success = false;
8932 break;
8933 }
8934 tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT);
8935 if (tmp[i] == null) {
8936 success = false;
8937 break;
8938 }
8939 }
8940 if (success) {
8941 messages = tmp;
8942 } else {
8943 return null;
8944 }
8945 }
8946
8947 PendingIntent onRead = b.getParcelable(KEY_ON_READ);
8948 PendingIntent onReply = b.getParcelable(KEY_ON_REPLY);
8949
8950 RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT);
8951
8952 String[] participants = b.getStringArray(KEY_PARTICIPANTS);
8953 if (participants == null || participants.length != 1) {
8954 return null;
8955 }
8956
8957 return new UnreadConversation(messages,
8958 remoteInput,
8959 onReply,
8960 onRead,
8961 participants, b.getLong(KEY_TIMESTAMP));
8962 }
8963 };
8964
8965 /**
8966 * Builder class for {@link CarExtender.UnreadConversation} objects.
8967 */
8968 public static class Builder {
8969 private final List<String> mMessages = new ArrayList<String>();
8970 private final String mParticipant;
8971 private RemoteInput mRemoteInput;
8972 private PendingIntent mReadPendingIntent;
8973 private PendingIntent mReplyPendingIntent;
8974 private long mLatestTimestamp;
8975
8976 /**
8977 * Constructs a new builder for {@link CarExtender.UnreadConversation}.
8978 *
8979 * @param name The name of the other participant in the conversation.
8980 */
8981 public Builder(String name) {
8982 mParticipant = name;
8983 }
8984
8985 /**
8986 * Appends a new unread message to the list of messages for this conversation.
8987 *
8988 * The messages should be added from oldest to newest.
8989 *
8990 * @param message The text of the new unread message.
8991 * @return This object for method chaining.
8992 */
8993 public Builder addMessage(String message) {
8994 mMessages.add(message);
8995 return this;
8996 }
8997
8998 /**
8999 * Sets the pending intent and remote input which will convey the reply to this
9000 * notification.
9001 *
9002 * @param pendingIntent The pending intent which will be triggered on a reply.
9003 * @param remoteInput The remote input parcelable which will carry the reply.
9004 * @return This object for method chaining.
9005 *
9006 * @see CarExtender.UnreadConversation#getRemoteInput
9007 * @see CarExtender.UnreadConversation#getReplyPendingIntent
9008 */
9009 public Builder setReplyAction(
9010 PendingIntent pendingIntent, RemoteInput remoteInput) {
9011 mRemoteInput = remoteInput;
9012 mReplyPendingIntent = pendingIntent;
9013
9014 return this;
9015 }
9016
9017 /**
9018 * Sets the pending intent that will be sent once the messages in this notification
9019 * are read.
9020 *
9021 * @param pendingIntent The pending intent to use.
9022 * @return This object for method chaining.
9023 */
9024 public Builder setReadPendingIntent(PendingIntent pendingIntent) {
9025 mReadPendingIntent = pendingIntent;
9026 return this;
9027 }
9028
9029 /**
9030 * Sets the timestamp of the most recent message in an unread conversation.
9031 *
9032 * If a messaging notification has been posted by your application and has not
9033 * yet been cancelled, posting a later notification with the same id and tag
9034 * but without a newer timestamp may result in Android Auto not displaying a
9035 * heads up notification for the later notification.
9036 *
9037 * @param timestamp The timestamp of the most recent message in the conversation.
9038 * @return This object for method chaining.
9039 */
9040 public Builder setLatestTimestamp(long timestamp) {
9041 mLatestTimestamp = timestamp;
9042 return this;
9043 }
9044
9045 /**
9046 * Builds a new unread conversation object.
9047 *
9048 * @return The new unread conversation object.
9049 */
9050 public UnreadConversation build() {
9051 String[] messages = mMessages.toArray(new String[mMessages.size()]);
9052 String[] participants = { mParticipant };
9053 return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent,
9054 mReadPendingIntent, participants, mLatestTimestamp);
9055 }
9056 }
9057 }
9058
9059 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009060 * <p>Helper class to add Android TV extensions to notifications. To create a notification
9061 * with a TV extension:
9062 *
9063 * <ol>
9064 * <li>Create an {@link Notification.Builder}, setting any desired properties.
9065 * <li>Create a {@link TvExtender}.
9066 * <li>Set TV-specific properties using the {@code set} methods of
9067 * {@link TvExtender}.
9068 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
9069 * to apply the extension to a notification.
9070 * </ol>
9071 *
9072 * <pre class="prettyprint">
9073 * Notification notification = new Notification.Builder(context)
9074 * ...
9075 * .extend(new TvExtender()
9076 * .set*(...))
9077 * .build();
9078 * </pre>
9079 *
9080 * <p>TV extensions can be accessed on an existing notification by using the
9081 * {@code TvExtender(Notification)} constructor, and then using the {@code get} methods
9082 * to access values.
9083 *
9084 * @hide
9085 */
9086 @SystemApi
9087 public static final class TvExtender implements Extender {
9088 private static final String TAG = "TvExtender";
9089
9090 private static final String EXTRA_TV_EXTENDER = "android.tv.EXTENSIONS";
9091 private static final String EXTRA_FLAGS = "flags";
9092 private static final String EXTRA_CONTENT_INTENT = "content_intent";
9093 private static final String EXTRA_DELETE_INTENT = "delete_intent";
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009094 private static final String EXTRA_CHANNEL_ID = "channel_id";
Rhiannon Malia1a083932018-01-24 15:02:30 -08009095 private static final String EXTRA_SUPPRESS_SHOW_OVER_APPS = "suppressShowOverApps";
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009096
9097 // Flags bitwise-ored to mFlags
9098 private static final int FLAG_AVAILABLE_ON_TV = 0x1;
9099
9100 private int mFlags;
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009101 private String mChannelId;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009102 private PendingIntent mContentIntent;
9103 private PendingIntent mDeleteIntent;
Rhiannon Malia1a083932018-01-24 15:02:30 -08009104 private boolean mSuppressShowOverApps;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009105
9106 /**
9107 * Create a {@link TvExtender} with default options.
9108 */
9109 public TvExtender() {
9110 mFlags = FLAG_AVAILABLE_ON_TV;
9111 }
9112
9113 /**
9114 * Create a {@link TvExtender} from the TvExtender options of an existing Notification.
9115 *
9116 * @param notif The notification from which to copy options.
9117 */
9118 public TvExtender(Notification notif) {
9119 Bundle bundle = notif.extras == null ?
9120 null : notif.extras.getBundle(EXTRA_TV_EXTENDER);
9121 if (bundle != null) {
9122 mFlags = bundle.getInt(EXTRA_FLAGS);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009123 mChannelId = bundle.getString(EXTRA_CHANNEL_ID);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009124 mSuppressShowOverApps = bundle.getBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009125 mContentIntent = bundle.getParcelable(EXTRA_CONTENT_INTENT);
9126 mDeleteIntent = bundle.getParcelable(EXTRA_DELETE_INTENT);
9127 }
9128 }
9129
9130 /**
9131 * Apply a TV extension to a notification that is being built. This is typically called by
9132 * the {@link Notification.Builder#extend(Notification.Extender)}
9133 * method of {@link Notification.Builder}.
9134 */
9135 @Override
9136 public Notification.Builder extend(Notification.Builder builder) {
9137 Bundle bundle = new Bundle();
9138
9139 bundle.putInt(EXTRA_FLAGS, mFlags);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009140 bundle.putString(EXTRA_CHANNEL_ID, mChannelId);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009141 bundle.putBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS, mSuppressShowOverApps);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009142 if (mContentIntent != null) {
9143 bundle.putParcelable(EXTRA_CONTENT_INTENT, mContentIntent);
9144 }
9145
9146 if (mDeleteIntent != null) {
9147 bundle.putParcelable(EXTRA_DELETE_INTENT, mDeleteIntent);
9148 }
9149
9150 builder.getExtras().putBundle(EXTRA_TV_EXTENDER, bundle);
9151 return builder;
9152 }
9153
9154 /**
9155 * Returns true if this notification should be shown on TV. This method return true
9156 * if the notification was extended with a TvExtender.
9157 */
9158 public boolean isAvailableOnTv() {
9159 return (mFlags & FLAG_AVAILABLE_ON_TV) != 0;
9160 }
9161
9162 /**
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009163 * Specifies the channel the notification should be delivered on when shown on TV.
9164 * It can be different from the channel that the notification is delivered to when
9165 * posting on a non-TV device.
9166 */
9167 public TvExtender setChannel(String channelId) {
9168 mChannelId = channelId;
9169 return this;
9170 }
9171
9172 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009173 * Specifies the channel the notification should be delivered on when shown on TV.
9174 * It can be different from the channel that the notification is delivered to when
9175 * posting on a non-TV device.
9176 */
9177 public TvExtender setChannelId(String channelId) {
9178 mChannelId = channelId;
9179 return this;
9180 }
9181
Jeff Sharkey000ce802017-04-29 13:13:27 -06009182 /** @removed */
9183 @Deprecated
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009184 public String getChannel() {
9185 return mChannelId;
9186 }
9187
9188 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009189 * Returns the id of the channel this notification posts to on TV.
9190 */
9191 public String getChannelId() {
9192 return mChannelId;
9193 }
9194
9195 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009196 * Supplies a {@link PendingIntent} to be sent when the notification is selected on TV.
9197 * If provided, it is used instead of the content intent specified
9198 * at the level of Notification.
9199 */
9200 public TvExtender setContentIntent(PendingIntent intent) {
9201 mContentIntent = intent;
9202 return this;
9203 }
9204
9205 /**
9206 * Returns the TV-specific content intent. If this method returns null, the
9207 * main content intent on the notification should be used.
9208 *
9209 * @see {@link Notification#contentIntent}
9210 */
9211 public PendingIntent getContentIntent() {
9212 return mContentIntent;
9213 }
9214
9215 /**
9216 * Supplies a {@link PendingIntent} to send when the notification is cleared explicitly
9217 * by the user on TV. If provided, it is used instead of the delete intent specified
9218 * at the level of Notification.
9219 */
9220 public TvExtender setDeleteIntent(PendingIntent intent) {
9221 mDeleteIntent = intent;
9222 return this;
9223 }
9224
9225 /**
9226 * Returns the TV-specific delete intent. If this method returns null, the
9227 * main delete intent on the notification should be used.
9228 *
9229 * @see {@link Notification#deleteIntent}
9230 */
9231 public PendingIntent getDeleteIntent() {
9232 return mDeleteIntent;
9233 }
Rhiannon Malia1a083932018-01-24 15:02:30 -08009234
9235 /**
9236 * Specifies whether this notification should suppress showing a message over top of apps
9237 * outside of the launcher.
9238 */
9239 public TvExtender setSuppressShowOverApps(boolean suppress) {
9240 mSuppressShowOverApps = suppress;
9241 return this;
9242 }
9243
9244 /**
9245 * Returns true if this notification should not show messages over top of apps
9246 * outside of the launcher.
9247 */
9248 public boolean getSuppressShowOverApps() {
9249 return mSuppressShowOverApps;
9250 }
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009251 }
9252
9253 /**
Griff Hazen61a9e862014-05-22 16:05:19 -07009254 * Get an array of Notification objects from a parcelable array bundle field.
9255 * Update the bundle to have a typed array so fetches in the future don't need
9256 * to do an array copy.
9257 */
9258 private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) {
9259 Parcelable[] array = bundle.getParcelableArray(key);
9260 if (array instanceof Notification[] || array == null) {
9261 return (Notification[]) array;
9262 }
9263 Notification[] typedArray = Arrays.copyOf(array, array.length,
9264 Notification[].class);
9265 bundle.putParcelableArray(key, typedArray);
9266 return typedArray;
9267 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02009268
9269 private static class BuilderRemoteViews extends RemoteViews {
9270 public BuilderRemoteViews(Parcel parcel) {
9271 super(parcel);
9272 }
9273
Kenny Guy77320062014-08-27 21:37:15 +01009274 public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) {
9275 super(appInfo, layoutId);
Christoph Studer4600f9b2014-07-22 22:44:43 +02009276 }
9277
9278 @Override
9279 public BuilderRemoteViews clone() {
9280 Parcel p = Parcel.obtain();
9281 writeToParcel(p, 0);
9282 p.setDataPosition(0);
9283 BuilderRemoteViews brv = new BuilderRemoteViews(p);
9284 p.recycle();
9285 return brv;
9286 }
9287 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08009288
9289 private static class StandardTemplateParams {
9290 boolean hasProgress = true;
9291 boolean ambient = false;
9292 CharSequence title;
9293 CharSequence text;
Selim Cinekafeed292017-12-12 17:32:44 -08009294 CharSequence headerTextSecondary;
Selim Cinek88188f22017-09-19 16:46:56 -07009295 boolean hideLargeIcon;
9296 public boolean alwaysShowReply;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009297
9298 final StandardTemplateParams reset() {
9299 hasProgress = true;
9300 ambient = false;
9301 title = null;
9302 text = null;
Selim Cinekafeed292017-12-12 17:32:44 -08009303 headerTextSecondary = null;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009304 return this;
9305 }
9306
9307 final StandardTemplateParams hasProgress(boolean hasProgress) {
9308 this.hasProgress = hasProgress;
9309 return this;
9310 }
9311
9312 final StandardTemplateParams title(CharSequence title) {
9313 this.title = title;
9314 return this;
9315 }
9316
9317 final StandardTemplateParams text(CharSequence text) {
9318 this.text = text;
9319 return this;
9320 }
9321
Selim Cinekafeed292017-12-12 17:32:44 -08009322 final StandardTemplateParams headerTextSecondary(CharSequence text) {
9323 this.headerTextSecondary = text;
9324 return this;
9325 }
9326
Selim Cinek88188f22017-09-19 16:46:56 -07009327 final StandardTemplateParams alwaysShowReply(boolean alwaysShowReply) {
9328 this.alwaysShowReply = alwaysShowReply;
9329 return this;
9330 }
9331
9332 final StandardTemplateParams hideLargeIcon(boolean hideLargeIcon) {
9333 this.hideLargeIcon = hideLargeIcon;
9334 return this;
9335 }
9336
Adrian Roos70d7aa32017-01-11 15:39:06 -08009337 final StandardTemplateParams ambient(boolean ambient) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08009338 Preconditions.checkState(title == null && text == null, "must set ambient before text");
Adrian Roos70d7aa32017-01-11 15:39:06 -08009339 this.ambient = ambient;
9340 return this;
9341 }
9342
9343 final StandardTemplateParams fillTextsFrom(Builder b) {
9344 Bundle extras = b.mN.extras;
Lucas Dupin06c5e642017-09-13 16:34:58 -07009345 this.title = b.processLegacyText(extras.getCharSequence(EXTRA_TITLE), ambient);
9346
9347 // Big text notifications should contain their content when viewed in ambient mode.
9348 CharSequence text = extras.getCharSequence(EXTRA_BIG_TEXT);
9349 if (!ambient || TextUtils.isEmpty(text)) {
9350 text = extras.getCharSequence(EXTRA_TEXT);
9351 }
9352 this.text = b.processLegacyText(text, ambient);
Adrian Roos70d7aa32017-01-11 15:39:06 -08009353 return this;
9354 }
9355 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009356}