blob: c22a43ec4af331c8f15535228228a257ad6e23c1 [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) {
Robin Leead7e72a2017-12-04 15:45:46 +01002770 fixDuplicateExtra(mLargeIcon, EXTRA_LARGE_ICON);
2771 }
2772 }
2773
2774 /**
2775 * If we find an extra that's exactly the same as one of the "real" fields but refers to a
2776 * separate object, replace it with the field's version to avoid holding duplicate copies.
2777 */
2778 private void fixDuplicateExtra(@Nullable Parcelable original, @NonNull String extraName) {
2779 if (original != null && extras.getParcelable(extraName) != null) {
2780 extras.putParcelable(extraName, original);
2781 }
2782 }
2783
2784 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002785 * Sets the {@link #contentView} field to be a view with the standard "Latest Event"
2786 * layout.
2787 *
2788 * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields
2789 * in the view.</p>
2790 * @param context The context for your application / activity.
2791 * @param contentTitle The title that goes in the expanded entry.
2792 * @param contentText The text that goes in the expanded entry.
2793 * @param contentIntent The intent to launch when the user clicks the expanded notification.
2794 * If this is an activity, it must include the
2795 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -08002796 * that you take care of task management as described in the
2797 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2798 * Stack</a> document.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002799 *
Joe Onorato46439ce2010-11-19 13:56:21 -08002800 * @deprecated Use {@link Builder} instead.
Chris Wrena05db382015-06-24 15:18:34 -04002801 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002802 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002803 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002804 public void setLatestEventInfo(Context context,
2805 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002806 if (context.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.LOLLIPOP_MR1){
2807 Log.e(TAG, "setLatestEventInfo() is deprecated and you should feel deprecated.",
2808 new Throwable());
2809 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002810
Selim Cinek4ac6f602016-06-13 15:47:03 -07002811 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
2812 extras.putBoolean(EXTRA_SHOW_WHEN, true);
2813 }
2814
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002815 // ensure that any information already set directly is preserved
2816 final Notification.Builder builder = new Notification.Builder(context, this);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002817
2818 // now apply the latestEventInfo fields
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002819 if (contentTitle != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002820 builder.setContentTitle(contentTitle);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002821 }
2822 if (contentText != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002823 builder.setContentText(contentText);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002824 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002825 builder.setContentIntent(contentIntent);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002826
2827 builder.build(); // callers expect this notification to be ready to use
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002828 }
2829
Julia Reynoldsda303542015-11-23 14:00:20 -05002830 /**
2831 * @hide
2832 */
2833 public static void addFieldsFromContext(Context context, Notification notification) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04002834 addFieldsFromContext(context.getApplicationInfo(), notification);
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002835 }
2836
2837 /**
2838 * @hide
2839 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04002840 public static void addFieldsFromContext(ApplicationInfo ai, Notification notification) {
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002841 notification.extras.putParcelable(EXTRA_BUILDER_APPLICATION_INFO, ai);
Julia Reynoldsda303542015-11-23 14:00:20 -05002842 }
2843
Yi Jin6b514142017-10-30 14:54:12 -07002844 /**
2845 * @hide
2846 */
2847 public void writeToProto(ProtoOutputStream proto, long fieldId) {
2848 long token = proto.start(fieldId);
2849 proto.write(NotificationProto.CHANNEL_ID, getChannelId());
2850 proto.write(NotificationProto.HAS_TICKER_TEXT, this.tickerText != null);
2851 proto.write(NotificationProto.FLAGS, this.flags);
2852 proto.write(NotificationProto.COLOR, this.color);
2853 proto.write(NotificationProto.CATEGORY, this.category);
2854 proto.write(NotificationProto.GROUP_KEY, this.mGroupKey);
2855 proto.write(NotificationProto.SORT_KEY, this.mSortKey);
2856 if (this.actions != null) {
2857 proto.write(NotificationProto.ACTION_LENGTH, this.actions.length);
2858 }
2859 if (this.visibility >= VISIBILITY_SECRET && this.visibility <= VISIBILITY_PUBLIC) {
2860 proto.write(NotificationProto.VISIBILITY, this.visibility);
2861 }
2862 if (publicVersion != null) {
2863 publicVersion.writeToProto(proto, NotificationProto.PUBLIC_VERSION);
2864 }
2865 proto.end(token);
2866 }
2867
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002868 @Override
2869 public String toString() {
2870 StringBuilder sb = new StringBuilder();
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002871 sb.append("Notification(channel=");
Julia Reynoldsbad42972017-04-25 13:52:49 -04002872 sb.append(getChannelId());
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002873 sb.append(" pri=");
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002874 sb.append(priority);
2875 sb.append(" contentView=");
Joe Onoratoc9596d62011-01-12 17:03:11 -08002876 if (contentView != null) {
2877 sb.append(contentView.getPackage());
2878 sb.append("/0x");
2879 sb.append(Integer.toHexString(contentView.getLayoutId()));
2880 } else {
2881 sb.append("null");
2882 }
2883 sb.append(" vibrate=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002884 if ((this.defaults & DEFAULT_VIBRATE) != 0) {
2885 sb.append("default");
2886 } else if (this.vibrate != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002887 int N = this.vibrate.length-1;
2888 sb.append("[");
2889 for (int i=0; i<N; i++) {
2890 sb.append(this.vibrate[i]);
2891 sb.append(',');
2892 }
Simon Schoar8cf97d92009-06-10 22:08:37 +02002893 if (N != -1) {
2894 sb.append(this.vibrate[N]);
2895 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002896 sb.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002897 } else {
2898 sb.append("null");
2899 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002900 sb.append(" sound=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002901 if ((this.defaults & DEFAULT_SOUND) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002902 sb.append("default");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002903 } else if (this.sound != null) {
2904 sb.append(this.sound.toString());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002905 } else {
2906 sb.append("null");
2907 }
Chris Wren365b6d32015-07-16 10:39:26 -04002908 if (this.tickerText != null) {
2909 sb.append(" tick");
2910 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002911 sb.append(" defaults=0x");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002912 sb.append(Integer.toHexString(this.defaults));
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002913 sb.append(" flags=0x");
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002914 sb.append(Integer.toHexString(this.flags));
Dan Sandler26e81cf2014-05-06 10:01:27 -04002915 sb.append(String.format(" color=0x%08x", this.color));
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002916 if (this.category != null) {
2917 sb.append(" category=");
2918 sb.append(this.category);
2919 }
2920 if (this.mGroupKey != null) {
2921 sb.append(" groupKey=");
2922 sb.append(this.mGroupKey);
2923 }
2924 if (this.mSortKey != null) {
2925 sb.append(" sortKey=");
2926 sb.append(this.mSortKey);
2927 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002928 if (actions != null) {
Dan Sandler1b718782014-07-18 12:43:45 -04002929 sb.append(" actions=");
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002930 sb.append(actions.length);
Dan Sandler1b718782014-07-18 12:43:45 -04002931 }
2932 sb.append(" vis=");
2933 sb.append(visibilityToString(this.visibility));
2934 if (this.publicVersion != null) {
2935 sb.append(" publicVersion=");
2936 sb.append(publicVersion.toString());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002937 }
2938 sb.append(")");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002939 return sb.toString();
2940 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002941
Dan Sandler1b718782014-07-18 12:43:45 -04002942 /**
2943 * {@hide}
2944 */
2945 public static String visibilityToString(int vis) {
2946 switch (vis) {
2947 case VISIBILITY_PRIVATE:
2948 return "PRIVATE";
2949 case VISIBILITY_PUBLIC:
2950 return "PUBLIC";
2951 case VISIBILITY_SECRET:
2952 return "SECRET";
2953 default:
2954 return "UNKNOWN(" + String.valueOf(vis) + ")";
2955 }
2956 }
2957
Joe Onoratocb109a02011-01-18 17:57:41 -08002958 /**
John Spurlock1d881a12015-03-18 19:21:54 -04002959 * {@hide}
2960 */
2961 public static String priorityToString(@Priority int pri) {
2962 switch (pri) {
2963 case PRIORITY_MIN:
2964 return "MIN";
2965 case PRIORITY_LOW:
2966 return "LOW";
2967 case PRIORITY_DEFAULT:
2968 return "DEFAULT";
2969 case PRIORITY_HIGH:
2970 return "HIGH";
2971 case PRIORITY_MAX:
2972 return "MAX";
2973 default:
2974 return "UNKNOWN(" + String.valueOf(pri) + ")";
2975 }
2976 }
2977
Julia Reynolds6ad0aec2017-07-05 08:47:03 -04002978 /**
2979 * @hide
2980 */
2981 public boolean hasCompletedProgress() {
2982 // not a progress notification; can't be complete
2983 if (!extras.containsKey(EXTRA_PROGRESS)
2984 || !extras.containsKey(EXTRA_PROGRESS_MAX)) {
2985 return false;
2986 }
2987 // many apps use max 0 for 'indeterminate'; not complete
2988 if (extras.getInt(EXTRA_PROGRESS_MAX) == 0) {
2989 return false;
2990 }
2991 return extras.getInt(EXTRA_PROGRESS) == extras.getInt(EXTRA_PROGRESS_MAX);
2992 }
2993
Jeff Sharkey000ce802017-04-29 13:13:27 -06002994 /** @removed */
2995 @Deprecated
Julia Reynolds37856052016-11-11 09:20:07 -05002996 public String getChannel() {
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002997 return mChannelId;
2998 }
2999
3000 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003001 * Returns the id of the channel this notification posts to.
3002 */
3003 public String getChannelId() {
3004 return mChannelId;
3005 }
3006
Jeff Sharkey000ce802017-04-29 13:13:27 -06003007 /** @removed */
3008 @Deprecated
Julia Reynolds2a128742016-11-28 14:29:25 -05003009 public long getTimeout() {
3010 return mTimeout;
3011 }
3012
3013 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003014 * Returns the duration from posting after which this notification should be canceled by the
3015 * system, if it's not canceled already.
3016 */
3017 public long getTimeoutAfter() {
3018 return mTimeout;
3019 }
3020
3021 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04003022 * Returns what icon should be shown for this notification if it is being displayed in a
3023 * Launcher that supports badging. Will be one of {@link #BADGE_ICON_NONE},
3024 * {@link #BADGE_ICON_SMALL}, or {@link #BADGE_ICON_LARGE}.
3025 */
3026 public int getBadgeIconType() {
3027 return mBadgeIcon;
3028 }
3029
3030 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003031 * Returns the {@link ShortcutInfo#getId() id} that this notification supersedes, if any.
Julia Reynoldsbad42972017-04-25 13:52:49 -04003032 *
3033 * <p>Used by some Launchers that display notification content to hide shortcuts that duplicate
3034 * notifications.
Julia Reynolds13d898c2017-02-02 12:22:05 -05003035 */
3036 public String getShortcutId() {
3037 return mShortcutId;
3038 }
3039
Julia Reynolds3aedded2017-03-31 14:42:09 -04003040
3041 /**
3042 * Returns the settings text provided to {@link Builder#setSettingsText(CharSequence)}.
3043 */
3044 public CharSequence getSettingsText() {
3045 return mSettingsText;
3046 }
3047
Julia Reynolds13d898c2017-02-02 12:22:05 -05003048 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003049 * Returns which type of notifications in a group are responsible for audibly alerting the
3050 * user. See {@link #GROUP_ALERT_ALL}, {@link #GROUP_ALERT_CHILDREN},
3051 * {@link #GROUP_ALERT_SUMMARY}.
3052 */
3053 public @GroupAlertBehavior int getGroupAlertBehavior() {
3054 return mGroupAlertBehavior;
3055 }
3056
3057 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04003058 * The small icon representing this notification in the status bar and content view.
3059 *
3060 * @return the small icon representing this notification.
3061 *
3062 * @see Builder#getSmallIcon()
3063 * @see Builder#setSmallIcon(Icon)
3064 */
3065 public Icon getSmallIcon() {
3066 return mSmallIcon;
3067 }
3068
3069 /**
3070 * Used when notifying to clean up legacy small icons.
3071 * @hide
3072 */
3073 public void setSmallIcon(Icon icon) {
3074 mSmallIcon = icon;
3075 }
3076
3077 /**
3078 * The large icon shown in this notification's content view.
3079 * @see Builder#getLargeIcon()
3080 * @see Builder#setLargeIcon(Icon)
3081 */
3082 public Icon getLargeIcon() {
3083 return mLargeIcon;
3084 }
3085
3086 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +02003087 * @hide
3088 */
Christoph Studerc8db24b2014-07-25 17:50:30 +02003089 public boolean isGroupSummary() {
3090 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) != 0;
3091 }
3092
3093 /**
3094 * @hide
3095 */
3096 public boolean isGroupChild() {
3097 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) == 0;
3098 }
3099
3100 /**
Julia Reynolds30203152017-05-26 13:36:31 -04003101 * @hide
3102 */
3103 public boolean suppressAlertingDueToGrouping() {
3104 if (isGroupSummary()
3105 && getGroupAlertBehavior() == Notification.GROUP_ALERT_CHILDREN) {
3106 return true;
3107 } else if (isGroupChild()
3108 && getGroupAlertBehavior() == Notification.GROUP_ALERT_SUMMARY) {
3109 return true;
3110 }
3111 return false;
3112 }
3113
3114 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003115 * Builder class for {@link Notification} objects.
Joe Malin8d40d042012-11-05 11:36:40 -08003116 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003117 * Provides a convenient way to set the various fields of a {@link Notification} and generate
Scott Main183bf112012-08-13 19:12:13 -07003118 * content views using the platform's notification layout template. If your app supports
3119 * versions of Android as old as API level 4, you can instead use
3120 * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder},
3121 * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support
3122 * library</a>.
Joe Malin8d40d042012-11-05 11:36:40 -08003123 *
Scott Main183bf112012-08-13 19:12:13 -07003124 * <p>Example:
Joe Malin8d40d042012-11-05 11:36:40 -08003125 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003126 * <pre class="prettyprint">
Scott Main183bf112012-08-13 19:12:13 -07003127 * Notification noti = new Notification.Builder(mContext)
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003128 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
3129 * .setContentText(subject)
3130 * .setSmallIcon(R.drawable.new_mail)
3131 * .setLargeIcon(aBitmap)
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003132 * .build();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003133 * </pre>
Joe Onoratocb109a02011-01-18 17:57:41 -08003134 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003135 public static class Builder {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003136 /**
3137 * @hide
3138 */
3139 public static final String EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT =
3140 "android.rebuild.contentViewActionCount";
3141 /**
3142 * @hide
3143 */
3144 public static final String EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT
3145 = "android.rebuild.bigViewActionCount";
3146 /**
3147 * @hide
3148 */
3149 public static final String EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT
3150 = "android.rebuild.hudViewActionCount";
3151
Daniel Sandler602ad1c2012-06-12 16:06:27 -04003152 private static final int MAX_ACTION_BUTTONS = 3;
Daniel Sandler8680bf82012-05-15 16:52:52 -04003153
Selim Cinek6743c0b2017-01-18 18:24:01 -08003154 private static final boolean USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY =
3155 SystemProperties.getBoolean("notifications.only_title", true);
3156
Selim Cinek389edcd2017-05-11 19:16:44 -07003157 /**
3158 * The lightness difference that has to be added to the primary text color to obtain the
3159 * secondary text color when the background is light.
3160 */
3161 private static final int LIGHTNESS_TEXT_DIFFERENCE_LIGHT = 20;
3162
3163 /**
3164 * The lightness difference that has to be added to the primary text color to obtain the
3165 * secondary text color when the background is dark.
3166 * A bit less then the above value, since it looks better on dark backgrounds.
3167 */
3168 private static final int LIGHTNESS_TEXT_DIFFERENCE_DARK = -10;
3169
Joe Onorato46439ce2010-11-19 13:56:21 -08003170 private Context mContext;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003171 private Notification mN;
3172 private Bundle mUserExtras = new Bundle();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003173 private Style mStyle;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003174 private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS);
Selim Cineke7238dd2017-12-14 17:48:32 -08003175 private ArrayList<Person> mPersonList = new ArrayList<>();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003176 private NotificationColorUtil mColorUtil;
Selim Cinek7b9605b2017-01-19 17:36:00 -08003177 private boolean mIsLegacy;
3178 private boolean mIsLegacyInitialized;
Christoph Studer7ac80e62014-08-04 16:01:57 +02003179
3180 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -08003181 * Caches a contrast-enhanced version of {@link #mCachedContrastColorIsFor}.
3182 */
3183 private int mCachedContrastColor = COLOR_INVALID;
3184 private int mCachedContrastColorIsFor = COLOR_INVALID;
Adrian Roos487374f2017-01-11 15:48:14 -08003185 /**
Selim Cinek4717d862018-04-19 09:19:15 +08003186 * Caches a ambient version of {@link #mCachedAmbientColorIsFor}.
Adrian Roos487374f2017-01-11 15:48:14 -08003187 */
3188 private int mCachedAmbientColor = COLOR_INVALID;
3189 private int mCachedAmbientColorIsFor = COLOR_INVALID;
Selim Cinek4717d862018-04-19 09:19:15 +08003190 /**
3191 * A neutral color color that can be used for icons.
3192 */
3193 private int mNeutralColor = COLOR_INVALID;
Adrian Roos4ff3b122016-02-01 12:26:13 -08003194
3195 /**
Adrian Roos70d7aa32017-01-11 15:39:06 -08003196 * Caches an instance of StandardTemplateParams. Note that this may have been used before,
3197 * so make sure to call {@link StandardTemplateParams#reset()} before using it.
3198 */
3199 StandardTemplateParams mParams = new StandardTemplateParams();
Selim Cinek7b9605b2017-01-19 17:36:00 -08003200 private int mTextColorsAreForBackground = COLOR_INVALID;
3201 private int mPrimaryTextColor = COLOR_INVALID;
3202 private int mSecondaryTextColor = COLOR_INVALID;
Selim Cinek5fb73f82017-04-20 16:55:38 -07003203 private int mBackgroundColor = COLOR_INVALID;
3204 private int mForegroundColor = COLOR_INVALID;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07003205 /**
3206 * A temporary location where actions are stored. If != null the view originally has action
3207 * but doesn't have any for this inflation.
3208 */
3209 private ArrayList<Action> mOriginalActions;
Selim Cineka7679b62017-05-10 16:33:25 -07003210 private boolean mRebuildStyledRemoteViews;
Adrian Roos70d7aa32017-01-11 15:39:06 -08003211
Anthony Chenad4d1582017-04-10 16:07:58 -07003212 private boolean mTintActionButtons;
3213 private boolean mInNightMode;
3214
Adrian Roos70d7aa32017-01-11 15:39:06 -08003215 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003216 * Constructs a new Builder with the defaults:
Joe Onoratocb109a02011-01-18 17:57:41 -08003217 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003218 * @param context
3219 * A {@link Context} that will be used by the Builder to construct the
3220 * RemoteViews. The Context will not be held past the lifetime of this Builder
3221 * object.
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003222 * @param channelId
3223 * The constructed Notification will be posted on this
3224 * {@link NotificationChannel}. To use a NotificationChannel, it must first be
3225 * created using {@link NotificationManager#createNotificationChannel}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003226 */
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003227 public Builder(Context context, String channelId) {
3228 this(context, (Notification) null);
3229 mN.mChannelId = channelId;
3230 }
3231
3232 /**
3233 * @deprecated use {@link Notification.Builder#Notification.Builder(Context, String)}
3234 * instead. All posted Notifications must specify a NotificationChannel Id.
3235 */
3236 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003237 public Builder(Context context) {
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003238 this(context, (Notification) null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003239 }
3240
Joe Onoratocb109a02011-01-18 17:57:41 -08003241 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003242 * @hide
Christoph Studer4600f9b2014-07-22 22:44:43 +02003243 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003244 public Builder(Context context, Notification toAdopt) {
3245 mContext = context;
Anthony Chenad4d1582017-04-10 16:07:58 -07003246 Resources res = mContext.getResources();
3247 mTintActionButtons = res.getBoolean(R.bool.config_tintNotificationActionButtons);
3248
3249 if (res.getBoolean(R.bool.config_enableNightMode)) {
3250 Configuration currentConfig = res.getConfiguration();
3251 mInNightMode = (currentConfig.uiMode & Configuration.UI_MODE_NIGHT_MASK)
3252 == Configuration.UI_MODE_NIGHT_YES;
3253 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02003254
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003255 if (toAdopt == null) {
3256 mN = new Notification();
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003257 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
3258 mN.extras.putBoolean(EXTRA_SHOW_WHEN, true);
3259 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003260 mN.priority = PRIORITY_DEFAULT;
3261 mN.visibility = VISIBILITY_PRIVATE;
3262 } else {
3263 mN = toAdopt;
3264 if (mN.actions != null) {
3265 Collections.addAll(mActions, mN.actions);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003266 }
3267
Selim Cineke7238dd2017-12-14 17:48:32 -08003268 if (mN.extras.containsKey(EXTRA_PEOPLE_LIST)) {
3269 ArrayList<Person> people = mN.extras.getParcelableArrayList(EXTRA_PEOPLE_LIST);
3270 mPersonList.addAll(people);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003271 }
3272
Selim Cinek4ac6f602016-06-13 15:47:03 -07003273 if (mN.getSmallIcon() == null && mN.icon != 0) {
3274 setSmallIcon(mN.icon);
3275 }
3276
3277 if (mN.getLargeIcon() == null && mN.largeIcon != null) {
3278 setLargeIcon(mN.largeIcon);
3279 }
3280
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003281 String templateClass = mN.extras.getString(EXTRA_TEMPLATE);
3282 if (!TextUtils.isEmpty(templateClass)) {
3283 final Class<? extends Style> styleClass
3284 = getNotificationStyleClass(templateClass);
3285 if (styleClass == null) {
3286 Log.d(TAG, "Unknown style class: " + templateClass);
3287 } else {
3288 try {
Adrian Roosc1a80b02016-04-05 14:54:55 -07003289 final Constructor<? extends Style> ctor =
3290 styleClass.getDeclaredConstructor();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003291 ctor.setAccessible(true);
3292 final Style style = ctor.newInstance();
3293 style.restoreFromExtras(mN.extras);
3294
3295 if (style != null) {
3296 setStyle(style);
3297 }
3298 } catch (Throwable t) {
3299 Log.e(TAG, "Could not create Style", t);
3300 }
3301 }
3302 }
3303
3304 }
3305 }
3306
3307 private NotificationColorUtil getColorUtil() {
Selim Cinek99104832017-01-25 14:47:33 -08003308 if (mColorUtil == null) {
3309 mColorUtil = NotificationColorUtil.getInstance(mContext);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003310 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003311 return mColorUtil;
Christoph Studer4600f9b2014-07-22 22:44:43 +02003312 }
3313
3314 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003315 * If this notification is duplicative of a Launcher shortcut, sets the
3316 * {@link ShortcutInfo#getId() id} of the shortcut, in case the Launcher wants to hide
3317 * the shortcut.
3318 *
Julia Reynoldsbad42972017-04-25 13:52:49 -04003319 * This field will be ignored by Launchers that don't support badging, don't show
3320 * notification content, or don't show {@link android.content.pm.ShortcutManager shortcuts}.
Julia Reynolds13d898c2017-02-02 12:22:05 -05003321 *
3322 * @param shortcutId the {@link ShortcutInfo#getId() id} of the shortcut this notification
3323 * supersedes
3324 */
3325 public Builder setShortcutId(String shortcutId) {
3326 mN.mShortcutId = shortcutId;
3327 return this;
3328 }
3329
3330 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04003331 * Sets which icon to display as a badge for this notification.
3332 *
3333 * Must be one of {@link #BADGE_ICON_NONE}, {@link #BADGE_ICON_SMALL},
3334 * {@link #BADGE_ICON_LARGE}.
3335 *
3336 * Note: This value might be ignored, for launchers that don't support badge icons.
3337 */
Julia Reynolds612beb22017-03-30 10:48:30 -04003338 public Builder setBadgeIconType(int icon) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04003339 mN.mBadgeIcon = icon;
3340 return this;
3341 }
3342
3343 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003344 * Sets the group alert behavior for this notification. Use this method to mute this
3345 * notification if alerts for this notification's group should be handled by a different
3346 * notification. This is only applicable for notifications that belong to a
Julia Reynolds399d9bf2017-08-11 12:52:14 -04003347 * {@link #setGroup(String) group}. This must be called on all notifications you want to
3348 * mute. For example, if you want only the summary of your group to make noise, all
3349 * children in the group should have the group alert behavior {@link #GROUP_ALERT_SUMMARY}.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003350 *
3351 * <p> The default value is {@link #GROUP_ALERT_ALL}.</p>
3352 */
3353 public Builder setGroupAlertBehavior(@GroupAlertBehavior int groupAlertBehavior) {
3354 mN.mGroupAlertBehavior = groupAlertBehavior;
3355 return this;
3356 }
3357
Jeff Sharkey000ce802017-04-29 13:13:27 -06003358 /** @removed */
3359 @Deprecated
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04003360 public Builder setChannel(String channelId) {
3361 mN.mChannelId = channelId;
3362 return this;
3363 }
3364
3365 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003366 * Specifies the channel the notification should be delivered on.
3367 */
3368 public Builder setChannelId(String channelId) {
3369 mN.mChannelId = channelId;
3370 return this;
3371 }
3372
Jeff Sharkey000ce802017-04-29 13:13:27 -06003373 /** @removed */
3374 @Deprecated
Julia Reynolds50989772017-02-23 14:32:16 -05003375 public Builder setTimeout(long durationMs) {
3376 mN.mTimeout = durationMs;
Julia Reynolds2a128742016-11-28 14:29:25 -05003377 return this;
3378 }
3379
3380 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003381 * Specifies a duration in milliseconds after which this notification should be canceled,
3382 * if it is not already canceled.
3383 */
3384 public Builder setTimeoutAfter(long durationMs) {
3385 mN.mTimeout = durationMs;
3386 return this;
3387 }
3388
3389 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003390 * Add a timestamp pertaining to the notification (usually the time the event occurred).
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003391 *
3392 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not
3393 * shown anymore by default and must be opted into by using
3394 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003395 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003396 * @see Notification#when
Joe Onoratocb109a02011-01-18 17:57:41 -08003397 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003398 public Builder setWhen(long when) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003399 mN.when = when;
Joe Onorato46439ce2010-11-19 13:56:21 -08003400 return this;
3401 }
3402
Joe Onoratocb109a02011-01-18 17:57:41 -08003403 /**
Griff Hazen50c11652014-05-16 09:46:31 -07003404 * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown
Daniel Sandler0c890492012-09-12 17:23:10 -07003405 * in the content view.
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003406 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to
3407 * {@code false}. For earlier apps, the default is {@code true}.
Daniel Sandler0c890492012-09-12 17:23:10 -07003408 */
3409 public Builder setShowWhen(boolean show) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003410 mN.extras.putBoolean(EXTRA_SHOW_WHEN, show);
Daniel Sandler0c890492012-09-12 17:23:10 -07003411 return this;
3412 }
3413
3414 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003415 * Show the {@link Notification#when} field as a stopwatch.
Joe Malin8d40d042012-11-05 11:36:40 -08003416 *
3417 * Instead of presenting <code>when</code> as a timestamp, the notification will show an
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003418 * automatically updating display of the minutes and seconds since <code>when</code>.
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003419 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003420 * Useful when showing an elapsed time (like an ongoing phone call).
3421 *
Selim Cinek81c23aa2016-02-25 16:23:13 -08003422 * The counter can also be set to count down to <code>when</code> when using
Adrian Roos96b7e202016-05-17 13:50:38 -07003423 * {@link #setChronometerCountDown(boolean)}.
Selim Cinek81c23aa2016-02-25 16:23:13 -08003424 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003425 * @see android.widget.Chronometer
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003426 * @see Notification#when
Adrian Roos96b7e202016-05-17 13:50:38 -07003427 * @see #setChronometerCountDown(boolean)
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003428 */
3429 public Builder setUsesChronometer(boolean b) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003430 mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b);
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003431 return this;
3432 }
3433
3434 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08003435 * Sets the Chronometer to count down instead of counting up.
3436 *
3437 * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true.
3438 * If it isn't set the chronometer will count up.
3439 *
3440 * @see #setUsesChronometer(boolean)
3441 */
Adrian Roos96b7e202016-05-17 13:50:38 -07003442 public Builder setChronometerCountDown(boolean countDown) {
3443 mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, countDown);
Selim Cinek81c23aa2016-02-25 16:23:13 -08003444 return this;
3445 }
3446
3447 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003448 * Set the small icon resource, which will be used to represent the notification in the
3449 * status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -08003450 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003451
3452 * The platform template for the expanded view will draw this icon in the left, unless a
3453 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
3454 * icon will be moved to the right-hand side.
3455 *
3456
3457 * @param icon
3458 * A resource ID in the application's package of the drawable to use.
3459 * @see Notification#icon
Joe Onoratocb109a02011-01-18 17:57:41 -08003460 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003461 public Builder setSmallIcon(@DrawableRes int icon) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04003462 return setSmallIcon(icon != 0
3463 ? Icon.createWithResource(mContext, icon)
3464 : null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003465 }
3466
Joe Onoratocb109a02011-01-18 17:57:41 -08003467 /**
3468 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
3469 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
3470 * LevelListDrawable}.
3471 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003472 * @param icon A resource ID in the application's package of the drawable to use.
Joe Onoratocb109a02011-01-18 17:57:41 -08003473 * @param level The level to use for the icon.
3474 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003475 * @see Notification#icon
3476 * @see Notification#iconLevel
Joe Onoratocb109a02011-01-18 17:57:41 -08003477 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003478 public Builder setSmallIcon(@DrawableRes int icon, int level) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003479 mN.iconLevel = level;
Dan Sandlerd63f9322015-05-06 15:18:49 -04003480 return setSmallIcon(icon);
3481 }
3482
3483 /**
3484 * Set the small icon, which will be used to represent the notification in the
3485 * status bar and content view (unless overriden there by a
3486 * {@link #setLargeIcon(Bitmap) large icon}).
3487 *
3488 * @param icon An Icon object to use.
3489 * @see Notification#icon
3490 */
3491 public Builder setSmallIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003492 mN.setSmallIcon(icon);
3493 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
3494 mN.icon = icon.getResId();
3495 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003496 return this;
3497 }
3498
Joe Onoratocb109a02011-01-18 17:57:41 -08003499 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003500 * Set the first line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003501 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003502 public Builder setContentTitle(CharSequence title) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003503 mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title));
Joe Onorato46439ce2010-11-19 13:56:21 -08003504 return this;
3505 }
3506
Joe Onoratocb109a02011-01-18 17:57:41 -08003507 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003508 * Set the second line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003509 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003510 public Builder setContentText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003511 mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text));
Joe Onorato46439ce2010-11-19 13:56:21 -08003512 return this;
3513 }
3514
Joe Onoratocb109a02011-01-18 17:57:41 -08003515 /**
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003516 * This provides some additional information that is displayed in the notification. No
3517 * guarantees are given where exactly it is displayed.
3518 *
3519 * <p>This information should only be provided if it provides an essential
3520 * benefit to the understanding of the notification. The more text you provide the
3521 * less readable it becomes. For example, an email client should only provide the account
3522 * name here if more than one email account has been added.</p>
3523 *
3524 * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the
3525 * notification header area.
3526 *
3527 * On Android versions before {@link android.os.Build.VERSION_CODES#N}
3528 * this will be shown in the third line of text in the platform notification template.
3529 * You should not be using {@link #setProgress(int, int, boolean)} at the
3530 * same time on those versions; they occupy the same place.
3531 * </p>
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003532 */
3533 public Builder setSubText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003534 mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text));
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003535 return this;
3536 }
3537
3538 /**
Julia Reynolds3aedded2017-03-31 14:42:09 -04003539 * Provides text that will appear as a link to your application's settings.
3540 *
3541 * <p>This text does not appear within notification {@link Style templates} but may
3542 * appear when the user uses an affordance to learn more about the notification.
3543 * Additionally, this text will not appear unless you provide a valid link target by
3544 * handling {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}.
3545 *
3546 * <p>This text is meant to be concise description about what the user can customize
3547 * when they click on this link. The recommended maximum length is 40 characters.
3548 * @param text
3549 * @return
3550 */
3551 public Builder setSettingsText(CharSequence text) {
3552 mN.mSettingsText = safeCharSequence(text);
3553 return this;
3554 }
3555
3556 /**
Adrian Roose458aa82015-12-08 16:17:19 -08003557 * Set the remote input history.
3558 *
3559 * This should be set to the most recent inputs that have been sent
3560 * through a {@link RemoteInput} of this Notification and cleared once the it is no
3561 * longer relevant (e.g. for chat notifications once the other party has responded).
3562 *
3563 * The most recent input must be stored at the 0 index, the second most recent at the
3564 * 1 index, etc. Note that the system will limit both how far back the inputs will be shown
3565 * and how much of each individual input is shown.
3566 *
3567 * <p>Note: The reply text will only be shown on notifications that have least one action
3568 * with a {@code RemoteInput}.</p>
3569 */
3570 public Builder setRemoteInputHistory(CharSequence[] text) {
3571 if (text == null) {
3572 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null);
3573 } else {
3574 final int N = Math.min(MAX_REPLY_HISTORY, text.length);
3575 CharSequence[] safe = new CharSequence[N];
3576 for (int i = 0; i < N; i++) {
3577 safe[i] = safeCharSequence(text[i]);
3578 }
3579 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe);
3580 }
3581 return this;
3582 }
3583
3584 /**
Kenny Guya0f6de82018-04-06 16:20:16 +01003585 * Sets whether remote history entries view should have a spinner.
3586 * @hide
3587 */
3588 public Builder setShowRemoteInputSpinner(boolean showSpinner) {
3589 mN.extras.putBoolean(EXTRA_SHOW_REMOTE_INPUT_SPINNER, showSpinner);
3590 return this;
3591 }
3592
3593 /**
Kenny Guy8cc15d22018-05-09 09:50:55 +01003594 * Sets whether smart reply buttons should be hidden.
3595 * @hide
3596 */
3597 public Builder setHideSmartReplies(boolean hideSmartReplies) {
3598 mN.extras.putBoolean(EXTRA_HIDE_SMART_REPLIES, hideSmartReplies);
3599 return this;
3600 }
3601
3602 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003603 * Sets the number of items this notification represents. May be displayed as a badge count
3604 * for Launchers that support badging.
Joe Onoratocb109a02011-01-18 17:57:41 -08003605 */
Joe Onorato8595a3d2010-11-19 18:12:07 -08003606 public Builder setNumber(int number) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003607 mN.number = number;
Joe Onorato8595a3d2010-11-19 18:12:07 -08003608 return this;
3609 }
3610
Joe Onoratocb109a02011-01-18 17:57:41 -08003611 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003612 * A small piece of additional information pertaining to this notification.
3613 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003614 * The platform template will draw this on the last line of the notification, at the far
3615 * right (to the right of a smallIcon if it has been placed there).
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003616 *
3617 * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header.
3618 * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this
3619 * field will still show up, but the subtext will take precedence.
Joe Onoratocb109a02011-01-18 17:57:41 -08003620 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003621 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003622 public Builder setContentInfo(CharSequence info) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003623 mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info));
Joe Onorato46439ce2010-11-19 13:56:21 -08003624 return this;
3625 }
3626
Joe Onoratocb109a02011-01-18 17:57:41 -08003627 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003628 * Set the progress this notification represents.
3629 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003630 * The platform template will represent this using a {@link ProgressBar}.
Jeff Sharkey1c400132011-08-05 14:50:13 -07003631 */
3632 public Builder setProgress(int max, int progress, boolean indeterminate) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003633 mN.extras.putInt(EXTRA_PROGRESS, progress);
3634 mN.extras.putInt(EXTRA_PROGRESS_MAX, max);
3635 mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate);
Jeff Sharkey1c400132011-08-05 14:50:13 -07003636 return this;
3637 }
3638
3639 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003640 * Supply a custom RemoteViews to use instead of the platform template.
3641 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003642 * Use {@link #setCustomContentView(RemoteViews)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003643 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003644 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003645 public Builder setContent(RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003646 return setCustomContentView(views);
3647 }
3648
3649 /**
3650 * Supply custom RemoteViews to use instead of the platform template.
3651 *
3652 * This will override the layout that would otherwise be constructed by this Builder
3653 * object.
3654 */
3655 public Builder setCustomContentView(RemoteViews contentView) {
3656 mN.contentView = contentView;
3657 return this;
3658 }
3659
3660 /**
3661 * Supply custom RemoteViews to use instead of the platform template in the expanded form.
3662 *
3663 * This will override the expanded layout that would otherwise be constructed by this
3664 * Builder object.
3665 */
3666 public Builder setCustomBigContentView(RemoteViews contentView) {
3667 mN.bigContentView = contentView;
3668 return this;
3669 }
3670
3671 /**
3672 * Supply custom RemoteViews to use instead of the platform template in the heads up dialog.
3673 *
3674 * This will override the heads-up layout that would otherwise be constructed by this
3675 * Builder object.
3676 */
3677 public Builder setCustomHeadsUpContentView(RemoteViews contentView) {
3678 mN.headsUpContentView = contentView;
Joe Onorato46439ce2010-11-19 13:56:21 -08003679 return this;
3680 }
3681
Joe Onoratocb109a02011-01-18 17:57:41 -08003682 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003683 * Supply a {@link PendingIntent} to be sent when the notification is clicked.
3684 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003685 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
3686 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
3687 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003688 * to assign PendingIntents to individual views in that custom layout (i.e., to create
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003689 * clickable buttons inside the notification view).
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003690 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003691 * @see Notification#contentIntent Notification.contentIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003692 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003693 public Builder setContentIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003694 mN.contentIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003695 return this;
3696 }
3697
Joe Onoratocb109a02011-01-18 17:57:41 -08003698 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003699 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
3700 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003701 * @see Notification#deleteIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003702 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003703 public Builder setDeleteIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003704 mN.deleteIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003705 return this;
3706 }
3707
Joe Onoratocb109a02011-01-18 17:57:41 -08003708 /**
3709 * An intent to launch instead of posting the notification to the status bar.
3710 * Only for use with extremely high-priority notifications demanding the user's
3711 * <strong>immediate</strong> attention, such as an incoming phone call or
3712 * alarm clock that the user has explicitly set to a particular time.
3713 * If this facility is used for something else, please give the user an option
3714 * to turn it off and use a normal notification, as this can be extremely
3715 * disruptive.
3716 *
Chris Wren47c20a12014-06-18 17:27:29 -04003717 * <p>
3718 * The system UI may choose to display a heads-up notification, instead of
3719 * launching this intent, while the user is using the device.
3720 * </p>
3721 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003722 * @param intent The pending intent to launch.
3723 * @param highPriority Passing true will cause this notification to be sent
3724 * even if other notifications are suppressed.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003725 *
3726 * @see Notification#fullScreenIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003727 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003728 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003729 mN.fullScreenIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003730 setFlag(FLAG_HIGH_PRIORITY, highPriority);
3731 return this;
3732 }
3733
Joe Onoratocb109a02011-01-18 17:57:41 -08003734 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003735 * Set the "ticker" text which is sent to accessibility services.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003736 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003737 * @see Notification#tickerText
Joe Onoratocb109a02011-01-18 17:57:41 -08003738 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003739 public Builder setTicker(CharSequence tickerText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003740 mN.tickerText = safeCharSequence(tickerText);
Joe Onorato46439ce2010-11-19 13:56:21 -08003741 return this;
3742 }
3743
Joe Onoratocb109a02011-01-18 17:57:41 -08003744 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003745 * Obsolete version of {@link #setTicker(CharSequence)}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003746 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003747 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003748 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003749 public Builder setTicker(CharSequence tickerText, RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003750 setTicker(tickerText);
3751 // views is ignored
Joe Onorato46439ce2010-11-19 13:56:21 -08003752 return this;
3753 }
3754
Joe Onoratocb109a02011-01-18 17:57:41 -08003755 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04003756 * Add a large icon to the notification content view.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003757 *
3758 * In the platform template, this image will be shown on the left of the notification view
Dan Sandlerd63f9322015-05-06 15:18:49 -04003759 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3760 * badge atop the large icon).
Dan Sandler08a04c12015-05-06 15:18:49 -04003761 */
Dan Sandlerd63f9322015-05-06 15:18:49 -04003762 public Builder setLargeIcon(Bitmap b) {
3763 return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
3764 }
3765
3766 /**
3767 * Add a large icon to the notification content view.
3768 *
3769 * In the platform template, this image will be shown on the left of the notification view
3770 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3771 * badge atop the large icon).
3772 */
3773 public Builder setLargeIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003774 mN.mLargeIcon = icon;
3775 mN.extras.putParcelable(EXTRA_LARGE_ICON, icon);
Joe Onorato46439ce2010-11-19 13:56:21 -08003776 return this;
3777 }
3778
Joe Onoratocb109a02011-01-18 17:57:41 -08003779 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003780 * Set the sound to play.
3781 *
John Spurlockc0650f022014-07-19 13:22:39 -04003782 * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes}
3783 * for notifications.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003784 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003785 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003786 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003787 @Deprecated
Joe Onorato52f80cd2010-11-21 15:34:48 -08003788 public Builder setSound(Uri sound) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003789 mN.sound = sound;
3790 mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
Joe Onorato52f80cd2010-11-21 15:34:48 -08003791 return this;
3792 }
3793
Joe Onoratocb109a02011-01-18 17:57:41 -08003794 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003795 * Set the sound to play, along with a specific stream on which to play it.
Joe Onoratocb109a02011-01-18 17:57:41 -08003796 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003797 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
3798 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003799 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003800 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -07003801 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003802 public Builder setSound(Uri sound, int streamType) {
Jean-Michel Trivi2f7511f2016-11-28 15:40:27 -08003803 PlayerBase.deprecateStreamTypeForPlayback(streamType, "Notification", "setSound()");
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003804 mN.sound = sound;
3805 mN.audioStreamType = streamType;
Joe Onorato46439ce2010-11-19 13:56:21 -08003806 return this;
3807 }
3808
Joe Onoratocb109a02011-01-18 17:57:41 -08003809 /**
John Spurlockc0650f022014-07-19 13:22:39 -04003810 * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to
3811 * use during playback.
3812 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003813 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
John Spurlockc0650f022014-07-19 13:22:39 -04003814 * @see Notification#sound
3815 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003816 @Deprecated
John Spurlockc0650f022014-07-19 13:22:39 -04003817 public Builder setSound(Uri sound, AudioAttributes audioAttributes) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003818 mN.sound = sound;
3819 mN.audioAttributes = audioAttributes;
John Spurlockc0650f022014-07-19 13:22:39 -04003820 return this;
3821 }
3822
3823 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003824 * Set the vibration pattern to use.
3825 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003826 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
3827 * <code>pattern</code> parameter.
3828 *
Chris Wren47c20a12014-06-18 17:27:29 -04003829 * <p>
3830 * A notification that vibrates is more likely to be presented as a heads-up notification.
3831 * </p>
3832 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003833 * @deprecated use {@link NotificationChannel#setVibrationPattern(long[])} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003834 * @see Notification#vibrate
Joe Onoratocb109a02011-01-18 17:57:41 -08003835 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003836 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003837 public Builder setVibrate(long[] pattern) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003838 mN.vibrate = pattern;
Joe Onorato46439ce2010-11-19 13:56:21 -08003839 return this;
3840 }
3841
Joe Onoratocb109a02011-01-18 17:57:41 -08003842 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003843 * Set the desired color for the indicator LED on the device, as well as the
3844 * blink duty cycle (specified in milliseconds).
3845 *
3846
3847 * Not all devices will honor all (or even any) of these values.
3848 *
Julia Reynolds529e3322017-02-06 08:33:01 -05003849 * @deprecated use {@link NotificationChannel#enableLights(boolean)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003850 * @see Notification#ledARGB
3851 * @see Notification#ledOnMS
3852 * @see Notification#ledOffMS
Joe Onoratocb109a02011-01-18 17:57:41 -08003853 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003854 @Deprecated
Tor Norbye80756e32015-03-02 09:39:27 -08003855 public Builder setLights(@ColorInt int argb, int onMs, int offMs) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003856 mN.ledARGB = argb;
3857 mN.ledOnMS = onMs;
3858 mN.ledOffMS = offMs;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05003859 if (onMs != 0 || offMs != 0) {
3860 mN.flags |= FLAG_SHOW_LIGHTS;
3861 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003862 return this;
3863 }
3864
Joe Onoratocb109a02011-01-18 17:57:41 -08003865 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003866 * Set whether this is an "ongoing" notification.
Joe Onoratocb109a02011-01-18 17:57:41 -08003867 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003868
3869 * Ongoing notifications cannot be dismissed by the user, so your application or service
3870 * must take care of canceling them.
3871 *
3872
3873 * They are typically used to indicate a background task that the user is actively engaged
3874 * with (e.g., playing music) or is pending in some way and therefore occupying the device
3875 * (e.g., a file download, sync operation, active network connection).
3876 *
3877
3878 * @see Notification#FLAG_ONGOING_EVENT
3879 * @see Service#setForeground(boolean)
Joe Onoratocb109a02011-01-18 17:57:41 -08003880 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003881 public Builder setOngoing(boolean ongoing) {
3882 setFlag(FLAG_ONGOING_EVENT, ongoing);
3883 return this;
3884 }
3885
Joe Onoratocb109a02011-01-18 17:57:41 -08003886 /**
Selim Cinek7b9605b2017-01-19 17:36:00 -08003887 * Set whether this notification should be colorized. When set, the color set with
3888 * {@link #setColor(int)} will be used as the background color of this notification.
3889 * <p>
Selim Cinek7b9605b2017-01-19 17:36:00 -08003890 * This should only be used for high priority ongoing tasks like navigation, an ongoing
3891 * call, or other similarly high-priority events for the user.
Selim Cinek99104832017-01-25 14:47:33 -08003892 * <p>
Selim Cinek22714f12017-04-13 16:23:53 -07003893 * For most styles, the coloring will only be applied if the notification is for a
3894 * foreground service notification.
Selim Cinek99104832017-01-25 14:47:33 -08003895 * However, for {@link MediaStyle} and {@link DecoratedMediaCustomViewStyle} notifications
Selim Cinek22714f12017-04-13 16:23:53 -07003896 * that have a media session attached there is no such requirement.
Selim Cinek7b9605b2017-01-19 17:36:00 -08003897 *
Selim Cinek7b9605b2017-01-19 17:36:00 -08003898 * @see Builder#setColor(int)
Selim Cinek99104832017-01-25 14:47:33 -08003899 * @see MediaStyle#setMediaSession(MediaSession.Token)
Selim Cinek7b9605b2017-01-19 17:36:00 -08003900 */
3901 public Builder setColorized(boolean colorize) {
3902 mN.extras.putBoolean(EXTRA_COLORIZED, colorize);
3903 return this;
3904 }
3905
3906 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003907 * Set this flag if you would only like the sound, vibrate
3908 * and ticker to be played if the notification is not already showing.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003909 *
3910 * @see Notification#FLAG_ONLY_ALERT_ONCE
Joe Onoratocb109a02011-01-18 17:57:41 -08003911 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003912 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
3913 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
3914 return this;
3915 }
3916
Joe Onoratocb109a02011-01-18 17:57:41 -08003917 /**
Julia Reynolds04499532016-09-13 14:04:53 -04003918 * Make this notification automatically dismissed when the user touches it.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003919 *
3920 * @see Notification#FLAG_AUTO_CANCEL
Joe Onoratocb109a02011-01-18 17:57:41 -08003921 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003922 public Builder setAutoCancel(boolean autoCancel) {
Joe Onorato281d83f2011-01-04 17:13:10 -08003923 setFlag(FLAG_AUTO_CANCEL, autoCancel);
Joe Onorato46439ce2010-11-19 13:56:21 -08003924 return this;
3925 }
3926
Joe Onoratocb109a02011-01-18 17:57:41 -08003927 /**
Griff Hazendfcb0802014-02-11 12:00:00 -08003928 * Set whether or not this notification should not bridge to other devices.
3929 *
3930 * <p>Some notifications can be bridged to other devices for remote display.
3931 * This hint can be set to recommend this notification not be bridged.
3932 */
3933 public Builder setLocalOnly(boolean localOnly) {
3934 setFlag(FLAG_LOCAL_ONLY, localOnly);
3935 return this;
3936 }
3937
3938 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003939 * Set which notification properties will be inherited from system defaults.
Joe Onoratocb109a02011-01-18 17:57:41 -08003940 * <p>
3941 * The value should be one or more of the following fields combined with
3942 * bitwise-or:
3943 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
3944 * <p>
3945 * For all default values, use {@link #DEFAULT_ALL}.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003946 *
3947 * @deprecated use {@link NotificationChannel#enableVibration(boolean)} and
Julia Reynolds529e3322017-02-06 08:33:01 -05003948 * {@link NotificationChannel#enableLights(boolean)} and
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003949 * {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003950 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003951 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003952 public Builder setDefaults(int defaults) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003953 mN.defaults = defaults;
Joe Onorato46439ce2010-11-19 13:56:21 -08003954 return this;
3955 }
3956
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003957 /**
3958 * Set the priority of this notification.
3959 *
3960 * @see Notification#priority
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003961 * @deprecated use {@link NotificationChannel#setImportance(int)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003962 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003963 @Deprecated
Tor Norbyed9273d62013-05-30 15:59:53 -07003964 public Builder setPriority(@Priority int pri) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003965 mN.priority = pri;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003966 return this;
3967 }
Joe Malin8d40d042012-11-05 11:36:40 -08003968
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003969 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04003970 * Set the notification category.
Joe Malin8d40d042012-11-05 11:36:40 -08003971 *
John Spurlockfd7f1e02014-03-18 16:41:57 -04003972 * @see Notification#category
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003973 */
John Spurlockfd7f1e02014-03-18 16:41:57 -04003974 public Builder setCategory(String category) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003975 mN.category = category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003976 return this;
3977 }
3978
3979 /**
Chris Wrendde75302014-03-26 17:24:15 -04003980 * Add a person that is relevant to this notification.
3981 *
Chris Wrene6c48932014-09-29 17:19:27 -04003982 * <P>
3983 * Depending on user preferences, this annotation may allow the notification to pass
Julia Reynoldse071abd2017-03-22 10:52:11 -04003984 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3985 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3986 * appear more prominently in the user interface.
Chris Wrene6c48932014-09-29 17:19:27 -04003987 * </P>
3988 *
3989 * <P>
3990 * The person should be specified by the {@code String} representation of a
3991 * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
3992 * </P>
3993 *
3994 * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
3995 * URIs. The path part of these URIs must exist in the contacts database, in the
3996 * appropriate column, or the reference will be discarded as invalid. Telephone schema
3997 * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
Selim Cineke7238dd2017-12-14 17:48:32 -08003998 * It is also possible to provide a URI with the schema {@code name:} in order to uniquely
3999 * identify a person without an entry in the contacts database.
Chris Wrene6c48932014-09-29 17:19:27 -04004000 * </P>
4001 *
4002 * @param uri A URI for the person.
Chris Wrendde75302014-03-26 17:24:15 -04004003 * @see Notification#EXTRA_PEOPLE
Selim Cineke7238dd2017-12-14 17:48:32 -08004004 * @deprecated use {@link #addPerson(Person)}
Chris Wrendde75302014-03-26 17:24:15 -04004005 */
Chris Wrene6c48932014-09-29 17:19:27 -04004006 public Builder addPerson(String uri) {
Selim Cinek9acd6732018-03-23 16:39:02 -07004007 addPerson(new Person.Builder().setUri(uri).build());
Selim Cineke7238dd2017-12-14 17:48:32 -08004008 return this;
4009 }
4010
4011 /**
4012 * Add a person that is relevant to this notification.
4013 *
4014 * <P>
4015 * Depending on user preferences, this annotation may allow the notification to pass
4016 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
4017 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
4018 * appear more prominently in the user interface.
4019 * </P>
4020 *
4021 * <P>
4022 * A person should usually contain a uri in order to benefit from the ranking boost.
4023 * However, even if no uri is provided, it's beneficial to provide other people in the
4024 * notification, such that listeners and voice only devices can announce and handle them
4025 * properly.
4026 * </P>
4027 *
4028 * @param person the person to add.
4029 * @see Notification#EXTRA_PEOPLE_LIST
4030 */
4031 public Builder addPerson(Person person) {
4032 mPersonList.add(person);
Chris Wrendde75302014-03-26 17:24:15 -04004033 return this;
4034 }
4035
4036 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004037 * Set this notification to be part of a group of notifications sharing the same key.
4038 * Grouped notifications may display in a cluster or stack on devices which
4039 * support such rendering.
4040 *
4041 * <p>To make this notification the summary for its group, also call
4042 * {@link #setGroupSummary}. A sort order can be specified for group members by using
4043 * {@link #setSortKey}.
4044 * @param groupKey The group key of the group.
4045 * @return this object for method chaining
4046 */
4047 public Builder setGroup(String groupKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004048 mN.mGroupKey = groupKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004049 return this;
4050 }
4051
4052 /**
4053 * Set this notification to be the group summary for a group of notifications.
4054 * Grouped notifications may display in a cluster or stack on devices which
Julia Reynolds04499532016-09-13 14:04:53 -04004055 * support such rendering. If thereRequires a group key also be set using {@link #setGroup}.
4056 * The group summary may be suppressed if too few notifications are included in the group.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004057 * @param isGroupSummary Whether this notification should be a group summary.
4058 * @return this object for method chaining
4059 */
4060 public Builder setGroupSummary(boolean isGroupSummary) {
4061 setFlag(FLAG_GROUP_SUMMARY, isGroupSummary);
4062 return this;
4063 }
4064
4065 /**
4066 * Set a sort key that orders this notification among other notifications from the
4067 * same package. This can be useful if an external sort was already applied and an app
4068 * would like to preserve this. Notifications will be sorted lexicographically using this
4069 * value, although providing different priorities in addition to providing sort key may
4070 * cause this value to be ignored.
4071 *
4072 * <p>This sort key can also be used to order members of a notification group. See
Griff Hazen9e1379f2014-05-20 12:50:51 -07004073 * {@link #setGroup}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004074 *
4075 * @see String#compareTo(String)
4076 */
4077 public Builder setSortKey(String sortKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004078 mN.mSortKey = sortKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004079 return this;
4080 }
4081
4082 /**
Griff Hazen720042b2014-02-24 15:46:56 -08004083 * Merge additional metadata into this notification.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004084 *
Griff Hazen720042b2014-02-24 15:46:56 -08004085 * <p>Values within the Bundle will replace existing extras values in this Builder.
4086 *
4087 * @see Notification#extras
4088 */
Griff Hazen959591e2014-05-15 22:26:18 -07004089 public Builder addExtras(Bundle extras) {
4090 if (extras != null) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004091 mUserExtras.putAll(extras);
Griff Hazen720042b2014-02-24 15:46:56 -08004092 }
4093 return this;
4094 }
4095
4096 /**
4097 * Set metadata for this notification.
4098 *
4099 * <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 -04004100 * current contents are copied into the Notification each time {@link #build()} is
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004101 * called.
4102 *
Griff Hazen720042b2014-02-24 15:46:56 -08004103 * <p>Replaces any existing extras values with those from the provided Bundle.
4104 * Use {@link #addExtras} to merge in metadata instead.
4105 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004106 * @see Notification#extras
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004107 */
Griff Hazen959591e2014-05-15 22:26:18 -07004108 public Builder setExtras(Bundle extras) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004109 if (extras != null) {
4110 mUserExtras = extras;
4111 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004112 return this;
4113 }
4114
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004115 /**
Griff Hazen720042b2014-02-24 15:46:56 -08004116 * Get the current metadata Bundle used by this notification Builder.
4117 *
4118 * <p>The returned Bundle is shared with this Builder.
4119 *
4120 * <p>The current contents of this Bundle are copied into the Notification each time
4121 * {@link #build()} is called.
4122 *
4123 * @see Notification#extras
4124 */
4125 public Bundle getExtras() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004126 return mUserExtras;
4127 }
4128
4129 private Bundle getAllExtras() {
4130 final Bundle saveExtras = (Bundle) mUserExtras.clone();
4131 saveExtras.putAll(mN.extras);
4132 return saveExtras;
Griff Hazen720042b2014-02-24 15:46:56 -08004133 }
4134
4135 /**
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004136 * Add an action to this notification. Actions are typically displayed by
4137 * the system as a button adjacent to the notification content.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004138 * <p>
4139 * Every action must have an icon (32dp square and matching the
4140 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4141 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4142 * <p>
4143 * A notification in its expanded form can display up to 3 actions, from left to right in
4144 * the order they were added. Actions will not be displayed when the notification is
4145 * collapsed, however, so be sure that any essential functions may be accessed by the user
4146 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004147 *
4148 * @param icon Resource ID of a drawable that represents the action.
4149 * @param title Text describing the action.
4150 * @param intent PendingIntent to be fired when the action is invoked.
Dan Sandler86647982015-05-13 23:41:13 -04004151 *
4152 * @deprecated Use {@link #addAction(Action)} instead.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004153 */
Dan Sandler86647982015-05-13 23:41:13 -04004154 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004155 public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004156 mActions.add(new Action(icon, safeCharSequence(title), intent));
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004157 return this;
4158 }
4159
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004160 /**
Griff Hazen959591e2014-05-15 22:26:18 -07004161 * Add an action to this notification. Actions are typically displayed by
4162 * the system as a button adjacent to the notification content.
4163 * <p>
4164 * Every action must have an icon (32dp square and matching the
4165 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4166 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4167 * <p>
4168 * A notification in its expanded form can display up to 3 actions, from left to right in
4169 * the order they were added. Actions will not be displayed when the notification is
4170 * collapsed, however, so be sure that any essential functions may be accessed by the user
4171 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
4172 *
4173 * @param action The action to add.
4174 */
4175 public Builder addAction(Action action) {
liangweikang63b03b52017-03-16 19:22:15 +08004176 if (action != null) {
4177 mActions.add(action);
4178 }
Griff Hazen959591e2014-05-15 22:26:18 -07004179 return this;
4180 }
4181
4182 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004183 * Alter the complete list of actions attached to this notification.
4184 * @see #addAction(Action).
4185 *
4186 * @param actions
4187 * @return
4188 */
4189 public Builder setActions(Action... actions) {
4190 mActions.clear();
4191 for (int i = 0; i < actions.length; i++) {
liangweikang63b03b52017-03-16 19:22:15 +08004192 if (actions[i] != null) {
4193 mActions.add(actions[i]);
4194 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004195 }
4196 return this;
4197 }
4198
4199 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004200 * Add a rich notification style to be applied at build time.
4201 *
4202 * @param style Object responsible for modifying the notification style.
4203 */
4204 public Builder setStyle(Style style) {
4205 if (mStyle != style) {
4206 mStyle = style;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004207 if (mStyle != null) {
4208 mStyle.setBuilder(this);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004209 mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName());
4210 } else {
4211 mN.extras.remove(EXTRA_TEMPLATE);
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004212 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004213 }
4214 return this;
4215 }
4216
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004217 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05004218 * Returns the style set by {@link #setStyle(Style)}.
4219 */
4220 public Style getStyle() {
4221 return mStyle;
4222 }
4223
4224 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004225 * Specify the value of {@link #visibility}.
Griff Hazenb720abe2014-05-20 13:15:30 -07004226 *
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004227 * @return The same Builder.
4228 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004229 public Builder setVisibility(@Visibility int visibility) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004230 mN.visibility = visibility;
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004231 return this;
4232 }
4233
4234 /**
4235 * Supply a replacement Notification whose contents should be shown in insecure contexts
4236 * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}.
4237 * @param n A replacement notification, presumably with some or all info redacted.
4238 * @return The same Builder.
4239 */
4240 public Builder setPublicVersion(Notification n) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004241 if (n != null) {
4242 mN.publicVersion = new Notification();
4243 n.cloneInto(mN.publicVersion, /*heavy=*/ true);
4244 } else {
4245 mN.publicVersion = null;
4246 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004247 return this;
4248 }
4249
Griff Hazenb720abe2014-05-20 13:15:30 -07004250 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004251 * Apply an extender to this notification builder. Extenders may be used to add
4252 * metadata or change options on this builder.
4253 */
Griff Hazen61a9e862014-05-22 16:05:19 -07004254 public Builder extend(Extender extender) {
4255 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004256 return this;
4257 }
4258
Dan Sandler4e787062015-06-17 15:09:48 -04004259 /**
4260 * @hide
4261 */
Julia Reynoldse46bb372016-03-17 11:05:58 -04004262 public Builder setFlag(int mask, boolean value) {
Joe Onorato46439ce2010-11-19 13:56:21 -08004263 if (value) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004264 mN.flags |= mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004265 } else {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004266 mN.flags &= ~mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004267 }
Julia Reynoldse46bb372016-03-17 11:05:58 -04004268 return this;
Joe Onorato46439ce2010-11-19 13:56:21 -08004269 }
4270
Dan Sandler26e81cf2014-05-06 10:01:27 -04004271 /**
4272 * Sets {@link Notification#color}.
4273 *
4274 * @param argb The accent color to use
4275 *
4276 * @return The same Builder.
4277 */
Tor Norbye80756e32015-03-02 09:39:27 -08004278 public Builder setColor(@ColorInt int argb) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004279 mN.color = argb;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05004280 sanitizeColor();
Dan Sandler26e81cf2014-05-06 10:01:27 -04004281 return this;
4282 }
4283
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004284 private Drawable getProfileBadgeDrawable() {
Chris Wren66619a22016-05-12 16:42:37 -04004285 if (mContext.getUserId() == UserHandle.USER_SYSTEM) {
4286 // This user can never be a badged profile,
4287 // and also includes USER_ALL system notifications.
4288 return null;
4289 }
Christoph Studer7ac80e62014-08-04 16:01:57 +02004290 // Note: This assumes that the current user can read the profile badge of the
4291 // originating user.
Selim Cineke6ff9462016-01-15 15:07:06 -08004292 return mContext.getPackageManager().getUserBadgeForDensityNoBackground(
Julia Reynoldsda303542015-11-23 14:00:20 -05004293 new UserHandle(mContext.getUserId()), 0);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004294 }
4295
4296 private Bitmap getProfileBadge() {
4297 Drawable badge = getProfileBadgeDrawable();
Kenny Guy8a0101b2014-05-08 23:34:12 +01004298 if (badge == null) {
4299 return null;
4300 }
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004301 final int size = mContext.getResources().getDimensionPixelSize(
4302 R.dimen.notification_badge_size);
4303 Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004304 Canvas canvas = new Canvas(bitmap);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004305 badge.setBounds(0, 0, size, size);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004306 badge.draw(canvas);
4307 return bitmap;
4308 }
4309
Selim Cinekc848c3a2016-01-13 15:27:30 -08004310 private void bindProfileBadge(RemoteViews contentView) {
Kenny Guy98193ea2014-07-24 19:54:37 +01004311 Bitmap profileBadge = getProfileBadge();
4312
Kenny Guy98193ea2014-07-24 19:54:37 +01004313 if (profileBadge != null) {
Selim Cinekc848c3a2016-01-13 15:27:30 -08004314 contentView.setImageViewBitmap(R.id.profile_badge, profileBadge);
4315 contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004316 if (isColorized()) {
Sunny Goyal5b153922017-09-21 21:00:36 -07004317 contentView.setDrawableTint(R.id.profile_badge, false,
4318 getPrimaryTextColor(), PorterDuff.Mode.SRC_ATOP);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004319 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004320 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004321 }
4322
Julia Reynoldsfc640012018-02-21 12:25:27 -05004323 /**
4324 * @hide
4325 */
4326 public boolean usesStandardHeader() {
4327 if (mN.mUsesStandardHeader) {
4328 return true;
4329 }
4330 if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.N) {
4331 if (mN.contentView == null && mN.bigContentView == null) {
4332 return true;
4333 }
4334 }
4335 boolean contentViewUsesHeader = mN.contentView == null
4336 || STANDARD_LAYOUTS.contains(mN.contentView.getLayoutId());
4337 boolean bigContentViewUsesHeader = mN.bigContentView == null
4338 || STANDARD_LAYOUTS.contains(mN.bigContentView.getLayoutId());
4339 return contentViewUsesHeader && bigContentViewUsesHeader;
4340 }
4341
Christoph Studerfe718432014-09-01 18:21:18 +02004342 private void resetStandardTemplate(RemoteViews contentView) {
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004343 resetNotificationHeader(contentView);
Christoph Studerfe718432014-09-01 18:21:18 +02004344 contentView.setViewVisibility(R.id.right_icon, View.GONE);
Selim Cinek860b6da2015-12-16 19:02:19 -08004345 contentView.setViewVisibility(R.id.title, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004346 contentView.setTextViewText(R.id.title, null);
Selim Cinek41598732016-01-11 16:58:37 -08004347 contentView.setViewVisibility(R.id.text, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004348 contentView.setTextViewText(R.id.text, null);
Selim Cinek29603462015-11-17 19:04:39 -08004349 contentView.setViewVisibility(R.id.text_line_1, View.GONE);
Selim Cinek41598732016-01-11 16:58:37 -08004350 contentView.setTextViewText(R.id.text_line_1, null);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004351 }
4352
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004353 /**
4354 * Resets the notification header to its original state
4355 */
4356 private void resetNotificationHeader(RemoteViews contentView) {
Adrian Roosc4337a32016-08-02 18:30:34 -07004357 // Small icon doesn't need to be reset, as it's always set. Resetting would prevent
4358 // re-using the drawable when the notification is updated.
Selim Cinek7b836392015-12-04 20:02:59 -08004359 contentView.setBoolean(R.id.notification_header, "setExpanded", false);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004360 contentView.setTextViewText(R.id.app_name_text, null);
Christoph Studerca1db712014-09-10 17:31:33 +02004361 contentView.setViewVisibility(R.id.chronometer, View.GONE);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004362 contentView.setViewVisibility(R.id.header_text, View.GONE);
Adrian Roos9dfb78f2016-06-30 15:43:44 -07004363 contentView.setTextViewText(R.id.header_text, null);
Selim Cinekafeed292017-12-12 17:32:44 -08004364 contentView.setViewVisibility(R.id.header_text_secondary, View.GONE);
4365 contentView.setTextViewText(R.id.header_text_secondary, null);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004366 contentView.setViewVisibility(R.id.header_text_divider, View.GONE);
Selim Cinekafeed292017-12-12 17:32:44 -08004367 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004368 contentView.setViewVisibility(R.id.time_divider, View.GONE);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004369 contentView.setViewVisibility(R.id.time, View.GONE);
Selim Cinekc848c3a2016-01-13 15:27:30 -08004370 contentView.setImageViewIcon(R.id.profile_badge, null);
4371 contentView.setViewVisibility(R.id.profile_badge, View.GONE);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004372 mN.mUsesStandardHeader = false;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004373 }
4374
Selim Cinek384804b2018-04-18 14:31:07 +08004375 private RemoteViews applyStandardTemplate(int resId, TemplateBindResult result) {
4376 return applyStandardTemplate(resId, mParams.reset().fillTextsFrom(this),
4377 result);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004378 }
4379
4380 /**
4381 * @param hasProgress whether the progress bar should be shown and set
Selim Cinek384804b2018-04-18 14:31:07 +08004382 * @param result
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004383 */
Selim Cinek384804b2018-04-18 14:31:07 +08004384 private RemoteViews applyStandardTemplate(int resId, boolean hasProgress,
4385 TemplateBindResult result) {
Adrian Roos70d7aa32017-01-11 15:39:06 -08004386 return applyStandardTemplate(resId, mParams.reset().hasProgress(hasProgress)
Selim Cinek384804b2018-04-18 14:31:07 +08004387 .fillTextsFrom(this), result);
Adrian Roosc1a80b02016-04-05 14:54:55 -07004388 }
4389
Selim Cinek384804b2018-04-18 14:31:07 +08004390 private RemoteViews applyStandardTemplate(int resId, StandardTemplateParams p,
4391 TemplateBindResult result) {
Kenny Guy77320062014-08-27 21:37:15 +01004392 RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId);
Dan Sandler539aad42014-08-04 00:43:39 -04004393
Christoph Studerfe718432014-09-01 18:21:18 +02004394 resetStandardTemplate(contentView);
4395
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004396 final Bundle ex = mN.extras;
Selim Cinek7b9605b2017-01-19 17:36:00 -08004397 updateBackgroundColor(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004398 bindNotificationHeader(contentView, p.ambient, p.headerTextSecondary);
Selim Cinek384804b2018-04-18 14:31:07 +08004399 bindLargeIconAndReply(contentView, p, result);
Adrian Roos70d7aa32017-01-11 15:39:06 -08004400 boolean showProgress = handleProgressBar(p.hasProgress, contentView, ex);
4401 if (p.title != null) {
Selim Cinek860b6da2015-12-16 19:02:19 -08004402 contentView.setViewVisibility(R.id.title, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004403 contentView.setTextViewText(R.id.title, processTextSpans(p.title));
Adrian Roos72171622017-01-27 10:32:06 -08004404 if (!p.ambient) {
4405 setTextViewColorPrimary(contentView, R.id.title);
4406 }
Selim Cinek954cc232016-05-20 13:29:23 -07004407 contentView.setViewLayoutWidth(R.id.title, showProgress
4408 ? ViewGroup.LayoutParams.WRAP_CONTENT
4409 : ViewGroup.LayoutParams.MATCH_PARENT);
Joe Onorato561d3852010-11-20 18:09:34 -08004410 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08004411 if (p.text != null) {
Selim Cinek41598732016-01-11 16:58:37 -08004412 int textId = showProgress ? com.android.internal.R.id.text_line_1
4413 : com.android.internal.R.id.text;
Selim Cinek48f66b72017-08-18 16:17:51 -07004414 contentView.setTextViewText(textId, processTextSpans(p.text));
Adrian Roos72171622017-01-27 10:32:06 -08004415 if (!p.ambient) {
4416 setTextViewColorSecondary(contentView, textId);
4417 }
Selim Cinek41598732016-01-11 16:58:37 -08004418 contentView.setViewVisibility(textId, View.VISIBLE);
Joe Onorato561d3852010-11-20 18:09:34 -08004419 }
Selim Cinekc848c3a2016-01-13 15:27:30 -08004420
Selim Cinek279fa862016-06-14 10:57:25 -07004421 setContentMinHeight(contentView, showProgress || mN.hasLargeIcon());
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004422
Selim Cinek29603462015-11-17 19:04:39 -08004423 return contentView;
4424 }
4425
Selim Cinek48f66b72017-08-18 16:17:51 -07004426 private CharSequence processTextSpans(CharSequence text) {
4427 if (hasForegroundColor()) {
Selim Cinek87c31532017-08-18 18:53:44 -07004428 return NotificationColorUtil.clearColorSpans(text);
Selim Cinek48f66b72017-08-18 16:17:51 -07004429 }
4430 return text;
4431 }
4432
Selim Cinek7b9605b2017-01-19 17:36:00 -08004433 private void setTextViewColorPrimary(RemoteViews contentView, int id) {
4434 ensureColors();
4435 contentView.setTextColor(id, mPrimaryTextColor);
4436 }
4437
Selim Cinek48f66b72017-08-18 16:17:51 -07004438 private boolean hasForegroundColor() {
4439 return mForegroundColor != COLOR_INVALID;
4440 }
4441
Selim Cinek389edcd2017-05-11 19:16:44 -07004442 /**
4443 * @return the primary text color
4444 * @hide
4445 */
4446 @VisibleForTesting
4447 public int getPrimaryTextColor() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004448 ensureColors();
4449 return mPrimaryTextColor;
4450 }
4451
Selim Cinek389edcd2017-05-11 19:16:44 -07004452 /**
4453 * @return the secondary text color
4454 * @hide
4455 */
4456 @VisibleForTesting
4457 public int getSecondaryTextColor() {
4458 ensureColors();
4459 return mSecondaryTextColor;
4460 }
4461
Selim Cinek7b9605b2017-01-19 17:36:00 -08004462 private void setTextViewColorSecondary(RemoteViews contentView, int id) {
4463 ensureColors();
4464 contentView.setTextColor(id, mSecondaryTextColor);
4465 }
4466
4467 private void ensureColors() {
4468 int backgroundColor = getBackgroundColor();
4469 if (mPrimaryTextColor == COLOR_INVALID
4470 || mSecondaryTextColor == COLOR_INVALID
Selim Cinek7b9605b2017-01-19 17:36:00 -08004471 || mTextColorsAreForBackground != backgroundColor) {
4472 mTextColorsAreForBackground = backgroundColor;
Selim Cinek48f66b72017-08-18 16:17:51 -07004473 if (!hasForegroundColor() || !isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004474 mPrimaryTextColor = NotificationColorUtil.resolvePrimaryColor(mContext,
4475 backgroundColor);
4476 mSecondaryTextColor = NotificationColorUtil.resolveSecondaryColor(mContext,
4477 backgroundColor);
Selim Cinekc7f5a822018-03-20 19:32:06 -07004478 if (backgroundColor != COLOR_DEFAULT && isColorized()) {
Selim Cinekac5f0272017-05-02 16:05:41 -07004479 mPrimaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4480 mPrimaryTextColor, backgroundColor, 4.5);
4481 mSecondaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4482 mSecondaryTextColor, backgroundColor, 4.5);
4483 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07004484 } else {
4485 double backLum = NotificationColorUtil.calculateLuminance(backgroundColor);
4486 double textLum = NotificationColorUtil.calculateLuminance(mForegroundColor);
4487 double contrast = NotificationColorUtil.calculateContrast(mForegroundColor,
4488 backgroundColor);
Selim Cinek389edcd2017-05-11 19:16:44 -07004489 // We only respect the given colors if worst case Black or White still has
4490 // contrast
4491 boolean backgroundLight = backLum > textLum
4492 && satisfiesTextContrast(backgroundColor, Color.BLACK)
4493 || backLum <= textLum
4494 && !satisfiesTextContrast(backgroundColor, Color.WHITE);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004495 if (contrast < 4.5f) {
Selim Cinek389edcd2017-05-11 19:16:44 -07004496 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004497 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4498 mForegroundColor,
4499 backgroundColor,
4500 true /* findFG */,
4501 4.5f);
4502 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004503 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_LIGHT);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004504 } else {
4505 mSecondaryTextColor =
4506 NotificationColorUtil.findContrastColorAgainstDark(
4507 mForegroundColor,
4508 backgroundColor,
4509 true /* findFG */,
4510 4.5f);
4511 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004512 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004513 }
4514 } else {
4515 mPrimaryTextColor = mForegroundColor;
4516 mSecondaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004517 mPrimaryTextColor, backgroundLight ? LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4518 : LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004519 if (NotificationColorUtil.calculateContrast(mSecondaryTextColor,
4520 backgroundColor) < 4.5f) {
4521 // oh well the secondary is not good enough
Selim Cinek389edcd2017-05-11 19:16:44 -07004522 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004523 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4524 mSecondaryTextColor,
4525 backgroundColor,
4526 true /* findFG */,
4527 4.5f);
4528 } else {
4529 mSecondaryTextColor
4530 = NotificationColorUtil.findContrastColorAgainstDark(
4531 mSecondaryTextColor,
4532 backgroundColor,
4533 true /* findFG */,
4534 4.5f);
4535 }
4536 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004537 mSecondaryTextColor, backgroundLight
4538 ? -LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4539 : -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004540 }
4541 }
4542 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08004543 }
4544 }
4545
4546 private void updateBackgroundColor(RemoteViews contentView) {
4547 if (isColorized()) {
4548 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundColor",
4549 getBackgroundColor());
4550 } else {
4551 // Clear it!
4552 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundResource",
4553 0);
4554 }
4555 }
4556
Selim Cinek860b6da2015-12-16 19:02:19 -08004557 /**
4558 * @param remoteView the remote view to update the minheight in
4559 * @param hasMinHeight does it have a mimHeight
4560 * @hide
4561 */
4562 void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) {
4563 int minHeight = 0;
4564 if (hasMinHeight) {
4565 // we need to set the minHeight of the notification
4566 minHeight = mContext.getResources().getDimensionPixelSize(
4567 com.android.internal.R.dimen.notification_min_content_height);
4568 }
4569 remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight);
4570 }
4571
Selim Cinek29603462015-11-17 19:04:39 -08004572 private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004573 final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0);
4574 final int progress = ex.getInt(EXTRA_PROGRESS, 0);
4575 final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
4576 if (hasProgress && (max != 0 || ind)) {
Selim Cinek29603462015-11-17 19:04:39 -08004577 contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004578 contentView.setProgressBar(
Selim Cinek29603462015-11-17 19:04:39 -08004579 R.id.progress, max, progress, ind);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004580 contentView.setProgressBackgroundTintList(
4581 R.id.progress, ColorStateList.valueOf(mContext.getColor(
4582 R.color.notification_progress_background_color)));
Selim Cinek29603462015-11-17 19:04:39 -08004583 if (mN.color != COLOR_DEFAULT) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08004584 ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004585 contentView.setProgressTintList(R.id.progress, colorStateList);
4586 contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004587 }
Selim Cinek29603462015-11-17 19:04:39 -08004588 return true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004589 } else {
4590 contentView.setViewVisibility(R.id.progress, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004591 return false;
Jeff Sharkey1c400132011-08-05 14:50:13 -07004592 }
Joe Onorato561d3852010-11-20 18:09:34 -08004593 }
4594
Selim Cinek384804b2018-04-18 14:31:07 +08004595 private void bindLargeIconAndReply(RemoteViews contentView, StandardTemplateParams p,
4596 TemplateBindResult result) {
4597 boolean largeIconShown = bindLargeIcon(contentView, p.hideLargeIcon || p.ambient);
Selim Cinek1c72fa02018-04-23 18:00:54 +08004598 boolean replyIconShown = bindReplyIcon(contentView, p.hideReplyIcon || p.ambient);
Selim Cinek384804b2018-04-18 14:31:07 +08004599 contentView.setViewVisibility(R.id.right_icon_container,
Selim Cinek1c72fa02018-04-23 18:00:54 +08004600 largeIconShown || replyIconShown ? View.VISIBLE : View.GONE);
4601 int marginEnd = calculateMarginEnd(largeIconShown, replyIconShown);
4602 contentView.setViewLayoutMarginEnd(R.id.line1, marginEnd);
4603 contentView.setViewLayoutMarginEnd(R.id.text, marginEnd);
4604 contentView.setViewLayoutMarginEnd(R.id.progress, marginEnd);
Selim Cinek384804b2018-04-18 14:31:07 +08004605 if (result != null) {
Selim Cinek1c72fa02018-04-23 18:00:54 +08004606 result.setIconMarginEnd(marginEnd);
Selim Cinek384804b2018-04-18 14:31:07 +08004607 }
4608 }
4609
Selim Cinek1c72fa02018-04-23 18:00:54 +08004610 private int calculateMarginEnd(boolean largeIconShown, boolean replyIconShown) {
4611 int marginEnd = 0;
4612 int contentMargin = mContext.getResources().getDimensionPixelSize(
4613 R.dimen.notification_content_margin_end);
4614 int iconSize = mContext.getResources().getDimensionPixelSize(
4615 R.dimen.notification_right_icon_size);
4616 if (replyIconShown) {
4617 // The size of the reply icon
4618 marginEnd += iconSize;
4619
4620 int replyInset = mContext.getResources().getDimensionPixelSize(
4621 R.dimen.notification_reply_inset);
4622 // We're subtracting the inset of the reply icon to make sure it's
4623 // aligned nicely on the right, and remove it from the following padding
4624 marginEnd -= replyInset * 2;
4625 }
4626 if (largeIconShown) {
4627 // adding size of the right icon
4628 marginEnd += iconSize;
4629
4630 if (replyIconShown) {
4631 // We also add some padding to the reply icon if it's around
4632 marginEnd += contentMargin;
4633 }
4634 }
4635 if (replyIconShown || largeIconShown) {
4636 // The padding to the content
4637 marginEnd += contentMargin;
4638 }
4639 return marginEnd;
4640 }
4641
Selim Cinek384804b2018-04-18 14:31:07 +08004642 /**
4643 * Bind the large icon.
4644 * @return if the largeIcon is visible
4645 */
4646 private boolean bindLargeIcon(RemoteViews contentView, boolean hideLargeIcon) {
Selim Cinek279fa862016-06-14 10:57:25 -07004647 if (mN.mLargeIcon == null && mN.largeIcon != null) {
4648 mN.mLargeIcon = Icon.createWithBitmap(mN.largeIcon);
4649 }
Selim Cinek88188f22017-09-19 16:46:56 -07004650 boolean showLargeIcon = mN.mLargeIcon != null && !hideLargeIcon;
4651 if (showLargeIcon) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004652 contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4653 contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon);
4654 processLargeLegacyIcon(mN.mLargeIcon, contentView);
Selim Cinek88188f22017-09-19 16:46:56 -07004655 }
Selim Cinek384804b2018-04-18 14:31:07 +08004656 return showLargeIcon;
4657 }
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004658
Selim Cinek384804b2018-04-18 14:31:07 +08004659 /**
4660 * Bind the reply icon.
4661 * @return if the reply icon is visible
4662 */
4663 private boolean bindReplyIcon(RemoteViews contentView, boolean hideReplyIcon) {
4664 boolean actionVisible = !hideReplyIcon;
4665 Action action = null;
Selim Cinek88188f22017-09-19 16:46:56 -07004666 if (actionVisible) {
Selim Cinek384804b2018-04-18 14:31:07 +08004667 action = findReplyAction();
4668 actionVisible = action != null;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004669 }
Selim Cinek384804b2018-04-18 14:31:07 +08004670 if (actionVisible) {
4671 contentView.setViewVisibility(R.id.reply_icon_action, View.VISIBLE);
4672 contentView.setDrawableTint(R.id.reply_icon_action,
4673 false /* targetBackground */,
Selim Cinek4717d862018-04-19 09:19:15 +08004674 getNeutralColor(),
Selim Cinek384804b2018-04-18 14:31:07 +08004675 PorterDuff.Mode.SRC_ATOP);
4676 contentView.setOnClickPendingIntent(R.id.reply_icon_action, action.actionIntent);
4677 contentView.setRemoteInputs(R.id.reply_icon_action, action.mRemoteInputs);
4678 } else {
4679 contentView.setRemoteInputs(R.id.reply_icon_action, null);
4680 }
4681 contentView.setViewVisibility(R.id.reply_icon_action,
4682 actionVisible ? View.VISIBLE : View.GONE);
4683 return actionVisible;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004684 }
4685
4686 private Action findReplyAction() {
4687 ArrayList<Action> actions = mActions;
4688 if (mOriginalActions != null) {
4689 actions = mOriginalActions;
4690 }
4691 int numActions = actions.size();
4692 for (int i = 0; i < numActions; i++) {
4693 Action action = actions.get(i);
4694 if (hasValidRemoteInput(action)) {
4695 return action;
4696 }
4697 }
4698 return null;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004699 }
4700
Selim Cinekafeed292017-12-12 17:32:44 -08004701 private void bindNotificationHeader(RemoteViews contentView, boolean ambient,
4702 CharSequence secondaryHeaderText) {
Adrian Roos487374f2017-01-11 15:48:14 -08004703 bindSmallIcon(contentView, ambient);
4704 bindHeaderAppName(contentView, ambient);
4705 if (!ambient) {
4706 // Ambient view does not have these
4707 bindHeaderText(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004708 bindHeaderTextSecondary(contentView, secondaryHeaderText);
Adrian Roos487374f2017-01-11 15:48:14 -08004709 bindHeaderChronometerAndTime(contentView);
Adrian Roos487374f2017-01-11 15:48:14 -08004710 bindProfileBadge(contentView);
4711 }
Julia Reynolds6013e5c2018-04-18 08:43:34 -04004712 bindActivePermissions(contentView, ambient);
Adrian Roosd83e9992017-03-16 15:17:57 -07004713 bindExpandButton(contentView);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004714 mN.mUsesStandardHeader = true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004715 }
4716
Julia Reynolds6013e5c2018-04-18 08:43:34 -04004717 private void bindActivePermissions(RemoteViews contentView, boolean ambient) {
Selim Cinek4717d862018-04-19 09:19:15 +08004718 int color = ambient ? resolveAmbientColor() : getNeutralColor();
Julia Reynoldsb887b232018-04-10 16:38:08 -04004719 contentView.setDrawableTint(R.id.camera, false, color, PorterDuff.Mode.SRC_ATOP);
4720 contentView.setDrawableTint(R.id.mic, false, color, PorterDuff.Mode.SRC_ATOP);
4721 contentView.setDrawableTint(R.id.overlay, false, color, PorterDuff.Mode.SRC_ATOP);
4722 }
4723
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004724 private void bindExpandButton(RemoteViews contentView) {
Selim Cinekc7f5a822018-03-20 19:32:06 -07004725 int color = isColorized() ? getPrimaryTextColor() : getSecondaryTextColor();
Sunny Goyal5b153922017-09-21 21:00:36 -07004726 contentView.setDrawableTint(R.id.expand_button, false, color,
4727 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08004728 contentView.setInt(R.id.notification_header, "setOriginalNotificationColor",
Selim Cinek7b9605b2017-01-19 17:36:00 -08004729 color);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004730 }
4731
4732 private void bindHeaderChronometerAndTime(RemoteViews contentView) {
4733 if (showsTimeOrChronometer()) {
Selim Cinek29603462015-11-17 19:04:39 -08004734 contentView.setViewVisibility(R.id.time_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004735 setTextViewColorSecondary(contentView, R.id.time_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004736 if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) {
4737 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
4738 contentView.setLong(R.id.chronometer, "setBase",
4739 mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
4740 contentView.setBoolean(R.id.chronometer, "setStarted", true);
Adrian Roos96b7e202016-05-17 13:50:38 -07004741 boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN);
Selim Cinekc3b752e2016-04-20 16:13:59 -07004742 contentView.setChronometerCountDown(R.id.chronometer, countsDown);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004743 setTextViewColorSecondary(contentView, R.id.chronometer);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004744 } else {
4745 contentView.setViewVisibility(R.id.time, View.VISIBLE);
4746 contentView.setLong(R.id.time, "setTime", mN.when);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004747 setTextViewColorSecondary(contentView, R.id.time);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004748 }
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004749 } else {
4750 // We still want a time to be set but gone, such that we can show and hide it
4751 // on demand in case it's a child notification without anything in the header
4752 contentView.setLong(R.id.time, "setTime", mN.when != 0 ? mN.when : mN.creationTime);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004753 }
4754 }
4755
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004756 private void bindHeaderText(RemoteViews contentView) {
4757 CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
4758 if (headerText == null && mStyle != null && mStyle.mSummaryTextSet
Selim Cinek03d0d652015-11-13 13:18:09 -05004759 && mStyle.hasSummaryInHeader()) {
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004760 headerText = mStyle.mSummaryText;
Selim Cinek03d0d652015-11-13 13:18:09 -05004761 }
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004762 if (headerText == null
4763 && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
4764 && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) {
4765 headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT);
4766 }
4767 if (headerText != null) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004768 // TODO: Remove the span entirely to only have the string with propper formating.
Selim Cinek48f66b72017-08-18 16:17:51 -07004769 contentView.setTextViewText(R.id.header_text, processTextSpans(
4770 processLegacyText(headerText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004771 setTextViewColorSecondary(contentView, R.id.header_text);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004772 contentView.setViewVisibility(R.id.header_text, View.VISIBLE);
4773 contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004774 setTextViewColorSecondary(contentView, R.id.header_text_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004775 }
4776 }
4777
Selim Cinekafeed292017-12-12 17:32:44 -08004778 private void bindHeaderTextSecondary(RemoteViews contentView, CharSequence secondaryText) {
4779 if (!TextUtils.isEmpty(secondaryText)) {
4780 contentView.setTextViewText(R.id.header_text_secondary, processTextSpans(
4781 processLegacyText(secondaryText)));
4782 setTextViewColorSecondary(contentView, R.id.header_text_secondary);
4783 contentView.setViewVisibility(R.id.header_text_secondary, View.VISIBLE);
4784 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.VISIBLE);
4785 setTextViewColorSecondary(contentView, R.id.header_text_secondary_divider);
4786 }
4787 }
4788
Adrian Rooseba05822016-04-22 17:09:27 -07004789 /**
4790 * @hide
4791 */
4792 public String loadHeaderAppName() {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004793 CharSequence name = null;
4794 final PackageManager pm = mContext.getPackageManager();
4795 if (mN.extras.containsKey(EXTRA_SUBSTITUTE_APP_NAME)) {
4796 // only system packages which lump together a bunch of unrelated stuff
4797 // may substitute a different name to make the purpose of the
4798 // notification more clear. the correct package label should always
4799 // be accessible via SystemUI.
4800 final String pkg = mContext.getPackageName();
4801 final String subName = mN.extras.getString(EXTRA_SUBSTITUTE_APP_NAME);
4802 if (PackageManager.PERMISSION_GRANTED == pm.checkPermission(
4803 android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME, pkg)) {
4804 name = subName;
4805 } else {
4806 Log.w(TAG, "warning: pkg "
4807 + pkg + " attempting to substitute app name '" + subName
4808 + "' without holding perm "
4809 + android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME);
4810 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004811 }
Dan Sandler732bd6c2016-04-12 14:20:32 -04004812 if (TextUtils.isEmpty(name)) {
4813 name = pm.getApplicationLabel(mContext.getApplicationInfo());
4814 }
4815 if (TextUtils.isEmpty(name)) {
4816 // still nothing?
4817 return null;
4818 }
4819
4820 return String.valueOf(name);
4821 }
Adrian Roos487374f2017-01-11 15:48:14 -08004822 private void bindHeaderAppName(RemoteViews contentView, boolean ambient) {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004823 contentView.setTextViewText(R.id.app_name_text, loadHeaderAppName());
Adrian Roos72171622017-01-27 10:32:06 -08004824 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004825 setTextViewColorPrimary(contentView, R.id.app_name_text);
4826 } else {
4827 contentView.setTextColor(R.id.app_name_text,
Selim Cinekc7f5a822018-03-20 19:32:06 -07004828 ambient ? resolveAmbientColor() : getSecondaryTextColor());
Selim Cinek7b9605b2017-01-19 17:36:00 -08004829 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004830 }
4831
Adrian Roos487374f2017-01-11 15:48:14 -08004832 private void bindSmallIcon(RemoteViews contentView, boolean ambient) {
Selim Cinek279fa862016-06-14 10:57:25 -07004833 if (mN.mSmallIcon == null && mN.icon != 0) {
4834 mN.mSmallIcon = Icon.createWithResource(mContext, mN.icon);
4835 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004836 contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon);
Sunny Goyal5b153922017-09-21 21:00:36 -07004837 contentView.setInt(R.id.icon, "setImageLevel", mN.iconLevel);
Adrian Roos487374f2017-01-11 15:48:14 -08004838 processSmallIconColor(mN.mSmallIcon, contentView, ambient);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004839 }
4840
Jorim Jaggi445d3c02014-08-19 22:33:42 +02004841 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004842 * @return true if the built notification will show the time or the chronometer; false
4843 * otherwise
4844 */
4845 private boolean showsTimeOrChronometer() {
Selim Cinekc2c0b042016-05-18 17:13:46 -07004846 return mN.showsTime() || mN.showsChronometer();
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004847 }
4848
Christoph Studerfe718432014-09-01 18:21:18 +02004849 private void resetStandardTemplateWithActions(RemoteViews big) {
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004850 // actions_container is only reset when there are no actions to avoid focus issues with
4851 // remote inputs.
Christoph Studerfe718432014-09-01 18:21:18 +02004852 big.setViewVisibility(R.id.actions, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004853 big.removeAllViews(R.id.actions);
Adrian Roose458aa82015-12-08 16:17:19 -08004854
4855 big.setViewVisibility(R.id.notification_material_reply_container, View.GONE);
4856 big.setTextViewText(R.id.notification_material_reply_text_1, null);
Kenny Guya0f6de82018-04-06 16:20:16 +01004857 big.setViewVisibility(R.id.notification_material_reply_text_1_container, View.GONE);
4858 big.setViewVisibility(R.id.notification_material_reply_progress, View.GONE);
Adrian Roose458aa82015-12-08 16:17:19 -08004859
4860 big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE);
4861 big.setTextViewText(R.id.notification_material_reply_text_2, null);
4862 big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE);
4863 big.setTextViewText(R.id.notification_material_reply_text_3, null);
Adrian Roosf852a422016-06-03 13:33:43 -07004864
Selim Cineked64a142018-02-06 18:06:01 -08004865 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target,
4866 R.dimen.notification_content_margin);
Christoph Studerfe718432014-09-01 18:21:18 +02004867 }
4868
Selim Cinek384804b2018-04-18 14:31:07 +08004869 private RemoteViews applyStandardTemplateWithActions(int layoutId,
4870 TemplateBindResult result) {
4871 return applyStandardTemplateWithActions(layoutId, mParams.reset().fillTextsFrom(this),
4872 result);
Adrian Roos48d746a2016-04-12 14:57:28 -07004873 }
4874
Adrian Roos70d7aa32017-01-11 15:39:06 -08004875 private RemoteViews applyStandardTemplateWithActions(int layoutId,
Selim Cinek384804b2018-04-18 14:31:07 +08004876 StandardTemplateParams p, TemplateBindResult result) {
4877 RemoteViews big = applyStandardTemplate(layoutId, p, result);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004878
Christoph Studerfe718432014-09-01 18:21:18 +02004879 resetStandardTemplateWithActions(big);
4880
Adrian Roose458aa82015-12-08 16:17:19 -08004881 boolean validRemoteInput = false;
4882
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004883 int N = mActions.size();
Adrian Roos487374f2017-01-11 15:48:14 -08004884 boolean emphazisedMode = mN.fullScreenIntent != null && !p.ambient;
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004885 big.setBoolean(R.id.actions, "setEmphasizedMode", emphazisedMode);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004886 if (N > 0) {
Adrian Roos7052de52016-03-03 15:53:34 -08004887 big.setViewVisibility(R.id.actions_container, View.VISIBLE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004888 big.setViewVisibility(R.id.actions, View.VISIBLE);
Selim Cineked64a142018-02-06 18:06:01 -08004889 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, 0);
Daniel Sandler8680bf82012-05-15 16:52:52 -04004890 if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004891 for (int i=0; i<N; i++) {
Adrian Roose458aa82015-12-08 16:17:19 -08004892 Action action = mActions.get(i);
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004893 boolean actionHasValidInput = hasValidRemoteInput(action);
4894 validRemoteInput |= actionHasValidInput;
Adrian Roose458aa82015-12-08 16:17:19 -08004895
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004896 final RemoteViews button = generateActionButton(action, emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07004897 p.ambient);
4898 if (actionHasValidInput && !emphazisedMode) {
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004899 // Clear the drawable
4900 button.setInt(R.id.action0, "setBackgroundResource", 0);
4901 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004902 big.addView(R.id.actions, button);
4903 }
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004904 } else {
4905 big.setViewVisibility(R.id.actions_container, View.GONE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004906 }
Adrian Roose458aa82015-12-08 16:17:19 -08004907
4908 CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
Adrian Roos487374f2017-01-11 15:48:14 -08004909 if (!p.ambient && validRemoteInput && replyText != null
Selim Cinekbee4e072018-05-21 22:06:43 -07004910 && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])
4911 && p.maxRemoteInputHistory > 0) {
Kenny Guya0f6de82018-04-06 16:20:16 +01004912 boolean showSpinner = mN.extras.getBoolean(EXTRA_SHOW_REMOTE_INPUT_SPINNER);
Adrian Roose458aa82015-12-08 16:17:19 -08004913 big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE);
Kenny Guya0f6de82018-04-06 16:20:16 +01004914 big.setViewVisibility(R.id.notification_material_reply_text_1_container,
4915 View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004916 big.setTextViewText(R.id.notification_material_reply_text_1,
4917 processTextSpans(replyText[0]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004918 setTextViewColorSecondary(big, R.id.notification_material_reply_text_1);
Kenny Guya0f6de82018-04-06 16:20:16 +01004919 big.setViewVisibility(R.id.notification_material_reply_progress,
4920 showSpinner ? View.VISIBLE : View.GONE);
4921 big.setProgressIndeterminateTintList(
4922 R.id.notification_material_reply_progress,
4923 ColorStateList.valueOf(
4924 isColorized() ? getPrimaryTextColor() : resolveContrastColor()));
Adrian Roose458aa82015-12-08 16:17:19 -08004925
Selim Cinekbee4e072018-05-21 22:06:43 -07004926 if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])
4927 && p.maxRemoteInputHistory > 1) {
Adrian Roose458aa82015-12-08 16:17:19 -08004928 big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004929 big.setTextViewText(R.id.notification_material_reply_text_2,
4930 processTextSpans(replyText[1]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004931 setTextViewColorSecondary(big, R.id.notification_material_reply_text_2);
Adrian Roose458aa82015-12-08 16:17:19 -08004932
Selim Cinekbee4e072018-05-21 22:06:43 -07004933 if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])
4934 && p.maxRemoteInputHistory > 2) {
Adrian Roose458aa82015-12-08 16:17:19 -08004935 big.setViewVisibility(
4936 R.id.notification_material_reply_text_3, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004937 big.setTextViewText(R.id.notification_material_reply_text_3,
4938 processTextSpans(replyText[2]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004939 setTextViewColorSecondary(big, R.id.notification_material_reply_text_3);
Adrian Roose458aa82015-12-08 16:17:19 -08004940 }
4941 }
4942 }
4943
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004944 return big;
4945 }
4946
Adrian Roose458aa82015-12-08 16:17:19 -08004947 private boolean hasValidRemoteInput(Action action) {
4948 if (TextUtils.isEmpty(action.title) || action.actionIntent == null) {
4949 // Weird actions
4950 return false;
4951 }
4952
4953 RemoteInput[] remoteInputs = action.getRemoteInputs();
4954 if (remoteInputs == null) {
4955 return false;
4956 }
4957
4958 for (RemoteInput r : remoteInputs) {
4959 CharSequence[] choices = r.getChoices();
4960 if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) {
4961 return true;
4962 }
4963 }
4964 return false;
4965 }
4966
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004967 /**
4968 * Construct a RemoteViews for the final 1U notification layout. In order:
4969 * 1. Custom contentView from the caller
4970 * 2. Style's proposed content view
4971 * 3. Standard template view
4972 */
Julia Reynolds3b848122016-02-26 10:45:32 -05004973 public RemoteViews createContentView() {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004974 return createContentView(false /* increasedheight */ );
4975 }
4976
4977 /**
4978 * Construct a RemoteViews for the smaller content view.
4979 *
4980 * @param increasedHeight true if this layout be created with an increased height. Some
4981 * styles may support showing more then just that basic 1U size
4982 * and the system may decide to render important notifications
4983 * slightly bigger even when collapsed.
4984 *
4985 * @hide
4986 */
4987 public RemoteViews createContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07004988 if (mN.contentView != null && useExistingRemoteView()) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004989 return mN.contentView;
4990 } else if (mStyle != null) {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004991 final RemoteViews styleView = mStyle.makeContentView(increasedHeight);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004992 if (styleView != null) {
4993 return styleView;
4994 }
Joe Onorato46439ce2010-11-19 13:56:21 -08004995 }
Selim Cinek384804b2018-04-18 14:31:07 +08004996 return applyStandardTemplate(getBaseLayoutResource(), null /* result */);
Joe Onorato46439ce2010-11-19 13:56:21 -08004997 }
4998
Selim Cineka7679b62017-05-10 16:33:25 -07004999 private boolean useExistingRemoteView() {
5000 return mStyle == null || (!mStyle.displayCustomViewInline()
5001 && !mRebuildStyledRemoteViews);
5002 }
5003
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005004 /**
5005 * Construct a RemoteViews for the final big notification layout.
5006 */
Julia Reynolds3b848122016-02-26 10:45:32 -05005007 public RemoteViews createBigContentView() {
Selim Cinek850a8542015-11-11 11:48:36 -05005008 RemoteViews result = null;
Selim Cineka7679b62017-05-10 16:33:25 -07005009 if (mN.bigContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05005010 return mN.bigContentView;
5011 } else if (mStyle != null) {
Selim Cinek850a8542015-11-11 11:48:36 -05005012 result = mStyle.makeBigContentView();
Selim Cinek90dcf6d2015-11-18 20:24:13 -08005013 hideLine1Text(result);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005014 } else if (mActions.size() != 0) {
Selim Cinek384804b2018-04-18 14:31:07 +08005015 result = applyStandardTemplateWithActions(getBigBaseLayoutResource(),
5016 null /* result */);
Selim Cinek850a8542015-11-11 11:48:36 -05005017 }
Selim Cinek6743c0b2017-01-18 18:24:01 -08005018 makeHeaderExpanded(result);
Selim Cinek850a8542015-11-11 11:48:36 -05005019 return result;
5020 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005021
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005022 /**
Selim Cinek414ad332017-02-24 19:06:12 -08005023 * Construct a RemoteViews for the final notification header only. This will not be
5024 * colorized.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005025 *
Adrian Roos6f6e1592017-05-02 16:22:53 -07005026 * @param ambient if true, generate the header for the ambient display layout.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005027 * @hide
5028 */
Adrian Roos6f6e1592017-05-02 16:22:53 -07005029 public RemoteViews makeNotificationHeader(boolean ambient) {
Selim Cinek414ad332017-02-24 19:06:12 -08005030 Boolean colorized = (Boolean) mN.extras.get(EXTRA_COLORIZED);
5031 mN.extras.putBoolean(EXTRA_COLORIZED, false);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005032 RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(),
Adrian Roos6f6e1592017-05-02 16:22:53 -07005033 ambient ? R.layout.notification_template_ambient_header
5034 : R.layout.notification_template_header);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005035 resetNotificationHeader(header);
Selim Cinekafeed292017-12-12 17:32:44 -08005036 bindNotificationHeader(header, ambient, null);
Selim Cinek414ad332017-02-24 19:06:12 -08005037 if (colorized != null) {
5038 mN.extras.putBoolean(EXTRA_COLORIZED, colorized);
5039 } else {
5040 mN.extras.remove(EXTRA_COLORIZED);
5041 }
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005042 return header;
5043 }
5044
Adrian Roos487374f2017-01-11 15:48:14 -08005045 /**
5046 * Construct a RemoteViews for the ambient version of the notification.
5047 *
5048 * @hide
5049 */
5050 public RemoteViews makeAmbientNotification() {
5051 RemoteViews ambient = applyStandardTemplateWithActions(
5052 R.layout.notification_template_material_ambient,
Selim Cinek384804b2018-04-18 14:31:07 +08005053 mParams.reset().ambient(true).fillTextsFrom(this).hasProgress(false),
5054 null /* result */);
Adrian Roos487374f2017-01-11 15:48:14 -08005055 return ambient;
5056 }
5057
Selim Cinek29603462015-11-17 19:04:39 -08005058 private void hideLine1Text(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005059 if (result != null) {
5060 result.setViewVisibility(R.id.text_line_1, View.GONE);
5061 }
Selim Cinek29603462015-11-17 19:04:39 -08005062 }
5063
Selim Cinek6743c0b2017-01-18 18:24:01 -08005064 /**
5065 * Adapt the Notification header if this view is used as an expanded view.
5066 *
5067 * @hide
5068 */
5069 public static void makeHeaderExpanded(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005070 if (result != null) {
5071 result.setBoolean(R.id.notification_header, "setExpanded", true);
5072 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005073 }
5074
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005075 /**
5076 * Construct a RemoteViews for the final heads-up notification layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08005077 *
5078 * @param increasedHeight true if this layout be created with an increased height. Some
5079 * styles may support showing more then just that basic 1U size
5080 * and the system may decide to render important notifications
5081 * slightly bigger even when collapsed.
5082 *
5083 * @hide
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005084 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08005085 public RemoteViews createHeadsUpContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07005086 if (mN.headsUpContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05005087 return mN.headsUpContentView;
5088 } else if (mStyle != null) {
Selim Cinek87ed69b2017-02-09 15:59:43 -08005089 final RemoteViews styleView = mStyle.makeHeadsUpContentView(increasedHeight);
5090 if (styleView != null) {
5091 return styleView;
5092 }
Julia Reynolds089e3e42015-11-18 09:59:57 -05005093 } else if (mActions.size() == 0) {
5094 return null;
5095 }
5096
Selim Cinekbee4e072018-05-21 22:06:43 -07005097 // We only want at most a single remote input history to be shown here, otherwise
5098 // the content would become squished.
5099 StandardTemplateParams p = mParams.reset().fillTextsFrom(this)
5100 .setMaxRemoteInputHistory(1);
5101 return applyStandardTemplateWithActions(getBigBaseLayoutResource(),
5102 p,
5103 null /* result */);
Chris Wren8fd39ec2014-02-27 17:43:26 -05005104 }
5105
Selim Cinek624c02db2015-12-14 21:00:02 -08005106 /**
Selim Cinek87ed69b2017-02-09 15:59:43 -08005107 * Construct a RemoteViews for the final heads-up notification layout.
5108 */
5109 public RemoteViews createHeadsUpContentView() {
5110 return createHeadsUpContentView(false /* useIncreasedHeight */);
5111 }
5112
5113 /**
Selim Cinek624c02db2015-12-14 21:00:02 -08005114 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
5115 *
5116 * @hide
5117 */
5118 public RemoteViews makePublicContentView() {
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005119 return makePublicView(false /* ambient */);
5120 }
5121
5122 /**
5123 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
5124 *
5125 * @hide
5126 */
5127 public RemoteViews makePublicAmbientNotification() {
5128 return makePublicView(true /* ambient */);
5129 }
5130
5131 private RemoteViews makePublicView(boolean ambient) {
Selim Cinek624c02db2015-12-14 21:00:02 -08005132 if (mN.publicVersion != null) {
5133 final Builder builder = recoverBuilder(mContext, mN.publicVersion);
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005134 return ambient ? builder.makeAmbientNotification() : builder.createContentView();
Selim Cinek624c02db2015-12-14 21:00:02 -08005135 }
5136 Bundle savedBundle = mN.extras;
5137 Style style = mStyle;
5138 mStyle = null;
5139 Icon largeIcon = mN.mLargeIcon;
5140 mN.mLargeIcon = null;
Selim Cinek279fa862016-06-14 10:57:25 -07005141 Bitmap largeIconLegacy = mN.largeIcon;
5142 mN.largeIcon = null;
Adrian Roosb19b06b2017-05-02 18:54:40 -07005143 ArrayList<Action> actions = mActions;
5144 mActions = new ArrayList<>();
Selim Cinek624c02db2015-12-14 21:00:02 -08005145 Bundle publicExtras = new Bundle();
5146 publicExtras.putBoolean(EXTRA_SHOW_WHEN,
5147 savedBundle.getBoolean(EXTRA_SHOW_WHEN));
5148 publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER,
5149 savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER));
Adrian Roos96b7e202016-05-17 13:50:38 -07005150 publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN,
5151 savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN));
Selim Cineked07b962018-04-30 14:39:35 -07005152 String appName = savedBundle.getString(EXTRA_SUBSTITUTE_APP_NAME);
5153 if (appName != null) {
5154 publicExtras.putString(EXTRA_SUBSTITUTE_APP_NAME, appName);
5155 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005156 mN.extras = publicExtras;
Selim Cinek499c20f2017-07-20 14:06:09 -07005157 RemoteViews view;
5158 if (ambient) {
5159 publicExtras.putCharSequence(EXTRA_TITLE,
5160 mContext.getString(com.android.internal.R.string.notification_hidden_text));
5161 view = makeAmbientNotification();
5162 } else{
5163 view = makeNotificationHeader(false /* ambient */);
5164 view.setBoolean(R.id.notification_header, "setExpandOnlyOnButton", true);
5165 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005166 mN.extras = savedBundle;
5167 mN.mLargeIcon = largeIcon;
Selim Cinek279fa862016-06-14 10:57:25 -07005168 mN.largeIcon = largeIconLegacy;
Adrian Roosb19b06b2017-05-02 18:54:40 -07005169 mActions = actions;
Selim Cinek624c02db2015-12-14 21:00:02 -08005170 mStyle = style;
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005171 return view;
Selim Cinek624c02db2015-12-14 21:00:02 -08005172 }
5173
Selim Cinek6743c0b2017-01-18 18:24:01 -08005174 /**
5175 * Construct a content view for the display when low - priority
5176 *
5177 * @param useRegularSubtext uses the normal subtext set if there is one available. Otherwise
5178 * a new subtext is created consisting of the content of the
5179 * notification.
5180 * @hide
5181 */
5182 public RemoteViews makeLowPriorityContentView(boolean useRegularSubtext) {
5183 int color = mN.color;
5184 mN.color = COLOR_DEFAULT;
5185 CharSequence summary = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
5186 if (!useRegularSubtext || TextUtils.isEmpty(summary)) {
5187 CharSequence newSummary = createSummaryText();
5188 if (!TextUtils.isEmpty(newSummary)) {
5189 mN.extras.putCharSequence(EXTRA_SUB_TEXT, newSummary);
5190 }
5191 }
Selim Cinek875ba9b2017-02-13 16:20:17 -08005192
Adrian Roos6f6e1592017-05-02 16:22:53 -07005193 RemoteViews header = makeNotificationHeader(false /* ambient */);
Selim Cinek1b554392017-02-28 17:22:49 -08005194 header.setBoolean(R.id.notification_header, "setAcceptAllTouches", true);
Selim Cinek6743c0b2017-01-18 18:24:01 -08005195 if (summary != null) {
5196 mN.extras.putCharSequence(EXTRA_SUB_TEXT, summary);
5197 } else {
5198 mN.extras.remove(EXTRA_SUB_TEXT);
5199 }
5200 mN.color = color;
5201 return header;
5202 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005203
Selim Cinek6743c0b2017-01-18 18:24:01 -08005204 private CharSequence createSummaryText() {
5205 CharSequence titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE);
5206 if (USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY) {
5207 return titleText;
5208 }
5209 SpannableStringBuilder summary = new SpannableStringBuilder();
5210 if (titleText == null) {
5211 titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE_BIG);
5212 }
5213 BidiFormatter bidi = BidiFormatter.getInstance();
5214 if (titleText != null) {
5215 summary.append(bidi.unicodeWrap(titleText));
5216 }
5217 CharSequence contentText = mN.extras.getCharSequence(Notification.EXTRA_TEXT);
5218 if (titleText != null && contentText != null) {
5219 summary.append(bidi.unicodeWrap(mContext.getText(
5220 R.string.notification_header_divider_symbol_with_spaces)));
5221 }
5222 if (contentText != null) {
5223 summary.append(bidi.unicodeWrap(contentText));
5224 }
5225 return summary;
5226 }
Chris Wren8fd39ec2014-02-27 17:43:26 -05005227
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005228 private RemoteViews generateActionButton(Action action, boolean emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07005229 boolean ambient) {
Daniel Sandler8680bf82012-05-15 16:52:52 -04005230 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07005231 RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(),
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005232 emphazisedMode ? getEmphasizedActionLayoutResource()
5233 : tombstone ? getActionTombstoneLayoutResource()
5234 : getActionLayoutResource());
Daniel Sandler8680bf82012-05-15 16:52:52 -04005235 if (!tombstone) {
Daniel Sandlere5518842012-05-10 16:20:40 -04005236 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
Daniel Sandlere5518842012-05-10 16:20:40 -04005237 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005238 button.setContentDescription(R.id.action0, action.title);
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005239 if (action.mRemoteInputs != null) {
5240 button.setRemoteInputs(R.id.action0, action.mRemoteInputs);
5241 }
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005242 if (emphazisedMode) {
Selim Cinek981962e2016-07-20 20:41:58 -07005243 // change the background bgColor
Selim Cinek981962e2016-07-20 20:41:58 -07005244 CharSequence title = action.title;
5245 ColorStateList[] outResultColor = null;
Selim Cinek396caca2018-04-10 17:46:46 -07005246 int background = resolveBackgroundColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005247 if (isLegacy()) {
Selim Cinek87c31532017-08-18 18:53:44 -07005248 title = NotificationColorUtil.clearColorSpans(title);
Selim Cinek981962e2016-07-20 20:41:58 -07005249 } else {
5250 outResultColor = new ColorStateList[1];
Selim Cinek396caca2018-04-10 17:46:46 -07005251 title = ensureColorSpanContrast(title, background, outResultColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005252 }
Selim Cinek48f66b72017-08-18 16:17:51 -07005253 button.setTextViewText(R.id.action0, processTextSpans(title));
Selim Cinek7b9605b2017-01-19 17:36:00 -08005254 setTextViewColorPrimary(button, R.id.action0);
Selim Cinek396caca2018-04-10 17:46:46 -07005255 int rippleColor;
5256 boolean hasColorOverride = outResultColor != null && outResultColor[0] != null;
5257 if (hasColorOverride) {
5258 // There's a span spanning the full text, let's take it and use it as the
5259 // background color
5260 background = outResultColor[0].getDefaultColor();
5261 int textColor = NotificationColorUtil.resolvePrimaryColor(mContext,
5262 background);
5263 button.setTextColor(R.id.action0, textColor);
5264 rippleColor = textColor;
Anthony Chenad4d1582017-04-10 16:07:58 -07005265 } else if (mN.color != COLOR_DEFAULT && !isColorized() && mTintActionButtons) {
Selim Cinek396caca2018-04-10 17:46:46 -07005266 rippleColor = resolveContrastColor();
5267 button.setTextColor(R.id.action0, rippleColor);
5268 } else {
5269 rippleColor = getPrimaryTextColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005270 }
Selim Cinek396caca2018-04-10 17:46:46 -07005271 // We only want about 20% alpha for the ripple
5272 rippleColor = (rippleColor & 0x00ffffff) | 0x33000000;
5273 button.setColorStateList(R.id.action0, "setRippleColor",
5274 ColorStateList.valueOf(rippleColor));
5275 button.setColorStateList(R.id.action0, "setButtonBackground",
5276 ColorStateList.valueOf(background));
5277 button.setBoolean(R.id.action0, "setHasStroke", !hasColorOverride);
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005278 } else {
Selim Cinek48f66b72017-08-18 16:17:51 -07005279 button.setTextViewText(R.id.action0, processTextSpans(
5280 processLegacyText(action.title)));
Adrian Roos72171622017-01-27 10:32:06 -08005281 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005282 setTextViewColorPrimary(button, R.id.action0);
Anthony Chenad4d1582017-04-10 16:07:58 -07005283 } else if (mN.color != COLOR_DEFAULT && mTintActionButtons) {
Adrian Roos487374f2017-01-11 15:48:14 -08005284 button.setTextColor(R.id.action0,
5285 ambient ? resolveAmbientColor() : resolveContrastColor());
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005286 }
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005287 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005288 return button;
5289 }
5290
Joe Onoratocb109a02011-01-18 17:57:41 -08005291 /**
Selim Cinek981962e2016-07-20 20:41:58 -07005292 * Ensures contrast on color spans against a background color. also returns the color of the
5293 * text if a span was found that spans over the whole text.
5294 *
5295 * @param charSequence the charSequence on which the spans are
5296 * @param background the background color to ensure the contrast against
5297 * @param outResultColor an array in which a color will be returned as the first element if
5298 * there exists a full length color span.
5299 * @return the contrasted charSequence
5300 */
5301 private CharSequence ensureColorSpanContrast(CharSequence charSequence, int background,
5302 ColorStateList[] outResultColor) {
5303 if (charSequence instanceof Spanned) {
5304 Spanned ss = (Spanned) charSequence;
5305 Object[] spans = ss.getSpans(0, ss.length(), Object.class);
5306 SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
5307 for (Object span : spans) {
5308 Object resultSpan = span;
5309 int spanStart = ss.getSpanStart(span);
5310 int spanEnd = ss.getSpanEnd(span);
5311 boolean fullLength = (spanEnd - spanStart) == charSequence.length();
5312 if (resultSpan instanceof CharacterStyle) {
5313 resultSpan = ((CharacterStyle) span).getUnderlying();
5314 }
5315 if (resultSpan instanceof TextAppearanceSpan) {
5316 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
5317 ColorStateList textColor = originalSpan.getTextColor();
5318 if (textColor != null) {
5319 int[] colors = textColor.getColors();
5320 int[] newColors = new int[colors.length];
5321 for (int i = 0; i < newColors.length; i++) {
5322 newColors[i] = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005323 colors[i], background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005324 }
5325 textColor = new ColorStateList(textColor.getStates().clone(),
5326 newColors);
Selim Cinek396caca2018-04-10 17:46:46 -07005327 if (fullLength) {
5328 outResultColor[0] = textColor;
5329 // Let's drop the color from the span
5330 textColor = null;
5331 }
Selim Cinek981962e2016-07-20 20:41:58 -07005332 resultSpan = new TextAppearanceSpan(
5333 originalSpan.getFamily(),
5334 originalSpan.getTextStyle(),
5335 originalSpan.getTextSize(),
5336 textColor,
5337 originalSpan.getLinkTextColor());
Selim Cinek981962e2016-07-20 20:41:58 -07005338 }
5339 } else if (resultSpan instanceof ForegroundColorSpan) {
5340 ForegroundColorSpan originalSpan = (ForegroundColorSpan) resultSpan;
5341 int foregroundColor = originalSpan.getForegroundColor();
5342 foregroundColor = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005343 foregroundColor, background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005344 if (fullLength) {
5345 outResultColor[0] = ColorStateList.valueOf(foregroundColor);
Selim Cinek396caca2018-04-10 17:46:46 -07005346 resultSpan = null;
5347 } else {
5348 resultSpan = new ForegroundColorSpan(foregroundColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005349 }
5350 } else {
5351 resultSpan = span;
5352 }
Selim Cinek396caca2018-04-10 17:46:46 -07005353 if (resultSpan != null) {
5354 builder.setSpan(resultSpan, spanStart, spanEnd, ss.getSpanFlags(span));
5355 }
Selim Cinek981962e2016-07-20 20:41:58 -07005356 }
5357 return builder;
5358 }
5359 return charSequence;
5360 }
5361
5362 /**
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005363 * @return Whether we are currently building a notification from a legacy (an app that
Alan Viverette3cb07a462014-06-06 14:19:53 -07005364 * doesn't create material notifications by itself) app.
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005365 */
5366 private boolean isLegacy() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005367 if (!mIsLegacyInitialized) {
5368 mIsLegacy = mContext.getApplicationInfo().targetSdkVersion
5369 < Build.VERSION_CODES.LOLLIPOP;
5370 mIsLegacyInitialized = true;
5371 }
5372 return mIsLegacy;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005373 }
5374
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005375 private CharSequence processLegacyText(CharSequence charSequence) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08005376 return processLegacyText(charSequence, false /* ambient */);
5377 }
5378
5379 private CharSequence processLegacyText(CharSequence charSequence, boolean ambient) {
5380 boolean isAlreadyLightText = isLegacy() || textColorsNeedInversion();
5381 boolean wantLightText = ambient;
5382 if (isAlreadyLightText != wantLightText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005383 return getColorUtil().invertCharSequenceColors(charSequence);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005384 } else {
5385 return charSequence;
5386 }
5387 }
5388
Dan Sandler26e81cf2014-05-06 10:01:27 -04005389 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005390 * Apply any necessariy colors to the small icon
Dan Sandler26e81cf2014-05-06 10:01:27 -04005391 */
Adrian Roos487374f2017-01-11 15:48:14 -08005392 private void processSmallIconColor(Icon smallIcon, RemoteViews contentView,
5393 boolean ambient) {
Selim Cinekea4bef72015-12-02 15:51:10 -08005394 boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon);
Selim Cinekc7f5a822018-03-20 19:32:06 -07005395 int color;
5396 if (ambient) {
5397 color = resolveAmbientColor();
5398 } else if (isColorized()) {
5399 color = getPrimaryTextColor();
5400 } else {
5401 color = resolveContrastColor();
5402 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005403 if (colorable) {
Sunny Goyal5b153922017-09-21 21:00:36 -07005404 contentView.setDrawableTint(R.id.icon, false, color,
5405 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08005406
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005407 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005408 contentView.setInt(R.id.notification_header, "setOriginalIconColor",
Adrian Roos487374f2017-01-11 15:48:14 -08005409 colorable ? color : NotificationHeaderView.NO_COLOR);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005410 }
5411
Dan Sandler26e81cf2014-05-06 10:01:27 -04005412 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005413 * Make the largeIcon dark if it's a fake smallIcon (that is,
Dan Sandler26e81cf2014-05-06 10:01:27 -04005414 * if it's grayscale).
5415 */
5416 // TODO: also check bounds, transparency, that sort of thing.
Dan Sandlerd63f9322015-05-06 15:18:49 -04005417 private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) {
5418 if (largeIcon != null && isLegacy()
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005419 && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005420 // resolve color will fall back to the default when legacy
Sunny Goyal5b153922017-09-21 21:00:36 -07005421 contentView.setDrawableTint(R.id.icon, false, resolveContrastColor(),
5422 PorterDuff.Mode.SRC_ATOP);
Jorim Jaggi92df1f22014-12-16 19:44:41 +01005423 }
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005424 }
5425
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05005426 private void sanitizeColor() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005427 if (mN.color != COLOR_DEFAULT) {
5428 mN.color |= 0xFF000000; // no alpha for custom colors
Jorim Jaggi74419312014-06-10 20:57:21 +02005429 }
Jorim Jaggi74419312014-06-10 20:57:21 +02005430 }
5431
Adrian Roos4ff3b122016-02-01 12:26:13 -08005432 int resolveContrastColor() {
5433 if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) {
5434 return mCachedContrastColor;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005435 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005436
Selim Cinekac5f0272017-05-02 16:05:41 -07005437 int color;
Selim Cinekc7f5a822018-03-20 19:32:06 -07005438 int background = mContext.getColor(
5439 com.android.internal.R.color.notification_material_background_color);
Selim Cinekac5f0272017-05-02 16:05:41 -07005440 if (mN.color == COLOR_DEFAULT) {
5441 ensureColors();
Selim Cinekc7f5a822018-03-20 19:32:06 -07005442 color = NotificationColorUtil.resolveDefaultColor(mContext, background);
Selim Cinekac5f0272017-05-02 16:05:41 -07005443 } else {
5444 color = NotificationColorUtil.resolveContrastColor(mContext, mN.color,
Anthony Chenad4d1582017-04-10 16:07:58 -07005445 background, mInNightMode);
Selim Cinekac5f0272017-05-02 16:05:41 -07005446 }
5447 if (Color.alpha(color) < 255) {
5448 // alpha doesn't go well for color filters, so let's blend it manually
5449 color = NotificationColorUtil.compositeColors(color, background);
5450 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005451 mCachedContrastColorIsFor = mN.color;
Selim Cinekac5f0272017-05-02 16:05:41 -07005452 return mCachedContrastColor = color;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005453 }
5454
Selim Cinek4717d862018-04-19 09:19:15 +08005455 int resolveNeutralColor() {
5456 if (mNeutralColor != COLOR_INVALID) {
5457 return mNeutralColor;
5458 }
5459 int background = mContext.getColor(
5460 com.android.internal.R.color.notification_material_background_color);
5461 mNeutralColor = NotificationColorUtil.resolveDefaultColor(mContext, background);
5462 if (Color.alpha(mNeutralColor) < 255) {
5463 // alpha doesn't go well for color filters, so let's blend it manually
5464 mNeutralColor = NotificationColorUtil.compositeColors(mNeutralColor, background);
5465 }
5466 return mNeutralColor;
5467 }
5468
Adrian Roos487374f2017-01-11 15:48:14 -08005469 int resolveAmbientColor() {
5470 if (mCachedAmbientColorIsFor == mN.color && mCachedAmbientColorIsFor != COLOR_INVALID) {
5471 return mCachedAmbientColor;
5472 }
5473 final int contrasted = NotificationColorUtil.resolveAmbientColor(mContext, mN.color);
5474
5475 mCachedAmbientColorIsFor = mN.color;
5476 return mCachedAmbientColor = contrasted;
5477 }
5478
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005479 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005480 * Apply the unstyled operations and return a new {@link Notification} object.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005481 * @hide
Joe Onoratocb109a02011-01-18 17:57:41 -08005482 */
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005483 public Notification buildUnstyled() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005484 if (mActions.size() > 0) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005485 mN.actions = new Action[mActions.size()];
5486 mActions.toArray(mN.actions);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005487 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005488 if (!mPersonList.isEmpty()) {
Selim Cineke7238dd2017-12-14 17:48:32 -08005489 mN.extras.putParcelableArrayList(EXTRA_PEOPLE_LIST, mPersonList);
Dan Sandler0bf2ed82013-12-21 23:33:41 -06005490 }
Selim Cinek247fa012016-02-18 09:50:48 -08005491 if (mN.bigContentView != null || mN.contentView != null
5492 || mN.headsUpContentView != null) {
5493 mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true);
5494 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005495 return mN;
Joe Onorato46439ce2010-11-19 13:56:21 -08005496 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005497
Julia Reynolds3b848122016-02-26 10:45:32 -05005498 /**
5499 * Creates a Builder from an existing notification so further changes can be made.
5500 * @param context The context for your application / activity.
5501 * @param n The notification to create a Builder from.
5502 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005503 public static Notification.Builder recoverBuilder(Context context, Notification n) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02005504 // Re-create notification context so we can access app resources.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005505 ApplicationInfo applicationInfo = n.extras.getParcelable(
5506 EXTRA_BUILDER_APPLICATION_INFO);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005507 Context builderContext;
Julia Reynoldsda303542015-11-23 14:00:20 -05005508 if (applicationInfo != null) {
5509 try {
5510 builderContext = context.createApplicationContext(applicationInfo,
5511 Context.CONTEXT_RESTRICTED);
5512 } catch (NameNotFoundException e) {
5513 Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found");
5514 builderContext = context; // try with our context
5515 }
5516 } else {
5517 builderContext = context; // try with given context
Christoph Studer4600f9b2014-07-22 22:44:43 +02005518 }
5519
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005520 return new Builder(builderContext, n);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005521 }
5522
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005523 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005524 * @deprecated Use {@link #build()} instead.
5525 */
5526 @Deprecated
5527 public Notification getNotification() {
5528 return build();
5529 }
5530
5531 /**
5532 * Combine all of the options that have been set and return a new {@link Notification}
5533 * object.
5534 */
5535 public Notification build() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005536 // first, add any extras from the calling code
5537 if (mUserExtras != null) {
5538 mN.extras = getAllExtras();
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07005539 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005540
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005541 mN.creationTime = System.currentTimeMillis();
5542
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005543 // lazy stuff from mContext; see comment in Builder(Context, Notification)
Julia Reynoldsda303542015-11-23 14:00:20 -05005544 Notification.addFieldsFromContext(mContext, mN);
Christoph Studer943aa672014-08-03 20:31:16 +02005545
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005546 buildUnstyled();
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005547
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005548 if (mStyle != null) {
Selim Cinekd0426622017-07-11 13:19:59 +02005549 mStyle.reduceImageSizes(mContext);
5550 mStyle.purgeResources();
Selim Cinek90343862018-02-01 11:07:11 -08005551 mStyle.validate(mContext);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005552 mStyle.buildStyled(mN);
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005553 }
Selim Cinekd0426622017-07-11 13:19:59 +02005554 mN.reduceImageSizes(mContext);
5555
Adrian Roos5081c0d2016-02-26 16:04:19 -08005556 if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
Selim Cineka7679b62017-05-10 16:33:25 -07005557 && (useExistingRemoteView())) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005558 if (mN.contentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005559 mN.contentView = createContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005560 mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT,
5561 mN.contentView.getSequenceNumber());
5562 }
5563 if (mN.bigContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005564 mN.bigContentView = createBigContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005565 if (mN.bigContentView != null) {
5566 mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT,
5567 mN.bigContentView.getSequenceNumber());
5568 }
5569 }
5570 if (mN.headsUpContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005571 mN.headsUpContentView = createHeadsUpContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005572 if (mN.headsUpContentView != null) {
5573 mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT,
5574 mN.headsUpContentView.getSequenceNumber());
5575 }
5576 }
5577 }
5578
Julia Reynolds4c0c2022016-02-02 15:11:59 -05005579 if ((mN.defaults & DEFAULT_LIGHTS) != 0) {
5580 mN.flags |= FLAG_SHOW_LIGHTS;
5581 }
5582
Adrian Roosfb921842017-10-26 14:49:56 +02005583 mN.allPendingIntents = null;
5584
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005585 return mN;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005586 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005587
5588 /**
5589 * Apply this Builder to an existing {@link Notification} object.
5590 *
5591 * @hide
5592 */
5593 public Notification buildInto(Notification n) {
Daniel Sandler1a497d32013-04-18 14:52:45 -04005594 build().cloneInto(n, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005595 return n;
5596 }
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005597
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005598 /**
Adrian Roos184bfe022016-03-03 13:41:44 -08005599 * Removes RemoteViews that were created for compatibility from {@param n}, if they did not
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005600 * change. Also removes extenders on low ram devices, as
5601 * {@link android.service.notification.NotificationListenerService} services are disabled.
Adrian Roos184bfe022016-03-03 13:41:44 -08005602 *
5603 * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}.
5604 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005605 * @hide
5606 */
Kristian Monsen30f59b22018-04-09 10:27:16 +02005607 public static Notification maybeCloneStrippedForDelivery(Notification n, boolean isLowRam,
5608 Context context) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005609 String templateClass = n.extras.getString(EXTRA_TEMPLATE);
Adrian Roos184bfe022016-03-03 13:41:44 -08005610
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005611 // Only strip views for known Styles because we won't know how to
5612 // re-create them otherwise.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005613 if (!isLowRam
5614 && !TextUtils.isEmpty(templateClass)
Adrian Roos184bfe022016-03-03 13:41:44 -08005615 && getNotificationStyleClass(templateClass) == null) {
5616 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005617 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005618
5619 // Only strip unmodified BuilderRemoteViews.
5620 boolean stripContentView = n.contentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005621 n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005622 n.contentView.getSequenceNumber();
5623 boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005624 n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005625 n.bigContentView.getSequenceNumber();
5626 boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005627 n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005628 n.headsUpContentView.getSequenceNumber();
5629
5630 // Nothing to do here, no need to clone.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005631 if (!isLowRam
5632 && !stripContentView && !stripBigContentView && !stripHeadsUpContentView) {
Adrian Roos184bfe022016-03-03 13:41:44 -08005633 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005634 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005635
5636 Notification clone = n.clone();
5637 if (stripContentView) {
5638 clone.contentView = null;
5639 clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT);
5640 }
5641 if (stripBigContentView) {
5642 clone.bigContentView = null;
5643 clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT);
5644 }
5645 if (stripHeadsUpContentView) {
5646 clone.headsUpContentView = null;
5647 clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT);
5648 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005649 if (isLowRam) {
Kristian Monsen30f59b22018-04-09 10:27:16 +02005650 String[] allowedServices = context.getResources().getStringArray(
5651 R.array.config_allowedManagedServicesOnLowRamDevices);
5652 if (allowedServices.length == 0) {
5653 clone.extras.remove(Notification.TvExtender.EXTRA_TV_EXTENDER);
5654 clone.extras.remove(WearableExtender.EXTRA_WEARABLE_EXTENSIONS);
5655 clone.extras.remove(CarExtender.EXTRA_CAR_EXTENDER);
5656 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005657 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005658 return clone;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005659 }
5660
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005661 private int getBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005662 return R.layout.notification_template_material_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005663 }
5664
5665 private int getBigBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005666 return R.layout.notification_template_material_big_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005667 }
5668
5669 private int getBigPictureLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005670 return R.layout.notification_template_material_big_picture;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005671 }
5672
5673 private int getBigTextLayoutResource() {
Jorim Jaggi445d3c02014-08-19 22:33:42 +02005674 return R.layout.notification_template_material_big_text;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005675 }
5676
5677 private int getInboxLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005678 return R.layout.notification_template_material_inbox;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005679 }
5680
Adrian Roosc1a80b02016-04-05 14:54:55 -07005681 private int getMessagingLayoutResource() {
5682 return R.layout.notification_template_material_messaging;
5683 }
5684
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005685 private int getActionLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005686 return R.layout.notification_material_action;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005687 }
5688
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005689 private int getEmphasizedActionLayoutResource() {
5690 return R.layout.notification_material_action_emphasized;
5691 }
5692
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005693 private int getActionTombstoneLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005694 return R.layout.notification_material_action_tombstone;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005695 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005696
5697 private int getBackgroundColor() {
5698 if (isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005699 return mBackgroundColor != COLOR_INVALID ? mBackgroundColor : mN.color;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005700 } else {
Selim Cinekc7f5a822018-03-20 19:32:06 -07005701 return COLOR_DEFAULT;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005702 }
5703 }
5704
Selim Cinek396caca2018-04-10 17:46:46 -07005705 /**
Selim Cinek4717d862018-04-19 09:19:15 +08005706 * Gets a neutral color that can be used for icons or similar that should not stand out.
5707 */
5708 private int getNeutralColor() {
5709 if (isColorized()) {
5710 return getSecondaryTextColor();
5711 } else {
5712 return resolveNeutralColor();
5713 }
5714 }
5715
5716 /**
Selim Cinek396caca2018-04-10 17:46:46 -07005717 * Same as getBackgroundColor but also resolved the default color to the background.
5718 */
5719 private int resolveBackgroundColor() {
5720 int backgroundColor = getBackgroundColor();
5721 if (backgroundColor == COLOR_DEFAULT) {
5722 backgroundColor = mContext.getColor(
5723 com.android.internal.R.color.notification_material_background_color);
5724 }
5725 return backgroundColor;
5726 }
5727
Selim Cinek7b9605b2017-01-19 17:36:00 -08005728 private boolean isColorized() {
5729 return mN.isColorized();
5730 }
Selim Cinek99104832017-01-25 14:47:33 -08005731
Anthony Chenad4d1582017-04-10 16:07:58 -07005732 private boolean shouldTintActionButtons() {
5733 return mTintActionButtons;
5734 }
5735
Selim Cinek99104832017-01-25 14:47:33 -08005736 private boolean textColorsNeedInversion() {
5737 if (mStyle == null || !MediaStyle.class.equals(mStyle.getClass())) {
5738 return false;
5739 }
5740 int targetSdkVersion = mContext.getApplicationInfo().targetSdkVersion;
5741 return targetSdkVersion > Build.VERSION_CODES.M
5742 && targetSdkVersion < Build.VERSION_CODES.O;
5743 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005744
5745 /**
5746 * Set a color palette to be used as the background and textColors
5747 *
5748 * @param backgroundColor the color to be used as the background
5749 * @param foregroundColor the color to be used as the foreground
5750 *
5751 * @hide
5752 */
5753 public void setColorPalette(int backgroundColor, int foregroundColor) {
5754 mBackgroundColor = backgroundColor;
5755 mForegroundColor = foregroundColor;
5756 mTextColorsAreForBackground = COLOR_INVALID;
5757 ensureColors();
5758 }
Selim Cinekac5f0272017-05-02 16:05:41 -07005759
5760 /**
Selim Cineka7679b62017-05-10 16:33:25 -07005761 * Forces all styled remoteViews to be built from scratch and not use any cached
5762 * RemoteViews.
5763 * This is needed for legacy apps that are baking in their remoteviews into the
5764 * notification.
5765 *
5766 * @hide
5767 */
5768 public void setRebuildStyledRemoteViews(boolean rebuild) {
5769 mRebuildStyledRemoteViews = rebuild;
5770 }
Selim Cinekaa9db1f2018-02-27 17:35:47 -08005771
5772 /**
5773 * Get the text that should be displayed in the statusBar when heads upped. This is
5774 * usually just the app name, but may be different depending on the style.
5775 *
5776 * @param publicMode If true, return a text that is safe to display in public.
5777 *
5778 * @hide
5779 */
5780 public CharSequence getHeadsUpStatusBarText(boolean publicMode) {
5781 if (mStyle != null && !publicMode) {
5782 CharSequence text = mStyle.getHeadsUpStatusBarText();
5783 if (!TextUtils.isEmpty(text)) {
5784 return text;
5785 }
5786 }
5787 return loadHeaderAppName();
5788 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005789 }
5790
5791 /**
Selim Cinekd0426622017-07-11 13:19:59 +02005792 * Reduces the image sizes to conform to a maximum allowed size. This also processes all custom
5793 * remote views.
5794 *
5795 * @hide
5796 */
5797 void reduceImageSizes(Context context) {
5798 if (extras.getBoolean(EXTRA_REDUCED_IMAGES)) {
5799 return;
5800 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005801 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02005802 if (mLargeIcon != null || largeIcon != null) {
5803 Resources resources = context.getResources();
5804 Class<? extends Style> style = getNotificationStyle();
Selim Cineka8cb1262017-08-15 16:53:44 -07005805 int maxWidth = resources.getDimensionPixelSize(isLowRam
5806 ? R.dimen.notification_right_icon_size_low_ram
5807 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02005808 int maxHeight = maxWidth;
5809 if (MediaStyle.class.equals(style)
5810 || DecoratedMediaCustomViewStyle.class.equals(style)) {
Selim Cineka8cb1262017-08-15 16:53:44 -07005811 maxHeight = resources.getDimensionPixelSize(isLowRam
5812 ? R.dimen.notification_media_image_max_height_low_ram
5813 : R.dimen.notification_media_image_max_height);
5814 maxWidth = resources.getDimensionPixelSize(isLowRam
5815 ? R.dimen.notification_media_image_max_width_low_ram
5816 : R.dimen.notification_media_image_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02005817 }
5818 if (mLargeIcon != null) {
5819 mLargeIcon.scaleDownIfNecessary(maxWidth, maxHeight);
5820 }
5821 if (largeIcon != null) {
5822 largeIcon = Icon.scaleDownIfNecessary(largeIcon, maxWidth, maxHeight);
5823 }
5824 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005825 reduceImageSizesForRemoteView(contentView, context, isLowRam);
5826 reduceImageSizesForRemoteView(headsUpContentView, context, isLowRam);
5827 reduceImageSizesForRemoteView(bigContentView, context, isLowRam);
Selim Cinekd0426622017-07-11 13:19:59 +02005828 extras.putBoolean(EXTRA_REDUCED_IMAGES, true);
5829 }
5830
Selim Cineka8cb1262017-08-15 16:53:44 -07005831 private void reduceImageSizesForRemoteView(RemoteViews remoteView, Context context,
5832 boolean isLowRam) {
Selim Cinekd0426622017-07-11 13:19:59 +02005833 if (remoteView != null) {
5834 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07005835 int maxWidth = resources.getDimensionPixelSize(isLowRam
5836 ? R.dimen.notification_custom_view_max_image_width_low_ram
5837 : R.dimen.notification_custom_view_max_image_width);
5838 int maxHeight = resources.getDimensionPixelSize(isLowRam
5839 ? R.dimen.notification_custom_view_max_image_height_low_ram
5840 : R.dimen.notification_custom_view_max_image_height);
Selim Cinekd0426622017-07-11 13:19:59 +02005841 remoteView.reduceImageSizes(maxWidth, maxHeight);
5842 }
5843 }
5844
5845 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005846 * @return whether this notification is a foreground service notification
Selim Cinek7b9605b2017-01-19 17:36:00 -08005847 */
Selim Cinek22714f12017-04-13 16:23:53 -07005848 private boolean isForegroundService() {
5849 return (flags & Notification.FLAG_FOREGROUND_SERVICE) != 0;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005850 }
5851
5852 /**
Selim Cinek99104832017-01-25 14:47:33 -08005853 * @return whether this notification has a media session attached
5854 * @hide
5855 */
5856 public boolean hasMediaSession() {
5857 return extras.getParcelable(Notification.EXTRA_MEDIA_SESSION) != null;
5858 }
5859
5860 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08005861 * @return the style class of this notification
5862 * @hide
5863 */
5864 public Class<? extends Notification.Style> getNotificationStyle() {
5865 String templateClass = extras.getString(Notification.EXTRA_TEMPLATE);
5866
5867 if (!TextUtils.isEmpty(templateClass)) {
5868 return Notification.getNotificationStyleClass(templateClass);
5869 }
5870 return null;
5871 }
5872
5873 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005874 * @return true if this notification is colorized.
Selim Cinek7b9605b2017-01-19 17:36:00 -08005875 *
5876 * @hide
5877 */
5878 public boolean isColorized() {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005879 if (isColorizedMedia()) {
5880 return true;
5881 }
Julia Reynolds4db59552017-06-30 13:34:01 -04005882 return extras.getBoolean(EXTRA_COLORIZED)
5883 && (hasColorizedPermission() || isForegroundService());
5884 }
5885
5886 /**
5887 * Returns whether an app can colorize due to the android.permission.USE_COLORIZED_NOTIFICATIONS
5888 * permission. The permission is checked when a notification is enqueued.
5889 */
5890 private boolean hasColorizedPermission() {
5891 return (flags & Notification.FLAG_CAN_COLORIZE) != 0;
Selim Cinek5fb73f82017-04-20 16:55:38 -07005892 }
5893
5894 /**
5895 * @return true if this notification is colorized and it is a media notification
5896 *
5897 * @hide
5898 */
5899 public boolean isColorizedMedia() {
Selim Cinek99104832017-01-25 14:47:33 -08005900 Class<? extends Style> style = getNotificationStyle();
5901 if (MediaStyle.class.equals(style)) {
5902 Boolean colorized = (Boolean) extras.get(EXTRA_COLORIZED);
5903 if ((colorized == null || colorized) && hasMediaSession()) {
5904 return true;
5905 }
5906 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5907 if (extras.getBoolean(EXTRA_COLORIZED) && hasMediaSession()) {
5908 return true;
5909 }
5910 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005911 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005912 }
5913
Selim Cinek0847acd2017-04-24 19:48:29 -07005914
5915 /**
5916 * @return true if this is a media notification
5917 *
5918 * @hide
5919 */
5920 public boolean isMediaNotification() {
5921 Class<? extends Style> style = getNotificationStyle();
5922 if (MediaStyle.class.equals(style)) {
5923 return true;
5924 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5925 return true;
5926 }
5927 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005928 }
5929
Selim Cinek279fa862016-06-14 10:57:25 -07005930 private boolean hasLargeIcon() {
5931 return mLargeIcon != null || largeIcon != null;
5932 }
5933
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005934 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005935 * @return true if the notification will show the time; false otherwise
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005936 * @hide
5937 */
Selim Cinekc2c0b042016-05-18 17:13:46 -07005938 public boolean showsTime() {
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005939 return when != 0 && extras.getBoolean(EXTRA_SHOW_WHEN);
5940 }
5941
5942 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005943 * @return true if the notification will show a chronometer; false otherwise
5944 * @hide
5945 */
5946 public boolean showsChronometer() {
5947 return when != 0 && extras.getBoolean(EXTRA_SHOW_CHRONOMETER);
5948 }
5949
5950 /**
Julia Reynolds7ca33072017-06-29 13:58:24 -04005951 * @removed
Julia Reynolds4a02afb2016-12-13 13:39:52 -05005952 */
5953 @SystemApi
5954 public static Class<? extends Style> getNotificationStyleClass(String templateClass) {
5955 Class<? extends Style>[] classes = new Class[] {
5956 BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class,
5957 DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class,
5958 MessagingStyle.class };
5959 for (Class<? extends Style> innerClass : classes) {
5960 if (templateClass.equals(innerClass.getName())) {
5961 return innerClass;
5962 }
5963 }
5964 return null;
5965 }
5966
5967 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005968 * An object that can apply a rich notification style to a {@link Notification.Builder}
5969 * object.
5970 */
Griff Hazendfcb0802014-02-11 12:00:00 -08005971 public static abstract class Style {
Selim Cinekbee4e072018-05-21 22:06:43 -07005972
5973 /**
5974 * The number of items allowed simulatanously in the remote input history.
5975 * @hide
5976 */
5977 static final int MAX_REMOTE_INPUT_HISTORY_LINES = 3;
Chris Wrend6297db2012-05-03 16:20:13 -04005978 private CharSequence mBigContentTitle;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02005979
5980 /**
5981 * @hide
5982 */
5983 protected CharSequence mSummaryText = null;
5984
5985 /**
5986 * @hide
5987 */
5988 protected boolean mSummaryTextSet = false;
Chris Wrend6297db2012-05-03 16:20:13 -04005989
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005990 protected Builder mBuilder;
5991
Chris Wrend6297db2012-05-03 16:20:13 -04005992 /**
5993 * Overrides ContentTitle in the big form of the template.
5994 * This defaults to the value passed to setContentTitle().
5995 */
5996 protected void internalSetBigContentTitle(CharSequence title) {
5997 mBigContentTitle = title;
5998 }
5999
6000 /**
6001 * Set the first line of text after the detail section in the big form of the template.
6002 */
6003 protected void internalSetSummaryText(CharSequence cs) {
6004 mSummaryText = cs;
Daniel Sandler619738c2012-06-07 16:33:08 -04006005 mSummaryTextSet = true;
Chris Wrend6297db2012-05-03 16:20:13 -04006006 }
6007
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006008 public void setBuilder(Builder builder) {
6009 if (mBuilder != builder) {
6010 mBuilder = builder;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07006011 if (mBuilder != null) {
6012 mBuilder.setStyle(this);
6013 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006014 }
6015 }
6016
Chris Wrend6297db2012-05-03 16:20:13 -04006017 protected void checkBuilder() {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006018 if (mBuilder == null) {
6019 throw new IllegalArgumentException("Style requires a valid Builder object");
6020 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006021 }
Chris Wrend6297db2012-05-03 16:20:13 -04006022
6023 protected RemoteViews getStandardView(int layoutId) {
Selim Cinek384804b2018-04-18 14:31:07 +08006024 return getStandardView(layoutId, null);
6025 }
6026
6027 /**
6028 * Get the standard view for this style.
6029 *
6030 * @param layoutId The layout id to use
6031 * @param result The result where template bind information is saved.
6032 * @return A remoteView for this style.
6033 * @hide
6034 */
6035 protected RemoteViews getStandardView(int layoutId, TemplateBindResult result) {
Chris Wrend6297db2012-05-03 16:20:13 -04006036 checkBuilder();
6037
Christoph Studer4600f9b2014-07-22 22:44:43 +02006038 // Nasty.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006039 CharSequence oldBuilderContentTitle =
6040 mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE);
Chris Wrend6297db2012-05-03 16:20:13 -04006041 if (mBigContentTitle != null) {
6042 mBuilder.setContentTitle(mBigContentTitle);
6043 }
6044
Selim Cinek384804b2018-04-18 14:31:07 +08006045 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId, result);
Chris Wrend6297db2012-05-03 16:20:13 -04006046
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006047 mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006048
Chris Wrend6297db2012-05-03 16:20:13 -04006049 if (mBigContentTitle != null && mBigContentTitle.equals("")) {
6050 contentView.setViewVisibility(R.id.line1, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04006051 } else {
6052 contentView.setViewVisibility(R.id.line1, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04006053 }
6054
Chris Wrend6297db2012-05-03 16:20:13 -04006055 return contentView;
6056 }
6057
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006058 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08006059 * Construct a Style-specific RemoteViews for the collapsed notification layout.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006060 * The default implementation has nothing additional to add.
Selim Cinek7d1009b2017-01-25 15:28:28 -08006061 *
6062 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006063 * @hide
6064 */
Selim Cinek7d1009b2017-01-25 15:28:28 -08006065 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006066 return null;
6067 }
6068
6069 /**
6070 * Construct a Style-specific RemoteViews for the final big notification layout.
6071 * @hide
6072 */
6073 public RemoteViews makeBigContentView() {
6074 return null;
6075 }
6076
6077 /**
6078 * Construct a Style-specific RemoteViews for the final HUN layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08006079 *
6080 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006081 * @hide
6082 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08006083 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006084 return null;
6085 }
6086
6087 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006088 * Apply any style-specific extras to this notification before shipping it out.
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006089 * @hide
6090 */
6091 public void addExtras(Bundle extras) {
6092 if (mSummaryTextSet) {
6093 extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
6094 }
6095 if (mBigContentTitle != null) {
6096 extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
6097 }
Chris Wren91ad5632013-06-05 15:05:57 -04006098 extras.putString(EXTRA_TEMPLATE, this.getClass().getName());
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006099 }
6100
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006101 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006102 * Reconstruct the internal state of this Style object from extras.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006103 * @hide
6104 */
Christoph Studer4600f9b2014-07-22 22:44:43 +02006105 protected void restoreFromExtras(Bundle extras) {
6106 if (extras.containsKey(EXTRA_SUMMARY_TEXT)) {
6107 mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT);
6108 mSummaryTextSet = true;
6109 }
6110 if (extras.containsKey(EXTRA_TITLE_BIG)) {
6111 mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG);
6112 }
6113 }
6114
6115
6116 /**
6117 * @hide
6118 */
6119 public Notification buildStyled(Notification wip) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006120 addExtras(wip.extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006121 return wip;
6122 }
6123
Daniel Sandler0ec46202015-06-24 01:27:05 -04006124 /**
6125 * @hide
6126 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006127 public void purgeResources() {}
6128
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006129 /**
6130 * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is
6131 * attached to.
6132 *
6133 * @return the fully constructed Notification.
6134 */
6135 public Notification build() {
6136 checkBuilder();
6137 return mBuilder.build();
6138 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02006139
6140 /**
6141 * @hide
6142 * @return true if the style positions the progress bar on the second line; false if the
6143 * style hides the progress bar
6144 */
6145 protected boolean hasProgress() {
6146 return true;
6147 }
Selim Cinek03d0d652015-11-13 13:18:09 -05006148
6149 /**
6150 * @hide
6151 * @return Whether we should put the summary be put into the notification header
6152 */
6153 public boolean hasSummaryInHeader() {
6154 return true;
6155 }
Selim Cinek593610c2016-02-16 18:42:57 -08006156
6157 /**
6158 * @hide
6159 * @return Whether custom content views are displayed inline in the style
6160 */
6161 public boolean displayCustomViewInline() {
6162 return false;
6163 }
Selim Cinekd0426622017-07-11 13:19:59 +02006164
6165 /**
6166 * Reduces the image sizes contained in this style.
6167 *
6168 * @hide
6169 */
6170 public void reduceImageSizes(Context context) {
6171 }
Selim Cinek90343862018-02-01 11:07:11 -08006172
6173 /**
6174 * Validate that this style was properly composed. This is called at build time.
6175 * @hide
6176 */
6177 public void validate(Context context) {
6178 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05006179
6180 /**
6181 * @hide
6182 */
6183 public abstract boolean areNotificationsVisiblyDifferent(Style other);
Selim Cinekc7f5a822018-03-20 19:32:06 -07006184
Selim Cinekaa9db1f2018-02-27 17:35:47 -08006185 /**
6186 * @return the the text that should be displayed in the statusBar when heads-upped.
6187 * If {@code null} is returned, the default implementation will be used.
6188 *
6189 * @hide
6190 */
6191 public CharSequence getHeadsUpStatusBarText() {
6192 return null;
6193 }
Joe Onorato46439ce2010-11-19 13:56:21 -08006194 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006195
6196 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006197 * Helper class for generating large-format notifications that include a large image attachment.
Joe Malin8d40d042012-11-05 11:36:40 -08006198 *
Robert Ly91c5ce32014-06-08 15:37:00 -07006199 * Here's how you'd set the <code>BigPictureStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006200 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07006201 * Notification notif = new Notification.Builder(mContext)
6202 * .setContentTitle(&quot;New photo from &quot; + sender.toString())
6203 * .setContentText(subject)
6204 * .setSmallIcon(R.drawable.new_post)
6205 * .setLargeIcon(aBitmap)
6206 * .setStyle(new Notification.BigPictureStyle()
6207 * .bigPicture(aBigBitmap))
6208 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006209 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006210 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006211 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006212 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006213 public static class BigPictureStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006214 private Bitmap mPicture;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006215 private Icon mBigLargeIcon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006216 private boolean mBigLargeIconSet = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006217
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006218 public BigPictureStyle() {
6219 }
6220
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006221 /**
6222 * @deprecated use {@code BigPictureStyle()}.
6223 */
6224 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006225 public BigPictureStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006226 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006227 }
6228
Chris Wrend6297db2012-05-03 16:20:13 -04006229 /**
6230 * Overrides ContentTitle in the big form of the template.
6231 * This defaults to the value passed to setContentTitle().
6232 */
6233 public BigPictureStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006234 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006235 return this;
6236 }
6237
6238 /**
6239 * Set the first line of text after the detail section in the big form of the template.
6240 */
6241 public BigPictureStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006242 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006243 return this;
6244 }
6245
Chris Wren0bd664d2012-08-01 13:56:56 -04006246 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05006247 * @hide
6248 */
6249 public Bitmap getBigPicture() {
6250 return mPicture;
6251 }
6252
6253 /**
Chris Wren0bd664d2012-08-01 13:56:56 -04006254 * Provide the bitmap to be used as the payload for the BigPicture notification.
6255 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006256 public BigPictureStyle bigPicture(Bitmap b) {
6257 mPicture = b;
6258 return this;
6259 }
6260
Chris Wren3745a3d2012-05-22 15:11:52 -04006261 /**
Chris Wren3745a3d2012-05-22 15:11:52 -04006262 * Override the large icon when the big notification is shown.
6263 */
6264 public BigPictureStyle bigLargeIcon(Bitmap b) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04006265 return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
6266 }
6267
6268 /**
6269 * Override the large icon when the big notification is shown.
6270 */
6271 public BigPictureStyle bigLargeIcon(Icon icon) {
Chris Wren3745a3d2012-05-22 15:11:52 -04006272 mBigLargeIconSet = true;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006273 mBigLargeIcon = icon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006274 return this;
6275 }
6276
Riley Andrews0394a0c2015-11-03 23:36:52 -08006277 /** @hide */
6278 public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10);
6279
Daniel Sandler0ec46202015-06-24 01:27:05 -04006280 /**
6281 * @hide
6282 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006283 @Override
6284 public void purgeResources() {
6285 super.purgeResources();
Riley Andrews8cee7c12015-11-01 23:36:04 -08006286 if (mPicture != null &&
6287 mPicture.isMutable() &&
Riley Andrews0394a0c2015-11-03 23:36:52 -08006288 mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) {
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006289 mPicture = mPicture.createAshmemBitmap();
6290 }
6291 if (mBigLargeIcon != null) {
6292 mBigLargeIcon.convertToAshmem();
6293 }
6294 }
Christoph Studer5c510ee2014-12-15 16:32:27 +01006295
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006296 /**
6297 * @hide
6298 */
Selim Cinekd0426622017-07-11 13:19:59 +02006299 @Override
6300 public void reduceImageSizes(Context context) {
6301 super.reduceImageSizes(context);
6302 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07006303 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02006304 if (mPicture != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006305 int maxPictureWidth = resources.getDimensionPixelSize(isLowRam
6306 ? R.dimen.notification_big_picture_max_height_low_ram
6307 : R.dimen.notification_big_picture_max_height);
6308 int maxPictureHeight = resources.getDimensionPixelSize(isLowRam
6309 ? R.dimen.notification_big_picture_max_width_low_ram
6310 : R.dimen.notification_big_picture_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02006311 mPicture = Icon.scaleDownIfNecessary(mPicture, maxPictureWidth, maxPictureHeight);
6312 }
6313 if (mBigLargeIcon != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006314 int rightIconSize = resources.getDimensionPixelSize(isLowRam
6315 ? R.dimen.notification_right_icon_size_low_ram
6316 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02006317 mBigLargeIcon.scaleDownIfNecessary(rightIconSize, rightIconSize);
6318 }
6319 }
6320
6321 /**
6322 * @hide
6323 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006324 public RemoteViews makeBigContentView() {
6325 // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet
Christoph Studer5c510ee2014-12-15 16:32:27 +01006326 // This covers the following cases:
6327 // 1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006328 // mN.mLargeIcon
6329 // 2. !mBigLargeIconSet -> mN.mLargeIcon applies
Dan Sandlerd63f9322015-05-06 15:18:49 -04006330 Icon oldLargeIcon = null;
Selim Cineke99acb22016-08-04 12:55:48 -07006331 Bitmap largeIconLegacy = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006332 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006333 oldLargeIcon = mBuilder.mN.mLargeIcon;
6334 mBuilder.mN.mLargeIcon = mBigLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006335 // The legacy largeIcon might not allow us to clear the image, as it's taken in
6336 // replacement if the other one is null. Because we're restoring these legacy icons
6337 // for old listeners, this is in general non-null.
6338 largeIconLegacy = mBuilder.mN.largeIcon;
6339 mBuilder.mN.largeIcon = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006340 }
6341
Selim Cinek384804b2018-04-18 14:31:07 +08006342 RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource(),
6343 null /* result */);
Selim Cinek03d0d652015-11-13 13:18:09 -05006344 if (mSummaryTextSet) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006345 contentView.setTextViewText(R.id.text, mBuilder.processTextSpans(
6346 mBuilder.processLegacyText(mSummaryText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006347 mBuilder.setTextViewColorSecondary(contentView, R.id.text);
Selim Cinekc848c3a2016-01-13 15:27:30 -08006348 contentView.setViewVisibility(R.id.text, View.VISIBLE);
Selim Cinek03d0d652015-11-13 13:18:09 -05006349 }
Selim Cinek279fa862016-06-14 10:57:25 -07006350 mBuilder.setContentMinHeight(contentView, mBuilder.mN.hasLargeIcon());
Selim Cinek53e64a42015-11-16 10:40:56 -08006351
Christoph Studer5c510ee2014-12-15 16:32:27 +01006352 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006353 mBuilder.mN.mLargeIcon = oldLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006354 mBuilder.mN.largeIcon = largeIconLegacy;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006355 }
6356
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006357 contentView.setImageViewBitmap(R.id.big_picture, mPicture);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006358 return contentView;
6359 }
6360
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006361 /**
6362 * @hide
6363 */
6364 public void addExtras(Bundle extras) {
6365 super.addExtras(extras);
6366
6367 if (mBigLargeIconSet) {
6368 extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
6369 }
6370 extras.putParcelable(EXTRA_PICTURE, mPicture);
6371 }
6372
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006373 /**
6374 * @hide
6375 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006376 @Override
Christoph Studer4600f9b2014-07-22 22:44:43 +02006377 protected void restoreFromExtras(Bundle extras) {
6378 super.restoreFromExtras(extras);
6379
6380 if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) {
Christoph Studer5c510ee2014-12-15 16:32:27 +01006381 mBigLargeIconSet = true;
Christoph Studer4600f9b2014-07-22 22:44:43 +02006382 mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG);
Chris Wren3745a3d2012-05-22 15:11:52 -04006383 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02006384 mPicture = extras.getParcelable(EXTRA_PICTURE);
6385 }
Selim Cinek03d0d652015-11-13 13:18:09 -05006386
6387 /**
6388 * @hide
6389 */
6390 @Override
6391 public boolean hasSummaryInHeader() {
6392 return false;
6393 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05006394
6395 /**
6396 * @hide
Dan Sandler7d67bd42018-05-15 14:06:38 -04006397 * Note that we aren't actually comparing the contents of the bitmaps here, so this
6398 * is only doing a cursory inspection. Bitmaps of equal size will appear the same.
Julia Reynolds7217dc92018-03-07 12:12:09 -05006399 */
6400 @Override
6401 public boolean areNotificationsVisiblyDifferent(Style other) {
6402 if (other == null || getClass() != other.getClass()) {
6403 return true;
6404 }
6405 BigPictureStyle otherS = (BigPictureStyle) other;
Dan Sandler7d67bd42018-05-15 14:06:38 -04006406 return areBitmapsObviouslyDifferent(getBigPicture(), otherS.getBigPicture());
6407 }
6408
6409 private static boolean areBitmapsObviouslyDifferent(Bitmap a, Bitmap b) {
6410 if (a == b) {
6411 return false;
6412 }
6413 if (a == null || b == null) {
6414 return true;
6415 }
6416 return a.getWidth() != b.getWidth()
6417 || a.getHeight() != b.getHeight()
6418 || a.getConfig() != b.getConfig()
6419 || a.getGenerationId() != b.getGenerationId();
Julia Reynolds7217dc92018-03-07 12:12:09 -05006420 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006421 }
6422
6423 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006424 * Helper class for generating large-format notifications that include a lot of text.
Joe Malin8d40d042012-11-05 11:36:40 -08006425 *
Robert Ly91c5ce32014-06-08 15:37:00 -07006426 * Here's how you'd set the <code>BigTextStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006427 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07006428 * Notification notif = new Notification.Builder(mContext)
6429 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
6430 * .setContentText(subject)
6431 * .setSmallIcon(R.drawable.new_mail)
6432 * .setLargeIcon(aBitmap)
6433 * .setStyle(new Notification.BigTextStyle()
6434 * .bigText(aVeryLongString))
6435 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006436 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006437 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006438 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006439 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006440 public static class BigTextStyle extends Style {
Jorim Jaggi457a10d2014-09-08 16:18:23 +02006441
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006442 private CharSequence mBigText;
6443
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006444 public BigTextStyle() {
6445 }
6446
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006447 /**
6448 * @deprecated use {@code BigTextStyle()}.
6449 */
6450 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006451 public BigTextStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006452 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006453 }
6454
Chris Wrend6297db2012-05-03 16:20:13 -04006455 /**
6456 * Overrides ContentTitle in the big form of the template.
6457 * This defaults to the value passed to setContentTitle().
6458 */
6459 public BigTextStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006460 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006461 return this;
6462 }
6463
6464 /**
6465 * Set the first line of text after the detail section in the big form of the template.
6466 */
6467 public BigTextStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006468 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006469 return this;
6470 }
6471
Chris Wren0bd664d2012-08-01 13:56:56 -04006472 /**
6473 * Provide the longer text to be displayed in the big form of the
6474 * template in place of the content text.
6475 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006476 public BigTextStyle bigText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006477 mBigText = safeCharSequence(cs);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006478 return this;
6479 }
6480
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006481 /**
6482 * @hide
6483 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05006484 public CharSequence getBigText() {
6485 return mBigText;
6486 }
6487
6488 /**
6489 * @hide
6490 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006491 public void addExtras(Bundle extras) {
6492 super.addExtras(extras);
6493
Christoph Studer4600f9b2014-07-22 22:44:43 +02006494 extras.putCharSequence(EXTRA_BIG_TEXT, mBigText);
6495 }
6496
6497 /**
6498 * @hide
6499 */
6500 @Override
6501 protected void restoreFromExtras(Bundle extras) {
6502 super.restoreFromExtras(extras);
6503
6504 mBigText = extras.getCharSequence(EXTRA_BIG_TEXT);
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006505 }
6506
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006507 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08006508 * @param increasedHeight true if this layout be created with an increased height.
6509 *
6510 * @hide
6511 */
6512 @Override
6513 public RemoteViews makeContentView(boolean increasedHeight) {
6514 if (increasedHeight) {
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006515 mBuilder.mOriginalActions = mBuilder.mActions;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006516 mBuilder.mActions = new ArrayList<>();
6517 RemoteViews remoteViews = makeBigContentView();
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006518 mBuilder.mActions = mBuilder.mOriginalActions;
6519 mBuilder.mOriginalActions = null;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006520 return remoteViews;
6521 }
6522 return super.makeContentView(increasedHeight);
6523 }
6524
6525 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006526 * @hide
6527 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08006528 @Override
6529 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
6530 if (increasedHeight && mBuilder.mActions.size() > 0) {
6531 return makeBigContentView();
6532 }
6533 return super.makeHeadsUpContentView(increasedHeight);
6534 }
6535
6536 /**
6537 * @hide
6538 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006539 public RemoteViews makeBigContentView() {
Christoph Studer4600f9b2014-07-22 22:44:43 +02006540
6541 // Nasty
Selim Cinek75998782016-04-26 10:39:17 -07006542 CharSequence text = mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006543 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Daniel Sandler916ad912012-06-13 12:17:07 -04006544
Selim Cinek384804b2018-04-18 14:31:07 +08006545 TemplateBindResult result = new TemplateBindResult();
6546 RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource(), result);
Selim Cinek1c72fa02018-04-23 18:00:54 +08006547 contentView.setInt(R.id.big_text, "setImageEndMargin", result.getIconMarginEnd());
Joe Malin8d40d042012-11-05 11:36:40 -08006548
Selim Cinek75998782016-04-26 10:39:17 -07006549 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, text);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006550
Selim Cinek3a2c4b92015-12-17 17:01:17 -08006551 CharSequence bigTextText = mBuilder.processLegacyText(mBigText);
Selim Cinek75998782016-04-26 10:39:17 -07006552 if (TextUtils.isEmpty(bigTextText)) {
6553 // In case the bigtext is null / empty fall back to the normal text to avoid a weird
6554 // experience
6555 bigTextText = mBuilder.processLegacyText(text);
6556 }
Adrian Roosb1f427c2016-05-26 12:27:15 -07006557 applyBigTextContentView(mBuilder, contentView, bigTextText);
Selim Cinek4fb12d32015-11-19 18:10:48 -08006558
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006559 return contentView;
6560 }
6561
Julia Reynolds7217dc92018-03-07 12:12:09 -05006562 /**
6563 * @hide
Dan Sandler7d67bd42018-05-15 14:06:38 -04006564 * Spans are ignored when comparing text for visual difference.
Julia Reynolds7217dc92018-03-07 12:12:09 -05006565 */
6566 @Override
6567 public boolean areNotificationsVisiblyDifferent(Style other) {
6568 if (other == null || getClass() != other.getClass()) {
6569 return true;
6570 }
6571 BigTextStyle newS = (BigTextStyle) other;
Dan Sandler7d67bd42018-05-15 14:06:38 -04006572 return !Objects.equals(String.valueOf(getBigText()), String.valueOf(newS.getBigText()));
Julia Reynolds7217dc92018-03-07 12:12:09 -05006573 }
6574
Adrian Roosb1f427c2016-05-26 12:27:15 -07006575 static void applyBigTextContentView(Builder builder,
6576 RemoteViews contentView, CharSequence bigTextText) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006577 contentView.setTextViewText(R.id.big_text, builder.processTextSpans(bigTextText));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006578 builder.setTextViewColorSecondary(contentView, R.id.big_text);
Adrian Roosb1f427c2016-05-26 12:27:15 -07006579 contentView.setViewVisibility(R.id.big_text,
6580 TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE);
Selim Cinek279fa862016-06-14 10:57:25 -07006581 contentView.setBoolean(R.id.big_text, "setHasImage", builder.mN.hasLargeIcon());
Adrian Roosb1f427c2016-05-26 12:27:15 -07006582 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006583 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04006584
6585 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006586 * Helper class for generating large-format notifications that include multiple back-and-forth
6587 * messages of varying types between any number of people.
6588 *
Selim Cinekce8794f2018-05-23 16:46:05 -07006589 * <p>
Alex Hillsfc737de2016-03-23 17:33:02 -04006590 * If the platform does not provide large-format notifications, this method has no effect. The
6591 * user will always see the normal notification view.
Selim Cinekce8794f2018-05-23 16:46:05 -07006592 *
6593 * <p>
6594 * If the app is targeting Android P and above, it is required to use the {@link Person}
6595 * class in order to get an optimal rendering of the notification and its avatars. For
6596 * conversations involving multiple people, the app should also make sure that it marks the
6597 * conversation as a group with {@link #setGroupConversation(boolean)}.
6598 *
6599 * <p>
6600 * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior.
6601 * Here's an example of how this may be used:
Alex Hillsfc737de2016-03-23 17:33:02 -04006602 * <pre class="prettyprint">
6603 *
Selim Cinekce8794f2018-05-23 16:46:05 -07006604 * Person user = new Person.Builder().setIcon(userIcon).setName(userName).build();
6605 * MessagingStyle style = new MessagingStyle(user)
6606 * .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getPerson())
6607 * .addMessage(messages[2].getText(), messages[2].getTime(), messages[2].getPerson())
6608 * .setGroupConversation(hasMultiplePeople());
6609 *
Alex Hillsfc737de2016-03-23 17:33:02 -04006610 * Notification noti = new Notification.Builder()
Selim Cinekce8794f2018-05-23 16:46:05 -07006611 * .setContentTitle(&quot;2 new messages with &quot; + sender.toString())
Alex Hillsfc737de2016-03-23 17:33:02 -04006612 * .setContentText(subject)
6613 * .setSmallIcon(R.drawable.new_message)
6614 * .setLargeIcon(aBitmap)
Selim Cinekce8794f2018-05-23 16:46:05 -07006615 * .setStyle(style)
Alex Hillsfc737de2016-03-23 17:33:02 -04006616 * .build();
6617 * </pre>
6618 */
6619 public static class MessagingStyle extends Style {
6620
6621 /**
6622 * The maximum number of messages that will be retained in the Notification itself (the
6623 * number displayed is up to the platform).
6624 */
6625 public static final int MAXIMUM_RETAINED_MESSAGES = 25;
6626
Selim Cinekcb8b9852017-12-15 18:01:52 -08006627 @NonNull Person mUser;
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006628 @Nullable CharSequence mConversationTitle;
Alex Hillsd9b04d92016-04-11 16:38:16 -04006629 List<Message> mMessages = new ArrayList<>();
Adrian Roos437cd562017-01-18 15:47:03 -08006630 List<Message> mHistoricMessages = new ArrayList<>();
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006631 boolean mIsGroupConversation;
Alex Hillsfc737de2016-03-23 17:33:02 -04006632
6633 MessagingStyle() {
6634 }
6635
6636 /**
Alex Hillsfd590442016-10-07 09:52:44 -04006637 * @param userDisplayName Required - the name to be displayed for any replies sent by the
6638 * user before the posting app reposts the notification with those messages after they've
6639 * been actually sent and in previous messages sent by the user added in
Alex Hillsfc737de2016-03-23 17:33:02 -04006640 * {@link #addMessage(Notification.MessagingStyle.Message)}
Selim Cinekcb8b9852017-12-15 18:01:52 -08006641 *
6642 * @deprecated use {@code MessagingStyle(Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006643 */
Alex Hillsfd590442016-10-07 09:52:44 -04006644 public MessagingStyle(@NonNull CharSequence userDisplayName) {
Selim Cinek9acd6732018-03-23 16:39:02 -07006645 this(new Person.Builder().setName(userDisplayName).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006646 }
6647
6648 /**
6649 * @param user Required - The person displayed for any messages that are sent by the
6650 * user. Any messages added with {@link #addMessage(Notification.MessagingStyle.Message)}
6651 * who don't have a Person associated with it will be displayed as if they were sent
Selim Cinek90343862018-02-01 11:07:11 -08006652 * by this user. The user also needs to have a valid name associated with it, which will
6653 * be enforced starting in Android P.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006654 */
6655 public MessagingStyle(@NonNull Person user) {
6656 mUser = user;
Selim Cinek90343862018-02-01 11:07:11 -08006657 }
6658
6659 /**
6660 * Validate that this style was properly composed. This is called at build time.
6661 * @hide
6662 */
6663 @Override
6664 public void validate(Context context) {
6665 super.validate(context);
6666 if (context.getApplicationInfo().targetSdkVersion
6667 >= Build.VERSION_CODES.P && (mUser == null || mUser.getName() == null)) {
6668 throw new RuntimeException("User must be valid and have a name.");
Selim Cinekcb8b9852017-12-15 18:01:52 -08006669 }
6670 }
6671
6672 /**
Selim Cinekaa9db1f2018-02-27 17:35:47 -08006673 * @return the the text that should be displayed in the statusBar when heads upped.
6674 * If {@code null} is returned, the default implementation will be used.
6675 *
6676 * @hide
6677 */
6678 @Override
6679 public CharSequence getHeadsUpStatusBarText() {
6680 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
6681 ? super.mBigContentTitle
6682 : mConversationTitle;
6683 if (!TextUtils.isEmpty(conversationTitle) && !hasOnlyWhiteSpaceSenders()) {
6684 return conversationTitle;
6685 }
6686 return null;
6687 }
6688
6689 /**
Selim Cinekcb8b9852017-12-15 18:01:52 -08006690 * @return the user to be displayed for any replies sent by the user
6691 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006692 @NonNull
Selim Cinekcb8b9852017-12-15 18:01:52 -08006693 public Person getUser() {
6694 return mUser;
Alex Hillsfc737de2016-03-23 17:33:02 -04006695 }
6696
6697 /**
6698 * Returns the name to be displayed for any replies sent by the user
Selim Cinekcb8b9852017-12-15 18:01:52 -08006699 *
6700 * @deprecated use {@link #getUser()} instead
Alex Hillsfc737de2016-03-23 17:33:02 -04006701 */
6702 public CharSequence getUserDisplayName() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006703 return mUser.getName();
Alex Hillsfc737de2016-03-23 17:33:02 -04006704 }
6705
6706 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006707 * Sets the title to be displayed on this conversation. May be set to {@code null}.
6708 *
Kodlee Yin14656422017-12-22 17:00:46 -08006709 * <p>This API's behavior was changed in SDK version {@link Build.VERSION_CODES#P}. If your
6710 * application's target version is less than {@link Build.VERSION_CODES#P}, setting a
6711 * conversation title to a non-null value will make {@link #isGroupConversation()} return
6712 * {@code true} and passing {@code null} will make it return {@code false}. In
6713 * {@link Build.VERSION_CODES#P} and beyond, use {@link #setGroupConversation(boolean)}
6714 * to set group conversation status.
6715 *
6716 * @param conversationTitle Title displayed for this conversation
6717 * @return this object for method chaining
Alex Hillsfc737de2016-03-23 17:33:02 -04006718 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006719 public MessagingStyle setConversationTitle(@Nullable CharSequence conversationTitle) {
Alex Hillsfc737de2016-03-23 17:33:02 -04006720 mConversationTitle = conversationTitle;
6721 return this;
6722 }
6723
6724 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006725 * Return the title to be displayed on this conversation. May return {@code null}.
Alex Hillsfc737de2016-03-23 17:33:02 -04006726 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006727 @Nullable
Alex Hillsfc737de2016-03-23 17:33:02 -04006728 public CharSequence getConversationTitle() {
6729 return mConversationTitle;
6730 }
6731
6732 /**
6733 * Adds a message for display by this notification. Convenience call for a simple
6734 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6735 * @param text A {@link CharSequence} to be displayed as the message content
6736 * @param timestamp Time at which the message arrived
6737 * @param sender A {@link CharSequence} to be used for displaying the name of the
6738 * sender. Should be <code>null</code> for messages by the current user, in which case
6739 * the platform will insert {@link #getUserDisplayName()}.
6740 * Should be unique amongst all individuals in the conversation, and should be
6741 * consistent during re-posts of the notification.
6742 *
6743 * @see Message#Message(CharSequence, long, CharSequence)
6744 *
6745 * @return this object for method chaining
Selim Cinekcb8b9852017-12-15 18:01:52 -08006746 *
6747 * @deprecated use {@link #addMessage(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006748 */
6749 public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006750 return addMessage(text, timestamp,
Selim Cinek9acd6732018-03-23 16:39:02 -07006751 sender == null ? null : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006752 }
6753
6754 /**
6755 * Adds a message for display by this notification. Convenience call for a simple
6756 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6757 * @param text A {@link CharSequence} to be displayed as the message content
6758 * @param timestamp Time at which the message arrived
6759 * @param sender The {@link Person} who sent the message.
6760 * Should be <code>null</code> for messages by the current user, in which case
6761 * the platform will insert the user set in {@code MessagingStyle(Person)}.
6762 *
6763 * @see Message#Message(CharSequence, long, CharSequence)
6764 *
6765 * @return this object for method chaining
6766 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006767 public MessagingStyle addMessage(@NonNull CharSequence text, long timestamp,
6768 @Nullable Person sender) {
Adrian Roos437cd562017-01-18 15:47:03 -08006769 return addMessage(new Message(text, timestamp, sender));
Alex Hillsfc737de2016-03-23 17:33:02 -04006770 }
6771
6772 /**
6773 * Adds a {@link Message} for display in this notification.
Adrian Roos437cd562017-01-18 15:47:03 -08006774 *
6775 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6776 * the newest last.
6777 *
Alex Hillsfc737de2016-03-23 17:33:02 -04006778 * @param message The {@link Message} to be displayed
6779 * @return this object for method chaining
6780 */
6781 public MessagingStyle addMessage(Message message) {
6782 mMessages.add(message);
6783 if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6784 mMessages.remove(0);
6785 }
6786 return this;
6787 }
6788
6789 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006790 * Adds a {@link Message} for historic context in this notification.
6791 *
6792 * <p>Messages should be added as historic if they are not the main subject of the
6793 * notification but may give context to a conversation. The system may choose to present
6794 * them only when relevant, e.g. when replying to a message through a {@link RemoteInput}.
6795 *
6796 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6797 * the newest last.
6798 *
6799 * @param message The historic {@link Message} to be added
6800 * @return this object for method chaining
6801 */
6802 public MessagingStyle addHistoricMessage(Message message) {
6803 mHistoricMessages.add(message);
6804 if (mHistoricMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6805 mHistoricMessages.remove(0);
6806 }
6807 return this;
6808 }
6809
6810 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006811 * Gets the list of {@code Message} objects that represent the notification
6812 */
6813 public List<Message> getMessages() {
6814 return mMessages;
6815 }
6816
6817 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006818 * Gets the list of historic {@code Message}s in the notification.
6819 */
6820 public List<Message> getHistoricMessages() {
6821 return mHistoricMessages;
6822 }
6823
6824 /**
Selim Cinekce8794f2018-05-23 16:46:05 -07006825 * Sets whether this conversation notification represents a group. If the app is targeting
6826 * Android P, this is required if the app wants to display the largeIcon set with
6827 * {@link Notification.Builder#setLargeIcon(Bitmap)}, otherwise it will be hidden.
Kodlee Yin14656422017-12-22 17:00:46 -08006828 *
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006829 * @param isGroupConversation {@code true} if the conversation represents a group,
6830 * {@code false} otherwise.
6831 * @return this object for method chaining
6832 */
6833 public MessagingStyle setGroupConversation(boolean isGroupConversation) {
6834 mIsGroupConversation = isGroupConversation;
6835 return this;
6836 }
6837
6838 /**
Kodlee Yin14656422017-12-22 17:00:46 -08006839 * Returns {@code true} if this notification represents a group conversation, otherwise
6840 * {@code false}.
6841 *
6842 * <p> If the application that generated this {@link MessagingStyle} targets an SDK version
6843 * less than {@link Build.VERSION_CODES#P}, this method becomes dependent on whether or
6844 * not the conversation title is set; returning {@code true} if the conversation title is
6845 * a non-null value, or {@code false} otherwise. From {@link Build.VERSION_CODES#P} forward,
6846 * this method returns what's set by {@link #setGroupConversation(boolean)} allowing for
6847 * named, non-group conversations.
6848 *
6849 * @see #setConversationTitle(CharSequence)
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006850 */
6851 public boolean isGroupConversation() {
Kodlee Yin14656422017-12-22 17:00:46 -08006852 // When target SDK version is < P, a non-null conversation title dictates if this is
6853 // as group conversation.
6854 if (mBuilder != null
6855 && mBuilder.mContext.getApplicationInfo().targetSdkVersion
6856 < Build.VERSION_CODES.P) {
6857 return mConversationTitle != null;
6858 }
6859
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006860 return mIsGroupConversation;
6861 }
6862
6863 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006864 * @hide
6865 */
6866 @Override
6867 public void addExtras(Bundle extras) {
6868 super.addExtras(extras);
Selim Cinekcb8b9852017-12-15 18:01:52 -08006869 if (mUser != null) {
6870 // For legacy usages
6871 extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUser.getName());
6872 extras.putParcelable(EXTRA_MESSAGING_PERSON, mUser);
Alex Hillsfc737de2016-03-23 17:33:02 -04006873 }
6874 if (mConversationTitle != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04006875 extras.putCharSequence(EXTRA_CONVERSATION_TITLE, mConversationTitle);
Alex Hillsfc737de2016-03-23 17:33:02 -04006876 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04006877 if (!mMessages.isEmpty()) { extras.putParcelableArray(EXTRA_MESSAGES,
6878 Message.getBundleArrayForMessages(mMessages));
Alex Hillsfc737de2016-03-23 17:33:02 -04006879 }
Adrian Roos437cd562017-01-18 15:47:03 -08006880 if (!mHistoricMessages.isEmpty()) { extras.putParcelableArray(EXTRA_HISTORIC_MESSAGES,
6881 Message.getBundleArrayForMessages(mHistoricMessages));
6882 }
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006883
6884 fixTitleAndTextExtras(extras);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006885 extras.putBoolean(EXTRA_IS_GROUP_CONVERSATION, mIsGroupConversation);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006886 }
6887
6888 private void fixTitleAndTextExtras(Bundle extras) {
6889 Message m = findLatestIncomingMessage();
6890 CharSequence text = (m == null) ? null : m.mText;
6891 CharSequence sender = m == null ? null
Selim Cinekcb8b9852017-12-15 18:01:52 -08006892 : m.mSender == null || TextUtils.isEmpty(m.mSender.getName())
6893 ? mUser.getName() : m.mSender.getName();
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006894 CharSequence title;
6895 if (!TextUtils.isEmpty(mConversationTitle)) {
6896 if (!TextUtils.isEmpty(sender)) {
6897 BidiFormatter bidi = BidiFormatter.getInstance();
6898 title = mBuilder.mContext.getString(
6899 com.android.internal.R.string.notification_messaging_title_template,
Selim Cinekcb8b9852017-12-15 18:01:52 -08006900 bidi.unicodeWrap(mConversationTitle), bidi.unicodeWrap(sender));
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006901 } else {
6902 title = mConversationTitle;
6903 }
6904 } else {
6905 title = sender;
6906 }
6907
6908 if (title != null) {
6909 extras.putCharSequence(EXTRA_TITLE, title);
6910 }
6911 if (text != null) {
6912 extras.putCharSequence(EXTRA_TEXT, text);
6913 }
Alex Hillsfc737de2016-03-23 17:33:02 -04006914 }
6915
6916 /**
6917 * @hide
6918 */
6919 @Override
6920 protected void restoreFromExtras(Bundle extras) {
6921 super.restoreFromExtras(extras);
6922
Selim Cinekcb8b9852017-12-15 18:01:52 -08006923 mUser = extras.getParcelable(EXTRA_MESSAGING_PERSON);
6924 if (mUser == null) {
6925 CharSequence displayName = extras.getCharSequence(EXTRA_SELF_DISPLAY_NAME);
Selim Cinek9acd6732018-03-23 16:39:02 -07006926 mUser = new Person.Builder().setName(displayName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08006927 }
Adrian Roos96b7e202016-05-17 13:50:38 -07006928 mConversationTitle = extras.getCharSequence(EXTRA_CONVERSATION_TITLE);
Adrian Roos437cd562017-01-18 15:47:03 -08006929 Parcelable[] messages = extras.getParcelableArray(EXTRA_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006930 mMessages = Message.getMessagesFromBundleArray(messages);
Adrian Roos437cd562017-01-18 15:47:03 -08006931 Parcelable[] histMessages = extras.getParcelableArray(EXTRA_HISTORIC_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006932 mHistoricMessages = Message.getMessagesFromBundleArray(histMessages);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006933 mIsGroupConversation = extras.getBoolean(EXTRA_IS_GROUP_CONVERSATION);
Alex Hillsfc737de2016-03-23 17:33:02 -04006934 }
6935
6936 /**
6937 * @hide
6938 */
Adrian Roosc1a80b02016-04-05 14:54:55 -07006939 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08006940 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cineke62255c2017-09-28 18:23:23 -07006941 mBuilder.mOriginalActions = mBuilder.mActions;
6942 mBuilder.mActions = new ArrayList<>();
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006943 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
Selim Cinek384804b2018-04-18 14:31:07 +08006944 false /* hideLargeIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07006945 mBuilder.mActions = mBuilder.mOriginalActions;
6946 mBuilder.mOriginalActions = null;
6947 return remoteViews;
Adrian Roosc1a80b02016-04-05 14:54:55 -07006948 }
6949
Julia Reynolds7217dc92018-03-07 12:12:09 -05006950 /**
6951 * @hide
Dan Sandler7d67bd42018-05-15 14:06:38 -04006952 * Spans are ignored when comparing text for visual difference.
Julia Reynolds7217dc92018-03-07 12:12:09 -05006953 */
6954 @Override
6955 public boolean areNotificationsVisiblyDifferent(Style other) {
6956 if (other == null || getClass() != other.getClass()) {
6957 return true;
6958 }
6959 MessagingStyle newS = (MessagingStyle) other;
6960 List<MessagingStyle.Message> oldMs = getMessages();
6961 List<MessagingStyle.Message> newMs = newS.getMessages();
6962
Dan Sandler7d67bd42018-05-15 14:06:38 -04006963 if (oldMs == null || newMs == null) {
Julia Reynolds7217dc92018-03-07 12:12:09 -05006964 newMs = new ArrayList<>();
6965 }
6966
6967 int n = oldMs.size();
6968 if (n != newMs.size()) {
6969 return true;
6970 }
6971 for (int i = 0; i < n; i++) {
6972 MessagingStyle.Message oldM = oldMs.get(i);
6973 MessagingStyle.Message newM = newMs.get(i);
Dan Sandler7d67bd42018-05-15 14:06:38 -04006974 if (!Objects.equals(
6975 String.valueOf(oldM.getText()),
6976 String.valueOf(newM.getText()))) {
Julia Reynolds7217dc92018-03-07 12:12:09 -05006977 return true;
6978 }
6979 if (!Objects.equals(oldM.getDataUri(), newM.getDataUri())) {
6980 return true;
6981 }
Dan Sandler7d67bd42018-05-15 14:06:38 -04006982 String oldSender = String.valueOf(oldM.getSenderPerson() == null
6983 ? oldM.getSender()
6984 : oldM.getSenderPerson().getName());
6985 String newSender = String.valueOf(newM.getSenderPerson() == null
6986 ? newM.getSender()
6987 : newM.getSenderPerson().getName());
Julia Reynolds7217dc92018-03-07 12:12:09 -05006988 if (!Objects.equals(oldSender, newSender)) {
6989 return true;
6990 }
6991
6992 String oldKey = oldM.getSenderPerson() == null
6993 ? null : oldM.getSenderPerson().getKey();
6994 String newKey = newM.getSenderPerson() == null
6995 ? null : newM.getSenderPerson().getKey();
6996 if (!Objects.equals(oldKey, newKey)) {
6997 return true;
6998 }
6999 // Other fields (like timestamp) intentionally excluded
7000 }
7001 return false;
7002 }
7003
Adrian Roosc1a80b02016-04-05 14:54:55 -07007004 private Message findLatestIncomingMessage() {
Selim Cinek88188f22017-09-19 16:46:56 -07007005 return findLatestIncomingMessage(mMessages);
7006 }
7007
7008 /**
7009 * @hide
7010 */
7011 @Nullable
7012 public static Message findLatestIncomingMessage(
7013 List<Message> messages) {
7014 for (int i = messages.size() - 1; i >= 0; i--) {
7015 Message m = messages.get(i);
Adrian Roosc1a80b02016-04-05 14:54:55 -07007016 // Incoming messages have a non-empty sender.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007017 if (m.mSender != null && !TextUtils.isEmpty(m.mSender.getName())) {
Adrian Roosc1a80b02016-04-05 14:54:55 -07007018 return m;
7019 }
7020 }
Selim Cinek88188f22017-09-19 16:46:56 -07007021 if (!messages.isEmpty()) {
Adrian Roos33fbd2c2016-05-27 15:35:28 -07007022 // No incoming messages, fall back to outgoing message
Selim Cinek88188f22017-09-19 16:46:56 -07007023 return messages.get(messages.size() - 1);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07007024 }
Adrian Roosc1a80b02016-04-05 14:54:55 -07007025 return null;
7026 }
7027
7028 /**
7029 * @hide
7030 */
7031 @Override
7032 public RemoteViews makeBigContentView() {
Selim Cinek384804b2018-04-18 14:31:07 +08007033 return makeMessagingView(false /* displayImagesAtEnd */, true /* hideLargeIcon */);
Selim Cinekafeed292017-12-12 17:32:44 -08007034 }
7035
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007036 /**
7037 * Create a messaging layout.
7038 *
7039 * @param displayImagesAtEnd should images be displayed at the end of the content instead
7040 * of inline.
Selim Cinek384804b2018-04-18 14:31:07 +08007041 * @param hideRightIcons Should the reply affordance be shown at the end of the notification
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007042 * @return the created remoteView.
7043 */
Selim Cinekafeed292017-12-12 17:32:44 -08007044 @NonNull
Selim Cinek384804b2018-04-18 14:31:07 +08007045 private RemoteViews makeMessagingView(boolean displayImagesAtEnd, boolean hideRightIcons) {
Selim Cinek88188f22017-09-19 16:46:56 -07007046 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
Adrian Roosc1a80b02016-04-05 14:54:55 -07007047 ? super.mBigContentTitle
7048 : mConversationTitle;
Selim Cinekce8794f2018-05-23 16:46:05 -07007049 boolean atLeastP = mBuilder.mContext.getApplicationInfo().targetSdkVersion
7050 >= Build.VERSION_CODES.P;
7051 boolean isOneToOne;
Selim Cinek2dd3e722018-01-19 11:06:06 -08007052 CharSequence nameReplacement = null;
Selim Cinekce8794f2018-05-23 16:46:05 -07007053 Icon avatarReplacement = null;
7054 if (!atLeastP) {
7055 isOneToOne = TextUtils.isEmpty(conversationTitle);
7056 avatarReplacement = mBuilder.mN.mLargeIcon;
7057 if (hasOnlyWhiteSpaceSenders()) {
7058 isOneToOne = true;
7059 nameReplacement = conversationTitle;
7060 conversationTitle = null;
7061 }
7062 } else {
7063 isOneToOne = !isGroupConversation();
Adrian Roosb1f427c2016-05-26 12:27:15 -07007064 }
Selim Cinek384804b2018-04-18 14:31:07 +08007065 TemplateBindResult bindResult = new TemplateBindResult();
Adrian Roos48d746a2016-04-12 14:57:28 -07007066 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
Adrian Roosc1a80b02016-04-05 14:54:55 -07007067 mBuilder.getMessagingLayoutResource(),
Selim Cinek88188f22017-09-19 16:46:56 -07007068 mBuilder.mParams.reset().hasProgress(false).title(conversationTitle).text(null)
Selim Cinek384804b2018-04-18 14:31:07 +08007069 .hideLargeIcon(hideRightIcons || isOneToOne)
7070 .hideReplyIcon(hideRightIcons)
7071 .headerTextSecondary(conversationTitle),
7072 bindResult);
Selim Cinek88188f22017-09-19 16:46:56 -07007073 addExtras(mBuilder.mN.extras);
Selim Cinekafeed292017-12-12 17:32:44 -08007074 // also update the end margin if there is an image
Selim Cinek1c72fa02018-04-23 18:00:54 +08007075 contentView.setViewLayoutMarginEnd(R.id.notification_messaging,
7076 bindResult.getIconMarginEnd());
Selim Cinek88188f22017-09-19 16:46:56 -07007077 contentView.setInt(R.id.status_bar_latest_event_content, "setLayoutColor",
Kenny Guy14d035c2018-05-02 19:10:36 +01007078 mBuilder.isColorized() ? mBuilder.getPrimaryTextColor()
7079 : mBuilder.resolveContrastColor());
7080 contentView.setInt(R.id.status_bar_latest_event_content, "setSenderTextColor",
7081 mBuilder.getPrimaryTextColor());
7082 contentView.setInt(R.id.status_bar_latest_event_content, "setMessageTextColor",
7083 mBuilder.getSecondaryTextColor());
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007084 contentView.setBoolean(R.id.status_bar_latest_event_content, "setDisplayImagesAtEnd",
7085 displayImagesAtEnd);
Selim Cinekce8794f2018-05-23 16:46:05 -07007086 contentView.setIcon(R.id.status_bar_latest_event_content, "setAvatarReplacement",
7087 avatarReplacement);
Selim Cinek2dd3e722018-01-19 11:06:06 -08007088 contentView.setCharSequence(R.id.status_bar_latest_event_content, "setNameReplacement",
7089 nameReplacement);
Selim Cinek88188f22017-09-19 16:46:56 -07007090 contentView.setBoolean(R.id.status_bar_latest_event_content, "setIsOneToOne",
7091 isOneToOne);
7092 contentView.setBundle(R.id.status_bar_latest_event_content, "setData",
7093 mBuilder.mN.extras);
Alex Hillsfc737de2016-03-23 17:33:02 -04007094 return contentView;
7095 }
7096
Selim Cinekf7409db2017-10-24 16:17:14 -07007097 private boolean hasOnlyWhiteSpaceSenders() {
7098 for (int i = 0; i < mMessages.size(); i++) {
7099 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08007100 Person sender = m.getSenderPerson();
7101 if (sender != null && !isWhiteSpace(sender.getName())) {
Selim Cinekf7409db2017-10-24 16:17:14 -07007102 return false;
7103 }
7104 }
7105 return true;
7106 }
7107
7108 private boolean isWhiteSpace(CharSequence sender) {
7109 if (TextUtils.isEmpty(sender)) {
7110 return true;
7111 }
7112 if (sender.toString().matches("^\\s*$")) {
7113 return true;
7114 }
7115 // Let's check if we only have 0 whitespace chars. Some apps did this as a workaround
7116 // For the presentation that we had.
7117 for (int i = 0; i < sender.length(); i++) {
7118 char c = sender.charAt(i);
7119 if (c != '\u200B') {
7120 return false;
7121 }
7122 }
7123 return true;
7124 }
7125
Selim Cinek88188f22017-09-19 16:46:56 -07007126 private CharSequence createConversationTitleFromMessages() {
7127 ArraySet<CharSequence> names = new ArraySet<>();
7128 for (int i = 0; i < mMessages.size(); i++) {
7129 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08007130 Person sender = m.getSenderPerson();
Selim Cinek88188f22017-09-19 16:46:56 -07007131 if (sender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007132 names.add(sender.getName());
Selim Cinek88188f22017-09-19 16:46:56 -07007133 }
7134 }
7135 SpannableStringBuilder title = new SpannableStringBuilder();
7136 int size = names.size();
7137 for (int i = 0; i < size; i++) {
7138 CharSequence name = names.valueAt(i);
7139 if (!TextUtils.isEmpty(title)) {
7140 title.append(", ");
7141 }
7142 title.append(BidiFormatter.getInstance().unicodeWrap(name));
7143 }
7144 return title;
7145 }
7146
Adrian Roosdedd1df2016-04-26 16:38:47 -07007147 /**
7148 * @hide
7149 */
7150 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007151 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007152 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
Selim Cinek384804b2018-04-18 14:31:07 +08007153 true /* hideLargeIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07007154 remoteViews.setInt(R.id.notification_messaging, "setMaxDisplayedLines", 1);
7155 return remoteViews;
Adrian Roosdedd1df2016-04-26 16:38:47 -07007156 }
7157
Adrian Roosc1a80b02016-04-05 14:54:55 -07007158 private static TextAppearanceSpan makeFontColorSpan(int color) {
7159 return new TextAppearanceSpan(null, 0, 0,
7160 ColorStateList.valueOf(color), null);
7161 }
7162
Alex Hillsd9b04d92016-04-11 16:38:16 -04007163 public static final class Message {
7164
7165 static final String KEY_TEXT = "text";
7166 static final String KEY_TIMESTAMP = "time";
7167 static final String KEY_SENDER = "sender";
Selim Cinekcb8b9852017-12-15 18:01:52 -08007168 static final String KEY_SENDER_PERSON = "sender_person";
Alex Hillsd9b04d92016-04-11 16:38:16 -04007169 static final String KEY_DATA_MIME_TYPE = "type";
7170 static final String KEY_DATA_URI= "uri";
Shane Brennan5a871862017-03-11 13:14:17 -08007171 static final String KEY_EXTRAS_BUNDLE = "extras";
Kenny Guya0f6de82018-04-06 16:20:16 +01007172 static final String KEY_REMOTE_INPUT_HISTORY = "remote_input_history";
Alex Hillsfc737de2016-03-23 17:33:02 -04007173
7174 private final CharSequence mText;
7175 private final long mTimestamp;
Selim Cinekcb8b9852017-12-15 18:01:52 -08007176 @Nullable
7177 private final Person mSender;
Kenny Guya0f6de82018-04-06 16:20:16 +01007178 /** True if this message was generated from the extra
7179 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}
7180 */
7181 private final boolean mRemoteInputHistory;
Alex Hillsfc737de2016-03-23 17:33:02 -04007182
Shane Brennan5a871862017-03-11 13:14:17 -08007183 private Bundle mExtras = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04007184 private String mDataMimeType;
7185 private Uri mDataUri;
7186
7187 /**
7188 * Constructor
7189 * @param text A {@link CharSequence} to be displayed as the message content
7190 * @param timestamp Time at which the message arrived
7191 * @param sender A {@link CharSequence} to be used for displaying the name of the
7192 * sender. Should be <code>null</code> for messages by the current user, in which case
7193 * the platform will insert {@link MessagingStyle#getUserDisplayName()}.
7194 * Should be unique amongst all individuals in the conversation, and should be
7195 * consistent during re-posts of the notification.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007196 *
7197 * @deprecated use {@code Message(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04007198 */
7199 public Message(CharSequence text, long timestamp, CharSequence sender){
Selim Cinek9acd6732018-03-23 16:39:02 -07007200 this(text, timestamp, sender == null ? null
7201 : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08007202 }
7203
7204 /**
7205 * Constructor
7206 * @param text A {@link CharSequence} to be displayed as the message content
7207 * @param timestamp Time at which the message arrived
7208 * @param sender The {@link Person} who sent the message.
7209 * Should be <code>null</code> for messages by the current user, in which case
7210 * the platform will insert the user set in {@code MessagingStyle(Person)}.
7211 * <p>
Selim Cinek9acd6732018-03-23 16:39:02 -07007212 * The person provided should contain an Icon, set with
7213 * {@link Person.Builder#setIcon(Icon)} and also have a name provided
7214 * with {@link Person.Builder#setName(CharSequence)}. If multiple users have the same
7215 * name, consider providing a key with {@link Person.Builder#setKey(String)} in order
7216 * to differentiate between the different users.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007217 * </p>
7218 */
Selim Cinekeb53c222018-04-06 12:56:09 -07007219 public Message(@NonNull CharSequence text, long timestamp, @Nullable Person sender) {
Kenny Guya0f6de82018-04-06 16:20:16 +01007220 this(text, timestamp, sender, false /* remoteHistory */);
7221 }
7222
7223 /**
7224 * Constructor
7225 * @param text A {@link CharSequence} to be displayed as the message content
7226 * @param timestamp Time at which the message arrived
7227 * @param sender The {@link Person} who sent the message.
7228 * Should be <code>null</code> for messages by the current user, in which case
7229 * the platform will insert the user set in {@code MessagingStyle(Person)}.
7230 * @param remoteInputHistory True if the messages was generated from the extra
7231 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}.
7232 * <p>
7233 * The person provided should contain an Icon, set with
7234 * {@link Person.Builder#setIcon(Icon)} and also have a name provided
7235 * with {@link Person.Builder#setName(CharSequence)}. If multiple users have the same
7236 * name, consider providing a key with {@link Person.Builder#setKey(String)} in order
7237 * to differentiate between the different users.
7238 * </p>
7239 * @hide
7240 */
7241 public Message(@NonNull CharSequence text, long timestamp, @Nullable Person sender,
7242 boolean remoteInputHistory) {
Alex Hillsfc737de2016-03-23 17:33:02 -04007243 mText = text;
7244 mTimestamp = timestamp;
7245 mSender = sender;
Kenny Guya0f6de82018-04-06 16:20:16 +01007246 mRemoteInputHistory = remoteInputHistory;
Alex Hillsfc737de2016-03-23 17:33:02 -04007247 }
7248
7249 /**
7250 * Sets a binary blob of data and an associated MIME type for a message. In the case
7251 * where the platform doesn't support the MIME type, the original text provided in the
7252 * constructor will be used.
7253 * @param dataMimeType The MIME type of the content. See
7254 * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME
7255 * types on Android and Android Wear.
7256 * @param dataUri The uri containing the content whose type is given by the MIME type.
7257 * <p class="note">
7258 * <ol>
7259 * <li>Notification Listeners including the System UI need permission to access the
7260 * data the Uri points to. The recommended ways to do this are:</li>
7261 * <li>Store the data in your own ContentProvider, making sure that other apps have
7262 * the correct permission to access your provider. The preferred mechanism for
7263 * providing access is to use per-URI permissions which are temporary and only
7264 * grant access to the receiving application. An easy way to create a
7265 * ContentProvider like this is to use the FileProvider helper class.</li>
7266 * <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio
7267 * and image MIME types, however beginning with Android 3.0 (API level 11) it can
7268 * also store non-media types (see MediaStore.Files for more info). Files can be
7269 * inserted into the MediaStore using scanFile() after which a content:// style
7270 * Uri suitable for sharing is passed to the provided onScanCompleted() callback.
7271 * Note that once added to the system MediaStore the content is accessible to any
7272 * app on the device.</li>
7273 * </ol>
7274 * @return this object for method chaining
7275 */
7276 public Message setData(String dataMimeType, Uri dataUri) {
7277 mDataMimeType = dataMimeType;
7278 mDataUri = dataUri;
7279 return this;
7280 }
7281
Alex Hillsfc737de2016-03-23 17:33:02 -04007282 /**
7283 * Get the text to be used for this message, or the fallback text if a type and content
7284 * Uri have been set
7285 */
7286 public CharSequence getText() {
7287 return mText;
7288 }
7289
7290 /**
7291 * Get the time at which this message arrived
7292 */
7293 public long getTimestamp() {
7294 return mTimestamp;
7295 }
7296
7297 /**
Shane Brennan5a871862017-03-11 13:14:17 -08007298 * Get the extras Bundle for this message.
7299 */
7300 public Bundle getExtras() {
7301 return mExtras;
7302 }
7303
7304 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04007305 * Get the text used to display the contact's name in the messaging experience
Selim Cinekcb8b9852017-12-15 18:01:52 -08007306 *
7307 * @deprecated use {@link #getSenderPerson()}
Alex Hillsfc737de2016-03-23 17:33:02 -04007308 */
7309 public CharSequence getSender() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007310 return mSender == null ? null : mSender.getName();
7311 }
7312
7313 /**
7314 * Get the sender associated with this message.
7315 */
7316 @Nullable
7317 public Person getSenderPerson() {
Alex Hillsfc737de2016-03-23 17:33:02 -04007318 return mSender;
7319 }
7320
7321 /**
7322 * Get the MIME type of the data pointed to by the Uri
7323 */
7324 public String getDataMimeType() {
7325 return mDataMimeType;
7326 }
7327
7328 /**
7329 * Get the the Uri pointing to the content of the message. Can be null, in which case
7330 * {@see #getText()} is used.
7331 */
7332 public Uri getDataUri() {
7333 return mDataUri;
7334 }
7335
Kenny Guya0f6de82018-04-06 16:20:16 +01007336 /**
7337 * @return True if the message was generated from
7338 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}.
7339 * @hide
7340 */
7341 public boolean isRemoteInputHistory() {
7342 return mRemoteInputHistory;
7343 }
7344
Alex Hillsd9b04d92016-04-11 16:38:16 -04007345 private Bundle toBundle() {
7346 Bundle bundle = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04007347 if (mText != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007348 bundle.putCharSequence(KEY_TEXT, mText);
Alex Hillsfc737de2016-03-23 17:33:02 -04007349 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007350 bundle.putLong(KEY_TIMESTAMP, mTimestamp);
Alex Hillsfc737de2016-03-23 17:33:02 -04007351 if (mSender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007352 // Legacy listeners need this
7353 bundle.putCharSequence(KEY_SENDER, mSender.getName());
7354 bundle.putParcelable(KEY_SENDER_PERSON, mSender);
Alex Hillsfc737de2016-03-23 17:33:02 -04007355 }
7356 if (mDataMimeType != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007357 bundle.putString(KEY_DATA_MIME_TYPE, mDataMimeType);
Alex Hillsfc737de2016-03-23 17:33:02 -04007358 }
7359 if (mDataUri != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007360 bundle.putParcelable(KEY_DATA_URI, mDataUri);
Alex Hillsfc737de2016-03-23 17:33:02 -04007361 }
Shane Brennan5a871862017-03-11 13:14:17 -08007362 if (mExtras != null) {
7363 bundle.putBundle(KEY_EXTRAS_BUNDLE, mExtras);
7364 }
Kenny Guya0f6de82018-04-06 16:20:16 +01007365 if (mRemoteInputHistory) {
7366 bundle.putBoolean(KEY_REMOTE_INPUT_HISTORY, mRemoteInputHistory);
7367 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007368 return bundle;
Alex Hillsfc737de2016-03-23 17:33:02 -04007369 }
7370
Alex Hillsd9b04d92016-04-11 16:38:16 -04007371 static Bundle[] getBundleArrayForMessages(List<Message> messages) {
7372 Bundle[] bundles = new Bundle[messages.size()];
7373 final int N = messages.size();
7374 for (int i = 0; i < N; i++) {
7375 bundles[i] = messages.get(i).toBundle();
7376 }
7377 return bundles;
7378 }
7379
Selim Cinek88188f22017-09-19 16:46:56 -07007380 /**
7381 * @return A list of messages read from the bundles.
7382 *
7383 * @hide
7384 */
7385 public static List<Message> getMessagesFromBundleArray(Parcelable[] bundles) {
7386 if (bundles == null) {
7387 return new ArrayList<>();
7388 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007389 List<Message> messages = new ArrayList<>(bundles.length);
7390 for (int i = 0; i < bundles.length; i++) {
Adrian Roosdedd1df2016-04-26 16:38:47 -07007391 if (bundles[i] instanceof Bundle) {
7392 Message message = getMessageFromBundle((Bundle)bundles[i]);
7393 if (message != null) {
7394 messages.add(message);
7395 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007396 }
7397 }
7398 return messages;
7399 }
7400
Selim Cinekb0dc61b2018-05-22 18:49:36 -07007401 /**
7402 * @return The message that is stored in the bundle or null if the message couldn't be
7403 * resolved.
7404 *
7405 * @hide
7406 */
7407 @Nullable
7408 public static Message getMessageFromBundle(Bundle bundle) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007409 try {
Adrian Roosfbddd2c2016-05-13 12:57:20 -07007410 if (!bundle.containsKey(KEY_TEXT) || !bundle.containsKey(KEY_TIMESTAMP)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007411 return null;
7412 } else {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007413
7414 Person senderPerson = bundle.getParcelable(KEY_SENDER_PERSON);
7415 if (senderPerson == null) {
7416 // Legacy apps that use compat don't actually provide the sender objects
7417 // We need to fix the compat version to provide people / use
7418 // the native api instead
7419 CharSequence senderName = bundle.getCharSequence(KEY_SENDER);
7420 if (senderName != null) {
Selim Cinek9acd6732018-03-23 16:39:02 -07007421 senderPerson = new Person.Builder().setName(senderName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08007422 }
7423 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007424 Message message = new Message(bundle.getCharSequence(KEY_TEXT),
Selim Cinekcb8b9852017-12-15 18:01:52 -08007425 bundle.getLong(KEY_TIMESTAMP),
Kenny Guya0f6de82018-04-06 16:20:16 +01007426 senderPerson,
7427 bundle.getBoolean(KEY_REMOTE_INPUT_HISTORY, false));
Alex Hillsd9b04d92016-04-11 16:38:16 -04007428 if (bundle.containsKey(KEY_DATA_MIME_TYPE) &&
7429 bundle.containsKey(KEY_DATA_URI)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007430 message.setData(bundle.getString(KEY_DATA_MIME_TYPE),
7431 (Uri) bundle.getParcelable(KEY_DATA_URI));
Alex Hillsfc737de2016-03-23 17:33:02 -04007432 }
Shane Brennan5a871862017-03-11 13:14:17 -08007433 if (bundle.containsKey(KEY_EXTRAS_BUNDLE)) {
7434 message.getExtras().putAll(bundle.getBundle(KEY_EXTRAS_BUNDLE));
7435 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007436 return message;
7437 }
7438 } catch (ClassCastException e) {
7439 return null;
7440 }
7441 }
Alex Hillsfc737de2016-03-23 17:33:02 -04007442 }
7443 }
7444
7445 /**
Daniel Sandler879c5e02012-04-17 16:46:51 -04007446 * Helper class for generating large-format notifications that include a list of (up to 5) strings.
Joe Malin8d40d042012-11-05 11:36:40 -08007447 *
Robert Ly91c5ce32014-06-08 15:37:00 -07007448 * Here's how you'd set the <code>InboxStyle</code> on a notification:
Daniel Sandler879c5e02012-04-17 16:46:51 -04007449 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07007450 * Notification notif = new Notification.Builder(mContext)
7451 * .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
7452 * .setContentText(subject)
7453 * .setSmallIcon(R.drawable.new_mail)
7454 * .setLargeIcon(aBitmap)
7455 * .setStyle(new Notification.InboxStyle()
7456 * .addLine(str1)
7457 * .addLine(str2)
7458 * .setContentTitle(&quot;&quot;)
7459 * .setSummaryText(&quot;+3 more&quot;))
7460 * .build();
Daniel Sandler879c5e02012-04-17 16:46:51 -04007461 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08007462 *
Daniel Sandler879c5e02012-04-17 16:46:51 -04007463 * @see Notification#bigContentView
7464 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007465 public static class InboxStyle extends Style {
Selim Cinekbee4e072018-05-21 22:06:43 -07007466
7467 /**
7468 * The number of lines of remote input history allowed until we start reducing lines.
7469 */
7470 private static final int NUMBER_OF_HISTORY_ALLOWED_UNTIL_REDUCTION = 1;
Daniel Sandler879c5e02012-04-17 16:46:51 -04007471 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
7472
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007473 public InboxStyle() {
7474 }
7475
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007476 /**
7477 * @deprecated use {@code InboxStyle()}.
7478 */
7479 @Deprecated
Daniel Sandler879c5e02012-04-17 16:46:51 -04007480 public InboxStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007481 setBuilder(builder);
Daniel Sandler879c5e02012-04-17 16:46:51 -04007482 }
7483
Chris Wrend6297db2012-05-03 16:20:13 -04007484 /**
7485 * Overrides ContentTitle in the big form of the template.
7486 * This defaults to the value passed to setContentTitle().
7487 */
7488 public InboxStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007489 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04007490 return this;
7491 }
7492
7493 /**
7494 * Set the first line of text after the detail section in the big form of the template.
7495 */
7496 public InboxStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007497 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04007498 return this;
7499 }
7500
Chris Wren0bd664d2012-08-01 13:56:56 -04007501 /**
7502 * Append a line to the digest section of the Inbox notification.
7503 */
Daniel Sandler879c5e02012-04-17 16:46:51 -04007504 public InboxStyle addLine(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007505 mTexts.add(safeCharSequence(cs));
Daniel Sandler879c5e02012-04-17 16:46:51 -04007506 return this;
7507 }
7508
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007509 /**
7510 * @hide
7511 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05007512 public ArrayList<CharSequence> getLines() {
7513 return mTexts;
7514 }
7515
7516 /**
7517 * @hide
7518 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007519 public void addExtras(Bundle extras) {
7520 super.addExtras(extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007521
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007522 CharSequence[] a = new CharSequence[mTexts.size()];
7523 extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
7524 }
7525
Christoph Studer4600f9b2014-07-22 22:44:43 +02007526 /**
7527 * @hide
7528 */
7529 @Override
7530 protected void restoreFromExtras(Bundle extras) {
7531 super.restoreFromExtras(extras);
7532
7533 mTexts.clear();
7534 if (extras.containsKey(EXTRA_TEXT_LINES)) {
7535 Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES));
7536 }
7537 }
7538
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007539 /**
7540 * @hide
7541 */
7542 public RemoteViews makeBigContentView() {
Selim Cinekc848c3a2016-01-13 15:27:30 -08007543 // Remove the content text so it disappears unless you have a summary
Christoph Studer4600f9b2014-07-22 22:44:43 +02007544 // Nasty
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007545 CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT);
7546 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007547
Selim Cinek384804b2018-04-18 14:31:07 +08007548 TemplateBindResult result = new TemplateBindResult();
7549 RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource(), result);
Daniel Sandler619738c2012-06-07 16:33:08 -04007550
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007551 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007552
Chris Wrend6297db2012-05-03 16:20:13 -04007553 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 -04007554 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
Chris Wrend6297db2012-05-03 16:20:13 -04007555
Chris Wren4ed80d52012-05-17 09:30:03 -04007556 // Make sure all rows are gone in case we reuse a view.
7557 for (int rowId : rowIds) {
7558 contentView.setViewVisibility(rowId, View.GONE);
7559 }
7560
Daniel Sandler879c5e02012-04-17 16:46:51 -04007561 int i=0;
Selim Cinek07c80172016-04-21 16:40:47 -07007562 int topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7563 R.dimen.notification_inbox_item_top_padding);
Selim Cinek247fa012016-02-18 09:50:48 -08007564 boolean first = true;
Selim Cinek07c80172016-04-21 16:40:47 -07007565 int onlyViewId = 0;
7566 int maxRows = rowIds.length;
7567 if (mBuilder.mActions.size() > 0) {
7568 maxRows--;
7569 }
Selim Cinekbee4e072018-05-21 22:06:43 -07007570 CharSequence[] remoteInputHistory = mBuilder.mN.extras.getCharSequenceArray(
7571 EXTRA_REMOTE_INPUT_HISTORY);
7572 if (remoteInputHistory != null
7573 && remoteInputHistory.length > NUMBER_OF_HISTORY_ALLOWED_UNTIL_REDUCTION) {
7574 // Let's remove some messages to make room for the remote input history.
7575 // 1 is always able to fit, but let's remove them if they are 2 or 3
7576 int numRemoteInputs = Math.min(remoteInputHistory.length,
7577 MAX_REMOTE_INPUT_HISTORY_LINES);
7578 int totalNumRows = mTexts.size() + numRemoteInputs
7579 - NUMBER_OF_HISTORY_ALLOWED_UNTIL_REDUCTION;
7580 if (totalNumRows > maxRows) {
7581 int overflow = totalNumRows - maxRows;
7582 if (mTexts.size() > maxRows) {
7583 // Heuristic: if the Texts don't fit anyway, we'll rather drop the last
7584 // few messages, even with the remote input
7585 maxRows -= overflow;
7586 } else {
7587 // otherwise we drop the first messages
7588 i = overflow;
7589 }
7590 }
7591 }
Selim Cinek07c80172016-04-21 16:40:47 -07007592 while (i < mTexts.size() && i < maxRows) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007593 CharSequence str = mTexts.get(i);
Selim Cinek07c80172016-04-21 16:40:47 -07007594 if (!TextUtils.isEmpty(str)) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007595 contentView.setViewVisibility(rowIds[i], View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07007596 contentView.setTextViewText(rowIds[i],
7597 mBuilder.processTextSpans(mBuilder.processLegacyText(str)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08007598 mBuilder.setTextViewColorSecondary(contentView, rowIds[i]);
Selim Cinek07c80172016-04-21 16:40:47 -07007599 contentView.setViewPadding(rowIds[i], 0, topPadding, 0, 0);
Selim Cinek384804b2018-04-18 14:31:07 +08007600 handleInboxImageMargin(contentView, rowIds[i], first,
Selim Cinek1c72fa02018-04-23 18:00:54 +08007601 result.getIconMarginEnd());
Selim Cinek07c80172016-04-21 16:40:47 -07007602 if (first) {
7603 onlyViewId = rowIds[i];
7604 } else {
7605 onlyViewId = 0;
7606 }
Selim Cinek247fa012016-02-18 09:50:48 -08007607 first = false;
Daniel Sandler879c5e02012-04-17 16:46:51 -04007608 }
7609 i++;
7610 }
Selim Cinek07c80172016-04-21 16:40:47 -07007611 if (onlyViewId != 0) {
7612 // We only have 1 entry, lets make it look like the normal Text of a Bigtext
7613 topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7614 R.dimen.notification_text_margin_top);
7615 contentView.setViewPadding(onlyViewId, 0, topPadding, 0, 0);
7616 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007617
Daniel Sandler879c5e02012-04-17 16:46:51 -04007618 return contentView;
7619 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007620
Julia Reynolds7217dc92018-03-07 12:12:09 -05007621 /**
7622 * @hide
7623 */
7624 @Override
7625 public boolean areNotificationsVisiblyDifferent(Style other) {
7626 if (other == null || getClass() != other.getClass()) {
7627 return true;
7628 }
7629 InboxStyle newS = (InboxStyle) other;
Dan Sandler7d67bd42018-05-15 14:06:38 -04007630
7631 final ArrayList<CharSequence> myLines = getLines();
7632 final ArrayList<CharSequence> newLines = newS.getLines();
7633 final int n = myLines.size();
7634 if (n != newLines.size()) {
7635 return true;
7636 }
7637
7638 for (int i = 0; i < n; i++) {
7639 if (!Objects.equals(
7640 String.valueOf(myLines.get(i)),
7641 String.valueOf(newLines.get(i)))) {
7642 return true;
7643 }
7644 }
7645 return false;
Julia Reynolds7217dc92018-03-07 12:12:09 -05007646 }
7647
Selim Cinek384804b2018-04-18 14:31:07 +08007648 private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first,
Selim Cinek1c72fa02018-04-23 18:00:54 +08007649 int marginEndValue) {
Selim Cinek1e0bf612015-11-20 15:57:26 -08007650 int endMargin = 0;
Selim Cinek247fa012016-02-18 09:50:48 -08007651 if (first) {
7652 final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0);
7653 final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
7654 boolean hasProgress = max != 0 || ind;
Selim Cinek384804b2018-04-18 14:31:07 +08007655 if (!hasProgress) {
Selim Cinek1c72fa02018-04-23 18:00:54 +08007656 endMargin = marginEndValue;
Selim Cinek247fa012016-02-18 09:50:48 -08007657 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007658 }
Selim Cinek1c72fa02018-04-23 18:00:54 +08007659 contentView.setViewLayoutMarginEnd(id, endMargin);
Selim Cinek1e0bf612015-11-20 15:57:26 -08007660 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04007661 }
Dan Sandler842dd772014-05-15 09:36:47 -04007662
7663 /**
7664 * Notification style for media playback notifications.
7665 *
7666 * In the expanded form, {@link Notification#bigContentView}, up to 5
7667 * {@link Notification.Action}s specified with
Dan Sandler86647982015-05-13 23:41:13 -04007668 * {@link Notification.Builder#addAction(Action) addAction} will be
Dan Sandler842dd772014-05-15 09:36:47 -04007669 * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
7670 * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be
7671 * treated as album artwork.
Selim Cinek99104832017-01-25 14:47:33 -08007672 * <p>
Dan Sandler842dd772014-05-15 09:36:47 -04007673 * Unlike the other styles provided here, MediaStyle can also modify the standard-size
7674 * {@link Notification#contentView}; by providing action indices to
Christoph Studerfde6f4d2014-12-12 13:23:26 +01007675 * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed
Dan Sandler842dd772014-05-15 09:36:47 -04007676 * in the standard view alongside the usual content.
Selim Cinek99104832017-01-25 14:47:33 -08007677 * <p>
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007678 * Notifications created with MediaStyle will have their category set to
7679 * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different
7680 * category using {@link Notification.Builder#setCategory(String) setCategory()}.
Selim Cinek99104832017-01-25 14:47:33 -08007681 * <p>
Jeff Browndba34ba2014-06-24 20:46:03 -07007682 * Finally, if you attach a {@link android.media.session.MediaSession.Token} using
7683 * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)},
Dan Sandler842dd772014-05-15 09:36:47 -04007684 * the System UI can identify this as a notification representing an active media session
7685 * and respond accordingly (by showing album artwork in the lockscreen, for example).
7686 *
Selim Cinek99104832017-01-25 14:47:33 -08007687 * <p>
7688 * Starting at {@link android.os.Build.VERSION_CODES#O Android O} any notification that has a
7689 * media session attached with {@link #setMediaSession(MediaSession.Token)} will be colorized.
7690 * You can opt-out of this behavior by using {@link Notification.Builder#setColorized(boolean)}.
7691 * <p>
7692 *
Dan Sandler842dd772014-05-15 09:36:47 -04007693 * To use this style with your Notification, feed it to
7694 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7695 * <pre class="prettyprint">
7696 * Notification noti = new Notification.Builder()
7697 * .setSmallIcon(R.drawable.ic_stat_player)
Christoph Studere935fe92014-11-24 14:18:06 +01007698 * .setContentTitle(&quot;Track title&quot;)
7699 * .setContentText(&quot;Artist - Album&quot;)
7700 * .setLargeIcon(albumArtBitmap))
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007701 * .setStyle(<b>new Notification.MediaStyle()</b>
7702 * .setMediaSession(mySession))
Dan Sandler842dd772014-05-15 09:36:47 -04007703 * .build();
7704 * </pre>
7705 *
7706 * @see Notification#bigContentView
Selim Cinek99104832017-01-25 14:47:33 -08007707 * @see Notification.Builder#setColorized(boolean)
Dan Sandler842dd772014-05-15 09:36:47 -04007708 */
7709 public static class MediaStyle extends Style {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007710 static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3;
Dan Sandler842dd772014-05-15 09:36:47 -04007711 static final int MAX_MEDIA_BUTTONS = 5;
7712
7713 private int[] mActionsToShowInCompact = null;
Jeff Browndba34ba2014-06-24 20:46:03 -07007714 private MediaSession.Token mToken;
Dan Sandler842dd772014-05-15 09:36:47 -04007715
7716 public MediaStyle() {
7717 }
7718
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007719 /**
7720 * @deprecated use {@code MediaStyle()}.
7721 */
7722 @Deprecated
Dan Sandler842dd772014-05-15 09:36:47 -04007723 public MediaStyle(Builder builder) {
7724 setBuilder(builder);
7725 }
7726
7727 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007728 * 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 -04007729 * notification view.
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007730 *
7731 * @param actions the indices of the actions to show in the compact notification view
Dan Sandler842dd772014-05-15 09:36:47 -04007732 */
7733 public MediaStyle setShowActionsInCompactView(int...actions) {
7734 mActionsToShowInCompact = actions;
7735 return this;
7736 }
7737
7738 /**
Jeff Browndba34ba2014-06-24 20:46:03 -07007739 * Attach a {@link android.media.session.MediaSession.Token} to this Notification
7740 * to provide additional playback information and control to the SystemUI.
Dan Sandler842dd772014-05-15 09:36:47 -04007741 */
Jeff Browndba34ba2014-06-24 20:46:03 -07007742 public MediaStyle setMediaSession(MediaSession.Token token) {
Dan Sandler842dd772014-05-15 09:36:47 -04007743 mToken = token;
7744 return this;
7745 }
7746
Christoph Studer4600f9b2014-07-22 22:44:43 +02007747 /**
7748 * @hide
7749 */
Dan Sandler842dd772014-05-15 09:36:47 -04007750 @Override
7751 public Notification buildStyled(Notification wip) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02007752 super.buildStyled(wip);
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007753 if (wip.category == null) {
7754 wip.category = Notification.CATEGORY_TRANSPORT;
7755 }
Dan Sandler842dd772014-05-15 09:36:47 -04007756 return wip;
7757 }
7758
Christoph Studer4600f9b2014-07-22 22:44:43 +02007759 /**
7760 * @hide
7761 */
7762 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007763 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007764 return makeMediaContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007765 }
7766
7767 /**
7768 * @hide
7769 */
7770 @Override
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007771 public RemoteViews makeBigContentView() {
7772 return makeMediaBigContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007773 }
7774
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007775 /**
7776 * @hide
7777 */
7778 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007779 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007780 RemoteViews expanded = makeMediaBigContentView();
7781 return expanded != null ? expanded : makeMediaContentView();
7782 }
7783
Dan Sandler842dd772014-05-15 09:36:47 -04007784 /** @hide */
7785 @Override
7786 public void addExtras(Bundle extras) {
7787 super.addExtras(extras);
7788
7789 if (mToken != null) {
7790 extras.putParcelable(EXTRA_MEDIA_SESSION, mToken);
7791 }
Bryan Mawhinneye191f902014-07-22 12:50:09 +01007792 if (mActionsToShowInCompact != null) {
7793 extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact);
7794 }
Dan Sandler842dd772014-05-15 09:36:47 -04007795 }
7796
Christoph Studer4600f9b2014-07-22 22:44:43 +02007797 /**
7798 * @hide
7799 */
7800 @Override
7801 protected void restoreFromExtras(Bundle extras) {
7802 super.restoreFromExtras(extras);
7803
7804 if (extras.containsKey(EXTRA_MEDIA_SESSION)) {
7805 mToken = extras.getParcelable(EXTRA_MEDIA_SESSION);
7806 }
7807 if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) {
7808 mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS);
7809 }
7810 }
7811
Julia Reynolds7217dc92018-03-07 12:12:09 -05007812 /**
7813 * @hide
7814 */
7815 @Override
7816 public boolean areNotificationsVisiblyDifferent(Style other) {
7817 if (other == null || getClass() != other.getClass()) {
7818 return true;
7819 }
7820 // All fields to compare are on the Notification object
7821 return false;
7822 }
7823
Selim Cinek5bf069a2015-11-10 19:14:27 -05007824 private RemoteViews generateMediaActionButton(Action action, int color) {
Dan Sandler842dd772014-05-15 09:36:47 -04007825 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07007826 RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(),
Alan Viverette3cb07a462014-06-06 14:19:53 -07007827 R.layout.notification_material_media_action);
Dan Sandler68079d52015-07-22 10:45:30 -04007828 button.setImageViewIcon(R.id.action0, action.getIcon());
Anthony Chenad4d1582017-04-10 16:07:58 -07007829
7830 // If the action buttons should not be tinted, then just use the default
7831 // notification color. Otherwise, just use the passed-in color.
7832 int tintColor = mBuilder.shouldTintActionButtons() || mBuilder.isColorized()
7833 ? color
7834 : NotificationColorUtil.resolveColor(mBuilder.mContext,
7835 Notification.COLOR_DEFAULT);
7836
Sunny Goyal5b153922017-09-21 21:00:36 -07007837 button.setDrawableTint(R.id.action0, false, tintColor,
7838 PorterDuff.Mode.SRC_ATOP);
Dan Sandler842dd772014-05-15 09:36:47 -04007839 if (!tombstone) {
7840 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
7841 }
7842 button.setContentDescription(R.id.action0, action.title);
7843 return button;
7844 }
7845
7846 private RemoteViews makeMediaContentView() {
7847 RemoteViews view = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007848 R.layout.notification_template_material_media, false, /* hasProgress */
7849 null /* result */);
Dan Sandler842dd772014-05-15 09:36:47 -04007850
7851 final int numActions = mBuilder.mActions.size();
7852 final int N = mActionsToShowInCompact == null
7853 ? 0
7854 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
7855 if (N > 0) {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007856 view.removeAllViews(com.android.internal.R.id.media_actions);
Dan Sandler842dd772014-05-15 09:36:47 -04007857 for (int i = 0; i < N; i++) {
7858 if (i >= numActions) {
7859 throw new IllegalArgumentException(String.format(
7860 "setShowActionsInCompactView: action %d out of bounds (max %d)",
7861 i, numActions - 1));
7862 }
7863
7864 final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]);
Selim Cinekc7f5a822018-03-20 19:32:06 -07007865 final RemoteViews button = generateMediaActionButton(action, getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007866 view.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007867 }
7868 }
Selim Cinekfdc738f2016-01-27 20:04:27 -08007869 handleImage(view);
7870 // handle the content margin
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007871 int endMargin = R.dimen.notification_content_margin_end;
Selim Cinek279fa862016-06-14 10:57:25 -07007872 if (mBuilder.mN.hasLargeIcon()) {
Selim Cinek384804b2018-04-18 14:31:07 +08007873 endMargin = R.dimen.notification_media_image_margin_end;
Selim Cinekfdc738f2016-01-27 20:04:27 -08007874 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007875 view.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
Dan Sandler842dd772014-05-15 09:36:47 -04007876 return view;
7877 }
7878
Selim Cinekc7f5a822018-03-20 19:32:06 -07007879 private int getActionColor() {
7880 return mBuilder.isColorized() ? mBuilder.getPrimaryTextColor()
7881 : mBuilder.resolveContrastColor();
Selim Cinek99104832017-01-25 14:47:33 -08007882 }
7883
Dan Sandler842dd772014-05-15 09:36:47 -04007884 private RemoteViews makeMediaBigContentView() {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007885 final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007886 // Dont add an expanded view if there is no more content to be revealed
7887 int actionsInCompact = mActionsToShowInCompact == null
7888 ? 0
7889 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
Selim Cinek279fa862016-06-14 10:57:25 -07007890 if (!mBuilder.mN.hasLargeIcon() && actionCount <= actionsInCompact) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007891 return null;
7892 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007893 RemoteViews big = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007894 R.layout.notification_template_material_big_media, false, null /* result */);
Dan Sandler842dd772014-05-15 09:36:47 -04007895
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007896 if (actionCount > 0) {
7897 big.removeAllViews(com.android.internal.R.id.media_actions);
7898 for (int i = 0; i < actionCount; i++) {
Selim Cinek5bf069a2015-11-10 19:14:27 -05007899 final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i),
Selim Cinekc7f5a822018-03-20 19:32:06 -07007900 getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007901 big.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007902 }
7903 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007904 handleImage(big);
Dan Sandler842dd772014-05-15 09:36:47 -04007905 return big;
7906 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007907
Selim Cinek5bf069a2015-11-10 19:14:27 -05007908 private void handleImage(RemoteViews contentView) {
Selim Cinek279fa862016-06-14 10:57:25 -07007909 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007910 contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
7911 contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007912 }
7913 }
7914
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007915 /**
7916 * @hide
7917 */
7918 @Override
7919 protected boolean hasProgress() {
7920 return false;
7921 }
Dan Sandler842dd772014-05-15 09:36:47 -04007922 }
Griff Hazen61a9e862014-05-22 16:05:19 -07007923
Selim Cinek593610c2016-02-16 18:42:57 -08007924 /**
7925 * Notification style for custom views that are decorated by the system
7926 *
7927 * <p>Instead of providing a notification that is completely custom, a developer can set this
7928 * style and still obtain system decorations like the notification header with the expand
7929 * affordance and actions.
7930 *
7931 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7932 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7933 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7934 * corresponding custom views to display.
7935 *
7936 * To use this style with your Notification, feed it to
7937 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7938 * <pre class="prettyprint">
7939 * Notification noti = new Notification.Builder()
7940 * .setSmallIcon(R.drawable.ic_stat_player)
7941 * .setLargeIcon(albumArtBitmap))
7942 * .setCustomContentView(contentView);
7943 * .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>)
7944 * .build();
7945 * </pre>
7946 */
7947 public static class DecoratedCustomViewStyle extends Style {
7948
7949 public DecoratedCustomViewStyle() {
7950 }
7951
Selim Cinek593610c2016-02-16 18:42:57 -08007952 /**
7953 * @hide
7954 */
7955 public boolean displayCustomViewInline() {
7956 return true;
7957 }
7958
7959 /**
7960 * @hide
7961 */
7962 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007963 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007964 return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView);
7965 }
7966
7967 /**
7968 * @hide
7969 */
7970 @Override
7971 public RemoteViews makeBigContentView() {
7972 return makeDecoratedBigContentView();
7973 }
7974
7975 /**
7976 * @hide
7977 */
7978 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007979 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007980 return makeDecoratedHeadsUpContentView();
7981 }
7982
Selim Cinek593610c2016-02-16 18:42:57 -08007983 private RemoteViews makeDecoratedHeadsUpContentView() {
7984 RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null
7985 ? mBuilder.mN.contentView
7986 : mBuilder.mN.headsUpContentView;
7987 if (mBuilder.mActions.size() == 0) {
7988 return makeStandardTemplateWithCustomContent(headsUpContentView);
7989 }
Selim Cinek384804b2018-04-18 14:31:07 +08007990 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08007991 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
Selim Cinek384804b2018-04-18 14:31:07 +08007992 mBuilder.getBigBaseLayoutResource(), result);
7993 buildIntoRemoteViewContent(remoteViews, headsUpContentView, result);
Selim Cinek593610c2016-02-16 18:42:57 -08007994 return remoteViews;
7995 }
7996
Selim Cinek593610c2016-02-16 18:42:57 -08007997 private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) {
Selim Cinek384804b2018-04-18 14:31:07 +08007998 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08007999 RemoteViews remoteViews = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08008000 mBuilder.getBaseLayoutResource(), result);
8001 buildIntoRemoteViewContent(remoteViews, customContent, result);
Selim Cinek593610c2016-02-16 18:42:57 -08008002 return remoteViews;
8003 }
8004
Selim Cinek593610c2016-02-16 18:42:57 -08008005 private RemoteViews makeDecoratedBigContentView() {
8006 RemoteViews bigContentView = mBuilder.mN.bigContentView == null
8007 ? mBuilder.mN.contentView
8008 : mBuilder.mN.bigContentView;
8009 if (mBuilder.mActions.size() == 0) {
8010 return makeStandardTemplateWithCustomContent(bigContentView);
8011 }
Selim Cinek384804b2018-04-18 14:31:07 +08008012 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08008013 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
Selim Cinek384804b2018-04-18 14:31:07 +08008014 mBuilder.getBigBaseLayoutResource(), result);
8015 buildIntoRemoteViewContent(remoteViews, bigContentView, result);
Selim Cinek593610c2016-02-16 18:42:57 -08008016 return remoteViews;
8017 }
Selim Cinek247fa012016-02-18 09:50:48 -08008018
8019 private void buildIntoRemoteViewContent(RemoteViews remoteViews,
Selim Cinek384804b2018-04-18 14:31:07 +08008020 RemoteViews customContent, TemplateBindResult result) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08008021 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07008022 // Need to clone customContent before adding, because otherwise it can no longer be
8023 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08008024 customContent = customContent.clone();
Anthony Chen8f5f3582017-04-11 11:18:37 -07008025 remoteViews.removeAllViewsExceptId(R.id.notification_main_column, R.id.progress);
8026 remoteViews.addView(R.id.notification_main_column, customContent, 0 /* index */);
Selim Cinekfc8073c2017-08-16 17:50:20 -07008027 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08008028 }
Selim Cinek247fa012016-02-18 09:50:48 -08008029 // also update the end margin if there is an image
Selim Cinek384804b2018-04-18 14:31:07 +08008030 Resources resources = mBuilder.mContext.getResources();
8031 int endMargin = resources.getDimensionPixelSize(
Selim Cinek1c72fa02018-04-23 18:00:54 +08008032 R.dimen.notification_content_margin_end) + result.getIconMarginEnd();
Selim Cinek384804b2018-04-18 14:31:07 +08008033 remoteViews.setViewLayoutMarginEnd(R.id.notification_main_column, endMargin);
Selim Cinek247fa012016-02-18 09:50:48 -08008034 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05008035
8036 /**
8037 * @hide
8038 */
8039 @Override
8040 public boolean areNotificationsVisiblyDifferent(Style other) {
8041 if (other == null || getClass() != other.getClass()) {
8042 return true;
8043 }
8044 // Comparison done for all custom RemoteViews, independent of style
8045 return false;
8046 }
Selim Cinek593610c2016-02-16 18:42:57 -08008047 }
8048
Selim Cinek03eb3b72016-02-18 10:39:45 -08008049 /**
8050 * Notification style for media custom views that are decorated by the system
8051 *
8052 * <p>Instead of providing a media notification that is completely custom, a developer can set
8053 * this style and still obtain system decorations like the notification header with the expand
8054 * affordance and actions.
8055 *
8056 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
8057 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
8058 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
8059 * corresponding custom views to display.
Selim Cinek99104832017-01-25 14:47:33 -08008060 * <p>
8061 * Contrary to {@link MediaStyle} a developer has to opt-in to the colorizing of the
8062 * notification by using {@link Notification.Builder#setColorized(boolean)}.
8063 * <p>
Selim Cinek03eb3b72016-02-18 10:39:45 -08008064 * To use this style with your Notification, feed it to
8065 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
8066 * <pre class="prettyprint">
8067 * Notification noti = new Notification.Builder()
8068 * .setSmallIcon(R.drawable.ic_stat_player)
8069 * .setLargeIcon(albumArtBitmap))
8070 * .setCustomContentView(contentView);
8071 * .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b>
8072 * .setMediaSession(mySession))
8073 * .build();
8074 * </pre>
8075 *
8076 * @see android.app.Notification.DecoratedCustomViewStyle
8077 * @see android.app.Notification.MediaStyle
8078 */
8079 public static class DecoratedMediaCustomViewStyle extends MediaStyle {
8080
8081 public DecoratedMediaCustomViewStyle() {
8082 }
8083
Selim Cinek03eb3b72016-02-18 10:39:45 -08008084 /**
8085 * @hide
8086 */
8087 public boolean displayCustomViewInline() {
8088 return true;
8089 }
8090
8091 /**
8092 * @hide
8093 */
8094 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08008095 public RemoteViews makeContentView(boolean increasedHeight) {
8096 RemoteViews remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08008097 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
8098 mBuilder.mN.contentView);
8099 }
8100
8101 /**
8102 * @hide
8103 */
8104 @Override
8105 public RemoteViews makeBigContentView() {
8106 RemoteViews customRemoteView = mBuilder.mN.bigContentView != null
8107 ? mBuilder.mN.bigContentView
8108 : mBuilder.mN.contentView;
8109 return makeBigContentViewWithCustomContent(customRemoteView);
8110 }
8111
8112 private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) {
8113 RemoteViews remoteViews = super.makeBigContentView();
8114 if (remoteViews != null) {
8115 return buildIntoRemoteView(remoteViews, R.id.notification_main_column,
8116 customRemoteView);
8117 } else if (customRemoteView != mBuilder.mN.contentView){
Selim Cinek7d1009b2017-01-25 15:28:28 -08008118 remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08008119 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
8120 customRemoteView);
8121 } else {
8122 return null;
8123 }
8124 }
8125
8126 /**
8127 * @hide
8128 */
8129 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08008130 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek03eb3b72016-02-18 10:39:45 -08008131 RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null
8132 ? mBuilder.mN.headsUpContentView
8133 : mBuilder.mN.contentView;
8134 return makeBigContentViewWithCustomContent(customRemoteView);
8135 }
8136
Julia Reynolds7217dc92018-03-07 12:12:09 -05008137 /**
8138 * @hide
8139 */
8140 @Override
8141 public boolean areNotificationsVisiblyDifferent(Style other) {
8142 if (other == null || getClass() != other.getClass()) {
8143 return true;
8144 }
8145 // Comparison done for all custom RemoteViews, independent of style
8146 return false;
8147 }
8148
Selim Cinek03eb3b72016-02-18 10:39:45 -08008149 private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id,
8150 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08008151 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07008152 // Need to clone customContent before adding, because otherwise it can no longer be
8153 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08008154 customContent = customContent.clone();
Selim Cinek87c31532017-08-18 18:53:44 -07008155 customContent.overrideTextColors(mBuilder.getPrimaryTextColor());
Selim Cinekf91017e2016-03-14 12:25:09 -07008156 remoteViews.removeAllViews(id);
8157 remoteViews.addView(id, customContent);
Selim Cinekfc8073c2017-08-16 17:50:20 -07008158 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08008159 }
Selim Cinek03eb3b72016-02-18 10:39:45 -08008160 return remoteViews;
8161 }
8162 }
8163
Christoph Studer4600f9b2014-07-22 22:44:43 +02008164 // When adding a new Style subclass here, don't forget to update
8165 // Builder.getNotificationStyleClass.
8166
Griff Hazen61a9e862014-05-22 16:05:19 -07008167 /**
8168 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
8169 * metadata or change options on a notification builder.
8170 */
8171 public interface Extender {
8172 /**
8173 * Apply this extender to a notification builder.
8174 * @param builder the builder to be modified.
8175 * @return the build object for chaining.
8176 */
8177 public Builder extend(Builder builder);
8178 }
8179
8180 /**
8181 * Helper class to add wearable extensions to notifications.
8182 * <p class="note"> See
8183 * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications
8184 * for Android Wear</a> for more information on how to use this class.
8185 * <p>
8186 * To create a notification with wearable extensions:
8187 * <ol>
8188 * <li>Create a {@link android.app.Notification.Builder}, setting any desired
8189 * properties.
8190 * <li>Create a {@link android.app.Notification.WearableExtender}.
8191 * <li>Set wearable-specific properties using the
8192 * {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}.
8193 * <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a
8194 * notification.
8195 * <li>Post the notification to the notification system with the
8196 * {@code NotificationManager.notify(...)} methods.
8197 * </ol>
8198 *
8199 * <pre class="prettyprint">
8200 * Notification notif = new Notification.Builder(mContext)
8201 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
8202 * .setContentText(subject)
8203 * .setSmallIcon(R.drawable.new_mail)
8204 * .extend(new Notification.WearableExtender()
8205 * .setContentIcon(R.drawable.new_mail))
8206 * .build();
8207 * NotificationManager notificationManger =
8208 * (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
8209 * notificationManger.notify(0, notif);</pre>
8210 *
8211 * <p>Wearable extensions can be accessed on an existing notification by using the
8212 * {@code WearableExtender(Notification)} constructor,
8213 * and then using the {@code get} methods to access values.
8214 *
8215 * <pre class="prettyprint">
8216 * Notification.WearableExtender wearableExtender = new Notification.WearableExtender(
8217 * notification);
Griff Hazen14f57992014-05-26 09:07:14 -07008218 * List&lt;Notification&gt; pages = wearableExtender.getPages();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07008219 */
8220 public static final class WearableExtender implements Extender {
8221 /**
8222 * Sentinel value for an action index that is unset.
8223 */
8224 public static final int UNSET_ACTION_INDEX = -1;
8225
8226 /**
8227 * Size value for use with {@link #setCustomSizePreset} to show this notification with
8228 * default sizing.
8229 * <p>For custom display notifications created using {@link #setDisplayIntent},
Paul Soulosaa4f4bf2015-08-04 11:59:45 -07008230 * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based
Griff Hazen61a9e862014-05-22 16:05:19 -07008231 * on their content.
8232 */
8233 public static final int SIZE_DEFAULT = 0;
8234
8235 /**
8236 * Size value for use with {@link #setCustomSizePreset} to show this notification
8237 * with an extra small size.
8238 * <p>This value is only applicable for custom display notifications created using
8239 * {@link #setDisplayIntent}.
8240 */
8241 public static final int SIZE_XSMALL = 1;
8242
8243 /**
8244 * Size value for use with {@link #setCustomSizePreset} to show this notification
8245 * with a small size.
8246 * <p>This value is only applicable for custom display notifications created using
8247 * {@link #setDisplayIntent}.
8248 */
8249 public static final int SIZE_SMALL = 2;
8250
8251 /**
8252 * Size value for use with {@link #setCustomSizePreset} to show this notification
8253 * with a medium size.
8254 * <p>This value is only applicable for custom display notifications created using
8255 * {@link #setDisplayIntent}.
8256 */
8257 public static final int SIZE_MEDIUM = 3;
8258
8259 /**
8260 * Size value for use with {@link #setCustomSizePreset} to show this notification
8261 * with a large size.
8262 * <p>This value is only applicable for custom display notifications created using
8263 * {@link #setDisplayIntent}.
8264 */
8265 public static final int SIZE_LARGE = 4;
8266
Griff Hazend5f11f92014-05-27 15:40:09 -07008267 /**
8268 * Size value for use with {@link #setCustomSizePreset} to show this notification
8269 * full screen.
8270 * <p>This value is only applicable for custom display notifications created using
8271 * {@link #setDisplayIntent}.
8272 */
8273 public static final int SIZE_FULL_SCREEN = 5;
8274
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008275 /**
8276 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a
8277 * short amount of time when this notification is displayed on the screen. This
8278 * is the default value.
8279 */
8280 public static final int SCREEN_TIMEOUT_SHORT = 0;
8281
8282 /**
8283 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on
8284 * for a longer amount of time when this notification is displayed on the screen.
8285 */
8286 public static final int SCREEN_TIMEOUT_LONG = -1;
8287
Griff Hazen61a9e862014-05-22 16:05:19 -07008288 /** Notification extra which contains wearable extensions */
8289 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
8290
Pete Gastaf6781d2014-10-07 15:17:05 -04008291 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07008292 private static final String KEY_ACTIONS = "actions";
8293 private static final String KEY_FLAGS = "flags";
8294 private static final String KEY_DISPLAY_INTENT = "displayIntent";
8295 private static final String KEY_PAGES = "pages";
8296 private static final String KEY_BACKGROUND = "background";
8297 private static final String KEY_CONTENT_ICON = "contentIcon";
8298 private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity";
8299 private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex";
8300 private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset";
8301 private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight";
8302 private static final String KEY_GRAVITY = "gravity";
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008303 private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout";
Nadia Benbernou948627e2016-04-14 14:41:08 -04008304 private static final String KEY_DISMISSAL_ID = "dismissalId";
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008305 private static final String KEY_BRIDGE_TAG = "bridgeTag";
Griff Hazen61a9e862014-05-22 16:05:19 -07008306
8307 // Flags bitwise-ored to mFlags
8308 private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1;
8309 private static final int FLAG_HINT_HIDE_ICON = 1 << 1;
8310 private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2;
8311 private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008312 private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4;
Alex Hills4bcb06b2016-04-05 14:26:25 -04008313 private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5;
Alex Hills9ab3a232016-04-05 14:54:56 -04008314 private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6;
Griff Hazen61a9e862014-05-22 16:05:19 -07008315
8316 // Default value for flags integer
8317 private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE;
8318
8319 private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END;
8320 private static final int DEFAULT_GRAVITY = Gravity.BOTTOM;
8321
8322 private ArrayList<Action> mActions = new ArrayList<Action>();
8323 private int mFlags = DEFAULT_FLAGS;
8324 private PendingIntent mDisplayIntent;
8325 private ArrayList<Notification> mPages = new ArrayList<Notification>();
8326 private Bitmap mBackground;
8327 private int mContentIcon;
8328 private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY;
8329 private int mContentActionIndex = UNSET_ACTION_INDEX;
8330 private int mCustomSizePreset = SIZE_DEFAULT;
8331 private int mCustomContentHeight;
8332 private int mGravity = DEFAULT_GRAVITY;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008333 private int mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04008334 private String mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008335 private String mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07008336
8337 /**
8338 * Create a {@link android.app.Notification.WearableExtender} with default
8339 * options.
8340 */
8341 public WearableExtender() {
8342 }
8343
8344 public WearableExtender(Notification notif) {
8345 Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS);
8346 if (wearableBundle != null) {
8347 List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS);
8348 if (actions != null) {
8349 mActions.addAll(actions);
8350 }
8351
8352 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
8353 mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT);
8354
8355 Notification[] pages = getNotificationArrayFromBundle(
8356 wearableBundle, KEY_PAGES);
8357 if (pages != null) {
8358 Collections.addAll(mPages, pages);
8359 }
8360
8361 mBackground = wearableBundle.getParcelable(KEY_BACKGROUND);
8362 mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON);
8363 mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY,
8364 DEFAULT_CONTENT_ICON_GRAVITY);
8365 mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX,
8366 UNSET_ACTION_INDEX);
8367 mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET,
8368 SIZE_DEFAULT);
8369 mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT);
8370 mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY);
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008371 mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT);
Nadia Benbernou948627e2016-04-14 14:41:08 -04008372 mDismissalId = wearableBundle.getString(KEY_DISMISSAL_ID);
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008373 mBridgeTag = wearableBundle.getString(KEY_BRIDGE_TAG);
Griff Hazen61a9e862014-05-22 16:05:19 -07008374 }
8375 }
8376
8377 /**
8378 * Apply wearable extensions to a notification that is being built. This is typically
8379 * called by the {@link android.app.Notification.Builder#extend} method of
8380 * {@link android.app.Notification.Builder}.
8381 */
8382 @Override
8383 public Notification.Builder extend(Notification.Builder builder) {
8384 Bundle wearableBundle = new Bundle();
8385
8386 if (!mActions.isEmpty()) {
8387 wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions);
8388 }
8389 if (mFlags != DEFAULT_FLAGS) {
8390 wearableBundle.putInt(KEY_FLAGS, mFlags);
8391 }
8392 if (mDisplayIntent != null) {
8393 wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent);
8394 }
8395 if (!mPages.isEmpty()) {
8396 wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray(
8397 new Notification[mPages.size()]));
8398 }
8399 if (mBackground != null) {
8400 wearableBundle.putParcelable(KEY_BACKGROUND, mBackground);
8401 }
8402 if (mContentIcon != 0) {
8403 wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon);
8404 }
8405 if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) {
8406 wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity);
8407 }
8408 if (mContentActionIndex != UNSET_ACTION_INDEX) {
8409 wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX,
8410 mContentActionIndex);
8411 }
8412 if (mCustomSizePreset != SIZE_DEFAULT) {
8413 wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset);
8414 }
8415 if (mCustomContentHeight != 0) {
8416 wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight);
8417 }
8418 if (mGravity != DEFAULT_GRAVITY) {
8419 wearableBundle.putInt(KEY_GRAVITY, mGravity);
8420 }
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008421 if (mHintScreenTimeout != 0) {
8422 wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout);
8423 }
Nadia Benbernou948627e2016-04-14 14:41:08 -04008424 if (mDismissalId != null) {
8425 wearableBundle.putString(KEY_DISMISSAL_ID, mDismissalId);
8426 }
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008427 if (mBridgeTag != null) {
8428 wearableBundle.putString(KEY_BRIDGE_TAG, mBridgeTag);
8429 }
Griff Hazen61a9e862014-05-22 16:05:19 -07008430
8431 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
8432 return builder;
8433 }
8434
8435 @Override
8436 public WearableExtender clone() {
8437 WearableExtender that = new WearableExtender();
8438 that.mActions = new ArrayList<Action>(this.mActions);
8439 that.mFlags = this.mFlags;
8440 that.mDisplayIntent = this.mDisplayIntent;
8441 that.mPages = new ArrayList<Notification>(this.mPages);
8442 that.mBackground = this.mBackground;
8443 that.mContentIcon = this.mContentIcon;
8444 that.mContentIconGravity = this.mContentIconGravity;
8445 that.mContentActionIndex = this.mContentActionIndex;
8446 that.mCustomSizePreset = this.mCustomSizePreset;
8447 that.mCustomContentHeight = this.mCustomContentHeight;
8448 that.mGravity = this.mGravity;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008449 that.mHintScreenTimeout = this.mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04008450 that.mDismissalId = this.mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008451 that.mBridgeTag = this.mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07008452 return that;
8453 }
8454
8455 /**
8456 * Add a wearable action to this notification.
8457 *
8458 * <p>When wearable actions are added using this method, the set of actions that
8459 * show on a wearable device splits from devices that only show actions added
8460 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8461 * of which actions display on different devices.
8462 *
8463 * @param action the action to add to this notification
8464 * @return this object for method chaining
8465 * @see android.app.Notification.Action
8466 */
8467 public WearableExtender addAction(Action action) {
8468 mActions.add(action);
8469 return this;
8470 }
8471
8472 /**
8473 * Adds wearable actions to this notification.
8474 *
8475 * <p>When wearable actions are added using this method, the set of actions that
8476 * show on a wearable device splits from devices that only show actions added
8477 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8478 * of which actions display on different devices.
8479 *
8480 * @param actions the actions to add to this notification
8481 * @return this object for method chaining
8482 * @see android.app.Notification.Action
8483 */
8484 public WearableExtender addActions(List<Action> actions) {
8485 mActions.addAll(actions);
8486 return this;
8487 }
8488
8489 /**
8490 * Clear all wearable actions present on this builder.
8491 * @return this object for method chaining.
8492 * @see #addAction
8493 */
8494 public WearableExtender clearActions() {
8495 mActions.clear();
8496 return this;
8497 }
8498
8499 /**
8500 * Get the wearable actions present on this notification.
8501 */
8502 public List<Action> getActions() {
8503 return mActions;
8504 }
8505
8506 /**
8507 * Set an intent to launch inside of an activity view when displaying
Griff Hazen14f57992014-05-26 09:07:14 -07008508 * this notification. The {@link PendingIntent} provided should be for an activity.
8509 *
8510 * <pre class="prettyprint">
8511 * Intent displayIntent = new Intent(context, MyDisplayActivity.class);
8512 * PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
8513 * 0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
8514 * Notification notif = new Notification.Builder(context)
8515 * .extend(new Notification.WearableExtender()
8516 * .setDisplayIntent(displayPendingIntent)
8517 * .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM))
8518 * .build();</pre>
8519 *
8520 * <p>The activity to launch needs to allow embedding, must be exported, and
Griff Hazen831ca9d2014-06-17 00:38:38 -07008521 * should have an empty task affinity. It is also recommended to use the device
8522 * default light theme.
Griff Hazen14f57992014-05-26 09:07:14 -07008523 *
8524 * <p>Example AndroidManifest.xml entry:
8525 * <pre class="prettyprint">
8526 * &lt;activity android:name=&quot;com.example.MyDisplayActivity&quot;
8527 * android:exported=&quot;true&quot;
8528 * android:allowEmbedded=&quot;true&quot;
Griff Hazen831ca9d2014-06-17 00:38:38 -07008529 * android:taskAffinity=&quot;&quot;
8530 * android:theme=&quot;@android:style/Theme.DeviceDefault.Light&quot; /&gt;</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07008531 *
8532 * @param intent the {@link PendingIntent} for an activity
8533 * @return this object for method chaining
8534 * @see android.app.Notification.WearableExtender#getDisplayIntent
8535 */
8536 public WearableExtender setDisplayIntent(PendingIntent intent) {
8537 mDisplayIntent = intent;
8538 return this;
8539 }
8540
8541 /**
8542 * Get the intent to launch inside of an activity view when displaying this
8543 * notification. This {@code PendingIntent} should be for an activity.
8544 */
8545 public PendingIntent getDisplayIntent() {
8546 return mDisplayIntent;
8547 }
8548
8549 /**
8550 * Add an additional page of content to display with this notification. The current
8551 * notification forms the first page, and pages added using this function form
8552 * subsequent pages. This field can be used to separate a notification into multiple
8553 * sections.
8554 *
8555 * @param page the notification to add as another page
8556 * @return this object for method chaining
8557 * @see android.app.Notification.WearableExtender#getPages
8558 */
8559 public WearableExtender addPage(Notification page) {
8560 mPages.add(page);
8561 return this;
8562 }
8563
8564 /**
8565 * Add additional pages of content to display with this notification. The current
8566 * notification forms the first page, and pages added using this function form
8567 * subsequent pages. This field can be used to separate a notification into multiple
8568 * sections.
8569 *
8570 * @param pages a list of notifications
8571 * @return this object for method chaining
8572 * @see android.app.Notification.WearableExtender#getPages
8573 */
8574 public WearableExtender addPages(List<Notification> pages) {
8575 mPages.addAll(pages);
8576 return this;
8577 }
8578
8579 /**
8580 * Clear all additional pages present on this builder.
8581 * @return this object for method chaining.
8582 * @see #addPage
8583 */
8584 public WearableExtender clearPages() {
8585 mPages.clear();
8586 return this;
8587 }
8588
8589 /**
8590 * Get the array of additional pages of content for displaying this notification. The
8591 * current notification forms the first page, and elements within this array form
8592 * subsequent pages. This field can be used to separate a notification into multiple
8593 * sections.
8594 * @return the pages for this notification
8595 */
8596 public List<Notification> getPages() {
8597 return mPages;
8598 }
8599
8600 /**
8601 * Set a background image to be displayed behind the notification content.
8602 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8603 * will work with any notification style.
8604 *
8605 * @param background the background bitmap
8606 * @return this object for method chaining
8607 * @see android.app.Notification.WearableExtender#getBackground
8608 */
8609 public WearableExtender setBackground(Bitmap background) {
8610 mBackground = background;
8611 return this;
8612 }
8613
8614 /**
8615 * Get a background image to be displayed behind the notification content.
8616 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8617 * will work with any notification style.
8618 *
8619 * @return the background image
8620 * @see android.app.Notification.WearableExtender#setBackground
8621 */
8622 public Bitmap getBackground() {
8623 return mBackground;
8624 }
8625
8626 /**
8627 * Set an icon that goes with the content of this notification.
8628 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008629 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008630 public WearableExtender setContentIcon(int icon) {
8631 mContentIcon = icon;
8632 return this;
8633 }
8634
8635 /**
8636 * Get an icon that goes with the content of this notification.
8637 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008638 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008639 public int getContentIcon() {
8640 return mContentIcon;
8641 }
8642
8643 /**
8644 * Set the gravity that the content icon should have within the notification display.
8645 * Supported values include {@link android.view.Gravity#START} and
8646 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8647 * @see #setContentIcon
8648 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008649 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008650 public WearableExtender setContentIconGravity(int contentIconGravity) {
8651 mContentIconGravity = contentIconGravity;
8652 return this;
8653 }
8654
8655 /**
8656 * Get the gravity that the content icon should have within the notification display.
8657 * Supported values include {@link android.view.Gravity#START} and
8658 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8659 * @see #getContentIcon
8660 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008661 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008662 public int getContentIconGravity() {
8663 return mContentIconGravity;
8664 }
8665
8666 /**
8667 * Set an action from this notification's actions to be clickable with the content of
Griff Hazen14f57992014-05-26 09:07:14 -07008668 * this notification. This action will no longer display separately from the
8669 * notification's content.
8670 *
Griff Hazenca48d352014-05-28 22:37:13 -07008671 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008672 * set, although the list of available actions comes from the main notification and not
8673 * from the child page's notification.
8674 *
8675 * @param actionIndex The index of the action to hoist onto the current notification page.
8676 * If wearable actions were added to the main notification, this index
8677 * will apply to that list, otherwise it will apply to the regular
8678 * actions list.
Griff Hazen61a9e862014-05-22 16:05:19 -07008679 */
8680 public WearableExtender setContentAction(int actionIndex) {
8681 mContentActionIndex = actionIndex;
8682 return this;
8683 }
8684
8685 /**
Griff Hazenca48d352014-05-28 22:37:13 -07008686 * Get the index of the notification action, if any, that was specified as being clickable
8687 * with the content of this notification. This action will no longer display separately
Griff Hazen14f57992014-05-26 09:07:14 -07008688 * from the notification's content.
Griff Hazen61a9e862014-05-22 16:05:19 -07008689 *
Griff Hazenca48d352014-05-28 22:37:13 -07008690 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008691 * set, although the list of available actions comes from the main notification and not
8692 * from the child page's notification.
8693 *
8694 * <p>If wearable specific actions were added to the main notification, this index will
8695 * apply to that list, otherwise it will apply to the regular actions list.
Griff Hazenca48d352014-05-28 22:37:13 -07008696 *
8697 * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected.
Griff Hazen61a9e862014-05-22 16:05:19 -07008698 */
8699 public int getContentAction() {
8700 return mContentActionIndex;
8701 }
8702
8703 /**
8704 * Set the gravity that this notification should have within the available viewport space.
8705 * Supported values include {@link android.view.Gravity#TOP},
8706 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8707 * The default value is {@link android.view.Gravity#BOTTOM}.
8708 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008709 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008710 public WearableExtender setGravity(int gravity) {
8711 mGravity = gravity;
8712 return this;
8713 }
8714
8715 /**
8716 * Get the gravity that this notification should have within the available viewport space.
8717 * Supported values include {@link android.view.Gravity#TOP},
8718 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8719 * The default value is {@link android.view.Gravity#BOTTOM}.
8720 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008721 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008722 public int getGravity() {
8723 return mGravity;
8724 }
8725
8726 /**
8727 * Set the custom size preset for the display of this notification out of the available
8728 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8729 * {@link #SIZE_LARGE}.
8730 * <p>Some custom size presets are only applicable for custom display notifications created
8731 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the
8732 * documentation for the preset in question. See also
8733 * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}.
8734 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008735 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008736 public WearableExtender setCustomSizePreset(int sizePreset) {
8737 mCustomSizePreset = sizePreset;
8738 return this;
8739 }
8740
8741 /**
8742 * Get the custom size preset for the display of this notification out of the available
8743 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8744 * {@link #SIZE_LARGE}.
8745 * <p>Some custom size presets are only applicable for custom display notifications created
8746 * using {@link #setDisplayIntent}. Check the documentation for the preset in question.
8747 * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}.
8748 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008749 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008750 public int getCustomSizePreset() {
8751 return mCustomSizePreset;
8752 }
8753
8754 /**
8755 * Set the custom height in pixels for the display of this notification's content.
8756 * <p>This option is only available for custom display notifications created
8757 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also
8758 * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and
8759 * {@link #getCustomContentHeight}.
8760 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008761 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008762 public WearableExtender setCustomContentHeight(int height) {
8763 mCustomContentHeight = height;
8764 return this;
8765 }
8766
8767 /**
8768 * Get the custom height in pixels for the display of this notification's content.
8769 * <p>This option is only available for custom display notifications created
8770 * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and
8771 * {@link #setCustomContentHeight}.
8772 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008773 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008774 public int getCustomContentHeight() {
8775 return mCustomContentHeight;
8776 }
8777
8778 /**
8779 * Set whether the scrolling position for the contents of this notification should start
8780 * at the bottom of the contents instead of the top when the contents are too long to
8781 * display within the screen. Default is false (start scroll at the top).
8782 */
8783 public WearableExtender setStartScrollBottom(boolean startScrollBottom) {
8784 setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom);
8785 return this;
8786 }
8787
8788 /**
8789 * Get whether the scrolling position for the contents of this notification should start
8790 * at the bottom of the contents instead of the top when the contents are too long to
8791 * display within the screen. Default is false (start scroll at the top).
8792 */
8793 public boolean getStartScrollBottom() {
8794 return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0;
8795 }
8796
8797 /**
8798 * Set whether the content intent is available when the wearable device is not connected
8799 * to a companion device. The user can still trigger this intent when the wearable device
8800 * is offline, but a visual hint will indicate that the content intent may not be available.
8801 * Defaults to true.
8802 */
8803 public WearableExtender setContentIntentAvailableOffline(
8804 boolean contentIntentAvailableOffline) {
8805 setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline);
8806 return this;
8807 }
8808
8809 /**
8810 * Get whether the content intent is available when the wearable device is not connected
8811 * to a companion device. The user can still trigger this intent when the wearable device
8812 * is offline, but a visual hint will indicate that the content intent may not be available.
8813 * Defaults to true.
8814 */
8815 public boolean getContentIntentAvailableOffline() {
8816 return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0;
8817 }
8818
8819 /**
8820 * Set a hint that this notification's icon should not be displayed.
8821 * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise.
8822 * @return this object for method chaining
8823 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008824 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008825 public WearableExtender setHintHideIcon(boolean hintHideIcon) {
8826 setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon);
8827 return this;
8828 }
8829
8830 /**
8831 * Get a hint that this notification's icon should not be displayed.
8832 * @return {@code true} if this icon should not be displayed, false otherwise.
8833 * The default value is {@code false} if this was never set.
8834 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008835 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008836 public boolean getHintHideIcon() {
8837 return (mFlags & FLAG_HINT_HIDE_ICON) != 0;
8838 }
8839
8840 /**
8841 * Set a visual hint that only the background image of this notification should be
8842 * displayed, and other semantic content should be hidden. This hint is only applicable
8843 * to sub-pages added using {@link #addPage}.
8844 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008845 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008846 public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) {
8847 setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly);
8848 return this;
8849 }
8850
8851 /**
8852 * Get a visual hint that only the background image of this notification should be
8853 * displayed, and other semantic content should be hidden. This hint is only applicable
8854 * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}.
8855 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008856 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008857 public boolean getHintShowBackgroundOnly() {
8858 return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0;
8859 }
8860
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008861 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008862 * Set a hint that this notification's background should not be clipped if possible,
8863 * and should instead be resized to fully display on the screen, retaining the aspect
8864 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008865 * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
8866 * @return this object for method chaining
8867 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008868 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008869 public WearableExtender setHintAvoidBackgroundClipping(
8870 boolean hintAvoidBackgroundClipping) {
8871 setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping);
8872 return this;
8873 }
8874
8875 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008876 * Get a hint that this notification's background should not be clipped if possible,
8877 * and should instead be resized to fully display on the screen, retaining the aspect
8878 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008879 * @return {@code true} if it's ok if the background is clipped on the screen, false
8880 * otherwise. The default value is {@code false} if this was never set.
8881 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008882 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008883 public boolean getHintAvoidBackgroundClipping() {
8884 return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0;
8885 }
8886
8887 /**
8888 * Set a hint that the screen should remain on for at least this duration when
8889 * this notification is displayed on the screen.
8890 * @param timeout The requested screen timeout in milliseconds. Can also be either
8891 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8892 * @return this object for method chaining
8893 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008894 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008895 public WearableExtender setHintScreenTimeout(int timeout) {
8896 mHintScreenTimeout = timeout;
8897 return this;
8898 }
8899
8900 /**
8901 * Get the duration, in milliseconds, that the screen should remain on for
8902 * when this notification is displayed.
8903 * @return the duration in milliseconds if > 0, or either one of the sentinel values
8904 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8905 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008906 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008907 public int getHintScreenTimeout() {
8908 return mHintScreenTimeout;
8909 }
8910
Alex Hills9ab3a232016-04-05 14:54:56 -04008911 /**
Alex Hills4bcb06b2016-04-05 14:26:25 -04008912 * Set a hint that this notification's {@link BigPictureStyle} (if present) should be
8913 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8914 * qr codes, as well as other simple black-and-white tickets.
8915 * @param hintAmbientBigPicture {@code true} to enable converstion and ambient.
8916 * @return this object for method chaining
8917 */
8918 public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) {
8919 setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture);
8920 return this;
8921 }
8922
8923 /**
8924 * Get a hint that this notification's {@link BigPictureStyle} (if present) should be
8925 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8926 * qr codes, as well as other simple black-and-white tickets.
8927 * @return {@code true} if it should be displayed in ambient, false otherwise
8928 * otherwise. The default value is {@code false} if this was never set.
8929 */
8930 public boolean getHintAmbientBigPicture() {
8931 return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0;
8932 }
8933
8934 /**
Alex Hills9ab3a232016-04-05 14:54:56 -04008935 * Set a hint that this notification's content intent will launch an {@link Activity}
8936 * directly, telling the platform that it can generate the appropriate transitions.
8937 * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch
8938 * an activity and transitions should be generated, false otherwise.
8939 * @return this object for method chaining
8940 */
8941 public WearableExtender setHintContentIntentLaunchesActivity(
8942 boolean hintContentIntentLaunchesActivity) {
8943 setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity);
8944 return this;
8945 }
8946
8947 /**
8948 * Get a hint that this notification's content intent will launch an {@link Activity}
8949 * directly, telling the platform that it can generate the appropriate transitions
8950 * @return {@code true} if the content intent will launch an activity and transitions should
8951 * be generated, false otherwise. The default value is {@code false} if this was never set.
8952 */
8953 public boolean getHintContentIntentLaunchesActivity() {
8954 return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0;
8955 }
8956
Nadia Benbernou948627e2016-04-14 14:41:08 -04008957 /**
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008958 * Sets the dismissal id for this notification. If a notification is posted with a
8959 * dismissal id, then when that notification is canceled, notifications on other wearables
8960 * and the paired Android phone having that same dismissal id will also be canceled. See
Nadia Benbernou948627e2016-04-14 14:41:08 -04008961 * <a href="{@docRoot}wear/notifications/index.html">Adding Wearable Features to
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008962 * Notifications</a> for more information.
Nadia Benbernou948627e2016-04-14 14:41:08 -04008963 * @param dismissalId the dismissal id of the notification.
8964 * @return this object for method chaining
8965 */
8966 public WearableExtender setDismissalId(String dismissalId) {
8967 mDismissalId = dismissalId;
8968 return this;
8969 }
8970
8971 /**
8972 * Returns the dismissal id of the notification.
8973 * @return the dismissal id of the notification or null if it has not been set.
8974 */
8975 public String getDismissalId() {
8976 return mDismissalId;
8977 }
8978
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008979 /**
8980 * Sets a bridge tag for this notification. A bridge tag can be set for notifications
8981 * posted from a phone to provide finer-grained control on what notifications are bridged
8982 * to wearables. See <a href="{@docRoot}wear/notifications/index.html">Adding Wearable
8983 * Features to Notifications</a> for more information.
8984 * @param bridgeTag the bridge tag of the notification.
8985 * @return this object for method chaining
8986 */
8987 public WearableExtender setBridgeTag(String bridgeTag) {
8988 mBridgeTag = bridgeTag;
8989 return this;
8990 }
8991
8992 /**
8993 * Returns the bridge tag of the notification.
8994 * @return the bridge tag or null if not present.
8995 */
8996 public String getBridgeTag() {
8997 return mBridgeTag;
8998 }
8999
Griff Hazen61a9e862014-05-22 16:05:19 -07009000 private void setFlag(int mask, boolean value) {
9001 if (value) {
9002 mFlags |= mask;
9003 } else {
9004 mFlags &= ~mask;
9005 }
9006 }
9007 }
9008
9009 /**
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009010 * <p>Helper class to add Android Auto extensions to notifications. To create a notification
9011 * with car extensions:
9012 *
9013 * <ol>
9014 * <li>Create an {@link Notification.Builder}, setting any desired
9015 * properties.
9016 * <li>Create a {@link CarExtender}.
9017 * <li>Set car-specific properties using the {@code add} and {@code set} methods of
9018 * {@link CarExtender}.
9019 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
9020 * to apply the extensions to a notification.
9021 * </ol>
9022 *
9023 * <pre class="prettyprint">
9024 * Notification notification = new Notification.Builder(context)
9025 * ...
9026 * .extend(new CarExtender()
9027 * .set*(...))
9028 * .build();
9029 * </pre>
9030 *
9031 * <p>Car extensions can be accessed on an existing notification by using the
9032 * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods
9033 * to access values.
9034 */
9035 public static final class CarExtender implements Extender {
9036 private static final String TAG = "CarExtender";
9037
9038 private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS";
9039 private static final String EXTRA_LARGE_ICON = "large_icon";
9040 private static final String EXTRA_CONVERSATION = "car_conversation";
9041 private static final String EXTRA_COLOR = "app_color";
9042
9043 private Bitmap mLargeIcon;
9044 private UnreadConversation mUnreadConversation;
9045 private int mColor = Notification.COLOR_DEFAULT;
9046
9047 /**
9048 * Create a {@link CarExtender} with default options.
9049 */
9050 public CarExtender() {
9051 }
9052
9053 /**
9054 * Create a {@link CarExtender} from the CarExtender options of an existing Notification.
9055 *
9056 * @param notif The notification from which to copy options.
9057 */
9058 public CarExtender(Notification notif) {
9059 Bundle carBundle = notif.extras == null ?
9060 null : notif.extras.getBundle(EXTRA_CAR_EXTENDER);
9061 if (carBundle != null) {
9062 mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON);
9063 mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT);
9064
9065 Bundle b = carBundle.getBundle(EXTRA_CONVERSATION);
9066 mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b);
9067 }
9068 }
9069
9070 /**
9071 * Apply car extensions to a notification that is being built. This is typically called by
9072 * the {@link Notification.Builder#extend(Notification.Extender)}
9073 * method of {@link Notification.Builder}.
9074 */
9075 @Override
9076 public Notification.Builder extend(Notification.Builder builder) {
9077 Bundle carExtensions = new Bundle();
9078
9079 if (mLargeIcon != null) {
9080 carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon);
9081 }
9082 if (mColor != Notification.COLOR_DEFAULT) {
9083 carExtensions.putInt(EXTRA_COLOR, mColor);
9084 }
9085
9086 if (mUnreadConversation != null) {
9087 Bundle b = mUnreadConversation.getBundleForUnreadConversation();
9088 carExtensions.putBundle(EXTRA_CONVERSATION, b);
9089 }
9090
9091 builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions);
9092 return builder;
9093 }
9094
9095 /**
9096 * Sets the accent color to use when Android Auto presents the notification.
9097 *
9098 * Android Auto uses the color set with {@link Notification.Builder#setColor(int)}
9099 * to accent the displayed notification. However, not all colors are acceptable in an
9100 * automotive setting. This method can be used to override the color provided in the
9101 * notification in such a situation.
9102 */
Tor Norbye80756e32015-03-02 09:39:27 -08009103 public CarExtender setColor(@ColorInt int color) {
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009104 mColor = color;
9105 return this;
9106 }
9107
9108 /**
9109 * Gets the accent color.
9110 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04009111 * @see #setColor
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009112 */
Tor Norbye80756e32015-03-02 09:39:27 -08009113 @ColorInt
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009114 public int getColor() {
9115 return mColor;
9116 }
9117
9118 /**
9119 * Sets the large icon of the car notification.
9120 *
9121 * If no large icon is set in the extender, Android Auto will display the icon
9122 * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)}
9123 *
9124 * @param largeIcon The large icon to use in the car notification.
9125 * @return This object for method chaining.
9126 */
9127 public CarExtender setLargeIcon(Bitmap largeIcon) {
9128 mLargeIcon = largeIcon;
9129 return this;
9130 }
9131
9132 /**
9133 * Gets the large icon used in this car notification, or null if no icon has been set.
9134 *
9135 * @return The large icon for the car notification.
9136 * @see CarExtender#setLargeIcon
9137 */
9138 public Bitmap getLargeIcon() {
9139 return mLargeIcon;
9140 }
9141
9142 /**
9143 * Sets the unread conversation in a message notification.
9144 *
9145 * @param unreadConversation The unread part of the conversation this notification conveys.
9146 * @return This object for method chaining.
9147 */
9148 public CarExtender setUnreadConversation(UnreadConversation unreadConversation) {
9149 mUnreadConversation = unreadConversation;
9150 return this;
9151 }
9152
9153 /**
9154 * Returns the unread conversation conveyed by this notification.
9155 * @see #setUnreadConversation(UnreadConversation)
9156 */
9157 public UnreadConversation getUnreadConversation() {
9158 return mUnreadConversation;
9159 }
9160
9161 /**
9162 * A class which holds the unread messages from a conversation.
9163 */
9164 public static class UnreadConversation {
9165 private static final String KEY_AUTHOR = "author";
9166 private static final String KEY_TEXT = "text";
9167 private static final String KEY_MESSAGES = "messages";
9168 private static final String KEY_REMOTE_INPUT = "remote_input";
9169 private static final String KEY_ON_REPLY = "on_reply";
9170 private static final String KEY_ON_READ = "on_read";
9171 private static final String KEY_PARTICIPANTS = "participants";
9172 private static final String KEY_TIMESTAMP = "timestamp";
9173
9174 private final String[] mMessages;
9175 private final RemoteInput mRemoteInput;
9176 private final PendingIntent mReplyPendingIntent;
9177 private final PendingIntent mReadPendingIntent;
9178 private final String[] mParticipants;
9179 private final long mLatestTimestamp;
9180
9181 UnreadConversation(String[] messages, RemoteInput remoteInput,
9182 PendingIntent replyPendingIntent, PendingIntent readPendingIntent,
9183 String[] participants, long latestTimestamp) {
9184 mMessages = messages;
9185 mRemoteInput = remoteInput;
9186 mReadPendingIntent = readPendingIntent;
9187 mReplyPendingIntent = replyPendingIntent;
9188 mParticipants = participants;
9189 mLatestTimestamp = latestTimestamp;
9190 }
9191
9192 /**
9193 * Gets the list of messages conveyed by this notification.
9194 */
9195 public String[] getMessages() {
9196 return mMessages;
9197 }
9198
9199 /**
9200 * Gets the remote input that will be used to convey the response to a message list, or
9201 * null if no such remote input exists.
9202 */
9203 public RemoteInput getRemoteInput() {
9204 return mRemoteInput;
9205 }
9206
9207 /**
9208 * Gets the pending intent that will be triggered when the user replies to this
9209 * notification.
9210 */
9211 public PendingIntent getReplyPendingIntent() {
9212 return mReplyPendingIntent;
9213 }
9214
9215 /**
9216 * Gets the pending intent that Android Auto will send after it reads aloud all messages
9217 * in this object's message list.
9218 */
9219 public PendingIntent getReadPendingIntent() {
9220 return mReadPendingIntent;
9221 }
9222
9223 /**
9224 * Gets the participants in the conversation.
9225 */
9226 public String[] getParticipants() {
9227 return mParticipants;
9228 }
9229
9230 /**
9231 * Gets the firs participant in the conversation.
9232 */
9233 public String getParticipant() {
9234 return mParticipants.length > 0 ? mParticipants[0] : null;
9235 }
9236
9237 /**
9238 * Gets the timestamp of the conversation.
9239 */
9240 public long getLatestTimestamp() {
9241 return mLatestTimestamp;
9242 }
9243
9244 Bundle getBundleForUnreadConversation() {
9245 Bundle b = new Bundle();
9246 String author = null;
9247 if (mParticipants != null && mParticipants.length > 1) {
9248 author = mParticipants[0];
9249 }
9250 Parcelable[] messages = new Parcelable[mMessages.length];
9251 for (int i = 0; i < messages.length; i++) {
9252 Bundle m = new Bundle();
9253 m.putString(KEY_TEXT, mMessages[i]);
9254 m.putString(KEY_AUTHOR, author);
9255 messages[i] = m;
9256 }
9257 b.putParcelableArray(KEY_MESSAGES, messages);
9258 if (mRemoteInput != null) {
9259 b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput);
9260 }
9261 b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent);
9262 b.putParcelable(KEY_ON_READ, mReadPendingIntent);
9263 b.putStringArray(KEY_PARTICIPANTS, mParticipants);
9264 b.putLong(KEY_TIMESTAMP, mLatestTimestamp);
9265 return b;
9266 }
9267
9268 static UnreadConversation getUnreadConversationFromBundle(Bundle b) {
9269 if (b == null) {
9270 return null;
9271 }
9272 Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES);
9273 String[] messages = null;
9274 if (parcelableMessages != null) {
9275 String[] tmp = new String[parcelableMessages.length];
9276 boolean success = true;
9277 for (int i = 0; i < tmp.length; i++) {
9278 if (!(parcelableMessages[i] instanceof Bundle)) {
9279 success = false;
9280 break;
9281 }
9282 tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT);
9283 if (tmp[i] == null) {
9284 success = false;
9285 break;
9286 }
9287 }
9288 if (success) {
9289 messages = tmp;
9290 } else {
9291 return null;
9292 }
9293 }
9294
9295 PendingIntent onRead = b.getParcelable(KEY_ON_READ);
9296 PendingIntent onReply = b.getParcelable(KEY_ON_REPLY);
9297
9298 RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT);
9299
9300 String[] participants = b.getStringArray(KEY_PARTICIPANTS);
9301 if (participants == null || participants.length != 1) {
9302 return null;
9303 }
9304
9305 return new UnreadConversation(messages,
9306 remoteInput,
9307 onReply,
9308 onRead,
9309 participants, b.getLong(KEY_TIMESTAMP));
9310 }
9311 };
9312
9313 /**
9314 * Builder class for {@link CarExtender.UnreadConversation} objects.
9315 */
9316 public static class Builder {
9317 private final List<String> mMessages = new ArrayList<String>();
9318 private final String mParticipant;
9319 private RemoteInput mRemoteInput;
9320 private PendingIntent mReadPendingIntent;
9321 private PendingIntent mReplyPendingIntent;
9322 private long mLatestTimestamp;
9323
9324 /**
9325 * Constructs a new builder for {@link CarExtender.UnreadConversation}.
9326 *
9327 * @param name The name of the other participant in the conversation.
9328 */
9329 public Builder(String name) {
9330 mParticipant = name;
9331 }
9332
9333 /**
9334 * Appends a new unread message to the list of messages for this conversation.
9335 *
9336 * The messages should be added from oldest to newest.
9337 *
9338 * @param message The text of the new unread message.
9339 * @return This object for method chaining.
9340 */
9341 public Builder addMessage(String message) {
9342 mMessages.add(message);
9343 return this;
9344 }
9345
9346 /**
9347 * Sets the pending intent and remote input which will convey the reply to this
9348 * notification.
9349 *
9350 * @param pendingIntent The pending intent which will be triggered on a reply.
9351 * @param remoteInput The remote input parcelable which will carry the reply.
9352 * @return This object for method chaining.
9353 *
9354 * @see CarExtender.UnreadConversation#getRemoteInput
9355 * @see CarExtender.UnreadConversation#getReplyPendingIntent
9356 */
9357 public Builder setReplyAction(
9358 PendingIntent pendingIntent, RemoteInput remoteInput) {
9359 mRemoteInput = remoteInput;
9360 mReplyPendingIntent = pendingIntent;
9361
9362 return this;
9363 }
9364
9365 /**
9366 * Sets the pending intent that will be sent once the messages in this notification
9367 * are read.
9368 *
9369 * @param pendingIntent The pending intent to use.
9370 * @return This object for method chaining.
9371 */
9372 public Builder setReadPendingIntent(PendingIntent pendingIntent) {
9373 mReadPendingIntent = pendingIntent;
9374 return this;
9375 }
9376
9377 /**
9378 * Sets the timestamp of the most recent message in an unread conversation.
9379 *
9380 * If a messaging notification has been posted by your application and has not
9381 * yet been cancelled, posting a later notification with the same id and tag
9382 * but without a newer timestamp may result in Android Auto not displaying a
9383 * heads up notification for the later notification.
9384 *
9385 * @param timestamp The timestamp of the most recent message in the conversation.
9386 * @return This object for method chaining.
9387 */
9388 public Builder setLatestTimestamp(long timestamp) {
9389 mLatestTimestamp = timestamp;
9390 return this;
9391 }
9392
9393 /**
9394 * Builds a new unread conversation object.
9395 *
9396 * @return The new unread conversation object.
9397 */
9398 public UnreadConversation build() {
9399 String[] messages = mMessages.toArray(new String[mMessages.size()]);
9400 String[] participants = { mParticipant };
9401 return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent,
9402 mReadPendingIntent, participants, mLatestTimestamp);
9403 }
9404 }
9405 }
9406
9407 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009408 * <p>Helper class to add Android TV extensions to notifications. To create a notification
9409 * with a TV extension:
9410 *
9411 * <ol>
9412 * <li>Create an {@link Notification.Builder}, setting any desired properties.
9413 * <li>Create a {@link TvExtender}.
9414 * <li>Set TV-specific properties using the {@code set} methods of
9415 * {@link TvExtender}.
9416 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
9417 * to apply the extension to a notification.
9418 * </ol>
9419 *
9420 * <pre class="prettyprint">
9421 * Notification notification = new Notification.Builder(context)
9422 * ...
9423 * .extend(new TvExtender()
9424 * .set*(...))
9425 * .build();
9426 * </pre>
9427 *
9428 * <p>TV extensions can be accessed on an existing notification by using the
9429 * {@code TvExtender(Notification)} constructor, and then using the {@code get} methods
9430 * to access values.
9431 *
9432 * @hide
9433 */
9434 @SystemApi
9435 public static final class TvExtender implements Extender {
9436 private static final String TAG = "TvExtender";
9437
9438 private static final String EXTRA_TV_EXTENDER = "android.tv.EXTENSIONS";
9439 private static final String EXTRA_FLAGS = "flags";
9440 private static final String EXTRA_CONTENT_INTENT = "content_intent";
9441 private static final String EXTRA_DELETE_INTENT = "delete_intent";
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009442 private static final String EXTRA_CHANNEL_ID = "channel_id";
Rhiannon Malia1a083932018-01-24 15:02:30 -08009443 private static final String EXTRA_SUPPRESS_SHOW_OVER_APPS = "suppressShowOverApps";
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009444
9445 // Flags bitwise-ored to mFlags
9446 private static final int FLAG_AVAILABLE_ON_TV = 0x1;
9447
9448 private int mFlags;
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009449 private String mChannelId;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009450 private PendingIntent mContentIntent;
9451 private PendingIntent mDeleteIntent;
Rhiannon Malia1a083932018-01-24 15:02:30 -08009452 private boolean mSuppressShowOverApps;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009453
9454 /**
9455 * Create a {@link TvExtender} with default options.
9456 */
9457 public TvExtender() {
9458 mFlags = FLAG_AVAILABLE_ON_TV;
9459 }
9460
9461 /**
9462 * Create a {@link TvExtender} from the TvExtender options of an existing Notification.
9463 *
9464 * @param notif The notification from which to copy options.
9465 */
9466 public TvExtender(Notification notif) {
9467 Bundle bundle = notif.extras == null ?
9468 null : notif.extras.getBundle(EXTRA_TV_EXTENDER);
9469 if (bundle != null) {
9470 mFlags = bundle.getInt(EXTRA_FLAGS);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009471 mChannelId = bundle.getString(EXTRA_CHANNEL_ID);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009472 mSuppressShowOverApps = bundle.getBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009473 mContentIntent = bundle.getParcelable(EXTRA_CONTENT_INTENT);
9474 mDeleteIntent = bundle.getParcelable(EXTRA_DELETE_INTENT);
9475 }
9476 }
9477
9478 /**
9479 * Apply a TV extension to a notification that is being built. This is typically called by
9480 * the {@link Notification.Builder#extend(Notification.Extender)}
9481 * method of {@link Notification.Builder}.
9482 */
9483 @Override
9484 public Notification.Builder extend(Notification.Builder builder) {
9485 Bundle bundle = new Bundle();
9486
9487 bundle.putInt(EXTRA_FLAGS, mFlags);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009488 bundle.putString(EXTRA_CHANNEL_ID, mChannelId);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009489 bundle.putBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS, mSuppressShowOverApps);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009490 if (mContentIntent != null) {
9491 bundle.putParcelable(EXTRA_CONTENT_INTENT, mContentIntent);
9492 }
9493
9494 if (mDeleteIntent != null) {
9495 bundle.putParcelable(EXTRA_DELETE_INTENT, mDeleteIntent);
9496 }
9497
9498 builder.getExtras().putBundle(EXTRA_TV_EXTENDER, bundle);
9499 return builder;
9500 }
9501
9502 /**
9503 * Returns true if this notification should be shown on TV. This method return true
9504 * if the notification was extended with a TvExtender.
9505 */
9506 public boolean isAvailableOnTv() {
9507 return (mFlags & FLAG_AVAILABLE_ON_TV) != 0;
9508 }
9509
9510 /**
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009511 * Specifies the channel the notification should be delivered on when shown on TV.
9512 * It can be different from the channel that the notification is delivered to when
9513 * posting on a non-TV device.
9514 */
9515 public TvExtender setChannel(String channelId) {
9516 mChannelId = channelId;
9517 return this;
9518 }
9519
9520 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009521 * Specifies the channel the notification should be delivered on when shown on TV.
9522 * It can be different from the channel that the notification is delivered to when
9523 * posting on a non-TV device.
9524 */
9525 public TvExtender setChannelId(String channelId) {
9526 mChannelId = channelId;
9527 return this;
9528 }
9529
Jeff Sharkey000ce802017-04-29 13:13:27 -06009530 /** @removed */
9531 @Deprecated
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009532 public String getChannel() {
9533 return mChannelId;
9534 }
9535
9536 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009537 * Returns the id of the channel this notification posts to on TV.
9538 */
9539 public String getChannelId() {
9540 return mChannelId;
9541 }
9542
9543 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009544 * Supplies a {@link PendingIntent} to be sent when the notification is selected on TV.
9545 * If provided, it is used instead of the content intent specified
9546 * at the level of Notification.
9547 */
9548 public TvExtender setContentIntent(PendingIntent intent) {
9549 mContentIntent = intent;
9550 return this;
9551 }
9552
9553 /**
9554 * Returns the TV-specific content intent. If this method returns null, the
9555 * main content intent on the notification should be used.
9556 *
9557 * @see {@link Notification#contentIntent}
9558 */
9559 public PendingIntent getContentIntent() {
9560 return mContentIntent;
9561 }
9562
9563 /**
9564 * Supplies a {@link PendingIntent} to send when the notification is cleared explicitly
9565 * by the user on TV. If provided, it is used instead of the delete intent specified
9566 * at the level of Notification.
9567 */
9568 public TvExtender setDeleteIntent(PendingIntent intent) {
9569 mDeleteIntent = intent;
9570 return this;
9571 }
9572
9573 /**
9574 * Returns the TV-specific delete intent. If this method returns null, the
9575 * main delete intent on the notification should be used.
9576 *
9577 * @see {@link Notification#deleteIntent}
9578 */
9579 public PendingIntent getDeleteIntent() {
9580 return mDeleteIntent;
9581 }
Rhiannon Malia1a083932018-01-24 15:02:30 -08009582
9583 /**
9584 * Specifies whether this notification should suppress showing a message over top of apps
9585 * outside of the launcher.
9586 */
9587 public TvExtender setSuppressShowOverApps(boolean suppress) {
9588 mSuppressShowOverApps = suppress;
9589 return this;
9590 }
9591
9592 /**
9593 * Returns true if this notification should not show messages over top of apps
9594 * outside of the launcher.
9595 */
9596 public boolean getSuppressShowOverApps() {
9597 return mSuppressShowOverApps;
9598 }
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009599 }
9600
9601 /**
Griff Hazen61a9e862014-05-22 16:05:19 -07009602 * Get an array of Notification objects from a parcelable array bundle field.
9603 * Update the bundle to have a typed array so fetches in the future don't need
9604 * to do an array copy.
9605 */
9606 private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) {
9607 Parcelable[] array = bundle.getParcelableArray(key);
9608 if (array instanceof Notification[] || array == null) {
9609 return (Notification[]) array;
9610 }
9611 Notification[] typedArray = Arrays.copyOf(array, array.length,
9612 Notification[].class);
9613 bundle.putParcelableArray(key, typedArray);
9614 return typedArray;
9615 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02009616
9617 private static class BuilderRemoteViews extends RemoteViews {
9618 public BuilderRemoteViews(Parcel parcel) {
9619 super(parcel);
9620 }
9621
Kenny Guy77320062014-08-27 21:37:15 +01009622 public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) {
9623 super(appInfo, layoutId);
Christoph Studer4600f9b2014-07-22 22:44:43 +02009624 }
9625
9626 @Override
9627 public BuilderRemoteViews clone() {
9628 Parcel p = Parcel.obtain();
9629 writeToParcel(p, 0);
9630 p.setDataPosition(0);
9631 BuilderRemoteViews brv = new BuilderRemoteViews(p);
9632 p.recycle();
9633 return brv;
9634 }
9635 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08009636
Selim Cinek384804b2018-04-18 14:31:07 +08009637 /**
9638 * A result object where information about the template that was created is saved.
9639 */
9640 private static class TemplateBindResult {
Selim Cinek1c72fa02018-04-23 18:00:54 +08009641 int mIconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009642
9643 /**
Selim Cinek1c72fa02018-04-23 18:00:54 +08009644 * Get the margin end that needs to be added to any fields that may overlap
Selim Cinek384804b2018-04-18 14:31:07 +08009645 * with the right actions.
9646 */
Selim Cinek1c72fa02018-04-23 18:00:54 +08009647 public int getIconMarginEnd() {
9648 return mIconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009649 }
9650
Selim Cinek1c72fa02018-04-23 18:00:54 +08009651 public void setIconMarginEnd(int iconMarginEnd) {
9652 this.mIconMarginEnd = iconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009653 }
9654 }
9655
Adrian Roos70d7aa32017-01-11 15:39:06 -08009656 private static class StandardTemplateParams {
9657 boolean hasProgress = true;
9658 boolean ambient = false;
9659 CharSequence title;
9660 CharSequence text;
Selim Cinekafeed292017-12-12 17:32:44 -08009661 CharSequence headerTextSecondary;
Selim Cinekbee4e072018-05-21 22:06:43 -07009662 int maxRemoteInputHistory = Style.MAX_REMOTE_INPUT_HISTORY_LINES;
Selim Cinek88188f22017-09-19 16:46:56 -07009663 boolean hideLargeIcon;
Selim Cinek384804b2018-04-18 14:31:07 +08009664 boolean hideReplyIcon;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009665
9666 final StandardTemplateParams reset() {
9667 hasProgress = true;
9668 ambient = false;
9669 title = null;
9670 text = null;
Selim Cinekafeed292017-12-12 17:32:44 -08009671 headerTextSecondary = null;
Selim Cinekbee4e072018-05-21 22:06:43 -07009672 maxRemoteInputHistory = Style.MAX_REMOTE_INPUT_HISTORY_LINES;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009673 return this;
9674 }
9675
9676 final StandardTemplateParams hasProgress(boolean hasProgress) {
9677 this.hasProgress = hasProgress;
9678 return this;
9679 }
9680
9681 final StandardTemplateParams title(CharSequence title) {
9682 this.title = title;
9683 return this;
9684 }
9685
9686 final StandardTemplateParams text(CharSequence text) {
9687 this.text = text;
9688 return this;
9689 }
9690
Selim Cinekafeed292017-12-12 17:32:44 -08009691 final StandardTemplateParams headerTextSecondary(CharSequence text) {
9692 this.headerTextSecondary = text;
9693 return this;
9694 }
9695
Selim Cinek384804b2018-04-18 14:31:07 +08009696 final StandardTemplateParams hideLargeIcon(boolean hideLargeIcon) {
9697 this.hideLargeIcon = hideLargeIcon;
Selim Cinek88188f22017-09-19 16:46:56 -07009698 return this;
9699 }
9700
Selim Cinek384804b2018-04-18 14:31:07 +08009701 final StandardTemplateParams hideReplyIcon(boolean hideReplyIcon) {
9702 this.hideReplyIcon = hideReplyIcon;
Selim Cinek88188f22017-09-19 16:46:56 -07009703 return this;
9704 }
9705
Adrian Roos70d7aa32017-01-11 15:39:06 -08009706 final StandardTemplateParams ambient(boolean ambient) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08009707 Preconditions.checkState(title == null && text == null, "must set ambient before text");
Adrian Roos70d7aa32017-01-11 15:39:06 -08009708 this.ambient = ambient;
9709 return this;
9710 }
9711
9712 final StandardTemplateParams fillTextsFrom(Builder b) {
9713 Bundle extras = b.mN.extras;
Lucas Dupin06c5e642017-09-13 16:34:58 -07009714 this.title = b.processLegacyText(extras.getCharSequence(EXTRA_TITLE), ambient);
9715
9716 // Big text notifications should contain their content when viewed in ambient mode.
9717 CharSequence text = extras.getCharSequence(EXTRA_BIG_TEXT);
9718 if (!ambient || TextUtils.isEmpty(text)) {
9719 text = extras.getCharSequence(EXTRA_TEXT);
9720 }
9721 this.text = b.processLegacyText(text, ambient);
Adrian Roos70d7aa32017-01-11 15:39:06 -08009722 return this;
9723 }
Selim Cinekbee4e072018-05-21 22:06:43 -07009724
9725 /**
9726 * Set the maximum lines of remote input history lines allowed.
9727 * @param maxRemoteInputHistory The number of lines.
9728 * @return The builder for method chaining.
9729 */
9730 public StandardTemplateParams setMaxRemoteInputHistory(int maxRemoteInputHistory) {
9731 this.maxRemoteInputHistory = maxRemoteInputHistory;
9732 return this;
9733 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08009734 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009735}