blob: 1ea93a4191130bb6bd060efbbdf96dcc6b95e373 [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;
Jeff Sharkey23b31182018-04-18 21:32:12 -060094import java.util.function.Consumer;
Joe Onorato561d3852010-11-20 18:09:34 -080095
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080096/**
97 * A class that represents how a persistent notification is to be presented to
98 * the user using the {@link android.app.NotificationManager}.
99 *
Joe Onoratocb109a02011-01-18 17:57:41 -0800100 * <p>The {@link Notification.Builder Notification.Builder} has been added to make it
101 * easier to construct Notifications.</p>
102 *
Joe Fernandez558459f2011-10-13 16:47:36 -0700103 * <div class="special reference">
104 * <h3>Developer Guides</h3>
105 * <p>For a guide to creating notifications, read the
106 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Status Bar Notifications</a>
107 * developer guide.</p>
108 * </div>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800109 */
110public class Notification implements Parcelable
111{
Daniel Sandlerdcbaf662013-04-26 16:23:09 -0400112 private static final String TAG = "Notification";
113
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800114 /**
Daniel Sandler01df1c62014-06-09 10:54:01 -0400115 * An activity that provides a user interface for adjusting notification preferences for its
Julia Reynolds3aedded2017-03-31 14:42:09 -0400116 * containing application.
Daniel Sandler01df1c62014-06-09 10:54:01 -0400117 */
118 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
119 public static final String INTENT_CATEGORY_NOTIFICATION_PREFERENCES
120 = "android.intent.category.NOTIFICATION_PREFERENCES";
121
122 /**
Julia Reynolds2619b5e2017-02-09 09:58:15 -0500123 * Optional extra for {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}. If provided, will
124 * contain a {@link NotificationChannel#getId() channel id} that can be used to narrow down
Julia Reynolds3aedded2017-03-31 14:42:09 -0400125 * what settings should be shown in the target app.
Julia Reynolds2619b5e2017-02-09 09:58:15 -0500126 */
127 public static final String EXTRA_CHANNEL_ID = "android.intent.extra.CHANNEL_ID";
128
129 /**
Julia Reynolds3aedded2017-03-31 14:42:09 -0400130 * Optional extra for {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}. If provided, will
Julia Reynolds005c8b92017-08-24 10:35:53 -0400131 * contain a {@link NotificationChannelGroup#getId() group id} that can be used to narrow down
132 * what settings should be shown in the target app.
133 */
134 public static final String EXTRA_CHANNEL_GROUP_ID = "android.intent.extra.CHANNEL_GROUP_ID";
135
136 /**
137 * Optional extra for {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}. If provided, will
Julia Reynolds3aedded2017-03-31 14:42:09 -0400138 * contain the tag provided to {@link NotificationManager#notify(String, int, Notification)}
139 * that can be used to narrow down what settings should be shown in the target app.
140 */
141 public static final String EXTRA_NOTIFICATION_TAG = "android.intent.extra.NOTIFICATION_TAG";
142
143 /**
144 * Optional extra for {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}. If provided, will
145 * contain the id provided to {@link NotificationManager#notify(String, int, Notification)}
146 * that can be used to narrow down what settings should be shown in the target app.
147 */
148 public static final String EXTRA_NOTIFICATION_ID = "android.intent.extra.NOTIFICATION_ID";
149
150 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800151 * Use all default values (where applicable).
152 */
153 public static final int DEFAULT_ALL = ~0;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500154
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800155 /**
156 * Use the default notification sound. This will ignore any given
157 * {@link #sound}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500158 *
Chris Wren47c20a12014-06-18 17:27:29 -0400159 * <p>
160 * A notification that is noisy is more likely to be presented as a heads-up notification.
161 * </p>
162 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800163 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500164 */
165
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800166 public static final int DEFAULT_SOUND = 1;
167
168 /**
169 * Use the default notification vibrate. This will ignore any given
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500170 * {@link #vibrate}. Using phone vibration requires the
Scott Mainb8b36452009-04-26 15:50:49 -0700171 * {@link android.Manifest.permission#VIBRATE VIBRATE} permission.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500172 *
Chris Wren47c20a12014-06-18 17:27:29 -0400173 * <p>
174 * A notification that vibrates is more likely to be presented as a heads-up notification.
175 * </p>
176 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800177 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500178 */
179
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800180 public static final int DEFAULT_VIBRATE = 2;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500181
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800182 /**
183 * Use the default notification lights. This will ignore the
184 * {@link #FLAG_SHOW_LIGHTS} bit, and {@link #ledARGB}, {@link #ledOffMS}, or
185 * {@link #ledOnMS}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500186 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800187 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500188 */
189
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800190 public static final int DEFAULT_LIGHTS = 4;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500191
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800192 /**
Christoph Studer535ec612014-09-03 15:47:47 +0200193 * Maximum length of CharSequences accepted by Builder and friends.
194 *
195 * <p>
196 * Avoids spamming the system with overly large strings such as full e-mails.
197 */
198 private static final int MAX_CHARSEQUENCE_LENGTH = 5 * 1024;
199
200 /**
Adrian Roose458aa82015-12-08 16:17:19 -0800201 * Maximum entries of reply text that are accepted by Builder and friends.
202 */
203 private static final int MAX_REPLY_HISTORY = 5;
204
Selim Cinekde4de0e2018-01-24 16:21:07 -0800205
206 /**
207 * If the notification contained an unsent draft for a RemoteInput when the user clicked on it,
208 * we're adding the draft as a String extra to the {@link #contentIntent} using this key.
209 *
210 * <p>Apps may use this extra to prepopulate text fields in the app, where the user usually
211 * sends messages.</p>
212 */
213 public static final String EXTRA_REMOTE_INPUT_DRAFT = "android.remoteInputDraft";
214
Adrian Roose458aa82015-12-08 16:17:19 -0800215 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500216 * A timestamp related to this notification, in milliseconds since the epoch.
Joe Malin8d40d042012-11-05 11:36:40 -0800217 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500218 * Default value: {@link System#currentTimeMillis() Now}.
219 *
220 * Choose a timestamp that will be most relevant to the user. For most finite events, this
221 * corresponds to the time the event happened (or will happen, in the case of events that have
222 * yet to occur but about which the user is being informed). Indefinite events should be
Joe Malin8d40d042012-11-05 11:36:40 -0800223 * timestamped according to when the activity began.
224 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500225 * Some examples:
Joe Malin8d40d042012-11-05 11:36:40 -0800226 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500227 * <ul>
228 * <li>Notification of a new chat message should be stamped when the message was received.</li>
229 * <li>Notification of an ongoing file download (with a progress bar, for example) should be stamped when the download started.</li>
230 * <li>Notification of a completed file download should be stamped when the download finished.</li>
231 * <li>Notification of an upcoming meeting should be stamped with the time the meeting will begin (that is, in the future).</li>
232 * <li>Notification of an ongoing stopwatch (increasing timer) should be stamped with the watch's start time.
233 * <li>Notification of an ongoing countdown timer should be stamped with the timer's end time.
Joe Malin8d40d042012-11-05 11:36:40 -0800234 * </ul>
235 *
Selim Cinek0ff1ce602016-04-05 18:27:16 -0700236 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not shown
237 * anymore by default and must be opted into by using
238 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800239 */
240 public long when;
241
242 /**
Selim Cinekb85f36fd2016-04-20 18:46:36 -0700243 * The creation time of the notification
244 */
245 private long creationTime;
246
247 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800248 * The resource id of a drawable to use as the icon in the status bar.
Dan Sandler86647982015-05-13 23:41:13 -0400249 *
250 * @deprecated Use {@link Builder#setSmallIcon(Icon)} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800251 */
Dan Sandler86647982015-05-13 23:41:13 -0400252 @Deprecated
Tor Norbye7b9c9122013-05-30 16:48:33 -0700253 @DrawableRes
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800254 public int icon;
255
256 /**
Joe Onorato46439ce2010-11-19 13:56:21 -0800257 * If the icon in the status bar is to have more than one level, you can set this. Otherwise,
258 * leave it at its default value of 0.
259 *
260 * @see android.widget.ImageView#setImageLevel
Griff Hazen959591e2014-05-15 22:26:18 -0700261 * @see android.graphics.drawable.Drawable#setLevel
Joe Onorato46439ce2010-11-19 13:56:21 -0800262 */
263 public int iconLevel;
264
265 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500266 * The number of events that this notification represents. For example, in a new mail
267 * notification, this could be the number of unread messages.
Joe Malin8d40d042012-11-05 11:36:40 -0800268 *
Julia Reynolds30331982017-04-27 10:12:50 -0400269 * The system may or may not use this field to modify the appearance of the notification.
Julia Reynolds13d898c2017-02-02 12:22:05 -0500270 * Starting with {@link android.os.Build.VERSION_CODES#O}, the number may be displayed as a
271 * badge icon in Launchers that support badging.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800272 */
Julia Reynolds30331982017-04-27 10:12:50 -0400273 public int number = 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800274
275 /**
276 * The intent to execute when the expanded status entry is clicked. If
277 * this is an activity, it must include the
278 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -0800279 * that you take care of task management as described in the
280 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
Dianne Hackborn6ceca582012-01-10 15:24:26 -0800281 * Stack</a> document. In particular, make sure to read the notification section
282 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html#HandlingNotifications">Handling
283 * Notifications</a> for the correct ways to launch an application from a
284 * notification.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800285 */
286 public PendingIntent contentIntent;
287
288 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500289 * The intent to execute when the notification is explicitly dismissed by the user, either with
290 * the "Clear All" button or by swiping it away individually.
291 *
292 * This probably shouldn't be launching an activity since several of those will be sent
293 * at the same time.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800294 */
295 public PendingIntent deleteIntent;
296
297 /**
Dianne Hackborn170bae72010-09-03 15:14:28 -0700298 * An intent to launch instead of posting the notification to the status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -0800299 *
Chris Wren47c20a12014-06-18 17:27:29 -0400300 * <p>
301 * The system UI may choose to display a heads-up notification, instead of
302 * launching this intent, while the user is using the device.
303 * </p>
304 *
Joe Onoratocb109a02011-01-18 17:57:41 -0800305 * @see Notification.Builder#setFullScreenIntent
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400306 */
307 public PendingIntent fullScreenIntent;
308
309 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400310 * Text that summarizes this notification for accessibility services.
311 *
312 * As of the L release, this text is no longer shown on screen, but it is still useful to
313 * accessibility services (where it serves as an audible announcement of the notification's
314 * appearance).
Joe Onoratoef1e7762010-09-17 18:38:38 -0400315 *
Joe Onorato46439ce2010-11-19 13:56:21 -0800316 * @see #tickerView
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800317 */
318 public CharSequence tickerText;
319
320 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400321 * Formerly, a view showing the {@link #tickerText}.
322 *
323 * No longer displayed in the status bar as of API 21.
Joe Onoratoef1e7762010-09-17 18:38:38 -0400324 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400325 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -0800326 public RemoteViews tickerView;
Joe Onoratoef1e7762010-09-17 18:38:38 -0400327
328 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400329 * The view that will represent this notification in the notification list (which is pulled
330 * down from the status bar).
331 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500332 * As of N, this field may be null. The notification view is determined by the inputs
333 * to {@link Notification.Builder}; a custom RemoteViews can optionally be
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400334 * supplied with {@link Notification.Builder#setCustomContentView(RemoteViews)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800335 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400336 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800337 public RemoteViews contentView;
338
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400339 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -0400340 * A large-format version of {@link #contentView}, giving the Notification an
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400341 * opportunity to show more detail. The system UI may choose to show this
342 * instead of the normal content view at its discretion.
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400343 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500344 * As of N, this field may be null. The expanded notification view is determined by the
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400345 * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
346 * supplied with {@link Notification.Builder#setCustomBigContentView(RemoteViews)}.
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400347 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400348 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400349 public RemoteViews bigContentView;
350
Chris Wren8fd39ec2014-02-27 17:43:26 -0500351
352 /**
Chris Wren47c20a12014-06-18 17:27:29 -0400353 * A medium-format version of {@link #contentView}, providing the Notification an
354 * opportunity to add action buttons to contentView. At its discretion, the system UI may
355 * choose to show this as a heads-up notification, which will pop up so the user can see
356 * it without leaving their current activity.
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400357 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500358 * As of N, this field may be null. The heads-up notification view is determined by the
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400359 * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
360 * supplied with {@link Notification.Builder#setCustomHeadsUpContentView(RemoteViews)}.
Chris Wren8fd39ec2014-02-27 17:43:26 -0500361 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400362 @Deprecated
Chris Wren8fd39ec2014-02-27 17:43:26 -0500363 public RemoteViews headsUpContentView;
364
Julia Reynoldsfc640012018-02-21 12:25:27 -0500365 private boolean mUsesStandardHeader;
366
367 private static final ArraySet<Integer> STANDARD_LAYOUTS = new ArraySet<>();
368 static {
369 STANDARD_LAYOUTS.add(R.layout.notification_template_material_base);
370 STANDARD_LAYOUTS.add(R.layout.notification_template_material_big_base);
371 STANDARD_LAYOUTS.add(R.layout.notification_template_material_big_picture);
372 STANDARD_LAYOUTS.add(R.layout.notification_template_material_big_text);
373 STANDARD_LAYOUTS.add(R.layout.notification_template_material_inbox);
374 STANDARD_LAYOUTS.add(R.layout.notification_template_material_messaging);
375 STANDARD_LAYOUTS.add(R.layout.notification_template_material_media);
376 STANDARD_LAYOUTS.add(R.layout.notification_template_material_big_media);
377 STANDARD_LAYOUTS.add(R.layout.notification_template_ambient_header);
378 STANDARD_LAYOUTS.add(R.layout.notification_template_header);
379 STANDARD_LAYOUTS.add(R.layout.notification_template_material_ambient);
380 }
381
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400382 /**
Dan Sandler86647982015-05-13 23:41:13 -0400383 * A large bitmap to be shown in the notification content area.
384 *
385 * @deprecated Use {@link Builder#setLargeIcon(Icon)} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800386 */
Dan Sandler86647982015-05-13 23:41:13 -0400387 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -0800388 public Bitmap largeIcon;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800389
390 /**
391 * The sound to play.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500392 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800393 * <p>
Chris Wren47c20a12014-06-18 17:27:29 -0400394 * A notification that is noisy is more likely to be presented as a heads-up notification.
395 * </p>
396 *
397 * <p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500398 * To play the default notification sound, see {@link #defaults}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800399 * </p>
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500400 * @deprecated use {@link NotificationChannel#getSound()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800401 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500402 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800403 public Uri sound;
404
405 /**
406 * Use this constant as the value for audioStreamType to request that
407 * the default stream type for notifications be used. Currently the
Jeff Sharkey098d5802012-04-26 17:30:34 -0700408 * default stream type is {@link AudioManager#STREAM_NOTIFICATION}.
John Spurlockc0650f022014-07-19 13:22:39 -0400409 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500410 * @deprecated Use {@link NotificationChannel#getAudioAttributes()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800411 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -0700412 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800413 public static final int STREAM_DEFAULT = -1;
414
415 /**
416 * The audio stream type to use when playing the sound.
417 * Should be one of the STREAM_ constants from
418 * {@link android.media.AudioManager}.
John Spurlockc0650f022014-07-19 13:22:39 -0400419 *
420 * @deprecated Use {@link #audioAttributes} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800421 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -0700422 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800423 public int audioStreamType = STREAM_DEFAULT;
424
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800425 /**
John Spurlockc0650f022014-07-19 13:22:39 -0400426 * The default value of {@link #audioAttributes}.
427 */
428 public static final AudioAttributes AUDIO_ATTRIBUTES_DEFAULT = new AudioAttributes.Builder()
429 .setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION)
430 .setUsage(AudioAttributes.USAGE_NOTIFICATION)
431 .build();
432
433 /**
434 * The {@link AudioAttributes audio attributes} to use when playing the sound.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500435 *
436 * @deprecated use {@link NotificationChannel#getAudioAttributes()} instead.
John Spurlockc0650f022014-07-19 13:22:39 -0400437 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500438 @Deprecated
John Spurlockc0650f022014-07-19 13:22:39 -0400439 public AudioAttributes audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
440
441 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500442 * The pattern with which to vibrate.
443 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800444 * <p>
445 * To vibrate the default pattern, see {@link #defaults}.
446 * </p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500447 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800448 * @see android.os.Vibrator#vibrate(long[],int)
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500449 * @deprecated use {@link NotificationChannel#getVibrationPattern()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800450 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500451 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800452 public long[] vibrate;
453
454 /**
455 * The color of the led. The hardware will do its best approximation.
456 *
457 * @see #FLAG_SHOW_LIGHTS
458 * @see #flags
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500459 * @deprecated use {@link NotificationChannel#shouldShowLights()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800460 */
Tor Norbye80756e32015-03-02 09:39:27 -0800461 @ColorInt
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500462 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800463 public int ledARGB;
464
465 /**
466 * The number of milliseconds for the LED to be on while it's flashing.
467 * The hardware will do its best approximation.
468 *
469 * @see #FLAG_SHOW_LIGHTS
470 * @see #flags
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500471 * @deprecated use {@link NotificationChannel#shouldShowLights()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800472 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500473 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800474 public int ledOnMS;
475
476 /**
477 * The number of milliseconds for the LED to be off while it's flashing.
478 * The hardware will do its best approximation.
479 *
480 * @see #FLAG_SHOW_LIGHTS
481 * @see #flags
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500482 *
483 * @deprecated use {@link NotificationChannel#shouldShowLights()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800484 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500485 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800486 public int ledOffMS;
487
488 /**
489 * Specifies which values should be taken from the defaults.
490 * <p>
491 * To set, OR the desired from {@link #DEFAULT_SOUND},
492 * {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}. For all default
493 * values, use {@link #DEFAULT_ALL}.
494 * </p>
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500495 *
496 * @deprecated use {@link NotificationChannel#getSound()} and
497 * {@link NotificationChannel#shouldShowLights()} and
498 * {@link NotificationChannel#shouldVibrate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800499 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500500 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800501 public int defaults;
502
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800503 /**
504 * Bit to be bitwise-ored into the {@link #flags} field that should be
505 * set if you want the LED on for this notification.
506 * <ul>
507 * <li>To turn the LED off, pass 0 in the alpha channel for colorARGB
508 * or 0 for both ledOnMS and ledOffMS.</li>
509 * <li>To turn the LED on, pass 1 for ledOnMS and 0 for ledOffMS.</li>
510 * <li>To flash the LED, pass the number of milliseconds that it should
511 * be on and off to ledOnMS and ledOffMS.</li>
512 * </ul>
513 * <p>
514 * Since hardware varies, you are not guaranteed that any of the values
Ricardo Loo Forondaf8f6d0a2018-01-25 08:42:43 -0800515 * you pass are honored exactly. Use the system defaults if possible
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800516 * because they will be set to values that work on any given hardware.
517 * <p>
518 * The alpha channel must be set for forward compatibility.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500519 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500520 * @deprecated use {@link NotificationChannel#shouldShowLights()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800521 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500522 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800523 public static final int FLAG_SHOW_LIGHTS = 0x00000001;
524
525 /**
526 * Bit to be bitwise-ored into the {@link #flags} field that should be
527 * set if this notification is in reference to something that is ongoing,
528 * like a phone call. It should not be set if this notification is in
529 * reference to something that happened at a particular point in time,
530 * like a missed phone call.
531 */
532 public static final int FLAG_ONGOING_EVENT = 0x00000002;
533
534 /**
535 * Bit to be bitwise-ored into the {@link #flags} field that if set,
Scott Mainb8b36452009-04-26 15:50:49 -0700536 * the audio will be repeated until the notification is
537 * cancelled or the notification window is opened.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800538 */
539 public static final int FLAG_INSISTENT = 0x00000004;
540
541 /**
542 * Bit to be bitwise-ored into the {@link #flags} field that should be
Griff Hazen293977b2014-04-28 08:37:20 -0700543 * set if you would only like the sound, vibrate and ticker to be played
544 * if the notification was not already showing.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800545 */
546 public static final int FLAG_ONLY_ALERT_ONCE = 0x00000008;
547
548 /**
549 * Bit to be bitwise-ored into the {@link #flags} field that should be
550 * set if the notification should be canceled when it is clicked by the
Daniel Sandler8aa9ae62012-12-04 23:31:47 -0500551 * user.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800552 */
553 public static final int FLAG_AUTO_CANCEL = 0x00000010;
554
555 /**
556 * Bit to be bitwise-ored into the {@link #flags} field that should be
557 * set if the notification should not be canceled when the user clicks
558 * the Clear all button.
559 */
560 public static final int FLAG_NO_CLEAR = 0x00000020;
561
Dianne Hackbornd8a43f62009-08-17 23:33:56 -0700562 /**
563 * Bit to be bitwise-ored into the {@link #flags} field that should be
564 * set if this notification represents a currently running service. This
565 * will normally be set for you by {@link Service#startForeground}.
566 */
567 public static final int FLAG_FOREGROUND_SERVICE = 0x00000040;
568
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400569 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500570 * Obsolete flag indicating high-priority notifications; use the priority field instead.
Joe Malin8d40d042012-11-05 11:36:40 -0800571 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500572 * @deprecated Use {@link #priority} with a positive value.
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400573 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700574 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500575 public static final int FLAG_HIGH_PRIORITY = 0x00000080;
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400576
Griff Hazendfcb0802014-02-11 12:00:00 -0800577 /**
578 * Bit to be bitswise-ored into the {@link #flags} field that should be
579 * set if this notification is relevant to the current device only
580 * and it is not recommended that it bridge to other devices.
581 */
582 public static final int FLAG_LOCAL_ONLY = 0x00000100;
583
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700584 /**
585 * Bit to be bitswise-ored into the {@link #flags} field that should be
586 * set if this notification is the group summary for a group of notifications.
587 * Grouped notifications may display in a cluster or stack on devices which
588 * support such rendering. Requires a group key also be set using {@link Builder#setGroup}.
589 */
590 public static final int FLAG_GROUP_SUMMARY = 0x00000200;
591
Julia Reynoldse46bb372016-03-17 11:05:58 -0400592 /**
593 * Bit to be bitswise-ored into the {@link #flags} field that should be
594 * set if this notification is the group summary for an auto-group of notifications.
595 *
596 * @hide
597 */
598 @SystemApi
599 public static final int FLAG_AUTOGROUP_SUMMARY = 0x00000400;
600
Julia Reynolds4db59552017-06-30 13:34:01 -0400601 /**
602 * @hide
603 */
604 public static final int FLAG_CAN_COLORIZE = 0x00000800;
605
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800606 public int flags;
607
Tor Norbyed9273d62013-05-30 15:59:53 -0700608 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -0700609 @IntDef(prefix = { "PRIORITY_" }, value = {
610 PRIORITY_DEFAULT,
611 PRIORITY_LOW,
612 PRIORITY_MIN,
613 PRIORITY_HIGH,
614 PRIORITY_MAX
615 })
Tor Norbyed9273d62013-05-30 15:59:53 -0700616 @Retention(RetentionPolicy.SOURCE)
617 public @interface Priority {}
618
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800619 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500620 * Default notification {@link #priority}. If your application does not prioritize its own
621 * notifications, use this value for all notifications.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500622 *
623 * @deprecated use {@link NotificationManager#IMPORTANCE_DEFAULT} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500624 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500625 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500626 public static final int PRIORITY_DEFAULT = 0;
627
628 /**
629 * Lower {@link #priority}, for items that are less important. The UI may choose to show these
630 * items smaller, or at a different position in the list, compared with your app's
631 * {@link #PRIORITY_DEFAULT} items.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500632 *
633 * @deprecated use {@link NotificationManager#IMPORTANCE_LOW} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500634 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500635 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500636 public static final int PRIORITY_LOW = -1;
637
638 /**
639 * Lowest {@link #priority}; these items might not be shown to the user except under special
640 * circumstances, such as detailed notification logs.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500641 *
642 * @deprecated use {@link NotificationManager#IMPORTANCE_MIN} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500643 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500644 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500645 public static final int PRIORITY_MIN = -2;
646
647 /**
648 * Higher {@link #priority}, for more important notifications or alerts. The UI may choose to
649 * show these items larger, or at a different position in notification lists, compared with
650 * your app's {@link #PRIORITY_DEFAULT} items.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500651 *
652 * @deprecated use {@link NotificationManager#IMPORTANCE_HIGH} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500653 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500654 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500655 public static final int PRIORITY_HIGH = 1;
656
657 /**
658 * Highest {@link #priority}, for your application's most important items that require the
659 * user's prompt attention or input.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500660 *
661 * @deprecated use {@link NotificationManager#IMPORTANCE_HIGH} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500662 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500663 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500664 public static final int PRIORITY_MAX = 2;
665
666 /**
667 * Relative priority for this notification.
Joe Malin8d40d042012-11-05 11:36:40 -0800668 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500669 * Priority is an indication of how much of the user's valuable attention should be consumed by
670 * this notification. Low-priority notifications may be hidden from the user in certain
671 * situations, while the user might be interrupted for a higher-priority notification. The
Daniel Sandler6738eee2012-11-16 12:03:32 -0500672 * system will make a determination about how to interpret this priority when presenting
673 * the notification.
Chris Wren47c20a12014-06-18 17:27:29 -0400674 *
675 * <p>
676 * A notification that is at least {@link #PRIORITY_HIGH} is more likely to be presented
677 * as a heads-up notification.
678 * </p>
679 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500680 * @deprecated use {@link NotificationChannel#getImportance()} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500681 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700682 @Priority
Julia Reynoldsa33f5c42017-01-31 16:53:35 -0500683 @Deprecated
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500684 public int priority;
Joe Malin8d40d042012-11-05 11:36:40 -0800685
Dan Sandler26e81cf2014-05-06 10:01:27 -0400686 /**
687 * Accent color (an ARGB integer like the constants in {@link android.graphics.Color})
688 * to be applied by the standard Style templates when presenting this notification.
689 *
690 * The current template design constructs a colorful header image by overlaying the
691 * {@link #icon} image (stenciled in white) atop a field of this color. Alpha components are
692 * ignored.
693 */
Tor Norbye80756e32015-03-02 09:39:27 -0800694 @ColorInt
Dan Sandler26e81cf2014-05-06 10:01:27 -0400695 public int color = COLOR_DEFAULT;
696
697 /**
698 * Special value of {@link #color} telling the system not to decorate this notification with
699 * any special color but instead use default colors when presenting this notification.
700 */
Tor Norbye80756e32015-03-02 09:39:27 -0800701 @ColorInt
Dan Sandler26e81cf2014-05-06 10:01:27 -0400702 public static final int COLOR_DEFAULT = 0; // AKA Color.TRANSPARENT
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600703
704 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -0800705 * Special value of {@link #color} used as a place holder for an invalid color.
Selim Cinek99104832017-01-25 14:47:33 -0800706 * @hide
Adrian Roos4ff3b122016-02-01 12:26:13 -0800707 */
708 @ColorInt
Selim Cinek99104832017-01-25 14:47:33 -0800709 public static final int COLOR_INVALID = 1;
Adrian Roos4ff3b122016-02-01 12:26:13 -0800710
711 /**
Adrian Roosc1a80b02016-04-05 14:54:55 -0700712 * Sphere of visibility of this notification, which affects how and when the SystemUI reveals
713 * the notification's presence and contents in untrusted situations (namely, on the secure
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600714 * lockscreen).
715 *
716 * The default level, {@link #VISIBILITY_PRIVATE}, behaves exactly as notifications have always
717 * done on Android: The notification's {@link #icon} and {@link #tickerText} (if available) are
718 * shown in all situations, but the contents are only available if the device is unlocked for
719 * the appropriate user.
720 *
721 * A more permissive policy can be expressed by {@link #VISIBILITY_PUBLIC}; such a notification
722 * can be read even in an "insecure" context (that is, above a secure lockscreen).
723 * To modify the public version of this notification—for example, to redact some portions—see
724 * {@link Builder#setPublicVersion(Notification)}.
725 *
726 * Finally, a notification can be made {@link #VISIBILITY_SECRET}, which will suppress its icon
727 * and ticker until the user has bypassed the lockscreen.
728 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600729 public @Visibility int visibility;
730
731 /** @hide */
732 @IntDef(prefix = { "VISIBILITY_" }, value = {
733 VISIBILITY_PUBLIC,
734 VISIBILITY_PRIVATE,
735 VISIBILITY_SECRET,
736 })
737 @Retention(RetentionPolicy.SOURCE)
738 public @interface Visibility {}
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600739
Griff Hazenfc3922d2014-08-20 11:56:44 -0700740 /**
741 * Notification visibility: Show this notification in its entirety on all lockscreens.
742 *
743 * {@see #visibility}
744 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600745 public static final int VISIBILITY_PUBLIC = 1;
Griff Hazenfc3922d2014-08-20 11:56:44 -0700746
747 /**
748 * Notification visibility: Show this notification on all lockscreens, but conceal sensitive or
749 * private information on secure lockscreens.
750 *
751 * {@see #visibility}
752 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600753 public static final int VISIBILITY_PRIVATE = 0;
Griff Hazenfc3922d2014-08-20 11:56:44 -0700754
755 /**
756 * Notification visibility: Do not reveal any part of this notification on a secure lockscreen.
757 *
758 * {@see #visibility}
759 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600760 public static final int VISIBILITY_SECRET = -1;
761
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500762 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400763 * Notification category: incoming call (voice or video) or similar synchronous communication request.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500764 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400765 public static final String CATEGORY_CALL = "call";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500766
767 /**
Adora Zhangaa90e872018-03-12 14:07:50 -0700768 * Notification category: map turn-by-turn navigation.
769 */
770 public static final String CATEGORY_NAVIGATION = "navigation";
771
772 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400773 * Notification category: incoming direct message (SMS, instant message, etc.).
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500774 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400775 public static final String CATEGORY_MESSAGE = "msg";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500776
777 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400778 * Notification category: asynchronous bulk message (email).
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500779 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400780 public static final String CATEGORY_EMAIL = "email";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500781
782 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400783 * Notification category: calendar event.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500784 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400785 public static final String CATEGORY_EVENT = "event";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500786
787 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400788 * Notification category: promotion or advertisement.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500789 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400790 public static final String CATEGORY_PROMO = "promo";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500791
792 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400793 * Notification category: alarm or timer.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500794 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400795 public static final String CATEGORY_ALARM = "alarm";
796
797 /**
798 * Notification category: progress of a long-running background operation.
799 */
800 public static final String CATEGORY_PROGRESS = "progress";
801
802 /**
803 * Notification category: social network or sharing update.
804 */
805 public static final String CATEGORY_SOCIAL = "social";
806
807 /**
808 * Notification category: error in background operation or authentication status.
809 */
810 public static final String CATEGORY_ERROR = "err";
811
812 /**
813 * Notification category: media transport control for playback.
814 */
815 public static final String CATEGORY_TRANSPORT = "transport";
816
817 /**
818 * Notification category: system or device status update. Reserved for system use.
819 */
820 public static final String CATEGORY_SYSTEM = "sys";
821
822 /**
823 * Notification category: indication of running background service.
824 */
825 public static final String CATEGORY_SERVICE = "service";
826
827 /**
John Spurlock0a69c8c2014-03-21 13:30:57 -0400828 * Notification category: a specific, timely recommendation for a single thing.
829 * For example, a news app might want to recommend a news story it believes the user will
830 * want to read next.
831 */
832 public static final String CATEGORY_RECOMMENDATION = "recommendation";
833
834 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400835 * Notification category: ongoing information about device or contextual status.
836 */
837 public static final String CATEGORY_STATUS = "status";
838
839 /**
John Spurlock24d3dad2015-04-02 12:24:02 -0400840 * Notification category: user-scheduled reminder.
841 */
842 public static final String CATEGORY_REMINDER = "reminder";
843
844 /**
Adora Zhangaa90e872018-03-12 14:07:50 -0700845 * Notification category: extreme car emergencies.
846 * @hide
847 */
848 @SystemApi
849 public static final String CATEGORY_CAR_EMERGENCY = "car_emergency";
850
851 /**
852 * Notification category: car warnings.
853 * @hide
854 */
855 @SystemApi
856 public static final String CATEGORY_CAR_WARNING = "car_warning";
857
858 /**
859 * Notification category: general car system information.
860 * @hide
861 */
862 @SystemApi
863 public static final String CATEGORY_CAR_INFORMATION = "car_information";
864
865 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400866 * One of the predefined notification categories (see the <code>CATEGORY_*</code> constants)
867 * that best describes this Notification. May be used by the system for ranking and filtering.
868 */
869 public String category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500870
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700871 private String mGroupKey;
872
873 /**
874 * Get the key used to group this notification into a cluster or stack
875 * with other notifications on devices which support such rendering.
876 */
877 public String getGroup() {
878 return mGroupKey;
879 }
880
881 private String mSortKey;
882
883 /**
884 * Get a sort key that orders this notification among other notifications from the
885 * same package. This can be useful if an external sort was already applied and an app
886 * would like to preserve this. Notifications will be sorted lexicographically using this
887 * value, although providing different priorities in addition to providing sort key may
888 * cause this value to be ignored.
889 *
890 * <p>This sort key can also be used to order members of a notification group. See
891 * {@link Builder#setGroup}.
892 *
893 * @see String#compareTo(String)
894 */
895 public String getSortKey() {
896 return mSortKey;
897 }
898
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500899 /**
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400900 * Additional semantic data to be carried around with this Notification.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400901 * <p>
902 * The extras keys defined here are intended to capture the original inputs to {@link Builder}
903 * APIs, and are intended to be used by
904 * {@link android.service.notification.NotificationListenerService} implementations to extract
905 * detailed information from notification objects.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500906 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400907 public Bundle extras = new Bundle();
908
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400909 /**
Felipe Lemedd85da62016-06-28 11:29:54 -0700910 * All pending intents in the notification as the system needs to be able to access them but
911 * touching the extras bundle in the system process is not safe because the bundle may contain
Svet Ganovddb94882016-06-23 19:55:24 -0700912 * custom parcelable objects.
913 *
914 * @hide
915 */
Felipe Lemedd85da62016-06-28 11:29:54 -0700916 public ArraySet<PendingIntent> allPendingIntents;
Svet Ganovddb94882016-06-23 19:55:24 -0700917
918 /**
Dianne Hackborn98305522017-05-05 17:53:53 -0700919 * Token identifying the notification that is applying doze/bgcheck whitelisting to the
920 * pending intents inside of it, so only those will get the behavior.
921 *
922 * @hide
923 */
Adrian Roosfb921842017-10-26 14:49:56 +0200924 private IBinder mWhitelistToken;
Dianne Hackborn98305522017-05-05 17:53:53 -0700925
926 /**
927 * Must be set by a process to start associating tokens with Notification objects
928 * coming in to it. This is set by NotificationManagerService.
929 *
930 * @hide
931 */
932 static public IBinder processWhitelistToken;
933
934 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400935 * {@link #extras} key: this is the title of the notification,
936 * as supplied to {@link Builder#setContentTitle(CharSequence)}.
937 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500938 public static final String EXTRA_TITLE = "android.title";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400939
940 /**
941 * {@link #extras} key: this is the title of the notification when shown in expanded form,
942 * e.g. as supplied to {@link BigTextStyle#setBigContentTitle(CharSequence)}.
943 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400944 public static final String EXTRA_TITLE_BIG = EXTRA_TITLE + ".big";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400945
946 /**
947 * {@link #extras} key: this is the main text payload, as supplied to
948 * {@link Builder#setContentText(CharSequence)}.
949 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500950 public static final String EXTRA_TEXT = "android.text";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400951
952 /**
953 * {@link #extras} key: this is a third line of text, as supplied to
954 * {@link Builder#setSubText(CharSequence)}.
955 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400956 public static final String EXTRA_SUB_TEXT = "android.subText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400957
958 /**
Adrian Roose458aa82015-12-08 16:17:19 -0800959 * {@link #extras} key: this is the remote input history, as supplied to
960 * {@link Builder#setRemoteInputHistory(CharSequence[])}.
Adrian Roos005e7742016-04-13 15:02:20 -0700961 *
962 * Apps can fill this through {@link Builder#setRemoteInputHistory(CharSequence[])}
963 * with the most recent inputs that have been sent through a {@link RemoteInput} of this
964 * Notification and are expected to clear it once the it is no longer relevant (e.g. for chat
965 * notifications once the other party has responded).
966 *
967 * The extra with this key is of type CharSequence[] and contains the most recent entry at
968 * the 0 index, the second most recent at the 1 index, etc.
969 *
970 * @see Builder#setRemoteInputHistory(CharSequence[])
Adrian Roose458aa82015-12-08 16:17:19 -0800971 */
972 public static final String EXTRA_REMOTE_INPUT_HISTORY = "android.remoteInputHistory";
973
974 /**
Kenny Guya0f6de82018-04-06 16:20:16 +0100975 * {@link #extras} key: boolean as supplied to
976 * {@link Builder#setShowRemoteInputSpinner(boolean)}.
977 *
978 * If set to true, then the view displaying the remote input history from
979 * {@link Builder#setRemoteInputHistory(CharSequence[])} will have a progress spinner.
980 *
981 * @see Builder#setShowRemoteInputSpinner(boolean)
982 * @hide
983 */
984 public static final String EXTRA_SHOW_REMOTE_INPUT_SPINNER = "android.remoteInputSpinner";
985
986 /**
Kenny Guy8cc15d22018-05-09 09:50:55 +0100987 * {@link #extras} key: boolean as supplied to
988 * {@link Builder#setHideSmartReplies(boolean)}.
989 *
990 * If set to true, then any smart reply buttons will be hidden.
991 *
992 * @see Builder#setHideSmartReplies(boolean)
993 * @hide
994 */
995 public static final String EXTRA_HIDE_SMART_REPLIES = "android.hideSmartReplies";
996
997 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400998 * {@link #extras} key: this is a small piece of additional text as supplied to
999 * {@link Builder#setContentInfo(CharSequence)}.
1000 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001001 public static final String EXTRA_INFO_TEXT = "android.infoText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001002
1003 /**
1004 * {@link #extras} key: this is a line of summary information intended to be shown
1005 * alongside expanded notifications, as supplied to (e.g.)
1006 * {@link BigTextStyle#setSummaryText(CharSequence)}.
1007 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001008 public static final String EXTRA_SUMMARY_TEXT = "android.summaryText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001009
1010 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +02001011 * {@link #extras} key: this is the longer text shown in the big form of a
1012 * {@link BigTextStyle} notification, as supplied to
1013 * {@link BigTextStyle#bigText(CharSequence)}.
1014 */
1015 public static final String EXTRA_BIG_TEXT = "android.bigText";
1016
1017 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001018 * {@link #extras} key: this is the resource ID of the notification's main small icon, as
1019 * supplied to {@link Builder#setSmallIcon(int)}.
Julia Reynoldse071abd2017-03-22 10:52:11 -04001020 *
1021 * @deprecated Use {@link #getSmallIcon()}, which supports a wider variety of icon sources.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001022 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04001023 @Deprecated
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001024 public static final String EXTRA_SMALL_ICON = "android.icon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001025
1026 /**
1027 * {@link #extras} key: this is a bitmap to be used instead of the small icon when showing the
1028 * notification payload, as
1029 * supplied to {@link Builder#setLargeIcon(android.graphics.Bitmap)}.
Julia Reynoldse071abd2017-03-22 10:52:11 -04001030 *
1031 * @deprecated Use {@link #getLargeIcon()}, which supports a wider variety of icon sources.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001032 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04001033 @Deprecated
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001034 public static final String EXTRA_LARGE_ICON = "android.largeIcon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001035
1036 /**
1037 * {@link #extras} key: this is a bitmap to be used instead of the one from
1038 * {@link Builder#setLargeIcon(android.graphics.Bitmap)} when the notification is
1039 * shown in its expanded form, as supplied to
1040 * {@link BigPictureStyle#bigLargeIcon(android.graphics.Bitmap)}.
1041 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001042 public static final String EXTRA_LARGE_ICON_BIG = EXTRA_LARGE_ICON + ".big";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001043
1044 /**
1045 * {@link #extras} key: this is the progress value supplied to
1046 * {@link Builder#setProgress(int, int, boolean)}.
1047 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001048 public static final String EXTRA_PROGRESS = "android.progress";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001049
1050 /**
1051 * {@link #extras} key: this is the maximum value supplied to
1052 * {@link Builder#setProgress(int, int, boolean)}.
1053 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001054 public static final String EXTRA_PROGRESS_MAX = "android.progressMax";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001055
1056 /**
1057 * {@link #extras} key: whether the progress bar is indeterminate, supplied to
1058 * {@link Builder#setProgress(int, int, boolean)}.
1059 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001060 public static final String EXTRA_PROGRESS_INDETERMINATE = "android.progressIndeterminate";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001061
1062 /**
1063 * {@link #extras} key: whether {@link #when} should be shown as a count-up timer (specifically
1064 * a {@link android.widget.Chronometer}) instead of a timestamp, as supplied to
1065 * {@link Builder#setUsesChronometer(boolean)}.
1066 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001067 public static final String EXTRA_SHOW_CHRONOMETER = "android.showChronometer";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001068
1069 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08001070 * {@link #extras} key: whether the chronometer set on the notification should count down
1071 * instead of counting up. Is only relevant if key {@link #EXTRA_SHOW_CHRONOMETER} is present.
Adrian Roos96b7e202016-05-17 13:50:38 -07001072 * This extra is a boolean. The default is false.
Selim Cinek81c23aa2016-02-25 16:23:13 -08001073 */
Adrian Roos96b7e202016-05-17 13:50:38 -07001074 public static final String EXTRA_CHRONOMETER_COUNT_DOWN = "android.chronometerCountDown";
Selim Cinek81c23aa2016-02-25 16:23:13 -08001075
1076 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001077 * {@link #extras} key: whether {@link #when} should be shown,
1078 * as supplied to {@link Builder#setShowWhen(boolean)}.
1079 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001080 public static final String EXTRA_SHOW_WHEN = "android.showWhen";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001081
1082 /**
1083 * {@link #extras} key: this is a bitmap to be shown in {@link BigPictureStyle} expanded
1084 * notifications, supplied to {@link BigPictureStyle#bigPicture(android.graphics.Bitmap)}.
1085 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001086 public static final String EXTRA_PICTURE = "android.picture";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001087
1088 /**
1089 * {@link #extras} key: An array of CharSequences to show in {@link InboxStyle} expanded
1090 * notifications, each of which was supplied to {@link InboxStyle#addLine(CharSequence)}.
1091 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001092 public static final String EXTRA_TEXT_LINES = "android.textLines";
Dan Sandler842dd772014-05-15 09:36:47 -04001093
1094 /**
1095 * {@link #extras} key: A string representing the name of the specific
1096 * {@link android.app.Notification.Style} used to create this notification.
1097 */
Chris Wren91ad5632013-06-05 15:05:57 -04001098 public static final String EXTRA_TEMPLATE = "android.template";
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001099
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001100 /**
Chris Wrene6c48932014-09-29 17:19:27 -04001101 * {@link #extras} key: A String array containing the people that this notification relates to,
1102 * each of which was supplied to {@link Builder#addPerson(String)}.
Selim Cineke7238dd2017-12-14 17:48:32 -08001103 *
1104 * @deprecated the actual objects are now in {@link #EXTRA_PEOPLE_LIST}
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001105 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001106 public static final String EXTRA_PEOPLE = "android.people";
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001107
1108 /**
Selim Cineke7238dd2017-12-14 17:48:32 -08001109 * {@link #extras} key: An arrayList of {@link Person} objects containing the people that
1110 * this notification relates to.
1111 */
1112 public static final String EXTRA_PEOPLE_LIST = "android.people.list";
1113
1114 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04001115 * Allow certain system-generated notifications to appear before the device is provisioned.
1116 * Only available to notifications coming from the android package.
1117 * @hide
1118 */
Maurice Lam96c10032017-03-29 15:42:38 -07001119 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001120 @RequiresPermission(android.Manifest.permission.NOTIFICATION_DURING_SETUP)
John Spurlockfd7f1e02014-03-18 16:41:57 -04001121 public static final String EXTRA_ALLOW_DURING_SETUP = "android.allowDuringSetup";
1122
1123 /**
Jose Limae9e3b3b2014-05-18 23:44:50 -07001124 * {@link #extras} key: A
1125 * {@link android.content.ContentUris content URI} pointing to an image that can be displayed
Julia Reynoldse0d711f2017-09-01 08:50:47 -04001126 * in the background when the notification is selected. Used on television platforms.
1127 * The URI must point to an image stream suitable for passing into
Jose Limae9e3b3b2014-05-18 23:44:50 -07001128 * {@link android.graphics.BitmapFactory#decodeStream(java.io.InputStream)
Julia Reynoldse0d711f2017-09-01 08:50:47 -04001129 * BitmapFactory.decodeStream}; all other content types will be ignored.
Jose Limae9e3b3b2014-05-18 23:44:50 -07001130 */
1131 public static final String EXTRA_BACKGROUND_IMAGE_URI = "android.backgroundImageUri";
1132
1133 /**
Dan Sandler842dd772014-05-15 09:36:47 -04001134 * {@link #extras} key: A
Jeff Browndba34ba2014-06-24 20:46:03 -07001135 * {@link android.media.session.MediaSession.Token} associated with a
Dan Sandler842dd772014-05-15 09:36:47 -04001136 * {@link android.app.Notification.MediaStyle} notification.
1137 */
1138 public static final String EXTRA_MEDIA_SESSION = "android.mediaSession";
1139
1140 /**
Bryan Mawhinneye191f902014-07-22 12:50:09 +01001141 * {@link #extras} key: the indices of actions to be shown in the compact view,
1142 * as supplied to (e.g.) {@link MediaStyle#setShowActionsInCompactView(int...)}.
1143 */
1144 public static final String EXTRA_COMPACT_ACTIONS = "android.compactActions";
1145
Christoph Studer943aa672014-08-03 20:31:16 +02001146 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04001147 * {@link #extras} key: the username to be displayed for all messages sent by the user including
1148 * direct replies
Adrian Roos96b7e202016-05-17 13:50:38 -07001149 * {@link android.app.Notification.MessagingStyle} notification. This extra is a
1150 * {@link CharSequence}
Selim Cinekcb8b9852017-12-15 18:01:52 -08001151 *
1152 * @deprecated use {@link #EXTRA_MESSAGING_PERSON}
Alex Hillsfc737de2016-03-23 17:33:02 -04001153 */
1154 public static final String EXTRA_SELF_DISPLAY_NAME = "android.selfDisplayName";
1155
1156 /**
Selim Cinekcb8b9852017-12-15 18:01:52 -08001157 * {@link #extras} key: the person to be displayed for all messages sent by the user including
1158 * direct replies
1159 * {@link android.app.Notification.MessagingStyle} notification. This extra is a
1160 * {@link Person}
1161 */
1162 public static final String EXTRA_MESSAGING_PERSON = "android.messagingUser";
1163
1164 /**
Adrian Roos96b7e202016-05-17 13:50:38 -07001165 * {@link #extras} key: a {@link CharSequence} to be displayed as the title to a conversation
Alex Hillsd9b04d92016-04-11 16:38:16 -04001166 * represented by a {@link android.app.Notification.MessagingStyle}
Alex Hillsfc737de2016-03-23 17:33:02 -04001167 */
Alex Hillsd9b04d92016-04-11 16:38:16 -04001168 public static final String EXTRA_CONVERSATION_TITLE = "android.conversationTitle";
Alex Hillsfc737de2016-03-23 17:33:02 -04001169
1170 /**
1171 * {@link #extras} key: an array of {@link android.app.Notification.MessagingStyle.Message}
1172 * bundles provided by a
Adrian Roos96b7e202016-05-17 13:50:38 -07001173 * {@link android.app.Notification.MessagingStyle} notification. This extra is a parcelable
1174 * array of bundles.
Alex Hillsfc737de2016-03-23 17:33:02 -04001175 */
1176 public static final String EXTRA_MESSAGES = "android.messages";
1177
1178 /**
Adrian Roos437cd562017-01-18 15:47:03 -08001179 * {@link #extras} key: an array of
1180 * {@link android.app.Notification.MessagingStyle#addHistoricMessage historic}
1181 * {@link android.app.Notification.MessagingStyle.Message} bundles provided by a
1182 * {@link android.app.Notification.MessagingStyle} notification. This extra is a parcelable
1183 * array of bundles.
1184 */
1185 public static final String EXTRA_HISTORIC_MESSAGES = "android.messages.historic";
1186
1187 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08001188 * {@link #extras} key: whether the {@link android.app.Notification.MessagingStyle} notification
1189 * represents a group conversation.
1190 */
1191 public static final String EXTRA_IS_GROUP_CONVERSATION = "android.isGroupConversation";
1192
1193 /**
Selim Cinek7b9605b2017-01-19 17:36:00 -08001194 * {@link #extras} key: whether the notification should be colorized as
1195 * supplied to {@link Builder#setColorized(boolean)}}.
1196 */
1197 public static final String EXTRA_COLORIZED = "android.colorized";
1198
1199 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04001200 * @hide
1201 */
1202 public static final String EXTRA_BUILDER_APPLICATION_INFO = "android.appInfo";
1203
Selim Cinek247fa012016-02-18 09:50:48 -08001204 /**
1205 * @hide
1206 */
1207 public static final String EXTRA_CONTAINS_CUSTOM_VIEW = "android.contains.customView";
1208
Shane Brennan472a3b32016-12-12 15:28:10 -08001209 /**
Selim Cinekd0426622017-07-11 13:19:59 +02001210 * @hide
1211 */
1212 public static final String EXTRA_REDUCED_IMAGES = "android.reduced.images";
1213
1214 /**
Shane Brennan472a3b32016-12-12 15:28:10 -08001215 * {@link #extras} key: the audio contents of this notification.
1216 *
1217 * This is for use when rendering the notification on an audio-focused interface;
1218 * the audio contents are a complete sound sample that contains the contents/body of the
1219 * notification. This may be used in substitute of a Text-to-Speech reading of the
1220 * notification. For example if the notification represents a voice message this should point
1221 * to the audio of that message.
1222 *
1223 * The data stored under this key should be a String representation of a Uri that contains the
1224 * audio contents in one of the following formats: WAV, PCM 16-bit, AMR-WB.
1225 *
1226 * This extra is unnecessary if you are using {@code MessagingStyle} since each {@code Message}
1227 * has a field for holding data URI. That field can be used for audio.
1228 * See {@code Message#setData}.
1229 *
1230 * Example usage:
1231 * <pre>
1232 * {@code
1233 * Notification.Builder myBuilder = (build your Notification as normal);
1234 * myBuilder.getExtras().putString(EXTRA_AUDIO_CONTENTS_URI, myAudioUri.toString());
1235 * }
1236 * </pre>
1237 */
1238 public static final String EXTRA_AUDIO_CONTENTS_URI = "android.audioContents";
1239
Dan Sandler80eaa592016-04-14 23:34:54 -04001240 /** @hide */
1241 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001242 @RequiresPermission(android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME)
Dan Sandler732bd6c2016-04-12 14:20:32 -04001243 public static final String EXTRA_SUBSTITUTE_APP_NAME = "android.substName";
1244
Dianne Hackbornfb5d4b52017-05-16 17:03:44 -07001245 /**
Julia Reynolds3c7de112018-03-28 09:33:13 -04001246 * This is set on the notifications shown by system_server about apps running foreground
1247 * services. It indicates that the notification should be shown
1248 * only if any of the given apps do not already have a properly tagged
1249 * {@link #FLAG_FOREGROUND_SERVICE} notification currently visible to the user.
1250 * This is a string array of all package names of the apps.
Dianne Hackbornfb5d4b52017-05-16 17:03:44 -07001251 * @hide
1252 */
1253 public static final String EXTRA_FOREGROUND_APPS = "android.foregroundApps";
1254
Dan Sandlerd63f9322015-05-06 15:18:49 -04001255 private Icon mSmallIcon;
1256 private Icon mLargeIcon;
1257
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04001258 private String mChannelId;
Julia Reynolds2a128742016-11-28 14:29:25 -05001259 private long mTimeout;
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04001260
Julia Reynolds13d898c2017-02-02 12:22:05 -05001261 private String mShortcutId;
Julia Reynolds3aedded2017-03-31 14:42:09 -04001262 private CharSequence mSettingsText;
Julia Reynolds13d898c2017-02-02 12:22:05 -05001263
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001264 /** @hide */
1265 @IntDef(prefix = { "GROUP_ALERT_" }, value = {
1266 GROUP_ALERT_ALL, GROUP_ALERT_CHILDREN, GROUP_ALERT_SUMMARY
1267 })
1268 @Retention(RetentionPolicy.SOURCE)
1269 public @interface GroupAlertBehavior {}
1270
1271 /**
1272 * Constant for {@link Builder#setGroupAlertBehavior(int)}, meaning that all notifications in a
1273 * group with sound or vibration ought to make sound or vibrate (respectively), so this
1274 * notification will not be muted when it is in a group.
1275 */
1276 public static final int GROUP_ALERT_ALL = 0;
1277
1278 /**
1279 * Constant for {@link Builder#setGroupAlertBehavior(int)}, meaning that all children
1280 * notification in a group should be silenced (no sound or vibration) even if they are posted
1281 * to a {@link NotificationChannel} that has sound and/or vibration. Use this constant to
Julia Reynolds399d9bf2017-08-11 12:52:14 -04001282 * mute this notification if this notification is a group child. This must be applied to all
1283 * children notifications you want to mute.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001284 *
1285 * <p> For example, you might want to use this constant if you post a number of children
1286 * notifications at once (say, after a periodic sync), and only need to notify the user
1287 * audibly once.
1288 */
1289 public static final int GROUP_ALERT_SUMMARY = 1;
1290
1291 /**
1292 * Constant for {@link Builder#setGroupAlertBehavior(int)}, meaning that the summary
1293 * notification in a group should be silenced (no sound or vibration) even if they are
1294 * posted to a {@link NotificationChannel} that has sound and/or vibration. Use this constant
1295 * to mute this notification if this notification is a group summary.
1296 *
1297 * <p>For example, you might want to use this constant if only the children notifications
Julia Reynolds399d9bf2017-08-11 12:52:14 -04001298 * in your group have content and the summary is only used to visually group notifications
1299 * rather than to alert the user that new information is available.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001300 */
1301 public static final int GROUP_ALERT_CHILDREN = 2;
1302
Julia Reynolds2f431e22017-06-07 14:12:09 +00001303 private int mGroupAlertBehavior = GROUP_ALERT_ALL;
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001304
Julia Reynolds13d898c2017-02-02 12:22:05 -05001305 /**
1306 * If this notification is being shown as a badge, always show as a number.
1307 */
1308 public static final int BADGE_ICON_NONE = 0;
1309
1310 /**
1311 * If this notification is being shown as a badge, use the {@link #getSmallIcon()} to
1312 * represent this notification.
1313 */
1314 public static final int BADGE_ICON_SMALL = 1;
1315
1316 /**
1317 * If this notification is being shown as a badge, use the {@link #getLargeIcon()} to
1318 * represent this notification.
1319 */
1320 public static final int BADGE_ICON_LARGE = 2;
Julia Reynolds7d5b4da2017-03-20 10:18:49 -04001321 private int mBadgeIcon = BADGE_ICON_NONE;
Julia Reynolds13d898c2017-02-02 12:22:05 -05001322
Chris Wren51c75102013-07-16 20:49:17 -04001323 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001324 * Structure to encapsulate a named action that can be shown as part of this notification.
1325 * It must include an icon, a label, and a {@link PendingIntent} to be fired when the action is
1326 * selected by the user.
1327 * <p>
Griff Hazen959591e2014-05-15 22:26:18 -07001328 * Apps should use {@link Notification.Builder#addAction(int, CharSequence, PendingIntent)}
1329 * or {@link Notification.Builder#addAction(Notification.Action)}
1330 * to attach actions.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001331 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -05001332 public static class Action implements Parcelable {
Shane Brennan472a3b32016-12-12 15:28:10 -08001333 /**
1334 * {@link #extras} key: Keys to a {@link Parcelable} {@link ArrayList} of
1335 * {@link RemoteInput}s.
1336 *
1337 * This is intended for {@link RemoteInput}s that only accept data, meaning
1338 * {@link RemoteInput#getAllowFreeFormInput} is false, {@link RemoteInput#getChoices}
1339 * is null or empty, and {@link RemoteInput#getAllowedDataTypes is non-null and not
1340 * empty. These {@link RemoteInput}s will be ignored by devices that do not
1341 * support non-text-based {@link RemoteInput}s. See {@link Builder#build}.
1342 *
1343 * You can test if a RemoteInput matches these constraints using
1344 * {@link RemoteInput#isDataOnly}.
1345 */
1346 private static final String EXTRA_DATA_ONLY_INPUTS = "android.extra.DATA_ONLY_INPUTS";
1347
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001348 /**
1349 * {@link }: No semantic action defined.
1350 */
1351 public static final int SEMANTIC_ACTION_NONE = 0;
1352
1353 /**
1354 * {@code SemanticAction}: Reply to a conversation, chat, group, or wherever replies
1355 * may be appropriate.
1356 */
1357 public static final int SEMANTIC_ACTION_REPLY = 1;
1358
1359 /**
1360 * {@code SemanticAction}: Mark content as read.
1361 */
1362 public static final int SEMANTIC_ACTION_MARK_AS_READ = 2;
1363
1364 /**
1365 * {@code SemanticAction}: Mark content as unread.
1366 */
1367 public static final int SEMANTIC_ACTION_MARK_AS_UNREAD = 3;
1368
1369 /**
1370 * {@code SemanticAction}: Delete the content associated with the notification. This
1371 * could mean deleting an email, message, etc.
1372 */
1373 public static final int SEMANTIC_ACTION_DELETE = 4;
1374
1375 /**
1376 * {@code SemanticAction}: Archive the content associated with the notification. This
1377 * could mean archiving an email, message, etc.
1378 */
1379 public static final int SEMANTIC_ACTION_ARCHIVE = 5;
1380
1381 /**
1382 * {@code SemanticAction}: Mute the content associated with the notification. This could
1383 * mean silencing a conversation or currently playing media.
1384 */
1385 public static final int SEMANTIC_ACTION_MUTE = 6;
1386
1387 /**
1388 * {@code SemanticAction}: Unmute the content associated with the notification. This could
1389 * mean un-silencing a conversation or currently playing media.
1390 */
1391 public static final int SEMANTIC_ACTION_UNMUTE = 7;
1392
1393 /**
1394 * {@code SemanticAction}: Mark content with a thumbs up.
1395 */
1396 public static final int SEMANTIC_ACTION_THUMBS_UP = 8;
1397
1398 /**
1399 * {@code SemanticAction}: Mark content with a thumbs down.
1400 */
1401 public static final int SEMANTIC_ACTION_THUMBS_DOWN = 9;
1402
Kodlee Yincda5b092018-02-15 15:34:53 -08001403 /**
1404 * {@code SemanticAction}: Call a contact, group, etc.
1405 */
1406 public static final int SEMANTIC_ACTION_CALL = 10;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001407
Griff Hazen959591e2014-05-15 22:26:18 -07001408 private final Bundle mExtras;
Dan Sandler86647982015-05-13 23:41:13 -04001409 private Icon mIcon;
Griff Hazen61a9e862014-05-22 16:05:19 -07001410 private final RemoteInput[] mRemoteInputs;
Alex Hills1f27f882017-01-12 11:24:46 -05001411 private boolean mAllowGeneratedReplies = true;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001412 private final @SemanticAction int mSemanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001413
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001414 /**
1415 * Small icon representing the action.
Dan Sandler86647982015-05-13 23:41:13 -04001416 *
1417 * @deprecated Use {@link Action#getIcon()} instead.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001418 */
Dan Sandler86647982015-05-13 23:41:13 -04001419 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001420 public int icon;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001421
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001422 /**
1423 * Title of the action.
1424 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001425 public CharSequence title;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001426
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001427 /**
1428 * Intent to send when the user invokes this action. May be null, in which case the action
1429 * may be rendered in a disabled presentation by the system UI.
1430 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001431 public PendingIntent actionIntent;
Griff Hazen959591e2014-05-15 22:26:18 -07001432
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001433 private Action(Parcel in) {
Dan Sandler86647982015-05-13 23:41:13 -04001434 if (in.readInt() != 0) {
1435 mIcon = Icon.CREATOR.createFromParcel(in);
Dan Sandler68079d52015-07-22 10:45:30 -04001436 if (mIcon.getType() == Icon.TYPE_RESOURCE) {
1437 icon = mIcon.getResId();
1438 }
Dan Sandler86647982015-05-13 23:41:13 -04001439 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001440 title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
1441 if (in.readInt() == 1) {
1442 actionIntent = PendingIntent.CREATOR.createFromParcel(in);
1443 }
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06001444 mExtras = Bundle.setDefusable(in.readBundle(), true);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001445 mRemoteInputs = in.createTypedArray(RemoteInput.CREATOR);
Alex Hills42b0c4d2016-04-26 13:35:36 -04001446 mAllowGeneratedReplies = in.readInt() == 1;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001447 mSemanticAction = in.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001448 }
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001449
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001450 /**
Dan Sandler86647982015-05-13 23:41:13 -04001451 * @deprecated Use {@link android.app.Notification.Action.Builder}.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001452 */
Dan Sandler86647982015-05-13 23:41:13 -04001453 @Deprecated
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001454 public Action(int icon, CharSequence title, PendingIntent intent) {
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001455 this(Icon.createWithResource("", icon), title, intent, new Bundle(), null, true,
1456 SEMANTIC_ACTION_NONE);
Griff Hazen959591e2014-05-15 22:26:18 -07001457 }
1458
Adrian Roos7af53622016-10-12 13:44:05 -07001459 /** Keep in sync with {@link Notification.Action.Builder#Builder(Action)}! */
Dan Sandler86647982015-05-13 23:41:13 -04001460 private Action(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001461 RemoteInput[] remoteInputs, boolean allowGeneratedReplies,
1462 @SemanticAction int semanticAction) {
Dan Sandler86647982015-05-13 23:41:13 -04001463 this.mIcon = icon;
Gus Prevasf5bff46f2015-08-24 10:34:28 -04001464 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
1465 this.icon = icon.getResId();
1466 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001467 this.title = title;
1468 this.actionIntent = intent;
Griff Hazen959591e2014-05-15 22:26:18 -07001469 this.mExtras = extras != null ? extras : new Bundle();
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001470 this.mRemoteInputs = remoteInputs;
Alex Hills42b0c4d2016-04-26 13:35:36 -04001471 this.mAllowGeneratedReplies = allowGeneratedReplies;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001472 this.mSemanticAction = semanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001473 }
1474
1475 /**
Dan Sandler86647982015-05-13 23:41:13 -04001476 * Return an icon representing the action.
1477 */
1478 public Icon getIcon() {
1479 if (mIcon == null && icon != 0) {
1480 // you snuck an icon in here without using the builder; let's try to keep it
1481 mIcon = Icon.createWithResource("", icon);
1482 }
1483 return mIcon;
1484 }
1485
1486 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001487 * Get additional metadata carried around with this Action.
1488 */
1489 public Bundle getExtras() {
1490 return mExtras;
1491 }
1492
1493 /**
Alex Hills42b0c4d2016-04-26 13:35:36 -04001494 * Return whether the platform should automatically generate possible replies for this
1495 * {@link Action}
1496 */
1497 public boolean getAllowGeneratedReplies() {
1498 return mAllowGeneratedReplies;
1499 }
1500
1501 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001502 * Get the list of inputs to be collected from the user when this action is sent.
Shane Brennan472a3b32016-12-12 15:28:10 -08001503 * May return null if no remote inputs were added. Only returns inputs which accept
1504 * a text input. For inputs which only accept data use {@link #getDataOnlyRemoteInputs}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001505 */
1506 public RemoteInput[] getRemoteInputs() {
1507 return mRemoteInputs;
1508 }
1509
1510 /**
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001511 * Returns the {@code SemanticAction} associated with this {@link Action}. A
1512 * {@code SemanticAction} denotes what an {@link Action}'s {@link PendingIntent} will do
1513 * (eg. reply, mark as read, delete, etc).
1514 */
1515 public @SemanticAction int getSemanticAction() {
1516 return mSemanticAction;
1517 }
1518
1519 /**
Shane Brennan472a3b32016-12-12 15:28:10 -08001520 * Get the list of inputs to be collected from the user that ONLY accept data when this
1521 * action is sent. These remote inputs are guaranteed to return true on a call to
1522 * {@link RemoteInput#isDataOnly}.
1523 *
Shane Brennanf670d6c2017-04-25 13:05:45 -07001524 * Returns null if there are no data-only remote inputs.
Shane Brennan472a3b32016-12-12 15:28:10 -08001525 *
1526 * This method exists so that legacy RemoteInput collectors that pre-date the addition
1527 * of non-textual RemoteInputs do not access these remote inputs.
1528 */
1529 public RemoteInput[] getDataOnlyRemoteInputs() {
1530 return (RemoteInput[]) mExtras.getParcelableArray(EXTRA_DATA_ONLY_INPUTS);
1531 }
1532
1533 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001534 * Builder class for {@link Action} objects.
1535 */
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001536 public static final class Builder {
Dan Sandler86647982015-05-13 23:41:13 -04001537 private final Icon mIcon;
Griff Hazen959591e2014-05-15 22:26:18 -07001538 private final CharSequence mTitle;
1539 private final PendingIntent mIntent;
Alex Hills1f27f882017-01-12 11:24:46 -05001540 private boolean mAllowGeneratedReplies = true;
Griff Hazen959591e2014-05-15 22:26:18 -07001541 private final Bundle mExtras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001542 private ArrayList<RemoteInput> mRemoteInputs;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001543 private @SemanticAction int mSemanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001544
1545 /**
1546 * Construct a new builder for {@link Action} object.
1547 * @param icon icon to show for this action
1548 * @param title the title of the action
1549 * @param intent the {@link PendingIntent} to fire when users trigger this action
1550 */
Dan Sandler86647982015-05-13 23:41:13 -04001551 @Deprecated
Griff Hazen959591e2014-05-15 22:26:18 -07001552 public Builder(int icon, CharSequence title, PendingIntent intent) {
Adrian Roos7af53622016-10-12 13:44:05 -07001553 this(Icon.createWithResource("", icon), title, intent);
Dan Sandler86647982015-05-13 23:41:13 -04001554 }
1555
1556 /**
1557 * Construct a new builder for {@link Action} object.
1558 * @param icon icon to show for this action
1559 * @param title the title of the action
1560 * @param intent the {@link PendingIntent} to fire when users trigger this action
1561 */
1562 public Builder(Icon icon, CharSequence title, PendingIntent intent) {
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001563 this(icon, title, intent, new Bundle(), null, true, SEMANTIC_ACTION_NONE);
Griff Hazen959591e2014-05-15 22:26:18 -07001564 }
1565
1566 /**
1567 * Construct a new builder for {@link Action} object using the fields from an
1568 * {@link Action}.
1569 * @param action the action to read fields from.
1570 */
1571 public Builder(Action action) {
Adrian Roos7af53622016-10-12 13:44:05 -07001572 this(action.getIcon(), action.title, action.actionIntent,
1573 new Bundle(action.mExtras), action.getRemoteInputs(),
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001574 action.getAllowGeneratedReplies(), action.getSemanticAction());
Griff Hazen959591e2014-05-15 22:26:18 -07001575 }
1576
Dan Sandler86647982015-05-13 23:41:13 -04001577 private Builder(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001578 RemoteInput[] remoteInputs, boolean allowGeneratedReplies,
1579 @SemanticAction int semanticAction) {
Griff Hazen959591e2014-05-15 22:26:18 -07001580 mIcon = icon;
1581 mTitle = title;
1582 mIntent = intent;
1583 mExtras = extras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001584 if (remoteInputs != null) {
1585 mRemoteInputs = new ArrayList<RemoteInput>(remoteInputs.length);
1586 Collections.addAll(mRemoteInputs, remoteInputs);
1587 }
Adrian Roos7af53622016-10-12 13:44:05 -07001588 mAllowGeneratedReplies = allowGeneratedReplies;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001589 mSemanticAction = semanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001590 }
1591
1592 /**
1593 * Merge additional metadata into this builder.
1594 *
1595 * <p>Values within the Bundle will replace existing extras values in this Builder.
1596 *
1597 * @see Notification.Action#extras
1598 */
1599 public Builder addExtras(Bundle extras) {
1600 if (extras != null) {
1601 mExtras.putAll(extras);
1602 }
1603 return this;
1604 }
1605
1606 /**
1607 * Get the metadata Bundle used by this Builder.
1608 *
1609 * <p>The returned Bundle is shared with this Builder.
1610 */
1611 public Bundle getExtras() {
1612 return mExtras;
1613 }
1614
1615 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001616 * Add an input to be collected from the user when this action is sent.
1617 * Response values can be retrieved from the fired intent by using the
1618 * {@link RemoteInput#getResultsFromIntent} function.
1619 * @param remoteInput a {@link RemoteInput} to add to the action
1620 * @return this object for method chaining
1621 */
1622 public Builder addRemoteInput(RemoteInput remoteInput) {
1623 if (mRemoteInputs == null) {
1624 mRemoteInputs = new ArrayList<RemoteInput>();
1625 }
1626 mRemoteInputs.add(remoteInput);
1627 return this;
1628 }
1629
1630 /**
Alex Hills42b0c4d2016-04-26 13:35:36 -04001631 * Set whether the platform should automatically generate possible replies to add to
1632 * {@link RemoteInput#getChoices()}. If the {@link Action} doesn't have a
1633 * {@link RemoteInput}, this has no effect.
1634 * @param allowGeneratedReplies {@code true} to allow generated replies, {@code false}
1635 * otherwise
1636 * @return this object for method chaining
Alex Hills1f27f882017-01-12 11:24:46 -05001637 * The default value is {@code true}
Alex Hills42b0c4d2016-04-26 13:35:36 -04001638 */
1639 public Builder setAllowGeneratedReplies(boolean allowGeneratedReplies) {
1640 mAllowGeneratedReplies = allowGeneratedReplies;
1641 return this;
1642 }
1643
1644 /**
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001645 * Sets the {@code SemanticAction} for this {@link Action}. A
1646 * {@code SemanticAction} denotes what an {@link Action}'s
1647 * {@link PendingIntent} will do (eg. reply, mark as read, delete, etc).
1648 * @param semanticAction a SemanticAction defined within {@link Action} with
1649 * {@code SEMANTIC_ACTION_} prefixes
1650 * @return this object for method chaining
1651 */
1652 public Builder setSemanticAction(@SemanticAction int semanticAction) {
1653 mSemanticAction = semanticAction;
1654 return this;
1655 }
1656
1657 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001658 * Apply an extender to this action builder. Extenders may be used to add
1659 * metadata or change options on this builder.
1660 */
Griff Hazen61a9e862014-05-22 16:05:19 -07001661 public Builder extend(Extender extender) {
1662 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001663 return this;
1664 }
1665
1666 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001667 * Combine all of the options that have been set and return a new {@link Action}
1668 * object.
1669 * @return the built action
1670 */
1671 public Action build() {
Shane Brennan472a3b32016-12-12 15:28:10 -08001672 ArrayList<RemoteInput> dataOnlyInputs = new ArrayList<>();
1673 RemoteInput[] previousDataInputs =
1674 (RemoteInput[]) mExtras.getParcelableArray(EXTRA_DATA_ONLY_INPUTS);
Felipe Lemedfd11962017-01-18 18:38:46 -08001675 if (previousDataInputs != null) {
Shane Brennan472a3b32016-12-12 15:28:10 -08001676 for (RemoteInput input : previousDataInputs) {
1677 dataOnlyInputs.add(input);
1678 }
1679 }
1680 List<RemoteInput> textInputs = new ArrayList<>();
1681 if (mRemoteInputs != null) {
1682 for (RemoteInput input : mRemoteInputs) {
1683 if (input.isDataOnly()) {
1684 dataOnlyInputs.add(input);
1685 } else {
1686 textInputs.add(input);
1687 }
1688 }
1689 }
1690 if (!dataOnlyInputs.isEmpty()) {
1691 RemoteInput[] dataInputsArr =
1692 dataOnlyInputs.toArray(new RemoteInput[dataOnlyInputs.size()]);
1693 mExtras.putParcelableArray(EXTRA_DATA_ONLY_INPUTS, dataInputsArr);
1694 }
1695 RemoteInput[] textInputsArr = textInputs.isEmpty()
1696 ? null : textInputs.toArray(new RemoteInput[textInputs.size()]);
1697 return new Action(mIcon, mTitle, mIntent, mExtras, textInputsArr,
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001698 mAllowGeneratedReplies, mSemanticAction);
Griff Hazen959591e2014-05-15 22:26:18 -07001699 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001700 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001701
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001702 @Override
1703 public Action clone() {
1704 return new Action(
Dan Sandler86647982015-05-13 23:41:13 -04001705 getIcon(),
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001706 title,
1707 actionIntent, // safe to alias
Julia Reynolds53c934c2016-09-16 14:03:43 -04001708 mExtras == null ? new Bundle() : new Bundle(mExtras),
Alex Hills42b0c4d2016-04-26 13:35:36 -04001709 getRemoteInputs(),
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001710 getAllowGeneratedReplies(),
1711 getSemanticAction());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001712 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001713
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001714 @Override
1715 public int describeContents() {
1716 return 0;
1717 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001718
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001719 @Override
1720 public void writeToParcel(Parcel out, int flags) {
Dan Sandler86647982015-05-13 23:41:13 -04001721 final Icon ic = getIcon();
1722 if (ic != null) {
1723 out.writeInt(1);
1724 ic.writeToParcel(out, 0);
1725 } else {
1726 out.writeInt(0);
1727 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001728 TextUtils.writeToParcel(title, out, flags);
1729 if (actionIntent != null) {
1730 out.writeInt(1);
1731 actionIntent.writeToParcel(out, flags);
1732 } else {
1733 out.writeInt(0);
1734 }
Griff Hazen959591e2014-05-15 22:26:18 -07001735 out.writeBundle(mExtras);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001736 out.writeTypedArray(mRemoteInputs, flags);
Alex Hills42b0c4d2016-04-26 13:35:36 -04001737 out.writeInt(mAllowGeneratedReplies ? 1 : 0);
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001738 out.writeInt(mSemanticAction);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001739 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001740
Griff Hazen959591e2014-05-15 22:26:18 -07001741 public static final Parcelable.Creator<Action> CREATOR =
1742 new Parcelable.Creator<Action>() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001743 public Action createFromParcel(Parcel in) {
1744 return new Action(in);
1745 }
1746 public Action[] newArray(int size) {
1747 return new Action[size];
1748 }
1749 };
Griff Hazen61a9e862014-05-22 16:05:19 -07001750
1751 /**
1752 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
1753 * metadata or change options on an action builder.
1754 */
1755 public interface Extender {
1756 /**
1757 * Apply this extender to a notification action builder.
1758 * @param builder the builder to be modified.
1759 * @return the build object for chaining.
1760 */
1761 public Builder extend(Builder builder);
1762 }
1763
1764 /**
1765 * Wearable extender for notification actions. To add extensions to an action,
1766 * create a new {@link android.app.Notification.Action.WearableExtender} object using
1767 * the {@code WearableExtender()} constructor and apply it to a
1768 * {@link android.app.Notification.Action.Builder} using
1769 * {@link android.app.Notification.Action.Builder#extend}.
1770 *
1771 * <pre class="prettyprint">
1772 * Notification.Action action = new Notification.Action.Builder(
1773 * R.drawable.archive_all, "Archive all", actionIntent)
Griff Hazen14f57992014-05-26 09:07:14 -07001774 * .extend(new Notification.Action.WearableExtender()
Griff Hazen61a9e862014-05-22 16:05:19 -07001775 * .setAvailableOffline(false))
Griff Hazen14f57992014-05-26 09:07:14 -07001776 * .build();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07001777 */
1778 public static final class WearableExtender implements Extender {
1779 /** Notification action extra which contains wearable extensions */
1780 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
1781
Pete Gastaf6781d2014-10-07 15:17:05 -04001782 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07001783 private static final String KEY_FLAGS = "flags";
Pete Gastaf6781d2014-10-07 15:17:05 -04001784 private static final String KEY_IN_PROGRESS_LABEL = "inProgressLabel";
1785 private static final String KEY_CONFIRM_LABEL = "confirmLabel";
1786 private static final String KEY_CANCEL_LABEL = "cancelLabel";
Griff Hazen61a9e862014-05-22 16:05:19 -07001787
1788 // Flags bitwise-ored to mFlags
1789 private static final int FLAG_AVAILABLE_OFFLINE = 0x1;
Alex Hills9ab3a232016-04-05 14:54:56 -04001790 private static final int FLAG_HINT_LAUNCHES_ACTIVITY = 1 << 1;
Alex Hills9f087612016-06-07 09:08:59 -04001791 private static final int FLAG_HINT_DISPLAY_INLINE = 1 << 2;
Griff Hazen61a9e862014-05-22 16:05:19 -07001792
1793 // Default value for flags integer
1794 private static final int DEFAULT_FLAGS = FLAG_AVAILABLE_OFFLINE;
1795
1796 private int mFlags = DEFAULT_FLAGS;
1797
Pete Gastaf6781d2014-10-07 15:17:05 -04001798 private CharSequence mInProgressLabel;
1799 private CharSequence mConfirmLabel;
1800 private CharSequence mCancelLabel;
1801
Griff Hazen61a9e862014-05-22 16:05:19 -07001802 /**
1803 * Create a {@link android.app.Notification.Action.WearableExtender} with default
1804 * options.
1805 */
1806 public WearableExtender() {
1807 }
1808
1809 /**
1810 * Create a {@link android.app.Notification.Action.WearableExtender} by reading
1811 * wearable options present in an existing notification action.
1812 * @param action the notification action to inspect.
1813 */
1814 public WearableExtender(Action action) {
1815 Bundle wearableBundle = action.getExtras().getBundle(EXTRA_WEARABLE_EXTENSIONS);
1816 if (wearableBundle != null) {
1817 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
Pete Gastaf6781d2014-10-07 15:17:05 -04001818 mInProgressLabel = wearableBundle.getCharSequence(KEY_IN_PROGRESS_LABEL);
1819 mConfirmLabel = wearableBundle.getCharSequence(KEY_CONFIRM_LABEL);
1820 mCancelLabel = wearableBundle.getCharSequence(KEY_CANCEL_LABEL);
Griff Hazen61a9e862014-05-22 16:05:19 -07001821 }
1822 }
1823
1824 /**
1825 * Apply wearable extensions to a notification action that is being built. This is
1826 * typically called by the {@link android.app.Notification.Action.Builder#extend}
1827 * method of {@link android.app.Notification.Action.Builder}.
1828 */
1829 @Override
1830 public Action.Builder extend(Action.Builder builder) {
1831 Bundle wearableBundle = new Bundle();
1832
1833 if (mFlags != DEFAULT_FLAGS) {
1834 wearableBundle.putInt(KEY_FLAGS, mFlags);
1835 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001836 if (mInProgressLabel != null) {
1837 wearableBundle.putCharSequence(KEY_IN_PROGRESS_LABEL, mInProgressLabel);
1838 }
1839 if (mConfirmLabel != null) {
1840 wearableBundle.putCharSequence(KEY_CONFIRM_LABEL, mConfirmLabel);
1841 }
1842 if (mCancelLabel != null) {
1843 wearableBundle.putCharSequence(KEY_CANCEL_LABEL, mCancelLabel);
1844 }
Griff Hazen61a9e862014-05-22 16:05:19 -07001845
1846 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
1847 return builder;
1848 }
1849
1850 @Override
1851 public WearableExtender clone() {
1852 WearableExtender that = new WearableExtender();
1853 that.mFlags = this.mFlags;
Pete Gastaf6781d2014-10-07 15:17:05 -04001854 that.mInProgressLabel = this.mInProgressLabel;
1855 that.mConfirmLabel = this.mConfirmLabel;
1856 that.mCancelLabel = this.mCancelLabel;
Griff Hazen61a9e862014-05-22 16:05:19 -07001857 return that;
1858 }
1859
1860 /**
1861 * Set whether this action is available when the wearable device is not connected to
1862 * a companion device. The user can still trigger this action when the wearable device is
1863 * offline, but a visual hint will indicate that the action may not be available.
1864 * Defaults to true.
1865 */
1866 public WearableExtender setAvailableOffline(boolean availableOffline) {
1867 setFlag(FLAG_AVAILABLE_OFFLINE, availableOffline);
1868 return this;
1869 }
1870
1871 /**
1872 * Get whether this action is available when the wearable device is not connected to
1873 * a companion device. The user can still trigger this action when the wearable device is
1874 * offline, but a visual hint will indicate that the action may not be available.
1875 * Defaults to true.
1876 */
1877 public boolean isAvailableOffline() {
1878 return (mFlags & FLAG_AVAILABLE_OFFLINE) != 0;
1879 }
1880
1881 private void setFlag(int mask, boolean value) {
1882 if (value) {
1883 mFlags |= mask;
1884 } else {
1885 mFlags &= ~mask;
1886 }
1887 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001888
1889 /**
1890 * Set a label to display while the wearable is preparing to automatically execute the
1891 * action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1892 *
1893 * @param label the label to display while the action is being prepared to execute
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 setInProgressLabel(CharSequence label) {
1898 mInProgressLabel = label;
1899 return this;
1900 }
1901
1902 /**
1903 * Get the label to display while the wearable is preparing to automatically execute
1904 * the action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1905 *
1906 * @return the label to display while the action is being prepared to execute
1907 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001908 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001909 public CharSequence getInProgressLabel() {
1910 return mInProgressLabel;
1911 }
1912
1913 /**
1914 * Set a label to display to confirm that the action should be executed.
1915 * This is usually an imperative verb like "Send".
1916 *
1917 * @param label the label to confirm the action should be executed
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 setConfirmLabel(CharSequence label) {
1922 mConfirmLabel = label;
1923 return this;
1924 }
1925
1926 /**
1927 * Get the label to display to confirm that the action should be executed.
1928 * This is usually an imperative verb like "Send".
1929 *
1930 * @return the label to confirm the action should be executed
1931 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001932 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001933 public CharSequence getConfirmLabel() {
1934 return mConfirmLabel;
1935 }
1936
1937 /**
1938 * Set a label to display to cancel the action.
1939 * This is usually an imperative verb, like "Cancel".
1940 *
1941 * @param label the label to display to cancel the action
1942 * @return this object for method chaining
1943 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001944 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001945 public WearableExtender setCancelLabel(CharSequence label) {
1946 mCancelLabel = label;
1947 return this;
1948 }
1949
1950 /**
1951 * Get the label to display to cancel the action.
1952 * This is usually an imperative verb like "Cancel".
1953 *
1954 * @return the label to display to cancel the action
1955 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001956 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001957 public CharSequence getCancelLabel() {
1958 return mCancelLabel;
1959 }
Alex Hills9ab3a232016-04-05 14:54:56 -04001960
1961 /**
1962 * Set a hint that this Action will launch an {@link Activity} directly, telling the
1963 * platform that it can generate the appropriate transitions.
1964 * @param hintLaunchesActivity {@code true} if the content intent will launch
1965 * an activity and transitions should be generated, false otherwise.
1966 * @return this object for method chaining
1967 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001968 public WearableExtender setHintLaunchesActivity(
Alex Hills9ab3a232016-04-05 14:54:56 -04001969 boolean hintLaunchesActivity) {
1970 setFlag(FLAG_HINT_LAUNCHES_ACTIVITY, hintLaunchesActivity);
1971 return this;
1972 }
1973
1974 /**
1975 * Get a hint that this Action will launch an {@link Activity} directly, telling the
1976 * platform that it can generate the appropriate transitions
1977 * @return {@code true} if the content intent will launch an activity and transitions
1978 * should be generated, false otherwise. The default value is {@code false} if this was
1979 * never set.
1980 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001981 public boolean getHintLaunchesActivity() {
Alex Hills9ab3a232016-04-05 14:54:56 -04001982 return (mFlags & FLAG_HINT_LAUNCHES_ACTIVITY) != 0;
1983 }
Alex Hills9f087612016-06-07 09:08:59 -04001984
1985 /**
1986 * Set a hint that this Action should be displayed inline.
1987 *
1988 * @param hintDisplayInline {@code true} if action should be displayed inline, false
1989 * otherwise
1990 * @return this object for method chaining
1991 */
1992 public WearableExtender setHintDisplayActionInline(
1993 boolean hintDisplayInline) {
1994 setFlag(FLAG_HINT_DISPLAY_INLINE, hintDisplayInline);
1995 return this;
1996 }
1997
1998 /**
1999 * Get a hint that this Action should be displayed inline.
2000 *
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08002001 * @return {@code true} if the Action should be displayed inline, {@code false}
Alex Hills9f087612016-06-07 09:08:59 -04002002 * otherwise. The default value is {@code false} if this was never set.
2003 */
2004 public boolean getHintDisplayActionInline() {
2005 return (mFlags & FLAG_HINT_DISPLAY_INLINE) != 0;
2006 }
Griff Hazen61a9e862014-05-22 16:05:19 -07002007 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00002008
2009 /**
2010 * Provides meaning to an {@link Action} that hints at what the associated
2011 * {@link PendingIntent} will do. For example, an {@link Action} with a
2012 * {@link PendingIntent} that replies to a text message notification may have the
2013 * {@link #SEMANTIC_ACTION_REPLY} {@code SemanticAction} set within it.
2014 *
2015 * @hide
2016 */
2017 @IntDef(prefix = { "SEMANTIC_ACTION_" }, value = {
2018 SEMANTIC_ACTION_NONE,
2019 SEMANTIC_ACTION_REPLY,
2020 SEMANTIC_ACTION_MARK_AS_READ,
2021 SEMANTIC_ACTION_MARK_AS_UNREAD,
2022 SEMANTIC_ACTION_DELETE,
2023 SEMANTIC_ACTION_ARCHIVE,
2024 SEMANTIC_ACTION_MUTE,
2025 SEMANTIC_ACTION_UNMUTE,
2026 SEMANTIC_ACTION_THUMBS_UP,
Kodlee Yincda5b092018-02-15 15:34:53 -08002027 SEMANTIC_ACTION_THUMBS_DOWN,
2028 SEMANTIC_ACTION_CALL
Kodlee Yinc72c44d2017-12-21 22:07:15 +00002029 })
2030 @Retention(RetentionPolicy.SOURCE)
2031 public @interface SemanticAction {}
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002032 }
2033
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04002034 /**
2035 * Array of all {@link Action} structures attached to this notification by
2036 * {@link Builder#addAction(int, CharSequence, PendingIntent)}. Mostly useful for instances of
2037 * {@link android.service.notification.NotificationListenerService} that provide an alternative
2038 * interface for invoking actions.
2039 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -05002040 public Action[] actions;
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002041
2042 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002043 * Replacement version of this notification whose content will be shown
2044 * in an insecure context such as atop a secure keyguard. See {@link #visibility}
2045 * and {@link #VISIBILITY_PUBLIC}.
2046 */
2047 public Notification publicVersion;
2048
2049 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002050 * Constructs a Notification object with default values.
Joe Onorato46439ce2010-11-19 13:56:21 -08002051 * You might want to consider using {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002052 */
2053 public Notification()
2054 {
2055 this.when = System.currentTimeMillis();
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002056 this.creationTime = System.currentTimeMillis();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002057 this.priority = PRIORITY_DEFAULT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002058 }
2059
2060 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002061 * @hide
2062 */
2063 public Notification(Context context, int icon, CharSequence tickerText, long when,
2064 CharSequence contentTitle, CharSequence contentText, Intent contentIntent)
2065 {
Chris Wren1ce4b6d2015-06-11 10:19:43 -04002066 new Builder(context)
2067 .setWhen(when)
2068 .setSmallIcon(icon)
2069 .setTicker(tickerText)
2070 .setContentTitle(contentTitle)
2071 .setContentText(contentText)
2072 .setContentIntent(PendingIntent.getActivity(context, 0, contentIntent, 0))
2073 .buildInto(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002074 }
2075
2076 /**
2077 * Constructs a Notification object with the information needed to
2078 * have a status bar icon without the standard expanded view.
2079 *
2080 * @param icon The resource id of the icon to put in the status bar.
2081 * @param tickerText The text that flows by in the status bar when the notification first
2082 * activates.
2083 * @param when The time to show in the time field. In the System.currentTimeMillis
2084 * timebase.
Joe Onorato46439ce2010-11-19 13:56:21 -08002085 *
2086 * @deprecated Use {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002087 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002088 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002089 public Notification(int icon, CharSequence tickerText, long when)
2090 {
2091 this.icon = icon;
2092 this.tickerText = tickerText;
2093 this.when = when;
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002094 this.creationTime = System.currentTimeMillis();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002095 }
2096
2097 /**
2098 * Unflatten the notification from a parcel.
2099 */
Svet Ganovddb94882016-06-23 19:55:24 -07002100 @SuppressWarnings("unchecked")
2101 public Notification(Parcel parcel) {
2102 // IMPORTANT: Add unmarshaling code in readFromParcel as the pending
2103 // intents in extras are always written as the last entry.
2104 readFromParcelImpl(parcel);
2105 // Must be read last!
Felipe Lemedd85da62016-06-28 11:29:54 -07002106 allPendingIntents = (ArraySet<PendingIntent>) parcel.readArraySet(null);
Svet Ganovddb94882016-06-23 19:55:24 -07002107 }
2108
2109 private void readFromParcelImpl(Parcel parcel)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002110 {
2111 int version = parcel.readInt();
2112
Adrian Roosfb921842017-10-26 14:49:56 +02002113 mWhitelistToken = parcel.readStrongBinder();
2114 if (mWhitelistToken == null) {
2115 mWhitelistToken = processWhitelistToken;
Dianne Hackborn98305522017-05-05 17:53:53 -07002116 }
2117 // Propagate this token to all pending intents that are unmarshalled from the parcel.
Adrian Roosfb921842017-10-26 14:49:56 +02002118 parcel.setClassCookie(PendingIntent.class, mWhitelistToken);
Dianne Hackborn98305522017-05-05 17:53:53 -07002119
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002120 when = parcel.readLong();
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002121 creationTime = parcel.readLong();
Dan Sandler3936e7a2015-05-19 20:59:12 -04002122 if (parcel.readInt() != 0) {
2123 mSmallIcon = Icon.CREATOR.createFromParcel(parcel);
Dan Sandler4e787062015-06-17 15:09:48 -04002124 if (mSmallIcon.getType() == Icon.TYPE_RESOURCE) {
2125 icon = mSmallIcon.getResId();
2126 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04002127 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002128 number = parcel.readInt();
2129 if (parcel.readInt() != 0) {
2130 contentIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2131 }
2132 if (parcel.readInt() != 0) {
2133 deleteIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2134 }
2135 if (parcel.readInt() != 0) {
2136 tickerText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
2137 }
2138 if (parcel.readInt() != 0) {
Joe Onorato46439ce2010-11-19 13:56:21 -08002139 tickerView = RemoteViews.CREATOR.createFromParcel(parcel);
Joe Onoratoef1e7762010-09-17 18:38:38 -04002140 }
2141 if (parcel.readInt() != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002142 contentView = RemoteViews.CREATOR.createFromParcel(parcel);
2143 }
Joe Onorato561d3852010-11-20 18:09:34 -08002144 if (parcel.readInt() != 0) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04002145 mLargeIcon = Icon.CREATOR.createFromParcel(parcel);
Joe Onorato561d3852010-11-20 18:09:34 -08002146 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002147 defaults = parcel.readInt();
2148 flags = parcel.readInt();
2149 if (parcel.readInt() != 0) {
2150 sound = Uri.CREATOR.createFromParcel(parcel);
2151 }
2152
2153 audioStreamType = parcel.readInt();
John Spurlockc0650f022014-07-19 13:22:39 -04002154 if (parcel.readInt() != 0) {
2155 audioAttributes = AudioAttributes.CREATOR.createFromParcel(parcel);
2156 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002157 vibrate = parcel.createLongArray();
2158 ledARGB = parcel.readInt();
2159 ledOnMS = parcel.readInt();
2160 ledOffMS = parcel.readInt();
2161 iconLevel = parcel.readInt();
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002162
2163 if (parcel.readInt() != 0) {
2164 fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2165 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002166
2167 priority = parcel.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002168
John Spurlockfd7f1e02014-03-18 16:41:57 -04002169 category = parcel.readString();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002170
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002171 mGroupKey = parcel.readString();
2172
2173 mSortKey = parcel.readString();
2174
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06002175 extras = Bundle.setDefusable(parcel.readBundle(), true); // may be null
Robin Leead7e72a2017-12-04 15:45:46 +01002176 fixDuplicateExtras();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002177
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002178 actions = parcel.createTypedArray(Action.CREATOR); // may be null
2179
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002180 if (parcel.readInt() != 0) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002181 bigContentView = RemoteViews.CREATOR.createFromParcel(parcel);
2182 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002183
Chris Wren8fd39ec2014-02-27 17:43:26 -05002184 if (parcel.readInt() != 0) {
2185 headsUpContentView = RemoteViews.CREATOR.createFromParcel(parcel);
2186 }
2187
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002188 visibility = parcel.readInt();
2189
2190 if (parcel.readInt() != 0) {
2191 publicVersion = Notification.CREATOR.createFromParcel(parcel);
2192 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04002193
2194 color = parcel.readInt();
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002195
2196 if (parcel.readInt() != 0) {
2197 mChannelId = parcel.readString();
2198 }
Julia Reynolds2a128742016-11-28 14:29:25 -05002199 mTimeout = parcel.readLong();
Julia Reynolds13d898c2017-02-02 12:22:05 -05002200
2201 if (parcel.readInt() != 0) {
2202 mShortcutId = parcel.readString();
2203 }
2204
2205 mBadgeIcon = parcel.readInt();
Julia Reynolds3aedded2017-03-31 14:42:09 -04002206
2207 if (parcel.readInt() != 0) {
2208 mSettingsText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
2209 }
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002210
2211 mGroupAlertBehavior = parcel.readInt();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002212 }
2213
Andy Stadler110988c2010-12-03 14:29:16 -08002214 @Override
Joe Onorato18e69df2010-05-17 22:26:12 -07002215 public Notification clone() {
2216 Notification that = new Notification();
Daniel Sandler1a497d32013-04-18 14:52:45 -04002217 cloneInto(that, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002218 return that;
2219 }
Joe Onorato18e69df2010-05-17 22:26:12 -07002220
Daniel Sandler1a497d32013-04-18 14:52:45 -04002221 /**
2222 * Copy all (or if heavy is false, all except Bitmaps and RemoteViews) members
2223 * of this into that.
2224 * @hide
2225 */
2226 public void cloneInto(Notification that, boolean heavy) {
Adrian Roosfb921842017-10-26 14:49:56 +02002227 that.mWhitelistToken = this.mWhitelistToken;
Joe Onorato18e69df2010-05-17 22:26:12 -07002228 that.when = this.when;
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002229 that.creationTime = this.creationTime;
Dan Sandlerd63f9322015-05-06 15:18:49 -04002230 that.mSmallIcon = this.mSmallIcon;
Joe Onorato18e69df2010-05-17 22:26:12 -07002231 that.number = this.number;
2232
2233 // PendingIntents are global, so there's no reason (or way) to clone them.
2234 that.contentIntent = this.contentIntent;
2235 that.deleteIntent = this.deleteIntent;
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002236 that.fullScreenIntent = this.fullScreenIntent;
Joe Onorato18e69df2010-05-17 22:26:12 -07002237
2238 if (this.tickerText != null) {
2239 that.tickerText = this.tickerText.toString();
2240 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002241 if (heavy && this.tickerView != null) {
Joe Onorato46439ce2010-11-19 13:56:21 -08002242 that.tickerView = this.tickerView.clone();
Joe Onoratoef1e7762010-09-17 18:38:38 -04002243 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002244 if (heavy && this.contentView != null) {
Joe Onorato18e69df2010-05-17 22:26:12 -07002245 that.contentView = this.contentView.clone();
2246 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04002247 if (heavy && this.mLargeIcon != null) {
2248 that.mLargeIcon = this.mLargeIcon;
Joe Onorato561d3852010-11-20 18:09:34 -08002249 }
Jozef BABJAKa8b91832011-02-22 08:05:08 +01002250 that.iconLevel = this.iconLevel;
Joe Onorato18e69df2010-05-17 22:26:12 -07002251 that.sound = this.sound; // android.net.Uri is immutable
2252 that.audioStreamType = this.audioStreamType;
John Spurlockc0650f022014-07-19 13:22:39 -04002253 if (this.audioAttributes != null) {
2254 that.audioAttributes = new AudioAttributes.Builder(this.audioAttributes).build();
2255 }
Joe Onorato18e69df2010-05-17 22:26:12 -07002256
2257 final long[] vibrate = this.vibrate;
2258 if (vibrate != null) {
2259 final int N = vibrate.length;
2260 final long[] vib = that.vibrate = new long[N];
2261 System.arraycopy(vibrate, 0, vib, 0, N);
2262 }
2263
2264 that.ledARGB = this.ledARGB;
2265 that.ledOnMS = this.ledOnMS;
2266 that.ledOffMS = this.ledOffMS;
2267 that.defaults = this.defaults;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002268
Joe Onorato18e69df2010-05-17 22:26:12 -07002269 that.flags = this.flags;
2270
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002271 that.priority = this.priority;
Joe Malin8d40d042012-11-05 11:36:40 -08002272
John Spurlockfd7f1e02014-03-18 16:41:57 -04002273 that.category = this.category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002274
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002275 that.mGroupKey = this.mGroupKey;
2276
2277 that.mSortKey = this.mSortKey;
2278
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002279 if (this.extras != null) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002280 try {
2281 that.extras = new Bundle(this.extras);
2282 // will unparcel
2283 that.extras.size();
2284 } catch (BadParcelableException e) {
2285 Log.e(TAG, "could not unparcel extras from notification: " + this, e);
2286 that.extras = null;
2287 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002288 }
2289
Felipe Lemedd85da62016-06-28 11:29:54 -07002290 if (!ArrayUtils.isEmpty(allPendingIntents)) {
2291 that.allPendingIntents = new ArraySet<>(allPendingIntents);
Svet Ganovddb94882016-06-23 19:55:24 -07002292 }
2293
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002294 if (this.actions != null) {
2295 that.actions = new Action[this.actions.length];
2296 for(int i=0; i<this.actions.length; i++) {
liangweikang63b03b52017-03-16 19:22:15 +08002297 if ( this.actions[i] != null) {
2298 that.actions[i] = this.actions[i].clone();
2299 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002300 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002301 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002302
Daniel Sandler1a497d32013-04-18 14:52:45 -04002303 if (heavy && this.bigContentView != null) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002304 that.bigContentView = this.bigContentView.clone();
2305 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002306
Chris Wren8fd39ec2014-02-27 17:43:26 -05002307 if (heavy && this.headsUpContentView != null) {
2308 that.headsUpContentView = this.headsUpContentView.clone();
2309 }
2310
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002311 that.visibility = this.visibility;
2312
2313 if (this.publicVersion != null) {
2314 that.publicVersion = new Notification();
2315 this.publicVersion.cloneInto(that.publicVersion, heavy);
2316 }
2317
Dan Sandler26e81cf2014-05-06 10:01:27 -04002318 that.color = this.color;
2319
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002320 that.mChannelId = this.mChannelId;
Julia Reynolds2a128742016-11-28 14:29:25 -05002321 that.mTimeout = this.mTimeout;
Julia Reynolds3aedded2017-03-31 14:42:09 -04002322 that.mShortcutId = this.mShortcutId;
2323 that.mBadgeIcon = this.mBadgeIcon;
2324 that.mSettingsText = this.mSettingsText;
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002325 that.mGroupAlertBehavior = this.mGroupAlertBehavior;
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002326
Daniel Sandler1a497d32013-04-18 14:52:45 -04002327 if (!heavy) {
2328 that.lightenPayload(); // will clean out extras
2329 }
2330 }
2331
2332 /**
Jeff Sharkey23b31182018-04-18 21:32:12 -06002333 * Note all {@link Uri} that are referenced internally, with the expectation
2334 * that Uri permission grants will need to be issued to ensure the recipient
2335 * of this object is able to render its contents.
2336 *
2337 * @hide
2338 */
2339 public void visitUris(@NonNull Consumer<Uri> visitor) {
2340 visitor.accept(sound);
2341
2342 if (tickerView != null) tickerView.visitUris(visitor);
2343 if (contentView != null) contentView.visitUris(visitor);
2344 if (bigContentView != null) bigContentView.visitUris(visitor);
2345 if (headsUpContentView != null) headsUpContentView.visitUris(visitor);
2346
2347 if (extras != null) {
2348 visitor.accept(extras.getParcelable(EXTRA_AUDIO_CONTENTS_URI));
2349 visitor.accept(extras.getParcelable(EXTRA_BACKGROUND_IMAGE_URI));
2350 }
2351
2352 if (MessagingStyle.class.equals(getNotificationStyle()) && extras != null) {
2353 final Parcelable[] messages = extras.getParcelableArray(EXTRA_MESSAGES);
2354 if (!ArrayUtils.isEmpty(messages)) {
2355 for (MessagingStyle.Message message : MessagingStyle.Message
2356 .getMessagesFromBundleArray(messages)) {
2357 visitor.accept(message.getDataUri());
2358 }
2359 }
2360
2361 final Parcelable[] historic = extras.getParcelableArray(EXTRA_HISTORIC_MESSAGES);
2362 if (!ArrayUtils.isEmpty(historic)) {
2363 for (MessagingStyle.Message message : MessagingStyle.Message
2364 .getMessagesFromBundleArray(historic)) {
2365 visitor.accept(message.getDataUri());
2366 }
2367 }
2368 }
2369 }
2370
2371 /**
Daniel Sandler1a497d32013-04-18 14:52:45 -04002372 * Removes heavyweight parts of the Notification object for archival or for sending to
2373 * listeners when the full contents are not necessary.
2374 * @hide
2375 */
2376 public final void lightenPayload() {
2377 tickerView = null;
2378 contentView = null;
2379 bigContentView = null;
Chris Wren8fd39ec2014-02-27 17:43:26 -05002380 headsUpContentView = null;
Dan Sandlerd63f9322015-05-06 15:18:49 -04002381 mLargeIcon = null;
Dan Sandler50128532015-12-08 15:42:41 -05002382 if (extras != null && !extras.isEmpty()) {
2383 final Set<String> keyset = extras.keySet();
2384 final int N = keyset.size();
2385 final String[] keys = keyset.toArray(new String[N]);
2386 for (int i=0; i<N; i++) {
2387 final String key = keys[i];
Dmitri Plotnikov22281362017-01-30 11:16:21 -08002388 if (TvExtender.EXTRA_TV_EXTENDER.equals(key)) {
2389 continue;
2390 }
Dan Sandler50128532015-12-08 15:42:41 -05002391 final Object obj = extras.get(key);
2392 if (obj != null &&
2393 ( obj instanceof Parcelable
2394 || obj instanceof Parcelable[]
2395 || obj instanceof SparseArray
2396 || obj instanceof ArrayList)) {
2397 extras.remove(key);
2398 }
2399 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002400 }
Joe Onorato18e69df2010-05-17 22:26:12 -07002401 }
2402
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002403 /**
2404 * Make sure this CharSequence is safe to put into a bundle, which basically
2405 * means it had better not be some custom Parcelable implementation.
2406 * @hide
2407 */
2408 public static CharSequence safeCharSequence(CharSequence cs) {
Christoph Studer535ec612014-09-03 15:47:47 +02002409 if (cs == null) return cs;
2410 if (cs.length() > MAX_CHARSEQUENCE_LENGTH) {
2411 cs = cs.subSequence(0, MAX_CHARSEQUENCE_LENGTH);
2412 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002413 if (cs instanceof Parcelable) {
2414 Log.e(TAG, "warning: " + cs.getClass().getCanonicalName()
2415 + " instance is a custom Parcelable and not allowed in Notification");
2416 return cs.toString();
2417 }
Selim Cinek60a54252016-02-26 17:03:25 -08002418 return removeTextSizeSpans(cs);
2419 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002420
Selim Cinek60a54252016-02-26 17:03:25 -08002421 private static CharSequence removeTextSizeSpans(CharSequence charSequence) {
2422 if (charSequence instanceof Spanned) {
2423 Spanned ss = (Spanned) charSequence;
2424 Object[] spans = ss.getSpans(0, ss.length(), Object.class);
2425 SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
2426 for (Object span : spans) {
2427 Object resultSpan = span;
Selim Cinek89991a22016-03-07 19:51:54 -08002428 if (resultSpan instanceof CharacterStyle) {
2429 resultSpan = ((CharacterStyle) span).getUnderlying();
2430 }
2431 if (resultSpan instanceof TextAppearanceSpan) {
2432 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
Selim Cinek60a54252016-02-26 17:03:25 -08002433 resultSpan = new TextAppearanceSpan(
2434 originalSpan.getFamily(),
2435 originalSpan.getTextStyle(),
2436 -1,
2437 originalSpan.getTextColor(),
2438 originalSpan.getLinkTextColor());
Selim Cinek89991a22016-03-07 19:51:54 -08002439 } else if (resultSpan instanceof RelativeSizeSpan
2440 || resultSpan instanceof AbsoluteSizeSpan) {
Selim Cinek60a54252016-02-26 17:03:25 -08002441 continue;
Selim Cinek89991a22016-03-07 19:51:54 -08002442 } else {
2443 resultSpan = span;
Selim Cinek60a54252016-02-26 17:03:25 -08002444 }
2445 builder.setSpan(resultSpan, ss.getSpanStart(span), ss.getSpanEnd(span),
2446 ss.getSpanFlags(span));
2447 }
2448 return builder;
2449 }
2450 return charSequence;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002451 }
2452
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002453 public int describeContents() {
2454 return 0;
2455 }
2456
2457 /**
Dan Sandler4e787062015-06-17 15:09:48 -04002458 * Flatten this notification into a parcel.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002459 */
Svet Ganovddb94882016-06-23 19:55:24 -07002460 public void writeToParcel(Parcel parcel, int flags) {
2461 // We need to mark all pending intents getting into the notification
2462 // system as being put there to later allow the notification ranker
2463 // to launch them and by doing so add the app to the battery saver white
2464 // list for a short period of time. The problem is that the system
2465 // cannot look into the extras as there may be parcelables there that
2466 // the platform does not know how to handle. To go around that we have
2467 // an explicit list of the pending intents in the extras bundle.
Felipe Lemedd85da62016-06-28 11:29:54 -07002468 final boolean collectPendingIntents = (allPendingIntents == null);
Svet Ganovddb94882016-06-23 19:55:24 -07002469 if (collectPendingIntents) {
2470 PendingIntent.setOnMarshaledListener(
2471 (PendingIntent intent, Parcel out, int outFlags) -> {
2472 if (parcel == out) {
Felipe Lemedd85da62016-06-28 11:29:54 -07002473 if (allPendingIntents == null) {
2474 allPendingIntents = new ArraySet<>();
Svet Ganovddb94882016-06-23 19:55:24 -07002475 }
Felipe Lemedd85da62016-06-28 11:29:54 -07002476 allPendingIntents.add(intent);
Svet Ganovddb94882016-06-23 19:55:24 -07002477 }
2478 });
2479 }
2480 try {
2481 // IMPORTANT: Add marshaling code in writeToParcelImpl as we
Julia Reynolds13d898c2017-02-02 12:22:05 -05002482 // want to intercept all pending events written to the parcel.
Svet Ganovddb94882016-06-23 19:55:24 -07002483 writeToParcelImpl(parcel, flags);
2484 // Must be written last!
Felipe Lemedd85da62016-06-28 11:29:54 -07002485 parcel.writeArraySet(allPendingIntents);
Svet Ganovddb94882016-06-23 19:55:24 -07002486 } finally {
2487 if (collectPendingIntents) {
2488 PendingIntent.setOnMarshaledListener(null);
2489 }
2490 }
2491 }
2492
2493 private void writeToParcelImpl(Parcel parcel, int flags) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002494 parcel.writeInt(1);
2495
Adrian Roosfb921842017-10-26 14:49:56 +02002496 parcel.writeStrongBinder(mWhitelistToken);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002497 parcel.writeLong(when);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002498 parcel.writeLong(creationTime);
Dan Sandler4e787062015-06-17 15:09:48 -04002499 if (mSmallIcon == null && icon != 0) {
2500 // you snuck an icon in here without using the builder; let's try to keep it
2501 mSmallIcon = Icon.createWithResource("", icon);
2502 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04002503 if (mSmallIcon != null) {
2504 parcel.writeInt(1);
2505 mSmallIcon.writeToParcel(parcel, 0);
2506 } else {
2507 parcel.writeInt(0);
2508 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002509 parcel.writeInt(number);
2510 if (contentIntent != null) {
2511 parcel.writeInt(1);
2512 contentIntent.writeToParcel(parcel, 0);
2513 } else {
2514 parcel.writeInt(0);
2515 }
2516 if (deleteIntent != null) {
2517 parcel.writeInt(1);
2518 deleteIntent.writeToParcel(parcel, 0);
2519 } else {
2520 parcel.writeInt(0);
2521 }
2522 if (tickerText != null) {
2523 parcel.writeInt(1);
2524 TextUtils.writeToParcel(tickerText, parcel, flags);
2525 } else {
2526 parcel.writeInt(0);
2527 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002528 if (tickerView != null) {
Joe Onoratoef1e7762010-09-17 18:38:38 -04002529 parcel.writeInt(1);
Joe Onorato46439ce2010-11-19 13:56:21 -08002530 tickerView.writeToParcel(parcel, 0);
Joe Onoratoef1e7762010-09-17 18:38:38 -04002531 } else {
2532 parcel.writeInt(0);
2533 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002534 if (contentView != null) {
2535 parcel.writeInt(1);
2536 contentView.writeToParcel(parcel, 0);
2537 } else {
2538 parcel.writeInt(0);
2539 }
Selim Cinek279fa862016-06-14 10:57:25 -07002540 if (mLargeIcon == null && largeIcon != null) {
2541 // you snuck an icon in here without using the builder; let's try to keep it
2542 mLargeIcon = Icon.createWithBitmap(largeIcon);
2543 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04002544 if (mLargeIcon != null) {
Joe Onorato561d3852010-11-20 18:09:34 -08002545 parcel.writeInt(1);
Dan Sandlerd63f9322015-05-06 15:18:49 -04002546 mLargeIcon.writeToParcel(parcel, 0);
Joe Onorato561d3852010-11-20 18:09:34 -08002547 } else {
2548 parcel.writeInt(0);
2549 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002550
2551 parcel.writeInt(defaults);
2552 parcel.writeInt(this.flags);
2553
2554 if (sound != null) {
2555 parcel.writeInt(1);
2556 sound.writeToParcel(parcel, 0);
2557 } else {
2558 parcel.writeInt(0);
2559 }
2560 parcel.writeInt(audioStreamType);
John Spurlockc0650f022014-07-19 13:22:39 -04002561
2562 if (audioAttributes != null) {
2563 parcel.writeInt(1);
2564 audioAttributes.writeToParcel(parcel, 0);
2565 } else {
2566 parcel.writeInt(0);
2567 }
2568
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002569 parcel.writeLongArray(vibrate);
2570 parcel.writeInt(ledARGB);
2571 parcel.writeInt(ledOnMS);
2572 parcel.writeInt(ledOffMS);
2573 parcel.writeInt(iconLevel);
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002574
2575 if (fullScreenIntent != null) {
2576 parcel.writeInt(1);
2577 fullScreenIntent.writeToParcel(parcel, 0);
2578 } else {
2579 parcel.writeInt(0);
2580 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002581
2582 parcel.writeInt(priority);
Joe Malin8d40d042012-11-05 11:36:40 -08002583
John Spurlockfd7f1e02014-03-18 16:41:57 -04002584 parcel.writeString(category);
Joe Malin8d40d042012-11-05 11:36:40 -08002585
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002586 parcel.writeString(mGroupKey);
2587
2588 parcel.writeString(mSortKey);
2589
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002590 parcel.writeBundle(extras); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002591
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002592 parcel.writeTypedArray(actions, 0); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002593
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002594 if (bigContentView != null) {
2595 parcel.writeInt(1);
2596 bigContentView.writeToParcel(parcel, 0);
2597 } else {
2598 parcel.writeInt(0);
2599 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002600
Chris Wren8fd39ec2014-02-27 17:43:26 -05002601 if (headsUpContentView != null) {
2602 parcel.writeInt(1);
2603 headsUpContentView.writeToParcel(parcel, 0);
2604 } else {
2605 parcel.writeInt(0);
2606 }
2607
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002608 parcel.writeInt(visibility);
2609
2610 if (publicVersion != null) {
2611 parcel.writeInt(1);
2612 publicVersion.writeToParcel(parcel, 0);
2613 } else {
2614 parcel.writeInt(0);
2615 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04002616
2617 parcel.writeInt(color);
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002618
2619 if (mChannelId != null) {
2620 parcel.writeInt(1);
2621 parcel.writeString(mChannelId);
2622 } else {
2623 parcel.writeInt(0);
2624 }
Julia Reynolds2a128742016-11-28 14:29:25 -05002625 parcel.writeLong(mTimeout);
Julia Reynolds13d898c2017-02-02 12:22:05 -05002626
2627 if (mShortcutId != null) {
2628 parcel.writeInt(1);
2629 parcel.writeString(mShortcutId);
2630 } else {
2631 parcel.writeInt(0);
2632 }
2633
2634 parcel.writeInt(mBadgeIcon);
Julia Reynolds3aedded2017-03-31 14:42:09 -04002635
2636 if (mSettingsText != null) {
2637 parcel.writeInt(1);
2638 TextUtils.writeToParcel(mSettingsText, parcel, flags);
2639 } else {
2640 parcel.writeInt(0);
2641 }
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002642
2643 parcel.writeInt(mGroupAlertBehavior);
Julia Reynoldsfc640012018-02-21 12:25:27 -05002644
2645 // mUsesStandardHeader is not written because it should be recomputed in listeners
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002646 }
2647
2648 /**
2649 * Parcelable.Creator that instantiates Notification objects
2650 */
2651 public static final Parcelable.Creator<Notification> CREATOR
2652 = new Parcelable.Creator<Notification>()
2653 {
2654 public Notification createFromParcel(Parcel parcel)
2655 {
2656 return new Notification(parcel);
2657 }
2658
2659 public Notification[] newArray(int size)
2660 {
2661 return new Notification[size];
2662 }
2663 };
2664
2665 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05002666 * @hide
2667 */
2668 public static boolean areActionsVisiblyDifferent(Notification first, Notification second) {
2669 Notification.Action[] firstAs = first.actions;
2670 Notification.Action[] secondAs = second.actions;
2671 if (firstAs == null && secondAs != null || firstAs != null && secondAs == null) {
2672 return true;
2673 }
2674 if (firstAs != null && secondAs != null) {
2675 if (firstAs.length != secondAs.length) {
2676 return true;
2677 }
2678 for (int i = 0; i < firstAs.length; i++) {
Julia Reynoldsa4fb9da2018-06-04 12:27:58 -04002679 if (!Objects.equals(String.valueOf(firstAs[i].title),
2680 String.valueOf(secondAs[i].title))) {
Julia Reynolds7217dc92018-03-07 12:12:09 -05002681 return true;
2682 }
2683 RemoteInput[] firstRs = firstAs[i].getRemoteInputs();
2684 RemoteInput[] secondRs = secondAs[i].getRemoteInputs();
2685 if (firstRs == null) {
2686 firstRs = new RemoteInput[0];
2687 }
2688 if (secondRs == null) {
2689 secondRs = new RemoteInput[0];
2690 }
2691 if (firstRs.length != secondRs.length) {
2692 return true;
2693 }
2694 for (int j = 0; j < firstRs.length; j++) {
Julia Reynoldsa4fb9da2018-06-04 12:27:58 -04002695 if (!Objects.equals(String.valueOf(firstRs[j].getLabel()),
2696 String.valueOf(secondRs[j].getLabel()))) {
Julia Reynolds7217dc92018-03-07 12:12:09 -05002697 return true;
2698 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05002699 }
2700 }
2701 }
2702 return false;
2703 }
2704
2705 /**
2706 * @hide
2707 */
2708 public static boolean areStyledNotificationsVisiblyDifferent(Builder first, Builder second) {
2709 if (first.getStyle() == null) {
2710 return second.getStyle() != null;
2711 }
2712 if (second.getStyle() == null) {
2713 return true;
2714 }
2715 return first.getStyle().areNotificationsVisiblyDifferent(second.getStyle());
2716 }
2717
2718 /**
2719 * @hide
2720 */
2721 public static boolean areRemoteViewsChanged(Builder first, Builder second) {
Julia Reynoldse5c60452018-04-30 14:41:36 -04002722 if (!Objects.equals(first.usesStandardHeader(), second.usesStandardHeader())) {
2723 return true;
2724 }
2725
2726 if (areRemoteViewsChanged(first.mN.contentView, second.mN.contentView)) {
2727 return true;
2728 }
2729 if (areRemoteViewsChanged(first.mN.bigContentView, second.mN.bigContentView)) {
2730 return true;
2731 }
2732 if (areRemoteViewsChanged(first.mN.headsUpContentView, second.mN.headsUpContentView)) {
2733 return true;
2734 }
2735
2736 return false;
2737 }
2738
2739 private static boolean areRemoteViewsChanged(RemoteViews first, RemoteViews second) {
2740 if (first == null && second == null) {
2741 return false;
2742 }
2743 if (first == null && second != null || first != null && second == null) {
2744 return true;
2745 }
2746
2747 if (!Objects.equals(first.getLayoutId(), second.getLayoutId())) {
2748 return true;
2749 }
2750
2751 if (!Objects.equals(first.getSequenceNumber(), second.getSequenceNumber())) {
2752 return true;
2753 }
2754
2755 return false;
Julia Reynolds7217dc92018-03-07 12:12:09 -05002756 }
2757
2758 /**
Robin Leead7e72a2017-12-04 15:45:46 +01002759 * Parcelling creates multiple copies of objects in {@code extras}. Fix them.
2760 * <p>
2761 * For backwards compatibility {@code extras} holds some references to "real" member data such
2762 * as {@link getLargeIcon()} which is mirrored by {@link #EXTRA_LARGE_ICON}. This is mostly
2763 * fine as long as the object stays in one process.
2764 * <p>
2765 * However, once the notification goes into a parcel each reference gets marshalled separately,
2766 * wasting memory. Especially with large images on Auto and TV, this is worth fixing.
2767 */
2768 private void fixDuplicateExtras() {
2769 if (extras != null) {
2770 fixDuplicateExtra(mSmallIcon, EXTRA_SMALL_ICON);
2771 fixDuplicateExtra(mLargeIcon, EXTRA_LARGE_ICON);
2772 }
2773 }
2774
2775 /**
2776 * If we find an extra that's exactly the same as one of the "real" fields but refers to a
2777 * separate object, replace it with the field's version to avoid holding duplicate copies.
2778 */
2779 private void fixDuplicateExtra(@Nullable Parcelable original, @NonNull String extraName) {
2780 if (original != null && extras.getParcelable(extraName) != null) {
2781 extras.putParcelable(extraName, original);
2782 }
2783 }
2784
2785 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002786 * Sets the {@link #contentView} field to be a view with the standard "Latest Event"
2787 * layout.
2788 *
2789 * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields
2790 * in the view.</p>
2791 * @param context The context for your application / activity.
2792 * @param contentTitle The title that goes in the expanded entry.
2793 * @param contentText The text that goes in the expanded entry.
2794 * @param contentIntent The intent to launch when the user clicks the expanded notification.
2795 * If this is an activity, it must include the
2796 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -08002797 * that you take care of task management as described in the
2798 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2799 * Stack</a> document.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002800 *
Joe Onorato46439ce2010-11-19 13:56:21 -08002801 * @deprecated Use {@link Builder} instead.
Chris Wrena05db382015-06-24 15:18:34 -04002802 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002803 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002804 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002805 public void setLatestEventInfo(Context context,
2806 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002807 if (context.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.LOLLIPOP_MR1){
2808 Log.e(TAG, "setLatestEventInfo() is deprecated and you should feel deprecated.",
2809 new Throwable());
2810 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002811
Selim Cinek4ac6f602016-06-13 15:47:03 -07002812 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
2813 extras.putBoolean(EXTRA_SHOW_WHEN, true);
2814 }
2815
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002816 // ensure that any information already set directly is preserved
2817 final Notification.Builder builder = new Notification.Builder(context, this);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002818
2819 // now apply the latestEventInfo fields
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002820 if (contentTitle != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002821 builder.setContentTitle(contentTitle);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002822 }
2823 if (contentText != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002824 builder.setContentText(contentText);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002825 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002826 builder.setContentIntent(contentIntent);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002827
2828 builder.build(); // callers expect this notification to be ready to use
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002829 }
2830
Julia Reynoldsda303542015-11-23 14:00:20 -05002831 /**
2832 * @hide
2833 */
2834 public static void addFieldsFromContext(Context context, Notification notification) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04002835 addFieldsFromContext(context.getApplicationInfo(), notification);
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002836 }
2837
2838 /**
2839 * @hide
2840 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04002841 public static void addFieldsFromContext(ApplicationInfo ai, Notification notification) {
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002842 notification.extras.putParcelable(EXTRA_BUILDER_APPLICATION_INFO, ai);
Julia Reynoldsda303542015-11-23 14:00:20 -05002843 }
2844
Yi Jin6b514142017-10-30 14:54:12 -07002845 /**
2846 * @hide
2847 */
2848 public void writeToProto(ProtoOutputStream proto, long fieldId) {
2849 long token = proto.start(fieldId);
2850 proto.write(NotificationProto.CHANNEL_ID, getChannelId());
2851 proto.write(NotificationProto.HAS_TICKER_TEXT, this.tickerText != null);
2852 proto.write(NotificationProto.FLAGS, this.flags);
2853 proto.write(NotificationProto.COLOR, this.color);
2854 proto.write(NotificationProto.CATEGORY, this.category);
2855 proto.write(NotificationProto.GROUP_KEY, this.mGroupKey);
2856 proto.write(NotificationProto.SORT_KEY, this.mSortKey);
2857 if (this.actions != null) {
2858 proto.write(NotificationProto.ACTION_LENGTH, this.actions.length);
2859 }
2860 if (this.visibility >= VISIBILITY_SECRET && this.visibility <= VISIBILITY_PUBLIC) {
2861 proto.write(NotificationProto.VISIBILITY, this.visibility);
2862 }
2863 if (publicVersion != null) {
2864 publicVersion.writeToProto(proto, NotificationProto.PUBLIC_VERSION);
2865 }
2866 proto.end(token);
2867 }
2868
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002869 @Override
2870 public String toString() {
2871 StringBuilder sb = new StringBuilder();
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002872 sb.append("Notification(channel=");
Julia Reynoldsbad42972017-04-25 13:52:49 -04002873 sb.append(getChannelId());
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002874 sb.append(" pri=");
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002875 sb.append(priority);
2876 sb.append(" contentView=");
Joe Onoratoc9596d62011-01-12 17:03:11 -08002877 if (contentView != null) {
2878 sb.append(contentView.getPackage());
2879 sb.append("/0x");
2880 sb.append(Integer.toHexString(contentView.getLayoutId()));
2881 } else {
2882 sb.append("null");
2883 }
2884 sb.append(" vibrate=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002885 if ((this.defaults & DEFAULT_VIBRATE) != 0) {
2886 sb.append("default");
2887 } else if (this.vibrate != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002888 int N = this.vibrate.length-1;
2889 sb.append("[");
2890 for (int i=0; i<N; i++) {
2891 sb.append(this.vibrate[i]);
2892 sb.append(',');
2893 }
Simon Schoar8cf97d92009-06-10 22:08:37 +02002894 if (N != -1) {
2895 sb.append(this.vibrate[N]);
2896 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002897 sb.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002898 } else {
2899 sb.append("null");
2900 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002901 sb.append(" sound=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002902 if ((this.defaults & DEFAULT_SOUND) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002903 sb.append("default");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002904 } else if (this.sound != null) {
2905 sb.append(this.sound.toString());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002906 } else {
2907 sb.append("null");
2908 }
Chris Wren365b6d32015-07-16 10:39:26 -04002909 if (this.tickerText != null) {
2910 sb.append(" tick");
2911 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002912 sb.append(" defaults=0x");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002913 sb.append(Integer.toHexString(this.defaults));
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002914 sb.append(" flags=0x");
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002915 sb.append(Integer.toHexString(this.flags));
Dan Sandler26e81cf2014-05-06 10:01:27 -04002916 sb.append(String.format(" color=0x%08x", this.color));
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002917 if (this.category != null) {
2918 sb.append(" category=");
2919 sb.append(this.category);
2920 }
2921 if (this.mGroupKey != null) {
2922 sb.append(" groupKey=");
2923 sb.append(this.mGroupKey);
2924 }
2925 if (this.mSortKey != null) {
2926 sb.append(" sortKey=");
2927 sb.append(this.mSortKey);
2928 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002929 if (actions != null) {
Dan Sandler1b718782014-07-18 12:43:45 -04002930 sb.append(" actions=");
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002931 sb.append(actions.length);
Dan Sandler1b718782014-07-18 12:43:45 -04002932 }
2933 sb.append(" vis=");
2934 sb.append(visibilityToString(this.visibility));
2935 if (this.publicVersion != null) {
2936 sb.append(" publicVersion=");
2937 sb.append(publicVersion.toString());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002938 }
2939 sb.append(")");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002940 return sb.toString();
2941 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002942
Dan Sandler1b718782014-07-18 12:43:45 -04002943 /**
2944 * {@hide}
2945 */
2946 public static String visibilityToString(int vis) {
2947 switch (vis) {
2948 case VISIBILITY_PRIVATE:
2949 return "PRIVATE";
2950 case VISIBILITY_PUBLIC:
2951 return "PUBLIC";
2952 case VISIBILITY_SECRET:
2953 return "SECRET";
2954 default:
2955 return "UNKNOWN(" + String.valueOf(vis) + ")";
2956 }
2957 }
2958
Joe Onoratocb109a02011-01-18 17:57:41 -08002959 /**
John Spurlock1d881a12015-03-18 19:21:54 -04002960 * {@hide}
2961 */
2962 public static String priorityToString(@Priority int pri) {
2963 switch (pri) {
2964 case PRIORITY_MIN:
2965 return "MIN";
2966 case PRIORITY_LOW:
2967 return "LOW";
2968 case PRIORITY_DEFAULT:
2969 return "DEFAULT";
2970 case PRIORITY_HIGH:
2971 return "HIGH";
2972 case PRIORITY_MAX:
2973 return "MAX";
2974 default:
2975 return "UNKNOWN(" + String.valueOf(pri) + ")";
2976 }
2977 }
2978
Julia Reynolds6ad0aec2017-07-05 08:47:03 -04002979 /**
2980 * @hide
2981 */
2982 public boolean hasCompletedProgress() {
2983 // not a progress notification; can't be complete
2984 if (!extras.containsKey(EXTRA_PROGRESS)
2985 || !extras.containsKey(EXTRA_PROGRESS_MAX)) {
2986 return false;
2987 }
2988 // many apps use max 0 for 'indeterminate'; not complete
2989 if (extras.getInt(EXTRA_PROGRESS_MAX) == 0) {
2990 return false;
2991 }
2992 return extras.getInt(EXTRA_PROGRESS) == extras.getInt(EXTRA_PROGRESS_MAX);
2993 }
2994
Jeff Sharkey000ce802017-04-29 13:13:27 -06002995 /** @removed */
2996 @Deprecated
Julia Reynolds37856052016-11-11 09:20:07 -05002997 public String getChannel() {
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002998 return mChannelId;
2999 }
3000
3001 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003002 * Returns the id of the channel this notification posts to.
3003 */
3004 public String getChannelId() {
3005 return mChannelId;
3006 }
3007
Jeff Sharkey000ce802017-04-29 13:13:27 -06003008 /** @removed */
3009 @Deprecated
Julia Reynolds2a128742016-11-28 14:29:25 -05003010 public long getTimeout() {
3011 return mTimeout;
3012 }
3013
3014 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003015 * Returns the duration from posting after which this notification should be canceled by the
3016 * system, if it's not canceled already.
3017 */
3018 public long getTimeoutAfter() {
3019 return mTimeout;
3020 }
3021
3022 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04003023 * Returns what icon should be shown for this notification if it is being displayed in a
3024 * Launcher that supports badging. Will be one of {@link #BADGE_ICON_NONE},
3025 * {@link #BADGE_ICON_SMALL}, or {@link #BADGE_ICON_LARGE}.
3026 */
3027 public int getBadgeIconType() {
3028 return mBadgeIcon;
3029 }
3030
3031 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003032 * Returns the {@link ShortcutInfo#getId() id} that this notification supersedes, if any.
Julia Reynoldsbad42972017-04-25 13:52:49 -04003033 *
3034 * <p>Used by some Launchers that display notification content to hide shortcuts that duplicate
3035 * notifications.
Julia Reynolds13d898c2017-02-02 12:22:05 -05003036 */
3037 public String getShortcutId() {
3038 return mShortcutId;
3039 }
3040
Julia Reynolds3aedded2017-03-31 14:42:09 -04003041
3042 /**
3043 * Returns the settings text provided to {@link Builder#setSettingsText(CharSequence)}.
3044 */
3045 public CharSequence getSettingsText() {
3046 return mSettingsText;
3047 }
3048
Julia Reynolds13d898c2017-02-02 12:22:05 -05003049 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003050 * Returns which type of notifications in a group are responsible for audibly alerting the
3051 * user. See {@link #GROUP_ALERT_ALL}, {@link #GROUP_ALERT_CHILDREN},
3052 * {@link #GROUP_ALERT_SUMMARY}.
3053 */
3054 public @GroupAlertBehavior int getGroupAlertBehavior() {
3055 return mGroupAlertBehavior;
3056 }
3057
3058 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04003059 * The small icon representing this notification in the status bar and content view.
3060 *
3061 * @return the small icon representing this notification.
3062 *
3063 * @see Builder#getSmallIcon()
3064 * @see Builder#setSmallIcon(Icon)
3065 */
3066 public Icon getSmallIcon() {
3067 return mSmallIcon;
3068 }
3069
3070 /**
3071 * Used when notifying to clean up legacy small icons.
3072 * @hide
3073 */
3074 public void setSmallIcon(Icon icon) {
3075 mSmallIcon = icon;
3076 }
3077
3078 /**
3079 * The large icon shown in this notification's content view.
3080 * @see Builder#getLargeIcon()
3081 * @see Builder#setLargeIcon(Icon)
3082 */
3083 public Icon getLargeIcon() {
3084 return mLargeIcon;
3085 }
3086
3087 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +02003088 * @hide
3089 */
Christoph Studerc8db24b2014-07-25 17:50:30 +02003090 public boolean isGroupSummary() {
3091 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) != 0;
3092 }
3093
3094 /**
3095 * @hide
3096 */
3097 public boolean isGroupChild() {
3098 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) == 0;
3099 }
3100
3101 /**
Julia Reynolds30203152017-05-26 13:36:31 -04003102 * @hide
3103 */
3104 public boolean suppressAlertingDueToGrouping() {
3105 if (isGroupSummary()
3106 && getGroupAlertBehavior() == Notification.GROUP_ALERT_CHILDREN) {
3107 return true;
3108 } else if (isGroupChild()
3109 && getGroupAlertBehavior() == Notification.GROUP_ALERT_SUMMARY) {
3110 return true;
3111 }
3112 return false;
3113 }
3114
3115 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003116 * Builder class for {@link Notification} objects.
Joe Malin8d40d042012-11-05 11:36:40 -08003117 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003118 * Provides a convenient way to set the various fields of a {@link Notification} and generate
Scott Main183bf112012-08-13 19:12:13 -07003119 * content views using the platform's notification layout template. If your app supports
3120 * versions of Android as old as API level 4, you can instead use
3121 * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder},
3122 * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support
3123 * library</a>.
Joe Malin8d40d042012-11-05 11:36:40 -08003124 *
Scott Main183bf112012-08-13 19:12:13 -07003125 * <p>Example:
Joe Malin8d40d042012-11-05 11:36:40 -08003126 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003127 * <pre class="prettyprint">
Scott Main183bf112012-08-13 19:12:13 -07003128 * Notification noti = new Notification.Builder(mContext)
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003129 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
3130 * .setContentText(subject)
3131 * .setSmallIcon(R.drawable.new_mail)
3132 * .setLargeIcon(aBitmap)
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003133 * .build();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003134 * </pre>
Joe Onoratocb109a02011-01-18 17:57:41 -08003135 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003136 public static class Builder {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003137 /**
3138 * @hide
3139 */
3140 public static final String EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT =
3141 "android.rebuild.contentViewActionCount";
3142 /**
3143 * @hide
3144 */
3145 public static final String EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT
3146 = "android.rebuild.bigViewActionCount";
3147 /**
3148 * @hide
3149 */
3150 public static final String EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT
3151 = "android.rebuild.hudViewActionCount";
3152
Daniel Sandler602ad1c2012-06-12 16:06:27 -04003153 private static final int MAX_ACTION_BUTTONS = 3;
Daniel Sandler8680bf82012-05-15 16:52:52 -04003154
Selim Cinek6743c0b2017-01-18 18:24:01 -08003155 private static final boolean USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY =
3156 SystemProperties.getBoolean("notifications.only_title", true);
3157
Selim Cinek389edcd2017-05-11 19:16:44 -07003158 /**
3159 * The lightness difference that has to be added to the primary text color to obtain the
3160 * secondary text color when the background is light.
3161 */
3162 private static final int LIGHTNESS_TEXT_DIFFERENCE_LIGHT = 20;
3163
3164 /**
3165 * The lightness difference that has to be added to the primary text color to obtain the
3166 * secondary text color when the background is dark.
3167 * A bit less then the above value, since it looks better on dark backgrounds.
3168 */
3169 private static final int LIGHTNESS_TEXT_DIFFERENCE_DARK = -10;
3170
Joe Onorato46439ce2010-11-19 13:56:21 -08003171 private Context mContext;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003172 private Notification mN;
3173 private Bundle mUserExtras = new Bundle();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003174 private Style mStyle;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003175 private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS);
Selim Cineke7238dd2017-12-14 17:48:32 -08003176 private ArrayList<Person> mPersonList = new ArrayList<>();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003177 private NotificationColorUtil mColorUtil;
Selim Cinek7b9605b2017-01-19 17:36:00 -08003178 private boolean mIsLegacy;
3179 private boolean mIsLegacyInitialized;
Christoph Studer7ac80e62014-08-04 16:01:57 +02003180
3181 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -08003182 * Caches a contrast-enhanced version of {@link #mCachedContrastColorIsFor}.
3183 */
3184 private int mCachedContrastColor = COLOR_INVALID;
3185 private int mCachedContrastColorIsFor = COLOR_INVALID;
Adrian Roos487374f2017-01-11 15:48:14 -08003186 /**
Selim Cinek4717d862018-04-19 09:19:15 +08003187 * Caches a ambient version of {@link #mCachedAmbientColorIsFor}.
Adrian Roos487374f2017-01-11 15:48:14 -08003188 */
3189 private int mCachedAmbientColor = COLOR_INVALID;
3190 private int mCachedAmbientColorIsFor = COLOR_INVALID;
Selim Cinek4717d862018-04-19 09:19:15 +08003191 /**
3192 * A neutral color color that can be used for icons.
3193 */
3194 private int mNeutralColor = COLOR_INVALID;
Adrian Roos4ff3b122016-02-01 12:26:13 -08003195
3196 /**
Adrian Roos70d7aa32017-01-11 15:39:06 -08003197 * Caches an instance of StandardTemplateParams. Note that this may have been used before,
3198 * so make sure to call {@link StandardTemplateParams#reset()} before using it.
3199 */
3200 StandardTemplateParams mParams = new StandardTemplateParams();
Selim Cinek7b9605b2017-01-19 17:36:00 -08003201 private int mTextColorsAreForBackground = COLOR_INVALID;
3202 private int mPrimaryTextColor = COLOR_INVALID;
3203 private int mSecondaryTextColor = COLOR_INVALID;
Selim Cinek5fb73f82017-04-20 16:55:38 -07003204 private int mBackgroundColor = COLOR_INVALID;
3205 private int mForegroundColor = COLOR_INVALID;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07003206 /**
3207 * A temporary location where actions are stored. If != null the view originally has action
3208 * but doesn't have any for this inflation.
3209 */
3210 private ArrayList<Action> mOriginalActions;
Selim Cineka7679b62017-05-10 16:33:25 -07003211 private boolean mRebuildStyledRemoteViews;
Adrian Roos70d7aa32017-01-11 15:39:06 -08003212
Anthony Chenad4d1582017-04-10 16:07:58 -07003213 private boolean mTintActionButtons;
3214 private boolean mInNightMode;
3215
Adrian Roos70d7aa32017-01-11 15:39:06 -08003216 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003217 * Constructs a new Builder with the defaults:
Joe Onoratocb109a02011-01-18 17:57:41 -08003218 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003219 * @param context
3220 * A {@link Context} that will be used by the Builder to construct the
3221 * RemoteViews. The Context will not be held past the lifetime of this Builder
3222 * object.
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003223 * @param channelId
3224 * The constructed Notification will be posted on this
3225 * {@link NotificationChannel}. To use a NotificationChannel, it must first be
3226 * created using {@link NotificationManager#createNotificationChannel}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003227 */
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003228 public Builder(Context context, String channelId) {
3229 this(context, (Notification) null);
3230 mN.mChannelId = channelId;
3231 }
3232
3233 /**
3234 * @deprecated use {@link Notification.Builder#Notification.Builder(Context, String)}
3235 * instead. All posted Notifications must specify a NotificationChannel Id.
3236 */
3237 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003238 public Builder(Context context) {
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003239 this(context, (Notification) null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003240 }
3241
Joe Onoratocb109a02011-01-18 17:57:41 -08003242 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003243 * @hide
Christoph Studer4600f9b2014-07-22 22:44:43 +02003244 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003245 public Builder(Context context, Notification toAdopt) {
3246 mContext = context;
Anthony Chenad4d1582017-04-10 16:07:58 -07003247 Resources res = mContext.getResources();
3248 mTintActionButtons = res.getBoolean(R.bool.config_tintNotificationActionButtons);
3249
3250 if (res.getBoolean(R.bool.config_enableNightMode)) {
3251 Configuration currentConfig = res.getConfiguration();
3252 mInNightMode = (currentConfig.uiMode & Configuration.UI_MODE_NIGHT_MASK)
3253 == Configuration.UI_MODE_NIGHT_YES;
3254 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02003255
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003256 if (toAdopt == null) {
3257 mN = new Notification();
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003258 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
3259 mN.extras.putBoolean(EXTRA_SHOW_WHEN, true);
3260 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003261 mN.priority = PRIORITY_DEFAULT;
3262 mN.visibility = VISIBILITY_PRIVATE;
3263 } else {
3264 mN = toAdopt;
3265 if (mN.actions != null) {
3266 Collections.addAll(mActions, mN.actions);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003267 }
3268
Selim Cineke7238dd2017-12-14 17:48:32 -08003269 if (mN.extras.containsKey(EXTRA_PEOPLE_LIST)) {
3270 ArrayList<Person> people = mN.extras.getParcelableArrayList(EXTRA_PEOPLE_LIST);
3271 mPersonList.addAll(people);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003272 }
3273
Selim Cinek4ac6f602016-06-13 15:47:03 -07003274 if (mN.getSmallIcon() == null && mN.icon != 0) {
3275 setSmallIcon(mN.icon);
3276 }
3277
3278 if (mN.getLargeIcon() == null && mN.largeIcon != null) {
3279 setLargeIcon(mN.largeIcon);
3280 }
3281
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003282 String templateClass = mN.extras.getString(EXTRA_TEMPLATE);
3283 if (!TextUtils.isEmpty(templateClass)) {
3284 final Class<? extends Style> styleClass
3285 = getNotificationStyleClass(templateClass);
3286 if (styleClass == null) {
3287 Log.d(TAG, "Unknown style class: " + templateClass);
3288 } else {
3289 try {
Adrian Roosc1a80b02016-04-05 14:54:55 -07003290 final Constructor<? extends Style> ctor =
3291 styleClass.getDeclaredConstructor();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003292 ctor.setAccessible(true);
3293 final Style style = ctor.newInstance();
3294 style.restoreFromExtras(mN.extras);
3295
3296 if (style != null) {
3297 setStyle(style);
3298 }
3299 } catch (Throwable t) {
3300 Log.e(TAG, "Could not create Style", t);
3301 }
3302 }
3303 }
3304
3305 }
3306 }
3307
3308 private NotificationColorUtil getColorUtil() {
Selim Cinek99104832017-01-25 14:47:33 -08003309 if (mColorUtil == null) {
3310 mColorUtil = NotificationColorUtil.getInstance(mContext);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003311 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003312 return mColorUtil;
Christoph Studer4600f9b2014-07-22 22:44:43 +02003313 }
3314
3315 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003316 * If this notification is duplicative of a Launcher shortcut, sets the
3317 * {@link ShortcutInfo#getId() id} of the shortcut, in case the Launcher wants to hide
3318 * the shortcut.
3319 *
Julia Reynoldsbad42972017-04-25 13:52:49 -04003320 * This field will be ignored by Launchers that don't support badging, don't show
3321 * notification content, or don't show {@link android.content.pm.ShortcutManager shortcuts}.
Julia Reynolds13d898c2017-02-02 12:22:05 -05003322 *
3323 * @param shortcutId the {@link ShortcutInfo#getId() id} of the shortcut this notification
3324 * supersedes
3325 */
3326 public Builder setShortcutId(String shortcutId) {
3327 mN.mShortcutId = shortcutId;
3328 return this;
3329 }
3330
3331 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04003332 * Sets which icon to display as a badge for this notification.
3333 *
3334 * Must be one of {@link #BADGE_ICON_NONE}, {@link #BADGE_ICON_SMALL},
3335 * {@link #BADGE_ICON_LARGE}.
3336 *
3337 * Note: This value might be ignored, for launchers that don't support badge icons.
3338 */
Julia Reynolds612beb22017-03-30 10:48:30 -04003339 public Builder setBadgeIconType(int icon) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04003340 mN.mBadgeIcon = icon;
3341 return this;
3342 }
3343
3344 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003345 * Sets the group alert behavior for this notification. Use this method to mute this
3346 * notification if alerts for this notification's group should be handled by a different
3347 * notification. This is only applicable for notifications that belong to a
Julia Reynolds399d9bf2017-08-11 12:52:14 -04003348 * {@link #setGroup(String) group}. This must be called on all notifications you want to
3349 * mute. For example, if you want only the summary of your group to make noise, all
3350 * children in the group should have the group alert behavior {@link #GROUP_ALERT_SUMMARY}.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003351 *
3352 * <p> The default value is {@link #GROUP_ALERT_ALL}.</p>
3353 */
3354 public Builder setGroupAlertBehavior(@GroupAlertBehavior int groupAlertBehavior) {
3355 mN.mGroupAlertBehavior = groupAlertBehavior;
3356 return this;
3357 }
3358
Jeff Sharkey000ce802017-04-29 13:13:27 -06003359 /** @removed */
3360 @Deprecated
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04003361 public Builder setChannel(String channelId) {
3362 mN.mChannelId = channelId;
3363 return this;
3364 }
3365
3366 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003367 * Specifies the channel the notification should be delivered on.
3368 */
3369 public Builder setChannelId(String channelId) {
3370 mN.mChannelId = channelId;
3371 return this;
3372 }
3373
Jeff Sharkey000ce802017-04-29 13:13:27 -06003374 /** @removed */
3375 @Deprecated
Julia Reynolds50989772017-02-23 14:32:16 -05003376 public Builder setTimeout(long durationMs) {
3377 mN.mTimeout = durationMs;
Julia Reynolds2a128742016-11-28 14:29:25 -05003378 return this;
3379 }
3380
3381 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003382 * Specifies a duration in milliseconds after which this notification should be canceled,
3383 * if it is not already canceled.
3384 */
3385 public Builder setTimeoutAfter(long durationMs) {
3386 mN.mTimeout = durationMs;
3387 return this;
3388 }
3389
3390 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003391 * Add a timestamp pertaining to the notification (usually the time the event occurred).
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003392 *
3393 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not
3394 * shown anymore by default and must be opted into by using
3395 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003396 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003397 * @see Notification#when
Joe Onoratocb109a02011-01-18 17:57:41 -08003398 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003399 public Builder setWhen(long when) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003400 mN.when = when;
Joe Onorato46439ce2010-11-19 13:56:21 -08003401 return this;
3402 }
3403
Joe Onoratocb109a02011-01-18 17:57:41 -08003404 /**
Griff Hazen50c11652014-05-16 09:46:31 -07003405 * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown
Daniel Sandler0c890492012-09-12 17:23:10 -07003406 * in the content view.
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003407 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to
3408 * {@code false}. For earlier apps, the default is {@code true}.
Daniel Sandler0c890492012-09-12 17:23:10 -07003409 */
3410 public Builder setShowWhen(boolean show) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003411 mN.extras.putBoolean(EXTRA_SHOW_WHEN, show);
Daniel Sandler0c890492012-09-12 17:23:10 -07003412 return this;
3413 }
3414
3415 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003416 * Show the {@link Notification#when} field as a stopwatch.
Joe Malin8d40d042012-11-05 11:36:40 -08003417 *
3418 * Instead of presenting <code>when</code> as a timestamp, the notification will show an
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003419 * automatically updating display of the minutes and seconds since <code>when</code>.
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003420 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003421 * Useful when showing an elapsed time (like an ongoing phone call).
3422 *
Selim Cinek81c23aa2016-02-25 16:23:13 -08003423 * The counter can also be set to count down to <code>when</code> when using
Adrian Roos96b7e202016-05-17 13:50:38 -07003424 * {@link #setChronometerCountDown(boolean)}.
Selim Cinek81c23aa2016-02-25 16:23:13 -08003425 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003426 * @see android.widget.Chronometer
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003427 * @see Notification#when
Adrian Roos96b7e202016-05-17 13:50:38 -07003428 * @see #setChronometerCountDown(boolean)
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003429 */
3430 public Builder setUsesChronometer(boolean b) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003431 mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b);
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003432 return this;
3433 }
3434
3435 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08003436 * Sets the Chronometer to count down instead of counting up.
3437 *
3438 * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true.
3439 * If it isn't set the chronometer will count up.
3440 *
3441 * @see #setUsesChronometer(boolean)
3442 */
Adrian Roos96b7e202016-05-17 13:50:38 -07003443 public Builder setChronometerCountDown(boolean countDown) {
3444 mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, countDown);
Selim Cinek81c23aa2016-02-25 16:23:13 -08003445 return this;
3446 }
3447
3448 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003449 * Set the small icon resource, which will be used to represent the notification in the
3450 * status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -08003451 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003452
3453 * The platform template for the expanded view will draw this icon in the left, unless a
3454 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
3455 * icon will be moved to the right-hand side.
3456 *
3457
3458 * @param icon
3459 * A resource ID in the application's package of the drawable to use.
3460 * @see Notification#icon
Joe Onoratocb109a02011-01-18 17:57:41 -08003461 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003462 public Builder setSmallIcon(@DrawableRes int icon) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04003463 return setSmallIcon(icon != 0
3464 ? Icon.createWithResource(mContext, icon)
3465 : null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003466 }
3467
Joe Onoratocb109a02011-01-18 17:57:41 -08003468 /**
3469 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
3470 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
3471 * LevelListDrawable}.
3472 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003473 * @param icon A resource ID in the application's package of the drawable to use.
Joe Onoratocb109a02011-01-18 17:57:41 -08003474 * @param level The level to use for the icon.
3475 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003476 * @see Notification#icon
3477 * @see Notification#iconLevel
Joe Onoratocb109a02011-01-18 17:57:41 -08003478 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003479 public Builder setSmallIcon(@DrawableRes int icon, int level) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003480 mN.iconLevel = level;
Dan Sandlerd63f9322015-05-06 15:18:49 -04003481 return setSmallIcon(icon);
3482 }
3483
3484 /**
3485 * Set the small icon, which will be used to represent the notification in the
3486 * status bar and content view (unless overriden there by a
3487 * {@link #setLargeIcon(Bitmap) large icon}).
3488 *
3489 * @param icon An Icon object to use.
3490 * @see Notification#icon
3491 */
3492 public Builder setSmallIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003493 mN.setSmallIcon(icon);
3494 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
3495 mN.icon = icon.getResId();
3496 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003497 return this;
3498 }
3499
Joe Onoratocb109a02011-01-18 17:57:41 -08003500 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003501 * Set the first line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003502 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003503 public Builder setContentTitle(CharSequence title) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003504 mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title));
Joe Onorato46439ce2010-11-19 13:56:21 -08003505 return this;
3506 }
3507
Joe Onoratocb109a02011-01-18 17:57:41 -08003508 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003509 * Set the second line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003510 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003511 public Builder setContentText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003512 mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text));
Joe Onorato46439ce2010-11-19 13:56:21 -08003513 return this;
3514 }
3515
Joe Onoratocb109a02011-01-18 17:57:41 -08003516 /**
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003517 * This provides some additional information that is displayed in the notification. No
3518 * guarantees are given where exactly it is displayed.
3519 *
3520 * <p>This information should only be provided if it provides an essential
3521 * benefit to the understanding of the notification. The more text you provide the
3522 * less readable it becomes. For example, an email client should only provide the account
3523 * name here if more than one email account has been added.</p>
3524 *
3525 * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the
3526 * notification header area.
3527 *
3528 * On Android versions before {@link android.os.Build.VERSION_CODES#N}
3529 * this will be shown in the third line of text in the platform notification template.
3530 * You should not be using {@link #setProgress(int, int, boolean)} at the
3531 * same time on those versions; they occupy the same place.
3532 * </p>
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003533 */
3534 public Builder setSubText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003535 mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text));
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003536 return this;
3537 }
3538
3539 /**
Julia Reynolds3aedded2017-03-31 14:42:09 -04003540 * Provides text that will appear as a link to your application's settings.
3541 *
3542 * <p>This text does not appear within notification {@link Style templates} but may
3543 * appear when the user uses an affordance to learn more about the notification.
3544 * Additionally, this text will not appear unless you provide a valid link target by
3545 * handling {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}.
3546 *
3547 * <p>This text is meant to be concise description about what the user can customize
3548 * when they click on this link. The recommended maximum length is 40 characters.
3549 * @param text
3550 * @return
3551 */
3552 public Builder setSettingsText(CharSequence text) {
3553 mN.mSettingsText = safeCharSequence(text);
3554 return this;
3555 }
3556
3557 /**
Adrian Roose458aa82015-12-08 16:17:19 -08003558 * Set the remote input history.
3559 *
3560 * This should be set to the most recent inputs that have been sent
3561 * through a {@link RemoteInput} of this Notification and cleared once the it is no
3562 * longer relevant (e.g. for chat notifications once the other party has responded).
3563 *
3564 * The most recent input must be stored at the 0 index, the second most recent at the
3565 * 1 index, etc. Note that the system will limit both how far back the inputs will be shown
3566 * and how much of each individual input is shown.
3567 *
3568 * <p>Note: The reply text will only be shown on notifications that have least one action
3569 * with a {@code RemoteInput}.</p>
3570 */
3571 public Builder setRemoteInputHistory(CharSequence[] text) {
3572 if (text == null) {
3573 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null);
3574 } else {
3575 final int N = Math.min(MAX_REPLY_HISTORY, text.length);
3576 CharSequence[] safe = new CharSequence[N];
3577 for (int i = 0; i < N; i++) {
3578 safe[i] = safeCharSequence(text[i]);
3579 }
3580 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe);
3581 }
3582 return this;
3583 }
3584
3585 /**
Kenny Guya0f6de82018-04-06 16:20:16 +01003586 * Sets whether remote history entries view should have a spinner.
3587 * @hide
3588 */
3589 public Builder setShowRemoteInputSpinner(boolean showSpinner) {
3590 mN.extras.putBoolean(EXTRA_SHOW_REMOTE_INPUT_SPINNER, showSpinner);
3591 return this;
3592 }
3593
3594 /**
Kenny Guy8cc15d22018-05-09 09:50:55 +01003595 * Sets whether smart reply buttons should be hidden.
3596 * @hide
3597 */
3598 public Builder setHideSmartReplies(boolean hideSmartReplies) {
3599 mN.extras.putBoolean(EXTRA_HIDE_SMART_REPLIES, hideSmartReplies);
3600 return this;
3601 }
3602
3603 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003604 * Sets the number of items this notification represents. May be displayed as a badge count
3605 * for Launchers that support badging.
Joe Onoratocb109a02011-01-18 17:57:41 -08003606 */
Joe Onorato8595a3d2010-11-19 18:12:07 -08003607 public Builder setNumber(int number) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003608 mN.number = number;
Joe Onorato8595a3d2010-11-19 18:12:07 -08003609 return this;
3610 }
3611
Joe Onoratocb109a02011-01-18 17:57:41 -08003612 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003613 * A small piece of additional information pertaining to this notification.
3614 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003615 * The platform template will draw this on the last line of the notification, at the far
3616 * right (to the right of a smallIcon if it has been placed there).
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003617 *
3618 * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header.
3619 * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this
3620 * field will still show up, but the subtext will take precedence.
Joe Onoratocb109a02011-01-18 17:57:41 -08003621 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003622 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003623 public Builder setContentInfo(CharSequence info) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003624 mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info));
Joe Onorato46439ce2010-11-19 13:56:21 -08003625 return this;
3626 }
3627
Joe Onoratocb109a02011-01-18 17:57:41 -08003628 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003629 * Set the progress this notification represents.
3630 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003631 * The platform template will represent this using a {@link ProgressBar}.
Jeff Sharkey1c400132011-08-05 14:50:13 -07003632 */
3633 public Builder setProgress(int max, int progress, boolean indeterminate) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003634 mN.extras.putInt(EXTRA_PROGRESS, progress);
3635 mN.extras.putInt(EXTRA_PROGRESS_MAX, max);
3636 mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate);
Jeff Sharkey1c400132011-08-05 14:50:13 -07003637 return this;
3638 }
3639
3640 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003641 * Supply a custom RemoteViews to use instead of the platform template.
3642 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003643 * Use {@link #setCustomContentView(RemoteViews)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003644 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003645 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003646 public Builder setContent(RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003647 return setCustomContentView(views);
3648 }
3649
3650 /**
3651 * Supply custom RemoteViews to use instead of the platform template.
3652 *
3653 * This will override the layout that would otherwise be constructed by this Builder
3654 * object.
3655 */
3656 public Builder setCustomContentView(RemoteViews contentView) {
3657 mN.contentView = contentView;
3658 return this;
3659 }
3660
3661 /**
3662 * Supply custom RemoteViews to use instead of the platform template in the expanded form.
3663 *
3664 * This will override the expanded layout that would otherwise be constructed by this
3665 * Builder object.
3666 */
3667 public Builder setCustomBigContentView(RemoteViews contentView) {
3668 mN.bigContentView = contentView;
3669 return this;
3670 }
3671
3672 /**
3673 * Supply custom RemoteViews to use instead of the platform template in the heads up dialog.
3674 *
3675 * This will override the heads-up layout that would otherwise be constructed by this
3676 * Builder object.
3677 */
3678 public Builder setCustomHeadsUpContentView(RemoteViews contentView) {
3679 mN.headsUpContentView = contentView;
Joe Onorato46439ce2010-11-19 13:56:21 -08003680 return this;
3681 }
3682
Joe Onoratocb109a02011-01-18 17:57:41 -08003683 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003684 * Supply a {@link PendingIntent} to be sent when the notification is clicked.
3685 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003686 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
3687 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
3688 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003689 * to assign PendingIntents to individual views in that custom layout (i.e., to create
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003690 * clickable buttons inside the notification view).
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003691 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003692 * @see Notification#contentIntent Notification.contentIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003693 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003694 public Builder setContentIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003695 mN.contentIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003696 return this;
3697 }
3698
Joe Onoratocb109a02011-01-18 17:57:41 -08003699 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003700 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
3701 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003702 * @see Notification#deleteIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003703 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003704 public Builder setDeleteIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003705 mN.deleteIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003706 return this;
3707 }
3708
Joe Onoratocb109a02011-01-18 17:57:41 -08003709 /**
3710 * An intent to launch instead of posting the notification to the status bar.
3711 * Only for use with extremely high-priority notifications demanding the user's
3712 * <strong>immediate</strong> attention, such as an incoming phone call or
3713 * alarm clock that the user has explicitly set to a particular time.
3714 * If this facility is used for something else, please give the user an option
3715 * to turn it off and use a normal notification, as this can be extremely
3716 * disruptive.
3717 *
Chris Wren47c20a12014-06-18 17:27:29 -04003718 * <p>
3719 * The system UI may choose to display a heads-up notification, instead of
3720 * launching this intent, while the user is using the device.
3721 * </p>
3722 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003723 * @param intent The pending intent to launch.
3724 * @param highPriority Passing true will cause this notification to be sent
3725 * even if other notifications are suppressed.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003726 *
3727 * @see Notification#fullScreenIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003728 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003729 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003730 mN.fullScreenIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003731 setFlag(FLAG_HIGH_PRIORITY, highPriority);
3732 return this;
3733 }
3734
Joe Onoratocb109a02011-01-18 17:57:41 -08003735 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003736 * Set the "ticker" text which is sent to accessibility services.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003737 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003738 * @see Notification#tickerText
Joe Onoratocb109a02011-01-18 17:57:41 -08003739 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003740 public Builder setTicker(CharSequence tickerText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003741 mN.tickerText = safeCharSequence(tickerText);
Joe Onorato46439ce2010-11-19 13:56:21 -08003742 return this;
3743 }
3744
Joe Onoratocb109a02011-01-18 17:57:41 -08003745 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003746 * Obsolete version of {@link #setTicker(CharSequence)}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003747 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003748 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003749 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003750 public Builder setTicker(CharSequence tickerText, RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003751 setTicker(tickerText);
3752 // views is ignored
Joe Onorato46439ce2010-11-19 13:56:21 -08003753 return this;
3754 }
3755
Joe Onoratocb109a02011-01-18 17:57:41 -08003756 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04003757 * Add a large icon to the notification content view.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003758 *
3759 * In the platform template, this image will be shown on the left of the notification view
Dan Sandlerd63f9322015-05-06 15:18:49 -04003760 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3761 * badge atop the large icon).
Dan Sandler08a04c12015-05-06 15:18:49 -04003762 */
Dan Sandlerd63f9322015-05-06 15:18:49 -04003763 public Builder setLargeIcon(Bitmap b) {
3764 return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
3765 }
3766
3767 /**
3768 * Add a large icon to the notification content view.
3769 *
3770 * In the platform template, this image will be shown on the left of the notification view
3771 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3772 * badge atop the large icon).
3773 */
3774 public Builder setLargeIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003775 mN.mLargeIcon = icon;
3776 mN.extras.putParcelable(EXTRA_LARGE_ICON, icon);
Joe Onorato46439ce2010-11-19 13:56:21 -08003777 return this;
3778 }
3779
Joe Onoratocb109a02011-01-18 17:57:41 -08003780 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003781 * Set the sound to play.
3782 *
John Spurlockc0650f022014-07-19 13:22:39 -04003783 * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes}
3784 * for notifications.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003785 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003786 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003787 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003788 @Deprecated
Joe Onorato52f80cd2010-11-21 15:34:48 -08003789 public Builder setSound(Uri sound) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003790 mN.sound = sound;
3791 mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
Joe Onorato52f80cd2010-11-21 15:34:48 -08003792 return this;
3793 }
3794
Joe Onoratocb109a02011-01-18 17:57:41 -08003795 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003796 * Set the sound to play, along with a specific stream on which to play it.
Joe Onoratocb109a02011-01-18 17:57:41 -08003797 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003798 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
3799 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003800 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003801 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -07003802 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003803 public Builder setSound(Uri sound, int streamType) {
Jean-Michel Trivi2f7511f2016-11-28 15:40:27 -08003804 PlayerBase.deprecateStreamTypeForPlayback(streamType, "Notification", "setSound()");
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003805 mN.sound = sound;
3806 mN.audioStreamType = streamType;
Joe Onorato46439ce2010-11-19 13:56:21 -08003807 return this;
3808 }
3809
Joe Onoratocb109a02011-01-18 17:57:41 -08003810 /**
John Spurlockc0650f022014-07-19 13:22:39 -04003811 * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to
3812 * use during playback.
3813 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003814 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
John Spurlockc0650f022014-07-19 13:22:39 -04003815 * @see Notification#sound
3816 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003817 @Deprecated
John Spurlockc0650f022014-07-19 13:22:39 -04003818 public Builder setSound(Uri sound, AudioAttributes audioAttributes) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003819 mN.sound = sound;
3820 mN.audioAttributes = audioAttributes;
John Spurlockc0650f022014-07-19 13:22:39 -04003821 return this;
3822 }
3823
3824 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003825 * Set the vibration pattern to use.
3826 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003827 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
3828 * <code>pattern</code> parameter.
3829 *
Chris Wren47c20a12014-06-18 17:27:29 -04003830 * <p>
3831 * A notification that vibrates is more likely to be presented as a heads-up notification.
3832 * </p>
3833 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003834 * @deprecated use {@link NotificationChannel#setVibrationPattern(long[])} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003835 * @see Notification#vibrate
Joe Onoratocb109a02011-01-18 17:57:41 -08003836 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003837 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003838 public Builder setVibrate(long[] pattern) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003839 mN.vibrate = pattern;
Joe Onorato46439ce2010-11-19 13:56:21 -08003840 return this;
3841 }
3842
Joe Onoratocb109a02011-01-18 17:57:41 -08003843 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003844 * Set the desired color for the indicator LED on the device, as well as the
3845 * blink duty cycle (specified in milliseconds).
3846 *
3847
3848 * Not all devices will honor all (or even any) of these values.
3849 *
Julia Reynolds529e3322017-02-06 08:33:01 -05003850 * @deprecated use {@link NotificationChannel#enableLights(boolean)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003851 * @see Notification#ledARGB
3852 * @see Notification#ledOnMS
3853 * @see Notification#ledOffMS
Joe Onoratocb109a02011-01-18 17:57:41 -08003854 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003855 @Deprecated
Tor Norbye80756e32015-03-02 09:39:27 -08003856 public Builder setLights(@ColorInt int argb, int onMs, int offMs) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003857 mN.ledARGB = argb;
3858 mN.ledOnMS = onMs;
3859 mN.ledOffMS = offMs;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05003860 if (onMs != 0 || offMs != 0) {
3861 mN.flags |= FLAG_SHOW_LIGHTS;
3862 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003863 return this;
3864 }
3865
Joe Onoratocb109a02011-01-18 17:57:41 -08003866 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003867 * Set whether this is an "ongoing" notification.
Joe Onoratocb109a02011-01-18 17:57:41 -08003868 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003869
3870 * Ongoing notifications cannot be dismissed by the user, so your application or service
3871 * must take care of canceling them.
3872 *
3873
3874 * They are typically used to indicate a background task that the user is actively engaged
3875 * with (e.g., playing music) or is pending in some way and therefore occupying the device
3876 * (e.g., a file download, sync operation, active network connection).
3877 *
3878
3879 * @see Notification#FLAG_ONGOING_EVENT
3880 * @see Service#setForeground(boolean)
Joe Onoratocb109a02011-01-18 17:57:41 -08003881 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003882 public Builder setOngoing(boolean ongoing) {
3883 setFlag(FLAG_ONGOING_EVENT, ongoing);
3884 return this;
3885 }
3886
Joe Onoratocb109a02011-01-18 17:57:41 -08003887 /**
Selim Cinek7b9605b2017-01-19 17:36:00 -08003888 * Set whether this notification should be colorized. When set, the color set with
3889 * {@link #setColor(int)} will be used as the background color of this notification.
3890 * <p>
Selim Cinek7b9605b2017-01-19 17:36:00 -08003891 * This should only be used for high priority ongoing tasks like navigation, an ongoing
3892 * call, or other similarly high-priority events for the user.
Selim Cinek99104832017-01-25 14:47:33 -08003893 * <p>
Selim Cinek22714f12017-04-13 16:23:53 -07003894 * For most styles, the coloring will only be applied if the notification is for a
3895 * foreground service notification.
Selim Cinek99104832017-01-25 14:47:33 -08003896 * However, for {@link MediaStyle} and {@link DecoratedMediaCustomViewStyle} notifications
Selim Cinek22714f12017-04-13 16:23:53 -07003897 * that have a media session attached there is no such requirement.
Selim Cinek7b9605b2017-01-19 17:36:00 -08003898 *
Selim Cinek7b9605b2017-01-19 17:36:00 -08003899 * @see Builder#setColor(int)
Selim Cinek99104832017-01-25 14:47:33 -08003900 * @see MediaStyle#setMediaSession(MediaSession.Token)
Selim Cinek7b9605b2017-01-19 17:36:00 -08003901 */
3902 public Builder setColorized(boolean colorize) {
3903 mN.extras.putBoolean(EXTRA_COLORIZED, colorize);
3904 return this;
3905 }
3906
3907 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003908 * Set this flag if you would only like the sound, vibrate
3909 * and ticker to be played if the notification is not already showing.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003910 *
3911 * @see Notification#FLAG_ONLY_ALERT_ONCE
Joe Onoratocb109a02011-01-18 17:57:41 -08003912 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003913 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
3914 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
3915 return this;
3916 }
3917
Joe Onoratocb109a02011-01-18 17:57:41 -08003918 /**
Julia Reynolds04499532016-09-13 14:04:53 -04003919 * Make this notification automatically dismissed when the user touches it.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003920 *
3921 * @see Notification#FLAG_AUTO_CANCEL
Joe Onoratocb109a02011-01-18 17:57:41 -08003922 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003923 public Builder setAutoCancel(boolean autoCancel) {
Joe Onorato281d83f2011-01-04 17:13:10 -08003924 setFlag(FLAG_AUTO_CANCEL, autoCancel);
Joe Onorato46439ce2010-11-19 13:56:21 -08003925 return this;
3926 }
3927
Joe Onoratocb109a02011-01-18 17:57:41 -08003928 /**
Griff Hazendfcb0802014-02-11 12:00:00 -08003929 * Set whether or not this notification should not bridge to other devices.
3930 *
3931 * <p>Some notifications can be bridged to other devices for remote display.
3932 * This hint can be set to recommend this notification not be bridged.
3933 */
3934 public Builder setLocalOnly(boolean localOnly) {
3935 setFlag(FLAG_LOCAL_ONLY, localOnly);
3936 return this;
3937 }
3938
3939 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003940 * Set which notification properties will be inherited from system defaults.
Joe Onoratocb109a02011-01-18 17:57:41 -08003941 * <p>
3942 * The value should be one or more of the following fields combined with
3943 * bitwise-or:
3944 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
3945 * <p>
3946 * For all default values, use {@link #DEFAULT_ALL}.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003947 *
3948 * @deprecated use {@link NotificationChannel#enableVibration(boolean)} and
Julia Reynolds529e3322017-02-06 08:33:01 -05003949 * {@link NotificationChannel#enableLights(boolean)} and
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003950 * {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003951 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003952 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003953 public Builder setDefaults(int defaults) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003954 mN.defaults = defaults;
Joe Onorato46439ce2010-11-19 13:56:21 -08003955 return this;
3956 }
3957
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003958 /**
3959 * Set the priority of this notification.
3960 *
3961 * @see Notification#priority
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003962 * @deprecated use {@link NotificationChannel#setImportance(int)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003963 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003964 @Deprecated
Tor Norbyed9273d62013-05-30 15:59:53 -07003965 public Builder setPriority(@Priority int pri) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003966 mN.priority = pri;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003967 return this;
3968 }
Joe Malin8d40d042012-11-05 11:36:40 -08003969
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003970 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04003971 * Set the notification category.
Joe Malin8d40d042012-11-05 11:36:40 -08003972 *
John Spurlockfd7f1e02014-03-18 16:41:57 -04003973 * @see Notification#category
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003974 */
John Spurlockfd7f1e02014-03-18 16:41:57 -04003975 public Builder setCategory(String category) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003976 mN.category = category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003977 return this;
3978 }
3979
3980 /**
Chris Wrendde75302014-03-26 17:24:15 -04003981 * Add a person that is relevant to this notification.
3982 *
Chris Wrene6c48932014-09-29 17:19:27 -04003983 * <P>
3984 * Depending on user preferences, this annotation may allow the notification to pass
Julia Reynoldse071abd2017-03-22 10:52:11 -04003985 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3986 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3987 * appear more prominently in the user interface.
Chris Wrene6c48932014-09-29 17:19:27 -04003988 * </P>
3989 *
3990 * <P>
3991 * The person should be specified by the {@code String} representation of a
3992 * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
3993 * </P>
3994 *
3995 * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
3996 * URIs. The path part of these URIs must exist in the contacts database, in the
3997 * appropriate column, or the reference will be discarded as invalid. Telephone schema
3998 * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
Selim Cineke7238dd2017-12-14 17:48:32 -08003999 * It is also possible to provide a URI with the schema {@code name:} in order to uniquely
4000 * identify a person without an entry in the contacts database.
Chris Wrene6c48932014-09-29 17:19:27 -04004001 * </P>
4002 *
4003 * @param uri A URI for the person.
Chris Wrendde75302014-03-26 17:24:15 -04004004 * @see Notification#EXTRA_PEOPLE
Selim Cineke7238dd2017-12-14 17:48:32 -08004005 * @deprecated use {@link #addPerson(Person)}
Chris Wrendde75302014-03-26 17:24:15 -04004006 */
Chris Wrene6c48932014-09-29 17:19:27 -04004007 public Builder addPerson(String uri) {
Selim Cinek9acd6732018-03-23 16:39:02 -07004008 addPerson(new Person.Builder().setUri(uri).build());
Selim Cineke7238dd2017-12-14 17:48:32 -08004009 return this;
4010 }
4011
4012 /**
4013 * Add a person that is relevant to this notification.
4014 *
4015 * <P>
4016 * Depending on user preferences, this annotation may allow the notification to pass
4017 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
4018 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
4019 * appear more prominently in the user interface.
4020 * </P>
4021 *
4022 * <P>
4023 * A person should usually contain a uri in order to benefit from the ranking boost.
4024 * However, even if no uri is provided, it's beneficial to provide other people in the
4025 * notification, such that listeners and voice only devices can announce and handle them
4026 * properly.
4027 * </P>
4028 *
4029 * @param person the person to add.
4030 * @see Notification#EXTRA_PEOPLE_LIST
4031 */
4032 public Builder addPerson(Person person) {
4033 mPersonList.add(person);
Chris Wrendde75302014-03-26 17:24:15 -04004034 return this;
4035 }
4036
4037 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004038 * Set this notification to be part of a group of notifications sharing the same key.
4039 * Grouped notifications may display in a cluster or stack on devices which
4040 * support such rendering.
4041 *
4042 * <p>To make this notification the summary for its group, also call
4043 * {@link #setGroupSummary}. A sort order can be specified for group members by using
4044 * {@link #setSortKey}.
4045 * @param groupKey The group key of the group.
4046 * @return this object for method chaining
4047 */
4048 public Builder setGroup(String groupKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004049 mN.mGroupKey = groupKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004050 return this;
4051 }
4052
4053 /**
4054 * Set this notification to be the group summary for a group of notifications.
4055 * Grouped notifications may display in a cluster or stack on devices which
Julia Reynolds04499532016-09-13 14:04:53 -04004056 * support such rendering. If thereRequires a group key also be set using {@link #setGroup}.
4057 * The group summary may be suppressed if too few notifications are included in the group.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004058 * @param isGroupSummary Whether this notification should be a group summary.
4059 * @return this object for method chaining
4060 */
4061 public Builder setGroupSummary(boolean isGroupSummary) {
4062 setFlag(FLAG_GROUP_SUMMARY, isGroupSummary);
4063 return this;
4064 }
4065
4066 /**
4067 * Set a sort key that orders this notification among other notifications from the
4068 * same package. This can be useful if an external sort was already applied and an app
4069 * would like to preserve this. Notifications will be sorted lexicographically using this
4070 * value, although providing different priorities in addition to providing sort key may
4071 * cause this value to be ignored.
4072 *
4073 * <p>This sort key can also be used to order members of a notification group. See
Griff Hazen9e1379f2014-05-20 12:50:51 -07004074 * {@link #setGroup}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004075 *
4076 * @see String#compareTo(String)
4077 */
4078 public Builder setSortKey(String sortKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004079 mN.mSortKey = sortKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004080 return this;
4081 }
4082
4083 /**
Griff Hazen720042b2014-02-24 15:46:56 -08004084 * Merge additional metadata into this notification.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004085 *
Griff Hazen720042b2014-02-24 15:46:56 -08004086 * <p>Values within the Bundle will replace existing extras values in this Builder.
4087 *
4088 * @see Notification#extras
4089 */
Griff Hazen959591e2014-05-15 22:26:18 -07004090 public Builder addExtras(Bundle extras) {
4091 if (extras != null) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004092 mUserExtras.putAll(extras);
Griff Hazen720042b2014-02-24 15:46:56 -08004093 }
4094 return this;
4095 }
4096
4097 /**
4098 * Set metadata for this notification.
4099 *
4100 * <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 -04004101 * current contents are copied into the Notification each time {@link #build()} is
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004102 * called.
4103 *
Griff Hazen720042b2014-02-24 15:46:56 -08004104 * <p>Replaces any existing extras values with those from the provided Bundle.
4105 * Use {@link #addExtras} to merge in metadata instead.
4106 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004107 * @see Notification#extras
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004108 */
Griff Hazen959591e2014-05-15 22:26:18 -07004109 public Builder setExtras(Bundle extras) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004110 if (extras != null) {
4111 mUserExtras = extras;
4112 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004113 return this;
4114 }
4115
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004116 /**
Griff Hazen720042b2014-02-24 15:46:56 -08004117 * Get the current metadata Bundle used by this notification Builder.
4118 *
4119 * <p>The returned Bundle is shared with this Builder.
4120 *
4121 * <p>The current contents of this Bundle are copied into the Notification each time
4122 * {@link #build()} is called.
4123 *
4124 * @see Notification#extras
4125 */
4126 public Bundle getExtras() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004127 return mUserExtras;
4128 }
4129
4130 private Bundle getAllExtras() {
4131 final Bundle saveExtras = (Bundle) mUserExtras.clone();
4132 saveExtras.putAll(mN.extras);
4133 return saveExtras;
Griff Hazen720042b2014-02-24 15:46:56 -08004134 }
4135
4136 /**
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004137 * Add an action to this notification. Actions are typically displayed by
4138 * the system as a button adjacent to the notification content.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004139 * <p>
4140 * Every action must have an icon (32dp square and matching the
4141 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4142 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4143 * <p>
4144 * A notification in its expanded form can display up to 3 actions, from left to right in
4145 * the order they were added. Actions will not be displayed when the notification is
4146 * collapsed, however, so be sure that any essential functions may be accessed by the user
4147 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004148 *
4149 * @param icon Resource ID of a drawable that represents the action.
4150 * @param title Text describing the action.
4151 * @param intent PendingIntent to be fired when the action is invoked.
Dan Sandler86647982015-05-13 23:41:13 -04004152 *
4153 * @deprecated Use {@link #addAction(Action)} instead.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004154 */
Dan Sandler86647982015-05-13 23:41:13 -04004155 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004156 public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004157 mActions.add(new Action(icon, safeCharSequence(title), intent));
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004158 return this;
4159 }
4160
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004161 /**
Griff Hazen959591e2014-05-15 22:26:18 -07004162 * Add an action to this notification. Actions are typically displayed by
4163 * the system as a button adjacent to the notification content.
4164 * <p>
4165 * Every action must have an icon (32dp square and matching the
4166 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4167 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4168 * <p>
4169 * A notification in its expanded form can display up to 3 actions, from left to right in
4170 * the order they were added. Actions will not be displayed when the notification is
4171 * collapsed, however, so be sure that any essential functions may be accessed by the user
4172 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
4173 *
4174 * @param action The action to add.
4175 */
4176 public Builder addAction(Action action) {
liangweikang63b03b52017-03-16 19:22:15 +08004177 if (action != null) {
4178 mActions.add(action);
4179 }
Griff Hazen959591e2014-05-15 22:26:18 -07004180 return this;
4181 }
4182
4183 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004184 * Alter the complete list of actions attached to this notification.
4185 * @see #addAction(Action).
4186 *
4187 * @param actions
4188 * @return
4189 */
4190 public Builder setActions(Action... actions) {
4191 mActions.clear();
4192 for (int i = 0; i < actions.length; i++) {
liangweikang63b03b52017-03-16 19:22:15 +08004193 if (actions[i] != null) {
4194 mActions.add(actions[i]);
4195 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004196 }
4197 return this;
4198 }
4199
4200 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004201 * Add a rich notification style to be applied at build time.
4202 *
4203 * @param style Object responsible for modifying the notification style.
4204 */
4205 public Builder setStyle(Style style) {
4206 if (mStyle != style) {
4207 mStyle = style;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004208 if (mStyle != null) {
4209 mStyle.setBuilder(this);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004210 mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName());
4211 } else {
4212 mN.extras.remove(EXTRA_TEMPLATE);
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004213 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004214 }
4215 return this;
4216 }
4217
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004218 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05004219 * Returns the style set by {@link #setStyle(Style)}.
4220 */
4221 public Style getStyle() {
4222 return mStyle;
4223 }
4224
4225 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004226 * Specify the value of {@link #visibility}.
Griff Hazenb720abe2014-05-20 13:15:30 -07004227 *
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004228 * @return The same Builder.
4229 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004230 public Builder setVisibility(@Visibility int visibility) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004231 mN.visibility = visibility;
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004232 return this;
4233 }
4234
4235 /**
4236 * Supply a replacement Notification whose contents should be shown in insecure contexts
4237 * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}.
4238 * @param n A replacement notification, presumably with some or all info redacted.
4239 * @return The same Builder.
4240 */
4241 public Builder setPublicVersion(Notification n) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004242 if (n != null) {
4243 mN.publicVersion = new Notification();
4244 n.cloneInto(mN.publicVersion, /*heavy=*/ true);
4245 } else {
4246 mN.publicVersion = null;
4247 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004248 return this;
4249 }
4250
Griff Hazenb720abe2014-05-20 13:15:30 -07004251 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004252 * Apply an extender to this notification builder. Extenders may be used to add
4253 * metadata or change options on this builder.
4254 */
Griff Hazen61a9e862014-05-22 16:05:19 -07004255 public Builder extend(Extender extender) {
4256 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004257 return this;
4258 }
4259
Dan Sandler4e787062015-06-17 15:09:48 -04004260 /**
4261 * @hide
4262 */
Julia Reynoldse46bb372016-03-17 11:05:58 -04004263 public Builder setFlag(int mask, boolean value) {
Joe Onorato46439ce2010-11-19 13:56:21 -08004264 if (value) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004265 mN.flags |= mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004266 } else {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004267 mN.flags &= ~mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004268 }
Julia Reynoldse46bb372016-03-17 11:05:58 -04004269 return this;
Joe Onorato46439ce2010-11-19 13:56:21 -08004270 }
4271
Dan Sandler26e81cf2014-05-06 10:01:27 -04004272 /**
4273 * Sets {@link Notification#color}.
4274 *
4275 * @param argb The accent color to use
4276 *
4277 * @return The same Builder.
4278 */
Tor Norbye80756e32015-03-02 09:39:27 -08004279 public Builder setColor(@ColorInt int argb) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004280 mN.color = argb;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05004281 sanitizeColor();
Dan Sandler26e81cf2014-05-06 10:01:27 -04004282 return this;
4283 }
4284
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004285 private Drawable getProfileBadgeDrawable() {
Chris Wren66619a22016-05-12 16:42:37 -04004286 if (mContext.getUserId() == UserHandle.USER_SYSTEM) {
4287 // This user can never be a badged profile,
4288 // and also includes USER_ALL system notifications.
4289 return null;
4290 }
Christoph Studer7ac80e62014-08-04 16:01:57 +02004291 // Note: This assumes that the current user can read the profile badge of the
4292 // originating user.
Selim Cineke6ff9462016-01-15 15:07:06 -08004293 return mContext.getPackageManager().getUserBadgeForDensityNoBackground(
Julia Reynoldsda303542015-11-23 14:00:20 -05004294 new UserHandle(mContext.getUserId()), 0);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004295 }
4296
4297 private Bitmap getProfileBadge() {
4298 Drawable badge = getProfileBadgeDrawable();
Kenny Guy8a0101b2014-05-08 23:34:12 +01004299 if (badge == null) {
4300 return null;
4301 }
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004302 final int size = mContext.getResources().getDimensionPixelSize(
4303 R.dimen.notification_badge_size);
4304 Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004305 Canvas canvas = new Canvas(bitmap);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004306 badge.setBounds(0, 0, size, size);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004307 badge.draw(canvas);
4308 return bitmap;
4309 }
4310
Selim Cinekc848c3a2016-01-13 15:27:30 -08004311 private void bindProfileBadge(RemoteViews contentView) {
Kenny Guy98193ea2014-07-24 19:54:37 +01004312 Bitmap profileBadge = getProfileBadge();
4313
Kenny Guy98193ea2014-07-24 19:54:37 +01004314 if (profileBadge != null) {
Selim Cinekc848c3a2016-01-13 15:27:30 -08004315 contentView.setImageViewBitmap(R.id.profile_badge, profileBadge);
4316 contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004317 if (isColorized()) {
Sunny Goyal5b153922017-09-21 21:00:36 -07004318 contentView.setDrawableTint(R.id.profile_badge, false,
4319 getPrimaryTextColor(), PorterDuff.Mode.SRC_ATOP);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004320 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004321 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004322 }
4323
Julia Reynoldsfc640012018-02-21 12:25:27 -05004324 /**
4325 * @hide
4326 */
4327 public boolean usesStandardHeader() {
4328 if (mN.mUsesStandardHeader) {
4329 return true;
4330 }
4331 if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.N) {
4332 if (mN.contentView == null && mN.bigContentView == null) {
4333 return true;
4334 }
4335 }
4336 boolean contentViewUsesHeader = mN.contentView == null
4337 || STANDARD_LAYOUTS.contains(mN.contentView.getLayoutId());
4338 boolean bigContentViewUsesHeader = mN.bigContentView == null
4339 || STANDARD_LAYOUTS.contains(mN.bigContentView.getLayoutId());
4340 return contentViewUsesHeader && bigContentViewUsesHeader;
4341 }
4342
Christoph Studerfe718432014-09-01 18:21:18 +02004343 private void resetStandardTemplate(RemoteViews contentView) {
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004344 resetNotificationHeader(contentView);
Christoph Studerfe718432014-09-01 18:21:18 +02004345 contentView.setViewVisibility(R.id.right_icon, View.GONE);
Selim Cinek860b6da2015-12-16 19:02:19 -08004346 contentView.setViewVisibility(R.id.title, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004347 contentView.setTextViewText(R.id.title, null);
Selim Cinek41598732016-01-11 16:58:37 -08004348 contentView.setViewVisibility(R.id.text, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004349 contentView.setTextViewText(R.id.text, null);
Selim Cinek29603462015-11-17 19:04:39 -08004350 contentView.setViewVisibility(R.id.text_line_1, View.GONE);
Selim Cinek41598732016-01-11 16:58:37 -08004351 contentView.setTextViewText(R.id.text_line_1, null);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004352 }
4353
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004354 /**
4355 * Resets the notification header to its original state
4356 */
4357 private void resetNotificationHeader(RemoteViews contentView) {
Adrian Roosc4337a32016-08-02 18:30:34 -07004358 // Small icon doesn't need to be reset, as it's always set. Resetting would prevent
4359 // re-using the drawable when the notification is updated.
Selim Cinek7b836392015-12-04 20:02:59 -08004360 contentView.setBoolean(R.id.notification_header, "setExpanded", false);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004361 contentView.setTextViewText(R.id.app_name_text, null);
Christoph Studerca1db712014-09-10 17:31:33 +02004362 contentView.setViewVisibility(R.id.chronometer, View.GONE);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004363 contentView.setViewVisibility(R.id.header_text, View.GONE);
Adrian Roos9dfb78f2016-06-30 15:43:44 -07004364 contentView.setTextViewText(R.id.header_text, null);
Selim Cinekafeed292017-12-12 17:32:44 -08004365 contentView.setViewVisibility(R.id.header_text_secondary, View.GONE);
4366 contentView.setTextViewText(R.id.header_text_secondary, null);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004367 contentView.setViewVisibility(R.id.header_text_divider, View.GONE);
Selim Cinekafeed292017-12-12 17:32:44 -08004368 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004369 contentView.setViewVisibility(R.id.time_divider, View.GONE);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004370 contentView.setViewVisibility(R.id.time, View.GONE);
Selim Cinekc848c3a2016-01-13 15:27:30 -08004371 contentView.setImageViewIcon(R.id.profile_badge, null);
4372 contentView.setViewVisibility(R.id.profile_badge, View.GONE);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004373 mN.mUsesStandardHeader = false;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004374 }
4375
Selim Cinek384804b2018-04-18 14:31:07 +08004376 private RemoteViews applyStandardTemplate(int resId, TemplateBindResult result) {
4377 return applyStandardTemplate(resId, mParams.reset().fillTextsFrom(this),
4378 result);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004379 }
4380
4381 /**
4382 * @param hasProgress whether the progress bar should be shown and set
Selim Cinek384804b2018-04-18 14:31:07 +08004383 * @param result
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004384 */
Selim Cinek384804b2018-04-18 14:31:07 +08004385 private RemoteViews applyStandardTemplate(int resId, boolean hasProgress,
4386 TemplateBindResult result) {
Adrian Roos70d7aa32017-01-11 15:39:06 -08004387 return applyStandardTemplate(resId, mParams.reset().hasProgress(hasProgress)
Selim Cinek384804b2018-04-18 14:31:07 +08004388 .fillTextsFrom(this), result);
Adrian Roosc1a80b02016-04-05 14:54:55 -07004389 }
4390
Selim Cinek384804b2018-04-18 14:31:07 +08004391 private RemoteViews applyStandardTemplate(int resId, StandardTemplateParams p,
4392 TemplateBindResult result) {
Kenny Guy77320062014-08-27 21:37:15 +01004393 RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId);
Dan Sandler539aad42014-08-04 00:43:39 -04004394
Christoph Studerfe718432014-09-01 18:21:18 +02004395 resetStandardTemplate(contentView);
4396
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004397 final Bundle ex = mN.extras;
Selim Cinek7b9605b2017-01-19 17:36:00 -08004398 updateBackgroundColor(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004399 bindNotificationHeader(contentView, p.ambient, p.headerTextSecondary);
Selim Cinek384804b2018-04-18 14:31:07 +08004400 bindLargeIconAndReply(contentView, p, result);
Adrian Roos70d7aa32017-01-11 15:39:06 -08004401 boolean showProgress = handleProgressBar(p.hasProgress, contentView, ex);
4402 if (p.title != null) {
Selim Cinek860b6da2015-12-16 19:02:19 -08004403 contentView.setViewVisibility(R.id.title, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004404 contentView.setTextViewText(R.id.title, processTextSpans(p.title));
Adrian Roos72171622017-01-27 10:32:06 -08004405 if (!p.ambient) {
4406 setTextViewColorPrimary(contentView, R.id.title);
4407 }
Selim Cinek954cc232016-05-20 13:29:23 -07004408 contentView.setViewLayoutWidth(R.id.title, showProgress
4409 ? ViewGroup.LayoutParams.WRAP_CONTENT
4410 : ViewGroup.LayoutParams.MATCH_PARENT);
Joe Onorato561d3852010-11-20 18:09:34 -08004411 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08004412 if (p.text != null) {
Selim Cinek41598732016-01-11 16:58:37 -08004413 int textId = showProgress ? com.android.internal.R.id.text_line_1
4414 : com.android.internal.R.id.text;
Selim Cinek48f66b72017-08-18 16:17:51 -07004415 contentView.setTextViewText(textId, processTextSpans(p.text));
Adrian Roos72171622017-01-27 10:32:06 -08004416 if (!p.ambient) {
4417 setTextViewColorSecondary(contentView, textId);
4418 }
Selim Cinek41598732016-01-11 16:58:37 -08004419 contentView.setViewVisibility(textId, View.VISIBLE);
Joe Onorato561d3852010-11-20 18:09:34 -08004420 }
Selim Cinekc848c3a2016-01-13 15:27:30 -08004421
Selim Cinek279fa862016-06-14 10:57:25 -07004422 setContentMinHeight(contentView, showProgress || mN.hasLargeIcon());
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004423
Selim Cinek29603462015-11-17 19:04:39 -08004424 return contentView;
4425 }
4426
Selim Cinek48f66b72017-08-18 16:17:51 -07004427 private CharSequence processTextSpans(CharSequence text) {
4428 if (hasForegroundColor()) {
Selim Cinek87c31532017-08-18 18:53:44 -07004429 return NotificationColorUtil.clearColorSpans(text);
Selim Cinek48f66b72017-08-18 16:17:51 -07004430 }
4431 return text;
4432 }
4433
Selim Cinek7b9605b2017-01-19 17:36:00 -08004434 private void setTextViewColorPrimary(RemoteViews contentView, int id) {
4435 ensureColors();
4436 contentView.setTextColor(id, mPrimaryTextColor);
4437 }
4438
Selim Cinek48f66b72017-08-18 16:17:51 -07004439 private boolean hasForegroundColor() {
4440 return mForegroundColor != COLOR_INVALID;
4441 }
4442
Selim Cinek389edcd2017-05-11 19:16:44 -07004443 /**
4444 * @return the primary text color
4445 * @hide
4446 */
4447 @VisibleForTesting
4448 public int getPrimaryTextColor() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004449 ensureColors();
4450 return mPrimaryTextColor;
4451 }
4452
Selim Cinek389edcd2017-05-11 19:16:44 -07004453 /**
4454 * @return the secondary text color
4455 * @hide
4456 */
4457 @VisibleForTesting
4458 public int getSecondaryTextColor() {
4459 ensureColors();
4460 return mSecondaryTextColor;
4461 }
4462
Selim Cinek7b9605b2017-01-19 17:36:00 -08004463 private void setTextViewColorSecondary(RemoteViews contentView, int id) {
4464 ensureColors();
4465 contentView.setTextColor(id, mSecondaryTextColor);
4466 }
4467
4468 private void ensureColors() {
4469 int backgroundColor = getBackgroundColor();
4470 if (mPrimaryTextColor == COLOR_INVALID
4471 || mSecondaryTextColor == COLOR_INVALID
Selim Cinek7b9605b2017-01-19 17:36:00 -08004472 || mTextColorsAreForBackground != backgroundColor) {
4473 mTextColorsAreForBackground = backgroundColor;
Selim Cinek48f66b72017-08-18 16:17:51 -07004474 if (!hasForegroundColor() || !isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004475 mPrimaryTextColor = NotificationColorUtil.resolvePrimaryColor(mContext,
4476 backgroundColor);
4477 mSecondaryTextColor = NotificationColorUtil.resolveSecondaryColor(mContext,
4478 backgroundColor);
Selim Cinekc7f5a822018-03-20 19:32:06 -07004479 if (backgroundColor != COLOR_DEFAULT && isColorized()) {
Selim Cinekac5f0272017-05-02 16:05:41 -07004480 mPrimaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4481 mPrimaryTextColor, backgroundColor, 4.5);
4482 mSecondaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4483 mSecondaryTextColor, backgroundColor, 4.5);
4484 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07004485 } else {
4486 double backLum = NotificationColorUtil.calculateLuminance(backgroundColor);
4487 double textLum = NotificationColorUtil.calculateLuminance(mForegroundColor);
4488 double contrast = NotificationColorUtil.calculateContrast(mForegroundColor,
4489 backgroundColor);
Selim Cinek389edcd2017-05-11 19:16:44 -07004490 // We only respect the given colors if worst case Black or White still has
4491 // contrast
4492 boolean backgroundLight = backLum > textLum
4493 && satisfiesTextContrast(backgroundColor, Color.BLACK)
4494 || backLum <= textLum
4495 && !satisfiesTextContrast(backgroundColor, Color.WHITE);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004496 if (contrast < 4.5f) {
Selim Cinek389edcd2017-05-11 19:16:44 -07004497 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004498 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4499 mForegroundColor,
4500 backgroundColor,
4501 true /* findFG */,
4502 4.5f);
4503 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004504 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_LIGHT);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004505 } else {
4506 mSecondaryTextColor =
4507 NotificationColorUtil.findContrastColorAgainstDark(
4508 mForegroundColor,
4509 backgroundColor,
4510 true /* findFG */,
4511 4.5f);
4512 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004513 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004514 }
4515 } else {
4516 mPrimaryTextColor = mForegroundColor;
4517 mSecondaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004518 mPrimaryTextColor, backgroundLight ? LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4519 : LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004520 if (NotificationColorUtil.calculateContrast(mSecondaryTextColor,
4521 backgroundColor) < 4.5f) {
4522 // oh well the secondary is not good enough
Selim Cinek389edcd2017-05-11 19:16:44 -07004523 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004524 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4525 mSecondaryTextColor,
4526 backgroundColor,
4527 true /* findFG */,
4528 4.5f);
4529 } else {
4530 mSecondaryTextColor
4531 = NotificationColorUtil.findContrastColorAgainstDark(
4532 mSecondaryTextColor,
4533 backgroundColor,
4534 true /* findFG */,
4535 4.5f);
4536 }
4537 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004538 mSecondaryTextColor, backgroundLight
4539 ? -LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4540 : -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004541 }
4542 }
4543 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08004544 }
4545 }
4546
4547 private void updateBackgroundColor(RemoteViews contentView) {
4548 if (isColorized()) {
4549 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundColor",
4550 getBackgroundColor());
4551 } else {
4552 // Clear it!
4553 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundResource",
4554 0);
4555 }
4556 }
4557
Selim Cinek860b6da2015-12-16 19:02:19 -08004558 /**
4559 * @param remoteView the remote view to update the minheight in
4560 * @param hasMinHeight does it have a mimHeight
4561 * @hide
4562 */
4563 void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) {
4564 int minHeight = 0;
4565 if (hasMinHeight) {
4566 // we need to set the minHeight of the notification
4567 minHeight = mContext.getResources().getDimensionPixelSize(
4568 com.android.internal.R.dimen.notification_min_content_height);
4569 }
4570 remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight);
4571 }
4572
Selim Cinek29603462015-11-17 19:04:39 -08004573 private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004574 final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0);
4575 final int progress = ex.getInt(EXTRA_PROGRESS, 0);
4576 final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
4577 if (hasProgress && (max != 0 || ind)) {
Selim Cinek29603462015-11-17 19:04:39 -08004578 contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004579 contentView.setProgressBar(
Selim Cinek29603462015-11-17 19:04:39 -08004580 R.id.progress, max, progress, ind);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004581 contentView.setProgressBackgroundTintList(
4582 R.id.progress, ColorStateList.valueOf(mContext.getColor(
4583 R.color.notification_progress_background_color)));
Selim Cinek29603462015-11-17 19:04:39 -08004584 if (mN.color != COLOR_DEFAULT) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08004585 ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004586 contentView.setProgressTintList(R.id.progress, colorStateList);
4587 contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004588 }
Selim Cinek29603462015-11-17 19:04:39 -08004589 return true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004590 } else {
4591 contentView.setViewVisibility(R.id.progress, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004592 return false;
Jeff Sharkey1c400132011-08-05 14:50:13 -07004593 }
Joe Onorato561d3852010-11-20 18:09:34 -08004594 }
4595
Selim Cinek384804b2018-04-18 14:31:07 +08004596 private void bindLargeIconAndReply(RemoteViews contentView, StandardTemplateParams p,
4597 TemplateBindResult result) {
4598 boolean largeIconShown = bindLargeIcon(contentView, p.hideLargeIcon || p.ambient);
Selim Cinek1c72fa02018-04-23 18:00:54 +08004599 boolean replyIconShown = bindReplyIcon(contentView, p.hideReplyIcon || p.ambient);
Selim Cinek384804b2018-04-18 14:31:07 +08004600 contentView.setViewVisibility(R.id.right_icon_container,
Selim Cinek1c72fa02018-04-23 18:00:54 +08004601 largeIconShown || replyIconShown ? View.VISIBLE : View.GONE);
4602 int marginEnd = calculateMarginEnd(largeIconShown, replyIconShown);
4603 contentView.setViewLayoutMarginEnd(R.id.line1, marginEnd);
4604 contentView.setViewLayoutMarginEnd(R.id.text, marginEnd);
4605 contentView.setViewLayoutMarginEnd(R.id.progress, marginEnd);
Selim Cinek384804b2018-04-18 14:31:07 +08004606 if (result != null) {
Selim Cinek1c72fa02018-04-23 18:00:54 +08004607 result.setIconMarginEnd(marginEnd);
Selim Cinek384804b2018-04-18 14:31:07 +08004608 }
4609 }
4610
Selim Cinek1c72fa02018-04-23 18:00:54 +08004611 private int calculateMarginEnd(boolean largeIconShown, boolean replyIconShown) {
4612 int marginEnd = 0;
4613 int contentMargin = mContext.getResources().getDimensionPixelSize(
4614 R.dimen.notification_content_margin_end);
4615 int iconSize = mContext.getResources().getDimensionPixelSize(
4616 R.dimen.notification_right_icon_size);
4617 if (replyIconShown) {
4618 // The size of the reply icon
4619 marginEnd += iconSize;
4620
4621 int replyInset = mContext.getResources().getDimensionPixelSize(
4622 R.dimen.notification_reply_inset);
4623 // We're subtracting the inset of the reply icon to make sure it's
4624 // aligned nicely on the right, and remove it from the following padding
4625 marginEnd -= replyInset * 2;
4626 }
4627 if (largeIconShown) {
4628 // adding size of the right icon
4629 marginEnd += iconSize;
4630
4631 if (replyIconShown) {
4632 // We also add some padding to the reply icon if it's around
4633 marginEnd += contentMargin;
4634 }
4635 }
4636 if (replyIconShown || largeIconShown) {
4637 // The padding to the content
4638 marginEnd += contentMargin;
4639 }
4640 return marginEnd;
4641 }
4642
Selim Cinek384804b2018-04-18 14:31:07 +08004643 /**
4644 * Bind the large icon.
4645 * @return if the largeIcon is visible
4646 */
4647 private boolean bindLargeIcon(RemoteViews contentView, boolean hideLargeIcon) {
Selim Cinek279fa862016-06-14 10:57:25 -07004648 if (mN.mLargeIcon == null && mN.largeIcon != null) {
4649 mN.mLargeIcon = Icon.createWithBitmap(mN.largeIcon);
4650 }
Selim Cinek88188f22017-09-19 16:46:56 -07004651 boolean showLargeIcon = mN.mLargeIcon != null && !hideLargeIcon;
4652 if (showLargeIcon) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004653 contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4654 contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon);
4655 processLargeLegacyIcon(mN.mLargeIcon, contentView);
Selim Cinek88188f22017-09-19 16:46:56 -07004656 }
Selim Cinek384804b2018-04-18 14:31:07 +08004657 return showLargeIcon;
4658 }
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004659
Selim Cinek384804b2018-04-18 14:31:07 +08004660 /**
4661 * Bind the reply icon.
4662 * @return if the reply icon is visible
4663 */
4664 private boolean bindReplyIcon(RemoteViews contentView, boolean hideReplyIcon) {
4665 boolean actionVisible = !hideReplyIcon;
4666 Action action = null;
Selim Cinek88188f22017-09-19 16:46:56 -07004667 if (actionVisible) {
Selim Cinek384804b2018-04-18 14:31:07 +08004668 action = findReplyAction();
4669 actionVisible = action != null;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004670 }
Selim Cinek384804b2018-04-18 14:31:07 +08004671 if (actionVisible) {
4672 contentView.setViewVisibility(R.id.reply_icon_action, View.VISIBLE);
4673 contentView.setDrawableTint(R.id.reply_icon_action,
4674 false /* targetBackground */,
Selim Cinek4717d862018-04-19 09:19:15 +08004675 getNeutralColor(),
Selim Cinek384804b2018-04-18 14:31:07 +08004676 PorterDuff.Mode.SRC_ATOP);
4677 contentView.setOnClickPendingIntent(R.id.reply_icon_action, action.actionIntent);
4678 contentView.setRemoteInputs(R.id.reply_icon_action, action.mRemoteInputs);
4679 } else {
4680 contentView.setRemoteInputs(R.id.reply_icon_action, null);
4681 }
4682 contentView.setViewVisibility(R.id.reply_icon_action,
4683 actionVisible ? View.VISIBLE : View.GONE);
4684 return actionVisible;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004685 }
4686
4687 private Action findReplyAction() {
4688 ArrayList<Action> actions = mActions;
4689 if (mOriginalActions != null) {
4690 actions = mOriginalActions;
4691 }
4692 int numActions = actions.size();
4693 for (int i = 0; i < numActions; i++) {
4694 Action action = actions.get(i);
4695 if (hasValidRemoteInput(action)) {
4696 return action;
4697 }
4698 }
4699 return null;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004700 }
4701
Selim Cinekafeed292017-12-12 17:32:44 -08004702 private void bindNotificationHeader(RemoteViews contentView, boolean ambient,
4703 CharSequence secondaryHeaderText) {
Adrian Roos487374f2017-01-11 15:48:14 -08004704 bindSmallIcon(contentView, ambient);
4705 bindHeaderAppName(contentView, ambient);
4706 if (!ambient) {
4707 // Ambient view does not have these
4708 bindHeaderText(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004709 bindHeaderTextSecondary(contentView, secondaryHeaderText);
Adrian Roos487374f2017-01-11 15:48:14 -08004710 bindHeaderChronometerAndTime(contentView);
Adrian Roos487374f2017-01-11 15:48:14 -08004711 bindProfileBadge(contentView);
4712 }
Julia Reynolds6013e5c2018-04-18 08:43:34 -04004713 bindActivePermissions(contentView, ambient);
Adrian Roosd83e9992017-03-16 15:17:57 -07004714 bindExpandButton(contentView);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004715 mN.mUsesStandardHeader = true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004716 }
4717
Julia Reynolds6013e5c2018-04-18 08:43:34 -04004718 private void bindActivePermissions(RemoteViews contentView, boolean ambient) {
Selim Cinek4717d862018-04-19 09:19:15 +08004719 int color = ambient ? resolveAmbientColor() : getNeutralColor();
Julia Reynoldsb887b232018-04-10 16:38:08 -04004720 contentView.setDrawableTint(R.id.camera, false, color, PorterDuff.Mode.SRC_ATOP);
4721 contentView.setDrawableTint(R.id.mic, false, color, PorterDuff.Mode.SRC_ATOP);
4722 contentView.setDrawableTint(R.id.overlay, false, color, PorterDuff.Mode.SRC_ATOP);
4723 }
4724
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004725 private void bindExpandButton(RemoteViews contentView) {
Selim Cinekc7f5a822018-03-20 19:32:06 -07004726 int color = isColorized() ? getPrimaryTextColor() : getSecondaryTextColor();
Sunny Goyal5b153922017-09-21 21:00:36 -07004727 contentView.setDrawableTint(R.id.expand_button, false, color,
4728 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08004729 contentView.setInt(R.id.notification_header, "setOriginalNotificationColor",
Selim Cinek7b9605b2017-01-19 17:36:00 -08004730 color);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004731 }
4732
4733 private void bindHeaderChronometerAndTime(RemoteViews contentView) {
4734 if (showsTimeOrChronometer()) {
Selim Cinek29603462015-11-17 19:04:39 -08004735 contentView.setViewVisibility(R.id.time_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004736 setTextViewColorSecondary(contentView, R.id.time_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004737 if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) {
4738 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
4739 contentView.setLong(R.id.chronometer, "setBase",
4740 mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
4741 contentView.setBoolean(R.id.chronometer, "setStarted", true);
Adrian Roos96b7e202016-05-17 13:50:38 -07004742 boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN);
Selim Cinekc3b752e2016-04-20 16:13:59 -07004743 contentView.setChronometerCountDown(R.id.chronometer, countsDown);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004744 setTextViewColorSecondary(contentView, R.id.chronometer);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004745 } else {
4746 contentView.setViewVisibility(R.id.time, View.VISIBLE);
4747 contentView.setLong(R.id.time, "setTime", mN.when);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004748 setTextViewColorSecondary(contentView, R.id.time);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004749 }
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004750 } else {
4751 // We still want a time to be set but gone, such that we can show and hide it
4752 // on demand in case it's a child notification without anything in the header
4753 contentView.setLong(R.id.time, "setTime", mN.when != 0 ? mN.when : mN.creationTime);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004754 }
4755 }
4756
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004757 private void bindHeaderText(RemoteViews contentView) {
4758 CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
4759 if (headerText == null && mStyle != null && mStyle.mSummaryTextSet
Selim Cinek03d0d652015-11-13 13:18:09 -05004760 && mStyle.hasSummaryInHeader()) {
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004761 headerText = mStyle.mSummaryText;
Selim Cinek03d0d652015-11-13 13:18:09 -05004762 }
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004763 if (headerText == null
4764 && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
4765 && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) {
4766 headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT);
4767 }
4768 if (headerText != null) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004769 // TODO: Remove the span entirely to only have the string with propper formating.
Selim Cinek48f66b72017-08-18 16:17:51 -07004770 contentView.setTextViewText(R.id.header_text, processTextSpans(
4771 processLegacyText(headerText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004772 setTextViewColorSecondary(contentView, R.id.header_text);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004773 contentView.setViewVisibility(R.id.header_text, View.VISIBLE);
4774 contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004775 setTextViewColorSecondary(contentView, R.id.header_text_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004776 }
4777 }
4778
Selim Cinekafeed292017-12-12 17:32:44 -08004779 private void bindHeaderTextSecondary(RemoteViews contentView, CharSequence secondaryText) {
4780 if (!TextUtils.isEmpty(secondaryText)) {
4781 contentView.setTextViewText(R.id.header_text_secondary, processTextSpans(
4782 processLegacyText(secondaryText)));
4783 setTextViewColorSecondary(contentView, R.id.header_text_secondary);
4784 contentView.setViewVisibility(R.id.header_text_secondary, View.VISIBLE);
4785 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.VISIBLE);
4786 setTextViewColorSecondary(contentView, R.id.header_text_secondary_divider);
4787 }
4788 }
4789
Adrian Rooseba05822016-04-22 17:09:27 -07004790 /**
4791 * @hide
4792 */
4793 public String loadHeaderAppName() {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004794 CharSequence name = null;
4795 final PackageManager pm = mContext.getPackageManager();
4796 if (mN.extras.containsKey(EXTRA_SUBSTITUTE_APP_NAME)) {
4797 // only system packages which lump together a bunch of unrelated stuff
4798 // may substitute a different name to make the purpose of the
4799 // notification more clear. the correct package label should always
4800 // be accessible via SystemUI.
4801 final String pkg = mContext.getPackageName();
4802 final String subName = mN.extras.getString(EXTRA_SUBSTITUTE_APP_NAME);
4803 if (PackageManager.PERMISSION_GRANTED == pm.checkPermission(
4804 android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME, pkg)) {
4805 name = subName;
4806 } else {
4807 Log.w(TAG, "warning: pkg "
4808 + pkg + " attempting to substitute app name '" + subName
4809 + "' without holding perm "
4810 + android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME);
4811 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004812 }
Dan Sandler732bd6c2016-04-12 14:20:32 -04004813 if (TextUtils.isEmpty(name)) {
4814 name = pm.getApplicationLabel(mContext.getApplicationInfo());
4815 }
4816 if (TextUtils.isEmpty(name)) {
4817 // still nothing?
4818 return null;
4819 }
4820
4821 return String.valueOf(name);
4822 }
Adrian Roos487374f2017-01-11 15:48:14 -08004823 private void bindHeaderAppName(RemoteViews contentView, boolean ambient) {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004824 contentView.setTextViewText(R.id.app_name_text, loadHeaderAppName());
Adrian Roos72171622017-01-27 10:32:06 -08004825 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004826 setTextViewColorPrimary(contentView, R.id.app_name_text);
4827 } else {
4828 contentView.setTextColor(R.id.app_name_text,
Selim Cinekc7f5a822018-03-20 19:32:06 -07004829 ambient ? resolveAmbientColor() : getSecondaryTextColor());
Selim Cinek7b9605b2017-01-19 17:36:00 -08004830 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004831 }
4832
Adrian Roos487374f2017-01-11 15:48:14 -08004833 private void bindSmallIcon(RemoteViews contentView, boolean ambient) {
Selim Cinek279fa862016-06-14 10:57:25 -07004834 if (mN.mSmallIcon == null && mN.icon != 0) {
4835 mN.mSmallIcon = Icon.createWithResource(mContext, mN.icon);
4836 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004837 contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon);
Sunny Goyal5b153922017-09-21 21:00:36 -07004838 contentView.setInt(R.id.icon, "setImageLevel", mN.iconLevel);
Adrian Roos487374f2017-01-11 15:48:14 -08004839 processSmallIconColor(mN.mSmallIcon, contentView, ambient);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004840 }
4841
Jorim Jaggi445d3c02014-08-19 22:33:42 +02004842 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004843 * @return true if the built notification will show the time or the chronometer; false
4844 * otherwise
4845 */
4846 private boolean showsTimeOrChronometer() {
Selim Cinekc2c0b042016-05-18 17:13:46 -07004847 return mN.showsTime() || mN.showsChronometer();
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004848 }
4849
Christoph Studerfe718432014-09-01 18:21:18 +02004850 private void resetStandardTemplateWithActions(RemoteViews big) {
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004851 // actions_container is only reset when there are no actions to avoid focus issues with
4852 // remote inputs.
Christoph Studerfe718432014-09-01 18:21:18 +02004853 big.setViewVisibility(R.id.actions, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004854 big.removeAllViews(R.id.actions);
Adrian Roose458aa82015-12-08 16:17:19 -08004855
4856 big.setViewVisibility(R.id.notification_material_reply_container, View.GONE);
4857 big.setTextViewText(R.id.notification_material_reply_text_1, null);
Kenny Guya0f6de82018-04-06 16:20:16 +01004858 big.setViewVisibility(R.id.notification_material_reply_text_1_container, View.GONE);
4859 big.setViewVisibility(R.id.notification_material_reply_progress, View.GONE);
Adrian Roose458aa82015-12-08 16:17:19 -08004860
4861 big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE);
4862 big.setTextViewText(R.id.notification_material_reply_text_2, null);
4863 big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE);
4864 big.setTextViewText(R.id.notification_material_reply_text_3, null);
Adrian Roosf852a422016-06-03 13:33:43 -07004865
Selim Cineked64a142018-02-06 18:06:01 -08004866 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target,
4867 R.dimen.notification_content_margin);
Christoph Studerfe718432014-09-01 18:21:18 +02004868 }
4869
Selim Cinek384804b2018-04-18 14:31:07 +08004870 private RemoteViews applyStandardTemplateWithActions(int layoutId,
4871 TemplateBindResult result) {
4872 return applyStandardTemplateWithActions(layoutId, mParams.reset().fillTextsFrom(this),
4873 result);
Adrian Roos48d746a2016-04-12 14:57:28 -07004874 }
4875
Adrian Roos70d7aa32017-01-11 15:39:06 -08004876 private RemoteViews applyStandardTemplateWithActions(int layoutId,
Selim Cinek384804b2018-04-18 14:31:07 +08004877 StandardTemplateParams p, TemplateBindResult result) {
4878 RemoteViews big = applyStandardTemplate(layoutId, p, result);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004879
Christoph Studerfe718432014-09-01 18:21:18 +02004880 resetStandardTemplateWithActions(big);
4881
Adrian Roose458aa82015-12-08 16:17:19 -08004882 boolean validRemoteInput = false;
4883
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004884 int N = mActions.size();
Adrian Roos487374f2017-01-11 15:48:14 -08004885 boolean emphazisedMode = mN.fullScreenIntent != null && !p.ambient;
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004886 big.setBoolean(R.id.actions, "setEmphasizedMode", emphazisedMode);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004887 if (N > 0) {
Adrian Roos7052de52016-03-03 15:53:34 -08004888 big.setViewVisibility(R.id.actions_container, View.VISIBLE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004889 big.setViewVisibility(R.id.actions, View.VISIBLE);
Selim Cineked64a142018-02-06 18:06:01 -08004890 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, 0);
Daniel Sandler8680bf82012-05-15 16:52:52 -04004891 if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004892 for (int i=0; i<N; i++) {
Adrian Roose458aa82015-12-08 16:17:19 -08004893 Action action = mActions.get(i);
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004894 boolean actionHasValidInput = hasValidRemoteInput(action);
4895 validRemoteInput |= actionHasValidInput;
Adrian Roose458aa82015-12-08 16:17:19 -08004896
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004897 final RemoteViews button = generateActionButton(action, emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07004898 p.ambient);
4899 if (actionHasValidInput && !emphazisedMode) {
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004900 // Clear the drawable
4901 button.setInt(R.id.action0, "setBackgroundResource", 0);
4902 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004903 big.addView(R.id.actions, button);
4904 }
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004905 } else {
4906 big.setViewVisibility(R.id.actions_container, View.GONE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004907 }
Adrian Roose458aa82015-12-08 16:17:19 -08004908
4909 CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
Adrian Roos487374f2017-01-11 15:48:14 -08004910 if (!p.ambient && validRemoteInput && replyText != null
Selim Cinekbee4e072018-05-21 22:06:43 -07004911 && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])
4912 && p.maxRemoteInputHistory > 0) {
Kenny Guya0f6de82018-04-06 16:20:16 +01004913 boolean showSpinner = mN.extras.getBoolean(EXTRA_SHOW_REMOTE_INPUT_SPINNER);
Adrian Roose458aa82015-12-08 16:17:19 -08004914 big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE);
Kenny Guya0f6de82018-04-06 16:20:16 +01004915 big.setViewVisibility(R.id.notification_material_reply_text_1_container,
4916 View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004917 big.setTextViewText(R.id.notification_material_reply_text_1,
4918 processTextSpans(replyText[0]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004919 setTextViewColorSecondary(big, R.id.notification_material_reply_text_1);
Kenny Guya0f6de82018-04-06 16:20:16 +01004920 big.setViewVisibility(R.id.notification_material_reply_progress,
4921 showSpinner ? View.VISIBLE : View.GONE);
4922 big.setProgressIndeterminateTintList(
4923 R.id.notification_material_reply_progress,
4924 ColorStateList.valueOf(
4925 isColorized() ? getPrimaryTextColor() : resolveContrastColor()));
Adrian Roose458aa82015-12-08 16:17:19 -08004926
Selim Cinekbee4e072018-05-21 22:06:43 -07004927 if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])
4928 && p.maxRemoteInputHistory > 1) {
Adrian Roose458aa82015-12-08 16:17:19 -08004929 big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004930 big.setTextViewText(R.id.notification_material_reply_text_2,
4931 processTextSpans(replyText[1]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004932 setTextViewColorSecondary(big, R.id.notification_material_reply_text_2);
Adrian Roose458aa82015-12-08 16:17:19 -08004933
Selim Cinekbee4e072018-05-21 22:06:43 -07004934 if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])
4935 && p.maxRemoteInputHistory > 2) {
Adrian Roose458aa82015-12-08 16:17:19 -08004936 big.setViewVisibility(
4937 R.id.notification_material_reply_text_3, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004938 big.setTextViewText(R.id.notification_material_reply_text_3,
4939 processTextSpans(replyText[2]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004940 setTextViewColorSecondary(big, R.id.notification_material_reply_text_3);
Adrian Roose458aa82015-12-08 16:17:19 -08004941 }
4942 }
4943 }
4944
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004945 return big;
4946 }
4947
Adrian Roose458aa82015-12-08 16:17:19 -08004948 private boolean hasValidRemoteInput(Action action) {
4949 if (TextUtils.isEmpty(action.title) || action.actionIntent == null) {
4950 // Weird actions
4951 return false;
4952 }
4953
4954 RemoteInput[] remoteInputs = action.getRemoteInputs();
4955 if (remoteInputs == null) {
4956 return false;
4957 }
4958
4959 for (RemoteInput r : remoteInputs) {
4960 CharSequence[] choices = r.getChoices();
4961 if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) {
4962 return true;
4963 }
4964 }
4965 return false;
4966 }
4967
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004968 /**
4969 * Construct a RemoteViews for the final 1U notification layout. In order:
4970 * 1. Custom contentView from the caller
4971 * 2. Style's proposed content view
4972 * 3. Standard template view
4973 */
Julia Reynolds3b848122016-02-26 10:45:32 -05004974 public RemoteViews createContentView() {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004975 return createContentView(false /* increasedheight */ );
4976 }
4977
4978 /**
4979 * Construct a RemoteViews for the smaller content view.
4980 *
4981 * @param increasedHeight true if this layout be created with an increased height. Some
4982 * styles may support showing more then just that basic 1U size
4983 * and the system may decide to render important notifications
4984 * slightly bigger even when collapsed.
4985 *
4986 * @hide
4987 */
4988 public RemoteViews createContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07004989 if (mN.contentView != null && useExistingRemoteView()) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004990 return mN.contentView;
4991 } else if (mStyle != null) {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004992 final RemoteViews styleView = mStyle.makeContentView(increasedHeight);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004993 if (styleView != null) {
4994 return styleView;
4995 }
Joe Onorato46439ce2010-11-19 13:56:21 -08004996 }
Selim Cinek384804b2018-04-18 14:31:07 +08004997 return applyStandardTemplate(getBaseLayoutResource(), null /* result */);
Joe Onorato46439ce2010-11-19 13:56:21 -08004998 }
4999
Selim Cineka7679b62017-05-10 16:33:25 -07005000 private boolean useExistingRemoteView() {
5001 return mStyle == null || (!mStyle.displayCustomViewInline()
5002 && !mRebuildStyledRemoteViews);
5003 }
5004
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005005 /**
5006 * Construct a RemoteViews for the final big notification layout.
5007 */
Julia Reynolds3b848122016-02-26 10:45:32 -05005008 public RemoteViews createBigContentView() {
Selim Cinek850a8542015-11-11 11:48:36 -05005009 RemoteViews result = null;
Selim Cineka7679b62017-05-10 16:33:25 -07005010 if (mN.bigContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05005011 return mN.bigContentView;
5012 } else if (mStyle != null) {
Selim Cinek850a8542015-11-11 11:48:36 -05005013 result = mStyle.makeBigContentView();
Selim Cinek90dcf6d2015-11-18 20:24:13 -08005014 hideLine1Text(result);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005015 } else if (mActions.size() != 0) {
Selim Cinek384804b2018-04-18 14:31:07 +08005016 result = applyStandardTemplateWithActions(getBigBaseLayoutResource(),
5017 null /* result */);
Selim Cinek850a8542015-11-11 11:48:36 -05005018 }
Selim Cinek6743c0b2017-01-18 18:24:01 -08005019 makeHeaderExpanded(result);
Selim Cinek850a8542015-11-11 11:48:36 -05005020 return result;
5021 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005022
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005023 /**
Selim Cinek414ad332017-02-24 19:06:12 -08005024 * Construct a RemoteViews for the final notification header only. This will not be
5025 * colorized.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005026 *
Adrian Roos6f6e1592017-05-02 16:22:53 -07005027 * @param ambient if true, generate the header for the ambient display layout.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005028 * @hide
5029 */
Adrian Roos6f6e1592017-05-02 16:22:53 -07005030 public RemoteViews makeNotificationHeader(boolean ambient) {
Selim Cinek414ad332017-02-24 19:06:12 -08005031 Boolean colorized = (Boolean) mN.extras.get(EXTRA_COLORIZED);
5032 mN.extras.putBoolean(EXTRA_COLORIZED, false);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005033 RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(),
Adrian Roos6f6e1592017-05-02 16:22:53 -07005034 ambient ? R.layout.notification_template_ambient_header
5035 : R.layout.notification_template_header);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005036 resetNotificationHeader(header);
Selim Cinekafeed292017-12-12 17:32:44 -08005037 bindNotificationHeader(header, ambient, null);
Selim Cinek414ad332017-02-24 19:06:12 -08005038 if (colorized != null) {
5039 mN.extras.putBoolean(EXTRA_COLORIZED, colorized);
5040 } else {
5041 mN.extras.remove(EXTRA_COLORIZED);
5042 }
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005043 return header;
5044 }
5045
Adrian Roos487374f2017-01-11 15:48:14 -08005046 /**
5047 * Construct a RemoteViews for the ambient version of the notification.
5048 *
5049 * @hide
5050 */
5051 public RemoteViews makeAmbientNotification() {
5052 RemoteViews ambient = applyStandardTemplateWithActions(
5053 R.layout.notification_template_material_ambient,
Selim Cinek384804b2018-04-18 14:31:07 +08005054 mParams.reset().ambient(true).fillTextsFrom(this).hasProgress(false),
5055 null /* result */);
Adrian Roos487374f2017-01-11 15:48:14 -08005056 return ambient;
5057 }
5058
Selim Cinek29603462015-11-17 19:04:39 -08005059 private void hideLine1Text(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005060 if (result != null) {
5061 result.setViewVisibility(R.id.text_line_1, View.GONE);
5062 }
Selim Cinek29603462015-11-17 19:04:39 -08005063 }
5064
Selim Cinek6743c0b2017-01-18 18:24:01 -08005065 /**
5066 * Adapt the Notification header if this view is used as an expanded view.
5067 *
5068 * @hide
5069 */
5070 public static void makeHeaderExpanded(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005071 if (result != null) {
5072 result.setBoolean(R.id.notification_header, "setExpanded", true);
5073 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005074 }
5075
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005076 /**
5077 * Construct a RemoteViews for the final heads-up notification layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08005078 *
5079 * @param increasedHeight true if this layout be created with an increased height. Some
5080 * styles may support showing more then just that basic 1U size
5081 * and the system may decide to render important notifications
5082 * slightly bigger even when collapsed.
5083 *
5084 * @hide
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005085 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08005086 public RemoteViews createHeadsUpContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07005087 if (mN.headsUpContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05005088 return mN.headsUpContentView;
5089 } else if (mStyle != null) {
Selim Cinek87ed69b2017-02-09 15:59:43 -08005090 final RemoteViews styleView = mStyle.makeHeadsUpContentView(increasedHeight);
5091 if (styleView != null) {
5092 return styleView;
5093 }
Julia Reynolds089e3e42015-11-18 09:59:57 -05005094 } else if (mActions.size() == 0) {
5095 return null;
5096 }
5097
Selim Cinekbee4e072018-05-21 22:06:43 -07005098 // We only want at most a single remote input history to be shown here, otherwise
5099 // the content would become squished.
5100 StandardTemplateParams p = mParams.reset().fillTextsFrom(this)
5101 .setMaxRemoteInputHistory(1);
5102 return applyStandardTemplateWithActions(getBigBaseLayoutResource(),
5103 p,
5104 null /* result */);
Chris Wren8fd39ec2014-02-27 17:43:26 -05005105 }
5106
Selim Cinek624c02db2015-12-14 21:00:02 -08005107 /**
Selim Cinek87ed69b2017-02-09 15:59:43 -08005108 * Construct a RemoteViews for the final heads-up notification layout.
5109 */
5110 public RemoteViews createHeadsUpContentView() {
5111 return createHeadsUpContentView(false /* useIncreasedHeight */);
5112 }
5113
5114 /**
Selim Cinek624c02db2015-12-14 21:00:02 -08005115 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
5116 *
5117 * @hide
5118 */
5119 public RemoteViews makePublicContentView() {
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005120 return makePublicView(false /* ambient */);
5121 }
5122
5123 /**
5124 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
5125 *
5126 * @hide
5127 */
5128 public RemoteViews makePublicAmbientNotification() {
5129 return makePublicView(true /* ambient */);
5130 }
5131
5132 private RemoteViews makePublicView(boolean ambient) {
Selim Cinek624c02db2015-12-14 21:00:02 -08005133 if (mN.publicVersion != null) {
5134 final Builder builder = recoverBuilder(mContext, mN.publicVersion);
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005135 return ambient ? builder.makeAmbientNotification() : builder.createContentView();
Selim Cinek624c02db2015-12-14 21:00:02 -08005136 }
5137 Bundle savedBundle = mN.extras;
5138 Style style = mStyle;
5139 mStyle = null;
5140 Icon largeIcon = mN.mLargeIcon;
5141 mN.mLargeIcon = null;
Selim Cinek279fa862016-06-14 10:57:25 -07005142 Bitmap largeIconLegacy = mN.largeIcon;
5143 mN.largeIcon = null;
Adrian Roosb19b06b2017-05-02 18:54:40 -07005144 ArrayList<Action> actions = mActions;
5145 mActions = new ArrayList<>();
Selim Cinek624c02db2015-12-14 21:00:02 -08005146 Bundle publicExtras = new Bundle();
5147 publicExtras.putBoolean(EXTRA_SHOW_WHEN,
5148 savedBundle.getBoolean(EXTRA_SHOW_WHEN));
5149 publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER,
5150 savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER));
Adrian Roos96b7e202016-05-17 13:50:38 -07005151 publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN,
5152 savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN));
Selim Cineked07b962018-04-30 14:39:35 -07005153 String appName = savedBundle.getString(EXTRA_SUBSTITUTE_APP_NAME);
5154 if (appName != null) {
5155 publicExtras.putString(EXTRA_SUBSTITUTE_APP_NAME, appName);
5156 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005157 mN.extras = publicExtras;
Selim Cinek499c20f2017-07-20 14:06:09 -07005158 RemoteViews view;
5159 if (ambient) {
5160 publicExtras.putCharSequence(EXTRA_TITLE,
5161 mContext.getString(com.android.internal.R.string.notification_hidden_text));
5162 view = makeAmbientNotification();
5163 } else{
5164 view = makeNotificationHeader(false /* ambient */);
5165 view.setBoolean(R.id.notification_header, "setExpandOnlyOnButton", true);
5166 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005167 mN.extras = savedBundle;
5168 mN.mLargeIcon = largeIcon;
Selim Cinek279fa862016-06-14 10:57:25 -07005169 mN.largeIcon = largeIconLegacy;
Adrian Roosb19b06b2017-05-02 18:54:40 -07005170 mActions = actions;
Selim Cinek624c02db2015-12-14 21:00:02 -08005171 mStyle = style;
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005172 return view;
Selim Cinek624c02db2015-12-14 21:00:02 -08005173 }
5174
Selim Cinek6743c0b2017-01-18 18:24:01 -08005175 /**
5176 * Construct a content view for the display when low - priority
5177 *
5178 * @param useRegularSubtext uses the normal subtext set if there is one available. Otherwise
5179 * a new subtext is created consisting of the content of the
5180 * notification.
5181 * @hide
5182 */
5183 public RemoteViews makeLowPriorityContentView(boolean useRegularSubtext) {
5184 int color = mN.color;
5185 mN.color = COLOR_DEFAULT;
5186 CharSequence summary = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
5187 if (!useRegularSubtext || TextUtils.isEmpty(summary)) {
5188 CharSequence newSummary = createSummaryText();
5189 if (!TextUtils.isEmpty(newSummary)) {
5190 mN.extras.putCharSequence(EXTRA_SUB_TEXT, newSummary);
5191 }
5192 }
Selim Cinek875ba9b2017-02-13 16:20:17 -08005193
Adrian Roos6f6e1592017-05-02 16:22:53 -07005194 RemoteViews header = makeNotificationHeader(false /* ambient */);
Selim Cinek1b554392017-02-28 17:22:49 -08005195 header.setBoolean(R.id.notification_header, "setAcceptAllTouches", true);
Selim Cinek6743c0b2017-01-18 18:24:01 -08005196 if (summary != null) {
5197 mN.extras.putCharSequence(EXTRA_SUB_TEXT, summary);
5198 } else {
5199 mN.extras.remove(EXTRA_SUB_TEXT);
5200 }
5201 mN.color = color;
5202 return header;
5203 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005204
Selim Cinek6743c0b2017-01-18 18:24:01 -08005205 private CharSequence createSummaryText() {
5206 CharSequence titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE);
5207 if (USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY) {
5208 return titleText;
5209 }
5210 SpannableStringBuilder summary = new SpannableStringBuilder();
5211 if (titleText == null) {
5212 titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE_BIG);
5213 }
5214 BidiFormatter bidi = BidiFormatter.getInstance();
5215 if (titleText != null) {
5216 summary.append(bidi.unicodeWrap(titleText));
5217 }
5218 CharSequence contentText = mN.extras.getCharSequence(Notification.EXTRA_TEXT);
5219 if (titleText != null && contentText != null) {
5220 summary.append(bidi.unicodeWrap(mContext.getText(
5221 R.string.notification_header_divider_symbol_with_spaces)));
5222 }
5223 if (contentText != null) {
5224 summary.append(bidi.unicodeWrap(contentText));
5225 }
5226 return summary;
5227 }
Chris Wren8fd39ec2014-02-27 17:43:26 -05005228
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005229 private RemoteViews generateActionButton(Action action, boolean emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07005230 boolean ambient) {
Daniel Sandler8680bf82012-05-15 16:52:52 -04005231 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07005232 RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(),
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005233 emphazisedMode ? getEmphasizedActionLayoutResource()
5234 : tombstone ? getActionTombstoneLayoutResource()
5235 : getActionLayoutResource());
Daniel Sandler8680bf82012-05-15 16:52:52 -04005236 if (!tombstone) {
Daniel Sandlere5518842012-05-10 16:20:40 -04005237 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
Daniel Sandlere5518842012-05-10 16:20:40 -04005238 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005239 button.setContentDescription(R.id.action0, action.title);
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005240 if (action.mRemoteInputs != null) {
5241 button.setRemoteInputs(R.id.action0, action.mRemoteInputs);
5242 }
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005243 if (emphazisedMode) {
Selim Cinek981962e2016-07-20 20:41:58 -07005244 // change the background bgColor
Selim Cinek981962e2016-07-20 20:41:58 -07005245 CharSequence title = action.title;
5246 ColorStateList[] outResultColor = null;
Selim Cinek396caca2018-04-10 17:46:46 -07005247 int background = resolveBackgroundColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005248 if (isLegacy()) {
Selim Cinek87c31532017-08-18 18:53:44 -07005249 title = NotificationColorUtil.clearColorSpans(title);
Selim Cinek981962e2016-07-20 20:41:58 -07005250 } else {
5251 outResultColor = new ColorStateList[1];
Selim Cinek396caca2018-04-10 17:46:46 -07005252 title = ensureColorSpanContrast(title, background, outResultColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005253 }
Selim Cinek48f66b72017-08-18 16:17:51 -07005254 button.setTextViewText(R.id.action0, processTextSpans(title));
Selim Cinek7b9605b2017-01-19 17:36:00 -08005255 setTextViewColorPrimary(button, R.id.action0);
Selim Cinek396caca2018-04-10 17:46:46 -07005256 int rippleColor;
5257 boolean hasColorOverride = outResultColor != null && outResultColor[0] != null;
5258 if (hasColorOverride) {
5259 // There's a span spanning the full text, let's take it and use it as the
5260 // background color
5261 background = outResultColor[0].getDefaultColor();
5262 int textColor = NotificationColorUtil.resolvePrimaryColor(mContext,
5263 background);
5264 button.setTextColor(R.id.action0, textColor);
5265 rippleColor = textColor;
Anthony Chenad4d1582017-04-10 16:07:58 -07005266 } else if (mN.color != COLOR_DEFAULT && !isColorized() && mTintActionButtons) {
Selim Cinek396caca2018-04-10 17:46:46 -07005267 rippleColor = resolveContrastColor();
5268 button.setTextColor(R.id.action0, rippleColor);
5269 } else {
5270 rippleColor = getPrimaryTextColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005271 }
Selim Cinek396caca2018-04-10 17:46:46 -07005272 // We only want about 20% alpha for the ripple
5273 rippleColor = (rippleColor & 0x00ffffff) | 0x33000000;
5274 button.setColorStateList(R.id.action0, "setRippleColor",
5275 ColorStateList.valueOf(rippleColor));
5276 button.setColorStateList(R.id.action0, "setButtonBackground",
5277 ColorStateList.valueOf(background));
5278 button.setBoolean(R.id.action0, "setHasStroke", !hasColorOverride);
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005279 } else {
Selim Cinek48f66b72017-08-18 16:17:51 -07005280 button.setTextViewText(R.id.action0, processTextSpans(
5281 processLegacyText(action.title)));
Adrian Roos72171622017-01-27 10:32:06 -08005282 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005283 setTextViewColorPrimary(button, R.id.action0);
Anthony Chenad4d1582017-04-10 16:07:58 -07005284 } else if (mN.color != COLOR_DEFAULT && mTintActionButtons) {
Adrian Roos487374f2017-01-11 15:48:14 -08005285 button.setTextColor(R.id.action0,
5286 ambient ? resolveAmbientColor() : resolveContrastColor());
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005287 }
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005288 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005289 return button;
5290 }
5291
Joe Onoratocb109a02011-01-18 17:57:41 -08005292 /**
Selim Cinek981962e2016-07-20 20:41:58 -07005293 * Ensures contrast on color spans against a background color. also returns the color of the
5294 * text if a span was found that spans over the whole text.
5295 *
5296 * @param charSequence the charSequence on which the spans are
5297 * @param background the background color to ensure the contrast against
5298 * @param outResultColor an array in which a color will be returned as the first element if
5299 * there exists a full length color span.
5300 * @return the contrasted charSequence
5301 */
5302 private CharSequence ensureColorSpanContrast(CharSequence charSequence, int background,
5303 ColorStateList[] outResultColor) {
5304 if (charSequence instanceof Spanned) {
5305 Spanned ss = (Spanned) charSequence;
5306 Object[] spans = ss.getSpans(0, ss.length(), Object.class);
5307 SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
5308 for (Object span : spans) {
5309 Object resultSpan = span;
5310 int spanStart = ss.getSpanStart(span);
5311 int spanEnd = ss.getSpanEnd(span);
5312 boolean fullLength = (spanEnd - spanStart) == charSequence.length();
5313 if (resultSpan instanceof CharacterStyle) {
5314 resultSpan = ((CharacterStyle) span).getUnderlying();
5315 }
5316 if (resultSpan instanceof TextAppearanceSpan) {
5317 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
5318 ColorStateList textColor = originalSpan.getTextColor();
5319 if (textColor != null) {
5320 int[] colors = textColor.getColors();
5321 int[] newColors = new int[colors.length];
5322 for (int i = 0; i < newColors.length; i++) {
5323 newColors[i] = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005324 colors[i], background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005325 }
5326 textColor = new ColorStateList(textColor.getStates().clone(),
5327 newColors);
Selim Cinek396caca2018-04-10 17:46:46 -07005328 if (fullLength) {
5329 outResultColor[0] = textColor;
5330 // Let's drop the color from the span
5331 textColor = null;
5332 }
Selim Cinek981962e2016-07-20 20:41:58 -07005333 resultSpan = new TextAppearanceSpan(
5334 originalSpan.getFamily(),
5335 originalSpan.getTextStyle(),
5336 originalSpan.getTextSize(),
5337 textColor,
5338 originalSpan.getLinkTextColor());
Selim Cinek981962e2016-07-20 20:41:58 -07005339 }
5340 } else if (resultSpan instanceof ForegroundColorSpan) {
5341 ForegroundColorSpan originalSpan = (ForegroundColorSpan) resultSpan;
5342 int foregroundColor = originalSpan.getForegroundColor();
5343 foregroundColor = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005344 foregroundColor, background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005345 if (fullLength) {
5346 outResultColor[0] = ColorStateList.valueOf(foregroundColor);
Selim Cinek396caca2018-04-10 17:46:46 -07005347 resultSpan = null;
5348 } else {
5349 resultSpan = new ForegroundColorSpan(foregroundColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005350 }
5351 } else {
5352 resultSpan = span;
5353 }
Selim Cinek396caca2018-04-10 17:46:46 -07005354 if (resultSpan != null) {
5355 builder.setSpan(resultSpan, spanStart, spanEnd, ss.getSpanFlags(span));
5356 }
Selim Cinek981962e2016-07-20 20:41:58 -07005357 }
5358 return builder;
5359 }
5360 return charSequence;
5361 }
5362
5363 /**
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005364 * @return Whether we are currently building a notification from a legacy (an app that
Alan Viverette3cb07a462014-06-06 14:19:53 -07005365 * doesn't create material notifications by itself) app.
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005366 */
5367 private boolean isLegacy() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005368 if (!mIsLegacyInitialized) {
5369 mIsLegacy = mContext.getApplicationInfo().targetSdkVersion
5370 < Build.VERSION_CODES.LOLLIPOP;
5371 mIsLegacyInitialized = true;
5372 }
5373 return mIsLegacy;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005374 }
5375
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005376 private CharSequence processLegacyText(CharSequence charSequence) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08005377 return processLegacyText(charSequence, false /* ambient */);
5378 }
5379
5380 private CharSequence processLegacyText(CharSequence charSequence, boolean ambient) {
5381 boolean isAlreadyLightText = isLegacy() || textColorsNeedInversion();
5382 boolean wantLightText = ambient;
5383 if (isAlreadyLightText != wantLightText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005384 return getColorUtil().invertCharSequenceColors(charSequence);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005385 } else {
5386 return charSequence;
5387 }
5388 }
5389
Dan Sandler26e81cf2014-05-06 10:01:27 -04005390 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005391 * Apply any necessariy colors to the small icon
Dan Sandler26e81cf2014-05-06 10:01:27 -04005392 */
Adrian Roos487374f2017-01-11 15:48:14 -08005393 private void processSmallIconColor(Icon smallIcon, RemoteViews contentView,
5394 boolean ambient) {
Selim Cinekea4bef72015-12-02 15:51:10 -08005395 boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon);
Selim Cinekc7f5a822018-03-20 19:32:06 -07005396 int color;
5397 if (ambient) {
5398 color = resolveAmbientColor();
5399 } else if (isColorized()) {
5400 color = getPrimaryTextColor();
5401 } else {
5402 color = resolveContrastColor();
5403 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005404 if (colorable) {
Sunny Goyal5b153922017-09-21 21:00:36 -07005405 contentView.setDrawableTint(R.id.icon, false, color,
5406 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08005407
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005408 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005409 contentView.setInt(R.id.notification_header, "setOriginalIconColor",
Adrian Roos487374f2017-01-11 15:48:14 -08005410 colorable ? color : NotificationHeaderView.NO_COLOR);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005411 }
5412
Dan Sandler26e81cf2014-05-06 10:01:27 -04005413 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005414 * Make the largeIcon dark if it's a fake smallIcon (that is,
Dan Sandler26e81cf2014-05-06 10:01:27 -04005415 * if it's grayscale).
5416 */
5417 // TODO: also check bounds, transparency, that sort of thing.
Dan Sandlerd63f9322015-05-06 15:18:49 -04005418 private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) {
5419 if (largeIcon != null && isLegacy()
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005420 && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005421 // resolve color will fall back to the default when legacy
Sunny Goyal5b153922017-09-21 21:00:36 -07005422 contentView.setDrawableTint(R.id.icon, false, resolveContrastColor(),
5423 PorterDuff.Mode.SRC_ATOP);
Jorim Jaggi92df1f22014-12-16 19:44:41 +01005424 }
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005425 }
5426
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05005427 private void sanitizeColor() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005428 if (mN.color != COLOR_DEFAULT) {
5429 mN.color |= 0xFF000000; // no alpha for custom colors
Jorim Jaggi74419312014-06-10 20:57:21 +02005430 }
Jorim Jaggi74419312014-06-10 20:57:21 +02005431 }
5432
Adrian Roos4ff3b122016-02-01 12:26:13 -08005433 int resolveContrastColor() {
5434 if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) {
5435 return mCachedContrastColor;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005436 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005437
Selim Cinekac5f0272017-05-02 16:05:41 -07005438 int color;
Selim Cinekc7f5a822018-03-20 19:32:06 -07005439 int background = mContext.getColor(
5440 com.android.internal.R.color.notification_material_background_color);
Selim Cinekac5f0272017-05-02 16:05:41 -07005441 if (mN.color == COLOR_DEFAULT) {
5442 ensureColors();
Selim Cinekc7f5a822018-03-20 19:32:06 -07005443 color = NotificationColorUtil.resolveDefaultColor(mContext, background);
Selim Cinekac5f0272017-05-02 16:05:41 -07005444 } else {
5445 color = NotificationColorUtil.resolveContrastColor(mContext, mN.color,
Anthony Chenad4d1582017-04-10 16:07:58 -07005446 background, mInNightMode);
Selim Cinekac5f0272017-05-02 16:05:41 -07005447 }
5448 if (Color.alpha(color) < 255) {
5449 // alpha doesn't go well for color filters, so let's blend it manually
5450 color = NotificationColorUtil.compositeColors(color, background);
5451 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005452 mCachedContrastColorIsFor = mN.color;
Selim Cinekac5f0272017-05-02 16:05:41 -07005453 return mCachedContrastColor = color;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005454 }
5455
Selim Cinek4717d862018-04-19 09:19:15 +08005456 int resolveNeutralColor() {
5457 if (mNeutralColor != COLOR_INVALID) {
5458 return mNeutralColor;
5459 }
5460 int background = mContext.getColor(
5461 com.android.internal.R.color.notification_material_background_color);
5462 mNeutralColor = NotificationColorUtil.resolveDefaultColor(mContext, background);
5463 if (Color.alpha(mNeutralColor) < 255) {
5464 // alpha doesn't go well for color filters, so let's blend it manually
5465 mNeutralColor = NotificationColorUtil.compositeColors(mNeutralColor, background);
5466 }
5467 return mNeutralColor;
5468 }
5469
Adrian Roos487374f2017-01-11 15:48:14 -08005470 int resolveAmbientColor() {
5471 if (mCachedAmbientColorIsFor == mN.color && mCachedAmbientColorIsFor != COLOR_INVALID) {
5472 return mCachedAmbientColor;
5473 }
5474 final int contrasted = NotificationColorUtil.resolveAmbientColor(mContext, mN.color);
5475
5476 mCachedAmbientColorIsFor = mN.color;
5477 return mCachedAmbientColor = contrasted;
5478 }
5479
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005480 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005481 * Apply the unstyled operations and return a new {@link Notification} object.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005482 * @hide
Joe Onoratocb109a02011-01-18 17:57:41 -08005483 */
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005484 public Notification buildUnstyled() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005485 if (mActions.size() > 0) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005486 mN.actions = new Action[mActions.size()];
5487 mActions.toArray(mN.actions);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005488 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005489 if (!mPersonList.isEmpty()) {
Selim Cineke7238dd2017-12-14 17:48:32 -08005490 mN.extras.putParcelableArrayList(EXTRA_PEOPLE_LIST, mPersonList);
Dan Sandler0bf2ed82013-12-21 23:33:41 -06005491 }
Selim Cinek247fa012016-02-18 09:50:48 -08005492 if (mN.bigContentView != null || mN.contentView != null
5493 || mN.headsUpContentView != null) {
5494 mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true);
5495 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005496 return mN;
Joe Onorato46439ce2010-11-19 13:56:21 -08005497 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005498
Julia Reynolds3b848122016-02-26 10:45:32 -05005499 /**
5500 * Creates a Builder from an existing notification so further changes can be made.
5501 * @param context The context for your application / activity.
5502 * @param n The notification to create a Builder from.
5503 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005504 public static Notification.Builder recoverBuilder(Context context, Notification n) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02005505 // Re-create notification context so we can access app resources.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005506 ApplicationInfo applicationInfo = n.extras.getParcelable(
5507 EXTRA_BUILDER_APPLICATION_INFO);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005508 Context builderContext;
Julia Reynoldsda303542015-11-23 14:00:20 -05005509 if (applicationInfo != null) {
5510 try {
5511 builderContext = context.createApplicationContext(applicationInfo,
5512 Context.CONTEXT_RESTRICTED);
5513 } catch (NameNotFoundException e) {
5514 Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found");
5515 builderContext = context; // try with our context
5516 }
5517 } else {
5518 builderContext = context; // try with given context
Christoph Studer4600f9b2014-07-22 22:44:43 +02005519 }
5520
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005521 return new Builder(builderContext, n);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005522 }
5523
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005524 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005525 * @deprecated Use {@link #build()} instead.
5526 */
5527 @Deprecated
5528 public Notification getNotification() {
5529 return build();
5530 }
5531
5532 /**
5533 * Combine all of the options that have been set and return a new {@link Notification}
5534 * object.
5535 */
5536 public Notification build() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005537 // first, add any extras from the calling code
5538 if (mUserExtras != null) {
5539 mN.extras = getAllExtras();
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07005540 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005541
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005542 mN.creationTime = System.currentTimeMillis();
5543
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005544 // lazy stuff from mContext; see comment in Builder(Context, Notification)
Julia Reynoldsda303542015-11-23 14:00:20 -05005545 Notification.addFieldsFromContext(mContext, mN);
Christoph Studer943aa672014-08-03 20:31:16 +02005546
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005547 buildUnstyled();
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005548
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005549 if (mStyle != null) {
Selim Cinekd0426622017-07-11 13:19:59 +02005550 mStyle.reduceImageSizes(mContext);
5551 mStyle.purgeResources();
Selim Cinek90343862018-02-01 11:07:11 -08005552 mStyle.validate(mContext);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005553 mStyle.buildStyled(mN);
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005554 }
Selim Cinekd0426622017-07-11 13:19:59 +02005555 mN.reduceImageSizes(mContext);
5556
Adrian Roos5081c0d2016-02-26 16:04:19 -08005557 if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
Selim Cineka7679b62017-05-10 16:33:25 -07005558 && (useExistingRemoteView())) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005559 if (mN.contentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005560 mN.contentView = createContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005561 mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT,
5562 mN.contentView.getSequenceNumber());
5563 }
5564 if (mN.bigContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005565 mN.bigContentView = createBigContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005566 if (mN.bigContentView != null) {
5567 mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT,
5568 mN.bigContentView.getSequenceNumber());
5569 }
5570 }
5571 if (mN.headsUpContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005572 mN.headsUpContentView = createHeadsUpContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005573 if (mN.headsUpContentView != null) {
5574 mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT,
5575 mN.headsUpContentView.getSequenceNumber());
5576 }
5577 }
5578 }
5579
Julia Reynolds4c0c2022016-02-02 15:11:59 -05005580 if ((mN.defaults & DEFAULT_LIGHTS) != 0) {
5581 mN.flags |= FLAG_SHOW_LIGHTS;
5582 }
5583
Adrian Roosfb921842017-10-26 14:49:56 +02005584 mN.allPendingIntents = null;
5585
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005586 return mN;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005587 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005588
5589 /**
5590 * Apply this Builder to an existing {@link Notification} object.
5591 *
5592 * @hide
5593 */
5594 public Notification buildInto(Notification n) {
Daniel Sandler1a497d32013-04-18 14:52:45 -04005595 build().cloneInto(n, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005596 return n;
5597 }
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005598
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005599 /**
Adrian Roos184bfe022016-03-03 13:41:44 -08005600 * Removes RemoteViews that were created for compatibility from {@param n}, if they did not
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005601 * change. Also removes extenders on low ram devices, as
5602 * {@link android.service.notification.NotificationListenerService} services are disabled.
Adrian Roos184bfe022016-03-03 13:41:44 -08005603 *
5604 * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}.
5605 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005606 * @hide
5607 */
Kristian Monsen30f59b22018-04-09 10:27:16 +02005608 public static Notification maybeCloneStrippedForDelivery(Notification n, boolean isLowRam,
5609 Context context) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005610 String templateClass = n.extras.getString(EXTRA_TEMPLATE);
Adrian Roos184bfe022016-03-03 13:41:44 -08005611
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005612 // Only strip views for known Styles because we won't know how to
5613 // re-create them otherwise.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005614 if (!isLowRam
5615 && !TextUtils.isEmpty(templateClass)
Adrian Roos184bfe022016-03-03 13:41:44 -08005616 && getNotificationStyleClass(templateClass) == null) {
5617 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005618 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005619
5620 // Only strip unmodified BuilderRemoteViews.
5621 boolean stripContentView = n.contentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005622 n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005623 n.contentView.getSequenceNumber();
5624 boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005625 n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005626 n.bigContentView.getSequenceNumber();
5627 boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005628 n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005629 n.headsUpContentView.getSequenceNumber();
5630
5631 // Nothing to do here, no need to clone.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005632 if (!isLowRam
5633 && !stripContentView && !stripBigContentView && !stripHeadsUpContentView) {
Adrian Roos184bfe022016-03-03 13:41:44 -08005634 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005635 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005636
5637 Notification clone = n.clone();
5638 if (stripContentView) {
5639 clone.contentView = null;
5640 clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT);
5641 }
5642 if (stripBigContentView) {
5643 clone.bigContentView = null;
5644 clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT);
5645 }
5646 if (stripHeadsUpContentView) {
5647 clone.headsUpContentView = null;
5648 clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT);
5649 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005650 if (isLowRam) {
Kristian Monsen30f59b22018-04-09 10:27:16 +02005651 String[] allowedServices = context.getResources().getStringArray(
5652 R.array.config_allowedManagedServicesOnLowRamDevices);
5653 if (allowedServices.length == 0) {
5654 clone.extras.remove(Notification.TvExtender.EXTRA_TV_EXTENDER);
5655 clone.extras.remove(WearableExtender.EXTRA_WEARABLE_EXTENSIONS);
5656 clone.extras.remove(CarExtender.EXTRA_CAR_EXTENDER);
5657 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005658 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005659 return clone;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005660 }
5661
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005662 private int getBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005663 return R.layout.notification_template_material_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005664 }
5665
5666 private int getBigBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005667 return R.layout.notification_template_material_big_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005668 }
5669
5670 private int getBigPictureLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005671 return R.layout.notification_template_material_big_picture;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005672 }
5673
5674 private int getBigTextLayoutResource() {
Jorim Jaggi445d3c02014-08-19 22:33:42 +02005675 return R.layout.notification_template_material_big_text;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005676 }
5677
5678 private int getInboxLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005679 return R.layout.notification_template_material_inbox;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005680 }
5681
Adrian Roosc1a80b02016-04-05 14:54:55 -07005682 private int getMessagingLayoutResource() {
5683 return R.layout.notification_template_material_messaging;
5684 }
5685
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005686 private int getActionLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005687 return R.layout.notification_material_action;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005688 }
5689
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005690 private int getEmphasizedActionLayoutResource() {
5691 return R.layout.notification_material_action_emphasized;
5692 }
5693
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005694 private int getActionTombstoneLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005695 return R.layout.notification_material_action_tombstone;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005696 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005697
5698 private int getBackgroundColor() {
5699 if (isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005700 return mBackgroundColor != COLOR_INVALID ? mBackgroundColor : mN.color;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005701 } else {
Selim Cinekc7f5a822018-03-20 19:32:06 -07005702 return COLOR_DEFAULT;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005703 }
5704 }
5705
Selim Cinek396caca2018-04-10 17:46:46 -07005706 /**
Selim Cinek4717d862018-04-19 09:19:15 +08005707 * Gets a neutral color that can be used for icons or similar that should not stand out.
5708 */
5709 private int getNeutralColor() {
5710 if (isColorized()) {
5711 return getSecondaryTextColor();
5712 } else {
5713 return resolveNeutralColor();
5714 }
5715 }
5716
5717 /**
Selim Cinek396caca2018-04-10 17:46:46 -07005718 * Same as getBackgroundColor but also resolved the default color to the background.
5719 */
5720 private int resolveBackgroundColor() {
5721 int backgroundColor = getBackgroundColor();
5722 if (backgroundColor == COLOR_DEFAULT) {
5723 backgroundColor = mContext.getColor(
5724 com.android.internal.R.color.notification_material_background_color);
5725 }
5726 return backgroundColor;
5727 }
5728
Selim Cinek7b9605b2017-01-19 17:36:00 -08005729 private boolean isColorized() {
5730 return mN.isColorized();
5731 }
Selim Cinek99104832017-01-25 14:47:33 -08005732
Anthony Chenad4d1582017-04-10 16:07:58 -07005733 private boolean shouldTintActionButtons() {
5734 return mTintActionButtons;
5735 }
5736
Selim Cinek99104832017-01-25 14:47:33 -08005737 private boolean textColorsNeedInversion() {
5738 if (mStyle == null || !MediaStyle.class.equals(mStyle.getClass())) {
5739 return false;
5740 }
5741 int targetSdkVersion = mContext.getApplicationInfo().targetSdkVersion;
5742 return targetSdkVersion > Build.VERSION_CODES.M
5743 && targetSdkVersion < Build.VERSION_CODES.O;
5744 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005745
5746 /**
5747 * Set a color palette to be used as the background and textColors
5748 *
5749 * @param backgroundColor the color to be used as the background
5750 * @param foregroundColor the color to be used as the foreground
5751 *
5752 * @hide
5753 */
5754 public void setColorPalette(int backgroundColor, int foregroundColor) {
5755 mBackgroundColor = backgroundColor;
5756 mForegroundColor = foregroundColor;
5757 mTextColorsAreForBackground = COLOR_INVALID;
5758 ensureColors();
5759 }
Selim Cinekac5f0272017-05-02 16:05:41 -07005760
5761 /**
Selim Cineka7679b62017-05-10 16:33:25 -07005762 * Forces all styled remoteViews to be built from scratch and not use any cached
5763 * RemoteViews.
5764 * This is needed for legacy apps that are baking in their remoteviews into the
5765 * notification.
5766 *
5767 * @hide
5768 */
5769 public void setRebuildStyledRemoteViews(boolean rebuild) {
5770 mRebuildStyledRemoteViews = rebuild;
5771 }
Selim Cinekaa9db1f2018-02-27 17:35:47 -08005772
5773 /**
5774 * Get the text that should be displayed in the statusBar when heads upped. This is
5775 * usually just the app name, but may be different depending on the style.
5776 *
5777 * @param publicMode If true, return a text that is safe to display in public.
5778 *
5779 * @hide
5780 */
5781 public CharSequence getHeadsUpStatusBarText(boolean publicMode) {
5782 if (mStyle != null && !publicMode) {
5783 CharSequence text = mStyle.getHeadsUpStatusBarText();
5784 if (!TextUtils.isEmpty(text)) {
5785 return text;
5786 }
5787 }
5788 return loadHeaderAppName();
5789 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005790 }
5791
5792 /**
Selim Cinekd0426622017-07-11 13:19:59 +02005793 * Reduces the image sizes to conform to a maximum allowed size. This also processes all custom
5794 * remote views.
5795 *
5796 * @hide
5797 */
5798 void reduceImageSizes(Context context) {
5799 if (extras.getBoolean(EXTRA_REDUCED_IMAGES)) {
5800 return;
5801 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005802 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02005803 if (mLargeIcon != null || largeIcon != null) {
5804 Resources resources = context.getResources();
5805 Class<? extends Style> style = getNotificationStyle();
Selim Cineka8cb1262017-08-15 16:53:44 -07005806 int maxWidth = resources.getDimensionPixelSize(isLowRam
5807 ? R.dimen.notification_right_icon_size_low_ram
5808 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02005809 int maxHeight = maxWidth;
5810 if (MediaStyle.class.equals(style)
5811 || DecoratedMediaCustomViewStyle.class.equals(style)) {
Selim Cineka8cb1262017-08-15 16:53:44 -07005812 maxHeight = resources.getDimensionPixelSize(isLowRam
5813 ? R.dimen.notification_media_image_max_height_low_ram
5814 : R.dimen.notification_media_image_max_height);
5815 maxWidth = resources.getDimensionPixelSize(isLowRam
5816 ? R.dimen.notification_media_image_max_width_low_ram
5817 : R.dimen.notification_media_image_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02005818 }
5819 if (mLargeIcon != null) {
5820 mLargeIcon.scaleDownIfNecessary(maxWidth, maxHeight);
5821 }
5822 if (largeIcon != null) {
5823 largeIcon = Icon.scaleDownIfNecessary(largeIcon, maxWidth, maxHeight);
5824 }
5825 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005826 reduceImageSizesForRemoteView(contentView, context, isLowRam);
5827 reduceImageSizesForRemoteView(headsUpContentView, context, isLowRam);
5828 reduceImageSizesForRemoteView(bigContentView, context, isLowRam);
Selim Cinekd0426622017-07-11 13:19:59 +02005829 extras.putBoolean(EXTRA_REDUCED_IMAGES, true);
5830 }
5831
Selim Cineka8cb1262017-08-15 16:53:44 -07005832 private void reduceImageSizesForRemoteView(RemoteViews remoteView, Context context,
5833 boolean isLowRam) {
Selim Cinekd0426622017-07-11 13:19:59 +02005834 if (remoteView != null) {
5835 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07005836 int maxWidth = resources.getDimensionPixelSize(isLowRam
5837 ? R.dimen.notification_custom_view_max_image_width_low_ram
5838 : R.dimen.notification_custom_view_max_image_width);
5839 int maxHeight = resources.getDimensionPixelSize(isLowRam
5840 ? R.dimen.notification_custom_view_max_image_height_low_ram
5841 : R.dimen.notification_custom_view_max_image_height);
Selim Cinekd0426622017-07-11 13:19:59 +02005842 remoteView.reduceImageSizes(maxWidth, maxHeight);
5843 }
5844 }
5845
5846 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005847 * @return whether this notification is a foreground service notification
Selim Cinek7b9605b2017-01-19 17:36:00 -08005848 */
Selim Cinek22714f12017-04-13 16:23:53 -07005849 private boolean isForegroundService() {
5850 return (flags & Notification.FLAG_FOREGROUND_SERVICE) != 0;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005851 }
5852
5853 /**
Selim Cinek99104832017-01-25 14:47:33 -08005854 * @return whether this notification has a media session attached
5855 * @hide
5856 */
5857 public boolean hasMediaSession() {
5858 return extras.getParcelable(Notification.EXTRA_MEDIA_SESSION) != null;
5859 }
5860
5861 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08005862 * @return the style class of this notification
5863 * @hide
5864 */
5865 public Class<? extends Notification.Style> getNotificationStyle() {
5866 String templateClass = extras.getString(Notification.EXTRA_TEMPLATE);
5867
5868 if (!TextUtils.isEmpty(templateClass)) {
5869 return Notification.getNotificationStyleClass(templateClass);
5870 }
5871 return null;
5872 }
5873
5874 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005875 * @return true if this notification is colorized.
Selim Cinek7b9605b2017-01-19 17:36:00 -08005876 *
5877 * @hide
5878 */
5879 public boolean isColorized() {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005880 if (isColorizedMedia()) {
5881 return true;
5882 }
Julia Reynolds4db59552017-06-30 13:34:01 -04005883 return extras.getBoolean(EXTRA_COLORIZED)
5884 && (hasColorizedPermission() || isForegroundService());
5885 }
5886
5887 /**
5888 * Returns whether an app can colorize due to the android.permission.USE_COLORIZED_NOTIFICATIONS
5889 * permission. The permission is checked when a notification is enqueued.
5890 */
5891 private boolean hasColorizedPermission() {
5892 return (flags & Notification.FLAG_CAN_COLORIZE) != 0;
Selim Cinek5fb73f82017-04-20 16:55:38 -07005893 }
5894
5895 /**
5896 * @return true if this notification is colorized and it is a media notification
5897 *
5898 * @hide
5899 */
5900 public boolean isColorizedMedia() {
Selim Cinek99104832017-01-25 14:47:33 -08005901 Class<? extends Style> style = getNotificationStyle();
5902 if (MediaStyle.class.equals(style)) {
5903 Boolean colorized = (Boolean) extras.get(EXTRA_COLORIZED);
5904 if ((colorized == null || colorized) && hasMediaSession()) {
5905 return true;
5906 }
5907 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5908 if (extras.getBoolean(EXTRA_COLORIZED) && hasMediaSession()) {
5909 return true;
5910 }
5911 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005912 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005913 }
5914
Selim Cinek0847acd2017-04-24 19:48:29 -07005915
5916 /**
5917 * @return true if this is a media notification
5918 *
5919 * @hide
5920 */
5921 public boolean isMediaNotification() {
5922 Class<? extends Style> style = getNotificationStyle();
5923 if (MediaStyle.class.equals(style)) {
5924 return true;
5925 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5926 return true;
5927 }
5928 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005929 }
5930
Selim Cinek279fa862016-06-14 10:57:25 -07005931 private boolean hasLargeIcon() {
5932 return mLargeIcon != null || largeIcon != null;
5933 }
5934
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005935 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005936 * @return true if the notification will show the time; false otherwise
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005937 * @hide
5938 */
Selim Cinekc2c0b042016-05-18 17:13:46 -07005939 public boolean showsTime() {
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005940 return when != 0 && extras.getBoolean(EXTRA_SHOW_WHEN);
5941 }
5942
5943 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005944 * @return true if the notification will show a chronometer; false otherwise
5945 * @hide
5946 */
5947 public boolean showsChronometer() {
5948 return when != 0 && extras.getBoolean(EXTRA_SHOW_CHRONOMETER);
5949 }
5950
5951 /**
Julia Reynolds7ca33072017-06-29 13:58:24 -04005952 * @removed
Julia Reynolds4a02afb2016-12-13 13:39:52 -05005953 */
5954 @SystemApi
5955 public static Class<? extends Style> getNotificationStyleClass(String templateClass) {
5956 Class<? extends Style>[] classes = new Class[] {
5957 BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class,
5958 DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class,
5959 MessagingStyle.class };
5960 for (Class<? extends Style> innerClass : classes) {
5961 if (templateClass.equals(innerClass.getName())) {
5962 return innerClass;
5963 }
5964 }
5965 return null;
5966 }
5967
5968 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005969 * An object that can apply a rich notification style to a {@link Notification.Builder}
5970 * object.
5971 */
Griff Hazendfcb0802014-02-11 12:00:00 -08005972 public static abstract class Style {
Selim Cinekbee4e072018-05-21 22:06:43 -07005973
5974 /**
5975 * The number of items allowed simulatanously in the remote input history.
5976 * @hide
5977 */
5978 static final int MAX_REMOTE_INPUT_HISTORY_LINES = 3;
Chris Wrend6297db2012-05-03 16:20:13 -04005979 private CharSequence mBigContentTitle;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02005980
5981 /**
5982 * @hide
5983 */
5984 protected CharSequence mSummaryText = null;
5985
5986 /**
5987 * @hide
5988 */
5989 protected boolean mSummaryTextSet = false;
Chris Wrend6297db2012-05-03 16:20:13 -04005990
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005991 protected Builder mBuilder;
5992
Chris Wrend6297db2012-05-03 16:20:13 -04005993 /**
5994 * Overrides ContentTitle in the big form of the template.
5995 * This defaults to the value passed to setContentTitle().
5996 */
5997 protected void internalSetBigContentTitle(CharSequence title) {
5998 mBigContentTitle = title;
5999 }
6000
6001 /**
6002 * Set the first line of text after the detail section in the big form of the template.
6003 */
6004 protected void internalSetSummaryText(CharSequence cs) {
6005 mSummaryText = cs;
Daniel Sandler619738c2012-06-07 16:33:08 -04006006 mSummaryTextSet = true;
Chris Wrend6297db2012-05-03 16:20:13 -04006007 }
6008
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006009 public void setBuilder(Builder builder) {
6010 if (mBuilder != builder) {
6011 mBuilder = builder;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07006012 if (mBuilder != null) {
6013 mBuilder.setStyle(this);
6014 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006015 }
6016 }
6017
Chris Wrend6297db2012-05-03 16:20:13 -04006018 protected void checkBuilder() {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006019 if (mBuilder == null) {
6020 throw new IllegalArgumentException("Style requires a valid Builder object");
6021 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006022 }
Chris Wrend6297db2012-05-03 16:20:13 -04006023
6024 protected RemoteViews getStandardView(int layoutId) {
Selim Cinek384804b2018-04-18 14:31:07 +08006025 return getStandardView(layoutId, null);
6026 }
6027
6028 /**
6029 * Get the standard view for this style.
6030 *
6031 * @param layoutId The layout id to use
6032 * @param result The result where template bind information is saved.
6033 * @return A remoteView for this style.
6034 * @hide
6035 */
6036 protected RemoteViews getStandardView(int layoutId, TemplateBindResult result) {
Chris Wrend6297db2012-05-03 16:20:13 -04006037 checkBuilder();
6038
Christoph Studer4600f9b2014-07-22 22:44:43 +02006039 // Nasty.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006040 CharSequence oldBuilderContentTitle =
6041 mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE);
Chris Wrend6297db2012-05-03 16:20:13 -04006042 if (mBigContentTitle != null) {
6043 mBuilder.setContentTitle(mBigContentTitle);
6044 }
6045
Selim Cinek384804b2018-04-18 14:31:07 +08006046 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId, result);
Chris Wrend6297db2012-05-03 16:20:13 -04006047
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006048 mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006049
Chris Wrend6297db2012-05-03 16:20:13 -04006050 if (mBigContentTitle != null && mBigContentTitle.equals("")) {
6051 contentView.setViewVisibility(R.id.line1, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04006052 } else {
6053 contentView.setViewVisibility(R.id.line1, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04006054 }
6055
Chris Wrend6297db2012-05-03 16:20:13 -04006056 return contentView;
6057 }
6058
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006059 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08006060 * Construct a Style-specific RemoteViews for the collapsed notification layout.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006061 * The default implementation has nothing additional to add.
Selim Cinek7d1009b2017-01-25 15:28:28 -08006062 *
6063 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006064 * @hide
6065 */
Selim Cinek7d1009b2017-01-25 15:28:28 -08006066 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006067 return null;
6068 }
6069
6070 /**
6071 * Construct a Style-specific RemoteViews for the final big notification layout.
6072 * @hide
6073 */
6074 public RemoteViews makeBigContentView() {
6075 return null;
6076 }
6077
6078 /**
6079 * Construct a Style-specific RemoteViews for the final HUN layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08006080 *
6081 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006082 * @hide
6083 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08006084 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006085 return null;
6086 }
6087
6088 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006089 * Apply any style-specific extras to this notification before shipping it out.
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006090 * @hide
6091 */
6092 public void addExtras(Bundle extras) {
6093 if (mSummaryTextSet) {
6094 extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
6095 }
6096 if (mBigContentTitle != null) {
6097 extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
6098 }
Chris Wren91ad5632013-06-05 15:05:57 -04006099 extras.putString(EXTRA_TEMPLATE, this.getClass().getName());
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006100 }
6101
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006102 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006103 * Reconstruct the internal state of this Style object from extras.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006104 * @hide
6105 */
Christoph Studer4600f9b2014-07-22 22:44:43 +02006106 protected void restoreFromExtras(Bundle extras) {
6107 if (extras.containsKey(EXTRA_SUMMARY_TEXT)) {
6108 mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT);
6109 mSummaryTextSet = true;
6110 }
6111 if (extras.containsKey(EXTRA_TITLE_BIG)) {
6112 mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG);
6113 }
6114 }
6115
6116
6117 /**
6118 * @hide
6119 */
6120 public Notification buildStyled(Notification wip) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006121 addExtras(wip.extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006122 return wip;
6123 }
6124
Daniel Sandler0ec46202015-06-24 01:27:05 -04006125 /**
6126 * @hide
6127 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006128 public void purgeResources() {}
6129
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006130 /**
6131 * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is
6132 * attached to.
6133 *
6134 * @return the fully constructed Notification.
6135 */
6136 public Notification build() {
6137 checkBuilder();
6138 return mBuilder.build();
6139 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02006140
6141 /**
6142 * @hide
6143 * @return true if the style positions the progress bar on the second line; false if the
6144 * style hides the progress bar
6145 */
6146 protected boolean hasProgress() {
6147 return true;
6148 }
Selim Cinek03d0d652015-11-13 13:18:09 -05006149
6150 /**
6151 * @hide
6152 * @return Whether we should put the summary be put into the notification header
6153 */
6154 public boolean hasSummaryInHeader() {
6155 return true;
6156 }
Selim Cinek593610c2016-02-16 18:42:57 -08006157
6158 /**
6159 * @hide
6160 * @return Whether custom content views are displayed inline in the style
6161 */
6162 public boolean displayCustomViewInline() {
6163 return false;
6164 }
Selim Cinekd0426622017-07-11 13:19:59 +02006165
6166 /**
6167 * Reduces the image sizes contained in this style.
6168 *
6169 * @hide
6170 */
6171 public void reduceImageSizes(Context context) {
6172 }
Selim Cinek90343862018-02-01 11:07:11 -08006173
6174 /**
6175 * Validate that this style was properly composed. This is called at build time.
6176 * @hide
6177 */
6178 public void validate(Context context) {
6179 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05006180
6181 /**
6182 * @hide
6183 */
6184 public abstract boolean areNotificationsVisiblyDifferent(Style other);
Selim Cinekc7f5a822018-03-20 19:32:06 -07006185
Selim Cinekaa9db1f2018-02-27 17:35:47 -08006186 /**
6187 * @return the the text that should be displayed in the statusBar when heads-upped.
6188 * If {@code null} is returned, the default implementation will be used.
6189 *
6190 * @hide
6191 */
6192 public CharSequence getHeadsUpStatusBarText() {
6193 return null;
6194 }
Joe Onorato46439ce2010-11-19 13:56:21 -08006195 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006196
6197 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006198 * Helper class for generating large-format notifications that include a large image attachment.
Joe Malin8d40d042012-11-05 11:36:40 -08006199 *
Robert Ly91c5ce32014-06-08 15:37:00 -07006200 * Here's how you'd set the <code>BigPictureStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006201 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07006202 * Notification notif = new Notification.Builder(mContext)
6203 * .setContentTitle(&quot;New photo from &quot; + sender.toString())
6204 * .setContentText(subject)
6205 * .setSmallIcon(R.drawable.new_post)
6206 * .setLargeIcon(aBitmap)
6207 * .setStyle(new Notification.BigPictureStyle()
6208 * .bigPicture(aBigBitmap))
6209 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006210 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006211 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006212 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006213 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006214 public static class BigPictureStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006215 private Bitmap mPicture;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006216 private Icon mBigLargeIcon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006217 private boolean mBigLargeIconSet = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006218
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006219 public BigPictureStyle() {
6220 }
6221
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006222 /**
6223 * @deprecated use {@code BigPictureStyle()}.
6224 */
6225 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006226 public BigPictureStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006227 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006228 }
6229
Chris Wrend6297db2012-05-03 16:20:13 -04006230 /**
6231 * Overrides ContentTitle in the big form of the template.
6232 * This defaults to the value passed to setContentTitle().
6233 */
6234 public BigPictureStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006235 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006236 return this;
6237 }
6238
6239 /**
6240 * Set the first line of text after the detail section in the big form of the template.
6241 */
6242 public BigPictureStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006243 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006244 return this;
6245 }
6246
Chris Wren0bd664d2012-08-01 13:56:56 -04006247 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05006248 * @hide
6249 */
6250 public Bitmap getBigPicture() {
6251 return mPicture;
6252 }
6253
6254 /**
Chris Wren0bd664d2012-08-01 13:56:56 -04006255 * Provide the bitmap to be used as the payload for the BigPicture notification.
6256 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006257 public BigPictureStyle bigPicture(Bitmap b) {
6258 mPicture = b;
6259 return this;
6260 }
6261
Chris Wren3745a3d2012-05-22 15:11:52 -04006262 /**
Chris Wren3745a3d2012-05-22 15:11:52 -04006263 * Override the large icon when the big notification is shown.
6264 */
6265 public BigPictureStyle bigLargeIcon(Bitmap b) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04006266 return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
6267 }
6268
6269 /**
6270 * Override the large icon when the big notification is shown.
6271 */
6272 public BigPictureStyle bigLargeIcon(Icon icon) {
Chris Wren3745a3d2012-05-22 15:11:52 -04006273 mBigLargeIconSet = true;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006274 mBigLargeIcon = icon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006275 return this;
6276 }
6277
Riley Andrews0394a0c2015-11-03 23:36:52 -08006278 /** @hide */
6279 public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10);
6280
Daniel Sandler0ec46202015-06-24 01:27:05 -04006281 /**
6282 * @hide
6283 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006284 @Override
6285 public void purgeResources() {
6286 super.purgeResources();
Riley Andrews8cee7c12015-11-01 23:36:04 -08006287 if (mPicture != null &&
6288 mPicture.isMutable() &&
Riley Andrews0394a0c2015-11-03 23:36:52 -08006289 mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) {
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006290 mPicture = mPicture.createAshmemBitmap();
6291 }
6292 if (mBigLargeIcon != null) {
6293 mBigLargeIcon.convertToAshmem();
6294 }
6295 }
Christoph Studer5c510ee2014-12-15 16:32:27 +01006296
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006297 /**
6298 * @hide
6299 */
Selim Cinekd0426622017-07-11 13:19:59 +02006300 @Override
6301 public void reduceImageSizes(Context context) {
6302 super.reduceImageSizes(context);
6303 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07006304 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02006305 if (mPicture != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006306 int maxPictureWidth = resources.getDimensionPixelSize(isLowRam
6307 ? R.dimen.notification_big_picture_max_height_low_ram
6308 : R.dimen.notification_big_picture_max_height);
6309 int maxPictureHeight = resources.getDimensionPixelSize(isLowRam
6310 ? R.dimen.notification_big_picture_max_width_low_ram
6311 : R.dimen.notification_big_picture_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02006312 mPicture = Icon.scaleDownIfNecessary(mPicture, maxPictureWidth, maxPictureHeight);
6313 }
6314 if (mBigLargeIcon != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006315 int rightIconSize = resources.getDimensionPixelSize(isLowRam
6316 ? R.dimen.notification_right_icon_size_low_ram
6317 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02006318 mBigLargeIcon.scaleDownIfNecessary(rightIconSize, rightIconSize);
6319 }
6320 }
6321
6322 /**
6323 * @hide
6324 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006325 public RemoteViews makeBigContentView() {
6326 // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet
Christoph Studer5c510ee2014-12-15 16:32:27 +01006327 // This covers the following cases:
6328 // 1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006329 // mN.mLargeIcon
6330 // 2. !mBigLargeIconSet -> mN.mLargeIcon applies
Dan Sandlerd63f9322015-05-06 15:18:49 -04006331 Icon oldLargeIcon = null;
Selim Cineke99acb22016-08-04 12:55:48 -07006332 Bitmap largeIconLegacy = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006333 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006334 oldLargeIcon = mBuilder.mN.mLargeIcon;
6335 mBuilder.mN.mLargeIcon = mBigLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006336 // The legacy largeIcon might not allow us to clear the image, as it's taken in
6337 // replacement if the other one is null. Because we're restoring these legacy icons
6338 // for old listeners, this is in general non-null.
6339 largeIconLegacy = mBuilder.mN.largeIcon;
6340 mBuilder.mN.largeIcon = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006341 }
6342
Selim Cinek384804b2018-04-18 14:31:07 +08006343 RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource(),
6344 null /* result */);
Selim Cinek03d0d652015-11-13 13:18:09 -05006345 if (mSummaryTextSet) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006346 contentView.setTextViewText(R.id.text, mBuilder.processTextSpans(
6347 mBuilder.processLegacyText(mSummaryText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006348 mBuilder.setTextViewColorSecondary(contentView, R.id.text);
Selim Cinekc848c3a2016-01-13 15:27:30 -08006349 contentView.setViewVisibility(R.id.text, View.VISIBLE);
Selim Cinek03d0d652015-11-13 13:18:09 -05006350 }
Selim Cinek279fa862016-06-14 10:57:25 -07006351 mBuilder.setContentMinHeight(contentView, mBuilder.mN.hasLargeIcon());
Selim Cinek53e64a42015-11-16 10:40:56 -08006352
Christoph Studer5c510ee2014-12-15 16:32:27 +01006353 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006354 mBuilder.mN.mLargeIcon = oldLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006355 mBuilder.mN.largeIcon = largeIconLegacy;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006356 }
6357
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006358 contentView.setImageViewBitmap(R.id.big_picture, mPicture);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006359 return contentView;
6360 }
6361
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006362 /**
6363 * @hide
6364 */
6365 public void addExtras(Bundle extras) {
6366 super.addExtras(extras);
6367
6368 if (mBigLargeIconSet) {
6369 extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
6370 }
6371 extras.putParcelable(EXTRA_PICTURE, mPicture);
6372 }
6373
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006374 /**
6375 * @hide
6376 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006377 @Override
Christoph Studer4600f9b2014-07-22 22:44:43 +02006378 protected void restoreFromExtras(Bundle extras) {
6379 super.restoreFromExtras(extras);
6380
6381 if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) {
Christoph Studer5c510ee2014-12-15 16:32:27 +01006382 mBigLargeIconSet = true;
Christoph Studer4600f9b2014-07-22 22:44:43 +02006383 mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG);
Chris Wren3745a3d2012-05-22 15:11:52 -04006384 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02006385 mPicture = extras.getParcelable(EXTRA_PICTURE);
6386 }
Selim Cinek03d0d652015-11-13 13:18:09 -05006387
6388 /**
6389 * @hide
6390 */
6391 @Override
6392 public boolean hasSummaryInHeader() {
6393 return false;
6394 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05006395
6396 /**
6397 * @hide
Dan Sandler7d67bd42018-05-15 14:06:38 -04006398 * Note that we aren't actually comparing the contents of the bitmaps here, so this
6399 * is only doing a cursory inspection. Bitmaps of equal size will appear the same.
Julia Reynolds7217dc92018-03-07 12:12:09 -05006400 */
6401 @Override
6402 public boolean areNotificationsVisiblyDifferent(Style other) {
6403 if (other == null || getClass() != other.getClass()) {
6404 return true;
6405 }
6406 BigPictureStyle otherS = (BigPictureStyle) other;
Dan Sandler7d67bd42018-05-15 14:06:38 -04006407 return areBitmapsObviouslyDifferent(getBigPicture(), otherS.getBigPicture());
6408 }
6409
6410 private static boolean areBitmapsObviouslyDifferent(Bitmap a, Bitmap b) {
6411 if (a == b) {
6412 return false;
6413 }
6414 if (a == null || b == null) {
6415 return true;
6416 }
6417 return a.getWidth() != b.getWidth()
6418 || a.getHeight() != b.getHeight()
6419 || a.getConfig() != b.getConfig()
6420 || a.getGenerationId() != b.getGenerationId();
Julia Reynolds7217dc92018-03-07 12:12:09 -05006421 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006422 }
6423
6424 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006425 * Helper class for generating large-format notifications that include a lot of text.
Joe Malin8d40d042012-11-05 11:36:40 -08006426 *
Robert Ly91c5ce32014-06-08 15:37:00 -07006427 * Here's how you'd set the <code>BigTextStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006428 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07006429 * Notification notif = new Notification.Builder(mContext)
6430 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
6431 * .setContentText(subject)
6432 * .setSmallIcon(R.drawable.new_mail)
6433 * .setLargeIcon(aBitmap)
6434 * .setStyle(new Notification.BigTextStyle()
6435 * .bigText(aVeryLongString))
6436 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006437 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006438 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006439 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006440 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006441 public static class BigTextStyle extends Style {
Jorim Jaggi457a10d2014-09-08 16:18:23 +02006442
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006443 private CharSequence mBigText;
6444
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006445 public BigTextStyle() {
6446 }
6447
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006448 /**
6449 * @deprecated use {@code BigTextStyle()}.
6450 */
6451 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006452 public BigTextStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006453 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006454 }
6455
Chris Wrend6297db2012-05-03 16:20:13 -04006456 /**
6457 * Overrides ContentTitle in the big form of the template.
6458 * This defaults to the value passed to setContentTitle().
6459 */
6460 public BigTextStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006461 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006462 return this;
6463 }
6464
6465 /**
6466 * Set the first line of text after the detail section in the big form of the template.
6467 */
6468 public BigTextStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006469 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006470 return this;
6471 }
6472
Chris Wren0bd664d2012-08-01 13:56:56 -04006473 /**
6474 * Provide the longer text to be displayed in the big form of the
6475 * template in place of the content text.
6476 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006477 public BigTextStyle bigText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006478 mBigText = safeCharSequence(cs);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006479 return this;
6480 }
6481
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006482 /**
6483 * @hide
6484 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05006485 public CharSequence getBigText() {
6486 return mBigText;
6487 }
6488
6489 /**
6490 * @hide
6491 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006492 public void addExtras(Bundle extras) {
6493 super.addExtras(extras);
6494
Christoph Studer4600f9b2014-07-22 22:44:43 +02006495 extras.putCharSequence(EXTRA_BIG_TEXT, mBigText);
6496 }
6497
6498 /**
6499 * @hide
6500 */
6501 @Override
6502 protected void restoreFromExtras(Bundle extras) {
6503 super.restoreFromExtras(extras);
6504
6505 mBigText = extras.getCharSequence(EXTRA_BIG_TEXT);
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006506 }
6507
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006508 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08006509 * @param increasedHeight true if this layout be created with an increased height.
6510 *
6511 * @hide
6512 */
6513 @Override
6514 public RemoteViews makeContentView(boolean increasedHeight) {
6515 if (increasedHeight) {
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006516 mBuilder.mOriginalActions = mBuilder.mActions;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006517 mBuilder.mActions = new ArrayList<>();
6518 RemoteViews remoteViews = makeBigContentView();
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006519 mBuilder.mActions = mBuilder.mOriginalActions;
6520 mBuilder.mOriginalActions = null;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006521 return remoteViews;
6522 }
6523 return super.makeContentView(increasedHeight);
6524 }
6525
6526 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006527 * @hide
6528 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08006529 @Override
6530 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
6531 if (increasedHeight && mBuilder.mActions.size() > 0) {
6532 return makeBigContentView();
6533 }
6534 return super.makeHeadsUpContentView(increasedHeight);
6535 }
6536
6537 /**
6538 * @hide
6539 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006540 public RemoteViews makeBigContentView() {
Christoph Studer4600f9b2014-07-22 22:44:43 +02006541
6542 // Nasty
Selim Cinek75998782016-04-26 10:39:17 -07006543 CharSequence text = mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006544 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Daniel Sandler916ad912012-06-13 12:17:07 -04006545
Selim Cinek384804b2018-04-18 14:31:07 +08006546 TemplateBindResult result = new TemplateBindResult();
6547 RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource(), result);
Selim Cinek1c72fa02018-04-23 18:00:54 +08006548 contentView.setInt(R.id.big_text, "setImageEndMargin", result.getIconMarginEnd());
Joe Malin8d40d042012-11-05 11:36:40 -08006549
Selim Cinek75998782016-04-26 10:39:17 -07006550 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, text);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006551
Selim Cinek3a2c4b92015-12-17 17:01:17 -08006552 CharSequence bigTextText = mBuilder.processLegacyText(mBigText);
Selim Cinek75998782016-04-26 10:39:17 -07006553 if (TextUtils.isEmpty(bigTextText)) {
6554 // In case the bigtext is null / empty fall back to the normal text to avoid a weird
6555 // experience
6556 bigTextText = mBuilder.processLegacyText(text);
6557 }
Adrian Roosb1f427c2016-05-26 12:27:15 -07006558 applyBigTextContentView(mBuilder, contentView, bigTextText);
Selim Cinek4fb12d32015-11-19 18:10:48 -08006559
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006560 return contentView;
6561 }
6562
Julia Reynolds7217dc92018-03-07 12:12:09 -05006563 /**
6564 * @hide
Dan Sandler7d67bd42018-05-15 14:06:38 -04006565 * Spans are ignored when comparing text for visual difference.
Julia Reynolds7217dc92018-03-07 12:12:09 -05006566 */
6567 @Override
6568 public boolean areNotificationsVisiblyDifferent(Style other) {
6569 if (other == null || getClass() != other.getClass()) {
6570 return true;
6571 }
6572 BigTextStyle newS = (BigTextStyle) other;
Dan Sandler7d67bd42018-05-15 14:06:38 -04006573 return !Objects.equals(String.valueOf(getBigText()), String.valueOf(newS.getBigText()));
Julia Reynolds7217dc92018-03-07 12:12:09 -05006574 }
6575
Adrian Roosb1f427c2016-05-26 12:27:15 -07006576 static void applyBigTextContentView(Builder builder,
6577 RemoteViews contentView, CharSequence bigTextText) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006578 contentView.setTextViewText(R.id.big_text, builder.processTextSpans(bigTextText));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006579 builder.setTextViewColorSecondary(contentView, R.id.big_text);
Adrian Roosb1f427c2016-05-26 12:27:15 -07006580 contentView.setViewVisibility(R.id.big_text,
6581 TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE);
Selim Cinek279fa862016-06-14 10:57:25 -07006582 contentView.setBoolean(R.id.big_text, "setHasImage", builder.mN.hasLargeIcon());
Adrian Roosb1f427c2016-05-26 12:27:15 -07006583 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006584 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04006585
6586 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006587 * Helper class for generating large-format notifications that include multiple back-and-forth
6588 * messages of varying types between any number of people.
6589 *
Selim Cinekce8794f2018-05-23 16:46:05 -07006590 * <p>
Alex Hillsfc737de2016-03-23 17:33:02 -04006591 * If the platform does not provide large-format notifications, this method has no effect. The
6592 * user will always see the normal notification view.
Selim Cinekce8794f2018-05-23 16:46:05 -07006593 *
6594 * <p>
6595 * If the app is targeting Android P and above, it is required to use the {@link Person}
6596 * class in order to get an optimal rendering of the notification and its avatars. For
6597 * conversations involving multiple people, the app should also make sure that it marks the
6598 * conversation as a group with {@link #setGroupConversation(boolean)}.
6599 *
6600 * <p>
6601 * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior.
6602 * Here's an example of how this may be used:
Alex Hillsfc737de2016-03-23 17:33:02 -04006603 * <pre class="prettyprint">
6604 *
Selim Cinekce8794f2018-05-23 16:46:05 -07006605 * Person user = new Person.Builder().setIcon(userIcon).setName(userName).build();
6606 * MessagingStyle style = new MessagingStyle(user)
6607 * .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getPerson())
6608 * .addMessage(messages[2].getText(), messages[2].getTime(), messages[2].getPerson())
6609 * .setGroupConversation(hasMultiplePeople());
6610 *
Alex Hillsfc737de2016-03-23 17:33:02 -04006611 * Notification noti = new Notification.Builder()
Selim Cinekce8794f2018-05-23 16:46:05 -07006612 * .setContentTitle(&quot;2 new messages with &quot; + sender.toString())
Alex Hillsfc737de2016-03-23 17:33:02 -04006613 * .setContentText(subject)
6614 * .setSmallIcon(R.drawable.new_message)
6615 * .setLargeIcon(aBitmap)
Selim Cinekce8794f2018-05-23 16:46:05 -07006616 * .setStyle(style)
Alex Hillsfc737de2016-03-23 17:33:02 -04006617 * .build();
6618 * </pre>
6619 */
6620 public static class MessagingStyle extends Style {
6621
6622 /**
6623 * The maximum number of messages that will be retained in the Notification itself (the
6624 * number displayed is up to the platform).
6625 */
6626 public static final int MAXIMUM_RETAINED_MESSAGES = 25;
6627
Selim Cinekcb8b9852017-12-15 18:01:52 -08006628 @NonNull Person mUser;
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006629 @Nullable CharSequence mConversationTitle;
Alex Hillsd9b04d92016-04-11 16:38:16 -04006630 List<Message> mMessages = new ArrayList<>();
Adrian Roos437cd562017-01-18 15:47:03 -08006631 List<Message> mHistoricMessages = new ArrayList<>();
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006632 boolean mIsGroupConversation;
Alex Hillsfc737de2016-03-23 17:33:02 -04006633
6634 MessagingStyle() {
6635 }
6636
6637 /**
Alex Hillsfd590442016-10-07 09:52:44 -04006638 * @param userDisplayName Required - the name to be displayed for any replies sent by the
6639 * user before the posting app reposts the notification with those messages after they've
6640 * been actually sent and in previous messages sent by the user added in
Alex Hillsfc737de2016-03-23 17:33:02 -04006641 * {@link #addMessage(Notification.MessagingStyle.Message)}
Selim Cinekcb8b9852017-12-15 18:01:52 -08006642 *
6643 * @deprecated use {@code MessagingStyle(Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006644 */
Alex Hillsfd590442016-10-07 09:52:44 -04006645 public MessagingStyle(@NonNull CharSequence userDisplayName) {
Selim Cinek9acd6732018-03-23 16:39:02 -07006646 this(new Person.Builder().setName(userDisplayName).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006647 }
6648
6649 /**
6650 * @param user Required - The person displayed for any messages that are sent by the
6651 * user. Any messages added with {@link #addMessage(Notification.MessagingStyle.Message)}
6652 * who don't have a Person associated with it will be displayed as if they were sent
Selim Cinek90343862018-02-01 11:07:11 -08006653 * by this user. The user also needs to have a valid name associated with it, which will
6654 * be enforced starting in Android P.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006655 */
6656 public MessagingStyle(@NonNull Person user) {
6657 mUser = user;
Selim Cinek90343862018-02-01 11:07:11 -08006658 }
6659
6660 /**
6661 * Validate that this style was properly composed. This is called at build time.
6662 * @hide
6663 */
6664 @Override
6665 public void validate(Context context) {
6666 super.validate(context);
6667 if (context.getApplicationInfo().targetSdkVersion
6668 >= Build.VERSION_CODES.P && (mUser == null || mUser.getName() == null)) {
6669 throw new RuntimeException("User must be valid and have a name.");
Selim Cinekcb8b9852017-12-15 18:01:52 -08006670 }
6671 }
6672
6673 /**
Selim Cinekaa9db1f2018-02-27 17:35:47 -08006674 * @return the the text that should be displayed in the statusBar when heads upped.
6675 * If {@code null} is returned, the default implementation will be used.
6676 *
6677 * @hide
6678 */
6679 @Override
6680 public CharSequence getHeadsUpStatusBarText() {
6681 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
6682 ? super.mBigContentTitle
6683 : mConversationTitle;
6684 if (!TextUtils.isEmpty(conversationTitle) && !hasOnlyWhiteSpaceSenders()) {
6685 return conversationTitle;
6686 }
6687 return null;
6688 }
6689
6690 /**
Selim Cinekcb8b9852017-12-15 18:01:52 -08006691 * @return the user to be displayed for any replies sent by the user
6692 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006693 @NonNull
Selim Cinekcb8b9852017-12-15 18:01:52 -08006694 public Person getUser() {
6695 return mUser;
Alex Hillsfc737de2016-03-23 17:33:02 -04006696 }
6697
6698 /**
6699 * Returns the name to be displayed for any replies sent by the user
Selim Cinekcb8b9852017-12-15 18:01:52 -08006700 *
6701 * @deprecated use {@link #getUser()} instead
Alex Hillsfc737de2016-03-23 17:33:02 -04006702 */
6703 public CharSequence getUserDisplayName() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006704 return mUser.getName();
Alex Hillsfc737de2016-03-23 17:33:02 -04006705 }
6706
6707 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006708 * Sets the title to be displayed on this conversation. May be set to {@code null}.
6709 *
Kodlee Yin14656422017-12-22 17:00:46 -08006710 * <p>This API's behavior was changed in SDK version {@link Build.VERSION_CODES#P}. If your
6711 * application's target version is less than {@link Build.VERSION_CODES#P}, setting a
6712 * conversation title to a non-null value will make {@link #isGroupConversation()} return
6713 * {@code true} and passing {@code null} will make it return {@code false}. In
6714 * {@link Build.VERSION_CODES#P} and beyond, use {@link #setGroupConversation(boolean)}
6715 * to set group conversation status.
6716 *
6717 * @param conversationTitle Title displayed for this conversation
6718 * @return this object for method chaining
Alex Hillsfc737de2016-03-23 17:33:02 -04006719 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006720 public MessagingStyle setConversationTitle(@Nullable CharSequence conversationTitle) {
Alex Hillsfc737de2016-03-23 17:33:02 -04006721 mConversationTitle = conversationTitle;
6722 return this;
6723 }
6724
6725 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006726 * Return the title to be displayed on this conversation. May return {@code null}.
Alex Hillsfc737de2016-03-23 17:33:02 -04006727 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006728 @Nullable
Alex Hillsfc737de2016-03-23 17:33:02 -04006729 public CharSequence getConversationTitle() {
6730 return mConversationTitle;
6731 }
6732
6733 /**
6734 * Adds a message for display by this notification. Convenience call for a simple
6735 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6736 * @param text A {@link CharSequence} to be displayed as the message content
6737 * @param timestamp Time at which the message arrived
6738 * @param sender A {@link CharSequence} to be used for displaying the name of the
6739 * sender. Should be <code>null</code> for messages by the current user, in which case
6740 * the platform will insert {@link #getUserDisplayName()}.
6741 * Should be unique amongst all individuals in the conversation, and should be
6742 * consistent during re-posts of the notification.
6743 *
6744 * @see Message#Message(CharSequence, long, CharSequence)
6745 *
6746 * @return this object for method chaining
Selim Cinekcb8b9852017-12-15 18:01:52 -08006747 *
6748 * @deprecated use {@link #addMessage(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006749 */
6750 public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006751 return addMessage(text, timestamp,
Selim Cinek9acd6732018-03-23 16:39:02 -07006752 sender == null ? null : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006753 }
6754
6755 /**
6756 * Adds a message for display by this notification. Convenience call for a simple
6757 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6758 * @param text A {@link CharSequence} to be displayed as the message content
6759 * @param timestamp Time at which the message arrived
6760 * @param sender The {@link Person} who sent the message.
6761 * Should be <code>null</code> for messages by the current user, in which case
6762 * the platform will insert the user set in {@code MessagingStyle(Person)}.
6763 *
6764 * @see Message#Message(CharSequence, long, CharSequence)
6765 *
6766 * @return this object for method chaining
6767 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006768 public MessagingStyle addMessage(@NonNull CharSequence text, long timestamp,
6769 @Nullable Person sender) {
Adrian Roos437cd562017-01-18 15:47:03 -08006770 return addMessage(new Message(text, timestamp, sender));
Alex Hillsfc737de2016-03-23 17:33:02 -04006771 }
6772
6773 /**
6774 * Adds a {@link Message} for display in this notification.
Adrian Roos437cd562017-01-18 15:47:03 -08006775 *
6776 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6777 * the newest last.
6778 *
Alex Hillsfc737de2016-03-23 17:33:02 -04006779 * @param message The {@link Message} to be displayed
6780 * @return this object for method chaining
6781 */
6782 public MessagingStyle addMessage(Message message) {
6783 mMessages.add(message);
6784 if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6785 mMessages.remove(0);
6786 }
6787 return this;
6788 }
6789
6790 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006791 * Adds a {@link Message} for historic context in this notification.
6792 *
6793 * <p>Messages should be added as historic if they are not the main subject of the
6794 * notification but may give context to a conversation. The system may choose to present
6795 * them only when relevant, e.g. when replying to a message through a {@link RemoteInput}.
6796 *
6797 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6798 * the newest last.
6799 *
6800 * @param message The historic {@link Message} to be added
6801 * @return this object for method chaining
6802 */
6803 public MessagingStyle addHistoricMessage(Message message) {
6804 mHistoricMessages.add(message);
6805 if (mHistoricMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6806 mHistoricMessages.remove(0);
6807 }
6808 return this;
6809 }
6810
6811 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006812 * Gets the list of {@code Message} objects that represent the notification
6813 */
6814 public List<Message> getMessages() {
6815 return mMessages;
6816 }
6817
6818 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006819 * Gets the list of historic {@code Message}s in the notification.
6820 */
6821 public List<Message> getHistoricMessages() {
6822 return mHistoricMessages;
6823 }
6824
6825 /**
Selim Cinekce8794f2018-05-23 16:46:05 -07006826 * Sets whether this conversation notification represents a group. If the app is targeting
6827 * Android P, this is required if the app wants to display the largeIcon set with
6828 * {@link Notification.Builder#setLargeIcon(Bitmap)}, otherwise it will be hidden.
Kodlee Yin14656422017-12-22 17:00:46 -08006829 *
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006830 * @param isGroupConversation {@code true} if the conversation represents a group,
6831 * {@code false} otherwise.
6832 * @return this object for method chaining
6833 */
6834 public MessagingStyle setGroupConversation(boolean isGroupConversation) {
6835 mIsGroupConversation = isGroupConversation;
6836 return this;
6837 }
6838
6839 /**
Kodlee Yin14656422017-12-22 17:00:46 -08006840 * Returns {@code true} if this notification represents a group conversation, otherwise
6841 * {@code false}.
6842 *
6843 * <p> If the application that generated this {@link MessagingStyle} targets an SDK version
6844 * less than {@link Build.VERSION_CODES#P}, this method becomes dependent on whether or
6845 * not the conversation title is set; returning {@code true} if the conversation title is
6846 * a non-null value, or {@code false} otherwise. From {@link Build.VERSION_CODES#P} forward,
6847 * this method returns what's set by {@link #setGroupConversation(boolean)} allowing for
6848 * named, non-group conversations.
6849 *
6850 * @see #setConversationTitle(CharSequence)
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006851 */
6852 public boolean isGroupConversation() {
Kodlee Yin14656422017-12-22 17:00:46 -08006853 // When target SDK version is < P, a non-null conversation title dictates if this is
6854 // as group conversation.
6855 if (mBuilder != null
6856 && mBuilder.mContext.getApplicationInfo().targetSdkVersion
6857 < Build.VERSION_CODES.P) {
6858 return mConversationTitle != null;
6859 }
6860
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006861 return mIsGroupConversation;
6862 }
6863
6864 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006865 * @hide
6866 */
6867 @Override
6868 public void addExtras(Bundle extras) {
6869 super.addExtras(extras);
Selim Cinekcb8b9852017-12-15 18:01:52 -08006870 if (mUser != null) {
6871 // For legacy usages
6872 extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUser.getName());
6873 extras.putParcelable(EXTRA_MESSAGING_PERSON, mUser);
Alex Hillsfc737de2016-03-23 17:33:02 -04006874 }
6875 if (mConversationTitle != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04006876 extras.putCharSequence(EXTRA_CONVERSATION_TITLE, mConversationTitle);
Alex Hillsfc737de2016-03-23 17:33:02 -04006877 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04006878 if (!mMessages.isEmpty()) { extras.putParcelableArray(EXTRA_MESSAGES,
6879 Message.getBundleArrayForMessages(mMessages));
Alex Hillsfc737de2016-03-23 17:33:02 -04006880 }
Adrian Roos437cd562017-01-18 15:47:03 -08006881 if (!mHistoricMessages.isEmpty()) { extras.putParcelableArray(EXTRA_HISTORIC_MESSAGES,
6882 Message.getBundleArrayForMessages(mHistoricMessages));
6883 }
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006884
6885 fixTitleAndTextExtras(extras);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006886 extras.putBoolean(EXTRA_IS_GROUP_CONVERSATION, mIsGroupConversation);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006887 }
6888
6889 private void fixTitleAndTextExtras(Bundle extras) {
6890 Message m = findLatestIncomingMessage();
6891 CharSequence text = (m == null) ? null : m.mText;
6892 CharSequence sender = m == null ? null
Selim Cinekcb8b9852017-12-15 18:01:52 -08006893 : m.mSender == null || TextUtils.isEmpty(m.mSender.getName())
6894 ? mUser.getName() : m.mSender.getName();
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006895 CharSequence title;
6896 if (!TextUtils.isEmpty(mConversationTitle)) {
6897 if (!TextUtils.isEmpty(sender)) {
6898 BidiFormatter bidi = BidiFormatter.getInstance();
6899 title = mBuilder.mContext.getString(
6900 com.android.internal.R.string.notification_messaging_title_template,
Selim Cinekcb8b9852017-12-15 18:01:52 -08006901 bidi.unicodeWrap(mConversationTitle), bidi.unicodeWrap(sender));
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006902 } else {
6903 title = mConversationTitle;
6904 }
6905 } else {
6906 title = sender;
6907 }
6908
6909 if (title != null) {
6910 extras.putCharSequence(EXTRA_TITLE, title);
6911 }
6912 if (text != null) {
6913 extras.putCharSequence(EXTRA_TEXT, text);
6914 }
Alex Hillsfc737de2016-03-23 17:33:02 -04006915 }
6916
6917 /**
6918 * @hide
6919 */
6920 @Override
6921 protected void restoreFromExtras(Bundle extras) {
6922 super.restoreFromExtras(extras);
6923
Selim Cinekcb8b9852017-12-15 18:01:52 -08006924 mUser = extras.getParcelable(EXTRA_MESSAGING_PERSON);
6925 if (mUser == null) {
6926 CharSequence displayName = extras.getCharSequence(EXTRA_SELF_DISPLAY_NAME);
Selim Cinek9acd6732018-03-23 16:39:02 -07006927 mUser = new Person.Builder().setName(displayName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08006928 }
Adrian Roos96b7e202016-05-17 13:50:38 -07006929 mConversationTitle = extras.getCharSequence(EXTRA_CONVERSATION_TITLE);
Adrian Roos437cd562017-01-18 15:47:03 -08006930 Parcelable[] messages = extras.getParcelableArray(EXTRA_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006931 mMessages = Message.getMessagesFromBundleArray(messages);
Adrian Roos437cd562017-01-18 15:47:03 -08006932 Parcelable[] histMessages = extras.getParcelableArray(EXTRA_HISTORIC_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006933 mHistoricMessages = Message.getMessagesFromBundleArray(histMessages);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006934 mIsGroupConversation = extras.getBoolean(EXTRA_IS_GROUP_CONVERSATION);
Alex Hillsfc737de2016-03-23 17:33:02 -04006935 }
6936
6937 /**
6938 * @hide
6939 */
Adrian Roosc1a80b02016-04-05 14:54:55 -07006940 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08006941 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cineke62255c2017-09-28 18:23:23 -07006942 mBuilder.mOriginalActions = mBuilder.mActions;
6943 mBuilder.mActions = new ArrayList<>();
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006944 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
Selim Cinek384804b2018-04-18 14:31:07 +08006945 false /* hideLargeIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07006946 mBuilder.mActions = mBuilder.mOriginalActions;
6947 mBuilder.mOriginalActions = null;
6948 return remoteViews;
Adrian Roosc1a80b02016-04-05 14:54:55 -07006949 }
6950
Julia Reynolds7217dc92018-03-07 12:12:09 -05006951 /**
6952 * @hide
Dan Sandler7d67bd42018-05-15 14:06:38 -04006953 * Spans are ignored when comparing text for visual difference.
Julia Reynolds7217dc92018-03-07 12:12:09 -05006954 */
6955 @Override
6956 public boolean areNotificationsVisiblyDifferent(Style other) {
6957 if (other == null || getClass() != other.getClass()) {
6958 return true;
6959 }
6960 MessagingStyle newS = (MessagingStyle) other;
6961 List<MessagingStyle.Message> oldMs = getMessages();
6962 List<MessagingStyle.Message> newMs = newS.getMessages();
6963
Dan Sandler7d67bd42018-05-15 14:06:38 -04006964 if (oldMs == null || newMs == null) {
Julia Reynolds7217dc92018-03-07 12:12:09 -05006965 newMs = new ArrayList<>();
6966 }
6967
6968 int n = oldMs.size();
6969 if (n != newMs.size()) {
6970 return true;
6971 }
6972 for (int i = 0; i < n; i++) {
6973 MessagingStyle.Message oldM = oldMs.get(i);
6974 MessagingStyle.Message newM = newMs.get(i);
Dan Sandler7d67bd42018-05-15 14:06:38 -04006975 if (!Objects.equals(
6976 String.valueOf(oldM.getText()),
6977 String.valueOf(newM.getText()))) {
Julia Reynolds7217dc92018-03-07 12:12:09 -05006978 return true;
6979 }
6980 if (!Objects.equals(oldM.getDataUri(), newM.getDataUri())) {
6981 return true;
6982 }
Dan Sandler7d67bd42018-05-15 14:06:38 -04006983 String oldSender = String.valueOf(oldM.getSenderPerson() == null
6984 ? oldM.getSender()
6985 : oldM.getSenderPerson().getName());
6986 String newSender = String.valueOf(newM.getSenderPerson() == null
6987 ? newM.getSender()
6988 : newM.getSenderPerson().getName());
Julia Reynolds7217dc92018-03-07 12:12:09 -05006989 if (!Objects.equals(oldSender, newSender)) {
6990 return true;
6991 }
6992
6993 String oldKey = oldM.getSenderPerson() == null
6994 ? null : oldM.getSenderPerson().getKey();
6995 String newKey = newM.getSenderPerson() == null
6996 ? null : newM.getSenderPerson().getKey();
6997 if (!Objects.equals(oldKey, newKey)) {
6998 return true;
6999 }
7000 // Other fields (like timestamp) intentionally excluded
7001 }
7002 return false;
7003 }
7004
Adrian Roosc1a80b02016-04-05 14:54:55 -07007005 private Message findLatestIncomingMessage() {
Selim Cinek88188f22017-09-19 16:46:56 -07007006 return findLatestIncomingMessage(mMessages);
7007 }
7008
7009 /**
7010 * @hide
7011 */
7012 @Nullable
7013 public static Message findLatestIncomingMessage(
7014 List<Message> messages) {
7015 for (int i = messages.size() - 1; i >= 0; i--) {
7016 Message m = messages.get(i);
Adrian Roosc1a80b02016-04-05 14:54:55 -07007017 // Incoming messages have a non-empty sender.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007018 if (m.mSender != null && !TextUtils.isEmpty(m.mSender.getName())) {
Adrian Roosc1a80b02016-04-05 14:54:55 -07007019 return m;
7020 }
7021 }
Selim Cinek88188f22017-09-19 16:46:56 -07007022 if (!messages.isEmpty()) {
Adrian Roos33fbd2c2016-05-27 15:35:28 -07007023 // No incoming messages, fall back to outgoing message
Selim Cinek88188f22017-09-19 16:46:56 -07007024 return messages.get(messages.size() - 1);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07007025 }
Adrian Roosc1a80b02016-04-05 14:54:55 -07007026 return null;
7027 }
7028
7029 /**
7030 * @hide
7031 */
7032 @Override
7033 public RemoteViews makeBigContentView() {
Selim Cinek384804b2018-04-18 14:31:07 +08007034 return makeMessagingView(false /* displayImagesAtEnd */, true /* hideLargeIcon */);
Selim Cinekafeed292017-12-12 17:32:44 -08007035 }
7036
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007037 /**
7038 * Create a messaging layout.
7039 *
7040 * @param displayImagesAtEnd should images be displayed at the end of the content instead
7041 * of inline.
Selim Cinek384804b2018-04-18 14:31:07 +08007042 * @param hideRightIcons Should the reply affordance be shown at the end of the notification
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007043 * @return the created remoteView.
7044 */
Selim Cinekafeed292017-12-12 17:32:44 -08007045 @NonNull
Selim Cinek384804b2018-04-18 14:31:07 +08007046 private RemoteViews makeMessagingView(boolean displayImagesAtEnd, boolean hideRightIcons) {
Selim Cinek88188f22017-09-19 16:46:56 -07007047 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
Adrian Roosc1a80b02016-04-05 14:54:55 -07007048 ? super.mBigContentTitle
7049 : mConversationTitle;
Selim Cinekce8794f2018-05-23 16:46:05 -07007050 boolean atLeastP = mBuilder.mContext.getApplicationInfo().targetSdkVersion
7051 >= Build.VERSION_CODES.P;
7052 boolean isOneToOne;
Selim Cinek2dd3e722018-01-19 11:06:06 -08007053 CharSequence nameReplacement = null;
Selim Cinekce8794f2018-05-23 16:46:05 -07007054 Icon avatarReplacement = null;
7055 if (!atLeastP) {
7056 isOneToOne = TextUtils.isEmpty(conversationTitle);
7057 avatarReplacement = mBuilder.mN.mLargeIcon;
7058 if (hasOnlyWhiteSpaceSenders()) {
7059 isOneToOne = true;
7060 nameReplacement = conversationTitle;
7061 conversationTitle = null;
7062 }
7063 } else {
7064 isOneToOne = !isGroupConversation();
Adrian Roosb1f427c2016-05-26 12:27:15 -07007065 }
Selim Cinek384804b2018-04-18 14:31:07 +08007066 TemplateBindResult bindResult = new TemplateBindResult();
Adrian Roos48d746a2016-04-12 14:57:28 -07007067 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
Adrian Roosc1a80b02016-04-05 14:54:55 -07007068 mBuilder.getMessagingLayoutResource(),
Selim Cinek88188f22017-09-19 16:46:56 -07007069 mBuilder.mParams.reset().hasProgress(false).title(conversationTitle).text(null)
Selim Cinek384804b2018-04-18 14:31:07 +08007070 .hideLargeIcon(hideRightIcons || isOneToOne)
7071 .hideReplyIcon(hideRightIcons)
7072 .headerTextSecondary(conversationTitle),
7073 bindResult);
Selim Cinek88188f22017-09-19 16:46:56 -07007074 addExtras(mBuilder.mN.extras);
Selim Cinekafeed292017-12-12 17:32:44 -08007075 // also update the end margin if there is an image
Selim Cinek1c72fa02018-04-23 18:00:54 +08007076 contentView.setViewLayoutMarginEnd(R.id.notification_messaging,
7077 bindResult.getIconMarginEnd());
Selim Cinek88188f22017-09-19 16:46:56 -07007078 contentView.setInt(R.id.status_bar_latest_event_content, "setLayoutColor",
Kenny Guy14d035c2018-05-02 19:10:36 +01007079 mBuilder.isColorized() ? mBuilder.getPrimaryTextColor()
7080 : mBuilder.resolveContrastColor());
7081 contentView.setInt(R.id.status_bar_latest_event_content, "setSenderTextColor",
7082 mBuilder.getPrimaryTextColor());
7083 contentView.setInt(R.id.status_bar_latest_event_content, "setMessageTextColor",
7084 mBuilder.getSecondaryTextColor());
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007085 contentView.setBoolean(R.id.status_bar_latest_event_content, "setDisplayImagesAtEnd",
7086 displayImagesAtEnd);
Selim Cinekce8794f2018-05-23 16:46:05 -07007087 contentView.setIcon(R.id.status_bar_latest_event_content, "setAvatarReplacement",
7088 avatarReplacement);
Selim Cinek2dd3e722018-01-19 11:06:06 -08007089 contentView.setCharSequence(R.id.status_bar_latest_event_content, "setNameReplacement",
7090 nameReplacement);
Selim Cinek88188f22017-09-19 16:46:56 -07007091 contentView.setBoolean(R.id.status_bar_latest_event_content, "setIsOneToOne",
7092 isOneToOne);
7093 contentView.setBundle(R.id.status_bar_latest_event_content, "setData",
7094 mBuilder.mN.extras);
Alex Hillsfc737de2016-03-23 17:33:02 -04007095 return contentView;
7096 }
7097
Selim Cinekf7409db2017-10-24 16:17:14 -07007098 private boolean hasOnlyWhiteSpaceSenders() {
7099 for (int i = 0; i < mMessages.size(); i++) {
7100 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08007101 Person sender = m.getSenderPerson();
7102 if (sender != null && !isWhiteSpace(sender.getName())) {
Selim Cinekf7409db2017-10-24 16:17:14 -07007103 return false;
7104 }
7105 }
7106 return true;
7107 }
7108
7109 private boolean isWhiteSpace(CharSequence sender) {
7110 if (TextUtils.isEmpty(sender)) {
7111 return true;
7112 }
7113 if (sender.toString().matches("^\\s*$")) {
7114 return true;
7115 }
7116 // Let's check if we only have 0 whitespace chars. Some apps did this as a workaround
7117 // For the presentation that we had.
7118 for (int i = 0; i < sender.length(); i++) {
7119 char c = sender.charAt(i);
7120 if (c != '\u200B') {
7121 return false;
7122 }
7123 }
7124 return true;
7125 }
7126
Selim Cinek88188f22017-09-19 16:46:56 -07007127 private CharSequence createConversationTitleFromMessages() {
7128 ArraySet<CharSequence> names = new ArraySet<>();
7129 for (int i = 0; i < mMessages.size(); i++) {
7130 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08007131 Person sender = m.getSenderPerson();
Selim Cinek88188f22017-09-19 16:46:56 -07007132 if (sender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007133 names.add(sender.getName());
Selim Cinek88188f22017-09-19 16:46:56 -07007134 }
7135 }
7136 SpannableStringBuilder title = new SpannableStringBuilder();
7137 int size = names.size();
7138 for (int i = 0; i < size; i++) {
7139 CharSequence name = names.valueAt(i);
7140 if (!TextUtils.isEmpty(title)) {
7141 title.append(", ");
7142 }
7143 title.append(BidiFormatter.getInstance().unicodeWrap(name));
7144 }
7145 return title;
7146 }
7147
Adrian Roosdedd1df2016-04-26 16:38:47 -07007148 /**
7149 * @hide
7150 */
7151 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007152 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007153 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
Selim Cinek384804b2018-04-18 14:31:07 +08007154 true /* hideLargeIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07007155 remoteViews.setInt(R.id.notification_messaging, "setMaxDisplayedLines", 1);
7156 return remoteViews;
Adrian Roosdedd1df2016-04-26 16:38:47 -07007157 }
7158
Adrian Roosc1a80b02016-04-05 14:54:55 -07007159 private static TextAppearanceSpan makeFontColorSpan(int color) {
7160 return new TextAppearanceSpan(null, 0, 0,
7161 ColorStateList.valueOf(color), null);
7162 }
7163
Alex Hillsd9b04d92016-04-11 16:38:16 -04007164 public static final class Message {
7165
7166 static final String KEY_TEXT = "text";
7167 static final String KEY_TIMESTAMP = "time";
7168 static final String KEY_SENDER = "sender";
Selim Cinekcb8b9852017-12-15 18:01:52 -08007169 static final String KEY_SENDER_PERSON = "sender_person";
Alex Hillsd9b04d92016-04-11 16:38:16 -04007170 static final String KEY_DATA_MIME_TYPE = "type";
7171 static final String KEY_DATA_URI= "uri";
Shane Brennan5a871862017-03-11 13:14:17 -08007172 static final String KEY_EXTRAS_BUNDLE = "extras";
Kenny Guya0f6de82018-04-06 16:20:16 +01007173 static final String KEY_REMOTE_INPUT_HISTORY = "remote_input_history";
Alex Hillsfc737de2016-03-23 17:33:02 -04007174
7175 private final CharSequence mText;
7176 private final long mTimestamp;
Selim Cinekcb8b9852017-12-15 18:01:52 -08007177 @Nullable
7178 private final Person mSender;
Kenny Guya0f6de82018-04-06 16:20:16 +01007179 /** True if this message was generated from the extra
7180 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}
7181 */
7182 private final boolean mRemoteInputHistory;
Alex Hillsfc737de2016-03-23 17:33:02 -04007183
Shane Brennan5a871862017-03-11 13:14:17 -08007184 private Bundle mExtras = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04007185 private String mDataMimeType;
7186 private Uri mDataUri;
7187
7188 /**
7189 * Constructor
7190 * @param text A {@link CharSequence} to be displayed as the message content
7191 * @param timestamp Time at which the message arrived
7192 * @param sender A {@link CharSequence} to be used for displaying the name of the
7193 * sender. Should be <code>null</code> for messages by the current user, in which case
7194 * the platform will insert {@link MessagingStyle#getUserDisplayName()}.
7195 * Should be unique amongst all individuals in the conversation, and should be
7196 * consistent during re-posts of the notification.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007197 *
7198 * @deprecated use {@code Message(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04007199 */
7200 public Message(CharSequence text, long timestamp, CharSequence sender){
Selim Cinek9acd6732018-03-23 16:39:02 -07007201 this(text, timestamp, sender == null ? null
7202 : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08007203 }
7204
7205 /**
7206 * Constructor
7207 * @param text A {@link CharSequence} to be displayed as the message content
7208 * @param timestamp Time at which the message arrived
7209 * @param sender The {@link Person} who sent the message.
7210 * Should be <code>null</code> for messages by the current user, in which case
7211 * the platform will insert the user set in {@code MessagingStyle(Person)}.
7212 * <p>
Selim Cinek9acd6732018-03-23 16:39:02 -07007213 * The person provided should contain an Icon, set with
7214 * {@link Person.Builder#setIcon(Icon)} and also have a name provided
7215 * with {@link Person.Builder#setName(CharSequence)}. If multiple users have the same
7216 * name, consider providing a key with {@link Person.Builder#setKey(String)} in order
7217 * to differentiate between the different users.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007218 * </p>
7219 */
Selim Cinekeb53c222018-04-06 12:56:09 -07007220 public Message(@NonNull CharSequence text, long timestamp, @Nullable Person sender) {
Kenny Guya0f6de82018-04-06 16:20:16 +01007221 this(text, timestamp, sender, false /* remoteHistory */);
7222 }
7223
7224 /**
7225 * Constructor
7226 * @param text A {@link CharSequence} to be displayed as the message content
7227 * @param timestamp Time at which the message arrived
7228 * @param sender The {@link Person} who sent the message.
7229 * Should be <code>null</code> for messages by the current user, in which case
7230 * the platform will insert the user set in {@code MessagingStyle(Person)}.
7231 * @param remoteInputHistory True if the messages was generated from the extra
7232 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}.
7233 * <p>
7234 * The person provided should contain an Icon, set with
7235 * {@link Person.Builder#setIcon(Icon)} and also have a name provided
7236 * with {@link Person.Builder#setName(CharSequence)}. If multiple users have the same
7237 * name, consider providing a key with {@link Person.Builder#setKey(String)} in order
7238 * to differentiate between the different users.
7239 * </p>
7240 * @hide
7241 */
7242 public Message(@NonNull CharSequence text, long timestamp, @Nullable Person sender,
7243 boolean remoteInputHistory) {
Alex Hillsfc737de2016-03-23 17:33:02 -04007244 mText = text;
7245 mTimestamp = timestamp;
7246 mSender = sender;
Kenny Guya0f6de82018-04-06 16:20:16 +01007247 mRemoteInputHistory = remoteInputHistory;
Alex Hillsfc737de2016-03-23 17:33:02 -04007248 }
7249
7250 /**
7251 * Sets a binary blob of data and an associated MIME type for a message. In the case
7252 * where the platform doesn't support the MIME type, the original text provided in the
7253 * constructor will be used.
7254 * @param dataMimeType The MIME type of the content. See
7255 * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME
7256 * types on Android and Android Wear.
7257 * @param dataUri The uri containing the content whose type is given by the MIME type.
7258 * <p class="note">
7259 * <ol>
7260 * <li>Notification Listeners including the System UI need permission to access the
7261 * data the Uri points to. The recommended ways to do this are:</li>
7262 * <li>Store the data in your own ContentProvider, making sure that other apps have
7263 * the correct permission to access your provider. The preferred mechanism for
7264 * providing access is to use per-URI permissions which are temporary and only
7265 * grant access to the receiving application. An easy way to create a
7266 * ContentProvider like this is to use the FileProvider helper class.</li>
7267 * <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio
7268 * and image MIME types, however beginning with Android 3.0 (API level 11) it can
7269 * also store non-media types (see MediaStore.Files for more info). Files can be
7270 * inserted into the MediaStore using scanFile() after which a content:// style
7271 * Uri suitable for sharing is passed to the provided onScanCompleted() callback.
7272 * Note that once added to the system MediaStore the content is accessible to any
7273 * app on the device.</li>
7274 * </ol>
7275 * @return this object for method chaining
7276 */
7277 public Message setData(String dataMimeType, Uri dataUri) {
7278 mDataMimeType = dataMimeType;
7279 mDataUri = dataUri;
7280 return this;
7281 }
7282
Alex Hillsfc737de2016-03-23 17:33:02 -04007283 /**
7284 * Get the text to be used for this message, or the fallback text if a type and content
7285 * Uri have been set
7286 */
7287 public CharSequence getText() {
7288 return mText;
7289 }
7290
7291 /**
7292 * Get the time at which this message arrived
7293 */
7294 public long getTimestamp() {
7295 return mTimestamp;
7296 }
7297
7298 /**
Shane Brennan5a871862017-03-11 13:14:17 -08007299 * Get the extras Bundle for this message.
7300 */
7301 public Bundle getExtras() {
7302 return mExtras;
7303 }
7304
7305 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04007306 * Get the text used to display the contact's name in the messaging experience
Selim Cinekcb8b9852017-12-15 18:01:52 -08007307 *
7308 * @deprecated use {@link #getSenderPerson()}
Alex Hillsfc737de2016-03-23 17:33:02 -04007309 */
7310 public CharSequence getSender() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007311 return mSender == null ? null : mSender.getName();
7312 }
7313
7314 /**
7315 * Get the sender associated with this message.
7316 */
7317 @Nullable
7318 public Person getSenderPerson() {
Alex Hillsfc737de2016-03-23 17:33:02 -04007319 return mSender;
7320 }
7321
7322 /**
7323 * Get the MIME type of the data pointed to by the Uri
7324 */
7325 public String getDataMimeType() {
7326 return mDataMimeType;
7327 }
7328
7329 /**
7330 * Get the the Uri pointing to the content of the message. Can be null, in which case
7331 * {@see #getText()} is used.
7332 */
7333 public Uri getDataUri() {
7334 return mDataUri;
7335 }
7336
Kenny Guya0f6de82018-04-06 16:20:16 +01007337 /**
7338 * @return True if the message was generated from
7339 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}.
7340 * @hide
7341 */
7342 public boolean isRemoteInputHistory() {
7343 return mRemoteInputHistory;
7344 }
7345
Alex Hillsd9b04d92016-04-11 16:38:16 -04007346 private Bundle toBundle() {
7347 Bundle bundle = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04007348 if (mText != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007349 bundle.putCharSequence(KEY_TEXT, mText);
Alex Hillsfc737de2016-03-23 17:33:02 -04007350 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007351 bundle.putLong(KEY_TIMESTAMP, mTimestamp);
Alex Hillsfc737de2016-03-23 17:33:02 -04007352 if (mSender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007353 // Legacy listeners need this
7354 bundle.putCharSequence(KEY_SENDER, mSender.getName());
7355 bundle.putParcelable(KEY_SENDER_PERSON, mSender);
Alex Hillsfc737de2016-03-23 17:33:02 -04007356 }
7357 if (mDataMimeType != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007358 bundle.putString(KEY_DATA_MIME_TYPE, mDataMimeType);
Alex Hillsfc737de2016-03-23 17:33:02 -04007359 }
7360 if (mDataUri != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007361 bundle.putParcelable(KEY_DATA_URI, mDataUri);
Alex Hillsfc737de2016-03-23 17:33:02 -04007362 }
Shane Brennan5a871862017-03-11 13:14:17 -08007363 if (mExtras != null) {
7364 bundle.putBundle(KEY_EXTRAS_BUNDLE, mExtras);
7365 }
Kenny Guya0f6de82018-04-06 16:20:16 +01007366 if (mRemoteInputHistory) {
7367 bundle.putBoolean(KEY_REMOTE_INPUT_HISTORY, mRemoteInputHistory);
7368 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007369 return bundle;
Alex Hillsfc737de2016-03-23 17:33:02 -04007370 }
7371
Alex Hillsd9b04d92016-04-11 16:38:16 -04007372 static Bundle[] getBundleArrayForMessages(List<Message> messages) {
7373 Bundle[] bundles = new Bundle[messages.size()];
7374 final int N = messages.size();
7375 for (int i = 0; i < N; i++) {
7376 bundles[i] = messages.get(i).toBundle();
7377 }
7378 return bundles;
7379 }
7380
Selim Cinek88188f22017-09-19 16:46:56 -07007381 /**
7382 * @return A list of messages read from the bundles.
7383 *
7384 * @hide
7385 */
7386 public static List<Message> getMessagesFromBundleArray(Parcelable[] bundles) {
7387 if (bundles == null) {
7388 return new ArrayList<>();
7389 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007390 List<Message> messages = new ArrayList<>(bundles.length);
7391 for (int i = 0; i < bundles.length; i++) {
Adrian Roosdedd1df2016-04-26 16:38:47 -07007392 if (bundles[i] instanceof Bundle) {
7393 Message message = getMessageFromBundle((Bundle)bundles[i]);
7394 if (message != null) {
7395 messages.add(message);
7396 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007397 }
7398 }
7399 return messages;
7400 }
7401
Selim Cinekb0dc61b2018-05-22 18:49:36 -07007402 /**
7403 * @return The message that is stored in the bundle or null if the message couldn't be
7404 * resolved.
7405 *
7406 * @hide
7407 */
7408 @Nullable
7409 public static Message getMessageFromBundle(Bundle bundle) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007410 try {
Adrian Roosfbddd2c2016-05-13 12:57:20 -07007411 if (!bundle.containsKey(KEY_TEXT) || !bundle.containsKey(KEY_TIMESTAMP)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007412 return null;
7413 } else {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007414
7415 Person senderPerson = bundle.getParcelable(KEY_SENDER_PERSON);
7416 if (senderPerson == null) {
7417 // Legacy apps that use compat don't actually provide the sender objects
7418 // We need to fix the compat version to provide people / use
7419 // the native api instead
7420 CharSequence senderName = bundle.getCharSequence(KEY_SENDER);
7421 if (senderName != null) {
Selim Cinek9acd6732018-03-23 16:39:02 -07007422 senderPerson = new Person.Builder().setName(senderName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08007423 }
7424 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007425 Message message = new Message(bundle.getCharSequence(KEY_TEXT),
Selim Cinekcb8b9852017-12-15 18:01:52 -08007426 bundle.getLong(KEY_TIMESTAMP),
Kenny Guya0f6de82018-04-06 16:20:16 +01007427 senderPerson,
7428 bundle.getBoolean(KEY_REMOTE_INPUT_HISTORY, false));
Alex Hillsd9b04d92016-04-11 16:38:16 -04007429 if (bundle.containsKey(KEY_DATA_MIME_TYPE) &&
7430 bundle.containsKey(KEY_DATA_URI)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007431 message.setData(bundle.getString(KEY_DATA_MIME_TYPE),
7432 (Uri) bundle.getParcelable(KEY_DATA_URI));
Alex Hillsfc737de2016-03-23 17:33:02 -04007433 }
Shane Brennan5a871862017-03-11 13:14:17 -08007434 if (bundle.containsKey(KEY_EXTRAS_BUNDLE)) {
7435 message.getExtras().putAll(bundle.getBundle(KEY_EXTRAS_BUNDLE));
7436 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007437 return message;
7438 }
7439 } catch (ClassCastException e) {
7440 return null;
7441 }
7442 }
Alex Hillsfc737de2016-03-23 17:33:02 -04007443 }
7444 }
7445
7446 /**
Daniel Sandler879c5e02012-04-17 16:46:51 -04007447 * Helper class for generating large-format notifications that include a list of (up to 5) strings.
Joe Malin8d40d042012-11-05 11:36:40 -08007448 *
Robert Ly91c5ce32014-06-08 15:37:00 -07007449 * Here's how you'd set the <code>InboxStyle</code> on a notification:
Daniel Sandler879c5e02012-04-17 16:46:51 -04007450 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07007451 * Notification notif = new Notification.Builder(mContext)
7452 * .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
7453 * .setContentText(subject)
7454 * .setSmallIcon(R.drawable.new_mail)
7455 * .setLargeIcon(aBitmap)
7456 * .setStyle(new Notification.InboxStyle()
7457 * .addLine(str1)
7458 * .addLine(str2)
7459 * .setContentTitle(&quot;&quot;)
7460 * .setSummaryText(&quot;+3 more&quot;))
7461 * .build();
Daniel Sandler879c5e02012-04-17 16:46:51 -04007462 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08007463 *
Daniel Sandler879c5e02012-04-17 16:46:51 -04007464 * @see Notification#bigContentView
7465 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007466 public static class InboxStyle extends Style {
Selim Cinekbee4e072018-05-21 22:06:43 -07007467
7468 /**
7469 * The number of lines of remote input history allowed until we start reducing lines.
7470 */
7471 private static final int NUMBER_OF_HISTORY_ALLOWED_UNTIL_REDUCTION = 1;
Daniel Sandler879c5e02012-04-17 16:46:51 -04007472 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
7473
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007474 public InboxStyle() {
7475 }
7476
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007477 /**
7478 * @deprecated use {@code InboxStyle()}.
7479 */
7480 @Deprecated
Daniel Sandler879c5e02012-04-17 16:46:51 -04007481 public InboxStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007482 setBuilder(builder);
Daniel Sandler879c5e02012-04-17 16:46:51 -04007483 }
7484
Chris Wrend6297db2012-05-03 16:20:13 -04007485 /**
7486 * Overrides ContentTitle in the big form of the template.
7487 * This defaults to the value passed to setContentTitle().
7488 */
7489 public InboxStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007490 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04007491 return this;
7492 }
7493
7494 /**
7495 * Set the first line of text after the detail section in the big form of the template.
7496 */
7497 public InboxStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007498 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04007499 return this;
7500 }
7501
Chris Wren0bd664d2012-08-01 13:56:56 -04007502 /**
7503 * Append a line to the digest section of the Inbox notification.
7504 */
Daniel Sandler879c5e02012-04-17 16:46:51 -04007505 public InboxStyle addLine(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007506 mTexts.add(safeCharSequence(cs));
Daniel Sandler879c5e02012-04-17 16:46:51 -04007507 return this;
7508 }
7509
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007510 /**
7511 * @hide
7512 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05007513 public ArrayList<CharSequence> getLines() {
7514 return mTexts;
7515 }
7516
7517 /**
7518 * @hide
7519 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007520 public void addExtras(Bundle extras) {
7521 super.addExtras(extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007522
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007523 CharSequence[] a = new CharSequence[mTexts.size()];
7524 extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
7525 }
7526
Christoph Studer4600f9b2014-07-22 22:44:43 +02007527 /**
7528 * @hide
7529 */
7530 @Override
7531 protected void restoreFromExtras(Bundle extras) {
7532 super.restoreFromExtras(extras);
7533
7534 mTexts.clear();
7535 if (extras.containsKey(EXTRA_TEXT_LINES)) {
7536 Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES));
7537 }
7538 }
7539
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007540 /**
7541 * @hide
7542 */
7543 public RemoteViews makeBigContentView() {
Selim Cinekc848c3a2016-01-13 15:27:30 -08007544 // Remove the content text so it disappears unless you have a summary
Christoph Studer4600f9b2014-07-22 22:44:43 +02007545 // Nasty
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007546 CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT);
7547 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007548
Selim Cinek384804b2018-04-18 14:31:07 +08007549 TemplateBindResult result = new TemplateBindResult();
7550 RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource(), result);
Daniel Sandler619738c2012-06-07 16:33:08 -04007551
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007552 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007553
Chris Wrend6297db2012-05-03 16:20:13 -04007554 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 -04007555 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
Chris Wrend6297db2012-05-03 16:20:13 -04007556
Chris Wren4ed80d52012-05-17 09:30:03 -04007557 // Make sure all rows are gone in case we reuse a view.
7558 for (int rowId : rowIds) {
7559 contentView.setViewVisibility(rowId, View.GONE);
7560 }
7561
Daniel Sandler879c5e02012-04-17 16:46:51 -04007562 int i=0;
Selim Cinek07c80172016-04-21 16:40:47 -07007563 int topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7564 R.dimen.notification_inbox_item_top_padding);
Selim Cinek247fa012016-02-18 09:50:48 -08007565 boolean first = true;
Selim Cinek07c80172016-04-21 16:40:47 -07007566 int onlyViewId = 0;
7567 int maxRows = rowIds.length;
7568 if (mBuilder.mActions.size() > 0) {
7569 maxRows--;
7570 }
Selim Cinekbee4e072018-05-21 22:06:43 -07007571 CharSequence[] remoteInputHistory = mBuilder.mN.extras.getCharSequenceArray(
7572 EXTRA_REMOTE_INPUT_HISTORY);
7573 if (remoteInputHistory != null
7574 && remoteInputHistory.length > NUMBER_OF_HISTORY_ALLOWED_UNTIL_REDUCTION) {
7575 // Let's remove some messages to make room for the remote input history.
7576 // 1 is always able to fit, but let's remove them if they are 2 or 3
7577 int numRemoteInputs = Math.min(remoteInputHistory.length,
7578 MAX_REMOTE_INPUT_HISTORY_LINES);
7579 int totalNumRows = mTexts.size() + numRemoteInputs
7580 - NUMBER_OF_HISTORY_ALLOWED_UNTIL_REDUCTION;
7581 if (totalNumRows > maxRows) {
7582 int overflow = totalNumRows - maxRows;
7583 if (mTexts.size() > maxRows) {
7584 // Heuristic: if the Texts don't fit anyway, we'll rather drop the last
7585 // few messages, even with the remote input
7586 maxRows -= overflow;
7587 } else {
7588 // otherwise we drop the first messages
7589 i = overflow;
7590 }
7591 }
7592 }
Selim Cinek07c80172016-04-21 16:40:47 -07007593 while (i < mTexts.size() && i < maxRows) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007594 CharSequence str = mTexts.get(i);
Selim Cinek07c80172016-04-21 16:40:47 -07007595 if (!TextUtils.isEmpty(str)) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007596 contentView.setViewVisibility(rowIds[i], View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07007597 contentView.setTextViewText(rowIds[i],
7598 mBuilder.processTextSpans(mBuilder.processLegacyText(str)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08007599 mBuilder.setTextViewColorSecondary(contentView, rowIds[i]);
Selim Cinek07c80172016-04-21 16:40:47 -07007600 contentView.setViewPadding(rowIds[i], 0, topPadding, 0, 0);
Selim Cinek384804b2018-04-18 14:31:07 +08007601 handleInboxImageMargin(contentView, rowIds[i], first,
Selim Cinek1c72fa02018-04-23 18:00:54 +08007602 result.getIconMarginEnd());
Selim Cinek07c80172016-04-21 16:40:47 -07007603 if (first) {
7604 onlyViewId = rowIds[i];
7605 } else {
7606 onlyViewId = 0;
7607 }
Selim Cinek247fa012016-02-18 09:50:48 -08007608 first = false;
Daniel Sandler879c5e02012-04-17 16:46:51 -04007609 }
7610 i++;
7611 }
Selim Cinek07c80172016-04-21 16:40:47 -07007612 if (onlyViewId != 0) {
7613 // We only have 1 entry, lets make it look like the normal Text of a Bigtext
7614 topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7615 R.dimen.notification_text_margin_top);
7616 contentView.setViewPadding(onlyViewId, 0, topPadding, 0, 0);
7617 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007618
Daniel Sandler879c5e02012-04-17 16:46:51 -04007619 return contentView;
7620 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007621
Julia Reynolds7217dc92018-03-07 12:12:09 -05007622 /**
7623 * @hide
7624 */
7625 @Override
7626 public boolean areNotificationsVisiblyDifferent(Style other) {
7627 if (other == null || getClass() != other.getClass()) {
7628 return true;
7629 }
7630 InboxStyle newS = (InboxStyle) other;
Dan Sandler7d67bd42018-05-15 14:06:38 -04007631
7632 final ArrayList<CharSequence> myLines = getLines();
7633 final ArrayList<CharSequence> newLines = newS.getLines();
7634 final int n = myLines.size();
7635 if (n != newLines.size()) {
7636 return true;
7637 }
7638
7639 for (int i = 0; i < n; i++) {
7640 if (!Objects.equals(
7641 String.valueOf(myLines.get(i)),
7642 String.valueOf(newLines.get(i)))) {
7643 return true;
7644 }
7645 }
7646 return false;
Julia Reynolds7217dc92018-03-07 12:12:09 -05007647 }
7648
Selim Cinek384804b2018-04-18 14:31:07 +08007649 private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first,
Selim Cinek1c72fa02018-04-23 18:00:54 +08007650 int marginEndValue) {
Selim Cinek1e0bf612015-11-20 15:57:26 -08007651 int endMargin = 0;
Selim Cinek247fa012016-02-18 09:50:48 -08007652 if (first) {
7653 final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0);
7654 final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
7655 boolean hasProgress = max != 0 || ind;
Selim Cinek384804b2018-04-18 14:31:07 +08007656 if (!hasProgress) {
Selim Cinek1c72fa02018-04-23 18:00:54 +08007657 endMargin = marginEndValue;
Selim Cinek247fa012016-02-18 09:50:48 -08007658 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007659 }
Selim Cinek1c72fa02018-04-23 18:00:54 +08007660 contentView.setViewLayoutMarginEnd(id, endMargin);
Selim Cinek1e0bf612015-11-20 15:57:26 -08007661 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04007662 }
Dan Sandler842dd772014-05-15 09:36:47 -04007663
7664 /**
7665 * Notification style for media playback notifications.
7666 *
7667 * In the expanded form, {@link Notification#bigContentView}, up to 5
7668 * {@link Notification.Action}s specified with
Dan Sandler86647982015-05-13 23:41:13 -04007669 * {@link Notification.Builder#addAction(Action) addAction} will be
Dan Sandler842dd772014-05-15 09:36:47 -04007670 * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
7671 * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be
7672 * treated as album artwork.
Selim Cinek99104832017-01-25 14:47:33 -08007673 * <p>
Dan Sandler842dd772014-05-15 09:36:47 -04007674 * Unlike the other styles provided here, MediaStyle can also modify the standard-size
7675 * {@link Notification#contentView}; by providing action indices to
Christoph Studerfde6f4d2014-12-12 13:23:26 +01007676 * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed
Dan Sandler842dd772014-05-15 09:36:47 -04007677 * in the standard view alongside the usual content.
Selim Cinek99104832017-01-25 14:47:33 -08007678 * <p>
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007679 * Notifications created with MediaStyle will have their category set to
7680 * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different
7681 * category using {@link Notification.Builder#setCategory(String) setCategory()}.
Selim Cinek99104832017-01-25 14:47:33 -08007682 * <p>
Jeff Browndba34ba2014-06-24 20:46:03 -07007683 * Finally, if you attach a {@link android.media.session.MediaSession.Token} using
7684 * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)},
Dan Sandler842dd772014-05-15 09:36:47 -04007685 * the System UI can identify this as a notification representing an active media session
7686 * and respond accordingly (by showing album artwork in the lockscreen, for example).
7687 *
Selim Cinek99104832017-01-25 14:47:33 -08007688 * <p>
7689 * Starting at {@link android.os.Build.VERSION_CODES#O Android O} any notification that has a
7690 * media session attached with {@link #setMediaSession(MediaSession.Token)} will be colorized.
7691 * You can opt-out of this behavior by using {@link Notification.Builder#setColorized(boolean)}.
7692 * <p>
7693 *
Dan Sandler842dd772014-05-15 09:36:47 -04007694 * To use this style with your Notification, feed it to
7695 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7696 * <pre class="prettyprint">
7697 * Notification noti = new Notification.Builder()
7698 * .setSmallIcon(R.drawable.ic_stat_player)
Christoph Studere935fe92014-11-24 14:18:06 +01007699 * .setContentTitle(&quot;Track title&quot;)
7700 * .setContentText(&quot;Artist - Album&quot;)
7701 * .setLargeIcon(albumArtBitmap))
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007702 * .setStyle(<b>new Notification.MediaStyle()</b>
7703 * .setMediaSession(mySession))
Dan Sandler842dd772014-05-15 09:36:47 -04007704 * .build();
7705 * </pre>
7706 *
7707 * @see Notification#bigContentView
Selim Cinek99104832017-01-25 14:47:33 -08007708 * @see Notification.Builder#setColorized(boolean)
Dan Sandler842dd772014-05-15 09:36:47 -04007709 */
7710 public static class MediaStyle extends Style {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007711 static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3;
Dan Sandler842dd772014-05-15 09:36:47 -04007712 static final int MAX_MEDIA_BUTTONS = 5;
7713
7714 private int[] mActionsToShowInCompact = null;
Jeff Browndba34ba2014-06-24 20:46:03 -07007715 private MediaSession.Token mToken;
Dan Sandler842dd772014-05-15 09:36:47 -04007716
7717 public MediaStyle() {
7718 }
7719
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007720 /**
7721 * @deprecated use {@code MediaStyle()}.
7722 */
7723 @Deprecated
Dan Sandler842dd772014-05-15 09:36:47 -04007724 public MediaStyle(Builder builder) {
7725 setBuilder(builder);
7726 }
7727
7728 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007729 * 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 -04007730 * notification view.
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007731 *
7732 * @param actions the indices of the actions to show in the compact notification view
Dan Sandler842dd772014-05-15 09:36:47 -04007733 */
7734 public MediaStyle setShowActionsInCompactView(int...actions) {
7735 mActionsToShowInCompact = actions;
7736 return this;
7737 }
7738
7739 /**
Jeff Browndba34ba2014-06-24 20:46:03 -07007740 * Attach a {@link android.media.session.MediaSession.Token} to this Notification
7741 * to provide additional playback information and control to the SystemUI.
Dan Sandler842dd772014-05-15 09:36:47 -04007742 */
Jeff Browndba34ba2014-06-24 20:46:03 -07007743 public MediaStyle setMediaSession(MediaSession.Token token) {
Dan Sandler842dd772014-05-15 09:36:47 -04007744 mToken = token;
7745 return this;
7746 }
7747
Christoph Studer4600f9b2014-07-22 22:44:43 +02007748 /**
7749 * @hide
7750 */
Dan Sandler842dd772014-05-15 09:36:47 -04007751 @Override
7752 public Notification buildStyled(Notification wip) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02007753 super.buildStyled(wip);
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007754 if (wip.category == null) {
7755 wip.category = Notification.CATEGORY_TRANSPORT;
7756 }
Dan Sandler842dd772014-05-15 09:36:47 -04007757 return wip;
7758 }
7759
Christoph Studer4600f9b2014-07-22 22:44:43 +02007760 /**
7761 * @hide
7762 */
7763 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007764 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007765 return makeMediaContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007766 }
7767
7768 /**
7769 * @hide
7770 */
7771 @Override
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007772 public RemoteViews makeBigContentView() {
7773 return makeMediaBigContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007774 }
7775
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007776 /**
7777 * @hide
7778 */
7779 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007780 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007781 RemoteViews expanded = makeMediaBigContentView();
7782 return expanded != null ? expanded : makeMediaContentView();
7783 }
7784
Dan Sandler842dd772014-05-15 09:36:47 -04007785 /** @hide */
7786 @Override
7787 public void addExtras(Bundle extras) {
7788 super.addExtras(extras);
7789
7790 if (mToken != null) {
7791 extras.putParcelable(EXTRA_MEDIA_SESSION, mToken);
7792 }
Bryan Mawhinneye191f902014-07-22 12:50:09 +01007793 if (mActionsToShowInCompact != null) {
7794 extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact);
7795 }
Dan Sandler842dd772014-05-15 09:36:47 -04007796 }
7797
Christoph Studer4600f9b2014-07-22 22:44:43 +02007798 /**
7799 * @hide
7800 */
7801 @Override
7802 protected void restoreFromExtras(Bundle extras) {
7803 super.restoreFromExtras(extras);
7804
7805 if (extras.containsKey(EXTRA_MEDIA_SESSION)) {
7806 mToken = extras.getParcelable(EXTRA_MEDIA_SESSION);
7807 }
7808 if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) {
7809 mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS);
7810 }
7811 }
7812
Julia Reynolds7217dc92018-03-07 12:12:09 -05007813 /**
7814 * @hide
7815 */
7816 @Override
7817 public boolean areNotificationsVisiblyDifferent(Style other) {
7818 if (other == null || getClass() != other.getClass()) {
7819 return true;
7820 }
7821 // All fields to compare are on the Notification object
7822 return false;
7823 }
7824
Selim Cinek5bf069a2015-11-10 19:14:27 -05007825 private RemoteViews generateMediaActionButton(Action action, int color) {
Dan Sandler842dd772014-05-15 09:36:47 -04007826 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07007827 RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(),
Alan Viverette3cb07a462014-06-06 14:19:53 -07007828 R.layout.notification_material_media_action);
Dan Sandler68079d52015-07-22 10:45:30 -04007829 button.setImageViewIcon(R.id.action0, action.getIcon());
Anthony Chenad4d1582017-04-10 16:07:58 -07007830
7831 // If the action buttons should not be tinted, then just use the default
7832 // notification color. Otherwise, just use the passed-in color.
7833 int tintColor = mBuilder.shouldTintActionButtons() || mBuilder.isColorized()
7834 ? color
7835 : NotificationColorUtil.resolveColor(mBuilder.mContext,
7836 Notification.COLOR_DEFAULT);
7837
Sunny Goyal5b153922017-09-21 21:00:36 -07007838 button.setDrawableTint(R.id.action0, false, tintColor,
7839 PorterDuff.Mode.SRC_ATOP);
Dan Sandler842dd772014-05-15 09:36:47 -04007840 if (!tombstone) {
7841 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
7842 }
7843 button.setContentDescription(R.id.action0, action.title);
7844 return button;
7845 }
7846
7847 private RemoteViews makeMediaContentView() {
7848 RemoteViews view = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007849 R.layout.notification_template_material_media, false, /* hasProgress */
7850 null /* result */);
Dan Sandler842dd772014-05-15 09:36:47 -04007851
7852 final int numActions = mBuilder.mActions.size();
7853 final int N = mActionsToShowInCompact == null
7854 ? 0
7855 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
7856 if (N > 0) {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007857 view.removeAllViews(com.android.internal.R.id.media_actions);
Dan Sandler842dd772014-05-15 09:36:47 -04007858 for (int i = 0; i < N; i++) {
7859 if (i >= numActions) {
7860 throw new IllegalArgumentException(String.format(
7861 "setShowActionsInCompactView: action %d out of bounds (max %d)",
7862 i, numActions - 1));
7863 }
7864
7865 final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]);
Selim Cinekc7f5a822018-03-20 19:32:06 -07007866 final RemoteViews button = generateMediaActionButton(action, getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007867 view.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007868 }
7869 }
Selim Cinekfdc738f2016-01-27 20:04:27 -08007870 handleImage(view);
7871 // handle the content margin
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007872 int endMargin = R.dimen.notification_content_margin_end;
Selim Cinek279fa862016-06-14 10:57:25 -07007873 if (mBuilder.mN.hasLargeIcon()) {
Selim Cinek384804b2018-04-18 14:31:07 +08007874 endMargin = R.dimen.notification_media_image_margin_end;
Selim Cinekfdc738f2016-01-27 20:04:27 -08007875 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007876 view.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
Dan Sandler842dd772014-05-15 09:36:47 -04007877 return view;
7878 }
7879
Selim Cinekc7f5a822018-03-20 19:32:06 -07007880 private int getActionColor() {
7881 return mBuilder.isColorized() ? mBuilder.getPrimaryTextColor()
7882 : mBuilder.resolveContrastColor();
Selim Cinek99104832017-01-25 14:47:33 -08007883 }
7884
Dan Sandler842dd772014-05-15 09:36:47 -04007885 private RemoteViews makeMediaBigContentView() {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007886 final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007887 // Dont add an expanded view if there is no more content to be revealed
7888 int actionsInCompact = mActionsToShowInCompact == null
7889 ? 0
7890 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
Selim Cinek279fa862016-06-14 10:57:25 -07007891 if (!mBuilder.mN.hasLargeIcon() && actionCount <= actionsInCompact) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007892 return null;
7893 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007894 RemoteViews big = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007895 R.layout.notification_template_material_big_media, false, null /* result */);
Dan Sandler842dd772014-05-15 09:36:47 -04007896
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007897 if (actionCount > 0) {
7898 big.removeAllViews(com.android.internal.R.id.media_actions);
7899 for (int i = 0; i < actionCount; i++) {
Selim Cinek5bf069a2015-11-10 19:14:27 -05007900 final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i),
Selim Cinekc7f5a822018-03-20 19:32:06 -07007901 getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007902 big.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007903 }
7904 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007905 handleImage(big);
Dan Sandler842dd772014-05-15 09:36:47 -04007906 return big;
7907 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007908
Selim Cinek5bf069a2015-11-10 19:14:27 -05007909 private void handleImage(RemoteViews contentView) {
Selim Cinek279fa862016-06-14 10:57:25 -07007910 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007911 contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
7912 contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007913 }
7914 }
7915
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007916 /**
7917 * @hide
7918 */
7919 @Override
7920 protected boolean hasProgress() {
7921 return false;
7922 }
Dan Sandler842dd772014-05-15 09:36:47 -04007923 }
Griff Hazen61a9e862014-05-22 16:05:19 -07007924
Selim Cinek593610c2016-02-16 18:42:57 -08007925 /**
7926 * Notification style for custom views that are decorated by the system
7927 *
7928 * <p>Instead of providing a notification that is completely custom, a developer can set this
7929 * style and still obtain system decorations like the notification header with the expand
7930 * affordance and actions.
7931 *
7932 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7933 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7934 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7935 * corresponding custom views to display.
7936 *
7937 * To use this style with your Notification, feed it to
7938 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7939 * <pre class="prettyprint">
7940 * Notification noti = new Notification.Builder()
7941 * .setSmallIcon(R.drawable.ic_stat_player)
7942 * .setLargeIcon(albumArtBitmap))
7943 * .setCustomContentView(contentView);
7944 * .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>)
7945 * .build();
7946 * </pre>
7947 */
7948 public static class DecoratedCustomViewStyle extends Style {
7949
7950 public DecoratedCustomViewStyle() {
7951 }
7952
Selim Cinek593610c2016-02-16 18:42:57 -08007953 /**
7954 * @hide
7955 */
7956 public boolean displayCustomViewInline() {
7957 return true;
7958 }
7959
7960 /**
7961 * @hide
7962 */
7963 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007964 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007965 return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView);
7966 }
7967
7968 /**
7969 * @hide
7970 */
7971 @Override
7972 public RemoteViews makeBigContentView() {
7973 return makeDecoratedBigContentView();
7974 }
7975
7976 /**
7977 * @hide
7978 */
7979 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007980 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007981 return makeDecoratedHeadsUpContentView();
7982 }
7983
Selim Cinek593610c2016-02-16 18:42:57 -08007984 private RemoteViews makeDecoratedHeadsUpContentView() {
7985 RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null
7986 ? mBuilder.mN.contentView
7987 : mBuilder.mN.headsUpContentView;
7988 if (mBuilder.mActions.size() == 0) {
7989 return makeStandardTemplateWithCustomContent(headsUpContentView);
7990 }
Selim Cinek384804b2018-04-18 14:31:07 +08007991 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08007992 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
Selim Cinek384804b2018-04-18 14:31:07 +08007993 mBuilder.getBigBaseLayoutResource(), result);
7994 buildIntoRemoteViewContent(remoteViews, headsUpContentView, result);
Selim Cinek593610c2016-02-16 18:42:57 -08007995 return remoteViews;
7996 }
7997
Selim Cinek593610c2016-02-16 18:42:57 -08007998 private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) {
Selim Cinek384804b2018-04-18 14:31:07 +08007999 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08008000 RemoteViews remoteViews = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08008001 mBuilder.getBaseLayoutResource(), result);
8002 buildIntoRemoteViewContent(remoteViews, customContent, result);
Selim Cinek593610c2016-02-16 18:42:57 -08008003 return remoteViews;
8004 }
8005
Selim Cinek593610c2016-02-16 18:42:57 -08008006 private RemoteViews makeDecoratedBigContentView() {
8007 RemoteViews bigContentView = mBuilder.mN.bigContentView == null
8008 ? mBuilder.mN.contentView
8009 : mBuilder.mN.bigContentView;
8010 if (mBuilder.mActions.size() == 0) {
8011 return makeStandardTemplateWithCustomContent(bigContentView);
8012 }
Selim Cinek384804b2018-04-18 14:31:07 +08008013 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08008014 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
Selim Cinek384804b2018-04-18 14:31:07 +08008015 mBuilder.getBigBaseLayoutResource(), result);
8016 buildIntoRemoteViewContent(remoteViews, bigContentView, result);
Selim Cinek593610c2016-02-16 18:42:57 -08008017 return remoteViews;
8018 }
Selim Cinek247fa012016-02-18 09:50:48 -08008019
8020 private void buildIntoRemoteViewContent(RemoteViews remoteViews,
Selim Cinek384804b2018-04-18 14:31:07 +08008021 RemoteViews customContent, TemplateBindResult result) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08008022 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07008023 // Need to clone customContent before adding, because otherwise it can no longer be
8024 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08008025 customContent = customContent.clone();
Anthony Chen8f5f3582017-04-11 11:18:37 -07008026 remoteViews.removeAllViewsExceptId(R.id.notification_main_column, R.id.progress);
8027 remoteViews.addView(R.id.notification_main_column, customContent, 0 /* index */);
Selim Cinekfc8073c2017-08-16 17:50:20 -07008028 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08008029 }
Selim Cinek247fa012016-02-18 09:50:48 -08008030 // also update the end margin if there is an image
Selim Cinek384804b2018-04-18 14:31:07 +08008031 Resources resources = mBuilder.mContext.getResources();
8032 int endMargin = resources.getDimensionPixelSize(
Selim Cinek1c72fa02018-04-23 18:00:54 +08008033 R.dimen.notification_content_margin_end) + result.getIconMarginEnd();
Selim Cinek384804b2018-04-18 14:31:07 +08008034 remoteViews.setViewLayoutMarginEnd(R.id.notification_main_column, endMargin);
Selim Cinek247fa012016-02-18 09:50:48 -08008035 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05008036
8037 /**
8038 * @hide
8039 */
8040 @Override
8041 public boolean areNotificationsVisiblyDifferent(Style other) {
8042 if (other == null || getClass() != other.getClass()) {
8043 return true;
8044 }
8045 // Comparison done for all custom RemoteViews, independent of style
8046 return false;
8047 }
Selim Cinek593610c2016-02-16 18:42:57 -08008048 }
8049
Selim Cinek03eb3b72016-02-18 10:39:45 -08008050 /**
8051 * Notification style for media custom views that are decorated by the system
8052 *
8053 * <p>Instead of providing a media notification that is completely custom, a developer can set
8054 * this style and still obtain system decorations like the notification header with the expand
8055 * affordance and actions.
8056 *
8057 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
8058 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
8059 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
8060 * corresponding custom views to display.
Selim Cinek99104832017-01-25 14:47:33 -08008061 * <p>
8062 * Contrary to {@link MediaStyle} a developer has to opt-in to the colorizing of the
8063 * notification by using {@link Notification.Builder#setColorized(boolean)}.
8064 * <p>
Selim Cinek03eb3b72016-02-18 10:39:45 -08008065 * To use this style with your Notification, feed it to
8066 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
8067 * <pre class="prettyprint">
8068 * Notification noti = new Notification.Builder()
8069 * .setSmallIcon(R.drawable.ic_stat_player)
8070 * .setLargeIcon(albumArtBitmap))
8071 * .setCustomContentView(contentView);
8072 * .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b>
8073 * .setMediaSession(mySession))
8074 * .build();
8075 * </pre>
8076 *
8077 * @see android.app.Notification.DecoratedCustomViewStyle
8078 * @see android.app.Notification.MediaStyle
8079 */
8080 public static class DecoratedMediaCustomViewStyle extends MediaStyle {
8081
8082 public DecoratedMediaCustomViewStyle() {
8083 }
8084
Selim Cinek03eb3b72016-02-18 10:39:45 -08008085 /**
8086 * @hide
8087 */
8088 public boolean displayCustomViewInline() {
8089 return true;
8090 }
8091
8092 /**
8093 * @hide
8094 */
8095 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08008096 public RemoteViews makeContentView(boolean increasedHeight) {
8097 RemoteViews remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08008098 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
8099 mBuilder.mN.contentView);
8100 }
8101
8102 /**
8103 * @hide
8104 */
8105 @Override
8106 public RemoteViews makeBigContentView() {
8107 RemoteViews customRemoteView = mBuilder.mN.bigContentView != null
8108 ? mBuilder.mN.bigContentView
8109 : mBuilder.mN.contentView;
8110 return makeBigContentViewWithCustomContent(customRemoteView);
8111 }
8112
8113 private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) {
8114 RemoteViews remoteViews = super.makeBigContentView();
8115 if (remoteViews != null) {
8116 return buildIntoRemoteView(remoteViews, R.id.notification_main_column,
8117 customRemoteView);
8118 } else if (customRemoteView != mBuilder.mN.contentView){
Selim Cinek7d1009b2017-01-25 15:28:28 -08008119 remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08008120 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
8121 customRemoteView);
8122 } else {
8123 return null;
8124 }
8125 }
8126
8127 /**
8128 * @hide
8129 */
8130 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08008131 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek03eb3b72016-02-18 10:39:45 -08008132 RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null
8133 ? mBuilder.mN.headsUpContentView
8134 : mBuilder.mN.contentView;
8135 return makeBigContentViewWithCustomContent(customRemoteView);
8136 }
8137
Julia Reynolds7217dc92018-03-07 12:12:09 -05008138 /**
8139 * @hide
8140 */
8141 @Override
8142 public boolean areNotificationsVisiblyDifferent(Style other) {
8143 if (other == null || getClass() != other.getClass()) {
8144 return true;
8145 }
8146 // Comparison done for all custom RemoteViews, independent of style
8147 return false;
8148 }
8149
Selim Cinek03eb3b72016-02-18 10:39:45 -08008150 private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id,
8151 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08008152 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07008153 // Need to clone customContent before adding, because otherwise it can no longer be
8154 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08008155 customContent = customContent.clone();
Selim Cinek87c31532017-08-18 18:53:44 -07008156 customContent.overrideTextColors(mBuilder.getPrimaryTextColor());
Selim Cinekf91017e2016-03-14 12:25:09 -07008157 remoteViews.removeAllViews(id);
8158 remoteViews.addView(id, customContent);
Selim Cinekfc8073c2017-08-16 17:50:20 -07008159 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08008160 }
Selim Cinek03eb3b72016-02-18 10:39:45 -08008161 return remoteViews;
8162 }
8163 }
8164
Christoph Studer4600f9b2014-07-22 22:44:43 +02008165 // When adding a new Style subclass here, don't forget to update
8166 // Builder.getNotificationStyleClass.
8167
Griff Hazen61a9e862014-05-22 16:05:19 -07008168 /**
8169 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
8170 * metadata or change options on a notification builder.
8171 */
8172 public interface Extender {
8173 /**
8174 * Apply this extender to a notification builder.
8175 * @param builder the builder to be modified.
8176 * @return the build object for chaining.
8177 */
8178 public Builder extend(Builder builder);
8179 }
8180
8181 /**
8182 * Helper class to add wearable extensions to notifications.
8183 * <p class="note"> See
8184 * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications
8185 * for Android Wear</a> for more information on how to use this class.
8186 * <p>
8187 * To create a notification with wearable extensions:
8188 * <ol>
8189 * <li>Create a {@link android.app.Notification.Builder}, setting any desired
8190 * properties.
8191 * <li>Create a {@link android.app.Notification.WearableExtender}.
8192 * <li>Set wearable-specific properties using the
8193 * {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}.
8194 * <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a
8195 * notification.
8196 * <li>Post the notification to the notification system with the
8197 * {@code NotificationManager.notify(...)} methods.
8198 * </ol>
8199 *
8200 * <pre class="prettyprint">
8201 * Notification notif = new Notification.Builder(mContext)
8202 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
8203 * .setContentText(subject)
8204 * .setSmallIcon(R.drawable.new_mail)
8205 * .extend(new Notification.WearableExtender()
8206 * .setContentIcon(R.drawable.new_mail))
8207 * .build();
8208 * NotificationManager notificationManger =
8209 * (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
8210 * notificationManger.notify(0, notif);</pre>
8211 *
8212 * <p>Wearable extensions can be accessed on an existing notification by using the
8213 * {@code WearableExtender(Notification)} constructor,
8214 * and then using the {@code get} methods to access values.
8215 *
8216 * <pre class="prettyprint">
8217 * Notification.WearableExtender wearableExtender = new Notification.WearableExtender(
8218 * notification);
Griff Hazen14f57992014-05-26 09:07:14 -07008219 * List&lt;Notification&gt; pages = wearableExtender.getPages();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07008220 */
8221 public static final class WearableExtender implements Extender {
8222 /**
8223 * Sentinel value for an action index that is unset.
8224 */
8225 public static final int UNSET_ACTION_INDEX = -1;
8226
8227 /**
8228 * Size value for use with {@link #setCustomSizePreset} to show this notification with
8229 * default sizing.
8230 * <p>For custom display notifications created using {@link #setDisplayIntent},
Paul Soulosaa4f4bf2015-08-04 11:59:45 -07008231 * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based
Griff Hazen61a9e862014-05-22 16:05:19 -07008232 * on their content.
8233 */
8234 public static final int SIZE_DEFAULT = 0;
8235
8236 /**
8237 * Size value for use with {@link #setCustomSizePreset} to show this notification
8238 * with an extra small size.
8239 * <p>This value is only applicable for custom display notifications created using
8240 * {@link #setDisplayIntent}.
8241 */
8242 public static final int SIZE_XSMALL = 1;
8243
8244 /**
8245 * Size value for use with {@link #setCustomSizePreset} to show this notification
8246 * with a small size.
8247 * <p>This value is only applicable for custom display notifications created using
8248 * {@link #setDisplayIntent}.
8249 */
8250 public static final int SIZE_SMALL = 2;
8251
8252 /**
8253 * Size value for use with {@link #setCustomSizePreset} to show this notification
8254 * with a medium size.
8255 * <p>This value is only applicable for custom display notifications created using
8256 * {@link #setDisplayIntent}.
8257 */
8258 public static final int SIZE_MEDIUM = 3;
8259
8260 /**
8261 * Size value for use with {@link #setCustomSizePreset} to show this notification
8262 * with a large size.
8263 * <p>This value is only applicable for custom display notifications created using
8264 * {@link #setDisplayIntent}.
8265 */
8266 public static final int SIZE_LARGE = 4;
8267
Griff Hazend5f11f92014-05-27 15:40:09 -07008268 /**
8269 * Size value for use with {@link #setCustomSizePreset} to show this notification
8270 * full screen.
8271 * <p>This value is only applicable for custom display notifications created using
8272 * {@link #setDisplayIntent}.
8273 */
8274 public static final int SIZE_FULL_SCREEN = 5;
8275
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008276 /**
8277 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a
8278 * short amount of time when this notification is displayed on the screen. This
8279 * is the default value.
8280 */
8281 public static final int SCREEN_TIMEOUT_SHORT = 0;
8282
8283 /**
8284 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on
8285 * for a longer amount of time when this notification is displayed on the screen.
8286 */
8287 public static final int SCREEN_TIMEOUT_LONG = -1;
8288
Griff Hazen61a9e862014-05-22 16:05:19 -07008289 /** Notification extra which contains wearable extensions */
8290 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
8291
Pete Gastaf6781d2014-10-07 15:17:05 -04008292 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07008293 private static final String KEY_ACTIONS = "actions";
8294 private static final String KEY_FLAGS = "flags";
8295 private static final String KEY_DISPLAY_INTENT = "displayIntent";
8296 private static final String KEY_PAGES = "pages";
8297 private static final String KEY_BACKGROUND = "background";
8298 private static final String KEY_CONTENT_ICON = "contentIcon";
8299 private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity";
8300 private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex";
8301 private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset";
8302 private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight";
8303 private static final String KEY_GRAVITY = "gravity";
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008304 private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout";
Nadia Benbernou948627e2016-04-14 14:41:08 -04008305 private static final String KEY_DISMISSAL_ID = "dismissalId";
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008306 private static final String KEY_BRIDGE_TAG = "bridgeTag";
Griff Hazen61a9e862014-05-22 16:05:19 -07008307
8308 // Flags bitwise-ored to mFlags
8309 private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1;
8310 private static final int FLAG_HINT_HIDE_ICON = 1 << 1;
8311 private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2;
8312 private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008313 private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4;
Alex Hills4bcb06b2016-04-05 14:26:25 -04008314 private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5;
Alex Hills9ab3a232016-04-05 14:54:56 -04008315 private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6;
Griff Hazen61a9e862014-05-22 16:05:19 -07008316
8317 // Default value for flags integer
8318 private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE;
8319
8320 private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END;
8321 private static final int DEFAULT_GRAVITY = Gravity.BOTTOM;
8322
8323 private ArrayList<Action> mActions = new ArrayList<Action>();
8324 private int mFlags = DEFAULT_FLAGS;
8325 private PendingIntent mDisplayIntent;
8326 private ArrayList<Notification> mPages = new ArrayList<Notification>();
8327 private Bitmap mBackground;
8328 private int mContentIcon;
8329 private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY;
8330 private int mContentActionIndex = UNSET_ACTION_INDEX;
8331 private int mCustomSizePreset = SIZE_DEFAULT;
8332 private int mCustomContentHeight;
8333 private int mGravity = DEFAULT_GRAVITY;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008334 private int mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04008335 private String mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008336 private String mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07008337
8338 /**
8339 * Create a {@link android.app.Notification.WearableExtender} with default
8340 * options.
8341 */
8342 public WearableExtender() {
8343 }
8344
8345 public WearableExtender(Notification notif) {
8346 Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS);
8347 if (wearableBundle != null) {
8348 List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS);
8349 if (actions != null) {
8350 mActions.addAll(actions);
8351 }
8352
8353 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
8354 mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT);
8355
8356 Notification[] pages = getNotificationArrayFromBundle(
8357 wearableBundle, KEY_PAGES);
8358 if (pages != null) {
8359 Collections.addAll(mPages, pages);
8360 }
8361
8362 mBackground = wearableBundle.getParcelable(KEY_BACKGROUND);
8363 mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON);
8364 mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY,
8365 DEFAULT_CONTENT_ICON_GRAVITY);
8366 mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX,
8367 UNSET_ACTION_INDEX);
8368 mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET,
8369 SIZE_DEFAULT);
8370 mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT);
8371 mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY);
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008372 mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT);
Nadia Benbernou948627e2016-04-14 14:41:08 -04008373 mDismissalId = wearableBundle.getString(KEY_DISMISSAL_ID);
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008374 mBridgeTag = wearableBundle.getString(KEY_BRIDGE_TAG);
Griff Hazen61a9e862014-05-22 16:05:19 -07008375 }
8376 }
8377
8378 /**
8379 * Apply wearable extensions to a notification that is being built. This is typically
8380 * called by the {@link android.app.Notification.Builder#extend} method of
8381 * {@link android.app.Notification.Builder}.
8382 */
8383 @Override
8384 public Notification.Builder extend(Notification.Builder builder) {
8385 Bundle wearableBundle = new Bundle();
8386
8387 if (!mActions.isEmpty()) {
8388 wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions);
8389 }
8390 if (mFlags != DEFAULT_FLAGS) {
8391 wearableBundle.putInt(KEY_FLAGS, mFlags);
8392 }
8393 if (mDisplayIntent != null) {
8394 wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent);
8395 }
8396 if (!mPages.isEmpty()) {
8397 wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray(
8398 new Notification[mPages.size()]));
8399 }
8400 if (mBackground != null) {
8401 wearableBundle.putParcelable(KEY_BACKGROUND, mBackground);
8402 }
8403 if (mContentIcon != 0) {
8404 wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon);
8405 }
8406 if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) {
8407 wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity);
8408 }
8409 if (mContentActionIndex != UNSET_ACTION_INDEX) {
8410 wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX,
8411 mContentActionIndex);
8412 }
8413 if (mCustomSizePreset != SIZE_DEFAULT) {
8414 wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset);
8415 }
8416 if (mCustomContentHeight != 0) {
8417 wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight);
8418 }
8419 if (mGravity != DEFAULT_GRAVITY) {
8420 wearableBundle.putInt(KEY_GRAVITY, mGravity);
8421 }
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008422 if (mHintScreenTimeout != 0) {
8423 wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout);
8424 }
Nadia Benbernou948627e2016-04-14 14:41:08 -04008425 if (mDismissalId != null) {
8426 wearableBundle.putString(KEY_DISMISSAL_ID, mDismissalId);
8427 }
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008428 if (mBridgeTag != null) {
8429 wearableBundle.putString(KEY_BRIDGE_TAG, mBridgeTag);
8430 }
Griff Hazen61a9e862014-05-22 16:05:19 -07008431
8432 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
8433 return builder;
8434 }
8435
8436 @Override
8437 public WearableExtender clone() {
8438 WearableExtender that = new WearableExtender();
8439 that.mActions = new ArrayList<Action>(this.mActions);
8440 that.mFlags = this.mFlags;
8441 that.mDisplayIntent = this.mDisplayIntent;
8442 that.mPages = new ArrayList<Notification>(this.mPages);
8443 that.mBackground = this.mBackground;
8444 that.mContentIcon = this.mContentIcon;
8445 that.mContentIconGravity = this.mContentIconGravity;
8446 that.mContentActionIndex = this.mContentActionIndex;
8447 that.mCustomSizePreset = this.mCustomSizePreset;
8448 that.mCustomContentHeight = this.mCustomContentHeight;
8449 that.mGravity = this.mGravity;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008450 that.mHintScreenTimeout = this.mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04008451 that.mDismissalId = this.mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008452 that.mBridgeTag = this.mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07008453 return that;
8454 }
8455
8456 /**
8457 * Add a wearable action to this notification.
8458 *
8459 * <p>When wearable actions are added using this method, the set of actions that
8460 * show on a wearable device splits from devices that only show actions added
8461 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8462 * of which actions display on different devices.
8463 *
8464 * @param action the action to add to this notification
8465 * @return this object for method chaining
8466 * @see android.app.Notification.Action
8467 */
8468 public WearableExtender addAction(Action action) {
8469 mActions.add(action);
8470 return this;
8471 }
8472
8473 /**
8474 * Adds wearable actions to this notification.
8475 *
8476 * <p>When wearable actions are added using this method, the set of actions that
8477 * show on a wearable device splits from devices that only show actions added
8478 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8479 * of which actions display on different devices.
8480 *
8481 * @param actions the actions to add to this notification
8482 * @return this object for method chaining
8483 * @see android.app.Notification.Action
8484 */
8485 public WearableExtender addActions(List<Action> actions) {
8486 mActions.addAll(actions);
8487 return this;
8488 }
8489
8490 /**
8491 * Clear all wearable actions present on this builder.
8492 * @return this object for method chaining.
8493 * @see #addAction
8494 */
8495 public WearableExtender clearActions() {
8496 mActions.clear();
8497 return this;
8498 }
8499
8500 /**
8501 * Get the wearable actions present on this notification.
8502 */
8503 public List<Action> getActions() {
8504 return mActions;
8505 }
8506
8507 /**
8508 * Set an intent to launch inside of an activity view when displaying
Griff Hazen14f57992014-05-26 09:07:14 -07008509 * this notification. The {@link PendingIntent} provided should be for an activity.
8510 *
8511 * <pre class="prettyprint">
8512 * Intent displayIntent = new Intent(context, MyDisplayActivity.class);
8513 * PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
8514 * 0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
8515 * Notification notif = new Notification.Builder(context)
8516 * .extend(new Notification.WearableExtender()
8517 * .setDisplayIntent(displayPendingIntent)
8518 * .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM))
8519 * .build();</pre>
8520 *
8521 * <p>The activity to launch needs to allow embedding, must be exported, and
Griff Hazen831ca9d2014-06-17 00:38:38 -07008522 * should have an empty task affinity. It is also recommended to use the device
8523 * default light theme.
Griff Hazen14f57992014-05-26 09:07:14 -07008524 *
8525 * <p>Example AndroidManifest.xml entry:
8526 * <pre class="prettyprint">
8527 * &lt;activity android:name=&quot;com.example.MyDisplayActivity&quot;
8528 * android:exported=&quot;true&quot;
8529 * android:allowEmbedded=&quot;true&quot;
Griff Hazen831ca9d2014-06-17 00:38:38 -07008530 * android:taskAffinity=&quot;&quot;
8531 * android:theme=&quot;@android:style/Theme.DeviceDefault.Light&quot; /&gt;</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07008532 *
8533 * @param intent the {@link PendingIntent} for an activity
8534 * @return this object for method chaining
8535 * @see android.app.Notification.WearableExtender#getDisplayIntent
8536 */
8537 public WearableExtender setDisplayIntent(PendingIntent intent) {
8538 mDisplayIntent = intent;
8539 return this;
8540 }
8541
8542 /**
8543 * Get the intent to launch inside of an activity view when displaying this
8544 * notification. This {@code PendingIntent} should be for an activity.
8545 */
8546 public PendingIntent getDisplayIntent() {
8547 return mDisplayIntent;
8548 }
8549
8550 /**
8551 * Add an additional page of content to display with this notification. The current
8552 * notification forms the first page, and pages added using this function form
8553 * subsequent pages. This field can be used to separate a notification into multiple
8554 * sections.
8555 *
8556 * @param page the notification to add as another page
8557 * @return this object for method chaining
8558 * @see android.app.Notification.WearableExtender#getPages
8559 */
8560 public WearableExtender addPage(Notification page) {
8561 mPages.add(page);
8562 return this;
8563 }
8564
8565 /**
8566 * Add additional pages of content to display with this notification. The current
8567 * notification forms the first page, and pages added using this function form
8568 * subsequent pages. This field can be used to separate a notification into multiple
8569 * sections.
8570 *
8571 * @param pages a list of notifications
8572 * @return this object for method chaining
8573 * @see android.app.Notification.WearableExtender#getPages
8574 */
8575 public WearableExtender addPages(List<Notification> pages) {
8576 mPages.addAll(pages);
8577 return this;
8578 }
8579
8580 /**
8581 * Clear all additional pages present on this builder.
8582 * @return this object for method chaining.
8583 * @see #addPage
8584 */
8585 public WearableExtender clearPages() {
8586 mPages.clear();
8587 return this;
8588 }
8589
8590 /**
8591 * Get the array of additional pages of content for displaying this notification. The
8592 * current notification forms the first page, and elements within this array form
8593 * subsequent pages. This field can be used to separate a notification into multiple
8594 * sections.
8595 * @return the pages for this notification
8596 */
8597 public List<Notification> getPages() {
8598 return mPages;
8599 }
8600
8601 /**
8602 * Set a background image to be displayed behind the notification content.
8603 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8604 * will work with any notification style.
8605 *
8606 * @param background the background bitmap
8607 * @return this object for method chaining
8608 * @see android.app.Notification.WearableExtender#getBackground
8609 */
8610 public WearableExtender setBackground(Bitmap background) {
8611 mBackground = background;
8612 return this;
8613 }
8614
8615 /**
8616 * Get a background image to be displayed behind the notification content.
8617 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8618 * will work with any notification style.
8619 *
8620 * @return the background image
8621 * @see android.app.Notification.WearableExtender#setBackground
8622 */
8623 public Bitmap getBackground() {
8624 return mBackground;
8625 }
8626
8627 /**
8628 * Set an icon that goes with the content of this notification.
8629 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008630 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008631 public WearableExtender setContentIcon(int icon) {
8632 mContentIcon = icon;
8633 return this;
8634 }
8635
8636 /**
8637 * Get an icon that goes with the content of this notification.
8638 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008639 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008640 public int getContentIcon() {
8641 return mContentIcon;
8642 }
8643
8644 /**
8645 * Set the gravity that the content icon should have within the notification display.
8646 * Supported values include {@link android.view.Gravity#START} and
8647 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8648 * @see #setContentIcon
8649 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008650 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008651 public WearableExtender setContentIconGravity(int contentIconGravity) {
8652 mContentIconGravity = contentIconGravity;
8653 return this;
8654 }
8655
8656 /**
8657 * Get the gravity that the content icon should have within the notification display.
8658 * Supported values include {@link android.view.Gravity#START} and
8659 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8660 * @see #getContentIcon
8661 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008662 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008663 public int getContentIconGravity() {
8664 return mContentIconGravity;
8665 }
8666
8667 /**
8668 * Set an action from this notification's actions to be clickable with the content of
Griff Hazen14f57992014-05-26 09:07:14 -07008669 * this notification. This action will no longer display separately from the
8670 * notification's content.
8671 *
Griff Hazenca48d352014-05-28 22:37:13 -07008672 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008673 * set, although the list of available actions comes from the main notification and not
8674 * from the child page's notification.
8675 *
8676 * @param actionIndex The index of the action to hoist onto the current notification page.
8677 * If wearable actions were added to the main notification, this index
8678 * will apply to that list, otherwise it will apply to the regular
8679 * actions list.
Griff Hazen61a9e862014-05-22 16:05:19 -07008680 */
8681 public WearableExtender setContentAction(int actionIndex) {
8682 mContentActionIndex = actionIndex;
8683 return this;
8684 }
8685
8686 /**
Griff Hazenca48d352014-05-28 22:37:13 -07008687 * Get the index of the notification action, if any, that was specified as being clickable
8688 * with the content of this notification. This action will no longer display separately
Griff Hazen14f57992014-05-26 09:07:14 -07008689 * from the notification's content.
Griff Hazen61a9e862014-05-22 16:05:19 -07008690 *
Griff Hazenca48d352014-05-28 22:37:13 -07008691 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008692 * set, although the list of available actions comes from the main notification and not
8693 * from the child page's notification.
8694 *
8695 * <p>If wearable specific actions were added to the main notification, this index will
8696 * apply to that list, otherwise it will apply to the regular actions list.
Griff Hazenca48d352014-05-28 22:37:13 -07008697 *
8698 * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected.
Griff Hazen61a9e862014-05-22 16:05:19 -07008699 */
8700 public int getContentAction() {
8701 return mContentActionIndex;
8702 }
8703
8704 /**
8705 * Set the gravity that this notification should have within the available viewport space.
8706 * Supported values include {@link android.view.Gravity#TOP},
8707 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8708 * The default value is {@link android.view.Gravity#BOTTOM}.
8709 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008710 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008711 public WearableExtender setGravity(int gravity) {
8712 mGravity = gravity;
8713 return this;
8714 }
8715
8716 /**
8717 * Get the gravity that this notification should have within the available viewport space.
8718 * Supported values include {@link android.view.Gravity#TOP},
8719 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8720 * The default value is {@link android.view.Gravity#BOTTOM}.
8721 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008722 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008723 public int getGravity() {
8724 return mGravity;
8725 }
8726
8727 /**
8728 * Set the custom size preset for the display of this notification out of the available
8729 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8730 * {@link #SIZE_LARGE}.
8731 * <p>Some custom size presets are only applicable for custom display notifications created
8732 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the
8733 * documentation for the preset in question. See also
8734 * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}.
8735 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008736 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008737 public WearableExtender setCustomSizePreset(int sizePreset) {
8738 mCustomSizePreset = sizePreset;
8739 return this;
8740 }
8741
8742 /**
8743 * Get the custom size preset for the display of this notification out of the available
8744 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8745 * {@link #SIZE_LARGE}.
8746 * <p>Some custom size presets are only applicable for custom display notifications created
8747 * using {@link #setDisplayIntent}. Check the documentation for the preset in question.
8748 * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}.
8749 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008750 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008751 public int getCustomSizePreset() {
8752 return mCustomSizePreset;
8753 }
8754
8755 /**
8756 * Set the custom height in pixels for the display of this notification's content.
8757 * <p>This option is only available for custom display notifications created
8758 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also
8759 * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and
8760 * {@link #getCustomContentHeight}.
8761 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008762 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008763 public WearableExtender setCustomContentHeight(int height) {
8764 mCustomContentHeight = height;
8765 return this;
8766 }
8767
8768 /**
8769 * Get the custom height in pixels for the display of this notification's content.
8770 * <p>This option is only available for custom display notifications created
8771 * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and
8772 * {@link #setCustomContentHeight}.
8773 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008774 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008775 public int getCustomContentHeight() {
8776 return mCustomContentHeight;
8777 }
8778
8779 /**
8780 * Set whether the scrolling position for the contents of this notification should start
8781 * at the bottom of the contents instead of the top when the contents are too long to
8782 * display within the screen. Default is false (start scroll at the top).
8783 */
8784 public WearableExtender setStartScrollBottom(boolean startScrollBottom) {
8785 setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom);
8786 return this;
8787 }
8788
8789 /**
8790 * Get whether the scrolling position for the contents of this notification should start
8791 * at the bottom of the contents instead of the top when the contents are too long to
8792 * display within the screen. Default is false (start scroll at the top).
8793 */
8794 public boolean getStartScrollBottom() {
8795 return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0;
8796 }
8797
8798 /**
8799 * Set whether the content intent is available when the wearable device is not connected
8800 * to a companion device. The user can still trigger this intent when the wearable device
8801 * is offline, but a visual hint will indicate that the content intent may not be available.
8802 * Defaults to true.
8803 */
8804 public WearableExtender setContentIntentAvailableOffline(
8805 boolean contentIntentAvailableOffline) {
8806 setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline);
8807 return this;
8808 }
8809
8810 /**
8811 * Get whether the content intent is available when the wearable device is not connected
8812 * to a companion device. The user can still trigger this intent when the wearable device
8813 * is offline, but a visual hint will indicate that the content intent may not be available.
8814 * Defaults to true.
8815 */
8816 public boolean getContentIntentAvailableOffline() {
8817 return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0;
8818 }
8819
8820 /**
8821 * Set a hint that this notification's icon should not be displayed.
8822 * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise.
8823 * @return this object for method chaining
8824 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008825 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008826 public WearableExtender setHintHideIcon(boolean hintHideIcon) {
8827 setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon);
8828 return this;
8829 }
8830
8831 /**
8832 * Get a hint that this notification's icon should not be displayed.
8833 * @return {@code true} if this icon should not be displayed, false otherwise.
8834 * The default value is {@code false} if this was never set.
8835 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008836 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008837 public boolean getHintHideIcon() {
8838 return (mFlags & FLAG_HINT_HIDE_ICON) != 0;
8839 }
8840
8841 /**
8842 * Set a visual hint that only the background image of this notification should be
8843 * displayed, and other semantic content should be hidden. This hint is only applicable
8844 * to sub-pages added using {@link #addPage}.
8845 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008846 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008847 public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) {
8848 setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly);
8849 return this;
8850 }
8851
8852 /**
8853 * Get a visual hint that only the background image of this notification should be
8854 * displayed, and other semantic content should be hidden. This hint is only applicable
8855 * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}.
8856 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008857 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008858 public boolean getHintShowBackgroundOnly() {
8859 return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0;
8860 }
8861
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008862 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008863 * Set a hint that this notification's background should not be clipped if possible,
8864 * and should instead be resized to fully display on the screen, retaining the aspect
8865 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008866 * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
8867 * @return this object for method chaining
8868 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008869 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008870 public WearableExtender setHintAvoidBackgroundClipping(
8871 boolean hintAvoidBackgroundClipping) {
8872 setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping);
8873 return this;
8874 }
8875
8876 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008877 * Get a hint that this notification's background should not be clipped if possible,
8878 * and should instead be resized to fully display on the screen, retaining the aspect
8879 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008880 * @return {@code true} if it's ok if the background is clipped on the screen, false
8881 * otherwise. The default value is {@code false} if this was never set.
8882 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008883 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008884 public boolean getHintAvoidBackgroundClipping() {
8885 return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0;
8886 }
8887
8888 /**
8889 * Set a hint that the screen should remain on for at least this duration when
8890 * this notification is displayed on the screen.
8891 * @param timeout The requested screen timeout in milliseconds. Can also be either
8892 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8893 * @return this object for method chaining
8894 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008895 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008896 public WearableExtender setHintScreenTimeout(int timeout) {
8897 mHintScreenTimeout = timeout;
8898 return this;
8899 }
8900
8901 /**
8902 * Get the duration, in milliseconds, that the screen should remain on for
8903 * when this notification is displayed.
8904 * @return the duration in milliseconds if > 0, or either one of the sentinel values
8905 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8906 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008907 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008908 public int getHintScreenTimeout() {
8909 return mHintScreenTimeout;
8910 }
8911
Alex Hills9ab3a232016-04-05 14:54:56 -04008912 /**
Alex Hills4bcb06b2016-04-05 14:26:25 -04008913 * Set a hint that this notification's {@link BigPictureStyle} (if present) should be
8914 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8915 * qr codes, as well as other simple black-and-white tickets.
8916 * @param hintAmbientBigPicture {@code true} to enable converstion and ambient.
8917 * @return this object for method chaining
8918 */
8919 public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) {
8920 setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture);
8921 return this;
8922 }
8923
8924 /**
8925 * Get a hint that this notification's {@link BigPictureStyle} (if present) should be
8926 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8927 * qr codes, as well as other simple black-and-white tickets.
8928 * @return {@code true} if it should be displayed in ambient, false otherwise
8929 * otherwise. The default value is {@code false} if this was never set.
8930 */
8931 public boolean getHintAmbientBigPicture() {
8932 return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0;
8933 }
8934
8935 /**
Alex Hills9ab3a232016-04-05 14:54:56 -04008936 * Set a hint that this notification's content intent will launch an {@link Activity}
8937 * directly, telling the platform that it can generate the appropriate transitions.
8938 * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch
8939 * an activity and transitions should be generated, false otherwise.
8940 * @return this object for method chaining
8941 */
8942 public WearableExtender setHintContentIntentLaunchesActivity(
8943 boolean hintContentIntentLaunchesActivity) {
8944 setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity);
8945 return this;
8946 }
8947
8948 /**
8949 * Get a hint that this notification's content intent will launch an {@link Activity}
8950 * directly, telling the platform that it can generate the appropriate transitions
8951 * @return {@code true} if the content intent will launch an activity and transitions should
8952 * be generated, false otherwise. The default value is {@code false} if this was never set.
8953 */
8954 public boolean getHintContentIntentLaunchesActivity() {
8955 return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0;
8956 }
8957
Nadia Benbernou948627e2016-04-14 14:41:08 -04008958 /**
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008959 * Sets the dismissal id for this notification. If a notification is posted with a
8960 * dismissal id, then when that notification is canceled, notifications on other wearables
8961 * and the paired Android phone having that same dismissal id will also be canceled. See
Nadia Benbernou948627e2016-04-14 14:41:08 -04008962 * <a href="{@docRoot}wear/notifications/index.html">Adding Wearable Features to
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008963 * Notifications</a> for more information.
Nadia Benbernou948627e2016-04-14 14:41:08 -04008964 * @param dismissalId the dismissal id of the notification.
8965 * @return this object for method chaining
8966 */
8967 public WearableExtender setDismissalId(String dismissalId) {
8968 mDismissalId = dismissalId;
8969 return this;
8970 }
8971
8972 /**
8973 * Returns the dismissal id of the notification.
8974 * @return the dismissal id of the notification or null if it has not been set.
8975 */
8976 public String getDismissalId() {
8977 return mDismissalId;
8978 }
8979
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008980 /**
8981 * Sets a bridge tag for this notification. A bridge tag can be set for notifications
8982 * posted from a phone to provide finer-grained control on what notifications are bridged
8983 * to wearables. See <a href="{@docRoot}wear/notifications/index.html">Adding Wearable
8984 * Features to Notifications</a> for more information.
8985 * @param bridgeTag the bridge tag of the notification.
8986 * @return this object for method chaining
8987 */
8988 public WearableExtender setBridgeTag(String bridgeTag) {
8989 mBridgeTag = bridgeTag;
8990 return this;
8991 }
8992
8993 /**
8994 * Returns the bridge tag of the notification.
8995 * @return the bridge tag or null if not present.
8996 */
8997 public String getBridgeTag() {
8998 return mBridgeTag;
8999 }
9000
Griff Hazen61a9e862014-05-22 16:05:19 -07009001 private void setFlag(int mask, boolean value) {
9002 if (value) {
9003 mFlags |= mask;
9004 } else {
9005 mFlags &= ~mask;
9006 }
9007 }
9008 }
9009
9010 /**
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009011 * <p>Helper class to add Android Auto extensions to notifications. To create a notification
9012 * with car extensions:
9013 *
9014 * <ol>
9015 * <li>Create an {@link Notification.Builder}, setting any desired
9016 * properties.
9017 * <li>Create a {@link CarExtender}.
9018 * <li>Set car-specific properties using the {@code add} and {@code set} methods of
9019 * {@link CarExtender}.
9020 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
9021 * to apply the extensions to a notification.
9022 * </ol>
9023 *
9024 * <pre class="prettyprint">
9025 * Notification notification = new Notification.Builder(context)
9026 * ...
9027 * .extend(new CarExtender()
9028 * .set*(...))
9029 * .build();
9030 * </pre>
9031 *
9032 * <p>Car extensions can be accessed on an existing notification by using the
9033 * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods
9034 * to access values.
9035 */
9036 public static final class CarExtender implements Extender {
9037 private static final String TAG = "CarExtender";
9038
9039 private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS";
9040 private static final String EXTRA_LARGE_ICON = "large_icon";
9041 private static final String EXTRA_CONVERSATION = "car_conversation";
9042 private static final String EXTRA_COLOR = "app_color";
9043
9044 private Bitmap mLargeIcon;
9045 private UnreadConversation mUnreadConversation;
9046 private int mColor = Notification.COLOR_DEFAULT;
9047
9048 /**
9049 * Create a {@link CarExtender} with default options.
9050 */
9051 public CarExtender() {
9052 }
9053
9054 /**
9055 * Create a {@link CarExtender} from the CarExtender options of an existing Notification.
9056 *
9057 * @param notif The notification from which to copy options.
9058 */
9059 public CarExtender(Notification notif) {
9060 Bundle carBundle = notif.extras == null ?
9061 null : notif.extras.getBundle(EXTRA_CAR_EXTENDER);
9062 if (carBundle != null) {
9063 mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON);
9064 mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT);
9065
9066 Bundle b = carBundle.getBundle(EXTRA_CONVERSATION);
9067 mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b);
9068 }
9069 }
9070
9071 /**
9072 * Apply car extensions to a notification that is being built. This is typically called by
9073 * the {@link Notification.Builder#extend(Notification.Extender)}
9074 * method of {@link Notification.Builder}.
9075 */
9076 @Override
9077 public Notification.Builder extend(Notification.Builder builder) {
9078 Bundle carExtensions = new Bundle();
9079
9080 if (mLargeIcon != null) {
9081 carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon);
9082 }
9083 if (mColor != Notification.COLOR_DEFAULT) {
9084 carExtensions.putInt(EXTRA_COLOR, mColor);
9085 }
9086
9087 if (mUnreadConversation != null) {
9088 Bundle b = mUnreadConversation.getBundleForUnreadConversation();
9089 carExtensions.putBundle(EXTRA_CONVERSATION, b);
9090 }
9091
9092 builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions);
9093 return builder;
9094 }
9095
9096 /**
9097 * Sets the accent color to use when Android Auto presents the notification.
9098 *
9099 * Android Auto uses the color set with {@link Notification.Builder#setColor(int)}
9100 * to accent the displayed notification. However, not all colors are acceptable in an
9101 * automotive setting. This method can be used to override the color provided in the
9102 * notification in such a situation.
9103 */
Tor Norbye80756e32015-03-02 09:39:27 -08009104 public CarExtender setColor(@ColorInt int color) {
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009105 mColor = color;
9106 return this;
9107 }
9108
9109 /**
9110 * Gets the accent color.
9111 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04009112 * @see #setColor
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009113 */
Tor Norbye80756e32015-03-02 09:39:27 -08009114 @ColorInt
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009115 public int getColor() {
9116 return mColor;
9117 }
9118
9119 /**
9120 * Sets the large icon of the car notification.
9121 *
9122 * If no large icon is set in the extender, Android Auto will display the icon
9123 * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)}
9124 *
9125 * @param largeIcon The large icon to use in the car notification.
9126 * @return This object for method chaining.
9127 */
9128 public CarExtender setLargeIcon(Bitmap largeIcon) {
9129 mLargeIcon = largeIcon;
9130 return this;
9131 }
9132
9133 /**
9134 * Gets the large icon used in this car notification, or null if no icon has been set.
9135 *
9136 * @return The large icon for the car notification.
9137 * @see CarExtender#setLargeIcon
9138 */
9139 public Bitmap getLargeIcon() {
9140 return mLargeIcon;
9141 }
9142
9143 /**
9144 * Sets the unread conversation in a message notification.
9145 *
9146 * @param unreadConversation The unread part of the conversation this notification conveys.
9147 * @return This object for method chaining.
9148 */
9149 public CarExtender setUnreadConversation(UnreadConversation unreadConversation) {
9150 mUnreadConversation = unreadConversation;
9151 return this;
9152 }
9153
9154 /**
9155 * Returns the unread conversation conveyed by this notification.
9156 * @see #setUnreadConversation(UnreadConversation)
9157 */
9158 public UnreadConversation getUnreadConversation() {
9159 return mUnreadConversation;
9160 }
9161
9162 /**
9163 * A class which holds the unread messages from a conversation.
9164 */
9165 public static class UnreadConversation {
9166 private static final String KEY_AUTHOR = "author";
9167 private static final String KEY_TEXT = "text";
9168 private static final String KEY_MESSAGES = "messages";
9169 private static final String KEY_REMOTE_INPUT = "remote_input";
9170 private static final String KEY_ON_REPLY = "on_reply";
9171 private static final String KEY_ON_READ = "on_read";
9172 private static final String KEY_PARTICIPANTS = "participants";
9173 private static final String KEY_TIMESTAMP = "timestamp";
9174
9175 private final String[] mMessages;
9176 private final RemoteInput mRemoteInput;
9177 private final PendingIntent mReplyPendingIntent;
9178 private final PendingIntent mReadPendingIntent;
9179 private final String[] mParticipants;
9180 private final long mLatestTimestamp;
9181
9182 UnreadConversation(String[] messages, RemoteInput remoteInput,
9183 PendingIntent replyPendingIntent, PendingIntent readPendingIntent,
9184 String[] participants, long latestTimestamp) {
9185 mMessages = messages;
9186 mRemoteInput = remoteInput;
9187 mReadPendingIntent = readPendingIntent;
9188 mReplyPendingIntent = replyPendingIntent;
9189 mParticipants = participants;
9190 mLatestTimestamp = latestTimestamp;
9191 }
9192
9193 /**
9194 * Gets the list of messages conveyed by this notification.
9195 */
9196 public String[] getMessages() {
9197 return mMessages;
9198 }
9199
9200 /**
9201 * Gets the remote input that will be used to convey the response to a message list, or
9202 * null if no such remote input exists.
9203 */
9204 public RemoteInput getRemoteInput() {
9205 return mRemoteInput;
9206 }
9207
9208 /**
9209 * Gets the pending intent that will be triggered when the user replies to this
9210 * notification.
9211 */
9212 public PendingIntent getReplyPendingIntent() {
9213 return mReplyPendingIntent;
9214 }
9215
9216 /**
9217 * Gets the pending intent that Android Auto will send after it reads aloud all messages
9218 * in this object's message list.
9219 */
9220 public PendingIntent getReadPendingIntent() {
9221 return mReadPendingIntent;
9222 }
9223
9224 /**
9225 * Gets the participants in the conversation.
9226 */
9227 public String[] getParticipants() {
9228 return mParticipants;
9229 }
9230
9231 /**
9232 * Gets the firs participant in the conversation.
9233 */
9234 public String getParticipant() {
9235 return mParticipants.length > 0 ? mParticipants[0] : null;
9236 }
9237
9238 /**
9239 * Gets the timestamp of the conversation.
9240 */
9241 public long getLatestTimestamp() {
9242 return mLatestTimestamp;
9243 }
9244
9245 Bundle getBundleForUnreadConversation() {
9246 Bundle b = new Bundle();
9247 String author = null;
9248 if (mParticipants != null && mParticipants.length > 1) {
9249 author = mParticipants[0];
9250 }
9251 Parcelable[] messages = new Parcelable[mMessages.length];
9252 for (int i = 0; i < messages.length; i++) {
9253 Bundle m = new Bundle();
9254 m.putString(KEY_TEXT, mMessages[i]);
9255 m.putString(KEY_AUTHOR, author);
9256 messages[i] = m;
9257 }
9258 b.putParcelableArray(KEY_MESSAGES, messages);
9259 if (mRemoteInput != null) {
9260 b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput);
9261 }
9262 b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent);
9263 b.putParcelable(KEY_ON_READ, mReadPendingIntent);
9264 b.putStringArray(KEY_PARTICIPANTS, mParticipants);
9265 b.putLong(KEY_TIMESTAMP, mLatestTimestamp);
9266 return b;
9267 }
9268
9269 static UnreadConversation getUnreadConversationFromBundle(Bundle b) {
9270 if (b == null) {
9271 return null;
9272 }
9273 Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES);
9274 String[] messages = null;
9275 if (parcelableMessages != null) {
9276 String[] tmp = new String[parcelableMessages.length];
9277 boolean success = true;
9278 for (int i = 0; i < tmp.length; i++) {
9279 if (!(parcelableMessages[i] instanceof Bundle)) {
9280 success = false;
9281 break;
9282 }
9283 tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT);
9284 if (tmp[i] == null) {
9285 success = false;
9286 break;
9287 }
9288 }
9289 if (success) {
9290 messages = tmp;
9291 } else {
9292 return null;
9293 }
9294 }
9295
9296 PendingIntent onRead = b.getParcelable(KEY_ON_READ);
9297 PendingIntent onReply = b.getParcelable(KEY_ON_REPLY);
9298
9299 RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT);
9300
9301 String[] participants = b.getStringArray(KEY_PARTICIPANTS);
9302 if (participants == null || participants.length != 1) {
9303 return null;
9304 }
9305
9306 return new UnreadConversation(messages,
9307 remoteInput,
9308 onReply,
9309 onRead,
9310 participants, b.getLong(KEY_TIMESTAMP));
9311 }
9312 };
9313
9314 /**
9315 * Builder class for {@link CarExtender.UnreadConversation} objects.
9316 */
9317 public static class Builder {
9318 private final List<String> mMessages = new ArrayList<String>();
9319 private final String mParticipant;
9320 private RemoteInput mRemoteInput;
9321 private PendingIntent mReadPendingIntent;
9322 private PendingIntent mReplyPendingIntent;
9323 private long mLatestTimestamp;
9324
9325 /**
9326 * Constructs a new builder for {@link CarExtender.UnreadConversation}.
9327 *
9328 * @param name The name of the other participant in the conversation.
9329 */
9330 public Builder(String name) {
9331 mParticipant = name;
9332 }
9333
9334 /**
9335 * Appends a new unread message to the list of messages for this conversation.
9336 *
9337 * The messages should be added from oldest to newest.
9338 *
9339 * @param message The text of the new unread message.
9340 * @return This object for method chaining.
9341 */
9342 public Builder addMessage(String message) {
9343 mMessages.add(message);
9344 return this;
9345 }
9346
9347 /**
9348 * Sets the pending intent and remote input which will convey the reply to this
9349 * notification.
9350 *
9351 * @param pendingIntent The pending intent which will be triggered on a reply.
9352 * @param remoteInput The remote input parcelable which will carry the reply.
9353 * @return This object for method chaining.
9354 *
9355 * @see CarExtender.UnreadConversation#getRemoteInput
9356 * @see CarExtender.UnreadConversation#getReplyPendingIntent
9357 */
9358 public Builder setReplyAction(
9359 PendingIntent pendingIntent, RemoteInput remoteInput) {
9360 mRemoteInput = remoteInput;
9361 mReplyPendingIntent = pendingIntent;
9362
9363 return this;
9364 }
9365
9366 /**
9367 * Sets the pending intent that will be sent once the messages in this notification
9368 * are read.
9369 *
9370 * @param pendingIntent The pending intent to use.
9371 * @return This object for method chaining.
9372 */
9373 public Builder setReadPendingIntent(PendingIntent pendingIntent) {
9374 mReadPendingIntent = pendingIntent;
9375 return this;
9376 }
9377
9378 /**
9379 * Sets the timestamp of the most recent message in an unread conversation.
9380 *
9381 * If a messaging notification has been posted by your application and has not
9382 * yet been cancelled, posting a later notification with the same id and tag
9383 * but without a newer timestamp may result in Android Auto not displaying a
9384 * heads up notification for the later notification.
9385 *
9386 * @param timestamp The timestamp of the most recent message in the conversation.
9387 * @return This object for method chaining.
9388 */
9389 public Builder setLatestTimestamp(long timestamp) {
9390 mLatestTimestamp = timestamp;
9391 return this;
9392 }
9393
9394 /**
9395 * Builds a new unread conversation object.
9396 *
9397 * @return The new unread conversation object.
9398 */
9399 public UnreadConversation build() {
9400 String[] messages = mMessages.toArray(new String[mMessages.size()]);
9401 String[] participants = { mParticipant };
9402 return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent,
9403 mReadPendingIntent, participants, mLatestTimestamp);
9404 }
9405 }
9406 }
9407
9408 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009409 * <p>Helper class to add Android TV extensions to notifications. To create a notification
9410 * with a TV extension:
9411 *
9412 * <ol>
9413 * <li>Create an {@link Notification.Builder}, setting any desired properties.
9414 * <li>Create a {@link TvExtender}.
9415 * <li>Set TV-specific properties using the {@code set} methods of
9416 * {@link TvExtender}.
9417 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
9418 * to apply the extension to a notification.
9419 * </ol>
9420 *
9421 * <pre class="prettyprint">
9422 * Notification notification = new Notification.Builder(context)
9423 * ...
9424 * .extend(new TvExtender()
9425 * .set*(...))
9426 * .build();
9427 * </pre>
9428 *
9429 * <p>TV extensions can be accessed on an existing notification by using the
9430 * {@code TvExtender(Notification)} constructor, and then using the {@code get} methods
9431 * to access values.
9432 *
9433 * @hide
9434 */
9435 @SystemApi
9436 public static final class TvExtender implements Extender {
9437 private static final String TAG = "TvExtender";
9438
9439 private static final String EXTRA_TV_EXTENDER = "android.tv.EXTENSIONS";
9440 private static final String EXTRA_FLAGS = "flags";
9441 private static final String EXTRA_CONTENT_INTENT = "content_intent";
9442 private static final String EXTRA_DELETE_INTENT = "delete_intent";
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009443 private static final String EXTRA_CHANNEL_ID = "channel_id";
Rhiannon Malia1a083932018-01-24 15:02:30 -08009444 private static final String EXTRA_SUPPRESS_SHOW_OVER_APPS = "suppressShowOverApps";
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009445
9446 // Flags bitwise-ored to mFlags
9447 private static final int FLAG_AVAILABLE_ON_TV = 0x1;
9448
9449 private int mFlags;
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009450 private String mChannelId;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009451 private PendingIntent mContentIntent;
9452 private PendingIntent mDeleteIntent;
Rhiannon Malia1a083932018-01-24 15:02:30 -08009453 private boolean mSuppressShowOverApps;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009454
9455 /**
9456 * Create a {@link TvExtender} with default options.
9457 */
9458 public TvExtender() {
9459 mFlags = FLAG_AVAILABLE_ON_TV;
9460 }
9461
9462 /**
9463 * Create a {@link TvExtender} from the TvExtender options of an existing Notification.
9464 *
9465 * @param notif The notification from which to copy options.
9466 */
9467 public TvExtender(Notification notif) {
9468 Bundle bundle = notif.extras == null ?
9469 null : notif.extras.getBundle(EXTRA_TV_EXTENDER);
9470 if (bundle != null) {
9471 mFlags = bundle.getInt(EXTRA_FLAGS);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009472 mChannelId = bundle.getString(EXTRA_CHANNEL_ID);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009473 mSuppressShowOverApps = bundle.getBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009474 mContentIntent = bundle.getParcelable(EXTRA_CONTENT_INTENT);
9475 mDeleteIntent = bundle.getParcelable(EXTRA_DELETE_INTENT);
9476 }
9477 }
9478
9479 /**
9480 * Apply a TV extension to a notification that is being built. This is typically called by
9481 * the {@link Notification.Builder#extend(Notification.Extender)}
9482 * method of {@link Notification.Builder}.
9483 */
9484 @Override
9485 public Notification.Builder extend(Notification.Builder builder) {
9486 Bundle bundle = new Bundle();
9487
9488 bundle.putInt(EXTRA_FLAGS, mFlags);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009489 bundle.putString(EXTRA_CHANNEL_ID, mChannelId);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009490 bundle.putBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS, mSuppressShowOverApps);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009491 if (mContentIntent != null) {
9492 bundle.putParcelable(EXTRA_CONTENT_INTENT, mContentIntent);
9493 }
9494
9495 if (mDeleteIntent != null) {
9496 bundle.putParcelable(EXTRA_DELETE_INTENT, mDeleteIntent);
9497 }
9498
9499 builder.getExtras().putBundle(EXTRA_TV_EXTENDER, bundle);
9500 return builder;
9501 }
9502
9503 /**
9504 * Returns true if this notification should be shown on TV. This method return true
9505 * if the notification was extended with a TvExtender.
9506 */
9507 public boolean isAvailableOnTv() {
9508 return (mFlags & FLAG_AVAILABLE_ON_TV) != 0;
9509 }
9510
9511 /**
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009512 * Specifies the channel the notification should be delivered on when shown on TV.
9513 * It can be different from the channel that the notification is delivered to when
9514 * posting on a non-TV device.
9515 */
9516 public TvExtender setChannel(String channelId) {
9517 mChannelId = channelId;
9518 return this;
9519 }
9520
9521 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009522 * Specifies the channel the notification should be delivered on when shown on TV.
9523 * It can be different from the channel that the notification is delivered to when
9524 * posting on a non-TV device.
9525 */
9526 public TvExtender setChannelId(String channelId) {
9527 mChannelId = channelId;
9528 return this;
9529 }
9530
Jeff Sharkey000ce802017-04-29 13:13:27 -06009531 /** @removed */
9532 @Deprecated
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009533 public String getChannel() {
9534 return mChannelId;
9535 }
9536
9537 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009538 * Returns the id of the channel this notification posts to on TV.
9539 */
9540 public String getChannelId() {
9541 return mChannelId;
9542 }
9543
9544 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009545 * Supplies a {@link PendingIntent} to be sent when the notification is selected on TV.
9546 * If provided, it is used instead of the content intent specified
9547 * at the level of Notification.
9548 */
9549 public TvExtender setContentIntent(PendingIntent intent) {
9550 mContentIntent = intent;
9551 return this;
9552 }
9553
9554 /**
9555 * Returns the TV-specific content intent. If this method returns null, the
9556 * main content intent on the notification should be used.
9557 *
9558 * @see {@link Notification#contentIntent}
9559 */
9560 public PendingIntent getContentIntent() {
9561 return mContentIntent;
9562 }
9563
9564 /**
9565 * Supplies a {@link PendingIntent} to send when the notification is cleared explicitly
9566 * by the user on TV. If provided, it is used instead of the delete intent specified
9567 * at the level of Notification.
9568 */
9569 public TvExtender setDeleteIntent(PendingIntent intent) {
9570 mDeleteIntent = intent;
9571 return this;
9572 }
9573
9574 /**
9575 * Returns the TV-specific delete intent. If this method returns null, the
9576 * main delete intent on the notification should be used.
9577 *
9578 * @see {@link Notification#deleteIntent}
9579 */
9580 public PendingIntent getDeleteIntent() {
9581 return mDeleteIntent;
9582 }
Rhiannon Malia1a083932018-01-24 15:02:30 -08009583
9584 /**
9585 * Specifies whether this notification should suppress showing a message over top of apps
9586 * outside of the launcher.
9587 */
9588 public TvExtender setSuppressShowOverApps(boolean suppress) {
9589 mSuppressShowOverApps = suppress;
9590 return this;
9591 }
9592
9593 /**
9594 * Returns true if this notification should not show messages over top of apps
9595 * outside of the launcher.
9596 */
9597 public boolean getSuppressShowOverApps() {
9598 return mSuppressShowOverApps;
9599 }
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009600 }
9601
9602 /**
Griff Hazen61a9e862014-05-22 16:05:19 -07009603 * Get an array of Notification objects from a parcelable array bundle field.
9604 * Update the bundle to have a typed array so fetches in the future don't need
9605 * to do an array copy.
9606 */
9607 private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) {
9608 Parcelable[] array = bundle.getParcelableArray(key);
9609 if (array instanceof Notification[] || array == null) {
9610 return (Notification[]) array;
9611 }
9612 Notification[] typedArray = Arrays.copyOf(array, array.length,
9613 Notification[].class);
9614 bundle.putParcelableArray(key, typedArray);
9615 return typedArray;
9616 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02009617
9618 private static class BuilderRemoteViews extends RemoteViews {
9619 public BuilderRemoteViews(Parcel parcel) {
9620 super(parcel);
9621 }
9622
Kenny Guy77320062014-08-27 21:37:15 +01009623 public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) {
9624 super(appInfo, layoutId);
Christoph Studer4600f9b2014-07-22 22:44:43 +02009625 }
9626
9627 @Override
9628 public BuilderRemoteViews clone() {
9629 Parcel p = Parcel.obtain();
9630 writeToParcel(p, 0);
9631 p.setDataPosition(0);
9632 BuilderRemoteViews brv = new BuilderRemoteViews(p);
9633 p.recycle();
9634 return brv;
9635 }
9636 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08009637
Selim Cinek384804b2018-04-18 14:31:07 +08009638 /**
9639 * A result object where information about the template that was created is saved.
9640 */
9641 private static class TemplateBindResult {
Selim Cinek1c72fa02018-04-23 18:00:54 +08009642 int mIconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009643
9644 /**
Selim Cinek1c72fa02018-04-23 18:00:54 +08009645 * Get the margin end that needs to be added to any fields that may overlap
Selim Cinek384804b2018-04-18 14:31:07 +08009646 * with the right actions.
9647 */
Selim Cinek1c72fa02018-04-23 18:00:54 +08009648 public int getIconMarginEnd() {
9649 return mIconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009650 }
9651
Selim Cinek1c72fa02018-04-23 18:00:54 +08009652 public void setIconMarginEnd(int iconMarginEnd) {
9653 this.mIconMarginEnd = iconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009654 }
9655 }
9656
Adrian Roos70d7aa32017-01-11 15:39:06 -08009657 private static class StandardTemplateParams {
9658 boolean hasProgress = true;
9659 boolean ambient = false;
9660 CharSequence title;
9661 CharSequence text;
Selim Cinekafeed292017-12-12 17:32:44 -08009662 CharSequence headerTextSecondary;
Selim Cinekbee4e072018-05-21 22:06:43 -07009663 int maxRemoteInputHistory = Style.MAX_REMOTE_INPUT_HISTORY_LINES;
Selim Cinek88188f22017-09-19 16:46:56 -07009664 boolean hideLargeIcon;
Selim Cinek384804b2018-04-18 14:31:07 +08009665 boolean hideReplyIcon;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009666
9667 final StandardTemplateParams reset() {
9668 hasProgress = true;
9669 ambient = false;
9670 title = null;
9671 text = null;
Selim Cinekafeed292017-12-12 17:32:44 -08009672 headerTextSecondary = null;
Selim Cinekbee4e072018-05-21 22:06:43 -07009673 maxRemoteInputHistory = Style.MAX_REMOTE_INPUT_HISTORY_LINES;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009674 return this;
9675 }
9676
9677 final StandardTemplateParams hasProgress(boolean hasProgress) {
9678 this.hasProgress = hasProgress;
9679 return this;
9680 }
9681
9682 final StandardTemplateParams title(CharSequence title) {
9683 this.title = title;
9684 return this;
9685 }
9686
9687 final StandardTemplateParams text(CharSequence text) {
9688 this.text = text;
9689 return this;
9690 }
9691
Selim Cinekafeed292017-12-12 17:32:44 -08009692 final StandardTemplateParams headerTextSecondary(CharSequence text) {
9693 this.headerTextSecondary = text;
9694 return this;
9695 }
9696
Selim Cinek384804b2018-04-18 14:31:07 +08009697 final StandardTemplateParams hideLargeIcon(boolean hideLargeIcon) {
9698 this.hideLargeIcon = hideLargeIcon;
Selim Cinek88188f22017-09-19 16:46:56 -07009699 return this;
9700 }
9701
Selim Cinek384804b2018-04-18 14:31:07 +08009702 final StandardTemplateParams hideReplyIcon(boolean hideReplyIcon) {
9703 this.hideReplyIcon = hideReplyIcon;
Selim Cinek88188f22017-09-19 16:46:56 -07009704 return this;
9705 }
9706
Adrian Roos70d7aa32017-01-11 15:39:06 -08009707 final StandardTemplateParams ambient(boolean ambient) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08009708 Preconditions.checkState(title == null && text == null, "must set ambient before text");
Adrian Roos70d7aa32017-01-11 15:39:06 -08009709 this.ambient = ambient;
9710 return this;
9711 }
9712
9713 final StandardTemplateParams fillTextsFrom(Builder b) {
9714 Bundle extras = b.mN.extras;
Lucas Dupin06c5e642017-09-13 16:34:58 -07009715 this.title = b.processLegacyText(extras.getCharSequence(EXTRA_TITLE), ambient);
9716
9717 // Big text notifications should contain their content when viewed in ambient mode.
9718 CharSequence text = extras.getCharSequence(EXTRA_BIG_TEXT);
9719 if (!ambient || TextUtils.isEmpty(text)) {
9720 text = extras.getCharSequence(EXTRA_TEXT);
9721 }
9722 this.text = b.processLegacyText(text, ambient);
Adrian Roos70d7aa32017-01-11 15:39:06 -08009723 return this;
9724 }
Selim Cinekbee4e072018-05-21 22:06:43 -07009725
9726 /**
9727 * Set the maximum lines of remote input history lines allowed.
9728 * @param maxRemoteInputHistory The number of lines.
9729 * @return The builder for method chaining.
9730 */
9731 public StandardTemplateParams setMaxRemoteInputHistory(int maxRemoteInputHistory) {
9732 this.maxRemoteInputHistory = maxRemoteInputHistory;
9733 return this;
9734 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08009735 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009736}