blob: f771cbd89e4bd0a50c6d71860e197395435e1688 [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 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400987 * {@link #extras} key: this is a small piece of additional text as supplied to
988 * {@link Builder#setContentInfo(CharSequence)}.
989 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400990 public static final String EXTRA_INFO_TEXT = "android.infoText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400991
992 /**
993 * {@link #extras} key: this is a line of summary information intended to be shown
994 * alongside expanded notifications, as supplied to (e.g.)
995 * {@link BigTextStyle#setSummaryText(CharSequence)}.
996 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400997 public static final String EXTRA_SUMMARY_TEXT = "android.summaryText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400998
999 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +02001000 * {@link #extras} key: this is the longer text shown in the big form of a
1001 * {@link BigTextStyle} notification, as supplied to
1002 * {@link BigTextStyle#bigText(CharSequence)}.
1003 */
1004 public static final String EXTRA_BIG_TEXT = "android.bigText";
1005
1006 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001007 * {@link #extras} key: this is the resource ID of the notification's main small icon, as
1008 * supplied to {@link Builder#setSmallIcon(int)}.
Julia Reynoldse071abd2017-03-22 10:52:11 -04001009 *
1010 * @deprecated Use {@link #getSmallIcon()}, which supports a wider variety of icon sources.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001011 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04001012 @Deprecated
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001013 public static final String EXTRA_SMALL_ICON = "android.icon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001014
1015 /**
1016 * {@link #extras} key: this is a bitmap to be used instead of the small icon when showing the
1017 * notification payload, as
1018 * supplied to {@link Builder#setLargeIcon(android.graphics.Bitmap)}.
Julia Reynoldse071abd2017-03-22 10:52:11 -04001019 *
1020 * @deprecated Use {@link #getLargeIcon()}, which supports a wider variety of icon sources.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001021 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04001022 @Deprecated
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001023 public static final String EXTRA_LARGE_ICON = "android.largeIcon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001024
1025 /**
1026 * {@link #extras} key: this is a bitmap to be used instead of the one from
1027 * {@link Builder#setLargeIcon(android.graphics.Bitmap)} when the notification is
1028 * shown in its expanded form, as supplied to
1029 * {@link BigPictureStyle#bigLargeIcon(android.graphics.Bitmap)}.
1030 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001031 public static final String EXTRA_LARGE_ICON_BIG = EXTRA_LARGE_ICON + ".big";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001032
1033 /**
1034 * {@link #extras} key: this is the progress value supplied to
1035 * {@link Builder#setProgress(int, int, boolean)}.
1036 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001037 public static final String EXTRA_PROGRESS = "android.progress";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001038
1039 /**
1040 * {@link #extras} key: this is the maximum value supplied to
1041 * {@link Builder#setProgress(int, int, boolean)}.
1042 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001043 public static final String EXTRA_PROGRESS_MAX = "android.progressMax";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001044
1045 /**
1046 * {@link #extras} key: whether the progress bar is indeterminate, supplied to
1047 * {@link Builder#setProgress(int, int, boolean)}.
1048 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001049 public static final String EXTRA_PROGRESS_INDETERMINATE = "android.progressIndeterminate";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001050
1051 /**
1052 * {@link #extras} key: whether {@link #when} should be shown as a count-up timer (specifically
1053 * a {@link android.widget.Chronometer}) instead of a timestamp, as supplied to
1054 * {@link Builder#setUsesChronometer(boolean)}.
1055 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001056 public static final String EXTRA_SHOW_CHRONOMETER = "android.showChronometer";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001057
1058 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08001059 * {@link #extras} key: whether the chronometer set on the notification should count down
1060 * instead of counting up. Is only relevant if key {@link #EXTRA_SHOW_CHRONOMETER} is present.
Adrian Roos96b7e202016-05-17 13:50:38 -07001061 * This extra is a boolean. The default is false.
Selim Cinek81c23aa2016-02-25 16:23:13 -08001062 */
Adrian Roos96b7e202016-05-17 13:50:38 -07001063 public static final String EXTRA_CHRONOMETER_COUNT_DOWN = "android.chronometerCountDown";
Selim Cinek81c23aa2016-02-25 16:23:13 -08001064
1065 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001066 * {@link #extras} key: whether {@link #when} should be shown,
1067 * as supplied to {@link Builder#setShowWhen(boolean)}.
1068 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001069 public static final String EXTRA_SHOW_WHEN = "android.showWhen";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001070
1071 /**
1072 * {@link #extras} key: this is a bitmap to be shown in {@link BigPictureStyle} expanded
1073 * notifications, supplied to {@link BigPictureStyle#bigPicture(android.graphics.Bitmap)}.
1074 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001075 public static final String EXTRA_PICTURE = "android.picture";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001076
1077 /**
1078 * {@link #extras} key: An array of CharSequences to show in {@link InboxStyle} expanded
1079 * notifications, each of which was supplied to {@link InboxStyle#addLine(CharSequence)}.
1080 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001081 public static final String EXTRA_TEXT_LINES = "android.textLines";
Dan Sandler842dd772014-05-15 09:36:47 -04001082
1083 /**
1084 * {@link #extras} key: A string representing the name of the specific
1085 * {@link android.app.Notification.Style} used to create this notification.
1086 */
Chris Wren91ad5632013-06-05 15:05:57 -04001087 public static final String EXTRA_TEMPLATE = "android.template";
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001088
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001089 /**
Chris Wrene6c48932014-09-29 17:19:27 -04001090 * {@link #extras} key: A String array containing the people that this notification relates to,
1091 * each of which was supplied to {@link Builder#addPerson(String)}.
Selim Cineke7238dd2017-12-14 17:48:32 -08001092 *
1093 * @deprecated the actual objects are now in {@link #EXTRA_PEOPLE_LIST}
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001094 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04001095 public static final String EXTRA_PEOPLE = "android.people";
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001096
1097 /**
Selim Cineke7238dd2017-12-14 17:48:32 -08001098 * {@link #extras} key: An arrayList of {@link Person} objects containing the people that
1099 * this notification relates to.
1100 */
1101 public static final String EXTRA_PEOPLE_LIST = "android.people.list";
1102
1103 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04001104 * Allow certain system-generated notifications to appear before the device is provisioned.
1105 * Only available to notifications coming from the android package.
1106 * @hide
1107 */
Maurice Lam96c10032017-03-29 15:42:38 -07001108 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001109 @RequiresPermission(android.Manifest.permission.NOTIFICATION_DURING_SETUP)
John Spurlockfd7f1e02014-03-18 16:41:57 -04001110 public static final String EXTRA_ALLOW_DURING_SETUP = "android.allowDuringSetup";
1111
1112 /**
Jose Limae9e3b3b2014-05-18 23:44:50 -07001113 * {@link #extras} key: A
1114 * {@link android.content.ContentUris content URI} pointing to an image that can be displayed
Julia Reynoldse0d711f2017-09-01 08:50:47 -04001115 * in the background when the notification is selected. Used on television platforms.
1116 * The URI must point to an image stream suitable for passing into
Jose Limae9e3b3b2014-05-18 23:44:50 -07001117 * {@link android.graphics.BitmapFactory#decodeStream(java.io.InputStream)
Julia Reynoldse0d711f2017-09-01 08:50:47 -04001118 * BitmapFactory.decodeStream}; all other content types will be ignored.
Jose Limae9e3b3b2014-05-18 23:44:50 -07001119 */
1120 public static final String EXTRA_BACKGROUND_IMAGE_URI = "android.backgroundImageUri";
1121
1122 /**
Dan Sandler842dd772014-05-15 09:36:47 -04001123 * {@link #extras} key: A
Jeff Browndba34ba2014-06-24 20:46:03 -07001124 * {@link android.media.session.MediaSession.Token} associated with a
Dan Sandler842dd772014-05-15 09:36:47 -04001125 * {@link android.app.Notification.MediaStyle} notification.
1126 */
1127 public static final String EXTRA_MEDIA_SESSION = "android.mediaSession";
1128
1129 /**
Bryan Mawhinneye191f902014-07-22 12:50:09 +01001130 * {@link #extras} key: the indices of actions to be shown in the compact view,
1131 * as supplied to (e.g.) {@link MediaStyle#setShowActionsInCompactView(int...)}.
1132 */
1133 public static final String EXTRA_COMPACT_ACTIONS = "android.compactActions";
1134
Christoph Studer943aa672014-08-03 20:31:16 +02001135 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04001136 * {@link #extras} key: the username to be displayed for all messages sent by the user including
1137 * direct replies
Adrian Roos96b7e202016-05-17 13:50:38 -07001138 * {@link android.app.Notification.MessagingStyle} notification. This extra is a
1139 * {@link CharSequence}
Selim Cinekcb8b9852017-12-15 18:01:52 -08001140 *
1141 * @deprecated use {@link #EXTRA_MESSAGING_PERSON}
Alex Hillsfc737de2016-03-23 17:33:02 -04001142 */
1143 public static final String EXTRA_SELF_DISPLAY_NAME = "android.selfDisplayName";
1144
1145 /**
Selim Cinekcb8b9852017-12-15 18:01:52 -08001146 * {@link #extras} key: the person to be displayed for all messages sent by the user including
1147 * direct replies
1148 * {@link android.app.Notification.MessagingStyle} notification. This extra is a
1149 * {@link Person}
1150 */
1151 public static final String EXTRA_MESSAGING_PERSON = "android.messagingUser";
1152
1153 /**
Adrian Roos96b7e202016-05-17 13:50:38 -07001154 * {@link #extras} key: a {@link CharSequence} to be displayed as the title to a conversation
Alex Hillsd9b04d92016-04-11 16:38:16 -04001155 * represented by a {@link android.app.Notification.MessagingStyle}
Alex Hillsfc737de2016-03-23 17:33:02 -04001156 */
Alex Hillsd9b04d92016-04-11 16:38:16 -04001157 public static final String EXTRA_CONVERSATION_TITLE = "android.conversationTitle";
Alex Hillsfc737de2016-03-23 17:33:02 -04001158
1159 /**
1160 * {@link #extras} key: an array of {@link android.app.Notification.MessagingStyle.Message}
1161 * bundles provided by a
Adrian Roos96b7e202016-05-17 13:50:38 -07001162 * {@link android.app.Notification.MessagingStyle} notification. This extra is a parcelable
1163 * array of bundles.
Alex Hillsfc737de2016-03-23 17:33:02 -04001164 */
1165 public static final String EXTRA_MESSAGES = "android.messages";
1166
1167 /**
Adrian Roos437cd562017-01-18 15:47:03 -08001168 * {@link #extras} key: an array of
1169 * {@link android.app.Notification.MessagingStyle#addHistoricMessage historic}
1170 * {@link android.app.Notification.MessagingStyle.Message} bundles provided by a
1171 * {@link android.app.Notification.MessagingStyle} notification. This extra is a parcelable
1172 * array of bundles.
1173 */
1174 public static final String EXTRA_HISTORIC_MESSAGES = "android.messages.historic";
1175
1176 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08001177 * {@link #extras} key: whether the {@link android.app.Notification.MessagingStyle} notification
1178 * represents a group conversation.
1179 */
1180 public static final String EXTRA_IS_GROUP_CONVERSATION = "android.isGroupConversation";
1181
1182 /**
Selim Cinek7b9605b2017-01-19 17:36:00 -08001183 * {@link #extras} key: whether the notification should be colorized as
1184 * supplied to {@link Builder#setColorized(boolean)}}.
1185 */
1186 public static final String EXTRA_COLORIZED = "android.colorized";
1187
1188 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04001189 * @hide
1190 */
1191 public static final String EXTRA_BUILDER_APPLICATION_INFO = "android.appInfo";
1192
Selim Cinek247fa012016-02-18 09:50:48 -08001193 /**
1194 * @hide
1195 */
1196 public static final String EXTRA_CONTAINS_CUSTOM_VIEW = "android.contains.customView";
1197
Shane Brennan472a3b32016-12-12 15:28:10 -08001198 /**
Selim Cinekd0426622017-07-11 13:19:59 +02001199 * @hide
1200 */
1201 public static final String EXTRA_REDUCED_IMAGES = "android.reduced.images";
1202
1203 /**
Shane Brennan472a3b32016-12-12 15:28:10 -08001204 * {@link #extras} key: the audio contents of this notification.
1205 *
1206 * This is for use when rendering the notification on an audio-focused interface;
1207 * the audio contents are a complete sound sample that contains the contents/body of the
1208 * notification. This may be used in substitute of a Text-to-Speech reading of the
1209 * notification. For example if the notification represents a voice message this should point
1210 * to the audio of that message.
1211 *
1212 * The data stored under this key should be a String representation of a Uri that contains the
1213 * audio contents in one of the following formats: WAV, PCM 16-bit, AMR-WB.
1214 *
1215 * This extra is unnecessary if you are using {@code MessagingStyle} since each {@code Message}
1216 * has a field for holding data URI. That field can be used for audio.
1217 * See {@code Message#setData}.
1218 *
1219 * Example usage:
1220 * <pre>
1221 * {@code
1222 * Notification.Builder myBuilder = (build your Notification as normal);
1223 * myBuilder.getExtras().putString(EXTRA_AUDIO_CONTENTS_URI, myAudioUri.toString());
1224 * }
1225 * </pre>
1226 */
1227 public static final String EXTRA_AUDIO_CONTENTS_URI = "android.audioContents";
1228
Dan Sandler80eaa592016-04-14 23:34:54 -04001229 /** @hide */
1230 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001231 @RequiresPermission(android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME)
Dan Sandler732bd6c2016-04-12 14:20:32 -04001232 public static final String EXTRA_SUBSTITUTE_APP_NAME = "android.substName";
1233
Dianne Hackbornfb5d4b52017-05-16 17:03:44 -07001234 /**
Julia Reynolds3c7de112018-03-28 09:33:13 -04001235 * This is set on the notifications shown by system_server about apps running foreground
1236 * services. It indicates that the notification should be shown
1237 * only if any of the given apps do not already have a properly tagged
1238 * {@link #FLAG_FOREGROUND_SERVICE} notification currently visible to the user.
1239 * This is a string array of all package names of the apps.
Dianne Hackbornfb5d4b52017-05-16 17:03:44 -07001240 * @hide
1241 */
1242 public static final String EXTRA_FOREGROUND_APPS = "android.foregroundApps";
1243
Dan Sandlerd63f9322015-05-06 15:18:49 -04001244 private Icon mSmallIcon;
1245 private Icon mLargeIcon;
1246
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04001247 private String mChannelId;
Julia Reynolds2a128742016-11-28 14:29:25 -05001248 private long mTimeout;
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04001249
Julia Reynolds13d898c2017-02-02 12:22:05 -05001250 private String mShortcutId;
Julia Reynolds3aedded2017-03-31 14:42:09 -04001251 private CharSequence mSettingsText;
Julia Reynolds13d898c2017-02-02 12:22:05 -05001252
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001253 /** @hide */
1254 @IntDef(prefix = { "GROUP_ALERT_" }, value = {
1255 GROUP_ALERT_ALL, GROUP_ALERT_CHILDREN, GROUP_ALERT_SUMMARY
1256 })
1257 @Retention(RetentionPolicy.SOURCE)
1258 public @interface GroupAlertBehavior {}
1259
1260 /**
1261 * Constant for {@link Builder#setGroupAlertBehavior(int)}, meaning that all notifications in a
1262 * group with sound or vibration ought to make sound or vibrate (respectively), so this
1263 * notification will not be muted when it is in a group.
1264 */
1265 public static final int GROUP_ALERT_ALL = 0;
1266
1267 /**
1268 * Constant for {@link Builder#setGroupAlertBehavior(int)}, meaning that all children
1269 * notification in a group should be silenced (no sound or vibration) even if they are posted
1270 * to a {@link NotificationChannel} that has sound and/or vibration. Use this constant to
Julia Reynolds399d9bf2017-08-11 12:52:14 -04001271 * mute this notification if this notification is a group child. This must be applied to all
1272 * children notifications you want to mute.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001273 *
1274 * <p> For example, you might want to use this constant if you post a number of children
1275 * notifications at once (say, after a periodic sync), and only need to notify the user
1276 * audibly once.
1277 */
1278 public static final int GROUP_ALERT_SUMMARY = 1;
1279
1280 /**
1281 * Constant for {@link Builder#setGroupAlertBehavior(int)}, meaning that the summary
1282 * notification in a group should be silenced (no sound or vibration) even if they are
1283 * posted to a {@link NotificationChannel} that has sound and/or vibration. Use this constant
1284 * to mute this notification if this notification is a group summary.
1285 *
1286 * <p>For example, you might want to use this constant if only the children notifications
Julia Reynolds399d9bf2017-08-11 12:52:14 -04001287 * in your group have content and the summary is only used to visually group notifications
1288 * rather than to alert the user that new information is available.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001289 */
1290 public static final int GROUP_ALERT_CHILDREN = 2;
1291
Julia Reynolds2f431e22017-06-07 14:12:09 +00001292 private int mGroupAlertBehavior = GROUP_ALERT_ALL;
Julia Reynoldsa79c3712017-04-21 10:29:57 -04001293
Julia Reynolds13d898c2017-02-02 12:22:05 -05001294 /**
1295 * If this notification is being shown as a badge, always show as a number.
1296 */
1297 public static final int BADGE_ICON_NONE = 0;
1298
1299 /**
1300 * If this notification is being shown as a badge, use the {@link #getSmallIcon()} to
1301 * represent this notification.
1302 */
1303 public static final int BADGE_ICON_SMALL = 1;
1304
1305 /**
1306 * If this notification is being shown as a badge, use the {@link #getLargeIcon()} to
1307 * represent this notification.
1308 */
1309 public static final int BADGE_ICON_LARGE = 2;
Julia Reynolds7d5b4da2017-03-20 10:18:49 -04001310 private int mBadgeIcon = BADGE_ICON_NONE;
Julia Reynolds13d898c2017-02-02 12:22:05 -05001311
Chris Wren51c75102013-07-16 20:49:17 -04001312 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001313 * Structure to encapsulate a named action that can be shown as part of this notification.
1314 * It must include an icon, a label, and a {@link PendingIntent} to be fired when the action is
1315 * selected by the user.
1316 * <p>
Griff Hazen959591e2014-05-15 22:26:18 -07001317 * Apps should use {@link Notification.Builder#addAction(int, CharSequence, PendingIntent)}
1318 * or {@link Notification.Builder#addAction(Notification.Action)}
1319 * to attach actions.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001320 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -05001321 public static class Action implements Parcelable {
Shane Brennan472a3b32016-12-12 15:28:10 -08001322 /**
1323 * {@link #extras} key: Keys to a {@link Parcelable} {@link ArrayList} of
1324 * {@link RemoteInput}s.
1325 *
1326 * This is intended for {@link RemoteInput}s that only accept data, meaning
1327 * {@link RemoteInput#getAllowFreeFormInput} is false, {@link RemoteInput#getChoices}
1328 * is null or empty, and {@link RemoteInput#getAllowedDataTypes is non-null and not
1329 * empty. These {@link RemoteInput}s will be ignored by devices that do not
1330 * support non-text-based {@link RemoteInput}s. See {@link Builder#build}.
1331 *
1332 * You can test if a RemoteInput matches these constraints using
1333 * {@link RemoteInput#isDataOnly}.
1334 */
1335 private static final String EXTRA_DATA_ONLY_INPUTS = "android.extra.DATA_ONLY_INPUTS";
1336
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001337 /**
1338 * {@link }: No semantic action defined.
1339 */
1340 public static final int SEMANTIC_ACTION_NONE = 0;
1341
1342 /**
1343 * {@code SemanticAction}: Reply to a conversation, chat, group, or wherever replies
1344 * may be appropriate.
1345 */
1346 public static final int SEMANTIC_ACTION_REPLY = 1;
1347
1348 /**
1349 * {@code SemanticAction}: Mark content as read.
1350 */
1351 public static final int SEMANTIC_ACTION_MARK_AS_READ = 2;
1352
1353 /**
1354 * {@code SemanticAction}: Mark content as unread.
1355 */
1356 public static final int SEMANTIC_ACTION_MARK_AS_UNREAD = 3;
1357
1358 /**
1359 * {@code SemanticAction}: Delete the content associated with the notification. This
1360 * could mean deleting an email, message, etc.
1361 */
1362 public static final int SEMANTIC_ACTION_DELETE = 4;
1363
1364 /**
1365 * {@code SemanticAction}: Archive the content associated with the notification. This
1366 * could mean archiving an email, message, etc.
1367 */
1368 public static final int SEMANTIC_ACTION_ARCHIVE = 5;
1369
1370 /**
1371 * {@code SemanticAction}: Mute the content associated with the notification. This could
1372 * mean silencing a conversation or currently playing media.
1373 */
1374 public static final int SEMANTIC_ACTION_MUTE = 6;
1375
1376 /**
1377 * {@code SemanticAction}: Unmute the content associated with the notification. This could
1378 * mean un-silencing a conversation or currently playing media.
1379 */
1380 public static final int SEMANTIC_ACTION_UNMUTE = 7;
1381
1382 /**
1383 * {@code SemanticAction}: Mark content with a thumbs up.
1384 */
1385 public static final int SEMANTIC_ACTION_THUMBS_UP = 8;
1386
1387 /**
1388 * {@code SemanticAction}: Mark content with a thumbs down.
1389 */
1390 public static final int SEMANTIC_ACTION_THUMBS_DOWN = 9;
1391
Kodlee Yincda5b092018-02-15 15:34:53 -08001392 /**
1393 * {@code SemanticAction}: Call a contact, group, etc.
1394 */
1395 public static final int SEMANTIC_ACTION_CALL = 10;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001396
Griff Hazen959591e2014-05-15 22:26:18 -07001397 private final Bundle mExtras;
Dan Sandler86647982015-05-13 23:41:13 -04001398 private Icon mIcon;
Griff Hazen61a9e862014-05-22 16:05:19 -07001399 private final RemoteInput[] mRemoteInputs;
Alex Hills1f27f882017-01-12 11:24:46 -05001400 private boolean mAllowGeneratedReplies = true;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001401 private final @SemanticAction int mSemanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001402
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001403 /**
1404 * Small icon representing the action.
Dan Sandler86647982015-05-13 23:41:13 -04001405 *
1406 * @deprecated Use {@link Action#getIcon()} instead.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001407 */
Dan Sandler86647982015-05-13 23:41:13 -04001408 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001409 public int icon;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001410
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001411 /**
1412 * Title of the action.
1413 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001414 public CharSequence title;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001415
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001416 /**
1417 * Intent to send when the user invokes this action. May be null, in which case the action
1418 * may be rendered in a disabled presentation by the system UI.
1419 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001420 public PendingIntent actionIntent;
Griff Hazen959591e2014-05-15 22:26:18 -07001421
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001422 private Action(Parcel in) {
Dan Sandler86647982015-05-13 23:41:13 -04001423 if (in.readInt() != 0) {
1424 mIcon = Icon.CREATOR.createFromParcel(in);
Dan Sandler68079d52015-07-22 10:45:30 -04001425 if (mIcon.getType() == Icon.TYPE_RESOURCE) {
1426 icon = mIcon.getResId();
1427 }
Dan Sandler86647982015-05-13 23:41:13 -04001428 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001429 title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
1430 if (in.readInt() == 1) {
1431 actionIntent = PendingIntent.CREATOR.createFromParcel(in);
1432 }
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06001433 mExtras = Bundle.setDefusable(in.readBundle(), true);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001434 mRemoteInputs = in.createTypedArray(RemoteInput.CREATOR);
Alex Hills42b0c4d2016-04-26 13:35:36 -04001435 mAllowGeneratedReplies = in.readInt() == 1;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001436 mSemanticAction = in.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001437 }
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001438
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001439 /**
Dan Sandler86647982015-05-13 23:41:13 -04001440 * @deprecated Use {@link android.app.Notification.Action.Builder}.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001441 */
Dan Sandler86647982015-05-13 23:41:13 -04001442 @Deprecated
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001443 public Action(int icon, CharSequence title, PendingIntent intent) {
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001444 this(Icon.createWithResource("", icon), title, intent, new Bundle(), null, true,
1445 SEMANTIC_ACTION_NONE);
Griff Hazen959591e2014-05-15 22:26:18 -07001446 }
1447
Adrian Roos7af53622016-10-12 13:44:05 -07001448 /** Keep in sync with {@link Notification.Action.Builder#Builder(Action)}! */
Dan Sandler86647982015-05-13 23:41:13 -04001449 private Action(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001450 RemoteInput[] remoteInputs, boolean allowGeneratedReplies,
1451 @SemanticAction int semanticAction) {
Dan Sandler86647982015-05-13 23:41:13 -04001452 this.mIcon = icon;
Gus Prevasf5bff46f2015-08-24 10:34:28 -04001453 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
1454 this.icon = icon.getResId();
1455 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001456 this.title = title;
1457 this.actionIntent = intent;
Griff Hazen959591e2014-05-15 22:26:18 -07001458 this.mExtras = extras != null ? extras : new Bundle();
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001459 this.mRemoteInputs = remoteInputs;
Alex Hills42b0c4d2016-04-26 13:35:36 -04001460 this.mAllowGeneratedReplies = allowGeneratedReplies;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001461 this.mSemanticAction = semanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001462 }
1463
1464 /**
Dan Sandler86647982015-05-13 23:41:13 -04001465 * Return an icon representing the action.
1466 */
1467 public Icon getIcon() {
1468 if (mIcon == null && icon != 0) {
1469 // you snuck an icon in here without using the builder; let's try to keep it
1470 mIcon = Icon.createWithResource("", icon);
1471 }
1472 return mIcon;
1473 }
1474
1475 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001476 * Get additional metadata carried around with this Action.
1477 */
1478 public Bundle getExtras() {
1479 return mExtras;
1480 }
1481
1482 /**
Alex Hills42b0c4d2016-04-26 13:35:36 -04001483 * Return whether the platform should automatically generate possible replies for this
1484 * {@link Action}
1485 */
1486 public boolean getAllowGeneratedReplies() {
1487 return mAllowGeneratedReplies;
1488 }
1489
1490 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001491 * Get the list of inputs to be collected from the user when this action is sent.
Shane Brennan472a3b32016-12-12 15:28:10 -08001492 * May return null if no remote inputs were added. Only returns inputs which accept
1493 * a text input. For inputs which only accept data use {@link #getDataOnlyRemoteInputs}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001494 */
1495 public RemoteInput[] getRemoteInputs() {
1496 return mRemoteInputs;
1497 }
1498
1499 /**
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001500 * Returns the {@code SemanticAction} associated with this {@link Action}. A
1501 * {@code SemanticAction} denotes what an {@link Action}'s {@link PendingIntent} will do
1502 * (eg. reply, mark as read, delete, etc).
1503 */
1504 public @SemanticAction int getSemanticAction() {
1505 return mSemanticAction;
1506 }
1507
1508 /**
Shane Brennan472a3b32016-12-12 15:28:10 -08001509 * Get the list of inputs to be collected from the user that ONLY accept data when this
1510 * action is sent. These remote inputs are guaranteed to return true on a call to
1511 * {@link RemoteInput#isDataOnly}.
1512 *
Shane Brennanf670d6c2017-04-25 13:05:45 -07001513 * Returns null if there are no data-only remote inputs.
Shane Brennan472a3b32016-12-12 15:28:10 -08001514 *
1515 * This method exists so that legacy RemoteInput collectors that pre-date the addition
1516 * of non-textual RemoteInputs do not access these remote inputs.
1517 */
1518 public RemoteInput[] getDataOnlyRemoteInputs() {
1519 return (RemoteInput[]) mExtras.getParcelableArray(EXTRA_DATA_ONLY_INPUTS);
1520 }
1521
1522 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001523 * Builder class for {@link Action} objects.
1524 */
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001525 public static final class Builder {
Dan Sandler86647982015-05-13 23:41:13 -04001526 private final Icon mIcon;
Griff Hazen959591e2014-05-15 22:26:18 -07001527 private final CharSequence mTitle;
1528 private final PendingIntent mIntent;
Alex Hills1f27f882017-01-12 11:24:46 -05001529 private boolean mAllowGeneratedReplies = true;
Griff Hazen959591e2014-05-15 22:26:18 -07001530 private final Bundle mExtras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001531 private ArrayList<RemoteInput> mRemoteInputs;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001532 private @SemanticAction int mSemanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001533
1534 /**
1535 * Construct a new builder for {@link Action} object.
1536 * @param icon icon to show for this action
1537 * @param title the title of the action
1538 * @param intent the {@link PendingIntent} to fire when users trigger this action
1539 */
Dan Sandler86647982015-05-13 23:41:13 -04001540 @Deprecated
Griff Hazen959591e2014-05-15 22:26:18 -07001541 public Builder(int icon, CharSequence title, PendingIntent intent) {
Adrian Roos7af53622016-10-12 13:44:05 -07001542 this(Icon.createWithResource("", icon), title, intent);
Dan Sandler86647982015-05-13 23:41:13 -04001543 }
1544
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 */
1551 public Builder(Icon icon, CharSequence title, PendingIntent intent) {
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001552 this(icon, title, intent, new Bundle(), null, true, SEMANTIC_ACTION_NONE);
Griff Hazen959591e2014-05-15 22:26:18 -07001553 }
1554
1555 /**
1556 * Construct a new builder for {@link Action} object using the fields from an
1557 * {@link Action}.
1558 * @param action the action to read fields from.
1559 */
1560 public Builder(Action action) {
Adrian Roos7af53622016-10-12 13:44:05 -07001561 this(action.getIcon(), action.title, action.actionIntent,
1562 new Bundle(action.mExtras), action.getRemoteInputs(),
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001563 action.getAllowGeneratedReplies(), action.getSemanticAction());
Griff Hazen959591e2014-05-15 22:26:18 -07001564 }
1565
Dan Sandler86647982015-05-13 23:41:13 -04001566 private Builder(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001567 RemoteInput[] remoteInputs, boolean allowGeneratedReplies,
1568 @SemanticAction int semanticAction) {
Griff Hazen959591e2014-05-15 22:26:18 -07001569 mIcon = icon;
1570 mTitle = title;
1571 mIntent = intent;
1572 mExtras = extras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001573 if (remoteInputs != null) {
1574 mRemoteInputs = new ArrayList<RemoteInput>(remoteInputs.length);
1575 Collections.addAll(mRemoteInputs, remoteInputs);
1576 }
Adrian Roos7af53622016-10-12 13:44:05 -07001577 mAllowGeneratedReplies = allowGeneratedReplies;
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001578 mSemanticAction = semanticAction;
Griff Hazen959591e2014-05-15 22:26:18 -07001579 }
1580
1581 /**
1582 * Merge additional metadata into this builder.
1583 *
1584 * <p>Values within the Bundle will replace existing extras values in this Builder.
1585 *
1586 * @see Notification.Action#extras
1587 */
1588 public Builder addExtras(Bundle extras) {
1589 if (extras != null) {
1590 mExtras.putAll(extras);
1591 }
1592 return this;
1593 }
1594
1595 /**
1596 * Get the metadata Bundle used by this Builder.
1597 *
1598 * <p>The returned Bundle is shared with this Builder.
1599 */
1600 public Bundle getExtras() {
1601 return mExtras;
1602 }
1603
1604 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001605 * Add an input to be collected from the user when this action is sent.
1606 * Response values can be retrieved from the fired intent by using the
1607 * {@link RemoteInput#getResultsFromIntent} function.
1608 * @param remoteInput a {@link RemoteInput} to add to the action
1609 * @return this object for method chaining
1610 */
1611 public Builder addRemoteInput(RemoteInput remoteInput) {
1612 if (mRemoteInputs == null) {
1613 mRemoteInputs = new ArrayList<RemoteInput>();
1614 }
1615 mRemoteInputs.add(remoteInput);
1616 return this;
1617 }
1618
1619 /**
Alex Hills42b0c4d2016-04-26 13:35:36 -04001620 * Set whether the platform should automatically generate possible replies to add to
1621 * {@link RemoteInput#getChoices()}. If the {@link Action} doesn't have a
1622 * {@link RemoteInput}, this has no effect.
1623 * @param allowGeneratedReplies {@code true} to allow generated replies, {@code false}
1624 * otherwise
1625 * @return this object for method chaining
Alex Hills1f27f882017-01-12 11:24:46 -05001626 * The default value is {@code true}
Alex Hills42b0c4d2016-04-26 13:35:36 -04001627 */
1628 public Builder setAllowGeneratedReplies(boolean allowGeneratedReplies) {
1629 mAllowGeneratedReplies = allowGeneratedReplies;
1630 return this;
1631 }
1632
1633 /**
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001634 * Sets the {@code SemanticAction} for this {@link Action}. A
1635 * {@code SemanticAction} denotes what an {@link Action}'s
1636 * {@link PendingIntent} will do (eg. reply, mark as read, delete, etc).
1637 * @param semanticAction a SemanticAction defined within {@link Action} with
1638 * {@code SEMANTIC_ACTION_} prefixes
1639 * @return this object for method chaining
1640 */
1641 public Builder setSemanticAction(@SemanticAction int semanticAction) {
1642 mSemanticAction = semanticAction;
1643 return this;
1644 }
1645
1646 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001647 * Apply an extender to this action builder. Extenders may be used to add
1648 * metadata or change options on this builder.
1649 */
Griff Hazen61a9e862014-05-22 16:05:19 -07001650 public Builder extend(Extender extender) {
1651 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001652 return this;
1653 }
1654
1655 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001656 * Combine all of the options that have been set and return a new {@link Action}
1657 * object.
1658 * @return the built action
1659 */
1660 public Action build() {
Shane Brennan472a3b32016-12-12 15:28:10 -08001661 ArrayList<RemoteInput> dataOnlyInputs = new ArrayList<>();
1662 RemoteInput[] previousDataInputs =
1663 (RemoteInput[]) mExtras.getParcelableArray(EXTRA_DATA_ONLY_INPUTS);
Felipe Lemedfd11962017-01-18 18:38:46 -08001664 if (previousDataInputs != null) {
Shane Brennan472a3b32016-12-12 15:28:10 -08001665 for (RemoteInput input : previousDataInputs) {
1666 dataOnlyInputs.add(input);
1667 }
1668 }
1669 List<RemoteInput> textInputs = new ArrayList<>();
1670 if (mRemoteInputs != null) {
1671 for (RemoteInput input : mRemoteInputs) {
1672 if (input.isDataOnly()) {
1673 dataOnlyInputs.add(input);
1674 } else {
1675 textInputs.add(input);
1676 }
1677 }
1678 }
1679 if (!dataOnlyInputs.isEmpty()) {
1680 RemoteInput[] dataInputsArr =
1681 dataOnlyInputs.toArray(new RemoteInput[dataOnlyInputs.size()]);
1682 mExtras.putParcelableArray(EXTRA_DATA_ONLY_INPUTS, dataInputsArr);
1683 }
1684 RemoteInput[] textInputsArr = textInputs.isEmpty()
1685 ? null : textInputs.toArray(new RemoteInput[textInputs.size()]);
1686 return new Action(mIcon, mTitle, mIntent, mExtras, textInputsArr,
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001687 mAllowGeneratedReplies, mSemanticAction);
Griff Hazen959591e2014-05-15 22:26:18 -07001688 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001689 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001690
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001691 @Override
1692 public Action clone() {
1693 return new Action(
Dan Sandler86647982015-05-13 23:41:13 -04001694 getIcon(),
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001695 title,
1696 actionIntent, // safe to alias
Julia Reynolds53c934c2016-09-16 14:03:43 -04001697 mExtras == null ? new Bundle() : new Bundle(mExtras),
Alex Hills42b0c4d2016-04-26 13:35:36 -04001698 getRemoteInputs(),
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001699 getAllowGeneratedReplies(),
1700 getSemanticAction());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001701 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001702
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001703 @Override
1704 public int describeContents() {
1705 return 0;
1706 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001707
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001708 @Override
1709 public void writeToParcel(Parcel out, int flags) {
Dan Sandler86647982015-05-13 23:41:13 -04001710 final Icon ic = getIcon();
1711 if (ic != null) {
1712 out.writeInt(1);
1713 ic.writeToParcel(out, 0);
1714 } else {
1715 out.writeInt(0);
1716 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001717 TextUtils.writeToParcel(title, out, flags);
1718 if (actionIntent != null) {
1719 out.writeInt(1);
1720 actionIntent.writeToParcel(out, flags);
1721 } else {
1722 out.writeInt(0);
1723 }
Griff Hazen959591e2014-05-15 22:26:18 -07001724 out.writeBundle(mExtras);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001725 out.writeTypedArray(mRemoteInputs, flags);
Alex Hills42b0c4d2016-04-26 13:35:36 -04001726 out.writeInt(mAllowGeneratedReplies ? 1 : 0);
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001727 out.writeInt(mSemanticAction);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001728 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001729
Griff Hazen959591e2014-05-15 22:26:18 -07001730 public static final Parcelable.Creator<Action> CREATOR =
1731 new Parcelable.Creator<Action>() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001732 public Action createFromParcel(Parcel in) {
1733 return new Action(in);
1734 }
1735 public Action[] newArray(int size) {
1736 return new Action[size];
1737 }
1738 };
Griff Hazen61a9e862014-05-22 16:05:19 -07001739
1740 /**
1741 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
1742 * metadata or change options on an action builder.
1743 */
1744 public interface Extender {
1745 /**
1746 * Apply this extender to a notification action builder.
1747 * @param builder the builder to be modified.
1748 * @return the build object for chaining.
1749 */
1750 public Builder extend(Builder builder);
1751 }
1752
1753 /**
1754 * Wearable extender for notification actions. To add extensions to an action,
1755 * create a new {@link android.app.Notification.Action.WearableExtender} object using
1756 * the {@code WearableExtender()} constructor and apply it to a
1757 * {@link android.app.Notification.Action.Builder} using
1758 * {@link android.app.Notification.Action.Builder#extend}.
1759 *
1760 * <pre class="prettyprint">
1761 * Notification.Action action = new Notification.Action.Builder(
1762 * R.drawable.archive_all, "Archive all", actionIntent)
Griff Hazen14f57992014-05-26 09:07:14 -07001763 * .extend(new Notification.Action.WearableExtender()
Griff Hazen61a9e862014-05-22 16:05:19 -07001764 * .setAvailableOffline(false))
Griff Hazen14f57992014-05-26 09:07:14 -07001765 * .build();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07001766 */
1767 public static final class WearableExtender implements Extender {
1768 /** Notification action extra which contains wearable extensions */
1769 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
1770
Pete Gastaf6781d2014-10-07 15:17:05 -04001771 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07001772 private static final String KEY_FLAGS = "flags";
Pete Gastaf6781d2014-10-07 15:17:05 -04001773 private static final String KEY_IN_PROGRESS_LABEL = "inProgressLabel";
1774 private static final String KEY_CONFIRM_LABEL = "confirmLabel";
1775 private static final String KEY_CANCEL_LABEL = "cancelLabel";
Griff Hazen61a9e862014-05-22 16:05:19 -07001776
1777 // Flags bitwise-ored to mFlags
1778 private static final int FLAG_AVAILABLE_OFFLINE = 0x1;
Alex Hills9ab3a232016-04-05 14:54:56 -04001779 private static final int FLAG_HINT_LAUNCHES_ACTIVITY = 1 << 1;
Alex Hills9f087612016-06-07 09:08:59 -04001780 private static final int FLAG_HINT_DISPLAY_INLINE = 1 << 2;
Griff Hazen61a9e862014-05-22 16:05:19 -07001781
1782 // Default value for flags integer
1783 private static final int DEFAULT_FLAGS = FLAG_AVAILABLE_OFFLINE;
1784
1785 private int mFlags = DEFAULT_FLAGS;
1786
Pete Gastaf6781d2014-10-07 15:17:05 -04001787 private CharSequence mInProgressLabel;
1788 private CharSequence mConfirmLabel;
1789 private CharSequence mCancelLabel;
1790
Griff Hazen61a9e862014-05-22 16:05:19 -07001791 /**
1792 * Create a {@link android.app.Notification.Action.WearableExtender} with default
1793 * options.
1794 */
1795 public WearableExtender() {
1796 }
1797
1798 /**
1799 * Create a {@link android.app.Notification.Action.WearableExtender} by reading
1800 * wearable options present in an existing notification action.
1801 * @param action the notification action to inspect.
1802 */
1803 public WearableExtender(Action action) {
1804 Bundle wearableBundle = action.getExtras().getBundle(EXTRA_WEARABLE_EXTENSIONS);
1805 if (wearableBundle != null) {
1806 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
Pete Gastaf6781d2014-10-07 15:17:05 -04001807 mInProgressLabel = wearableBundle.getCharSequence(KEY_IN_PROGRESS_LABEL);
1808 mConfirmLabel = wearableBundle.getCharSequence(KEY_CONFIRM_LABEL);
1809 mCancelLabel = wearableBundle.getCharSequence(KEY_CANCEL_LABEL);
Griff Hazen61a9e862014-05-22 16:05:19 -07001810 }
1811 }
1812
1813 /**
1814 * Apply wearable extensions to a notification action that is being built. This is
1815 * typically called by the {@link android.app.Notification.Action.Builder#extend}
1816 * method of {@link android.app.Notification.Action.Builder}.
1817 */
1818 @Override
1819 public Action.Builder extend(Action.Builder builder) {
1820 Bundle wearableBundle = new Bundle();
1821
1822 if (mFlags != DEFAULT_FLAGS) {
1823 wearableBundle.putInt(KEY_FLAGS, mFlags);
1824 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001825 if (mInProgressLabel != null) {
1826 wearableBundle.putCharSequence(KEY_IN_PROGRESS_LABEL, mInProgressLabel);
1827 }
1828 if (mConfirmLabel != null) {
1829 wearableBundle.putCharSequence(KEY_CONFIRM_LABEL, mConfirmLabel);
1830 }
1831 if (mCancelLabel != null) {
1832 wearableBundle.putCharSequence(KEY_CANCEL_LABEL, mCancelLabel);
1833 }
Griff Hazen61a9e862014-05-22 16:05:19 -07001834
1835 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
1836 return builder;
1837 }
1838
1839 @Override
1840 public WearableExtender clone() {
1841 WearableExtender that = new WearableExtender();
1842 that.mFlags = this.mFlags;
Pete Gastaf6781d2014-10-07 15:17:05 -04001843 that.mInProgressLabel = this.mInProgressLabel;
1844 that.mConfirmLabel = this.mConfirmLabel;
1845 that.mCancelLabel = this.mCancelLabel;
Griff Hazen61a9e862014-05-22 16:05:19 -07001846 return that;
1847 }
1848
1849 /**
1850 * Set whether this action is available when the wearable device is not connected to
1851 * a companion device. The user can still trigger this action when the wearable device is
1852 * offline, but a visual hint will indicate that the action may not be available.
1853 * Defaults to true.
1854 */
1855 public WearableExtender setAvailableOffline(boolean availableOffline) {
1856 setFlag(FLAG_AVAILABLE_OFFLINE, availableOffline);
1857 return this;
1858 }
1859
1860 /**
1861 * Get 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 boolean isAvailableOffline() {
1867 return (mFlags & FLAG_AVAILABLE_OFFLINE) != 0;
1868 }
1869
1870 private void setFlag(int mask, boolean value) {
1871 if (value) {
1872 mFlags |= mask;
1873 } else {
1874 mFlags &= ~mask;
1875 }
1876 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001877
1878 /**
1879 * Set a label to display while the wearable is preparing to automatically execute the
1880 * action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1881 *
1882 * @param label the label to display while the action is being prepared to execute
1883 * @return this object for method chaining
1884 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001885 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001886 public WearableExtender setInProgressLabel(CharSequence label) {
1887 mInProgressLabel = label;
1888 return this;
1889 }
1890
1891 /**
1892 * Get the label to display while the wearable is preparing to automatically execute
1893 * the action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1894 *
1895 * @return the label to display while the action is being prepared to execute
1896 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001897 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001898 public CharSequence getInProgressLabel() {
1899 return mInProgressLabel;
1900 }
1901
1902 /**
1903 * Set a label to display to confirm that the action should be executed.
1904 * This is usually an imperative verb like "Send".
1905 *
1906 * @param label the label to confirm the action should be executed
1907 * @return this object for method chaining
1908 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001909 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001910 public WearableExtender setConfirmLabel(CharSequence label) {
1911 mConfirmLabel = label;
1912 return this;
1913 }
1914
1915 /**
1916 * Get the label to display to confirm that the action should be executed.
1917 * This is usually an imperative verb like "Send".
1918 *
1919 * @return the label to confirm the action should be executed
1920 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001921 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001922 public CharSequence getConfirmLabel() {
1923 return mConfirmLabel;
1924 }
1925
1926 /**
1927 * Set a label to display to cancel the action.
1928 * This is usually an imperative verb, like "Cancel".
1929 *
1930 * @param label the label to display to cancel the action
1931 * @return this object for method chaining
1932 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001933 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001934 public WearableExtender setCancelLabel(CharSequence label) {
1935 mCancelLabel = label;
1936 return this;
1937 }
1938
1939 /**
1940 * Get the label to display to cancel the action.
1941 * This is usually an imperative verb like "Cancel".
1942 *
1943 * @return the label to display to cancel the action
1944 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05001945 @Deprecated
Pete Gastaf6781d2014-10-07 15:17:05 -04001946 public CharSequence getCancelLabel() {
1947 return mCancelLabel;
1948 }
Alex Hills9ab3a232016-04-05 14:54:56 -04001949
1950 /**
1951 * Set a hint that this Action will launch an {@link Activity} directly, telling the
1952 * platform that it can generate the appropriate transitions.
1953 * @param hintLaunchesActivity {@code true} if the content intent will launch
1954 * an activity and transitions should be generated, false otherwise.
1955 * @return this object for method chaining
1956 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001957 public WearableExtender setHintLaunchesActivity(
Alex Hills9ab3a232016-04-05 14:54:56 -04001958 boolean hintLaunchesActivity) {
1959 setFlag(FLAG_HINT_LAUNCHES_ACTIVITY, hintLaunchesActivity);
1960 return this;
1961 }
1962
1963 /**
1964 * Get a hint that this Action will launch an {@link Activity} directly, telling the
1965 * platform that it can generate the appropriate transitions
1966 * @return {@code true} if the content intent will launch an activity and transitions
1967 * should be generated, false otherwise. The default value is {@code false} if this was
1968 * never set.
1969 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001970 public boolean getHintLaunchesActivity() {
Alex Hills9ab3a232016-04-05 14:54:56 -04001971 return (mFlags & FLAG_HINT_LAUNCHES_ACTIVITY) != 0;
1972 }
Alex Hills9f087612016-06-07 09:08:59 -04001973
1974 /**
1975 * Set a hint that this Action should be displayed inline.
1976 *
1977 * @param hintDisplayInline {@code true} if action should be displayed inline, false
1978 * otherwise
1979 * @return this object for method chaining
1980 */
1981 public WearableExtender setHintDisplayActionInline(
1982 boolean hintDisplayInline) {
1983 setFlag(FLAG_HINT_DISPLAY_INLINE, hintDisplayInline);
1984 return this;
1985 }
1986
1987 /**
1988 * Get a hint that this Action should be displayed inline.
1989 *
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08001990 * @return {@code true} if the Action should be displayed inline, {@code false}
Alex Hills9f087612016-06-07 09:08:59 -04001991 * otherwise. The default value is {@code false} if this was never set.
1992 */
1993 public boolean getHintDisplayActionInline() {
1994 return (mFlags & FLAG_HINT_DISPLAY_INLINE) != 0;
1995 }
Griff Hazen61a9e862014-05-22 16:05:19 -07001996 }
Kodlee Yinc72c44d2017-12-21 22:07:15 +00001997
1998 /**
1999 * Provides meaning to an {@link Action} that hints at what the associated
2000 * {@link PendingIntent} will do. For example, an {@link Action} with a
2001 * {@link PendingIntent} that replies to a text message notification may have the
2002 * {@link #SEMANTIC_ACTION_REPLY} {@code SemanticAction} set within it.
2003 *
2004 * @hide
2005 */
2006 @IntDef(prefix = { "SEMANTIC_ACTION_" }, value = {
2007 SEMANTIC_ACTION_NONE,
2008 SEMANTIC_ACTION_REPLY,
2009 SEMANTIC_ACTION_MARK_AS_READ,
2010 SEMANTIC_ACTION_MARK_AS_UNREAD,
2011 SEMANTIC_ACTION_DELETE,
2012 SEMANTIC_ACTION_ARCHIVE,
2013 SEMANTIC_ACTION_MUTE,
2014 SEMANTIC_ACTION_UNMUTE,
2015 SEMANTIC_ACTION_THUMBS_UP,
Kodlee Yincda5b092018-02-15 15:34:53 -08002016 SEMANTIC_ACTION_THUMBS_DOWN,
2017 SEMANTIC_ACTION_CALL
Kodlee Yinc72c44d2017-12-21 22:07:15 +00002018 })
2019 @Retention(RetentionPolicy.SOURCE)
2020 public @interface SemanticAction {}
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002021 }
2022
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04002023 /**
2024 * Array of all {@link Action} structures attached to this notification by
2025 * {@link Builder#addAction(int, CharSequence, PendingIntent)}. Mostly useful for instances of
2026 * {@link android.service.notification.NotificationListenerService} that provide an alternative
2027 * interface for invoking actions.
2028 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -05002029 public Action[] actions;
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002030
2031 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002032 * Replacement version of this notification whose content will be shown
2033 * in an insecure context such as atop a secure keyguard. See {@link #visibility}
2034 * and {@link #VISIBILITY_PUBLIC}.
2035 */
2036 public Notification publicVersion;
2037
2038 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002039 * Constructs a Notification object with default values.
Joe Onorato46439ce2010-11-19 13:56:21 -08002040 * You might want to consider using {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002041 */
2042 public Notification()
2043 {
2044 this.when = System.currentTimeMillis();
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002045 this.creationTime = System.currentTimeMillis();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002046 this.priority = PRIORITY_DEFAULT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002047 }
2048
2049 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002050 * @hide
2051 */
2052 public Notification(Context context, int icon, CharSequence tickerText, long when,
2053 CharSequence contentTitle, CharSequence contentText, Intent contentIntent)
2054 {
Chris Wren1ce4b6d2015-06-11 10:19:43 -04002055 new Builder(context)
2056 .setWhen(when)
2057 .setSmallIcon(icon)
2058 .setTicker(tickerText)
2059 .setContentTitle(contentTitle)
2060 .setContentText(contentText)
2061 .setContentIntent(PendingIntent.getActivity(context, 0, contentIntent, 0))
2062 .buildInto(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002063 }
2064
2065 /**
2066 * Constructs a Notification object with the information needed to
2067 * have a status bar icon without the standard expanded view.
2068 *
2069 * @param icon The resource id of the icon to put in the status bar.
2070 * @param tickerText The text that flows by in the status bar when the notification first
2071 * activates.
2072 * @param when The time to show in the time field. In the System.currentTimeMillis
2073 * timebase.
Joe Onorato46439ce2010-11-19 13:56:21 -08002074 *
2075 * @deprecated Use {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002076 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002077 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002078 public Notification(int icon, CharSequence tickerText, long when)
2079 {
2080 this.icon = icon;
2081 this.tickerText = tickerText;
2082 this.when = when;
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002083 this.creationTime = System.currentTimeMillis();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002084 }
2085
2086 /**
2087 * Unflatten the notification from a parcel.
2088 */
Svet Ganovddb94882016-06-23 19:55:24 -07002089 @SuppressWarnings("unchecked")
2090 public Notification(Parcel parcel) {
2091 // IMPORTANT: Add unmarshaling code in readFromParcel as the pending
2092 // intents in extras are always written as the last entry.
2093 readFromParcelImpl(parcel);
2094 // Must be read last!
Felipe Lemedd85da62016-06-28 11:29:54 -07002095 allPendingIntents = (ArraySet<PendingIntent>) parcel.readArraySet(null);
Svet Ganovddb94882016-06-23 19:55:24 -07002096 }
2097
2098 private void readFromParcelImpl(Parcel parcel)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002099 {
2100 int version = parcel.readInt();
2101
Adrian Roosfb921842017-10-26 14:49:56 +02002102 mWhitelistToken = parcel.readStrongBinder();
2103 if (mWhitelistToken == null) {
2104 mWhitelistToken = processWhitelistToken;
Dianne Hackborn98305522017-05-05 17:53:53 -07002105 }
2106 // Propagate this token to all pending intents that are unmarshalled from the parcel.
Adrian Roosfb921842017-10-26 14:49:56 +02002107 parcel.setClassCookie(PendingIntent.class, mWhitelistToken);
Dianne Hackborn98305522017-05-05 17:53:53 -07002108
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002109 when = parcel.readLong();
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002110 creationTime = parcel.readLong();
Dan Sandler3936e7a2015-05-19 20:59:12 -04002111 if (parcel.readInt() != 0) {
2112 mSmallIcon = Icon.CREATOR.createFromParcel(parcel);
Dan Sandler4e787062015-06-17 15:09:48 -04002113 if (mSmallIcon.getType() == Icon.TYPE_RESOURCE) {
2114 icon = mSmallIcon.getResId();
2115 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04002116 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002117 number = parcel.readInt();
2118 if (parcel.readInt() != 0) {
2119 contentIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2120 }
2121 if (parcel.readInt() != 0) {
2122 deleteIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2123 }
2124 if (parcel.readInt() != 0) {
2125 tickerText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
2126 }
2127 if (parcel.readInt() != 0) {
Joe Onorato46439ce2010-11-19 13:56:21 -08002128 tickerView = RemoteViews.CREATOR.createFromParcel(parcel);
Joe Onoratoef1e7762010-09-17 18:38:38 -04002129 }
2130 if (parcel.readInt() != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002131 contentView = RemoteViews.CREATOR.createFromParcel(parcel);
2132 }
Joe Onorato561d3852010-11-20 18:09:34 -08002133 if (parcel.readInt() != 0) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04002134 mLargeIcon = Icon.CREATOR.createFromParcel(parcel);
Joe Onorato561d3852010-11-20 18:09:34 -08002135 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002136 defaults = parcel.readInt();
2137 flags = parcel.readInt();
2138 if (parcel.readInt() != 0) {
2139 sound = Uri.CREATOR.createFromParcel(parcel);
2140 }
2141
2142 audioStreamType = parcel.readInt();
John Spurlockc0650f022014-07-19 13:22:39 -04002143 if (parcel.readInt() != 0) {
2144 audioAttributes = AudioAttributes.CREATOR.createFromParcel(parcel);
2145 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002146 vibrate = parcel.createLongArray();
2147 ledARGB = parcel.readInt();
2148 ledOnMS = parcel.readInt();
2149 ledOffMS = parcel.readInt();
2150 iconLevel = parcel.readInt();
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002151
2152 if (parcel.readInt() != 0) {
2153 fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel);
2154 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002155
2156 priority = parcel.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002157
John Spurlockfd7f1e02014-03-18 16:41:57 -04002158 category = parcel.readString();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002159
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002160 mGroupKey = parcel.readString();
2161
2162 mSortKey = parcel.readString();
2163
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06002164 extras = Bundle.setDefusable(parcel.readBundle(), true); // may be null
Robin Leead7e72a2017-12-04 15:45:46 +01002165 fixDuplicateExtras();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002166
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002167 actions = parcel.createTypedArray(Action.CREATOR); // may be null
2168
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002169 if (parcel.readInt() != 0) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002170 bigContentView = RemoteViews.CREATOR.createFromParcel(parcel);
2171 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002172
Chris Wren8fd39ec2014-02-27 17:43:26 -05002173 if (parcel.readInt() != 0) {
2174 headsUpContentView = RemoteViews.CREATOR.createFromParcel(parcel);
2175 }
2176
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002177 visibility = parcel.readInt();
2178
2179 if (parcel.readInt() != 0) {
2180 publicVersion = Notification.CREATOR.createFromParcel(parcel);
2181 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04002182
2183 color = parcel.readInt();
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002184
2185 if (parcel.readInt() != 0) {
2186 mChannelId = parcel.readString();
2187 }
Julia Reynolds2a128742016-11-28 14:29:25 -05002188 mTimeout = parcel.readLong();
Julia Reynolds13d898c2017-02-02 12:22:05 -05002189
2190 if (parcel.readInt() != 0) {
2191 mShortcutId = parcel.readString();
2192 }
2193
2194 mBadgeIcon = parcel.readInt();
Julia Reynolds3aedded2017-03-31 14:42:09 -04002195
2196 if (parcel.readInt() != 0) {
2197 mSettingsText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
2198 }
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002199
2200 mGroupAlertBehavior = parcel.readInt();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002201 }
2202
Andy Stadler110988c2010-12-03 14:29:16 -08002203 @Override
Joe Onorato18e69df2010-05-17 22:26:12 -07002204 public Notification clone() {
2205 Notification that = new Notification();
Daniel Sandler1a497d32013-04-18 14:52:45 -04002206 cloneInto(that, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002207 return that;
2208 }
Joe Onorato18e69df2010-05-17 22:26:12 -07002209
Daniel Sandler1a497d32013-04-18 14:52:45 -04002210 /**
2211 * Copy all (or if heavy is false, all except Bitmaps and RemoteViews) members
2212 * of this into that.
2213 * @hide
2214 */
2215 public void cloneInto(Notification that, boolean heavy) {
Adrian Roosfb921842017-10-26 14:49:56 +02002216 that.mWhitelistToken = this.mWhitelistToken;
Joe Onorato18e69df2010-05-17 22:26:12 -07002217 that.when = this.when;
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002218 that.creationTime = this.creationTime;
Dan Sandlerd63f9322015-05-06 15:18:49 -04002219 that.mSmallIcon = this.mSmallIcon;
Joe Onorato18e69df2010-05-17 22:26:12 -07002220 that.number = this.number;
2221
2222 // PendingIntents are global, so there's no reason (or way) to clone them.
2223 that.contentIntent = this.contentIntent;
2224 that.deleteIntent = this.deleteIntent;
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002225 that.fullScreenIntent = this.fullScreenIntent;
Joe Onorato18e69df2010-05-17 22:26:12 -07002226
2227 if (this.tickerText != null) {
2228 that.tickerText = this.tickerText.toString();
2229 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002230 if (heavy && this.tickerView != null) {
Joe Onorato46439ce2010-11-19 13:56:21 -08002231 that.tickerView = this.tickerView.clone();
Joe Onoratoef1e7762010-09-17 18:38:38 -04002232 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002233 if (heavy && this.contentView != null) {
Joe Onorato18e69df2010-05-17 22:26:12 -07002234 that.contentView = this.contentView.clone();
2235 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04002236 if (heavy && this.mLargeIcon != null) {
2237 that.mLargeIcon = this.mLargeIcon;
Joe Onorato561d3852010-11-20 18:09:34 -08002238 }
Jozef BABJAKa8b91832011-02-22 08:05:08 +01002239 that.iconLevel = this.iconLevel;
Joe Onorato18e69df2010-05-17 22:26:12 -07002240 that.sound = this.sound; // android.net.Uri is immutable
2241 that.audioStreamType = this.audioStreamType;
John Spurlockc0650f022014-07-19 13:22:39 -04002242 if (this.audioAttributes != null) {
2243 that.audioAttributes = new AudioAttributes.Builder(this.audioAttributes).build();
2244 }
Joe Onorato18e69df2010-05-17 22:26:12 -07002245
2246 final long[] vibrate = this.vibrate;
2247 if (vibrate != null) {
2248 final int N = vibrate.length;
2249 final long[] vib = that.vibrate = new long[N];
2250 System.arraycopy(vibrate, 0, vib, 0, N);
2251 }
2252
2253 that.ledARGB = this.ledARGB;
2254 that.ledOnMS = this.ledOnMS;
2255 that.ledOffMS = this.ledOffMS;
2256 that.defaults = this.defaults;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002257
Joe Onorato18e69df2010-05-17 22:26:12 -07002258 that.flags = this.flags;
2259
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002260 that.priority = this.priority;
Joe Malin8d40d042012-11-05 11:36:40 -08002261
John Spurlockfd7f1e02014-03-18 16:41:57 -04002262 that.category = this.category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002263
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002264 that.mGroupKey = this.mGroupKey;
2265
2266 that.mSortKey = this.mSortKey;
2267
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002268 if (this.extras != null) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002269 try {
2270 that.extras = new Bundle(this.extras);
2271 // will unparcel
2272 that.extras.size();
2273 } catch (BadParcelableException e) {
2274 Log.e(TAG, "could not unparcel extras from notification: " + this, e);
2275 that.extras = null;
2276 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002277 }
2278
Felipe Lemedd85da62016-06-28 11:29:54 -07002279 if (!ArrayUtils.isEmpty(allPendingIntents)) {
2280 that.allPendingIntents = new ArraySet<>(allPendingIntents);
Svet Ganovddb94882016-06-23 19:55:24 -07002281 }
2282
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002283 if (this.actions != null) {
2284 that.actions = new Action[this.actions.length];
2285 for(int i=0; i<this.actions.length; i++) {
liangweikang63b03b52017-03-16 19:22:15 +08002286 if ( this.actions[i] != null) {
2287 that.actions[i] = this.actions[i].clone();
2288 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002289 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002290 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002291
Daniel Sandler1a497d32013-04-18 14:52:45 -04002292 if (heavy && this.bigContentView != null) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002293 that.bigContentView = this.bigContentView.clone();
2294 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002295
Chris Wren8fd39ec2014-02-27 17:43:26 -05002296 if (heavy && this.headsUpContentView != null) {
2297 that.headsUpContentView = this.headsUpContentView.clone();
2298 }
2299
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002300 that.visibility = this.visibility;
2301
2302 if (this.publicVersion != null) {
2303 that.publicVersion = new Notification();
2304 this.publicVersion.cloneInto(that.publicVersion, heavy);
2305 }
2306
Dan Sandler26e81cf2014-05-06 10:01:27 -04002307 that.color = this.color;
2308
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002309 that.mChannelId = this.mChannelId;
Julia Reynolds2a128742016-11-28 14:29:25 -05002310 that.mTimeout = this.mTimeout;
Julia Reynolds3aedded2017-03-31 14:42:09 -04002311 that.mShortcutId = this.mShortcutId;
2312 that.mBadgeIcon = this.mBadgeIcon;
2313 that.mSettingsText = this.mSettingsText;
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002314 that.mGroupAlertBehavior = this.mGroupAlertBehavior;
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002315
Daniel Sandler1a497d32013-04-18 14:52:45 -04002316 if (!heavy) {
2317 that.lightenPayload(); // will clean out extras
2318 }
2319 }
2320
2321 /**
Jeff Sharkey23b31182018-04-18 21:32:12 -06002322 * Note all {@link Uri} that are referenced internally, with the expectation
2323 * that Uri permission grants will need to be issued to ensure the recipient
2324 * of this object is able to render its contents.
2325 *
2326 * @hide
2327 */
2328 public void visitUris(@NonNull Consumer<Uri> visitor) {
2329 visitor.accept(sound);
2330
2331 if (tickerView != null) tickerView.visitUris(visitor);
2332 if (contentView != null) contentView.visitUris(visitor);
2333 if (bigContentView != null) bigContentView.visitUris(visitor);
2334 if (headsUpContentView != null) headsUpContentView.visitUris(visitor);
2335
2336 if (extras != null) {
2337 visitor.accept(extras.getParcelable(EXTRA_AUDIO_CONTENTS_URI));
2338 visitor.accept(extras.getParcelable(EXTRA_BACKGROUND_IMAGE_URI));
2339 }
2340
2341 if (MessagingStyle.class.equals(getNotificationStyle()) && extras != null) {
2342 final Parcelable[] messages = extras.getParcelableArray(EXTRA_MESSAGES);
2343 if (!ArrayUtils.isEmpty(messages)) {
2344 for (MessagingStyle.Message message : MessagingStyle.Message
2345 .getMessagesFromBundleArray(messages)) {
2346 visitor.accept(message.getDataUri());
2347 }
2348 }
2349
2350 final Parcelable[] historic = extras.getParcelableArray(EXTRA_HISTORIC_MESSAGES);
2351 if (!ArrayUtils.isEmpty(historic)) {
2352 for (MessagingStyle.Message message : MessagingStyle.Message
2353 .getMessagesFromBundleArray(historic)) {
2354 visitor.accept(message.getDataUri());
2355 }
2356 }
2357 }
2358 }
2359
2360 /**
Daniel Sandler1a497d32013-04-18 14:52:45 -04002361 * Removes heavyweight parts of the Notification object for archival or for sending to
2362 * listeners when the full contents are not necessary.
2363 * @hide
2364 */
2365 public final void lightenPayload() {
2366 tickerView = null;
2367 contentView = null;
2368 bigContentView = null;
Chris Wren8fd39ec2014-02-27 17:43:26 -05002369 headsUpContentView = null;
Dan Sandlerd63f9322015-05-06 15:18:49 -04002370 mLargeIcon = null;
Dan Sandler50128532015-12-08 15:42:41 -05002371 if (extras != null && !extras.isEmpty()) {
2372 final Set<String> keyset = extras.keySet();
2373 final int N = keyset.size();
2374 final String[] keys = keyset.toArray(new String[N]);
2375 for (int i=0; i<N; i++) {
2376 final String key = keys[i];
Dmitri Plotnikov22281362017-01-30 11:16:21 -08002377 if (TvExtender.EXTRA_TV_EXTENDER.equals(key)) {
2378 continue;
2379 }
Dan Sandler50128532015-12-08 15:42:41 -05002380 final Object obj = extras.get(key);
2381 if (obj != null &&
2382 ( obj instanceof Parcelable
2383 || obj instanceof Parcelable[]
2384 || obj instanceof SparseArray
2385 || obj instanceof ArrayList)) {
2386 extras.remove(key);
2387 }
2388 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04002389 }
Joe Onorato18e69df2010-05-17 22:26:12 -07002390 }
2391
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002392 /**
2393 * Make sure this CharSequence is safe to put into a bundle, which basically
2394 * means it had better not be some custom Parcelable implementation.
2395 * @hide
2396 */
2397 public static CharSequence safeCharSequence(CharSequence cs) {
Christoph Studer535ec612014-09-03 15:47:47 +02002398 if (cs == null) return cs;
2399 if (cs.length() > MAX_CHARSEQUENCE_LENGTH) {
2400 cs = cs.subSequence(0, MAX_CHARSEQUENCE_LENGTH);
2401 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002402 if (cs instanceof Parcelable) {
2403 Log.e(TAG, "warning: " + cs.getClass().getCanonicalName()
2404 + " instance is a custom Parcelable and not allowed in Notification");
2405 return cs.toString();
2406 }
Selim Cinek60a54252016-02-26 17:03:25 -08002407 return removeTextSizeSpans(cs);
2408 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002409
Selim Cinek60a54252016-02-26 17:03:25 -08002410 private static CharSequence removeTextSizeSpans(CharSequence charSequence) {
2411 if (charSequence instanceof Spanned) {
2412 Spanned ss = (Spanned) charSequence;
2413 Object[] spans = ss.getSpans(0, ss.length(), Object.class);
2414 SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
2415 for (Object span : spans) {
2416 Object resultSpan = span;
Selim Cinek89991a22016-03-07 19:51:54 -08002417 if (resultSpan instanceof CharacterStyle) {
2418 resultSpan = ((CharacterStyle) span).getUnderlying();
2419 }
2420 if (resultSpan instanceof TextAppearanceSpan) {
2421 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
Selim Cinek60a54252016-02-26 17:03:25 -08002422 resultSpan = new TextAppearanceSpan(
2423 originalSpan.getFamily(),
2424 originalSpan.getTextStyle(),
2425 -1,
2426 originalSpan.getTextColor(),
2427 originalSpan.getLinkTextColor());
Selim Cinek89991a22016-03-07 19:51:54 -08002428 } else if (resultSpan instanceof RelativeSizeSpan
2429 || resultSpan instanceof AbsoluteSizeSpan) {
Selim Cinek60a54252016-02-26 17:03:25 -08002430 continue;
Selim Cinek89991a22016-03-07 19:51:54 -08002431 } else {
2432 resultSpan = span;
Selim Cinek60a54252016-02-26 17:03:25 -08002433 }
2434 builder.setSpan(resultSpan, ss.getSpanStart(span), ss.getSpanEnd(span),
2435 ss.getSpanFlags(span));
2436 }
2437 return builder;
2438 }
2439 return charSequence;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002440 }
2441
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002442 public int describeContents() {
2443 return 0;
2444 }
2445
2446 /**
Dan Sandler4e787062015-06-17 15:09:48 -04002447 * Flatten this notification into a parcel.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002448 */
Svet Ganovddb94882016-06-23 19:55:24 -07002449 public void writeToParcel(Parcel parcel, int flags) {
2450 // We need to mark all pending intents getting into the notification
2451 // system as being put there to later allow the notification ranker
2452 // to launch them and by doing so add the app to the battery saver white
2453 // list for a short period of time. The problem is that the system
2454 // cannot look into the extras as there may be parcelables there that
2455 // the platform does not know how to handle. To go around that we have
2456 // an explicit list of the pending intents in the extras bundle.
Felipe Lemedd85da62016-06-28 11:29:54 -07002457 final boolean collectPendingIntents = (allPendingIntents == null);
Svet Ganovddb94882016-06-23 19:55:24 -07002458 if (collectPendingIntents) {
2459 PendingIntent.setOnMarshaledListener(
2460 (PendingIntent intent, Parcel out, int outFlags) -> {
2461 if (parcel == out) {
Felipe Lemedd85da62016-06-28 11:29:54 -07002462 if (allPendingIntents == null) {
2463 allPendingIntents = new ArraySet<>();
Svet Ganovddb94882016-06-23 19:55:24 -07002464 }
Felipe Lemedd85da62016-06-28 11:29:54 -07002465 allPendingIntents.add(intent);
Svet Ganovddb94882016-06-23 19:55:24 -07002466 }
2467 });
2468 }
2469 try {
2470 // IMPORTANT: Add marshaling code in writeToParcelImpl as we
Julia Reynolds13d898c2017-02-02 12:22:05 -05002471 // want to intercept all pending events written to the parcel.
Svet Ganovddb94882016-06-23 19:55:24 -07002472 writeToParcelImpl(parcel, flags);
2473 // Must be written last!
Felipe Lemedd85da62016-06-28 11:29:54 -07002474 parcel.writeArraySet(allPendingIntents);
Svet Ganovddb94882016-06-23 19:55:24 -07002475 } finally {
2476 if (collectPendingIntents) {
2477 PendingIntent.setOnMarshaledListener(null);
2478 }
2479 }
2480 }
2481
2482 private void writeToParcelImpl(Parcel parcel, int flags) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002483 parcel.writeInt(1);
2484
Adrian Roosfb921842017-10-26 14:49:56 +02002485 parcel.writeStrongBinder(mWhitelistToken);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002486 parcel.writeLong(when);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07002487 parcel.writeLong(creationTime);
Dan Sandler4e787062015-06-17 15:09:48 -04002488 if (mSmallIcon == null && icon != 0) {
2489 // you snuck an icon in here without using the builder; let's try to keep it
2490 mSmallIcon = Icon.createWithResource("", icon);
2491 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04002492 if (mSmallIcon != null) {
2493 parcel.writeInt(1);
2494 mSmallIcon.writeToParcel(parcel, 0);
2495 } else {
2496 parcel.writeInt(0);
2497 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002498 parcel.writeInt(number);
2499 if (contentIntent != null) {
2500 parcel.writeInt(1);
2501 contentIntent.writeToParcel(parcel, 0);
2502 } else {
2503 parcel.writeInt(0);
2504 }
2505 if (deleteIntent != null) {
2506 parcel.writeInt(1);
2507 deleteIntent.writeToParcel(parcel, 0);
2508 } else {
2509 parcel.writeInt(0);
2510 }
2511 if (tickerText != null) {
2512 parcel.writeInt(1);
2513 TextUtils.writeToParcel(tickerText, parcel, flags);
2514 } else {
2515 parcel.writeInt(0);
2516 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002517 if (tickerView != null) {
Joe Onoratoef1e7762010-09-17 18:38:38 -04002518 parcel.writeInt(1);
Joe Onorato46439ce2010-11-19 13:56:21 -08002519 tickerView.writeToParcel(parcel, 0);
Joe Onoratoef1e7762010-09-17 18:38:38 -04002520 } else {
2521 parcel.writeInt(0);
2522 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002523 if (contentView != null) {
2524 parcel.writeInt(1);
2525 contentView.writeToParcel(parcel, 0);
2526 } else {
2527 parcel.writeInt(0);
2528 }
Selim Cinek279fa862016-06-14 10:57:25 -07002529 if (mLargeIcon == null && largeIcon != null) {
2530 // you snuck an icon in here without using the builder; let's try to keep it
2531 mLargeIcon = Icon.createWithBitmap(largeIcon);
2532 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04002533 if (mLargeIcon != null) {
Joe Onorato561d3852010-11-20 18:09:34 -08002534 parcel.writeInt(1);
Dan Sandlerd63f9322015-05-06 15:18:49 -04002535 mLargeIcon.writeToParcel(parcel, 0);
Joe Onorato561d3852010-11-20 18:09:34 -08002536 } else {
2537 parcel.writeInt(0);
2538 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002539
2540 parcel.writeInt(defaults);
2541 parcel.writeInt(this.flags);
2542
2543 if (sound != null) {
2544 parcel.writeInt(1);
2545 sound.writeToParcel(parcel, 0);
2546 } else {
2547 parcel.writeInt(0);
2548 }
2549 parcel.writeInt(audioStreamType);
John Spurlockc0650f022014-07-19 13:22:39 -04002550
2551 if (audioAttributes != null) {
2552 parcel.writeInt(1);
2553 audioAttributes.writeToParcel(parcel, 0);
2554 } else {
2555 parcel.writeInt(0);
2556 }
2557
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002558 parcel.writeLongArray(vibrate);
2559 parcel.writeInt(ledARGB);
2560 parcel.writeInt(ledOnMS);
2561 parcel.writeInt(ledOffMS);
2562 parcel.writeInt(iconLevel);
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002563
2564 if (fullScreenIntent != null) {
2565 parcel.writeInt(1);
2566 fullScreenIntent.writeToParcel(parcel, 0);
2567 } else {
2568 parcel.writeInt(0);
2569 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002570
2571 parcel.writeInt(priority);
Joe Malin8d40d042012-11-05 11:36:40 -08002572
John Spurlockfd7f1e02014-03-18 16:41:57 -04002573 parcel.writeString(category);
Joe Malin8d40d042012-11-05 11:36:40 -08002574
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002575 parcel.writeString(mGroupKey);
2576
2577 parcel.writeString(mSortKey);
2578
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002579 parcel.writeBundle(extras); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002580
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002581 parcel.writeTypedArray(actions, 0); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002582
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002583 if (bigContentView != null) {
2584 parcel.writeInt(1);
2585 bigContentView.writeToParcel(parcel, 0);
2586 } else {
2587 parcel.writeInt(0);
2588 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002589
Chris Wren8fd39ec2014-02-27 17:43:26 -05002590 if (headsUpContentView != null) {
2591 parcel.writeInt(1);
2592 headsUpContentView.writeToParcel(parcel, 0);
2593 } else {
2594 parcel.writeInt(0);
2595 }
2596
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002597 parcel.writeInt(visibility);
2598
2599 if (publicVersion != null) {
2600 parcel.writeInt(1);
2601 publicVersion.writeToParcel(parcel, 0);
2602 } else {
2603 parcel.writeInt(0);
2604 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04002605
2606 parcel.writeInt(color);
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002607
2608 if (mChannelId != null) {
2609 parcel.writeInt(1);
2610 parcel.writeString(mChannelId);
2611 } else {
2612 parcel.writeInt(0);
2613 }
Julia Reynolds2a128742016-11-28 14:29:25 -05002614 parcel.writeLong(mTimeout);
Julia Reynolds13d898c2017-02-02 12:22:05 -05002615
2616 if (mShortcutId != null) {
2617 parcel.writeInt(1);
2618 parcel.writeString(mShortcutId);
2619 } else {
2620 parcel.writeInt(0);
2621 }
2622
2623 parcel.writeInt(mBadgeIcon);
Julia Reynolds3aedded2017-03-31 14:42:09 -04002624
2625 if (mSettingsText != null) {
2626 parcel.writeInt(1);
2627 TextUtils.writeToParcel(mSettingsText, parcel, flags);
2628 } else {
2629 parcel.writeInt(0);
2630 }
Julia Reynoldsa79c3712017-04-21 10:29:57 -04002631
2632 parcel.writeInt(mGroupAlertBehavior);
Julia Reynoldsfc640012018-02-21 12:25:27 -05002633
2634 // mUsesStandardHeader is not written because it should be recomputed in listeners
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002635 }
2636
2637 /**
2638 * Parcelable.Creator that instantiates Notification objects
2639 */
2640 public static final Parcelable.Creator<Notification> CREATOR
2641 = new Parcelable.Creator<Notification>()
2642 {
2643 public Notification createFromParcel(Parcel parcel)
2644 {
2645 return new Notification(parcel);
2646 }
2647
2648 public Notification[] newArray(int size)
2649 {
2650 return new Notification[size];
2651 }
2652 };
2653
2654 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05002655 * @hide
2656 */
2657 public static boolean areActionsVisiblyDifferent(Notification first, Notification second) {
2658 Notification.Action[] firstAs = first.actions;
2659 Notification.Action[] secondAs = second.actions;
2660 if (firstAs == null && secondAs != null || firstAs != null && secondAs == null) {
2661 return true;
2662 }
2663 if (firstAs != null && secondAs != null) {
2664 if (firstAs.length != secondAs.length) {
2665 return true;
2666 }
2667 for (int i = 0; i < firstAs.length; i++) {
2668 if (!Objects.equals(firstAs[i].title, secondAs[i].title)) {
2669 return true;
2670 }
2671 RemoteInput[] firstRs = firstAs[i].getRemoteInputs();
2672 RemoteInput[] secondRs = secondAs[i].getRemoteInputs();
2673 if (firstRs == null) {
2674 firstRs = new RemoteInput[0];
2675 }
2676 if (secondRs == null) {
2677 secondRs = new RemoteInput[0];
2678 }
2679 if (firstRs.length != secondRs.length) {
2680 return true;
2681 }
2682 for (int j = 0; j < firstRs.length; j++) {
2683 if (!Objects.equals(firstRs[j].getLabel(), secondRs[j].getLabel())) {
2684 return true;
2685 }
Julia Reynolds5a366fb2018-03-21 15:40:53 -04002686 CharSequence[] firstCs = firstRs[j].getChoices();
2687 CharSequence[] secondCs = secondRs[j].getChoices();
Julia Reynolds7217dc92018-03-07 12:12:09 -05002688 if (firstCs == null) {
2689 firstCs = new CharSequence[0];
2690 }
2691 if (secondCs == null) {
2692 secondCs = new CharSequence[0];
2693 }
2694 if (firstCs.length != secondCs.length) {
2695 return true;
2696 }
2697 for (int k = 0; k < firstCs.length; k++) {
2698 if (!Objects.equals(firstCs[k], secondCs[k])) {
2699 return true;
2700 }
2701 }
2702 }
2703 }
2704 }
2705 return false;
2706 }
2707
2708 /**
2709 * @hide
2710 */
2711 public static boolean areStyledNotificationsVisiblyDifferent(Builder first, Builder second) {
2712 if (first.getStyle() == null) {
2713 return second.getStyle() != null;
2714 }
2715 if (second.getStyle() == null) {
2716 return true;
2717 }
2718 return first.getStyle().areNotificationsVisiblyDifferent(second.getStyle());
2719 }
2720
2721 /**
2722 * @hide
2723 */
2724 public static boolean areRemoteViewsChanged(Builder first, Builder second) {
Julia Reynoldse5c60452018-04-30 14:41:36 -04002725 if (!Objects.equals(first.usesStandardHeader(), second.usesStandardHeader())) {
2726 return true;
2727 }
2728
2729 if (areRemoteViewsChanged(first.mN.contentView, second.mN.contentView)) {
2730 return true;
2731 }
2732 if (areRemoteViewsChanged(first.mN.bigContentView, second.mN.bigContentView)) {
2733 return true;
2734 }
2735 if (areRemoteViewsChanged(first.mN.headsUpContentView, second.mN.headsUpContentView)) {
2736 return true;
2737 }
2738
2739 return false;
2740 }
2741
2742 private static boolean areRemoteViewsChanged(RemoteViews first, RemoteViews second) {
2743 if (first == null && second == null) {
2744 return false;
2745 }
2746 if (first == null && second != null || first != null && second == null) {
2747 return true;
2748 }
2749
2750 if (!Objects.equals(first.getLayoutId(), second.getLayoutId())) {
2751 return true;
2752 }
2753
2754 if (!Objects.equals(first.getSequenceNumber(), second.getSequenceNumber())) {
2755 return true;
2756 }
2757
2758 return false;
Julia Reynolds7217dc92018-03-07 12:12:09 -05002759 }
2760
2761 /**
Robin Leead7e72a2017-12-04 15:45:46 +01002762 * Parcelling creates multiple copies of objects in {@code extras}. Fix them.
2763 * <p>
2764 * For backwards compatibility {@code extras} holds some references to "real" member data such
2765 * as {@link getLargeIcon()} which is mirrored by {@link #EXTRA_LARGE_ICON}. This is mostly
2766 * fine as long as the object stays in one process.
2767 * <p>
2768 * However, once the notification goes into a parcel each reference gets marshalled separately,
2769 * wasting memory. Especially with large images on Auto and TV, this is worth fixing.
2770 */
2771 private void fixDuplicateExtras() {
2772 if (extras != null) {
2773 fixDuplicateExtra(mSmallIcon, EXTRA_SMALL_ICON);
2774 fixDuplicateExtra(mLargeIcon, EXTRA_LARGE_ICON);
2775 }
2776 }
2777
2778 /**
2779 * If we find an extra that's exactly the same as one of the "real" fields but refers to a
2780 * separate object, replace it with the field's version to avoid holding duplicate copies.
2781 */
2782 private void fixDuplicateExtra(@Nullable Parcelable original, @NonNull String extraName) {
2783 if (original != null && extras.getParcelable(extraName) != null) {
2784 extras.putParcelable(extraName, original);
2785 }
2786 }
2787
2788 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002789 * Sets the {@link #contentView} field to be a view with the standard "Latest Event"
2790 * layout.
2791 *
2792 * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields
2793 * in the view.</p>
2794 * @param context The context for your application / activity.
2795 * @param contentTitle The title that goes in the expanded entry.
2796 * @param contentText The text that goes in the expanded entry.
2797 * @param contentIntent The intent to launch when the user clicks the expanded notification.
2798 * If this is an activity, it must include the
2799 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -08002800 * that you take care of task management as described in the
2801 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2802 * Stack</a> document.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002803 *
Joe Onorato46439ce2010-11-19 13:56:21 -08002804 * @deprecated Use {@link Builder} instead.
Chris Wrena05db382015-06-24 15:18:34 -04002805 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002806 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002807 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002808 public void setLatestEventInfo(Context context,
2809 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002810 if (context.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.LOLLIPOP_MR1){
2811 Log.e(TAG, "setLatestEventInfo() is deprecated and you should feel deprecated.",
2812 new Throwable());
2813 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002814
Selim Cinek4ac6f602016-06-13 15:47:03 -07002815 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
2816 extras.putBoolean(EXTRA_SHOW_WHEN, true);
2817 }
2818
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002819 // ensure that any information already set directly is preserved
2820 final Notification.Builder builder = new Notification.Builder(context, this);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002821
2822 // now apply the latestEventInfo fields
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002823 if (contentTitle != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002824 builder.setContentTitle(contentTitle);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002825 }
2826 if (contentText != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002827 builder.setContentText(contentText);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002828 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002829 builder.setContentIntent(contentIntent);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002830
2831 builder.build(); // callers expect this notification to be ready to use
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002832 }
2833
Julia Reynoldsda303542015-11-23 14:00:20 -05002834 /**
2835 * @hide
2836 */
2837 public static void addFieldsFromContext(Context context, Notification notification) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04002838 addFieldsFromContext(context.getApplicationInfo(), notification);
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002839 }
2840
2841 /**
2842 * @hide
2843 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04002844 public static void addFieldsFromContext(ApplicationInfo ai, Notification notification) {
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002845 notification.extras.putParcelable(EXTRA_BUILDER_APPLICATION_INFO, ai);
Julia Reynoldsda303542015-11-23 14:00:20 -05002846 }
2847
Yi Jin6b514142017-10-30 14:54:12 -07002848 /**
2849 * @hide
2850 */
2851 public void writeToProto(ProtoOutputStream proto, long fieldId) {
2852 long token = proto.start(fieldId);
2853 proto.write(NotificationProto.CHANNEL_ID, getChannelId());
2854 proto.write(NotificationProto.HAS_TICKER_TEXT, this.tickerText != null);
2855 proto.write(NotificationProto.FLAGS, this.flags);
2856 proto.write(NotificationProto.COLOR, this.color);
2857 proto.write(NotificationProto.CATEGORY, this.category);
2858 proto.write(NotificationProto.GROUP_KEY, this.mGroupKey);
2859 proto.write(NotificationProto.SORT_KEY, this.mSortKey);
2860 if (this.actions != null) {
2861 proto.write(NotificationProto.ACTION_LENGTH, this.actions.length);
2862 }
2863 if (this.visibility >= VISIBILITY_SECRET && this.visibility <= VISIBILITY_PUBLIC) {
2864 proto.write(NotificationProto.VISIBILITY, this.visibility);
2865 }
2866 if (publicVersion != null) {
2867 publicVersion.writeToProto(proto, NotificationProto.PUBLIC_VERSION);
2868 }
2869 proto.end(token);
2870 }
2871
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002872 @Override
2873 public String toString() {
2874 StringBuilder sb = new StringBuilder();
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002875 sb.append("Notification(channel=");
Julia Reynoldsbad42972017-04-25 13:52:49 -04002876 sb.append(getChannelId());
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002877 sb.append(" pri=");
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002878 sb.append(priority);
2879 sb.append(" contentView=");
Joe Onoratoc9596d62011-01-12 17:03:11 -08002880 if (contentView != null) {
2881 sb.append(contentView.getPackage());
2882 sb.append("/0x");
2883 sb.append(Integer.toHexString(contentView.getLayoutId()));
2884 } else {
2885 sb.append("null");
2886 }
2887 sb.append(" vibrate=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002888 if ((this.defaults & DEFAULT_VIBRATE) != 0) {
2889 sb.append("default");
2890 } else if (this.vibrate != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002891 int N = this.vibrate.length-1;
2892 sb.append("[");
2893 for (int i=0; i<N; i++) {
2894 sb.append(this.vibrate[i]);
2895 sb.append(',');
2896 }
Simon Schoar8cf97d92009-06-10 22:08:37 +02002897 if (N != -1) {
2898 sb.append(this.vibrate[N]);
2899 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002900 sb.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002901 } else {
2902 sb.append("null");
2903 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002904 sb.append(" sound=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002905 if ((this.defaults & DEFAULT_SOUND) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002906 sb.append("default");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002907 } else if (this.sound != null) {
2908 sb.append(this.sound.toString());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002909 } else {
2910 sb.append("null");
2911 }
Chris Wren365b6d32015-07-16 10:39:26 -04002912 if (this.tickerText != null) {
2913 sb.append(" tick");
2914 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002915 sb.append(" defaults=0x");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002916 sb.append(Integer.toHexString(this.defaults));
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002917 sb.append(" flags=0x");
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002918 sb.append(Integer.toHexString(this.flags));
Dan Sandler26e81cf2014-05-06 10:01:27 -04002919 sb.append(String.format(" color=0x%08x", this.color));
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002920 if (this.category != null) {
2921 sb.append(" category=");
2922 sb.append(this.category);
2923 }
2924 if (this.mGroupKey != null) {
2925 sb.append(" groupKey=");
2926 sb.append(this.mGroupKey);
2927 }
2928 if (this.mSortKey != null) {
2929 sb.append(" sortKey=");
2930 sb.append(this.mSortKey);
2931 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002932 if (actions != null) {
Dan Sandler1b718782014-07-18 12:43:45 -04002933 sb.append(" actions=");
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002934 sb.append(actions.length);
Dan Sandler1b718782014-07-18 12:43:45 -04002935 }
2936 sb.append(" vis=");
2937 sb.append(visibilityToString(this.visibility));
2938 if (this.publicVersion != null) {
2939 sb.append(" publicVersion=");
2940 sb.append(publicVersion.toString());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002941 }
2942 sb.append(")");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002943 return sb.toString();
2944 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002945
Dan Sandler1b718782014-07-18 12:43:45 -04002946 /**
2947 * {@hide}
2948 */
2949 public static String visibilityToString(int vis) {
2950 switch (vis) {
2951 case VISIBILITY_PRIVATE:
2952 return "PRIVATE";
2953 case VISIBILITY_PUBLIC:
2954 return "PUBLIC";
2955 case VISIBILITY_SECRET:
2956 return "SECRET";
2957 default:
2958 return "UNKNOWN(" + String.valueOf(vis) + ")";
2959 }
2960 }
2961
Joe Onoratocb109a02011-01-18 17:57:41 -08002962 /**
John Spurlock1d881a12015-03-18 19:21:54 -04002963 * {@hide}
2964 */
2965 public static String priorityToString(@Priority int pri) {
2966 switch (pri) {
2967 case PRIORITY_MIN:
2968 return "MIN";
2969 case PRIORITY_LOW:
2970 return "LOW";
2971 case PRIORITY_DEFAULT:
2972 return "DEFAULT";
2973 case PRIORITY_HIGH:
2974 return "HIGH";
2975 case PRIORITY_MAX:
2976 return "MAX";
2977 default:
2978 return "UNKNOWN(" + String.valueOf(pri) + ")";
2979 }
2980 }
2981
Julia Reynolds6ad0aec2017-07-05 08:47:03 -04002982 /**
2983 * @hide
2984 */
2985 public boolean hasCompletedProgress() {
2986 // not a progress notification; can't be complete
2987 if (!extras.containsKey(EXTRA_PROGRESS)
2988 || !extras.containsKey(EXTRA_PROGRESS_MAX)) {
2989 return false;
2990 }
2991 // many apps use max 0 for 'indeterminate'; not complete
2992 if (extras.getInt(EXTRA_PROGRESS_MAX) == 0) {
2993 return false;
2994 }
2995 return extras.getInt(EXTRA_PROGRESS) == extras.getInt(EXTRA_PROGRESS_MAX);
2996 }
2997
Jeff Sharkey000ce802017-04-29 13:13:27 -06002998 /** @removed */
2999 @Deprecated
Julia Reynolds37856052016-11-11 09:20:07 -05003000 public String getChannel() {
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04003001 return mChannelId;
3002 }
3003
3004 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003005 * Returns the id of the channel this notification posts to.
3006 */
3007 public String getChannelId() {
3008 return mChannelId;
3009 }
3010
Jeff Sharkey000ce802017-04-29 13:13:27 -06003011 /** @removed */
3012 @Deprecated
Julia Reynolds2a128742016-11-28 14:29:25 -05003013 public long getTimeout() {
3014 return mTimeout;
3015 }
3016
3017 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003018 * Returns the duration from posting after which this notification should be canceled by the
3019 * system, if it's not canceled already.
3020 */
3021 public long getTimeoutAfter() {
3022 return mTimeout;
3023 }
3024
3025 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04003026 * Returns what icon should be shown for this notification if it is being displayed in a
3027 * Launcher that supports badging. Will be one of {@link #BADGE_ICON_NONE},
3028 * {@link #BADGE_ICON_SMALL}, or {@link #BADGE_ICON_LARGE}.
3029 */
3030 public int getBadgeIconType() {
3031 return mBadgeIcon;
3032 }
3033
3034 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003035 * Returns the {@link ShortcutInfo#getId() id} that this notification supersedes, if any.
Julia Reynoldsbad42972017-04-25 13:52:49 -04003036 *
3037 * <p>Used by some Launchers that display notification content to hide shortcuts that duplicate
3038 * notifications.
Julia Reynolds13d898c2017-02-02 12:22:05 -05003039 */
3040 public String getShortcutId() {
3041 return mShortcutId;
3042 }
3043
Julia Reynolds3aedded2017-03-31 14:42:09 -04003044
3045 /**
3046 * Returns the settings text provided to {@link Builder#setSettingsText(CharSequence)}.
3047 */
3048 public CharSequence getSettingsText() {
3049 return mSettingsText;
3050 }
3051
Julia Reynolds13d898c2017-02-02 12:22:05 -05003052 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003053 * Returns which type of notifications in a group are responsible for audibly alerting the
3054 * user. See {@link #GROUP_ALERT_ALL}, {@link #GROUP_ALERT_CHILDREN},
3055 * {@link #GROUP_ALERT_SUMMARY}.
3056 */
3057 public @GroupAlertBehavior int getGroupAlertBehavior() {
3058 return mGroupAlertBehavior;
3059 }
3060
3061 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04003062 * The small icon representing this notification in the status bar and content view.
3063 *
3064 * @return the small icon representing this notification.
3065 *
3066 * @see Builder#getSmallIcon()
3067 * @see Builder#setSmallIcon(Icon)
3068 */
3069 public Icon getSmallIcon() {
3070 return mSmallIcon;
3071 }
3072
3073 /**
3074 * Used when notifying to clean up legacy small icons.
3075 * @hide
3076 */
3077 public void setSmallIcon(Icon icon) {
3078 mSmallIcon = icon;
3079 }
3080
3081 /**
3082 * The large icon shown in this notification's content view.
3083 * @see Builder#getLargeIcon()
3084 * @see Builder#setLargeIcon(Icon)
3085 */
3086 public Icon getLargeIcon() {
3087 return mLargeIcon;
3088 }
3089
3090 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +02003091 * @hide
3092 */
Christoph Studerc8db24b2014-07-25 17:50:30 +02003093 public boolean isGroupSummary() {
3094 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) != 0;
3095 }
3096
3097 /**
3098 * @hide
3099 */
3100 public boolean isGroupChild() {
3101 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) == 0;
3102 }
3103
3104 /**
Julia Reynolds30203152017-05-26 13:36:31 -04003105 * @hide
3106 */
3107 public boolean suppressAlertingDueToGrouping() {
3108 if (isGroupSummary()
3109 && getGroupAlertBehavior() == Notification.GROUP_ALERT_CHILDREN) {
3110 return true;
3111 } else if (isGroupChild()
3112 && getGroupAlertBehavior() == Notification.GROUP_ALERT_SUMMARY) {
3113 return true;
3114 }
3115 return false;
3116 }
3117
3118 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003119 * Builder class for {@link Notification} objects.
Joe Malin8d40d042012-11-05 11:36:40 -08003120 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003121 * Provides a convenient way to set the various fields of a {@link Notification} and generate
Scott Main183bf112012-08-13 19:12:13 -07003122 * content views using the platform's notification layout template. If your app supports
3123 * versions of Android as old as API level 4, you can instead use
3124 * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder},
3125 * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support
3126 * library</a>.
Joe Malin8d40d042012-11-05 11:36:40 -08003127 *
Scott Main183bf112012-08-13 19:12:13 -07003128 * <p>Example:
Joe Malin8d40d042012-11-05 11:36:40 -08003129 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003130 * <pre class="prettyprint">
Scott Main183bf112012-08-13 19:12:13 -07003131 * Notification noti = new Notification.Builder(mContext)
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003132 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
3133 * .setContentText(subject)
3134 * .setSmallIcon(R.drawable.new_mail)
3135 * .setLargeIcon(aBitmap)
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003136 * .build();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003137 * </pre>
Joe Onoratocb109a02011-01-18 17:57:41 -08003138 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003139 public static class Builder {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003140 /**
3141 * @hide
3142 */
3143 public static final String EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT =
3144 "android.rebuild.contentViewActionCount";
3145 /**
3146 * @hide
3147 */
3148 public static final String EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT
3149 = "android.rebuild.bigViewActionCount";
3150 /**
3151 * @hide
3152 */
3153 public static final String EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT
3154 = "android.rebuild.hudViewActionCount";
3155
Daniel Sandler602ad1c2012-06-12 16:06:27 -04003156 private static final int MAX_ACTION_BUTTONS = 3;
Daniel Sandler8680bf82012-05-15 16:52:52 -04003157
Selim Cinek6743c0b2017-01-18 18:24:01 -08003158 private static final boolean USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY =
3159 SystemProperties.getBoolean("notifications.only_title", true);
3160
Selim Cinek389edcd2017-05-11 19:16:44 -07003161 /**
3162 * The lightness difference that has to be added to the primary text color to obtain the
3163 * secondary text color when the background is light.
3164 */
3165 private static final int LIGHTNESS_TEXT_DIFFERENCE_LIGHT = 20;
3166
3167 /**
3168 * The lightness difference that has to be added to the primary text color to obtain the
3169 * secondary text color when the background is dark.
3170 * A bit less then the above value, since it looks better on dark backgrounds.
3171 */
3172 private static final int LIGHTNESS_TEXT_DIFFERENCE_DARK = -10;
3173
Joe Onorato46439ce2010-11-19 13:56:21 -08003174 private Context mContext;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003175 private Notification mN;
3176 private Bundle mUserExtras = new Bundle();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003177 private Style mStyle;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003178 private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS);
Selim Cineke7238dd2017-12-14 17:48:32 -08003179 private ArrayList<Person> mPersonList = new ArrayList<>();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003180 private NotificationColorUtil mColorUtil;
Selim Cinek7b9605b2017-01-19 17:36:00 -08003181 private boolean mIsLegacy;
3182 private boolean mIsLegacyInitialized;
Christoph Studer7ac80e62014-08-04 16:01:57 +02003183
3184 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -08003185 * Caches a contrast-enhanced version of {@link #mCachedContrastColorIsFor}.
3186 */
3187 private int mCachedContrastColor = COLOR_INVALID;
3188 private int mCachedContrastColorIsFor = COLOR_INVALID;
Adrian Roos487374f2017-01-11 15:48:14 -08003189 /**
Selim Cinek4717d862018-04-19 09:19:15 +08003190 * Caches a ambient version of {@link #mCachedAmbientColorIsFor}.
Adrian Roos487374f2017-01-11 15:48:14 -08003191 */
3192 private int mCachedAmbientColor = COLOR_INVALID;
3193 private int mCachedAmbientColorIsFor = COLOR_INVALID;
Selim Cinek4717d862018-04-19 09:19:15 +08003194 /**
3195 * A neutral color color that can be used for icons.
3196 */
3197 private int mNeutralColor = COLOR_INVALID;
Adrian Roos4ff3b122016-02-01 12:26:13 -08003198
3199 /**
Adrian Roos70d7aa32017-01-11 15:39:06 -08003200 * Caches an instance of StandardTemplateParams. Note that this may have been used before,
3201 * so make sure to call {@link StandardTemplateParams#reset()} before using it.
3202 */
3203 StandardTemplateParams mParams = new StandardTemplateParams();
Selim Cinek7b9605b2017-01-19 17:36:00 -08003204 private int mTextColorsAreForBackground = COLOR_INVALID;
3205 private int mPrimaryTextColor = COLOR_INVALID;
3206 private int mSecondaryTextColor = COLOR_INVALID;
Selim Cinek5fb73f82017-04-20 16:55:38 -07003207 private int mBackgroundColor = COLOR_INVALID;
3208 private int mForegroundColor = COLOR_INVALID;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07003209 /**
3210 * A temporary location where actions are stored. If != null the view originally has action
3211 * but doesn't have any for this inflation.
3212 */
3213 private ArrayList<Action> mOriginalActions;
Selim Cineka7679b62017-05-10 16:33:25 -07003214 private boolean mRebuildStyledRemoteViews;
Adrian Roos70d7aa32017-01-11 15:39:06 -08003215
Anthony Chenad4d1582017-04-10 16:07:58 -07003216 private boolean mTintActionButtons;
3217 private boolean mInNightMode;
3218
Adrian Roos70d7aa32017-01-11 15:39:06 -08003219 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003220 * Constructs a new Builder with the defaults:
Joe Onoratocb109a02011-01-18 17:57:41 -08003221 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003222 * @param context
3223 * A {@link Context} that will be used by the Builder to construct the
3224 * RemoteViews. The Context will not be held past the lifetime of this Builder
3225 * object.
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003226 * @param channelId
3227 * The constructed Notification will be posted on this
3228 * {@link NotificationChannel}. To use a NotificationChannel, it must first be
3229 * created using {@link NotificationManager#createNotificationChannel}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003230 */
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003231 public Builder(Context context, String channelId) {
3232 this(context, (Notification) null);
3233 mN.mChannelId = channelId;
3234 }
3235
3236 /**
3237 * @deprecated use {@link Notification.Builder#Notification.Builder(Context, String)}
3238 * instead. All posted Notifications must specify a NotificationChannel Id.
3239 */
3240 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003241 public Builder(Context context) {
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003242 this(context, (Notification) null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003243 }
3244
Joe Onoratocb109a02011-01-18 17:57:41 -08003245 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003246 * @hide
Christoph Studer4600f9b2014-07-22 22:44:43 +02003247 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003248 public Builder(Context context, Notification toAdopt) {
3249 mContext = context;
Anthony Chenad4d1582017-04-10 16:07:58 -07003250 Resources res = mContext.getResources();
3251 mTintActionButtons = res.getBoolean(R.bool.config_tintNotificationActionButtons);
3252
3253 if (res.getBoolean(R.bool.config_enableNightMode)) {
3254 Configuration currentConfig = res.getConfiguration();
3255 mInNightMode = (currentConfig.uiMode & Configuration.UI_MODE_NIGHT_MASK)
3256 == Configuration.UI_MODE_NIGHT_YES;
3257 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02003258
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003259 if (toAdopt == null) {
3260 mN = new Notification();
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003261 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
3262 mN.extras.putBoolean(EXTRA_SHOW_WHEN, true);
3263 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003264 mN.priority = PRIORITY_DEFAULT;
3265 mN.visibility = VISIBILITY_PRIVATE;
3266 } else {
3267 mN = toAdopt;
3268 if (mN.actions != null) {
3269 Collections.addAll(mActions, mN.actions);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003270 }
3271
Selim Cineke7238dd2017-12-14 17:48:32 -08003272 if (mN.extras.containsKey(EXTRA_PEOPLE_LIST)) {
3273 ArrayList<Person> people = mN.extras.getParcelableArrayList(EXTRA_PEOPLE_LIST);
3274 mPersonList.addAll(people);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003275 }
3276
Selim Cinek4ac6f602016-06-13 15:47:03 -07003277 if (mN.getSmallIcon() == null && mN.icon != 0) {
3278 setSmallIcon(mN.icon);
3279 }
3280
3281 if (mN.getLargeIcon() == null && mN.largeIcon != null) {
3282 setLargeIcon(mN.largeIcon);
3283 }
3284
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003285 String templateClass = mN.extras.getString(EXTRA_TEMPLATE);
3286 if (!TextUtils.isEmpty(templateClass)) {
3287 final Class<? extends Style> styleClass
3288 = getNotificationStyleClass(templateClass);
3289 if (styleClass == null) {
3290 Log.d(TAG, "Unknown style class: " + templateClass);
3291 } else {
3292 try {
Adrian Roosc1a80b02016-04-05 14:54:55 -07003293 final Constructor<? extends Style> ctor =
3294 styleClass.getDeclaredConstructor();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003295 ctor.setAccessible(true);
3296 final Style style = ctor.newInstance();
3297 style.restoreFromExtras(mN.extras);
3298
3299 if (style != null) {
3300 setStyle(style);
3301 }
3302 } catch (Throwable t) {
3303 Log.e(TAG, "Could not create Style", t);
3304 }
3305 }
3306 }
3307
3308 }
3309 }
3310
3311 private NotificationColorUtil getColorUtil() {
Selim Cinek99104832017-01-25 14:47:33 -08003312 if (mColorUtil == null) {
3313 mColorUtil = NotificationColorUtil.getInstance(mContext);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003314 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003315 return mColorUtil;
Christoph Studer4600f9b2014-07-22 22:44:43 +02003316 }
3317
3318 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003319 * If this notification is duplicative of a Launcher shortcut, sets the
3320 * {@link ShortcutInfo#getId() id} of the shortcut, in case the Launcher wants to hide
3321 * the shortcut.
3322 *
Julia Reynoldsbad42972017-04-25 13:52:49 -04003323 * This field will be ignored by Launchers that don't support badging, don't show
3324 * notification content, or don't show {@link android.content.pm.ShortcutManager shortcuts}.
Julia Reynolds13d898c2017-02-02 12:22:05 -05003325 *
3326 * @param shortcutId the {@link ShortcutInfo#getId() id} of the shortcut this notification
3327 * supersedes
3328 */
3329 public Builder setShortcutId(String shortcutId) {
3330 mN.mShortcutId = shortcutId;
3331 return this;
3332 }
3333
3334 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04003335 * Sets which icon to display as a badge for this notification.
3336 *
3337 * Must be one of {@link #BADGE_ICON_NONE}, {@link #BADGE_ICON_SMALL},
3338 * {@link #BADGE_ICON_LARGE}.
3339 *
3340 * Note: This value might be ignored, for launchers that don't support badge icons.
3341 */
Julia Reynolds612beb22017-03-30 10:48:30 -04003342 public Builder setBadgeIconType(int icon) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04003343 mN.mBadgeIcon = icon;
3344 return this;
3345 }
3346
3347 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003348 * Sets the group alert behavior for this notification. Use this method to mute this
3349 * notification if alerts for this notification's group should be handled by a different
3350 * notification. This is only applicable for notifications that belong to a
Julia Reynolds399d9bf2017-08-11 12:52:14 -04003351 * {@link #setGroup(String) group}. This must be called on all notifications you want to
3352 * mute. For example, if you want only the summary of your group to make noise, all
3353 * children in the group should have the group alert behavior {@link #GROUP_ALERT_SUMMARY}.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003354 *
3355 * <p> The default value is {@link #GROUP_ALERT_ALL}.</p>
3356 */
3357 public Builder setGroupAlertBehavior(@GroupAlertBehavior int groupAlertBehavior) {
3358 mN.mGroupAlertBehavior = groupAlertBehavior;
3359 return this;
3360 }
3361
Jeff Sharkey000ce802017-04-29 13:13:27 -06003362 /** @removed */
3363 @Deprecated
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04003364 public Builder setChannel(String channelId) {
3365 mN.mChannelId = channelId;
3366 return this;
3367 }
3368
3369 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003370 * Specifies the channel the notification should be delivered on.
3371 */
3372 public Builder setChannelId(String channelId) {
3373 mN.mChannelId = channelId;
3374 return this;
3375 }
3376
Jeff Sharkey000ce802017-04-29 13:13:27 -06003377 /** @removed */
3378 @Deprecated
Julia Reynolds50989772017-02-23 14:32:16 -05003379 public Builder setTimeout(long durationMs) {
3380 mN.mTimeout = durationMs;
Julia Reynolds2a128742016-11-28 14:29:25 -05003381 return this;
3382 }
3383
3384 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003385 * Specifies a duration in milliseconds after which this notification should be canceled,
3386 * if it is not already canceled.
3387 */
3388 public Builder setTimeoutAfter(long durationMs) {
3389 mN.mTimeout = durationMs;
3390 return this;
3391 }
3392
3393 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003394 * Add a timestamp pertaining to the notification (usually the time the event occurred).
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003395 *
3396 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not
3397 * shown anymore by default and must be opted into by using
3398 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003399 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003400 * @see Notification#when
Joe Onoratocb109a02011-01-18 17:57:41 -08003401 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003402 public Builder setWhen(long when) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003403 mN.when = when;
Joe Onorato46439ce2010-11-19 13:56:21 -08003404 return this;
3405 }
3406
Joe Onoratocb109a02011-01-18 17:57:41 -08003407 /**
Griff Hazen50c11652014-05-16 09:46:31 -07003408 * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown
Daniel Sandler0c890492012-09-12 17:23:10 -07003409 * in the content view.
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003410 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to
3411 * {@code false}. For earlier apps, the default is {@code true}.
Daniel Sandler0c890492012-09-12 17:23:10 -07003412 */
3413 public Builder setShowWhen(boolean show) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003414 mN.extras.putBoolean(EXTRA_SHOW_WHEN, show);
Daniel Sandler0c890492012-09-12 17:23:10 -07003415 return this;
3416 }
3417
3418 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003419 * Show the {@link Notification#when} field as a stopwatch.
Joe Malin8d40d042012-11-05 11:36:40 -08003420 *
3421 * Instead of presenting <code>when</code> as a timestamp, the notification will show an
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003422 * automatically updating display of the minutes and seconds since <code>when</code>.
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003423 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003424 * Useful when showing an elapsed time (like an ongoing phone call).
3425 *
Selim Cinek81c23aa2016-02-25 16:23:13 -08003426 * The counter can also be set to count down to <code>when</code> when using
Adrian Roos96b7e202016-05-17 13:50:38 -07003427 * {@link #setChronometerCountDown(boolean)}.
Selim Cinek81c23aa2016-02-25 16:23:13 -08003428 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003429 * @see android.widget.Chronometer
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003430 * @see Notification#when
Adrian Roos96b7e202016-05-17 13:50:38 -07003431 * @see #setChronometerCountDown(boolean)
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003432 */
3433 public Builder setUsesChronometer(boolean b) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003434 mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b);
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003435 return this;
3436 }
3437
3438 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08003439 * Sets the Chronometer to count down instead of counting up.
3440 *
3441 * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true.
3442 * If it isn't set the chronometer will count up.
3443 *
3444 * @see #setUsesChronometer(boolean)
3445 */
Adrian Roos96b7e202016-05-17 13:50:38 -07003446 public Builder setChronometerCountDown(boolean countDown) {
3447 mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, countDown);
Selim Cinek81c23aa2016-02-25 16:23:13 -08003448 return this;
3449 }
3450
3451 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003452 * Set the small icon resource, which will be used to represent the notification in the
3453 * status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -08003454 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003455
3456 * The platform template for the expanded view will draw this icon in the left, unless a
3457 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
3458 * icon will be moved to the right-hand side.
3459 *
3460
3461 * @param icon
3462 * A resource ID in the application's package of the drawable to use.
3463 * @see Notification#icon
Joe Onoratocb109a02011-01-18 17:57:41 -08003464 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003465 public Builder setSmallIcon(@DrawableRes int icon) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04003466 return setSmallIcon(icon != 0
3467 ? Icon.createWithResource(mContext, icon)
3468 : null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003469 }
3470
Joe Onoratocb109a02011-01-18 17:57:41 -08003471 /**
3472 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
3473 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
3474 * LevelListDrawable}.
3475 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003476 * @param icon A resource ID in the application's package of the drawable to use.
Joe Onoratocb109a02011-01-18 17:57:41 -08003477 * @param level The level to use for the icon.
3478 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003479 * @see Notification#icon
3480 * @see Notification#iconLevel
Joe Onoratocb109a02011-01-18 17:57:41 -08003481 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003482 public Builder setSmallIcon(@DrawableRes int icon, int level) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003483 mN.iconLevel = level;
Dan Sandlerd63f9322015-05-06 15:18:49 -04003484 return setSmallIcon(icon);
3485 }
3486
3487 /**
3488 * Set the small icon, which will be used to represent the notification in the
3489 * status bar and content view (unless overriden there by a
3490 * {@link #setLargeIcon(Bitmap) large icon}).
3491 *
3492 * @param icon An Icon object to use.
3493 * @see Notification#icon
3494 */
3495 public Builder setSmallIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003496 mN.setSmallIcon(icon);
3497 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
3498 mN.icon = icon.getResId();
3499 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003500 return this;
3501 }
3502
Joe Onoratocb109a02011-01-18 17:57:41 -08003503 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003504 * Set the first line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003505 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003506 public Builder setContentTitle(CharSequence title) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003507 mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title));
Joe Onorato46439ce2010-11-19 13:56:21 -08003508 return this;
3509 }
3510
Joe Onoratocb109a02011-01-18 17:57:41 -08003511 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003512 * Set the second line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003513 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003514 public Builder setContentText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003515 mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text));
Joe Onorato46439ce2010-11-19 13:56:21 -08003516 return this;
3517 }
3518
Joe Onoratocb109a02011-01-18 17:57:41 -08003519 /**
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003520 * This provides some additional information that is displayed in the notification. No
3521 * guarantees are given where exactly it is displayed.
3522 *
3523 * <p>This information should only be provided if it provides an essential
3524 * benefit to the understanding of the notification. The more text you provide the
3525 * less readable it becomes. For example, an email client should only provide the account
3526 * name here if more than one email account has been added.</p>
3527 *
3528 * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the
3529 * notification header area.
3530 *
3531 * On Android versions before {@link android.os.Build.VERSION_CODES#N}
3532 * this will be shown in the third line of text in the platform notification template.
3533 * You should not be using {@link #setProgress(int, int, boolean)} at the
3534 * same time on those versions; they occupy the same place.
3535 * </p>
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003536 */
3537 public Builder setSubText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003538 mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text));
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003539 return this;
3540 }
3541
3542 /**
Julia Reynolds3aedded2017-03-31 14:42:09 -04003543 * Provides text that will appear as a link to your application's settings.
3544 *
3545 * <p>This text does not appear within notification {@link Style templates} but may
3546 * appear when the user uses an affordance to learn more about the notification.
3547 * Additionally, this text will not appear unless you provide a valid link target by
3548 * handling {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}.
3549 *
3550 * <p>This text is meant to be concise description about what the user can customize
3551 * when they click on this link. The recommended maximum length is 40 characters.
3552 * @param text
3553 * @return
3554 */
3555 public Builder setSettingsText(CharSequence text) {
3556 mN.mSettingsText = safeCharSequence(text);
3557 return this;
3558 }
3559
3560 /**
Adrian Roose458aa82015-12-08 16:17:19 -08003561 * Set the remote input history.
3562 *
3563 * This should be set to the most recent inputs that have been sent
3564 * through a {@link RemoteInput} of this Notification and cleared once the it is no
3565 * longer relevant (e.g. for chat notifications once the other party has responded).
3566 *
3567 * The most recent input must be stored at the 0 index, the second most recent at the
3568 * 1 index, etc. Note that the system will limit both how far back the inputs will be shown
3569 * and how much of each individual input is shown.
3570 *
3571 * <p>Note: The reply text will only be shown on notifications that have least one action
3572 * with a {@code RemoteInput}.</p>
3573 */
3574 public Builder setRemoteInputHistory(CharSequence[] text) {
3575 if (text == null) {
3576 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null);
3577 } else {
3578 final int N = Math.min(MAX_REPLY_HISTORY, text.length);
3579 CharSequence[] safe = new CharSequence[N];
3580 for (int i = 0; i < N; i++) {
3581 safe[i] = safeCharSequence(text[i]);
3582 }
3583 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe);
3584 }
3585 return this;
3586 }
3587
3588 /**
Kenny Guya0f6de82018-04-06 16:20:16 +01003589 * Sets whether remote history entries view should have a spinner.
3590 * @hide
3591 */
3592 public Builder setShowRemoteInputSpinner(boolean showSpinner) {
3593 mN.extras.putBoolean(EXTRA_SHOW_REMOTE_INPUT_SPINNER, showSpinner);
3594 return this;
3595 }
3596
3597 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003598 * Sets the number of items this notification represents. May be displayed as a badge count
3599 * for Launchers that support badging.
Joe Onoratocb109a02011-01-18 17:57:41 -08003600 */
Joe Onorato8595a3d2010-11-19 18:12:07 -08003601 public Builder setNumber(int number) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003602 mN.number = number;
Joe Onorato8595a3d2010-11-19 18:12:07 -08003603 return this;
3604 }
3605
Joe Onoratocb109a02011-01-18 17:57:41 -08003606 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003607 * A small piece of additional information pertaining to this notification.
3608 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003609 * The platform template will draw this on the last line of the notification, at the far
3610 * right (to the right of a smallIcon if it has been placed there).
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003611 *
3612 * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header.
3613 * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this
3614 * field will still show up, but the subtext will take precedence.
Joe Onoratocb109a02011-01-18 17:57:41 -08003615 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003616 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003617 public Builder setContentInfo(CharSequence info) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003618 mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info));
Joe Onorato46439ce2010-11-19 13:56:21 -08003619 return this;
3620 }
3621
Joe Onoratocb109a02011-01-18 17:57:41 -08003622 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003623 * Set the progress this notification represents.
3624 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003625 * The platform template will represent this using a {@link ProgressBar}.
Jeff Sharkey1c400132011-08-05 14:50:13 -07003626 */
3627 public Builder setProgress(int max, int progress, boolean indeterminate) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003628 mN.extras.putInt(EXTRA_PROGRESS, progress);
3629 mN.extras.putInt(EXTRA_PROGRESS_MAX, max);
3630 mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate);
Jeff Sharkey1c400132011-08-05 14:50:13 -07003631 return this;
3632 }
3633
3634 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003635 * Supply a custom RemoteViews to use instead of the platform template.
3636 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003637 * Use {@link #setCustomContentView(RemoteViews)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003638 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003639 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003640 public Builder setContent(RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003641 return setCustomContentView(views);
3642 }
3643
3644 /**
3645 * Supply custom RemoteViews to use instead of the platform template.
3646 *
3647 * This will override the layout that would otherwise be constructed by this Builder
3648 * object.
3649 */
3650 public Builder setCustomContentView(RemoteViews contentView) {
3651 mN.contentView = contentView;
3652 return this;
3653 }
3654
3655 /**
3656 * Supply custom RemoteViews to use instead of the platform template in the expanded form.
3657 *
3658 * This will override the expanded layout that would otherwise be constructed by this
3659 * Builder object.
3660 */
3661 public Builder setCustomBigContentView(RemoteViews contentView) {
3662 mN.bigContentView = contentView;
3663 return this;
3664 }
3665
3666 /**
3667 * Supply custom RemoteViews to use instead of the platform template in the heads up dialog.
3668 *
3669 * This will override the heads-up layout that would otherwise be constructed by this
3670 * Builder object.
3671 */
3672 public Builder setCustomHeadsUpContentView(RemoteViews contentView) {
3673 mN.headsUpContentView = contentView;
Joe Onorato46439ce2010-11-19 13:56:21 -08003674 return this;
3675 }
3676
Joe Onoratocb109a02011-01-18 17:57:41 -08003677 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003678 * Supply a {@link PendingIntent} to be sent when the notification is clicked.
3679 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003680 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
3681 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
3682 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003683 * to assign PendingIntents to individual views in that custom layout (i.e., to create
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003684 * clickable buttons inside the notification view).
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003685 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003686 * @see Notification#contentIntent Notification.contentIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003687 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003688 public Builder setContentIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003689 mN.contentIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003690 return this;
3691 }
3692
Joe Onoratocb109a02011-01-18 17:57:41 -08003693 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003694 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
3695 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003696 * @see Notification#deleteIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003697 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003698 public Builder setDeleteIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003699 mN.deleteIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003700 return this;
3701 }
3702
Joe Onoratocb109a02011-01-18 17:57:41 -08003703 /**
3704 * An intent to launch instead of posting the notification to the status bar.
3705 * Only for use with extremely high-priority notifications demanding the user's
3706 * <strong>immediate</strong> attention, such as an incoming phone call or
3707 * alarm clock that the user has explicitly set to a particular time.
3708 * If this facility is used for something else, please give the user an option
3709 * to turn it off and use a normal notification, as this can be extremely
3710 * disruptive.
3711 *
Chris Wren47c20a12014-06-18 17:27:29 -04003712 * <p>
3713 * The system UI may choose to display a heads-up notification, instead of
3714 * launching this intent, while the user is using the device.
3715 * </p>
3716 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003717 * @param intent The pending intent to launch.
3718 * @param highPriority Passing true will cause this notification to be sent
3719 * even if other notifications are suppressed.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003720 *
3721 * @see Notification#fullScreenIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003722 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003723 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003724 mN.fullScreenIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003725 setFlag(FLAG_HIGH_PRIORITY, highPriority);
3726 return this;
3727 }
3728
Joe Onoratocb109a02011-01-18 17:57:41 -08003729 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003730 * Set the "ticker" text which is sent to accessibility services.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003731 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003732 * @see Notification#tickerText
Joe Onoratocb109a02011-01-18 17:57:41 -08003733 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003734 public Builder setTicker(CharSequence tickerText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003735 mN.tickerText = safeCharSequence(tickerText);
Joe Onorato46439ce2010-11-19 13:56:21 -08003736 return this;
3737 }
3738
Joe Onoratocb109a02011-01-18 17:57:41 -08003739 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003740 * Obsolete version of {@link #setTicker(CharSequence)}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003741 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003742 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003743 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003744 public Builder setTicker(CharSequence tickerText, RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003745 setTicker(tickerText);
3746 // views is ignored
Joe Onorato46439ce2010-11-19 13:56:21 -08003747 return this;
3748 }
3749
Joe Onoratocb109a02011-01-18 17:57:41 -08003750 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04003751 * Add a large icon to the notification content view.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003752 *
3753 * In the platform template, this image will be shown on the left of the notification view
Dan Sandlerd63f9322015-05-06 15:18:49 -04003754 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3755 * badge atop the large icon).
Dan Sandler08a04c12015-05-06 15:18:49 -04003756 */
Dan Sandlerd63f9322015-05-06 15:18:49 -04003757 public Builder setLargeIcon(Bitmap b) {
3758 return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
3759 }
3760
3761 /**
3762 * Add a large icon to the notification content view.
3763 *
3764 * In the platform template, this image will be shown on the left of the notification view
3765 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3766 * badge atop the large icon).
3767 */
3768 public Builder setLargeIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003769 mN.mLargeIcon = icon;
3770 mN.extras.putParcelable(EXTRA_LARGE_ICON, icon);
Joe Onorato46439ce2010-11-19 13:56:21 -08003771 return this;
3772 }
3773
Joe Onoratocb109a02011-01-18 17:57:41 -08003774 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003775 * Set the sound to play.
3776 *
John Spurlockc0650f022014-07-19 13:22:39 -04003777 * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes}
3778 * for notifications.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003779 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003780 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003781 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003782 @Deprecated
Joe Onorato52f80cd2010-11-21 15:34:48 -08003783 public Builder setSound(Uri sound) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003784 mN.sound = sound;
3785 mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
Joe Onorato52f80cd2010-11-21 15:34:48 -08003786 return this;
3787 }
3788
Joe Onoratocb109a02011-01-18 17:57:41 -08003789 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003790 * Set the sound to play, along with a specific stream on which to play it.
Joe Onoratocb109a02011-01-18 17:57:41 -08003791 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003792 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
3793 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003794 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003795 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -07003796 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003797 public Builder setSound(Uri sound, int streamType) {
Jean-Michel Trivi2f7511f2016-11-28 15:40:27 -08003798 PlayerBase.deprecateStreamTypeForPlayback(streamType, "Notification", "setSound()");
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003799 mN.sound = sound;
3800 mN.audioStreamType = streamType;
Joe Onorato46439ce2010-11-19 13:56:21 -08003801 return this;
3802 }
3803
Joe Onoratocb109a02011-01-18 17:57:41 -08003804 /**
John Spurlockc0650f022014-07-19 13:22:39 -04003805 * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to
3806 * use during playback.
3807 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003808 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
John Spurlockc0650f022014-07-19 13:22:39 -04003809 * @see Notification#sound
3810 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003811 @Deprecated
John Spurlockc0650f022014-07-19 13:22:39 -04003812 public Builder setSound(Uri sound, AudioAttributes audioAttributes) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003813 mN.sound = sound;
3814 mN.audioAttributes = audioAttributes;
John Spurlockc0650f022014-07-19 13:22:39 -04003815 return this;
3816 }
3817
3818 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003819 * Set the vibration pattern to use.
3820 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003821 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
3822 * <code>pattern</code> parameter.
3823 *
Chris Wren47c20a12014-06-18 17:27:29 -04003824 * <p>
3825 * A notification that vibrates is more likely to be presented as a heads-up notification.
3826 * </p>
3827 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003828 * @deprecated use {@link NotificationChannel#setVibrationPattern(long[])} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003829 * @see Notification#vibrate
Joe Onoratocb109a02011-01-18 17:57:41 -08003830 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003831 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003832 public Builder setVibrate(long[] pattern) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003833 mN.vibrate = pattern;
Joe Onorato46439ce2010-11-19 13:56:21 -08003834 return this;
3835 }
3836
Joe Onoratocb109a02011-01-18 17:57:41 -08003837 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003838 * Set the desired color for the indicator LED on the device, as well as the
3839 * blink duty cycle (specified in milliseconds).
3840 *
3841
3842 * Not all devices will honor all (or even any) of these values.
3843 *
Julia Reynolds529e3322017-02-06 08:33:01 -05003844 * @deprecated use {@link NotificationChannel#enableLights(boolean)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003845 * @see Notification#ledARGB
3846 * @see Notification#ledOnMS
3847 * @see Notification#ledOffMS
Joe Onoratocb109a02011-01-18 17:57:41 -08003848 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003849 @Deprecated
Tor Norbye80756e32015-03-02 09:39:27 -08003850 public Builder setLights(@ColorInt int argb, int onMs, int offMs) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003851 mN.ledARGB = argb;
3852 mN.ledOnMS = onMs;
3853 mN.ledOffMS = offMs;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05003854 if (onMs != 0 || offMs != 0) {
3855 mN.flags |= FLAG_SHOW_LIGHTS;
3856 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003857 return this;
3858 }
3859
Joe Onoratocb109a02011-01-18 17:57:41 -08003860 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003861 * Set whether this is an "ongoing" notification.
Joe Onoratocb109a02011-01-18 17:57:41 -08003862 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003863
3864 * Ongoing notifications cannot be dismissed by the user, so your application or service
3865 * must take care of canceling them.
3866 *
3867
3868 * They are typically used to indicate a background task that the user is actively engaged
3869 * with (e.g., playing music) or is pending in some way and therefore occupying the device
3870 * (e.g., a file download, sync operation, active network connection).
3871 *
3872
3873 * @see Notification#FLAG_ONGOING_EVENT
3874 * @see Service#setForeground(boolean)
Joe Onoratocb109a02011-01-18 17:57:41 -08003875 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003876 public Builder setOngoing(boolean ongoing) {
3877 setFlag(FLAG_ONGOING_EVENT, ongoing);
3878 return this;
3879 }
3880
Joe Onoratocb109a02011-01-18 17:57:41 -08003881 /**
Selim Cinek7b9605b2017-01-19 17:36:00 -08003882 * Set whether this notification should be colorized. When set, the color set with
3883 * {@link #setColor(int)} will be used as the background color of this notification.
3884 * <p>
Selim Cinek7b9605b2017-01-19 17:36:00 -08003885 * This should only be used for high priority ongoing tasks like navigation, an ongoing
3886 * call, or other similarly high-priority events for the user.
Selim Cinek99104832017-01-25 14:47:33 -08003887 * <p>
Selim Cinek22714f12017-04-13 16:23:53 -07003888 * For most styles, the coloring will only be applied if the notification is for a
3889 * foreground service notification.
Selim Cinek99104832017-01-25 14:47:33 -08003890 * However, for {@link MediaStyle} and {@link DecoratedMediaCustomViewStyle} notifications
Selim Cinek22714f12017-04-13 16:23:53 -07003891 * that have a media session attached there is no such requirement.
Selim Cinek7b9605b2017-01-19 17:36:00 -08003892 *
Selim Cinek7b9605b2017-01-19 17:36:00 -08003893 * @see Builder#setColor(int)
Selim Cinek99104832017-01-25 14:47:33 -08003894 * @see MediaStyle#setMediaSession(MediaSession.Token)
Selim Cinek7b9605b2017-01-19 17:36:00 -08003895 */
3896 public Builder setColorized(boolean colorize) {
3897 mN.extras.putBoolean(EXTRA_COLORIZED, colorize);
3898 return this;
3899 }
3900
3901 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003902 * Set this flag if you would only like the sound, vibrate
3903 * and ticker to be played if the notification is not already showing.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003904 *
3905 * @see Notification#FLAG_ONLY_ALERT_ONCE
Joe Onoratocb109a02011-01-18 17:57:41 -08003906 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003907 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
3908 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
3909 return this;
3910 }
3911
Joe Onoratocb109a02011-01-18 17:57:41 -08003912 /**
Julia Reynolds04499532016-09-13 14:04:53 -04003913 * Make this notification automatically dismissed when the user touches it.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003914 *
3915 * @see Notification#FLAG_AUTO_CANCEL
Joe Onoratocb109a02011-01-18 17:57:41 -08003916 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003917 public Builder setAutoCancel(boolean autoCancel) {
Joe Onorato281d83f2011-01-04 17:13:10 -08003918 setFlag(FLAG_AUTO_CANCEL, autoCancel);
Joe Onorato46439ce2010-11-19 13:56:21 -08003919 return this;
3920 }
3921
Joe Onoratocb109a02011-01-18 17:57:41 -08003922 /**
Griff Hazendfcb0802014-02-11 12:00:00 -08003923 * Set whether or not this notification should not bridge to other devices.
3924 *
3925 * <p>Some notifications can be bridged to other devices for remote display.
3926 * This hint can be set to recommend this notification not be bridged.
3927 */
3928 public Builder setLocalOnly(boolean localOnly) {
3929 setFlag(FLAG_LOCAL_ONLY, localOnly);
3930 return this;
3931 }
3932
3933 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003934 * Set which notification properties will be inherited from system defaults.
Joe Onoratocb109a02011-01-18 17:57:41 -08003935 * <p>
3936 * The value should be one or more of the following fields combined with
3937 * bitwise-or:
3938 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
3939 * <p>
3940 * For all default values, use {@link #DEFAULT_ALL}.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003941 *
3942 * @deprecated use {@link NotificationChannel#enableVibration(boolean)} and
Julia Reynolds529e3322017-02-06 08:33:01 -05003943 * {@link NotificationChannel#enableLights(boolean)} and
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003944 * {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003945 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003946 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003947 public Builder setDefaults(int defaults) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003948 mN.defaults = defaults;
Joe Onorato46439ce2010-11-19 13:56:21 -08003949 return this;
3950 }
3951
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003952 /**
3953 * Set the priority of this notification.
3954 *
3955 * @see Notification#priority
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003956 * @deprecated use {@link NotificationChannel#setImportance(int)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003957 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003958 @Deprecated
Tor Norbyed9273d62013-05-30 15:59:53 -07003959 public Builder setPriority(@Priority int pri) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003960 mN.priority = pri;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003961 return this;
3962 }
Joe Malin8d40d042012-11-05 11:36:40 -08003963
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003964 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04003965 * Set the notification category.
Joe Malin8d40d042012-11-05 11:36:40 -08003966 *
John Spurlockfd7f1e02014-03-18 16:41:57 -04003967 * @see Notification#category
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003968 */
John Spurlockfd7f1e02014-03-18 16:41:57 -04003969 public Builder setCategory(String category) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003970 mN.category = category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003971 return this;
3972 }
3973
3974 /**
Chris Wrendde75302014-03-26 17:24:15 -04003975 * Add a person that is relevant to this notification.
3976 *
Chris Wrene6c48932014-09-29 17:19:27 -04003977 * <P>
3978 * Depending on user preferences, this annotation may allow the notification to pass
Julia Reynoldse071abd2017-03-22 10:52:11 -04003979 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3980 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3981 * appear more prominently in the user interface.
Chris Wrene6c48932014-09-29 17:19:27 -04003982 * </P>
3983 *
3984 * <P>
3985 * The person should be specified by the {@code String} representation of a
3986 * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
3987 * </P>
3988 *
3989 * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
3990 * URIs. The path part of these URIs must exist in the contacts database, in the
3991 * appropriate column, or the reference will be discarded as invalid. Telephone schema
3992 * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
Selim Cineke7238dd2017-12-14 17:48:32 -08003993 * It is also possible to provide a URI with the schema {@code name:} in order to uniquely
3994 * identify a person without an entry in the contacts database.
Chris Wrene6c48932014-09-29 17:19:27 -04003995 * </P>
3996 *
3997 * @param uri A URI for the person.
Chris Wrendde75302014-03-26 17:24:15 -04003998 * @see Notification#EXTRA_PEOPLE
Selim Cineke7238dd2017-12-14 17:48:32 -08003999 * @deprecated use {@link #addPerson(Person)}
Chris Wrendde75302014-03-26 17:24:15 -04004000 */
Chris Wrene6c48932014-09-29 17:19:27 -04004001 public Builder addPerson(String uri) {
Selim Cinek9acd6732018-03-23 16:39:02 -07004002 addPerson(new Person.Builder().setUri(uri).build());
Selim Cineke7238dd2017-12-14 17:48:32 -08004003 return this;
4004 }
4005
4006 /**
4007 * Add a person that is relevant to this notification.
4008 *
4009 * <P>
4010 * Depending on user preferences, this annotation may allow the notification to pass
4011 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
4012 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
4013 * appear more prominently in the user interface.
4014 * </P>
4015 *
4016 * <P>
4017 * A person should usually contain a uri in order to benefit from the ranking boost.
4018 * However, even if no uri is provided, it's beneficial to provide other people in the
4019 * notification, such that listeners and voice only devices can announce and handle them
4020 * properly.
4021 * </P>
4022 *
4023 * @param person the person to add.
4024 * @see Notification#EXTRA_PEOPLE_LIST
4025 */
4026 public Builder addPerson(Person person) {
4027 mPersonList.add(person);
Chris Wrendde75302014-03-26 17:24:15 -04004028 return this;
4029 }
4030
4031 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004032 * Set this notification to be part of a group of notifications sharing the same key.
4033 * Grouped notifications may display in a cluster or stack on devices which
4034 * support such rendering.
4035 *
4036 * <p>To make this notification the summary for its group, also call
4037 * {@link #setGroupSummary}. A sort order can be specified for group members by using
4038 * {@link #setSortKey}.
4039 * @param groupKey The group key of the group.
4040 * @return this object for method chaining
4041 */
4042 public Builder setGroup(String groupKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004043 mN.mGroupKey = groupKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004044 return this;
4045 }
4046
4047 /**
4048 * Set this notification to be the group summary for a group of notifications.
4049 * Grouped notifications may display in a cluster or stack on devices which
Julia Reynolds04499532016-09-13 14:04:53 -04004050 * support such rendering. If thereRequires a group key also be set using {@link #setGroup}.
4051 * The group summary may be suppressed if too few notifications are included in the group.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004052 * @param isGroupSummary Whether this notification should be a group summary.
4053 * @return this object for method chaining
4054 */
4055 public Builder setGroupSummary(boolean isGroupSummary) {
4056 setFlag(FLAG_GROUP_SUMMARY, isGroupSummary);
4057 return this;
4058 }
4059
4060 /**
4061 * Set a sort key that orders this notification among other notifications from the
4062 * same package. This can be useful if an external sort was already applied and an app
4063 * would like to preserve this. Notifications will be sorted lexicographically using this
4064 * value, although providing different priorities in addition to providing sort key may
4065 * cause this value to be ignored.
4066 *
4067 * <p>This sort key can also be used to order members of a notification group. See
Griff Hazen9e1379f2014-05-20 12:50:51 -07004068 * {@link #setGroup}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004069 *
4070 * @see String#compareTo(String)
4071 */
4072 public Builder setSortKey(String sortKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004073 mN.mSortKey = sortKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004074 return this;
4075 }
4076
4077 /**
Griff Hazen720042b2014-02-24 15:46:56 -08004078 * Merge additional metadata into this notification.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004079 *
Griff Hazen720042b2014-02-24 15:46:56 -08004080 * <p>Values within the Bundle will replace existing extras values in this Builder.
4081 *
4082 * @see Notification#extras
4083 */
Griff Hazen959591e2014-05-15 22:26:18 -07004084 public Builder addExtras(Bundle extras) {
4085 if (extras != null) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004086 mUserExtras.putAll(extras);
Griff Hazen720042b2014-02-24 15:46:56 -08004087 }
4088 return this;
4089 }
4090
4091 /**
4092 * Set metadata for this notification.
4093 *
4094 * <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 -04004095 * current contents are copied into the Notification each time {@link #build()} is
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004096 * called.
4097 *
Griff Hazen720042b2014-02-24 15:46:56 -08004098 * <p>Replaces any existing extras values with those from the provided Bundle.
4099 * Use {@link #addExtras} to merge in metadata instead.
4100 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004101 * @see Notification#extras
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004102 */
Griff Hazen959591e2014-05-15 22:26:18 -07004103 public Builder setExtras(Bundle extras) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004104 if (extras != null) {
4105 mUserExtras = extras;
4106 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004107 return this;
4108 }
4109
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004110 /**
Griff Hazen720042b2014-02-24 15:46:56 -08004111 * Get the current metadata Bundle used by this notification Builder.
4112 *
4113 * <p>The returned Bundle is shared with this Builder.
4114 *
4115 * <p>The current contents of this Bundle are copied into the Notification each time
4116 * {@link #build()} is called.
4117 *
4118 * @see Notification#extras
4119 */
4120 public Bundle getExtras() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004121 return mUserExtras;
4122 }
4123
4124 private Bundle getAllExtras() {
4125 final Bundle saveExtras = (Bundle) mUserExtras.clone();
4126 saveExtras.putAll(mN.extras);
4127 return saveExtras;
Griff Hazen720042b2014-02-24 15:46:56 -08004128 }
4129
4130 /**
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004131 * Add an action to this notification. Actions are typically displayed by
4132 * the system as a button adjacent to the notification content.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004133 * <p>
4134 * Every action must have an icon (32dp square and matching the
4135 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4136 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4137 * <p>
4138 * A notification in its expanded form can display up to 3 actions, from left to right in
4139 * the order they were added. Actions will not be displayed when the notification is
4140 * collapsed, however, so be sure that any essential functions may be accessed by the user
4141 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004142 *
4143 * @param icon Resource ID of a drawable that represents the action.
4144 * @param title Text describing the action.
4145 * @param intent PendingIntent to be fired when the action is invoked.
Dan Sandler86647982015-05-13 23:41:13 -04004146 *
4147 * @deprecated Use {@link #addAction(Action)} instead.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004148 */
Dan Sandler86647982015-05-13 23:41:13 -04004149 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004150 public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004151 mActions.add(new Action(icon, safeCharSequence(title), intent));
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004152 return this;
4153 }
4154
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004155 /**
Griff Hazen959591e2014-05-15 22:26:18 -07004156 * Add an action to this notification. Actions are typically displayed by
4157 * the system as a button adjacent to the notification content.
4158 * <p>
4159 * Every action must have an icon (32dp square and matching the
4160 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4161 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4162 * <p>
4163 * A notification in its expanded form can display up to 3 actions, from left to right in
4164 * the order they were added. Actions will not be displayed when the notification is
4165 * collapsed, however, so be sure that any essential functions may be accessed by the user
4166 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
4167 *
4168 * @param action The action to add.
4169 */
4170 public Builder addAction(Action action) {
liangweikang63b03b52017-03-16 19:22:15 +08004171 if (action != null) {
4172 mActions.add(action);
4173 }
Griff Hazen959591e2014-05-15 22:26:18 -07004174 return this;
4175 }
4176
4177 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004178 * Alter the complete list of actions attached to this notification.
4179 * @see #addAction(Action).
4180 *
4181 * @param actions
4182 * @return
4183 */
4184 public Builder setActions(Action... actions) {
4185 mActions.clear();
4186 for (int i = 0; i < actions.length; i++) {
liangweikang63b03b52017-03-16 19:22:15 +08004187 if (actions[i] != null) {
4188 mActions.add(actions[i]);
4189 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004190 }
4191 return this;
4192 }
4193
4194 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004195 * Add a rich notification style to be applied at build time.
4196 *
4197 * @param style Object responsible for modifying the notification style.
4198 */
4199 public Builder setStyle(Style style) {
4200 if (mStyle != style) {
4201 mStyle = style;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004202 if (mStyle != null) {
4203 mStyle.setBuilder(this);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004204 mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName());
4205 } else {
4206 mN.extras.remove(EXTRA_TEMPLATE);
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004207 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004208 }
4209 return this;
4210 }
4211
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004212 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05004213 * Returns the style set by {@link #setStyle(Style)}.
4214 */
4215 public Style getStyle() {
4216 return mStyle;
4217 }
4218
4219 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004220 * Specify the value of {@link #visibility}.
Griff Hazenb720abe2014-05-20 13:15:30 -07004221 *
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004222 * @return The same Builder.
4223 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004224 public Builder setVisibility(@Visibility int visibility) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004225 mN.visibility = visibility;
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004226 return this;
4227 }
4228
4229 /**
4230 * Supply a replacement Notification whose contents should be shown in insecure contexts
4231 * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}.
4232 * @param n A replacement notification, presumably with some or all info redacted.
4233 * @return The same Builder.
4234 */
4235 public Builder setPublicVersion(Notification n) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004236 if (n != null) {
4237 mN.publicVersion = new Notification();
4238 n.cloneInto(mN.publicVersion, /*heavy=*/ true);
4239 } else {
4240 mN.publicVersion = null;
4241 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004242 return this;
4243 }
4244
Griff Hazenb720abe2014-05-20 13:15:30 -07004245 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004246 * Apply an extender to this notification builder. Extenders may be used to add
4247 * metadata or change options on this builder.
4248 */
Griff Hazen61a9e862014-05-22 16:05:19 -07004249 public Builder extend(Extender extender) {
4250 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004251 return this;
4252 }
4253
Dan Sandler4e787062015-06-17 15:09:48 -04004254 /**
4255 * @hide
4256 */
Julia Reynoldse46bb372016-03-17 11:05:58 -04004257 public Builder setFlag(int mask, boolean value) {
Joe Onorato46439ce2010-11-19 13:56:21 -08004258 if (value) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004259 mN.flags |= mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004260 } else {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004261 mN.flags &= ~mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004262 }
Julia Reynoldse46bb372016-03-17 11:05:58 -04004263 return this;
Joe Onorato46439ce2010-11-19 13:56:21 -08004264 }
4265
Dan Sandler26e81cf2014-05-06 10:01:27 -04004266 /**
4267 * Sets {@link Notification#color}.
4268 *
4269 * @param argb The accent color to use
4270 *
4271 * @return The same Builder.
4272 */
Tor Norbye80756e32015-03-02 09:39:27 -08004273 public Builder setColor(@ColorInt int argb) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004274 mN.color = argb;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05004275 sanitizeColor();
Dan Sandler26e81cf2014-05-06 10:01:27 -04004276 return this;
4277 }
4278
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004279 private Drawable getProfileBadgeDrawable() {
Chris Wren66619a22016-05-12 16:42:37 -04004280 if (mContext.getUserId() == UserHandle.USER_SYSTEM) {
4281 // This user can never be a badged profile,
4282 // and also includes USER_ALL system notifications.
4283 return null;
4284 }
Christoph Studer7ac80e62014-08-04 16:01:57 +02004285 // Note: This assumes that the current user can read the profile badge of the
4286 // originating user.
Selim Cineke6ff9462016-01-15 15:07:06 -08004287 return mContext.getPackageManager().getUserBadgeForDensityNoBackground(
Julia Reynoldsda303542015-11-23 14:00:20 -05004288 new UserHandle(mContext.getUserId()), 0);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004289 }
4290
4291 private Bitmap getProfileBadge() {
4292 Drawable badge = getProfileBadgeDrawable();
Kenny Guy8a0101b2014-05-08 23:34:12 +01004293 if (badge == null) {
4294 return null;
4295 }
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004296 final int size = mContext.getResources().getDimensionPixelSize(
4297 R.dimen.notification_badge_size);
4298 Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004299 Canvas canvas = new Canvas(bitmap);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004300 badge.setBounds(0, 0, size, size);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004301 badge.draw(canvas);
4302 return bitmap;
4303 }
4304
Selim Cinekc848c3a2016-01-13 15:27:30 -08004305 private void bindProfileBadge(RemoteViews contentView) {
Kenny Guy98193ea2014-07-24 19:54:37 +01004306 Bitmap profileBadge = getProfileBadge();
4307
Kenny Guy98193ea2014-07-24 19:54:37 +01004308 if (profileBadge != null) {
Selim Cinekc848c3a2016-01-13 15:27:30 -08004309 contentView.setImageViewBitmap(R.id.profile_badge, profileBadge);
4310 contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004311 if (isColorized()) {
Sunny Goyal5b153922017-09-21 21:00:36 -07004312 contentView.setDrawableTint(R.id.profile_badge, false,
4313 getPrimaryTextColor(), PorterDuff.Mode.SRC_ATOP);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004314 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004315 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004316 }
4317
Julia Reynoldsfc640012018-02-21 12:25:27 -05004318 /**
4319 * @hide
4320 */
4321 public boolean usesStandardHeader() {
4322 if (mN.mUsesStandardHeader) {
4323 return true;
4324 }
4325 if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.N) {
4326 if (mN.contentView == null && mN.bigContentView == null) {
4327 return true;
4328 }
4329 }
4330 boolean contentViewUsesHeader = mN.contentView == null
4331 || STANDARD_LAYOUTS.contains(mN.contentView.getLayoutId());
4332 boolean bigContentViewUsesHeader = mN.bigContentView == null
4333 || STANDARD_LAYOUTS.contains(mN.bigContentView.getLayoutId());
4334 return contentViewUsesHeader && bigContentViewUsesHeader;
4335 }
4336
Christoph Studerfe718432014-09-01 18:21:18 +02004337 private void resetStandardTemplate(RemoteViews contentView) {
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004338 resetNotificationHeader(contentView);
Christoph Studerfe718432014-09-01 18:21:18 +02004339 contentView.setViewVisibility(R.id.right_icon, View.GONE);
Selim Cinek860b6da2015-12-16 19:02:19 -08004340 contentView.setViewVisibility(R.id.title, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004341 contentView.setTextViewText(R.id.title, null);
Selim Cinek41598732016-01-11 16:58:37 -08004342 contentView.setViewVisibility(R.id.text, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004343 contentView.setTextViewText(R.id.text, null);
Selim Cinek29603462015-11-17 19:04:39 -08004344 contentView.setViewVisibility(R.id.text_line_1, View.GONE);
Selim Cinek41598732016-01-11 16:58:37 -08004345 contentView.setTextViewText(R.id.text_line_1, null);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004346 }
4347
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004348 /**
4349 * Resets the notification header to its original state
4350 */
4351 private void resetNotificationHeader(RemoteViews contentView) {
Adrian Roosc4337a32016-08-02 18:30:34 -07004352 // Small icon doesn't need to be reset, as it's always set. Resetting would prevent
4353 // re-using the drawable when the notification is updated.
Selim Cinek7b836392015-12-04 20:02:59 -08004354 contentView.setBoolean(R.id.notification_header, "setExpanded", false);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004355 contentView.setTextViewText(R.id.app_name_text, null);
Christoph Studerca1db712014-09-10 17:31:33 +02004356 contentView.setViewVisibility(R.id.chronometer, View.GONE);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004357 contentView.setViewVisibility(R.id.header_text, View.GONE);
Adrian Roos9dfb78f2016-06-30 15:43:44 -07004358 contentView.setTextViewText(R.id.header_text, null);
Selim Cinekafeed292017-12-12 17:32:44 -08004359 contentView.setViewVisibility(R.id.header_text_secondary, View.GONE);
4360 contentView.setTextViewText(R.id.header_text_secondary, null);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004361 contentView.setViewVisibility(R.id.header_text_divider, View.GONE);
Selim Cinekafeed292017-12-12 17:32:44 -08004362 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004363 contentView.setViewVisibility(R.id.time_divider, View.GONE);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004364 contentView.setViewVisibility(R.id.time, View.GONE);
Selim Cinekc848c3a2016-01-13 15:27:30 -08004365 contentView.setImageViewIcon(R.id.profile_badge, null);
4366 contentView.setViewVisibility(R.id.profile_badge, View.GONE);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004367 mN.mUsesStandardHeader = false;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004368 }
4369
Selim Cinek384804b2018-04-18 14:31:07 +08004370 private RemoteViews applyStandardTemplate(int resId, TemplateBindResult result) {
4371 return applyStandardTemplate(resId, mParams.reset().fillTextsFrom(this),
4372 result);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004373 }
4374
4375 /**
4376 * @param hasProgress whether the progress bar should be shown and set
Selim Cinek384804b2018-04-18 14:31:07 +08004377 * @param result
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004378 */
Selim Cinek384804b2018-04-18 14:31:07 +08004379 private RemoteViews applyStandardTemplate(int resId, boolean hasProgress,
4380 TemplateBindResult result) {
Adrian Roos70d7aa32017-01-11 15:39:06 -08004381 return applyStandardTemplate(resId, mParams.reset().hasProgress(hasProgress)
Selim Cinek384804b2018-04-18 14:31:07 +08004382 .fillTextsFrom(this), result);
Adrian Roosc1a80b02016-04-05 14:54:55 -07004383 }
4384
Selim Cinek384804b2018-04-18 14:31:07 +08004385 private RemoteViews applyStandardTemplate(int resId, StandardTemplateParams p,
4386 TemplateBindResult result) {
Kenny Guy77320062014-08-27 21:37:15 +01004387 RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId);
Dan Sandler539aad42014-08-04 00:43:39 -04004388
Christoph Studerfe718432014-09-01 18:21:18 +02004389 resetStandardTemplate(contentView);
4390
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004391 final Bundle ex = mN.extras;
Selim Cinek7b9605b2017-01-19 17:36:00 -08004392 updateBackgroundColor(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004393 bindNotificationHeader(contentView, p.ambient, p.headerTextSecondary);
Selim Cinek384804b2018-04-18 14:31:07 +08004394 bindLargeIconAndReply(contentView, p, result);
Adrian Roos70d7aa32017-01-11 15:39:06 -08004395 boolean showProgress = handleProgressBar(p.hasProgress, contentView, ex);
4396 if (p.title != null) {
Selim Cinek860b6da2015-12-16 19:02:19 -08004397 contentView.setViewVisibility(R.id.title, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004398 contentView.setTextViewText(R.id.title, processTextSpans(p.title));
Adrian Roos72171622017-01-27 10:32:06 -08004399 if (!p.ambient) {
4400 setTextViewColorPrimary(contentView, R.id.title);
4401 }
Selim Cinek954cc232016-05-20 13:29:23 -07004402 contentView.setViewLayoutWidth(R.id.title, showProgress
4403 ? ViewGroup.LayoutParams.WRAP_CONTENT
4404 : ViewGroup.LayoutParams.MATCH_PARENT);
Joe Onorato561d3852010-11-20 18:09:34 -08004405 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08004406 if (p.text != null) {
Selim Cinek41598732016-01-11 16:58:37 -08004407 int textId = showProgress ? com.android.internal.R.id.text_line_1
4408 : com.android.internal.R.id.text;
Selim Cinek48f66b72017-08-18 16:17:51 -07004409 contentView.setTextViewText(textId, processTextSpans(p.text));
Adrian Roos72171622017-01-27 10:32:06 -08004410 if (!p.ambient) {
4411 setTextViewColorSecondary(contentView, textId);
4412 }
Selim Cinek41598732016-01-11 16:58:37 -08004413 contentView.setViewVisibility(textId, View.VISIBLE);
Joe Onorato561d3852010-11-20 18:09:34 -08004414 }
Selim Cinekc848c3a2016-01-13 15:27:30 -08004415
Selim Cinek279fa862016-06-14 10:57:25 -07004416 setContentMinHeight(contentView, showProgress || mN.hasLargeIcon());
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004417
Selim Cinek29603462015-11-17 19:04:39 -08004418 return contentView;
4419 }
4420
Selim Cinek48f66b72017-08-18 16:17:51 -07004421 private CharSequence processTextSpans(CharSequence text) {
4422 if (hasForegroundColor()) {
Selim Cinek87c31532017-08-18 18:53:44 -07004423 return NotificationColorUtil.clearColorSpans(text);
Selim Cinek48f66b72017-08-18 16:17:51 -07004424 }
4425 return text;
4426 }
4427
Selim Cinek7b9605b2017-01-19 17:36:00 -08004428 private void setTextViewColorPrimary(RemoteViews contentView, int id) {
4429 ensureColors();
4430 contentView.setTextColor(id, mPrimaryTextColor);
4431 }
4432
Selim Cinek48f66b72017-08-18 16:17:51 -07004433 private boolean hasForegroundColor() {
4434 return mForegroundColor != COLOR_INVALID;
4435 }
4436
Selim Cinek389edcd2017-05-11 19:16:44 -07004437 /**
4438 * @return the primary text color
4439 * @hide
4440 */
4441 @VisibleForTesting
4442 public int getPrimaryTextColor() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004443 ensureColors();
4444 return mPrimaryTextColor;
4445 }
4446
Selim Cinek389edcd2017-05-11 19:16:44 -07004447 /**
4448 * @return the secondary text color
4449 * @hide
4450 */
4451 @VisibleForTesting
4452 public int getSecondaryTextColor() {
4453 ensureColors();
4454 return mSecondaryTextColor;
4455 }
4456
Selim Cinek7b9605b2017-01-19 17:36:00 -08004457 private void setTextViewColorSecondary(RemoteViews contentView, int id) {
4458 ensureColors();
4459 contentView.setTextColor(id, mSecondaryTextColor);
4460 }
4461
4462 private void ensureColors() {
4463 int backgroundColor = getBackgroundColor();
4464 if (mPrimaryTextColor == COLOR_INVALID
4465 || mSecondaryTextColor == COLOR_INVALID
Selim Cinek7b9605b2017-01-19 17:36:00 -08004466 || mTextColorsAreForBackground != backgroundColor) {
4467 mTextColorsAreForBackground = backgroundColor;
Selim Cinek48f66b72017-08-18 16:17:51 -07004468 if (!hasForegroundColor() || !isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004469 mPrimaryTextColor = NotificationColorUtil.resolvePrimaryColor(mContext,
4470 backgroundColor);
4471 mSecondaryTextColor = NotificationColorUtil.resolveSecondaryColor(mContext,
4472 backgroundColor);
Selim Cinekc7f5a822018-03-20 19:32:06 -07004473 if (backgroundColor != COLOR_DEFAULT && isColorized()) {
Selim Cinekac5f0272017-05-02 16:05:41 -07004474 mPrimaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4475 mPrimaryTextColor, backgroundColor, 4.5);
4476 mSecondaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4477 mSecondaryTextColor, backgroundColor, 4.5);
4478 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07004479 } else {
4480 double backLum = NotificationColorUtil.calculateLuminance(backgroundColor);
4481 double textLum = NotificationColorUtil.calculateLuminance(mForegroundColor);
4482 double contrast = NotificationColorUtil.calculateContrast(mForegroundColor,
4483 backgroundColor);
Selim Cinek389edcd2017-05-11 19:16:44 -07004484 // We only respect the given colors if worst case Black or White still has
4485 // contrast
4486 boolean backgroundLight = backLum > textLum
4487 && satisfiesTextContrast(backgroundColor, Color.BLACK)
4488 || backLum <= textLum
4489 && !satisfiesTextContrast(backgroundColor, Color.WHITE);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004490 if (contrast < 4.5f) {
Selim Cinek389edcd2017-05-11 19:16:44 -07004491 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004492 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4493 mForegroundColor,
4494 backgroundColor,
4495 true /* findFG */,
4496 4.5f);
4497 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004498 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_LIGHT);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004499 } else {
4500 mSecondaryTextColor =
4501 NotificationColorUtil.findContrastColorAgainstDark(
4502 mForegroundColor,
4503 backgroundColor,
4504 true /* findFG */,
4505 4.5f);
4506 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004507 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004508 }
4509 } else {
4510 mPrimaryTextColor = mForegroundColor;
4511 mSecondaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004512 mPrimaryTextColor, backgroundLight ? LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4513 : LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004514 if (NotificationColorUtil.calculateContrast(mSecondaryTextColor,
4515 backgroundColor) < 4.5f) {
4516 // oh well the secondary is not good enough
Selim Cinek389edcd2017-05-11 19:16:44 -07004517 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004518 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4519 mSecondaryTextColor,
4520 backgroundColor,
4521 true /* findFG */,
4522 4.5f);
4523 } else {
4524 mSecondaryTextColor
4525 = NotificationColorUtil.findContrastColorAgainstDark(
4526 mSecondaryTextColor,
4527 backgroundColor,
4528 true /* findFG */,
4529 4.5f);
4530 }
4531 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004532 mSecondaryTextColor, backgroundLight
4533 ? -LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4534 : -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004535 }
4536 }
4537 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08004538 }
4539 }
4540
4541 private void updateBackgroundColor(RemoteViews contentView) {
4542 if (isColorized()) {
4543 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundColor",
4544 getBackgroundColor());
4545 } else {
4546 // Clear it!
4547 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundResource",
4548 0);
4549 }
4550 }
4551
Selim Cinek860b6da2015-12-16 19:02:19 -08004552 /**
4553 * @param remoteView the remote view to update the minheight in
4554 * @param hasMinHeight does it have a mimHeight
4555 * @hide
4556 */
4557 void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) {
4558 int minHeight = 0;
4559 if (hasMinHeight) {
4560 // we need to set the minHeight of the notification
4561 minHeight = mContext.getResources().getDimensionPixelSize(
4562 com.android.internal.R.dimen.notification_min_content_height);
4563 }
4564 remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight);
4565 }
4566
Selim Cinek29603462015-11-17 19:04:39 -08004567 private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004568 final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0);
4569 final int progress = ex.getInt(EXTRA_PROGRESS, 0);
4570 final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
4571 if (hasProgress && (max != 0 || ind)) {
Selim Cinek29603462015-11-17 19:04:39 -08004572 contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004573 contentView.setProgressBar(
Selim Cinek29603462015-11-17 19:04:39 -08004574 R.id.progress, max, progress, ind);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004575 contentView.setProgressBackgroundTintList(
4576 R.id.progress, ColorStateList.valueOf(mContext.getColor(
4577 R.color.notification_progress_background_color)));
Selim Cinek29603462015-11-17 19:04:39 -08004578 if (mN.color != COLOR_DEFAULT) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08004579 ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004580 contentView.setProgressTintList(R.id.progress, colorStateList);
4581 contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004582 }
Selim Cinek29603462015-11-17 19:04:39 -08004583 return true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004584 } else {
4585 contentView.setViewVisibility(R.id.progress, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004586 return false;
Jeff Sharkey1c400132011-08-05 14:50:13 -07004587 }
Joe Onorato561d3852010-11-20 18:09:34 -08004588 }
4589
Selim Cinek384804b2018-04-18 14:31:07 +08004590 private void bindLargeIconAndReply(RemoteViews contentView, StandardTemplateParams p,
4591 TemplateBindResult result) {
4592 boolean largeIconShown = bindLargeIcon(contentView, p.hideLargeIcon || p.ambient);
Selim Cinek1c72fa02018-04-23 18:00:54 +08004593 boolean replyIconShown = bindReplyIcon(contentView, p.hideReplyIcon || p.ambient);
Selim Cinek384804b2018-04-18 14:31:07 +08004594 contentView.setViewVisibility(R.id.right_icon_container,
Selim Cinek1c72fa02018-04-23 18:00:54 +08004595 largeIconShown || replyIconShown ? View.VISIBLE : View.GONE);
4596 int marginEnd = calculateMarginEnd(largeIconShown, replyIconShown);
4597 contentView.setViewLayoutMarginEnd(R.id.line1, marginEnd);
4598 contentView.setViewLayoutMarginEnd(R.id.text, marginEnd);
4599 contentView.setViewLayoutMarginEnd(R.id.progress, marginEnd);
Selim Cinek384804b2018-04-18 14:31:07 +08004600 if (result != null) {
Selim Cinek1c72fa02018-04-23 18:00:54 +08004601 result.setIconMarginEnd(marginEnd);
Selim Cinek384804b2018-04-18 14:31:07 +08004602 }
4603 }
4604
Selim Cinek1c72fa02018-04-23 18:00:54 +08004605 private int calculateMarginEnd(boolean largeIconShown, boolean replyIconShown) {
4606 int marginEnd = 0;
4607 int contentMargin = mContext.getResources().getDimensionPixelSize(
4608 R.dimen.notification_content_margin_end);
4609 int iconSize = mContext.getResources().getDimensionPixelSize(
4610 R.dimen.notification_right_icon_size);
4611 if (replyIconShown) {
4612 // The size of the reply icon
4613 marginEnd += iconSize;
4614
4615 int replyInset = mContext.getResources().getDimensionPixelSize(
4616 R.dimen.notification_reply_inset);
4617 // We're subtracting the inset of the reply icon to make sure it's
4618 // aligned nicely on the right, and remove it from the following padding
4619 marginEnd -= replyInset * 2;
4620 }
4621 if (largeIconShown) {
4622 // adding size of the right icon
4623 marginEnd += iconSize;
4624
4625 if (replyIconShown) {
4626 // We also add some padding to the reply icon if it's around
4627 marginEnd += contentMargin;
4628 }
4629 }
4630 if (replyIconShown || largeIconShown) {
4631 // The padding to the content
4632 marginEnd += contentMargin;
4633 }
4634 return marginEnd;
4635 }
4636
Selim Cinek384804b2018-04-18 14:31:07 +08004637 /**
4638 * Bind the large icon.
4639 * @return if the largeIcon is visible
4640 */
4641 private boolean bindLargeIcon(RemoteViews contentView, boolean hideLargeIcon) {
Selim Cinek279fa862016-06-14 10:57:25 -07004642 if (mN.mLargeIcon == null && mN.largeIcon != null) {
4643 mN.mLargeIcon = Icon.createWithBitmap(mN.largeIcon);
4644 }
Selim Cinek88188f22017-09-19 16:46:56 -07004645 boolean showLargeIcon = mN.mLargeIcon != null && !hideLargeIcon;
4646 if (showLargeIcon) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004647 contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4648 contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon);
4649 processLargeLegacyIcon(mN.mLargeIcon, contentView);
Selim Cinek88188f22017-09-19 16:46:56 -07004650 }
Selim Cinek384804b2018-04-18 14:31:07 +08004651 return showLargeIcon;
4652 }
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004653
Selim Cinek384804b2018-04-18 14:31:07 +08004654 /**
4655 * Bind the reply icon.
4656 * @return if the reply icon is visible
4657 */
4658 private boolean bindReplyIcon(RemoteViews contentView, boolean hideReplyIcon) {
4659 boolean actionVisible = !hideReplyIcon;
4660 Action action = null;
Selim Cinek88188f22017-09-19 16:46:56 -07004661 if (actionVisible) {
Selim Cinek384804b2018-04-18 14:31:07 +08004662 action = findReplyAction();
4663 actionVisible = action != null;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004664 }
Selim Cinek384804b2018-04-18 14:31:07 +08004665 if (actionVisible) {
4666 contentView.setViewVisibility(R.id.reply_icon_action, View.VISIBLE);
4667 contentView.setDrawableTint(R.id.reply_icon_action,
4668 false /* targetBackground */,
Selim Cinek4717d862018-04-19 09:19:15 +08004669 getNeutralColor(),
Selim Cinek384804b2018-04-18 14:31:07 +08004670 PorterDuff.Mode.SRC_ATOP);
4671 contentView.setOnClickPendingIntent(R.id.reply_icon_action, action.actionIntent);
4672 contentView.setRemoteInputs(R.id.reply_icon_action, action.mRemoteInputs);
4673 } else {
4674 contentView.setRemoteInputs(R.id.reply_icon_action, null);
4675 }
4676 contentView.setViewVisibility(R.id.reply_icon_action,
4677 actionVisible ? View.VISIBLE : View.GONE);
4678 return actionVisible;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004679 }
4680
4681 private Action findReplyAction() {
4682 ArrayList<Action> actions = mActions;
4683 if (mOriginalActions != null) {
4684 actions = mOriginalActions;
4685 }
4686 int numActions = actions.size();
4687 for (int i = 0; i < numActions; i++) {
4688 Action action = actions.get(i);
4689 if (hasValidRemoteInput(action)) {
4690 return action;
4691 }
4692 }
4693 return null;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004694 }
4695
Selim Cinekafeed292017-12-12 17:32:44 -08004696 private void bindNotificationHeader(RemoteViews contentView, boolean ambient,
4697 CharSequence secondaryHeaderText) {
Adrian Roos487374f2017-01-11 15:48:14 -08004698 bindSmallIcon(contentView, ambient);
4699 bindHeaderAppName(contentView, ambient);
4700 if (!ambient) {
4701 // Ambient view does not have these
4702 bindHeaderText(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004703 bindHeaderTextSecondary(contentView, secondaryHeaderText);
Adrian Roos487374f2017-01-11 15:48:14 -08004704 bindHeaderChronometerAndTime(contentView);
Adrian Roos487374f2017-01-11 15:48:14 -08004705 bindProfileBadge(contentView);
4706 }
Julia Reynolds6013e5c2018-04-18 08:43:34 -04004707 bindActivePermissions(contentView, ambient);
Adrian Roosd83e9992017-03-16 15:17:57 -07004708 bindExpandButton(contentView);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004709 mN.mUsesStandardHeader = true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004710 }
4711
Julia Reynolds6013e5c2018-04-18 08:43:34 -04004712 private void bindActivePermissions(RemoteViews contentView, boolean ambient) {
Selim Cinek4717d862018-04-19 09:19:15 +08004713 int color = ambient ? resolveAmbientColor() : getNeutralColor();
Julia Reynoldsb887b232018-04-10 16:38:08 -04004714 contentView.setDrawableTint(R.id.camera, false, color, PorterDuff.Mode.SRC_ATOP);
4715 contentView.setDrawableTint(R.id.mic, false, color, PorterDuff.Mode.SRC_ATOP);
4716 contentView.setDrawableTint(R.id.overlay, false, color, PorterDuff.Mode.SRC_ATOP);
4717 }
4718
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004719 private void bindExpandButton(RemoteViews contentView) {
Selim Cinekc7f5a822018-03-20 19:32:06 -07004720 int color = isColorized() ? getPrimaryTextColor() : getSecondaryTextColor();
Sunny Goyal5b153922017-09-21 21:00:36 -07004721 contentView.setDrawableTint(R.id.expand_button, false, color,
4722 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08004723 contentView.setInt(R.id.notification_header, "setOriginalNotificationColor",
Selim Cinek7b9605b2017-01-19 17:36:00 -08004724 color);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004725 }
4726
4727 private void bindHeaderChronometerAndTime(RemoteViews contentView) {
4728 if (showsTimeOrChronometer()) {
Selim Cinek29603462015-11-17 19:04:39 -08004729 contentView.setViewVisibility(R.id.time_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004730 setTextViewColorSecondary(contentView, R.id.time_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004731 if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) {
4732 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
4733 contentView.setLong(R.id.chronometer, "setBase",
4734 mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
4735 contentView.setBoolean(R.id.chronometer, "setStarted", true);
Adrian Roos96b7e202016-05-17 13:50:38 -07004736 boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN);
Selim Cinekc3b752e2016-04-20 16:13:59 -07004737 contentView.setChronometerCountDown(R.id.chronometer, countsDown);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004738 setTextViewColorSecondary(contentView, R.id.chronometer);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004739 } else {
4740 contentView.setViewVisibility(R.id.time, View.VISIBLE);
4741 contentView.setLong(R.id.time, "setTime", mN.when);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004742 setTextViewColorSecondary(contentView, R.id.time);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004743 }
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004744 } else {
4745 // We still want a time to be set but gone, such that we can show and hide it
4746 // on demand in case it's a child notification without anything in the header
4747 contentView.setLong(R.id.time, "setTime", mN.when != 0 ? mN.when : mN.creationTime);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004748 }
4749 }
4750
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004751 private void bindHeaderText(RemoteViews contentView) {
4752 CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
4753 if (headerText == null && mStyle != null && mStyle.mSummaryTextSet
Selim Cinek03d0d652015-11-13 13:18:09 -05004754 && mStyle.hasSummaryInHeader()) {
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004755 headerText = mStyle.mSummaryText;
Selim Cinek03d0d652015-11-13 13:18:09 -05004756 }
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004757 if (headerText == null
4758 && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
4759 && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) {
4760 headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT);
4761 }
4762 if (headerText != null) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004763 // TODO: Remove the span entirely to only have the string with propper formating.
Selim Cinek48f66b72017-08-18 16:17:51 -07004764 contentView.setTextViewText(R.id.header_text, processTextSpans(
4765 processLegacyText(headerText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004766 setTextViewColorSecondary(contentView, R.id.header_text);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004767 contentView.setViewVisibility(R.id.header_text, View.VISIBLE);
4768 contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004769 setTextViewColorSecondary(contentView, R.id.header_text_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004770 }
4771 }
4772
Selim Cinekafeed292017-12-12 17:32:44 -08004773 private void bindHeaderTextSecondary(RemoteViews contentView, CharSequence secondaryText) {
4774 if (!TextUtils.isEmpty(secondaryText)) {
4775 contentView.setTextViewText(R.id.header_text_secondary, processTextSpans(
4776 processLegacyText(secondaryText)));
4777 setTextViewColorSecondary(contentView, R.id.header_text_secondary);
4778 contentView.setViewVisibility(R.id.header_text_secondary, View.VISIBLE);
4779 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.VISIBLE);
4780 setTextViewColorSecondary(contentView, R.id.header_text_secondary_divider);
4781 }
4782 }
4783
Adrian Rooseba05822016-04-22 17:09:27 -07004784 /**
4785 * @hide
4786 */
4787 public String loadHeaderAppName() {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004788 CharSequence name = null;
4789 final PackageManager pm = mContext.getPackageManager();
4790 if (mN.extras.containsKey(EXTRA_SUBSTITUTE_APP_NAME)) {
4791 // only system packages which lump together a bunch of unrelated stuff
4792 // may substitute a different name to make the purpose of the
4793 // notification more clear. the correct package label should always
4794 // be accessible via SystemUI.
4795 final String pkg = mContext.getPackageName();
4796 final String subName = mN.extras.getString(EXTRA_SUBSTITUTE_APP_NAME);
4797 if (PackageManager.PERMISSION_GRANTED == pm.checkPermission(
4798 android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME, pkg)) {
4799 name = subName;
4800 } else {
4801 Log.w(TAG, "warning: pkg "
4802 + pkg + " attempting to substitute app name '" + subName
4803 + "' without holding perm "
4804 + android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME);
4805 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004806 }
Dan Sandler732bd6c2016-04-12 14:20:32 -04004807 if (TextUtils.isEmpty(name)) {
4808 name = pm.getApplicationLabel(mContext.getApplicationInfo());
4809 }
4810 if (TextUtils.isEmpty(name)) {
4811 // still nothing?
4812 return null;
4813 }
4814
4815 return String.valueOf(name);
4816 }
Adrian Roos487374f2017-01-11 15:48:14 -08004817 private void bindHeaderAppName(RemoteViews contentView, boolean ambient) {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004818 contentView.setTextViewText(R.id.app_name_text, loadHeaderAppName());
Adrian Roos72171622017-01-27 10:32:06 -08004819 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004820 setTextViewColorPrimary(contentView, R.id.app_name_text);
4821 } else {
4822 contentView.setTextColor(R.id.app_name_text,
Selim Cinekc7f5a822018-03-20 19:32:06 -07004823 ambient ? resolveAmbientColor() : getSecondaryTextColor());
Selim Cinek7b9605b2017-01-19 17:36:00 -08004824 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004825 }
4826
Adrian Roos487374f2017-01-11 15:48:14 -08004827 private void bindSmallIcon(RemoteViews contentView, boolean ambient) {
Selim Cinek279fa862016-06-14 10:57:25 -07004828 if (mN.mSmallIcon == null && mN.icon != 0) {
4829 mN.mSmallIcon = Icon.createWithResource(mContext, mN.icon);
4830 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004831 contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon);
Sunny Goyal5b153922017-09-21 21:00:36 -07004832 contentView.setInt(R.id.icon, "setImageLevel", mN.iconLevel);
Adrian Roos487374f2017-01-11 15:48:14 -08004833 processSmallIconColor(mN.mSmallIcon, contentView, ambient);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004834 }
4835
Jorim Jaggi445d3c02014-08-19 22:33:42 +02004836 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004837 * @return true if the built notification will show the time or the chronometer; false
4838 * otherwise
4839 */
4840 private boolean showsTimeOrChronometer() {
Selim Cinekc2c0b042016-05-18 17:13:46 -07004841 return mN.showsTime() || mN.showsChronometer();
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004842 }
4843
Christoph Studerfe718432014-09-01 18:21:18 +02004844 private void resetStandardTemplateWithActions(RemoteViews big) {
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004845 // actions_container is only reset when there are no actions to avoid focus issues with
4846 // remote inputs.
Christoph Studerfe718432014-09-01 18:21:18 +02004847 big.setViewVisibility(R.id.actions, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004848 big.removeAllViews(R.id.actions);
Adrian Roose458aa82015-12-08 16:17:19 -08004849
4850 big.setViewVisibility(R.id.notification_material_reply_container, View.GONE);
4851 big.setTextViewText(R.id.notification_material_reply_text_1, null);
Kenny Guya0f6de82018-04-06 16:20:16 +01004852 big.setViewVisibility(R.id.notification_material_reply_text_1_container, View.GONE);
4853 big.setViewVisibility(R.id.notification_material_reply_progress, View.GONE);
Adrian Roose458aa82015-12-08 16:17:19 -08004854
4855 big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE);
4856 big.setTextViewText(R.id.notification_material_reply_text_2, null);
4857 big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE);
4858 big.setTextViewText(R.id.notification_material_reply_text_3, null);
Adrian Roosf852a422016-06-03 13:33:43 -07004859
Selim Cineked64a142018-02-06 18:06:01 -08004860 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target,
4861 R.dimen.notification_content_margin);
Christoph Studerfe718432014-09-01 18:21:18 +02004862 }
4863
Selim Cinek384804b2018-04-18 14:31:07 +08004864 private RemoteViews applyStandardTemplateWithActions(int layoutId,
4865 TemplateBindResult result) {
4866 return applyStandardTemplateWithActions(layoutId, mParams.reset().fillTextsFrom(this),
4867 result);
Adrian Roos48d746a2016-04-12 14:57:28 -07004868 }
4869
Adrian Roos70d7aa32017-01-11 15:39:06 -08004870 private RemoteViews applyStandardTemplateWithActions(int layoutId,
Selim Cinek384804b2018-04-18 14:31:07 +08004871 StandardTemplateParams p, TemplateBindResult result) {
4872 RemoteViews big = applyStandardTemplate(layoutId, p, result);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004873
Christoph Studerfe718432014-09-01 18:21:18 +02004874 resetStandardTemplateWithActions(big);
4875
Adrian Roose458aa82015-12-08 16:17:19 -08004876 boolean validRemoteInput = false;
4877
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004878 int N = mActions.size();
Adrian Roos487374f2017-01-11 15:48:14 -08004879 boolean emphazisedMode = mN.fullScreenIntent != null && !p.ambient;
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004880 big.setBoolean(R.id.actions, "setEmphasizedMode", emphazisedMode);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004881 if (N > 0) {
Adrian Roos7052de52016-03-03 15:53:34 -08004882 big.setViewVisibility(R.id.actions_container, View.VISIBLE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004883 big.setViewVisibility(R.id.actions, View.VISIBLE);
Selim Cineked64a142018-02-06 18:06:01 -08004884 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, 0);
Daniel Sandler8680bf82012-05-15 16:52:52 -04004885 if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004886 for (int i=0; i<N; i++) {
Adrian Roose458aa82015-12-08 16:17:19 -08004887 Action action = mActions.get(i);
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004888 boolean actionHasValidInput = hasValidRemoteInput(action);
4889 validRemoteInput |= actionHasValidInput;
Adrian Roose458aa82015-12-08 16:17:19 -08004890
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004891 final RemoteViews button = generateActionButton(action, emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07004892 p.ambient);
4893 if (actionHasValidInput && !emphazisedMode) {
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004894 // Clear the drawable
4895 button.setInt(R.id.action0, "setBackgroundResource", 0);
4896 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004897 big.addView(R.id.actions, button);
4898 }
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004899 } else {
4900 big.setViewVisibility(R.id.actions_container, View.GONE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004901 }
Adrian Roose458aa82015-12-08 16:17:19 -08004902
4903 CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
Adrian Roos487374f2017-01-11 15:48:14 -08004904 if (!p.ambient && validRemoteInput && replyText != null
Adrian Roose458aa82015-12-08 16:17:19 -08004905 && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])) {
Kenny Guya0f6de82018-04-06 16:20:16 +01004906 boolean showSpinner = mN.extras.getBoolean(EXTRA_SHOW_REMOTE_INPUT_SPINNER);
Adrian Roose458aa82015-12-08 16:17:19 -08004907 big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE);
Kenny Guya0f6de82018-04-06 16:20:16 +01004908 big.setViewVisibility(R.id.notification_material_reply_text_1_container,
4909 View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004910 big.setTextViewText(R.id.notification_material_reply_text_1,
4911 processTextSpans(replyText[0]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004912 setTextViewColorSecondary(big, R.id.notification_material_reply_text_1);
Kenny Guya0f6de82018-04-06 16:20:16 +01004913 big.setViewVisibility(R.id.notification_material_reply_progress,
4914 showSpinner ? View.VISIBLE : View.GONE);
4915 big.setProgressIndeterminateTintList(
4916 R.id.notification_material_reply_progress,
4917 ColorStateList.valueOf(
4918 isColorized() ? getPrimaryTextColor() : resolveContrastColor()));
Adrian Roose458aa82015-12-08 16:17:19 -08004919
4920 if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])) {
4921 big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004922 big.setTextViewText(R.id.notification_material_reply_text_2,
4923 processTextSpans(replyText[1]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004924 setTextViewColorSecondary(big, R.id.notification_material_reply_text_2);
Adrian Roose458aa82015-12-08 16:17:19 -08004925
4926 if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])) {
4927 big.setViewVisibility(
4928 R.id.notification_material_reply_text_3, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004929 big.setTextViewText(R.id.notification_material_reply_text_3,
4930 processTextSpans(replyText[2]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004931 setTextViewColorSecondary(big, R.id.notification_material_reply_text_3);
Adrian Roose458aa82015-12-08 16:17:19 -08004932 }
4933 }
4934 }
4935
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004936 return big;
4937 }
4938
Adrian Roose458aa82015-12-08 16:17:19 -08004939 private boolean hasValidRemoteInput(Action action) {
4940 if (TextUtils.isEmpty(action.title) || action.actionIntent == null) {
4941 // Weird actions
4942 return false;
4943 }
4944
4945 RemoteInput[] remoteInputs = action.getRemoteInputs();
4946 if (remoteInputs == null) {
4947 return false;
4948 }
4949
4950 for (RemoteInput r : remoteInputs) {
4951 CharSequence[] choices = r.getChoices();
4952 if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) {
4953 return true;
4954 }
4955 }
4956 return false;
4957 }
4958
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004959 /**
4960 * Construct a RemoteViews for the final 1U notification layout. In order:
4961 * 1. Custom contentView from the caller
4962 * 2. Style's proposed content view
4963 * 3. Standard template view
4964 */
Julia Reynolds3b848122016-02-26 10:45:32 -05004965 public RemoteViews createContentView() {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004966 return createContentView(false /* increasedheight */ );
4967 }
4968
4969 /**
4970 * Construct a RemoteViews for the smaller content view.
4971 *
4972 * @param increasedHeight true if this layout be created with an increased height. Some
4973 * styles may support showing more then just that basic 1U size
4974 * and the system may decide to render important notifications
4975 * slightly bigger even when collapsed.
4976 *
4977 * @hide
4978 */
4979 public RemoteViews createContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07004980 if (mN.contentView != null && useExistingRemoteView()) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004981 return mN.contentView;
4982 } else if (mStyle != null) {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004983 final RemoteViews styleView = mStyle.makeContentView(increasedHeight);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004984 if (styleView != null) {
4985 return styleView;
4986 }
Joe Onorato46439ce2010-11-19 13:56:21 -08004987 }
Selim Cinek384804b2018-04-18 14:31:07 +08004988 return applyStandardTemplate(getBaseLayoutResource(), null /* result */);
Joe Onorato46439ce2010-11-19 13:56:21 -08004989 }
4990
Selim Cineka7679b62017-05-10 16:33:25 -07004991 private boolean useExistingRemoteView() {
4992 return mStyle == null || (!mStyle.displayCustomViewInline()
4993 && !mRebuildStyledRemoteViews);
4994 }
4995
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004996 /**
4997 * Construct a RemoteViews for the final big notification layout.
4998 */
Julia Reynolds3b848122016-02-26 10:45:32 -05004999 public RemoteViews createBigContentView() {
Selim Cinek850a8542015-11-11 11:48:36 -05005000 RemoteViews result = null;
Selim Cineka7679b62017-05-10 16:33:25 -07005001 if (mN.bigContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05005002 return mN.bigContentView;
5003 } else if (mStyle != null) {
Selim Cinek850a8542015-11-11 11:48:36 -05005004 result = mStyle.makeBigContentView();
Selim Cinek90dcf6d2015-11-18 20:24:13 -08005005 hideLine1Text(result);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005006 } else if (mActions.size() != 0) {
Selim Cinek384804b2018-04-18 14:31:07 +08005007 result = applyStandardTemplateWithActions(getBigBaseLayoutResource(),
5008 null /* result */);
Selim Cinek850a8542015-11-11 11:48:36 -05005009 }
Selim Cinek6743c0b2017-01-18 18:24:01 -08005010 makeHeaderExpanded(result);
Selim Cinek850a8542015-11-11 11:48:36 -05005011 return result;
5012 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005013
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005014 /**
Selim Cinek414ad332017-02-24 19:06:12 -08005015 * Construct a RemoteViews for the final notification header only. This will not be
5016 * colorized.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005017 *
Adrian Roos6f6e1592017-05-02 16:22:53 -07005018 * @param ambient if true, generate the header for the ambient display layout.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005019 * @hide
5020 */
Adrian Roos6f6e1592017-05-02 16:22:53 -07005021 public RemoteViews makeNotificationHeader(boolean ambient) {
Selim Cinek414ad332017-02-24 19:06:12 -08005022 Boolean colorized = (Boolean) mN.extras.get(EXTRA_COLORIZED);
5023 mN.extras.putBoolean(EXTRA_COLORIZED, false);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005024 RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(),
Adrian Roos6f6e1592017-05-02 16:22:53 -07005025 ambient ? R.layout.notification_template_ambient_header
5026 : R.layout.notification_template_header);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005027 resetNotificationHeader(header);
Selim Cinekafeed292017-12-12 17:32:44 -08005028 bindNotificationHeader(header, ambient, null);
Selim Cinek414ad332017-02-24 19:06:12 -08005029 if (colorized != null) {
5030 mN.extras.putBoolean(EXTRA_COLORIZED, colorized);
5031 } else {
5032 mN.extras.remove(EXTRA_COLORIZED);
5033 }
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005034 return header;
5035 }
5036
Adrian Roos487374f2017-01-11 15:48:14 -08005037 /**
5038 * Construct a RemoteViews for the ambient version of the notification.
5039 *
5040 * @hide
5041 */
5042 public RemoteViews makeAmbientNotification() {
5043 RemoteViews ambient = applyStandardTemplateWithActions(
5044 R.layout.notification_template_material_ambient,
Selim Cinek384804b2018-04-18 14:31:07 +08005045 mParams.reset().ambient(true).fillTextsFrom(this).hasProgress(false),
5046 null /* result */);
Adrian Roos487374f2017-01-11 15:48:14 -08005047 return ambient;
5048 }
5049
Selim Cinek29603462015-11-17 19:04:39 -08005050 private void hideLine1Text(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005051 if (result != null) {
5052 result.setViewVisibility(R.id.text_line_1, View.GONE);
5053 }
Selim Cinek29603462015-11-17 19:04:39 -08005054 }
5055
Selim Cinek6743c0b2017-01-18 18:24:01 -08005056 /**
5057 * Adapt the Notification header if this view is used as an expanded view.
5058 *
5059 * @hide
5060 */
5061 public static void makeHeaderExpanded(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005062 if (result != null) {
5063 result.setBoolean(R.id.notification_header, "setExpanded", true);
5064 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005065 }
5066
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005067 /**
5068 * Construct a RemoteViews for the final heads-up notification layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08005069 *
5070 * @param increasedHeight true if this layout be created with an increased height. Some
5071 * styles may support showing more then just that basic 1U size
5072 * and the system may decide to render important notifications
5073 * slightly bigger even when collapsed.
5074 *
5075 * @hide
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005076 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08005077 public RemoteViews createHeadsUpContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07005078 if (mN.headsUpContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05005079 return mN.headsUpContentView;
5080 } else if (mStyle != null) {
Selim Cinek87ed69b2017-02-09 15:59:43 -08005081 final RemoteViews styleView = mStyle.makeHeadsUpContentView(increasedHeight);
5082 if (styleView != null) {
5083 return styleView;
5084 }
Julia Reynolds089e3e42015-11-18 09:59:57 -05005085 } else if (mActions.size() == 0) {
5086 return null;
5087 }
5088
Selim Cinek384804b2018-04-18 14:31:07 +08005089 return applyStandardTemplateWithActions(getBigBaseLayoutResource(), null /* result */);
Chris Wren8fd39ec2014-02-27 17:43:26 -05005090 }
5091
Selim Cinek624c02db2015-12-14 21:00:02 -08005092 /**
Selim Cinek87ed69b2017-02-09 15:59:43 -08005093 * Construct a RemoteViews for the final heads-up notification layout.
5094 */
5095 public RemoteViews createHeadsUpContentView() {
5096 return createHeadsUpContentView(false /* useIncreasedHeight */);
5097 }
5098
5099 /**
Selim Cinek624c02db2015-12-14 21:00:02 -08005100 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
5101 *
5102 * @hide
5103 */
5104 public RemoteViews makePublicContentView() {
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005105 return makePublicView(false /* ambient */);
5106 }
5107
5108 /**
5109 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
5110 *
5111 * @hide
5112 */
5113 public RemoteViews makePublicAmbientNotification() {
5114 return makePublicView(true /* ambient */);
5115 }
5116
5117 private RemoteViews makePublicView(boolean ambient) {
Selim Cinek624c02db2015-12-14 21:00:02 -08005118 if (mN.publicVersion != null) {
5119 final Builder builder = recoverBuilder(mContext, mN.publicVersion);
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005120 return ambient ? builder.makeAmbientNotification() : builder.createContentView();
Selim Cinek624c02db2015-12-14 21:00:02 -08005121 }
5122 Bundle savedBundle = mN.extras;
5123 Style style = mStyle;
5124 mStyle = null;
5125 Icon largeIcon = mN.mLargeIcon;
5126 mN.mLargeIcon = null;
Selim Cinek279fa862016-06-14 10:57:25 -07005127 Bitmap largeIconLegacy = mN.largeIcon;
5128 mN.largeIcon = null;
Adrian Roosb19b06b2017-05-02 18:54:40 -07005129 ArrayList<Action> actions = mActions;
5130 mActions = new ArrayList<>();
Selim Cinek624c02db2015-12-14 21:00:02 -08005131 Bundle publicExtras = new Bundle();
5132 publicExtras.putBoolean(EXTRA_SHOW_WHEN,
5133 savedBundle.getBoolean(EXTRA_SHOW_WHEN));
5134 publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER,
5135 savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER));
Adrian Roos96b7e202016-05-17 13:50:38 -07005136 publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN,
5137 savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN));
Selim Cineked07b962018-04-30 14:39:35 -07005138 String appName = savedBundle.getString(EXTRA_SUBSTITUTE_APP_NAME);
5139 if (appName != null) {
5140 publicExtras.putString(EXTRA_SUBSTITUTE_APP_NAME, appName);
5141 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005142 mN.extras = publicExtras;
Selim Cinek499c20f2017-07-20 14:06:09 -07005143 RemoteViews view;
5144 if (ambient) {
5145 publicExtras.putCharSequence(EXTRA_TITLE,
5146 mContext.getString(com.android.internal.R.string.notification_hidden_text));
5147 view = makeAmbientNotification();
5148 } else{
5149 view = makeNotificationHeader(false /* ambient */);
5150 view.setBoolean(R.id.notification_header, "setExpandOnlyOnButton", true);
5151 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005152 mN.extras = savedBundle;
5153 mN.mLargeIcon = largeIcon;
Selim Cinek279fa862016-06-14 10:57:25 -07005154 mN.largeIcon = largeIconLegacy;
Adrian Roosb19b06b2017-05-02 18:54:40 -07005155 mActions = actions;
Selim Cinek624c02db2015-12-14 21:00:02 -08005156 mStyle = style;
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005157 return view;
Selim Cinek624c02db2015-12-14 21:00:02 -08005158 }
5159
Selim Cinek6743c0b2017-01-18 18:24:01 -08005160 /**
5161 * Construct a content view for the display when low - priority
5162 *
5163 * @param useRegularSubtext uses the normal subtext set if there is one available. Otherwise
5164 * a new subtext is created consisting of the content of the
5165 * notification.
5166 * @hide
5167 */
5168 public RemoteViews makeLowPriorityContentView(boolean useRegularSubtext) {
5169 int color = mN.color;
5170 mN.color = COLOR_DEFAULT;
5171 CharSequence summary = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
5172 if (!useRegularSubtext || TextUtils.isEmpty(summary)) {
5173 CharSequence newSummary = createSummaryText();
5174 if (!TextUtils.isEmpty(newSummary)) {
5175 mN.extras.putCharSequence(EXTRA_SUB_TEXT, newSummary);
5176 }
5177 }
Selim Cinek875ba9b2017-02-13 16:20:17 -08005178
Adrian Roos6f6e1592017-05-02 16:22:53 -07005179 RemoteViews header = makeNotificationHeader(false /* ambient */);
Selim Cinek1b554392017-02-28 17:22:49 -08005180 header.setBoolean(R.id.notification_header, "setAcceptAllTouches", true);
Selim Cinek6743c0b2017-01-18 18:24:01 -08005181 if (summary != null) {
5182 mN.extras.putCharSequence(EXTRA_SUB_TEXT, summary);
5183 } else {
5184 mN.extras.remove(EXTRA_SUB_TEXT);
5185 }
5186 mN.color = color;
5187 return header;
5188 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005189
Selim Cinek6743c0b2017-01-18 18:24:01 -08005190 private CharSequence createSummaryText() {
5191 CharSequence titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE);
5192 if (USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY) {
5193 return titleText;
5194 }
5195 SpannableStringBuilder summary = new SpannableStringBuilder();
5196 if (titleText == null) {
5197 titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE_BIG);
5198 }
5199 BidiFormatter bidi = BidiFormatter.getInstance();
5200 if (titleText != null) {
5201 summary.append(bidi.unicodeWrap(titleText));
5202 }
5203 CharSequence contentText = mN.extras.getCharSequence(Notification.EXTRA_TEXT);
5204 if (titleText != null && contentText != null) {
5205 summary.append(bidi.unicodeWrap(mContext.getText(
5206 R.string.notification_header_divider_symbol_with_spaces)));
5207 }
5208 if (contentText != null) {
5209 summary.append(bidi.unicodeWrap(contentText));
5210 }
5211 return summary;
5212 }
Chris Wren8fd39ec2014-02-27 17:43:26 -05005213
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005214 private RemoteViews generateActionButton(Action action, boolean emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07005215 boolean ambient) {
Daniel Sandler8680bf82012-05-15 16:52:52 -04005216 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07005217 RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(),
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005218 emphazisedMode ? getEmphasizedActionLayoutResource()
5219 : tombstone ? getActionTombstoneLayoutResource()
5220 : getActionLayoutResource());
Daniel Sandler8680bf82012-05-15 16:52:52 -04005221 if (!tombstone) {
Daniel Sandlere5518842012-05-10 16:20:40 -04005222 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
Daniel Sandlere5518842012-05-10 16:20:40 -04005223 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005224 button.setContentDescription(R.id.action0, action.title);
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005225 if (action.mRemoteInputs != null) {
5226 button.setRemoteInputs(R.id.action0, action.mRemoteInputs);
5227 }
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005228 if (emphazisedMode) {
Selim Cinek981962e2016-07-20 20:41:58 -07005229 // change the background bgColor
Selim Cinek981962e2016-07-20 20:41:58 -07005230 CharSequence title = action.title;
5231 ColorStateList[] outResultColor = null;
Selim Cinek396caca2018-04-10 17:46:46 -07005232 int background = resolveBackgroundColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005233 if (isLegacy()) {
Selim Cinek87c31532017-08-18 18:53:44 -07005234 title = NotificationColorUtil.clearColorSpans(title);
Selim Cinek981962e2016-07-20 20:41:58 -07005235 } else {
5236 outResultColor = new ColorStateList[1];
Selim Cinek396caca2018-04-10 17:46:46 -07005237 title = ensureColorSpanContrast(title, background, outResultColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005238 }
Selim Cinek48f66b72017-08-18 16:17:51 -07005239 button.setTextViewText(R.id.action0, processTextSpans(title));
Selim Cinek7b9605b2017-01-19 17:36:00 -08005240 setTextViewColorPrimary(button, R.id.action0);
Selim Cinek396caca2018-04-10 17:46:46 -07005241 int rippleColor;
5242 boolean hasColorOverride = outResultColor != null && outResultColor[0] != null;
5243 if (hasColorOverride) {
5244 // There's a span spanning the full text, let's take it and use it as the
5245 // background color
5246 background = outResultColor[0].getDefaultColor();
5247 int textColor = NotificationColorUtil.resolvePrimaryColor(mContext,
5248 background);
5249 button.setTextColor(R.id.action0, textColor);
5250 rippleColor = textColor;
Anthony Chenad4d1582017-04-10 16:07:58 -07005251 } else if (mN.color != COLOR_DEFAULT && !isColorized() && mTintActionButtons) {
Selim Cinek396caca2018-04-10 17:46:46 -07005252 rippleColor = resolveContrastColor();
5253 button.setTextColor(R.id.action0, rippleColor);
5254 } else {
5255 rippleColor = getPrimaryTextColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005256 }
Selim Cinek396caca2018-04-10 17:46:46 -07005257 // We only want about 20% alpha for the ripple
5258 rippleColor = (rippleColor & 0x00ffffff) | 0x33000000;
5259 button.setColorStateList(R.id.action0, "setRippleColor",
5260 ColorStateList.valueOf(rippleColor));
5261 button.setColorStateList(R.id.action0, "setButtonBackground",
5262 ColorStateList.valueOf(background));
5263 button.setBoolean(R.id.action0, "setHasStroke", !hasColorOverride);
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005264 } else {
Selim Cinek48f66b72017-08-18 16:17:51 -07005265 button.setTextViewText(R.id.action0, processTextSpans(
5266 processLegacyText(action.title)));
Adrian Roos72171622017-01-27 10:32:06 -08005267 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005268 setTextViewColorPrimary(button, R.id.action0);
Anthony Chenad4d1582017-04-10 16:07:58 -07005269 } else if (mN.color != COLOR_DEFAULT && mTintActionButtons) {
Adrian Roos487374f2017-01-11 15:48:14 -08005270 button.setTextColor(R.id.action0,
5271 ambient ? resolveAmbientColor() : resolveContrastColor());
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005272 }
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005273 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005274 return button;
5275 }
5276
Joe Onoratocb109a02011-01-18 17:57:41 -08005277 /**
Selim Cinek981962e2016-07-20 20:41:58 -07005278 * Ensures contrast on color spans against a background color. also returns the color of the
5279 * text if a span was found that spans over the whole text.
5280 *
5281 * @param charSequence the charSequence on which the spans are
5282 * @param background the background color to ensure the contrast against
5283 * @param outResultColor an array in which a color will be returned as the first element if
5284 * there exists a full length color span.
5285 * @return the contrasted charSequence
5286 */
5287 private CharSequence ensureColorSpanContrast(CharSequence charSequence, int background,
5288 ColorStateList[] outResultColor) {
5289 if (charSequence instanceof Spanned) {
5290 Spanned ss = (Spanned) charSequence;
5291 Object[] spans = ss.getSpans(0, ss.length(), Object.class);
5292 SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
5293 for (Object span : spans) {
5294 Object resultSpan = span;
5295 int spanStart = ss.getSpanStart(span);
5296 int spanEnd = ss.getSpanEnd(span);
5297 boolean fullLength = (spanEnd - spanStart) == charSequence.length();
5298 if (resultSpan instanceof CharacterStyle) {
5299 resultSpan = ((CharacterStyle) span).getUnderlying();
5300 }
5301 if (resultSpan instanceof TextAppearanceSpan) {
5302 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
5303 ColorStateList textColor = originalSpan.getTextColor();
5304 if (textColor != null) {
5305 int[] colors = textColor.getColors();
5306 int[] newColors = new int[colors.length];
5307 for (int i = 0; i < newColors.length; i++) {
5308 newColors[i] = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005309 colors[i], background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005310 }
5311 textColor = new ColorStateList(textColor.getStates().clone(),
5312 newColors);
Selim Cinek396caca2018-04-10 17:46:46 -07005313 if (fullLength) {
5314 outResultColor[0] = textColor;
5315 // Let's drop the color from the span
5316 textColor = null;
5317 }
Selim Cinek981962e2016-07-20 20:41:58 -07005318 resultSpan = new TextAppearanceSpan(
5319 originalSpan.getFamily(),
5320 originalSpan.getTextStyle(),
5321 originalSpan.getTextSize(),
5322 textColor,
5323 originalSpan.getLinkTextColor());
Selim Cinek981962e2016-07-20 20:41:58 -07005324 }
5325 } else if (resultSpan instanceof ForegroundColorSpan) {
5326 ForegroundColorSpan originalSpan = (ForegroundColorSpan) resultSpan;
5327 int foregroundColor = originalSpan.getForegroundColor();
5328 foregroundColor = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005329 foregroundColor, background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005330 if (fullLength) {
5331 outResultColor[0] = ColorStateList.valueOf(foregroundColor);
Selim Cinek396caca2018-04-10 17:46:46 -07005332 resultSpan = null;
5333 } else {
5334 resultSpan = new ForegroundColorSpan(foregroundColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005335 }
5336 } else {
5337 resultSpan = span;
5338 }
Selim Cinek396caca2018-04-10 17:46:46 -07005339 if (resultSpan != null) {
5340 builder.setSpan(resultSpan, spanStart, spanEnd, ss.getSpanFlags(span));
5341 }
Selim Cinek981962e2016-07-20 20:41:58 -07005342 }
5343 return builder;
5344 }
5345 return charSequence;
5346 }
5347
5348 /**
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005349 * @return Whether we are currently building a notification from a legacy (an app that
Alan Viverette3cb07a462014-06-06 14:19:53 -07005350 * doesn't create material notifications by itself) app.
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005351 */
5352 private boolean isLegacy() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005353 if (!mIsLegacyInitialized) {
5354 mIsLegacy = mContext.getApplicationInfo().targetSdkVersion
5355 < Build.VERSION_CODES.LOLLIPOP;
5356 mIsLegacyInitialized = true;
5357 }
5358 return mIsLegacy;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005359 }
5360
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005361 private CharSequence processLegacyText(CharSequence charSequence) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08005362 return processLegacyText(charSequence, false /* ambient */);
5363 }
5364
5365 private CharSequence processLegacyText(CharSequence charSequence, boolean ambient) {
5366 boolean isAlreadyLightText = isLegacy() || textColorsNeedInversion();
5367 boolean wantLightText = ambient;
5368 if (isAlreadyLightText != wantLightText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005369 return getColorUtil().invertCharSequenceColors(charSequence);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005370 } else {
5371 return charSequence;
5372 }
5373 }
5374
Dan Sandler26e81cf2014-05-06 10:01:27 -04005375 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005376 * Apply any necessariy colors to the small icon
Dan Sandler26e81cf2014-05-06 10:01:27 -04005377 */
Adrian Roos487374f2017-01-11 15:48:14 -08005378 private void processSmallIconColor(Icon smallIcon, RemoteViews contentView,
5379 boolean ambient) {
Selim Cinekea4bef72015-12-02 15:51:10 -08005380 boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon);
Selim Cinekc7f5a822018-03-20 19:32:06 -07005381 int color;
5382 if (ambient) {
5383 color = resolveAmbientColor();
5384 } else if (isColorized()) {
5385 color = getPrimaryTextColor();
5386 } else {
5387 color = resolveContrastColor();
5388 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005389 if (colorable) {
Sunny Goyal5b153922017-09-21 21:00:36 -07005390 contentView.setDrawableTint(R.id.icon, false, color,
5391 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08005392
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005393 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005394 contentView.setInt(R.id.notification_header, "setOriginalIconColor",
Adrian Roos487374f2017-01-11 15:48:14 -08005395 colorable ? color : NotificationHeaderView.NO_COLOR);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005396 }
5397
Dan Sandler26e81cf2014-05-06 10:01:27 -04005398 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005399 * Make the largeIcon dark if it's a fake smallIcon (that is,
Dan Sandler26e81cf2014-05-06 10:01:27 -04005400 * if it's grayscale).
5401 */
5402 // TODO: also check bounds, transparency, that sort of thing.
Dan Sandlerd63f9322015-05-06 15:18:49 -04005403 private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) {
5404 if (largeIcon != null && isLegacy()
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005405 && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005406 // resolve color will fall back to the default when legacy
Sunny Goyal5b153922017-09-21 21:00:36 -07005407 contentView.setDrawableTint(R.id.icon, false, resolveContrastColor(),
5408 PorterDuff.Mode.SRC_ATOP);
Jorim Jaggi92df1f22014-12-16 19:44:41 +01005409 }
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005410 }
5411
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05005412 private void sanitizeColor() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005413 if (mN.color != COLOR_DEFAULT) {
5414 mN.color |= 0xFF000000; // no alpha for custom colors
Jorim Jaggi74419312014-06-10 20:57:21 +02005415 }
Jorim Jaggi74419312014-06-10 20:57:21 +02005416 }
5417
Adrian Roos4ff3b122016-02-01 12:26:13 -08005418 int resolveContrastColor() {
5419 if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) {
5420 return mCachedContrastColor;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005421 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005422
Selim Cinekac5f0272017-05-02 16:05:41 -07005423 int color;
Selim Cinekc7f5a822018-03-20 19:32:06 -07005424 int background = mContext.getColor(
5425 com.android.internal.R.color.notification_material_background_color);
Selim Cinekac5f0272017-05-02 16:05:41 -07005426 if (mN.color == COLOR_DEFAULT) {
5427 ensureColors();
Selim Cinekc7f5a822018-03-20 19:32:06 -07005428 color = NotificationColorUtil.resolveDefaultColor(mContext, background);
Selim Cinekac5f0272017-05-02 16:05:41 -07005429 } else {
5430 color = NotificationColorUtil.resolveContrastColor(mContext, mN.color,
Anthony Chenad4d1582017-04-10 16:07:58 -07005431 background, mInNightMode);
Selim Cinekac5f0272017-05-02 16:05:41 -07005432 }
5433 if (Color.alpha(color) < 255) {
5434 // alpha doesn't go well for color filters, so let's blend it manually
5435 color = NotificationColorUtil.compositeColors(color, background);
5436 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005437 mCachedContrastColorIsFor = mN.color;
Selim Cinekac5f0272017-05-02 16:05:41 -07005438 return mCachedContrastColor = color;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005439 }
5440
Selim Cinek4717d862018-04-19 09:19:15 +08005441 int resolveNeutralColor() {
5442 if (mNeutralColor != COLOR_INVALID) {
5443 return mNeutralColor;
5444 }
5445 int background = mContext.getColor(
5446 com.android.internal.R.color.notification_material_background_color);
5447 mNeutralColor = NotificationColorUtil.resolveDefaultColor(mContext, background);
5448 if (Color.alpha(mNeutralColor) < 255) {
5449 // alpha doesn't go well for color filters, so let's blend it manually
5450 mNeutralColor = NotificationColorUtil.compositeColors(mNeutralColor, background);
5451 }
5452 return mNeutralColor;
5453 }
5454
Adrian Roos487374f2017-01-11 15:48:14 -08005455 int resolveAmbientColor() {
5456 if (mCachedAmbientColorIsFor == mN.color && mCachedAmbientColorIsFor != COLOR_INVALID) {
5457 return mCachedAmbientColor;
5458 }
5459 final int contrasted = NotificationColorUtil.resolveAmbientColor(mContext, mN.color);
5460
5461 mCachedAmbientColorIsFor = mN.color;
5462 return mCachedAmbientColor = contrasted;
5463 }
5464
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005465 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005466 * Apply the unstyled operations and return a new {@link Notification} object.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005467 * @hide
Joe Onoratocb109a02011-01-18 17:57:41 -08005468 */
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005469 public Notification buildUnstyled() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005470 if (mActions.size() > 0) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005471 mN.actions = new Action[mActions.size()];
5472 mActions.toArray(mN.actions);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005473 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005474 if (!mPersonList.isEmpty()) {
Selim Cineke7238dd2017-12-14 17:48:32 -08005475 mN.extras.putParcelableArrayList(EXTRA_PEOPLE_LIST, mPersonList);
Dan Sandler0bf2ed82013-12-21 23:33:41 -06005476 }
Selim Cinek247fa012016-02-18 09:50:48 -08005477 if (mN.bigContentView != null || mN.contentView != null
5478 || mN.headsUpContentView != null) {
5479 mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true);
5480 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005481 return mN;
Joe Onorato46439ce2010-11-19 13:56:21 -08005482 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005483
Julia Reynolds3b848122016-02-26 10:45:32 -05005484 /**
5485 * Creates a Builder from an existing notification so further changes can be made.
5486 * @param context The context for your application / activity.
5487 * @param n The notification to create a Builder from.
5488 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005489 public static Notification.Builder recoverBuilder(Context context, Notification n) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02005490 // Re-create notification context so we can access app resources.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005491 ApplicationInfo applicationInfo = n.extras.getParcelable(
5492 EXTRA_BUILDER_APPLICATION_INFO);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005493 Context builderContext;
Julia Reynoldsda303542015-11-23 14:00:20 -05005494 if (applicationInfo != null) {
5495 try {
5496 builderContext = context.createApplicationContext(applicationInfo,
5497 Context.CONTEXT_RESTRICTED);
5498 } catch (NameNotFoundException e) {
5499 Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found");
5500 builderContext = context; // try with our context
5501 }
5502 } else {
5503 builderContext = context; // try with given context
Christoph Studer4600f9b2014-07-22 22:44:43 +02005504 }
5505
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005506 return new Builder(builderContext, n);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005507 }
5508
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005509 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005510 * @deprecated Use {@link #build()} instead.
5511 */
5512 @Deprecated
5513 public Notification getNotification() {
5514 return build();
5515 }
5516
5517 /**
5518 * Combine all of the options that have been set and return a new {@link Notification}
5519 * object.
5520 */
5521 public Notification build() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005522 // first, add any extras from the calling code
5523 if (mUserExtras != null) {
5524 mN.extras = getAllExtras();
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07005525 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005526
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005527 mN.creationTime = System.currentTimeMillis();
5528
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005529 // lazy stuff from mContext; see comment in Builder(Context, Notification)
Julia Reynoldsda303542015-11-23 14:00:20 -05005530 Notification.addFieldsFromContext(mContext, mN);
Christoph Studer943aa672014-08-03 20:31:16 +02005531
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005532 buildUnstyled();
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005533
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005534 if (mStyle != null) {
Selim Cinekd0426622017-07-11 13:19:59 +02005535 mStyle.reduceImageSizes(mContext);
5536 mStyle.purgeResources();
Selim Cinek90343862018-02-01 11:07:11 -08005537 mStyle.validate(mContext);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005538 mStyle.buildStyled(mN);
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005539 }
Selim Cinekd0426622017-07-11 13:19:59 +02005540 mN.reduceImageSizes(mContext);
5541
Adrian Roos5081c0d2016-02-26 16:04:19 -08005542 if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
Selim Cineka7679b62017-05-10 16:33:25 -07005543 && (useExistingRemoteView())) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005544 if (mN.contentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005545 mN.contentView = createContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005546 mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT,
5547 mN.contentView.getSequenceNumber());
5548 }
5549 if (mN.bigContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005550 mN.bigContentView = createBigContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005551 if (mN.bigContentView != null) {
5552 mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT,
5553 mN.bigContentView.getSequenceNumber());
5554 }
5555 }
5556 if (mN.headsUpContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005557 mN.headsUpContentView = createHeadsUpContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005558 if (mN.headsUpContentView != null) {
5559 mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT,
5560 mN.headsUpContentView.getSequenceNumber());
5561 }
5562 }
5563 }
5564
Julia Reynolds4c0c2022016-02-02 15:11:59 -05005565 if ((mN.defaults & DEFAULT_LIGHTS) != 0) {
5566 mN.flags |= FLAG_SHOW_LIGHTS;
5567 }
5568
Adrian Roosfb921842017-10-26 14:49:56 +02005569 mN.allPendingIntents = null;
5570
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005571 return mN;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005572 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005573
5574 /**
5575 * Apply this Builder to an existing {@link Notification} object.
5576 *
5577 * @hide
5578 */
5579 public Notification buildInto(Notification n) {
Daniel Sandler1a497d32013-04-18 14:52:45 -04005580 build().cloneInto(n, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005581 return n;
5582 }
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005583
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005584 /**
Adrian Roos184bfe022016-03-03 13:41:44 -08005585 * Removes RemoteViews that were created for compatibility from {@param n}, if they did not
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005586 * change. Also removes extenders on low ram devices, as
5587 * {@link android.service.notification.NotificationListenerService} services are disabled.
Adrian Roos184bfe022016-03-03 13:41:44 -08005588 *
5589 * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}.
5590 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005591 * @hide
5592 */
Kristian Monsen30f59b22018-04-09 10:27:16 +02005593 public static Notification maybeCloneStrippedForDelivery(Notification n, boolean isLowRam,
5594 Context context) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005595 String templateClass = n.extras.getString(EXTRA_TEMPLATE);
Adrian Roos184bfe022016-03-03 13:41:44 -08005596
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005597 // Only strip views for known Styles because we won't know how to
5598 // re-create them otherwise.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005599 if (!isLowRam
5600 && !TextUtils.isEmpty(templateClass)
Adrian Roos184bfe022016-03-03 13:41:44 -08005601 && getNotificationStyleClass(templateClass) == null) {
5602 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005603 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005604
5605 // Only strip unmodified BuilderRemoteViews.
5606 boolean stripContentView = n.contentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005607 n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005608 n.contentView.getSequenceNumber();
5609 boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005610 n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005611 n.bigContentView.getSequenceNumber();
5612 boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005613 n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005614 n.headsUpContentView.getSequenceNumber();
5615
5616 // Nothing to do here, no need to clone.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005617 if (!isLowRam
5618 && !stripContentView && !stripBigContentView && !stripHeadsUpContentView) {
Adrian Roos184bfe022016-03-03 13:41:44 -08005619 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005620 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005621
5622 Notification clone = n.clone();
5623 if (stripContentView) {
5624 clone.contentView = null;
5625 clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT);
5626 }
5627 if (stripBigContentView) {
5628 clone.bigContentView = null;
5629 clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT);
5630 }
5631 if (stripHeadsUpContentView) {
5632 clone.headsUpContentView = null;
5633 clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT);
5634 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005635 if (isLowRam) {
Kristian Monsen30f59b22018-04-09 10:27:16 +02005636 String[] allowedServices = context.getResources().getStringArray(
5637 R.array.config_allowedManagedServicesOnLowRamDevices);
5638 if (allowedServices.length == 0) {
5639 clone.extras.remove(Notification.TvExtender.EXTRA_TV_EXTENDER);
5640 clone.extras.remove(WearableExtender.EXTRA_WEARABLE_EXTENSIONS);
5641 clone.extras.remove(CarExtender.EXTRA_CAR_EXTENDER);
5642 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005643 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005644 return clone;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005645 }
5646
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005647 private int getBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005648 return R.layout.notification_template_material_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005649 }
5650
5651 private int getBigBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005652 return R.layout.notification_template_material_big_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005653 }
5654
5655 private int getBigPictureLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005656 return R.layout.notification_template_material_big_picture;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005657 }
5658
5659 private int getBigTextLayoutResource() {
Jorim Jaggi445d3c02014-08-19 22:33:42 +02005660 return R.layout.notification_template_material_big_text;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005661 }
5662
5663 private int getInboxLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005664 return R.layout.notification_template_material_inbox;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005665 }
5666
Adrian Roosc1a80b02016-04-05 14:54:55 -07005667 private int getMessagingLayoutResource() {
5668 return R.layout.notification_template_material_messaging;
5669 }
5670
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005671 private int getActionLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005672 return R.layout.notification_material_action;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005673 }
5674
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005675 private int getEmphasizedActionLayoutResource() {
5676 return R.layout.notification_material_action_emphasized;
5677 }
5678
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005679 private int getActionTombstoneLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005680 return R.layout.notification_material_action_tombstone;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005681 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005682
5683 private int getBackgroundColor() {
5684 if (isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005685 return mBackgroundColor != COLOR_INVALID ? mBackgroundColor : mN.color;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005686 } else {
Selim Cinekc7f5a822018-03-20 19:32:06 -07005687 return COLOR_DEFAULT;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005688 }
5689 }
5690
Selim Cinek396caca2018-04-10 17:46:46 -07005691 /**
Selim Cinek4717d862018-04-19 09:19:15 +08005692 * Gets a neutral color that can be used for icons or similar that should not stand out.
5693 */
5694 private int getNeutralColor() {
5695 if (isColorized()) {
5696 return getSecondaryTextColor();
5697 } else {
5698 return resolveNeutralColor();
5699 }
5700 }
5701
5702 /**
Selim Cinek396caca2018-04-10 17:46:46 -07005703 * Same as getBackgroundColor but also resolved the default color to the background.
5704 */
5705 private int resolveBackgroundColor() {
5706 int backgroundColor = getBackgroundColor();
5707 if (backgroundColor == COLOR_DEFAULT) {
5708 backgroundColor = mContext.getColor(
5709 com.android.internal.R.color.notification_material_background_color);
5710 }
5711 return backgroundColor;
5712 }
5713
Selim Cinek7b9605b2017-01-19 17:36:00 -08005714 private boolean isColorized() {
5715 return mN.isColorized();
5716 }
Selim Cinek99104832017-01-25 14:47:33 -08005717
Anthony Chenad4d1582017-04-10 16:07:58 -07005718 private boolean shouldTintActionButtons() {
5719 return mTintActionButtons;
5720 }
5721
Selim Cinek99104832017-01-25 14:47:33 -08005722 private boolean textColorsNeedInversion() {
5723 if (mStyle == null || !MediaStyle.class.equals(mStyle.getClass())) {
5724 return false;
5725 }
5726 int targetSdkVersion = mContext.getApplicationInfo().targetSdkVersion;
5727 return targetSdkVersion > Build.VERSION_CODES.M
5728 && targetSdkVersion < Build.VERSION_CODES.O;
5729 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005730
5731 /**
5732 * Set a color palette to be used as the background and textColors
5733 *
5734 * @param backgroundColor the color to be used as the background
5735 * @param foregroundColor the color to be used as the foreground
5736 *
5737 * @hide
5738 */
5739 public void setColorPalette(int backgroundColor, int foregroundColor) {
5740 mBackgroundColor = backgroundColor;
5741 mForegroundColor = foregroundColor;
5742 mTextColorsAreForBackground = COLOR_INVALID;
5743 ensureColors();
5744 }
Selim Cinekac5f0272017-05-02 16:05:41 -07005745
5746 /**
Selim Cineka7679b62017-05-10 16:33:25 -07005747 * Forces all styled remoteViews to be built from scratch and not use any cached
5748 * RemoteViews.
5749 * This is needed for legacy apps that are baking in their remoteviews into the
5750 * notification.
5751 *
5752 * @hide
5753 */
5754 public void setRebuildStyledRemoteViews(boolean rebuild) {
5755 mRebuildStyledRemoteViews = rebuild;
5756 }
Selim Cinekaa9db1f2018-02-27 17:35:47 -08005757
5758 /**
5759 * Get the text that should be displayed in the statusBar when heads upped. This is
5760 * usually just the app name, but may be different depending on the style.
5761 *
5762 * @param publicMode If true, return a text that is safe to display in public.
5763 *
5764 * @hide
5765 */
5766 public CharSequence getHeadsUpStatusBarText(boolean publicMode) {
5767 if (mStyle != null && !publicMode) {
5768 CharSequence text = mStyle.getHeadsUpStatusBarText();
5769 if (!TextUtils.isEmpty(text)) {
5770 return text;
5771 }
5772 }
5773 return loadHeaderAppName();
5774 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005775 }
5776
5777 /**
Selim Cinekd0426622017-07-11 13:19:59 +02005778 * Reduces the image sizes to conform to a maximum allowed size. This also processes all custom
5779 * remote views.
5780 *
5781 * @hide
5782 */
5783 void reduceImageSizes(Context context) {
5784 if (extras.getBoolean(EXTRA_REDUCED_IMAGES)) {
5785 return;
5786 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005787 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02005788 if (mLargeIcon != null || largeIcon != null) {
5789 Resources resources = context.getResources();
5790 Class<? extends Style> style = getNotificationStyle();
Selim Cineka8cb1262017-08-15 16:53:44 -07005791 int maxWidth = resources.getDimensionPixelSize(isLowRam
5792 ? R.dimen.notification_right_icon_size_low_ram
5793 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02005794 int maxHeight = maxWidth;
5795 if (MediaStyle.class.equals(style)
5796 || DecoratedMediaCustomViewStyle.class.equals(style)) {
Selim Cineka8cb1262017-08-15 16:53:44 -07005797 maxHeight = resources.getDimensionPixelSize(isLowRam
5798 ? R.dimen.notification_media_image_max_height_low_ram
5799 : R.dimen.notification_media_image_max_height);
5800 maxWidth = resources.getDimensionPixelSize(isLowRam
5801 ? R.dimen.notification_media_image_max_width_low_ram
5802 : R.dimen.notification_media_image_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02005803 }
5804 if (mLargeIcon != null) {
5805 mLargeIcon.scaleDownIfNecessary(maxWidth, maxHeight);
5806 }
5807 if (largeIcon != null) {
5808 largeIcon = Icon.scaleDownIfNecessary(largeIcon, maxWidth, maxHeight);
5809 }
5810 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005811 reduceImageSizesForRemoteView(contentView, context, isLowRam);
5812 reduceImageSizesForRemoteView(headsUpContentView, context, isLowRam);
5813 reduceImageSizesForRemoteView(bigContentView, context, isLowRam);
Selim Cinekd0426622017-07-11 13:19:59 +02005814 extras.putBoolean(EXTRA_REDUCED_IMAGES, true);
5815 }
5816
Selim Cineka8cb1262017-08-15 16:53:44 -07005817 private void reduceImageSizesForRemoteView(RemoteViews remoteView, Context context,
5818 boolean isLowRam) {
Selim Cinekd0426622017-07-11 13:19:59 +02005819 if (remoteView != null) {
5820 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07005821 int maxWidth = resources.getDimensionPixelSize(isLowRam
5822 ? R.dimen.notification_custom_view_max_image_width_low_ram
5823 : R.dimen.notification_custom_view_max_image_width);
5824 int maxHeight = resources.getDimensionPixelSize(isLowRam
5825 ? R.dimen.notification_custom_view_max_image_height_low_ram
5826 : R.dimen.notification_custom_view_max_image_height);
Selim Cinekd0426622017-07-11 13:19:59 +02005827 remoteView.reduceImageSizes(maxWidth, maxHeight);
5828 }
5829 }
5830
5831 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005832 * @return whether this notification is a foreground service notification
Selim Cinek7b9605b2017-01-19 17:36:00 -08005833 */
Selim Cinek22714f12017-04-13 16:23:53 -07005834 private boolean isForegroundService() {
5835 return (flags & Notification.FLAG_FOREGROUND_SERVICE) != 0;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005836 }
5837
5838 /**
Selim Cinek99104832017-01-25 14:47:33 -08005839 * @return whether this notification has a media session attached
5840 * @hide
5841 */
5842 public boolean hasMediaSession() {
5843 return extras.getParcelable(Notification.EXTRA_MEDIA_SESSION) != null;
5844 }
5845
5846 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08005847 * @return the style class of this notification
5848 * @hide
5849 */
5850 public Class<? extends Notification.Style> getNotificationStyle() {
5851 String templateClass = extras.getString(Notification.EXTRA_TEMPLATE);
5852
5853 if (!TextUtils.isEmpty(templateClass)) {
5854 return Notification.getNotificationStyleClass(templateClass);
5855 }
5856 return null;
5857 }
5858
5859 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005860 * @return true if this notification is colorized.
Selim Cinek7b9605b2017-01-19 17:36:00 -08005861 *
5862 * @hide
5863 */
5864 public boolean isColorized() {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005865 if (isColorizedMedia()) {
5866 return true;
5867 }
Julia Reynolds4db59552017-06-30 13:34:01 -04005868 return extras.getBoolean(EXTRA_COLORIZED)
5869 && (hasColorizedPermission() || isForegroundService());
5870 }
5871
5872 /**
5873 * Returns whether an app can colorize due to the android.permission.USE_COLORIZED_NOTIFICATIONS
5874 * permission. The permission is checked when a notification is enqueued.
5875 */
5876 private boolean hasColorizedPermission() {
5877 return (flags & Notification.FLAG_CAN_COLORIZE) != 0;
Selim Cinek5fb73f82017-04-20 16:55:38 -07005878 }
5879
5880 /**
5881 * @return true if this notification is colorized and it is a media notification
5882 *
5883 * @hide
5884 */
5885 public boolean isColorizedMedia() {
Selim Cinek99104832017-01-25 14:47:33 -08005886 Class<? extends Style> style = getNotificationStyle();
5887 if (MediaStyle.class.equals(style)) {
5888 Boolean colorized = (Boolean) extras.get(EXTRA_COLORIZED);
5889 if ((colorized == null || colorized) && hasMediaSession()) {
5890 return true;
5891 }
5892 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5893 if (extras.getBoolean(EXTRA_COLORIZED) && hasMediaSession()) {
5894 return true;
5895 }
5896 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005897 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005898 }
5899
Selim Cinek0847acd2017-04-24 19:48:29 -07005900
5901 /**
5902 * @return true if this is a media notification
5903 *
5904 * @hide
5905 */
5906 public boolean isMediaNotification() {
5907 Class<? extends Style> style = getNotificationStyle();
5908 if (MediaStyle.class.equals(style)) {
5909 return true;
5910 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5911 return true;
5912 }
5913 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005914 }
5915
Selim Cinek279fa862016-06-14 10:57:25 -07005916 private boolean hasLargeIcon() {
5917 return mLargeIcon != null || largeIcon != null;
5918 }
5919
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005920 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005921 * @return true if the notification will show the time; false otherwise
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005922 * @hide
5923 */
Selim Cinekc2c0b042016-05-18 17:13:46 -07005924 public boolean showsTime() {
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005925 return when != 0 && extras.getBoolean(EXTRA_SHOW_WHEN);
5926 }
5927
5928 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005929 * @return true if the notification will show a chronometer; false otherwise
5930 * @hide
5931 */
5932 public boolean showsChronometer() {
5933 return when != 0 && extras.getBoolean(EXTRA_SHOW_CHRONOMETER);
5934 }
5935
5936 /**
Julia Reynolds7ca33072017-06-29 13:58:24 -04005937 * @removed
Julia Reynolds4a02afb2016-12-13 13:39:52 -05005938 */
5939 @SystemApi
5940 public static Class<? extends Style> getNotificationStyleClass(String templateClass) {
5941 Class<? extends Style>[] classes = new Class[] {
5942 BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class,
5943 DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class,
5944 MessagingStyle.class };
5945 for (Class<? extends Style> innerClass : classes) {
5946 if (templateClass.equals(innerClass.getName())) {
5947 return innerClass;
5948 }
5949 }
5950 return null;
5951 }
5952
5953 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005954 * An object that can apply a rich notification style to a {@link Notification.Builder}
5955 * object.
5956 */
Griff Hazendfcb0802014-02-11 12:00:00 -08005957 public static abstract class Style {
Chris Wrend6297db2012-05-03 16:20:13 -04005958 private CharSequence mBigContentTitle;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02005959
5960 /**
5961 * @hide
5962 */
5963 protected CharSequence mSummaryText = null;
5964
5965 /**
5966 * @hide
5967 */
5968 protected boolean mSummaryTextSet = false;
Chris Wrend6297db2012-05-03 16:20:13 -04005969
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005970 protected Builder mBuilder;
5971
Chris Wrend6297db2012-05-03 16:20:13 -04005972 /**
5973 * Overrides ContentTitle in the big form of the template.
5974 * This defaults to the value passed to setContentTitle().
5975 */
5976 protected void internalSetBigContentTitle(CharSequence title) {
5977 mBigContentTitle = title;
5978 }
5979
5980 /**
5981 * Set the first line of text after the detail section in the big form of the template.
5982 */
5983 protected void internalSetSummaryText(CharSequence cs) {
5984 mSummaryText = cs;
Daniel Sandler619738c2012-06-07 16:33:08 -04005985 mSummaryTextSet = true;
Chris Wrend6297db2012-05-03 16:20:13 -04005986 }
5987
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005988 public void setBuilder(Builder builder) {
5989 if (mBuilder != builder) {
5990 mBuilder = builder;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07005991 if (mBuilder != null) {
5992 mBuilder.setStyle(this);
5993 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005994 }
5995 }
5996
Chris Wrend6297db2012-05-03 16:20:13 -04005997 protected void checkBuilder() {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005998 if (mBuilder == null) {
5999 throw new IllegalArgumentException("Style requires a valid Builder object");
6000 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006001 }
Chris Wrend6297db2012-05-03 16:20:13 -04006002
6003 protected RemoteViews getStandardView(int layoutId) {
Selim Cinek384804b2018-04-18 14:31:07 +08006004 return getStandardView(layoutId, null);
6005 }
6006
6007 /**
6008 * Get the standard view for this style.
6009 *
6010 * @param layoutId The layout id to use
6011 * @param result The result where template bind information is saved.
6012 * @return A remoteView for this style.
6013 * @hide
6014 */
6015 protected RemoteViews getStandardView(int layoutId, TemplateBindResult result) {
Chris Wrend6297db2012-05-03 16:20:13 -04006016 checkBuilder();
6017
Christoph Studer4600f9b2014-07-22 22:44:43 +02006018 // Nasty.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006019 CharSequence oldBuilderContentTitle =
6020 mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE);
Chris Wrend6297db2012-05-03 16:20:13 -04006021 if (mBigContentTitle != null) {
6022 mBuilder.setContentTitle(mBigContentTitle);
6023 }
6024
Selim Cinek384804b2018-04-18 14:31:07 +08006025 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId, result);
Chris Wrend6297db2012-05-03 16:20:13 -04006026
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006027 mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006028
Chris Wrend6297db2012-05-03 16:20:13 -04006029 if (mBigContentTitle != null && mBigContentTitle.equals("")) {
6030 contentView.setViewVisibility(R.id.line1, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04006031 } else {
6032 contentView.setViewVisibility(R.id.line1, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04006033 }
6034
Chris Wrend6297db2012-05-03 16:20:13 -04006035 return contentView;
6036 }
6037
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006038 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08006039 * Construct a Style-specific RemoteViews for the collapsed notification layout.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006040 * The default implementation has nothing additional to add.
Selim Cinek7d1009b2017-01-25 15:28:28 -08006041 *
6042 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006043 * @hide
6044 */
Selim Cinek7d1009b2017-01-25 15:28:28 -08006045 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006046 return null;
6047 }
6048
6049 /**
6050 * Construct a Style-specific RemoteViews for the final big notification layout.
6051 * @hide
6052 */
6053 public RemoteViews makeBigContentView() {
6054 return null;
6055 }
6056
6057 /**
6058 * Construct a Style-specific RemoteViews for the final HUN layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08006059 *
6060 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006061 * @hide
6062 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08006063 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006064 return null;
6065 }
6066
6067 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006068 * Apply any style-specific extras to this notification before shipping it out.
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006069 * @hide
6070 */
6071 public void addExtras(Bundle extras) {
6072 if (mSummaryTextSet) {
6073 extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
6074 }
6075 if (mBigContentTitle != null) {
6076 extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
6077 }
Chris Wren91ad5632013-06-05 15:05:57 -04006078 extras.putString(EXTRA_TEMPLATE, this.getClass().getName());
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006079 }
6080
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006081 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006082 * Reconstruct the internal state of this Style object from extras.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006083 * @hide
6084 */
Christoph Studer4600f9b2014-07-22 22:44:43 +02006085 protected void restoreFromExtras(Bundle extras) {
6086 if (extras.containsKey(EXTRA_SUMMARY_TEXT)) {
6087 mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT);
6088 mSummaryTextSet = true;
6089 }
6090 if (extras.containsKey(EXTRA_TITLE_BIG)) {
6091 mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG);
6092 }
6093 }
6094
6095
6096 /**
6097 * @hide
6098 */
6099 public Notification buildStyled(Notification wip) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006100 addExtras(wip.extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006101 return wip;
6102 }
6103
Daniel Sandler0ec46202015-06-24 01:27:05 -04006104 /**
6105 * @hide
6106 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006107 public void purgeResources() {}
6108
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006109 /**
6110 * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is
6111 * attached to.
6112 *
6113 * @return the fully constructed Notification.
6114 */
6115 public Notification build() {
6116 checkBuilder();
6117 return mBuilder.build();
6118 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02006119
6120 /**
6121 * @hide
6122 * @return true if the style positions the progress bar on the second line; false if the
6123 * style hides the progress bar
6124 */
6125 protected boolean hasProgress() {
6126 return true;
6127 }
Selim Cinek03d0d652015-11-13 13:18:09 -05006128
6129 /**
6130 * @hide
6131 * @return Whether we should put the summary be put into the notification header
6132 */
6133 public boolean hasSummaryInHeader() {
6134 return true;
6135 }
Selim Cinek593610c2016-02-16 18:42:57 -08006136
6137 /**
6138 * @hide
6139 * @return Whether custom content views are displayed inline in the style
6140 */
6141 public boolean displayCustomViewInline() {
6142 return false;
6143 }
Selim Cinekd0426622017-07-11 13:19:59 +02006144
6145 /**
6146 * Reduces the image sizes contained in this style.
6147 *
6148 * @hide
6149 */
6150 public void reduceImageSizes(Context context) {
6151 }
Selim Cinek90343862018-02-01 11:07:11 -08006152
6153 /**
6154 * Validate that this style was properly composed. This is called at build time.
6155 * @hide
6156 */
6157 public void validate(Context context) {
6158 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05006159
6160 /**
6161 * @hide
6162 */
6163 public abstract boolean areNotificationsVisiblyDifferent(Style other);
Selim Cinekc7f5a822018-03-20 19:32:06 -07006164
Selim Cinekaa9db1f2018-02-27 17:35:47 -08006165 /**
6166 * @return the the text that should be displayed in the statusBar when heads-upped.
6167 * If {@code null} is returned, the default implementation will be used.
6168 *
6169 * @hide
6170 */
6171 public CharSequence getHeadsUpStatusBarText() {
6172 return null;
6173 }
Joe Onorato46439ce2010-11-19 13:56:21 -08006174 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006175
6176 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006177 * Helper class for generating large-format notifications that include a large image attachment.
Joe Malin8d40d042012-11-05 11:36:40 -08006178 *
Robert Ly91c5ce32014-06-08 15:37:00 -07006179 * Here's how you'd set the <code>BigPictureStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006180 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07006181 * Notification notif = new Notification.Builder(mContext)
6182 * .setContentTitle(&quot;New photo from &quot; + sender.toString())
6183 * .setContentText(subject)
6184 * .setSmallIcon(R.drawable.new_post)
6185 * .setLargeIcon(aBitmap)
6186 * .setStyle(new Notification.BigPictureStyle()
6187 * .bigPicture(aBigBitmap))
6188 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006189 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006190 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006191 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006192 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006193 public static class BigPictureStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006194 private Bitmap mPicture;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006195 private Icon mBigLargeIcon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006196 private boolean mBigLargeIconSet = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006197
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006198 public BigPictureStyle() {
6199 }
6200
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006201 /**
6202 * @deprecated use {@code BigPictureStyle()}.
6203 */
6204 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006205 public BigPictureStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006206 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006207 }
6208
Chris Wrend6297db2012-05-03 16:20:13 -04006209 /**
6210 * Overrides ContentTitle in the big form of the template.
6211 * This defaults to the value passed to setContentTitle().
6212 */
6213 public BigPictureStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006214 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006215 return this;
6216 }
6217
6218 /**
6219 * Set the first line of text after the detail section in the big form of the template.
6220 */
6221 public BigPictureStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006222 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006223 return this;
6224 }
6225
Chris Wren0bd664d2012-08-01 13:56:56 -04006226 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05006227 * @hide
6228 */
6229 public Bitmap getBigPicture() {
6230 return mPicture;
6231 }
6232
6233 /**
Chris Wren0bd664d2012-08-01 13:56:56 -04006234 * Provide the bitmap to be used as the payload for the BigPicture notification.
6235 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006236 public BigPictureStyle bigPicture(Bitmap b) {
6237 mPicture = b;
6238 return this;
6239 }
6240
Chris Wren3745a3d2012-05-22 15:11:52 -04006241 /**
Chris Wren3745a3d2012-05-22 15:11:52 -04006242 * Override the large icon when the big notification is shown.
6243 */
6244 public BigPictureStyle bigLargeIcon(Bitmap b) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04006245 return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
6246 }
6247
6248 /**
6249 * Override the large icon when the big notification is shown.
6250 */
6251 public BigPictureStyle bigLargeIcon(Icon icon) {
Chris Wren3745a3d2012-05-22 15:11:52 -04006252 mBigLargeIconSet = true;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006253 mBigLargeIcon = icon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006254 return this;
6255 }
6256
Riley Andrews0394a0c2015-11-03 23:36:52 -08006257 /** @hide */
6258 public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10);
6259
Daniel Sandler0ec46202015-06-24 01:27:05 -04006260 /**
6261 * @hide
6262 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006263 @Override
6264 public void purgeResources() {
6265 super.purgeResources();
Riley Andrews8cee7c12015-11-01 23:36:04 -08006266 if (mPicture != null &&
6267 mPicture.isMutable() &&
Riley Andrews0394a0c2015-11-03 23:36:52 -08006268 mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) {
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006269 mPicture = mPicture.createAshmemBitmap();
6270 }
6271 if (mBigLargeIcon != null) {
6272 mBigLargeIcon.convertToAshmem();
6273 }
6274 }
Christoph Studer5c510ee2014-12-15 16:32:27 +01006275
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006276 /**
6277 * @hide
6278 */
Selim Cinekd0426622017-07-11 13:19:59 +02006279 @Override
6280 public void reduceImageSizes(Context context) {
6281 super.reduceImageSizes(context);
6282 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07006283 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02006284 if (mPicture != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006285 int maxPictureWidth = resources.getDimensionPixelSize(isLowRam
6286 ? R.dimen.notification_big_picture_max_height_low_ram
6287 : R.dimen.notification_big_picture_max_height);
6288 int maxPictureHeight = resources.getDimensionPixelSize(isLowRam
6289 ? R.dimen.notification_big_picture_max_width_low_ram
6290 : R.dimen.notification_big_picture_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02006291 mPicture = Icon.scaleDownIfNecessary(mPicture, maxPictureWidth, maxPictureHeight);
6292 }
6293 if (mBigLargeIcon != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006294 int rightIconSize = resources.getDimensionPixelSize(isLowRam
6295 ? R.dimen.notification_right_icon_size_low_ram
6296 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02006297 mBigLargeIcon.scaleDownIfNecessary(rightIconSize, rightIconSize);
6298 }
6299 }
6300
6301 /**
6302 * @hide
6303 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006304 public RemoteViews makeBigContentView() {
6305 // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet
Christoph Studer5c510ee2014-12-15 16:32:27 +01006306 // This covers the following cases:
6307 // 1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006308 // mN.mLargeIcon
6309 // 2. !mBigLargeIconSet -> mN.mLargeIcon applies
Dan Sandlerd63f9322015-05-06 15:18:49 -04006310 Icon oldLargeIcon = null;
Selim Cineke99acb22016-08-04 12:55:48 -07006311 Bitmap largeIconLegacy = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006312 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006313 oldLargeIcon = mBuilder.mN.mLargeIcon;
6314 mBuilder.mN.mLargeIcon = mBigLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006315 // The legacy largeIcon might not allow us to clear the image, as it's taken in
6316 // replacement if the other one is null. Because we're restoring these legacy icons
6317 // for old listeners, this is in general non-null.
6318 largeIconLegacy = mBuilder.mN.largeIcon;
6319 mBuilder.mN.largeIcon = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006320 }
6321
Selim Cinek384804b2018-04-18 14:31:07 +08006322 RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource(),
6323 null /* result */);
Selim Cinek03d0d652015-11-13 13:18:09 -05006324 if (mSummaryTextSet) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006325 contentView.setTextViewText(R.id.text, mBuilder.processTextSpans(
6326 mBuilder.processLegacyText(mSummaryText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006327 mBuilder.setTextViewColorSecondary(contentView, R.id.text);
Selim Cinekc848c3a2016-01-13 15:27:30 -08006328 contentView.setViewVisibility(R.id.text, View.VISIBLE);
Selim Cinek03d0d652015-11-13 13:18:09 -05006329 }
Selim Cinek279fa862016-06-14 10:57:25 -07006330 mBuilder.setContentMinHeight(contentView, mBuilder.mN.hasLargeIcon());
Selim Cinek53e64a42015-11-16 10:40:56 -08006331
Christoph Studer5c510ee2014-12-15 16:32:27 +01006332 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006333 mBuilder.mN.mLargeIcon = oldLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006334 mBuilder.mN.largeIcon = largeIconLegacy;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006335 }
6336
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006337 contentView.setImageViewBitmap(R.id.big_picture, mPicture);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006338 return contentView;
6339 }
6340
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006341 /**
6342 * @hide
6343 */
6344 public void addExtras(Bundle extras) {
6345 super.addExtras(extras);
6346
6347 if (mBigLargeIconSet) {
6348 extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
6349 }
6350 extras.putParcelable(EXTRA_PICTURE, mPicture);
6351 }
6352
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006353 /**
6354 * @hide
6355 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006356 @Override
Christoph Studer4600f9b2014-07-22 22:44:43 +02006357 protected void restoreFromExtras(Bundle extras) {
6358 super.restoreFromExtras(extras);
6359
6360 if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) {
Christoph Studer5c510ee2014-12-15 16:32:27 +01006361 mBigLargeIconSet = true;
Christoph Studer4600f9b2014-07-22 22:44:43 +02006362 mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG);
Chris Wren3745a3d2012-05-22 15:11:52 -04006363 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02006364 mPicture = extras.getParcelable(EXTRA_PICTURE);
6365 }
Selim Cinek03d0d652015-11-13 13:18:09 -05006366
6367 /**
6368 * @hide
6369 */
6370 @Override
6371 public boolean hasSummaryInHeader() {
6372 return false;
6373 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05006374
6375 /**
6376 * @hide
6377 */
6378 @Override
6379 public boolean areNotificationsVisiblyDifferent(Style other) {
6380 if (other == null || getClass() != other.getClass()) {
6381 return true;
6382 }
6383 BigPictureStyle otherS = (BigPictureStyle) other;
6384 return !Objects.equals(getBigPicture(), otherS.getBigPicture());
6385 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006386 }
6387
6388 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006389 * Helper class for generating large-format notifications that include a lot of text.
Joe Malin8d40d042012-11-05 11:36:40 -08006390 *
Robert Ly91c5ce32014-06-08 15:37:00 -07006391 * Here's how you'd set the <code>BigTextStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006392 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07006393 * Notification notif = new Notification.Builder(mContext)
6394 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
6395 * .setContentText(subject)
6396 * .setSmallIcon(R.drawable.new_mail)
6397 * .setLargeIcon(aBitmap)
6398 * .setStyle(new Notification.BigTextStyle()
6399 * .bigText(aVeryLongString))
6400 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006401 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006402 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006403 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006404 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006405 public static class BigTextStyle extends Style {
Jorim Jaggi457a10d2014-09-08 16:18:23 +02006406
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006407 private CharSequence mBigText;
6408
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006409 public BigTextStyle() {
6410 }
6411
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006412 /**
6413 * @deprecated use {@code BigTextStyle()}.
6414 */
6415 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006416 public BigTextStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006417 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006418 }
6419
Chris Wrend6297db2012-05-03 16:20:13 -04006420 /**
6421 * Overrides ContentTitle in the big form of the template.
6422 * This defaults to the value passed to setContentTitle().
6423 */
6424 public BigTextStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006425 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006426 return this;
6427 }
6428
6429 /**
6430 * Set the first line of text after the detail section in the big form of the template.
6431 */
6432 public BigTextStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006433 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006434 return this;
6435 }
6436
Chris Wren0bd664d2012-08-01 13:56:56 -04006437 /**
6438 * Provide the longer text to be displayed in the big form of the
6439 * template in place of the content text.
6440 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006441 public BigTextStyle bigText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006442 mBigText = safeCharSequence(cs);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006443 return this;
6444 }
6445
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006446 /**
6447 * @hide
6448 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05006449 public CharSequence getBigText() {
6450 return mBigText;
6451 }
6452
6453 /**
6454 * @hide
6455 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006456 public void addExtras(Bundle extras) {
6457 super.addExtras(extras);
6458
Christoph Studer4600f9b2014-07-22 22:44:43 +02006459 extras.putCharSequence(EXTRA_BIG_TEXT, mBigText);
6460 }
6461
6462 /**
6463 * @hide
6464 */
6465 @Override
6466 protected void restoreFromExtras(Bundle extras) {
6467 super.restoreFromExtras(extras);
6468
6469 mBigText = extras.getCharSequence(EXTRA_BIG_TEXT);
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006470 }
6471
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006472 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08006473 * @param increasedHeight true if this layout be created with an increased height.
6474 *
6475 * @hide
6476 */
6477 @Override
6478 public RemoteViews makeContentView(boolean increasedHeight) {
6479 if (increasedHeight) {
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006480 mBuilder.mOriginalActions = mBuilder.mActions;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006481 mBuilder.mActions = new ArrayList<>();
6482 RemoteViews remoteViews = makeBigContentView();
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006483 mBuilder.mActions = mBuilder.mOriginalActions;
6484 mBuilder.mOriginalActions = null;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006485 return remoteViews;
6486 }
6487 return super.makeContentView(increasedHeight);
6488 }
6489
6490 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006491 * @hide
6492 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08006493 @Override
6494 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
6495 if (increasedHeight && mBuilder.mActions.size() > 0) {
6496 return makeBigContentView();
6497 }
6498 return super.makeHeadsUpContentView(increasedHeight);
6499 }
6500
6501 /**
6502 * @hide
6503 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006504 public RemoteViews makeBigContentView() {
Christoph Studer4600f9b2014-07-22 22:44:43 +02006505
6506 // Nasty
Selim Cinek75998782016-04-26 10:39:17 -07006507 CharSequence text = mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006508 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Daniel Sandler916ad912012-06-13 12:17:07 -04006509
Selim Cinek384804b2018-04-18 14:31:07 +08006510 TemplateBindResult result = new TemplateBindResult();
6511 RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource(), result);
Selim Cinek1c72fa02018-04-23 18:00:54 +08006512 contentView.setInt(R.id.big_text, "setImageEndMargin", result.getIconMarginEnd());
Joe Malin8d40d042012-11-05 11:36:40 -08006513
Selim Cinek75998782016-04-26 10:39:17 -07006514 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, text);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006515
Selim Cinek3a2c4b92015-12-17 17:01:17 -08006516 CharSequence bigTextText = mBuilder.processLegacyText(mBigText);
Selim Cinek75998782016-04-26 10:39:17 -07006517 if (TextUtils.isEmpty(bigTextText)) {
6518 // In case the bigtext is null / empty fall back to the normal text to avoid a weird
6519 // experience
6520 bigTextText = mBuilder.processLegacyText(text);
6521 }
Adrian Roosb1f427c2016-05-26 12:27:15 -07006522 applyBigTextContentView(mBuilder, contentView, bigTextText);
Selim Cinek4fb12d32015-11-19 18:10:48 -08006523
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006524 return contentView;
6525 }
6526
Julia Reynolds7217dc92018-03-07 12:12:09 -05006527 /**
6528 * @hide
6529 */
6530 @Override
6531 public boolean areNotificationsVisiblyDifferent(Style other) {
6532 if (other == null || getClass() != other.getClass()) {
6533 return true;
6534 }
6535 BigTextStyle newS = (BigTextStyle) other;
6536 return !Objects.equals(getBigText(), newS.getBigText());
6537 }
6538
Adrian Roosb1f427c2016-05-26 12:27:15 -07006539 static void applyBigTextContentView(Builder builder,
6540 RemoteViews contentView, CharSequence bigTextText) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006541 contentView.setTextViewText(R.id.big_text, builder.processTextSpans(bigTextText));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006542 builder.setTextViewColorSecondary(contentView, R.id.big_text);
Adrian Roosb1f427c2016-05-26 12:27:15 -07006543 contentView.setViewVisibility(R.id.big_text,
6544 TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE);
Selim Cinek279fa862016-06-14 10:57:25 -07006545 contentView.setBoolean(R.id.big_text, "setHasImage", builder.mN.hasLargeIcon());
Adrian Roosb1f427c2016-05-26 12:27:15 -07006546 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006547 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04006548
6549 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006550 * Helper class for generating large-format notifications that include multiple back-and-forth
6551 * messages of varying types between any number of people.
6552 *
6553 * <br>
6554 * If the platform does not provide large-format notifications, this method has no effect. The
6555 * user will always see the normal notification view.
6556 * <br>
6557 * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like
6558 * so:
6559 * <pre class="prettyprint">
6560 *
6561 * Notification noti = new Notification.Builder()
6562 * .setContentTitle(&quot;2 new messages wtih &quot; + sender.toString())
6563 * .setContentText(subject)
6564 * .setSmallIcon(R.drawable.new_message)
6565 * .setLargeIcon(aBitmap)
6566 * .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name))
6567 * .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender())
6568 * .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender()))
6569 * .build();
6570 * </pre>
6571 */
6572 public static class MessagingStyle extends Style {
6573
6574 /**
6575 * The maximum number of messages that will be retained in the Notification itself (the
6576 * number displayed is up to the platform).
6577 */
6578 public static final int MAXIMUM_RETAINED_MESSAGES = 25;
6579
Selim Cinekcb8b9852017-12-15 18:01:52 -08006580 @NonNull Person mUser;
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006581 @Nullable CharSequence mConversationTitle;
Alex Hillsd9b04d92016-04-11 16:38:16 -04006582 List<Message> mMessages = new ArrayList<>();
Adrian Roos437cd562017-01-18 15:47:03 -08006583 List<Message> mHistoricMessages = new ArrayList<>();
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006584 boolean mIsGroupConversation;
Alex Hillsfc737de2016-03-23 17:33:02 -04006585
6586 MessagingStyle() {
6587 }
6588
6589 /**
Alex Hillsfd590442016-10-07 09:52:44 -04006590 * @param userDisplayName Required - the name to be displayed for any replies sent by the
6591 * user before the posting app reposts the notification with those messages after they've
6592 * been actually sent and in previous messages sent by the user added in
Alex Hillsfc737de2016-03-23 17:33:02 -04006593 * {@link #addMessage(Notification.MessagingStyle.Message)}
Selim Cinekcb8b9852017-12-15 18:01:52 -08006594 *
6595 * @deprecated use {@code MessagingStyle(Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006596 */
Alex Hillsfd590442016-10-07 09:52:44 -04006597 public MessagingStyle(@NonNull CharSequence userDisplayName) {
Selim Cinek9acd6732018-03-23 16:39:02 -07006598 this(new Person.Builder().setName(userDisplayName).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006599 }
6600
6601 /**
6602 * @param user Required - The person displayed for any messages that are sent by the
6603 * user. Any messages added with {@link #addMessage(Notification.MessagingStyle.Message)}
6604 * who don't have a Person associated with it will be displayed as if they were sent
Selim Cinek90343862018-02-01 11:07:11 -08006605 * by this user. The user also needs to have a valid name associated with it, which will
6606 * be enforced starting in Android P.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006607 */
6608 public MessagingStyle(@NonNull Person user) {
6609 mUser = user;
Selim Cinek90343862018-02-01 11:07:11 -08006610 }
6611
6612 /**
6613 * Validate that this style was properly composed. This is called at build time.
6614 * @hide
6615 */
6616 @Override
6617 public void validate(Context context) {
6618 super.validate(context);
6619 if (context.getApplicationInfo().targetSdkVersion
6620 >= Build.VERSION_CODES.P && (mUser == null || mUser.getName() == null)) {
6621 throw new RuntimeException("User must be valid and have a name.");
Selim Cinekcb8b9852017-12-15 18:01:52 -08006622 }
6623 }
6624
6625 /**
Selim Cinekaa9db1f2018-02-27 17:35:47 -08006626 * @return the the text that should be displayed in the statusBar when heads upped.
6627 * If {@code null} is returned, the default implementation will be used.
6628 *
6629 * @hide
6630 */
6631 @Override
6632 public CharSequence getHeadsUpStatusBarText() {
6633 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
6634 ? super.mBigContentTitle
6635 : mConversationTitle;
6636 if (!TextUtils.isEmpty(conversationTitle) && !hasOnlyWhiteSpaceSenders()) {
6637 return conversationTitle;
6638 }
6639 return null;
6640 }
6641
6642 /**
Selim Cinekcb8b9852017-12-15 18:01:52 -08006643 * @return the user to be displayed for any replies sent by the user
6644 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006645 @NonNull
Selim Cinekcb8b9852017-12-15 18:01:52 -08006646 public Person getUser() {
6647 return mUser;
Alex Hillsfc737de2016-03-23 17:33:02 -04006648 }
6649
6650 /**
6651 * Returns the name to be displayed for any replies sent by the user
Selim Cinekcb8b9852017-12-15 18:01:52 -08006652 *
6653 * @deprecated use {@link #getUser()} instead
Alex Hillsfc737de2016-03-23 17:33:02 -04006654 */
6655 public CharSequence getUserDisplayName() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006656 return mUser.getName();
Alex Hillsfc737de2016-03-23 17:33:02 -04006657 }
6658
6659 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006660 * Sets the title to be displayed on this conversation. May be set to {@code null}.
6661 *
Kodlee Yin14656422017-12-22 17:00:46 -08006662 * <p>This API's behavior was changed in SDK version {@link Build.VERSION_CODES#P}. If your
6663 * application's target version is less than {@link Build.VERSION_CODES#P}, setting a
6664 * conversation title to a non-null value will make {@link #isGroupConversation()} return
6665 * {@code true} and passing {@code null} will make it return {@code false}. In
6666 * {@link Build.VERSION_CODES#P} and beyond, use {@link #setGroupConversation(boolean)}
6667 * to set group conversation status.
6668 *
6669 * @param conversationTitle Title displayed for this conversation
6670 * @return this object for method chaining
Alex Hillsfc737de2016-03-23 17:33:02 -04006671 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006672 public MessagingStyle setConversationTitle(@Nullable CharSequence conversationTitle) {
Alex Hillsfc737de2016-03-23 17:33:02 -04006673 mConversationTitle = conversationTitle;
6674 return this;
6675 }
6676
6677 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006678 * Return the title to be displayed on this conversation. May return {@code null}.
Alex Hillsfc737de2016-03-23 17:33:02 -04006679 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006680 @Nullable
Alex Hillsfc737de2016-03-23 17:33:02 -04006681 public CharSequence getConversationTitle() {
6682 return mConversationTitle;
6683 }
6684
6685 /**
6686 * Adds a message for display by this notification. Convenience call for a simple
6687 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6688 * @param text A {@link CharSequence} to be displayed as the message content
6689 * @param timestamp Time at which the message arrived
6690 * @param sender A {@link CharSequence} to be used for displaying the name of the
6691 * sender. Should be <code>null</code> for messages by the current user, in which case
6692 * the platform will insert {@link #getUserDisplayName()}.
6693 * Should be unique amongst all individuals in the conversation, and should be
6694 * consistent during re-posts of the notification.
6695 *
6696 * @see Message#Message(CharSequence, long, CharSequence)
6697 *
6698 * @return this object for method chaining
Selim Cinekcb8b9852017-12-15 18:01:52 -08006699 *
6700 * @deprecated use {@link #addMessage(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006701 */
6702 public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006703 return addMessage(text, timestamp,
Selim Cinek9acd6732018-03-23 16:39:02 -07006704 sender == null ? null : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006705 }
6706
6707 /**
6708 * Adds a message for display by this notification. Convenience call for a simple
6709 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6710 * @param text A {@link CharSequence} to be displayed as the message content
6711 * @param timestamp Time at which the message arrived
6712 * @param sender The {@link Person} who sent the message.
6713 * Should be <code>null</code> for messages by the current user, in which case
6714 * the platform will insert the user set in {@code MessagingStyle(Person)}.
6715 *
6716 * @see Message#Message(CharSequence, long, CharSequence)
6717 *
6718 * @return this object for method chaining
6719 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006720 public MessagingStyle addMessage(@NonNull CharSequence text, long timestamp,
6721 @Nullable Person sender) {
Adrian Roos437cd562017-01-18 15:47:03 -08006722 return addMessage(new Message(text, timestamp, sender));
Alex Hillsfc737de2016-03-23 17:33:02 -04006723 }
6724
6725 /**
6726 * Adds a {@link Message} for display in this notification.
Adrian Roos437cd562017-01-18 15:47:03 -08006727 *
6728 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6729 * the newest last.
6730 *
Alex Hillsfc737de2016-03-23 17:33:02 -04006731 * @param message The {@link Message} to be displayed
6732 * @return this object for method chaining
6733 */
6734 public MessagingStyle addMessage(Message message) {
6735 mMessages.add(message);
6736 if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6737 mMessages.remove(0);
6738 }
6739 return this;
6740 }
6741
6742 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006743 * Adds a {@link Message} for historic context in this notification.
6744 *
6745 * <p>Messages should be added as historic if they are not the main subject of the
6746 * notification but may give context to a conversation. The system may choose to present
6747 * them only when relevant, e.g. when replying to a message through a {@link RemoteInput}.
6748 *
6749 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6750 * the newest last.
6751 *
6752 * @param message The historic {@link Message} to be added
6753 * @return this object for method chaining
6754 */
6755 public MessagingStyle addHistoricMessage(Message message) {
6756 mHistoricMessages.add(message);
6757 if (mHistoricMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6758 mHistoricMessages.remove(0);
6759 }
6760 return this;
6761 }
6762
6763 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006764 * Gets the list of {@code Message} objects that represent the notification
6765 */
6766 public List<Message> getMessages() {
6767 return mMessages;
6768 }
6769
6770 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006771 * Gets the list of historic {@code Message}s in the notification.
6772 */
6773 public List<Message> getHistoricMessages() {
6774 return mHistoricMessages;
6775 }
6776
6777 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006778 * Sets whether this conversation notification represents a group.
Kodlee Yin14656422017-12-22 17:00:46 -08006779 *
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006780 * @param isGroupConversation {@code true} if the conversation represents a group,
6781 * {@code false} otherwise.
6782 * @return this object for method chaining
6783 */
6784 public MessagingStyle setGroupConversation(boolean isGroupConversation) {
6785 mIsGroupConversation = isGroupConversation;
6786 return this;
6787 }
6788
6789 /**
Kodlee Yin14656422017-12-22 17:00:46 -08006790 * Returns {@code true} if this notification represents a group conversation, otherwise
6791 * {@code false}.
6792 *
6793 * <p> If the application that generated this {@link MessagingStyle} targets an SDK version
6794 * less than {@link Build.VERSION_CODES#P}, this method becomes dependent on whether or
6795 * not the conversation title is set; returning {@code true} if the conversation title is
6796 * a non-null value, or {@code false} otherwise. From {@link Build.VERSION_CODES#P} forward,
6797 * this method returns what's set by {@link #setGroupConversation(boolean)} allowing for
6798 * named, non-group conversations.
6799 *
6800 * @see #setConversationTitle(CharSequence)
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006801 */
6802 public boolean isGroupConversation() {
Kodlee Yin14656422017-12-22 17:00:46 -08006803 // When target SDK version is < P, a non-null conversation title dictates if this is
6804 // as group conversation.
6805 if (mBuilder != null
6806 && mBuilder.mContext.getApplicationInfo().targetSdkVersion
6807 < Build.VERSION_CODES.P) {
6808 return mConversationTitle != null;
6809 }
6810
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006811 return mIsGroupConversation;
6812 }
6813
6814 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006815 * @hide
6816 */
6817 @Override
6818 public void addExtras(Bundle extras) {
6819 super.addExtras(extras);
Selim Cinekcb8b9852017-12-15 18:01:52 -08006820 if (mUser != null) {
6821 // For legacy usages
6822 extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUser.getName());
6823 extras.putParcelable(EXTRA_MESSAGING_PERSON, mUser);
Alex Hillsfc737de2016-03-23 17:33:02 -04006824 }
6825 if (mConversationTitle != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04006826 extras.putCharSequence(EXTRA_CONVERSATION_TITLE, mConversationTitle);
Alex Hillsfc737de2016-03-23 17:33:02 -04006827 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04006828 if (!mMessages.isEmpty()) { extras.putParcelableArray(EXTRA_MESSAGES,
6829 Message.getBundleArrayForMessages(mMessages));
Alex Hillsfc737de2016-03-23 17:33:02 -04006830 }
Adrian Roos437cd562017-01-18 15:47:03 -08006831 if (!mHistoricMessages.isEmpty()) { extras.putParcelableArray(EXTRA_HISTORIC_MESSAGES,
6832 Message.getBundleArrayForMessages(mHistoricMessages));
6833 }
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006834
6835 fixTitleAndTextExtras(extras);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006836 extras.putBoolean(EXTRA_IS_GROUP_CONVERSATION, mIsGroupConversation);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006837 }
6838
6839 private void fixTitleAndTextExtras(Bundle extras) {
6840 Message m = findLatestIncomingMessage();
6841 CharSequence text = (m == null) ? null : m.mText;
6842 CharSequence sender = m == null ? null
Selim Cinekcb8b9852017-12-15 18:01:52 -08006843 : m.mSender == null || TextUtils.isEmpty(m.mSender.getName())
6844 ? mUser.getName() : m.mSender.getName();
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006845 CharSequence title;
6846 if (!TextUtils.isEmpty(mConversationTitle)) {
6847 if (!TextUtils.isEmpty(sender)) {
6848 BidiFormatter bidi = BidiFormatter.getInstance();
6849 title = mBuilder.mContext.getString(
6850 com.android.internal.R.string.notification_messaging_title_template,
Selim Cinekcb8b9852017-12-15 18:01:52 -08006851 bidi.unicodeWrap(mConversationTitle), bidi.unicodeWrap(sender));
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006852 } else {
6853 title = mConversationTitle;
6854 }
6855 } else {
6856 title = sender;
6857 }
6858
6859 if (title != null) {
6860 extras.putCharSequence(EXTRA_TITLE, title);
6861 }
6862 if (text != null) {
6863 extras.putCharSequence(EXTRA_TEXT, text);
6864 }
Alex Hillsfc737de2016-03-23 17:33:02 -04006865 }
6866
6867 /**
6868 * @hide
6869 */
6870 @Override
6871 protected void restoreFromExtras(Bundle extras) {
6872 super.restoreFromExtras(extras);
6873
Selim Cinekcb8b9852017-12-15 18:01:52 -08006874 mUser = extras.getParcelable(EXTRA_MESSAGING_PERSON);
6875 if (mUser == null) {
6876 CharSequence displayName = extras.getCharSequence(EXTRA_SELF_DISPLAY_NAME);
Selim Cinek9acd6732018-03-23 16:39:02 -07006877 mUser = new Person.Builder().setName(displayName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08006878 }
Adrian Roos96b7e202016-05-17 13:50:38 -07006879 mConversationTitle = extras.getCharSequence(EXTRA_CONVERSATION_TITLE);
Adrian Roos437cd562017-01-18 15:47:03 -08006880 Parcelable[] messages = extras.getParcelableArray(EXTRA_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006881 mMessages = Message.getMessagesFromBundleArray(messages);
Adrian Roos437cd562017-01-18 15:47:03 -08006882 Parcelable[] histMessages = extras.getParcelableArray(EXTRA_HISTORIC_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006883 mHistoricMessages = Message.getMessagesFromBundleArray(histMessages);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006884 mIsGroupConversation = extras.getBoolean(EXTRA_IS_GROUP_CONVERSATION);
Alex Hillsfc737de2016-03-23 17:33:02 -04006885 }
6886
6887 /**
6888 * @hide
6889 */
Adrian Roosc1a80b02016-04-05 14:54:55 -07006890 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08006891 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cineke62255c2017-09-28 18:23:23 -07006892 mBuilder.mOriginalActions = mBuilder.mActions;
6893 mBuilder.mActions = new ArrayList<>();
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006894 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
Selim Cinek384804b2018-04-18 14:31:07 +08006895 false /* hideLargeIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07006896 mBuilder.mActions = mBuilder.mOriginalActions;
6897 mBuilder.mOriginalActions = null;
6898 return remoteViews;
Adrian Roosc1a80b02016-04-05 14:54:55 -07006899 }
6900
Julia Reynolds7217dc92018-03-07 12:12:09 -05006901 /**
6902 * @hide
6903 */
6904 @Override
6905 public boolean areNotificationsVisiblyDifferent(Style other) {
6906 if (other == null || getClass() != other.getClass()) {
6907 return true;
6908 }
6909 MessagingStyle newS = (MessagingStyle) other;
6910 List<MessagingStyle.Message> oldMs = getMessages();
6911 List<MessagingStyle.Message> newMs = newS.getMessages();
6912
6913 if (oldMs == null) {
6914 oldMs = new ArrayList<>();
6915 }
6916 if (newMs == null) {
6917 newMs = new ArrayList<>();
6918 }
6919
6920 int n = oldMs.size();
6921 if (n != newMs.size()) {
6922 return true;
6923 }
6924 for (int i = 0; i < n; i++) {
6925 MessagingStyle.Message oldM = oldMs.get(i);
6926 MessagingStyle.Message newM = newMs.get(i);
6927 if (!Objects.equals(oldM.getText(), newM.getText())) {
6928 return true;
6929 }
6930 if (!Objects.equals(oldM.getDataUri(), newM.getDataUri())) {
6931 return true;
6932 }
6933 CharSequence oldSender = oldM.getSenderPerson() == null ? oldM.getSender()
6934 : oldM.getSenderPerson().getName();
6935 CharSequence newSender = newM.getSenderPerson() == null ? newM.getSender()
6936 : newM.getSenderPerson().getName();
6937 if (!Objects.equals(oldSender, newSender)) {
6938 return true;
6939 }
6940
6941 String oldKey = oldM.getSenderPerson() == null
6942 ? null : oldM.getSenderPerson().getKey();
6943 String newKey = newM.getSenderPerson() == null
6944 ? null : newM.getSenderPerson().getKey();
6945 if (!Objects.equals(oldKey, newKey)) {
6946 return true;
6947 }
6948 // Other fields (like timestamp) intentionally excluded
6949 }
6950 return false;
6951 }
6952
Adrian Roosc1a80b02016-04-05 14:54:55 -07006953 private Message findLatestIncomingMessage() {
Selim Cinek88188f22017-09-19 16:46:56 -07006954 return findLatestIncomingMessage(mMessages);
6955 }
6956
6957 /**
6958 * @hide
6959 */
6960 @Nullable
6961 public static Message findLatestIncomingMessage(
6962 List<Message> messages) {
6963 for (int i = messages.size() - 1; i >= 0; i--) {
6964 Message m = messages.get(i);
Adrian Roosc1a80b02016-04-05 14:54:55 -07006965 // Incoming messages have a non-empty sender.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006966 if (m.mSender != null && !TextUtils.isEmpty(m.mSender.getName())) {
Adrian Roosc1a80b02016-04-05 14:54:55 -07006967 return m;
6968 }
6969 }
Selim Cinek88188f22017-09-19 16:46:56 -07006970 if (!messages.isEmpty()) {
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006971 // No incoming messages, fall back to outgoing message
Selim Cinek88188f22017-09-19 16:46:56 -07006972 return messages.get(messages.size() - 1);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006973 }
Adrian Roosc1a80b02016-04-05 14:54:55 -07006974 return null;
6975 }
6976
6977 /**
6978 * @hide
6979 */
6980 @Override
6981 public RemoteViews makeBigContentView() {
Selim Cinek384804b2018-04-18 14:31:07 +08006982 return makeMessagingView(false /* displayImagesAtEnd */, true /* hideLargeIcon */);
Selim Cinekafeed292017-12-12 17:32:44 -08006983 }
6984
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006985 /**
6986 * Create a messaging layout.
6987 *
6988 * @param displayImagesAtEnd should images be displayed at the end of the content instead
6989 * of inline.
Selim Cinek384804b2018-04-18 14:31:07 +08006990 * @param hideRightIcons Should the reply affordance be shown at the end of the notification
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006991 * @return the created remoteView.
6992 */
Selim Cinekafeed292017-12-12 17:32:44 -08006993 @NonNull
Selim Cinek384804b2018-04-18 14:31:07 +08006994 private RemoteViews makeMessagingView(boolean displayImagesAtEnd, boolean hideRightIcons) {
Selim Cinek88188f22017-09-19 16:46:56 -07006995 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
Adrian Roosc1a80b02016-04-05 14:54:55 -07006996 ? super.mBigContentTitle
6997 : mConversationTitle;
Selim Cinek88188f22017-09-19 16:46:56 -07006998 boolean isOneToOne = TextUtils.isEmpty(conversationTitle);
Selim Cinek2dd3e722018-01-19 11:06:06 -08006999 CharSequence nameReplacement = null;
Selim Cinekafeed292017-12-12 17:32:44 -08007000 if (hasOnlyWhiteSpaceSenders()) {
Selim Cinekf7409db2017-10-24 16:17:14 -07007001 isOneToOne = true;
Selim Cinek2dd3e722018-01-19 11:06:06 -08007002 nameReplacement = conversationTitle;
7003 conversationTitle = null;
Adrian Roosb1f427c2016-05-26 12:27:15 -07007004 }
Selim Cinek384804b2018-04-18 14:31:07 +08007005 TemplateBindResult bindResult = new TemplateBindResult();
Adrian Roos48d746a2016-04-12 14:57:28 -07007006 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
Adrian Roosc1a80b02016-04-05 14:54:55 -07007007 mBuilder.getMessagingLayoutResource(),
Selim Cinek88188f22017-09-19 16:46:56 -07007008 mBuilder.mParams.reset().hasProgress(false).title(conversationTitle).text(null)
Selim Cinek384804b2018-04-18 14:31:07 +08007009 .hideLargeIcon(hideRightIcons || isOneToOne)
7010 .hideReplyIcon(hideRightIcons)
7011 .headerTextSecondary(conversationTitle),
7012 bindResult);
Selim Cinek88188f22017-09-19 16:46:56 -07007013 addExtras(mBuilder.mN.extras);
Selim Cinekafeed292017-12-12 17:32:44 -08007014 // also update the end margin if there is an image
Selim Cinek1c72fa02018-04-23 18:00:54 +08007015 contentView.setViewLayoutMarginEnd(R.id.notification_messaging,
7016 bindResult.getIconMarginEnd());
Selim Cinek88188f22017-09-19 16:46:56 -07007017 contentView.setInt(R.id.status_bar_latest_event_content, "setLayoutColor",
Kenny Guy14d035c2018-05-02 19:10:36 +01007018 mBuilder.isColorized() ? mBuilder.getPrimaryTextColor()
7019 : mBuilder.resolveContrastColor());
7020 contentView.setInt(R.id.status_bar_latest_event_content, "setSenderTextColor",
7021 mBuilder.getPrimaryTextColor());
7022 contentView.setInt(R.id.status_bar_latest_event_content, "setMessageTextColor",
7023 mBuilder.getSecondaryTextColor());
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007024 contentView.setBoolean(R.id.status_bar_latest_event_content, "setDisplayImagesAtEnd",
7025 displayImagesAtEnd);
Selim Cinek88188f22017-09-19 16:46:56 -07007026 contentView.setIcon(R.id.status_bar_latest_event_content, "setLargeIcon",
7027 mBuilder.mN.mLargeIcon);
Selim Cinek2dd3e722018-01-19 11:06:06 -08007028 contentView.setCharSequence(R.id.status_bar_latest_event_content, "setNameReplacement",
7029 nameReplacement);
Selim Cinek88188f22017-09-19 16:46:56 -07007030 contentView.setBoolean(R.id.status_bar_latest_event_content, "setIsOneToOne",
7031 isOneToOne);
7032 contentView.setBundle(R.id.status_bar_latest_event_content, "setData",
7033 mBuilder.mN.extras);
Alex Hillsfc737de2016-03-23 17:33:02 -04007034 return contentView;
7035 }
7036
Selim Cinekf7409db2017-10-24 16:17:14 -07007037 private boolean hasOnlyWhiteSpaceSenders() {
7038 for (int i = 0; i < mMessages.size(); i++) {
7039 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08007040 Person sender = m.getSenderPerson();
7041 if (sender != null && !isWhiteSpace(sender.getName())) {
Selim Cinekf7409db2017-10-24 16:17:14 -07007042 return false;
7043 }
7044 }
7045 return true;
7046 }
7047
7048 private boolean isWhiteSpace(CharSequence sender) {
7049 if (TextUtils.isEmpty(sender)) {
7050 return true;
7051 }
7052 if (sender.toString().matches("^\\s*$")) {
7053 return true;
7054 }
7055 // Let's check if we only have 0 whitespace chars. Some apps did this as a workaround
7056 // For the presentation that we had.
7057 for (int i = 0; i < sender.length(); i++) {
7058 char c = sender.charAt(i);
7059 if (c != '\u200B') {
7060 return false;
7061 }
7062 }
7063 return true;
7064 }
7065
Selim Cinek88188f22017-09-19 16:46:56 -07007066 private CharSequence createConversationTitleFromMessages() {
7067 ArraySet<CharSequence> names = new ArraySet<>();
7068 for (int i = 0; i < mMessages.size(); i++) {
7069 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08007070 Person sender = m.getSenderPerson();
Selim Cinek88188f22017-09-19 16:46:56 -07007071 if (sender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007072 names.add(sender.getName());
Selim Cinek88188f22017-09-19 16:46:56 -07007073 }
7074 }
7075 SpannableStringBuilder title = new SpannableStringBuilder();
7076 int size = names.size();
7077 for (int i = 0; i < size; i++) {
7078 CharSequence name = names.valueAt(i);
7079 if (!TextUtils.isEmpty(title)) {
7080 title.append(", ");
7081 }
7082 title.append(BidiFormatter.getInstance().unicodeWrap(name));
7083 }
7084 return title;
7085 }
7086
Adrian Roosdedd1df2016-04-26 16:38:47 -07007087 /**
7088 * @hide
7089 */
7090 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007091 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007092 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
Selim Cinek384804b2018-04-18 14:31:07 +08007093 true /* hideLargeIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07007094 remoteViews.setInt(R.id.notification_messaging, "setMaxDisplayedLines", 1);
7095 return remoteViews;
Adrian Roosdedd1df2016-04-26 16:38:47 -07007096 }
7097
Adrian Roosc1a80b02016-04-05 14:54:55 -07007098 private static TextAppearanceSpan makeFontColorSpan(int color) {
7099 return new TextAppearanceSpan(null, 0, 0,
7100 ColorStateList.valueOf(color), null);
7101 }
7102
Alex Hillsd9b04d92016-04-11 16:38:16 -04007103 public static final class Message {
7104
7105 static final String KEY_TEXT = "text";
7106 static final String KEY_TIMESTAMP = "time";
7107 static final String KEY_SENDER = "sender";
Selim Cinekcb8b9852017-12-15 18:01:52 -08007108 static final String KEY_SENDER_PERSON = "sender_person";
Alex Hillsd9b04d92016-04-11 16:38:16 -04007109 static final String KEY_DATA_MIME_TYPE = "type";
7110 static final String KEY_DATA_URI= "uri";
Shane Brennan5a871862017-03-11 13:14:17 -08007111 static final String KEY_EXTRAS_BUNDLE = "extras";
Kenny Guya0f6de82018-04-06 16:20:16 +01007112 static final String KEY_REMOTE_INPUT_HISTORY = "remote_input_history";
Alex Hillsfc737de2016-03-23 17:33:02 -04007113
7114 private final CharSequence mText;
7115 private final long mTimestamp;
Selim Cinekcb8b9852017-12-15 18:01:52 -08007116 @Nullable
7117 private final Person mSender;
Kenny Guya0f6de82018-04-06 16:20:16 +01007118 /** True if this message was generated from the extra
7119 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}
7120 */
7121 private final boolean mRemoteInputHistory;
Alex Hillsfc737de2016-03-23 17:33:02 -04007122
Shane Brennan5a871862017-03-11 13:14:17 -08007123 private Bundle mExtras = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04007124 private String mDataMimeType;
7125 private Uri mDataUri;
7126
7127 /**
7128 * Constructor
7129 * @param text A {@link CharSequence} to be displayed as the message content
7130 * @param timestamp Time at which the message arrived
7131 * @param sender A {@link CharSequence} to be used for displaying the name of the
7132 * sender. Should be <code>null</code> for messages by the current user, in which case
7133 * the platform will insert {@link MessagingStyle#getUserDisplayName()}.
7134 * Should be unique amongst all individuals in the conversation, and should be
7135 * consistent during re-posts of the notification.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007136 *
7137 * @deprecated use {@code Message(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04007138 */
7139 public Message(CharSequence text, long timestamp, CharSequence sender){
Selim Cinek9acd6732018-03-23 16:39:02 -07007140 this(text, timestamp, sender == null ? null
7141 : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08007142 }
7143
7144 /**
7145 * Constructor
7146 * @param text A {@link CharSequence} to be displayed as the message content
7147 * @param timestamp Time at which the message arrived
7148 * @param sender The {@link Person} who sent the message.
7149 * Should be <code>null</code> for messages by the current user, in which case
7150 * the platform will insert the user set in {@code MessagingStyle(Person)}.
7151 * <p>
Selim Cinek9acd6732018-03-23 16:39:02 -07007152 * The person provided should contain an Icon, set with
7153 * {@link Person.Builder#setIcon(Icon)} and also have a name provided
7154 * with {@link Person.Builder#setName(CharSequence)}. If multiple users have the same
7155 * name, consider providing a key with {@link Person.Builder#setKey(String)} in order
7156 * to differentiate between the different users.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007157 * </p>
7158 */
Selim Cinekeb53c222018-04-06 12:56:09 -07007159 public Message(@NonNull CharSequence text, long timestamp, @Nullable Person sender) {
Kenny Guya0f6de82018-04-06 16:20:16 +01007160 this(text, timestamp, sender, false /* remoteHistory */);
7161 }
7162
7163 /**
7164 * Constructor
7165 * @param text A {@link CharSequence} to be displayed as the message content
7166 * @param timestamp Time at which the message arrived
7167 * @param sender The {@link Person} who sent the message.
7168 * Should be <code>null</code> for messages by the current user, in which case
7169 * the platform will insert the user set in {@code MessagingStyle(Person)}.
7170 * @param remoteInputHistory True if the messages was generated from the extra
7171 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}.
7172 * <p>
7173 * The person provided should contain an Icon, set with
7174 * {@link Person.Builder#setIcon(Icon)} and also have a name provided
7175 * with {@link Person.Builder#setName(CharSequence)}. If multiple users have the same
7176 * name, consider providing a key with {@link Person.Builder#setKey(String)} in order
7177 * to differentiate between the different users.
7178 * </p>
7179 * @hide
7180 */
7181 public Message(@NonNull CharSequence text, long timestamp, @Nullable Person sender,
7182 boolean remoteInputHistory) {
Alex Hillsfc737de2016-03-23 17:33:02 -04007183 mText = text;
7184 mTimestamp = timestamp;
7185 mSender = sender;
Kenny Guya0f6de82018-04-06 16:20:16 +01007186 mRemoteInputHistory = remoteInputHistory;
Alex Hillsfc737de2016-03-23 17:33:02 -04007187 }
7188
7189 /**
7190 * Sets a binary blob of data and an associated MIME type for a message. In the case
7191 * where the platform doesn't support the MIME type, the original text provided in the
7192 * constructor will be used.
7193 * @param dataMimeType The MIME type of the content. See
7194 * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME
7195 * types on Android and Android Wear.
7196 * @param dataUri The uri containing the content whose type is given by the MIME type.
7197 * <p class="note">
7198 * <ol>
7199 * <li>Notification Listeners including the System UI need permission to access the
7200 * data the Uri points to. The recommended ways to do this are:</li>
7201 * <li>Store the data in your own ContentProvider, making sure that other apps have
7202 * the correct permission to access your provider. The preferred mechanism for
7203 * providing access is to use per-URI permissions which are temporary and only
7204 * grant access to the receiving application. An easy way to create a
7205 * ContentProvider like this is to use the FileProvider helper class.</li>
7206 * <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio
7207 * and image MIME types, however beginning with Android 3.0 (API level 11) it can
7208 * also store non-media types (see MediaStore.Files for more info). Files can be
7209 * inserted into the MediaStore using scanFile() after which a content:// style
7210 * Uri suitable for sharing is passed to the provided onScanCompleted() callback.
7211 * Note that once added to the system MediaStore the content is accessible to any
7212 * app on the device.</li>
7213 * </ol>
7214 * @return this object for method chaining
7215 */
7216 public Message setData(String dataMimeType, Uri dataUri) {
7217 mDataMimeType = dataMimeType;
7218 mDataUri = dataUri;
7219 return this;
7220 }
7221
Alex Hillsfc737de2016-03-23 17:33:02 -04007222 /**
7223 * Get the text to be used for this message, or the fallback text if a type and content
7224 * Uri have been set
7225 */
7226 public CharSequence getText() {
7227 return mText;
7228 }
7229
7230 /**
7231 * Get the time at which this message arrived
7232 */
7233 public long getTimestamp() {
7234 return mTimestamp;
7235 }
7236
7237 /**
Shane Brennan5a871862017-03-11 13:14:17 -08007238 * Get the extras Bundle for this message.
7239 */
7240 public Bundle getExtras() {
7241 return mExtras;
7242 }
7243
7244 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04007245 * Get the text used to display the contact's name in the messaging experience
Selim Cinekcb8b9852017-12-15 18:01:52 -08007246 *
7247 * @deprecated use {@link #getSenderPerson()}
Alex Hillsfc737de2016-03-23 17:33:02 -04007248 */
7249 public CharSequence getSender() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007250 return mSender == null ? null : mSender.getName();
7251 }
7252
7253 /**
7254 * Get the sender associated with this message.
7255 */
7256 @Nullable
7257 public Person getSenderPerson() {
Alex Hillsfc737de2016-03-23 17:33:02 -04007258 return mSender;
7259 }
7260
7261 /**
7262 * Get the MIME type of the data pointed to by the Uri
7263 */
7264 public String getDataMimeType() {
7265 return mDataMimeType;
7266 }
7267
7268 /**
7269 * Get the the Uri pointing to the content of the message. Can be null, in which case
7270 * {@see #getText()} is used.
7271 */
7272 public Uri getDataUri() {
7273 return mDataUri;
7274 }
7275
Kenny Guya0f6de82018-04-06 16:20:16 +01007276 /**
7277 * @return True if the message was generated from
7278 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}.
7279 * @hide
7280 */
7281 public boolean isRemoteInputHistory() {
7282 return mRemoteInputHistory;
7283 }
7284
Alex Hillsd9b04d92016-04-11 16:38:16 -04007285 private Bundle toBundle() {
7286 Bundle bundle = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04007287 if (mText != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007288 bundle.putCharSequence(KEY_TEXT, mText);
Alex Hillsfc737de2016-03-23 17:33:02 -04007289 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007290 bundle.putLong(KEY_TIMESTAMP, mTimestamp);
Alex Hillsfc737de2016-03-23 17:33:02 -04007291 if (mSender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007292 // Legacy listeners need this
7293 bundle.putCharSequence(KEY_SENDER, mSender.getName());
7294 bundle.putParcelable(KEY_SENDER_PERSON, mSender);
Alex Hillsfc737de2016-03-23 17:33:02 -04007295 }
7296 if (mDataMimeType != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007297 bundle.putString(KEY_DATA_MIME_TYPE, mDataMimeType);
Alex Hillsfc737de2016-03-23 17:33:02 -04007298 }
7299 if (mDataUri != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007300 bundle.putParcelable(KEY_DATA_URI, mDataUri);
Alex Hillsfc737de2016-03-23 17:33:02 -04007301 }
Shane Brennan5a871862017-03-11 13:14:17 -08007302 if (mExtras != null) {
7303 bundle.putBundle(KEY_EXTRAS_BUNDLE, mExtras);
7304 }
Kenny Guya0f6de82018-04-06 16:20:16 +01007305 if (mRemoteInputHistory) {
7306 bundle.putBoolean(KEY_REMOTE_INPUT_HISTORY, mRemoteInputHistory);
7307 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007308 return bundle;
Alex Hillsfc737de2016-03-23 17:33:02 -04007309 }
7310
Alex Hillsd9b04d92016-04-11 16:38:16 -04007311 static Bundle[] getBundleArrayForMessages(List<Message> messages) {
7312 Bundle[] bundles = new Bundle[messages.size()];
7313 final int N = messages.size();
7314 for (int i = 0; i < N; i++) {
7315 bundles[i] = messages.get(i).toBundle();
7316 }
7317 return bundles;
7318 }
7319
Selim Cinek88188f22017-09-19 16:46:56 -07007320 /**
7321 * @return A list of messages read from the bundles.
7322 *
7323 * @hide
7324 */
7325 public static List<Message> getMessagesFromBundleArray(Parcelable[] bundles) {
7326 if (bundles == null) {
7327 return new ArrayList<>();
7328 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007329 List<Message> messages = new ArrayList<>(bundles.length);
7330 for (int i = 0; i < bundles.length; i++) {
Adrian Roosdedd1df2016-04-26 16:38:47 -07007331 if (bundles[i] instanceof Bundle) {
7332 Message message = getMessageFromBundle((Bundle)bundles[i]);
7333 if (message != null) {
7334 messages.add(message);
7335 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007336 }
7337 }
7338 return messages;
7339 }
7340
7341 static Message getMessageFromBundle(Bundle bundle) {
7342 try {
Adrian Roosfbddd2c2016-05-13 12:57:20 -07007343 if (!bundle.containsKey(KEY_TEXT) || !bundle.containsKey(KEY_TIMESTAMP)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007344 return null;
7345 } else {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007346
7347 Person senderPerson = bundle.getParcelable(KEY_SENDER_PERSON);
7348 if (senderPerson == null) {
7349 // Legacy apps that use compat don't actually provide the sender objects
7350 // We need to fix the compat version to provide people / use
7351 // the native api instead
7352 CharSequence senderName = bundle.getCharSequence(KEY_SENDER);
7353 if (senderName != null) {
Selim Cinek9acd6732018-03-23 16:39:02 -07007354 senderPerson = new Person.Builder().setName(senderName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08007355 }
7356 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007357 Message message = new Message(bundle.getCharSequence(KEY_TEXT),
Selim Cinekcb8b9852017-12-15 18:01:52 -08007358 bundle.getLong(KEY_TIMESTAMP),
Kenny Guya0f6de82018-04-06 16:20:16 +01007359 senderPerson,
7360 bundle.getBoolean(KEY_REMOTE_INPUT_HISTORY, false));
Alex Hillsd9b04d92016-04-11 16:38:16 -04007361 if (bundle.containsKey(KEY_DATA_MIME_TYPE) &&
7362 bundle.containsKey(KEY_DATA_URI)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007363 message.setData(bundle.getString(KEY_DATA_MIME_TYPE),
7364 (Uri) bundle.getParcelable(KEY_DATA_URI));
Alex Hillsfc737de2016-03-23 17:33:02 -04007365 }
Shane Brennan5a871862017-03-11 13:14:17 -08007366 if (bundle.containsKey(KEY_EXTRAS_BUNDLE)) {
7367 message.getExtras().putAll(bundle.getBundle(KEY_EXTRAS_BUNDLE));
7368 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007369 return message;
7370 }
7371 } catch (ClassCastException e) {
7372 return null;
7373 }
7374 }
Alex Hillsfc737de2016-03-23 17:33:02 -04007375 }
7376 }
7377
7378 /**
Daniel Sandler879c5e02012-04-17 16:46:51 -04007379 * Helper class for generating large-format notifications that include a list of (up to 5) strings.
Joe Malin8d40d042012-11-05 11:36:40 -08007380 *
Robert Ly91c5ce32014-06-08 15:37:00 -07007381 * Here's how you'd set the <code>InboxStyle</code> on a notification:
Daniel Sandler879c5e02012-04-17 16:46:51 -04007382 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07007383 * Notification notif = new Notification.Builder(mContext)
7384 * .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
7385 * .setContentText(subject)
7386 * .setSmallIcon(R.drawable.new_mail)
7387 * .setLargeIcon(aBitmap)
7388 * .setStyle(new Notification.InboxStyle()
7389 * .addLine(str1)
7390 * .addLine(str2)
7391 * .setContentTitle(&quot;&quot;)
7392 * .setSummaryText(&quot;+3 more&quot;))
7393 * .build();
Daniel Sandler879c5e02012-04-17 16:46:51 -04007394 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08007395 *
Daniel Sandler879c5e02012-04-17 16:46:51 -04007396 * @see Notification#bigContentView
7397 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007398 public static class InboxStyle extends Style {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007399 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
7400
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007401 public InboxStyle() {
7402 }
7403
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007404 /**
7405 * @deprecated use {@code InboxStyle()}.
7406 */
7407 @Deprecated
Daniel Sandler879c5e02012-04-17 16:46:51 -04007408 public InboxStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007409 setBuilder(builder);
Daniel Sandler879c5e02012-04-17 16:46:51 -04007410 }
7411
Chris Wrend6297db2012-05-03 16:20:13 -04007412 /**
7413 * Overrides ContentTitle in the big form of the template.
7414 * This defaults to the value passed to setContentTitle().
7415 */
7416 public InboxStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007417 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04007418 return this;
7419 }
7420
7421 /**
7422 * Set the first line of text after the detail section in the big form of the template.
7423 */
7424 public InboxStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007425 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04007426 return this;
7427 }
7428
Chris Wren0bd664d2012-08-01 13:56:56 -04007429 /**
7430 * Append a line to the digest section of the Inbox notification.
7431 */
Daniel Sandler879c5e02012-04-17 16:46:51 -04007432 public InboxStyle addLine(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007433 mTexts.add(safeCharSequence(cs));
Daniel Sandler879c5e02012-04-17 16:46:51 -04007434 return this;
7435 }
7436
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007437 /**
7438 * @hide
7439 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05007440 public ArrayList<CharSequence> getLines() {
7441 return mTexts;
7442 }
7443
7444 /**
7445 * @hide
7446 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007447 public void addExtras(Bundle extras) {
7448 super.addExtras(extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007449
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007450 CharSequence[] a = new CharSequence[mTexts.size()];
7451 extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
7452 }
7453
Christoph Studer4600f9b2014-07-22 22:44:43 +02007454 /**
7455 * @hide
7456 */
7457 @Override
7458 protected void restoreFromExtras(Bundle extras) {
7459 super.restoreFromExtras(extras);
7460
7461 mTexts.clear();
7462 if (extras.containsKey(EXTRA_TEXT_LINES)) {
7463 Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES));
7464 }
7465 }
7466
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007467 /**
7468 * @hide
7469 */
7470 public RemoteViews makeBigContentView() {
Selim Cinekc848c3a2016-01-13 15:27:30 -08007471 // Remove the content text so it disappears unless you have a summary
Christoph Studer4600f9b2014-07-22 22:44:43 +02007472 // Nasty
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007473 CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT);
7474 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007475
Selim Cinek384804b2018-04-18 14:31:07 +08007476 TemplateBindResult result = new TemplateBindResult();
7477 RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource(), result);
Daniel Sandler619738c2012-06-07 16:33:08 -04007478
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007479 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007480
Chris Wrend6297db2012-05-03 16:20:13 -04007481 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 -04007482 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
Chris Wrend6297db2012-05-03 16:20:13 -04007483
Chris Wren4ed80d52012-05-17 09:30:03 -04007484 // Make sure all rows are gone in case we reuse a view.
7485 for (int rowId : rowIds) {
7486 contentView.setViewVisibility(rowId, View.GONE);
7487 }
7488
Daniel Sandler879c5e02012-04-17 16:46:51 -04007489 int i=0;
Selim Cinek07c80172016-04-21 16:40:47 -07007490 int topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7491 R.dimen.notification_inbox_item_top_padding);
Selim Cinek247fa012016-02-18 09:50:48 -08007492 boolean first = true;
Selim Cinek07c80172016-04-21 16:40:47 -07007493 int onlyViewId = 0;
7494 int maxRows = rowIds.length;
7495 if (mBuilder.mActions.size() > 0) {
7496 maxRows--;
7497 }
7498 while (i < mTexts.size() && i < maxRows) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007499 CharSequence str = mTexts.get(i);
Selim Cinek07c80172016-04-21 16:40:47 -07007500 if (!TextUtils.isEmpty(str)) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007501 contentView.setViewVisibility(rowIds[i], View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07007502 contentView.setTextViewText(rowIds[i],
7503 mBuilder.processTextSpans(mBuilder.processLegacyText(str)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08007504 mBuilder.setTextViewColorSecondary(contentView, rowIds[i]);
Selim Cinek07c80172016-04-21 16:40:47 -07007505 contentView.setViewPadding(rowIds[i], 0, topPadding, 0, 0);
Selim Cinek384804b2018-04-18 14:31:07 +08007506 handleInboxImageMargin(contentView, rowIds[i], first,
Selim Cinek1c72fa02018-04-23 18:00:54 +08007507 result.getIconMarginEnd());
Selim Cinek07c80172016-04-21 16:40:47 -07007508 if (first) {
7509 onlyViewId = rowIds[i];
7510 } else {
7511 onlyViewId = 0;
7512 }
Selim Cinek247fa012016-02-18 09:50:48 -08007513 first = false;
Daniel Sandler879c5e02012-04-17 16:46:51 -04007514 }
7515 i++;
7516 }
Selim Cinek07c80172016-04-21 16:40:47 -07007517 if (onlyViewId != 0) {
7518 // We only have 1 entry, lets make it look like the normal Text of a Bigtext
7519 topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7520 R.dimen.notification_text_margin_top);
7521 contentView.setViewPadding(onlyViewId, 0, topPadding, 0, 0);
7522 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007523
Daniel Sandler879c5e02012-04-17 16:46:51 -04007524 return contentView;
7525 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007526
Julia Reynolds7217dc92018-03-07 12:12:09 -05007527 /**
7528 * @hide
7529 */
7530 @Override
7531 public boolean areNotificationsVisiblyDifferent(Style other) {
7532 if (other == null || getClass() != other.getClass()) {
7533 return true;
7534 }
7535 InboxStyle newS = (InboxStyle) other;
7536 return !Objects.equals(getLines(), newS.getLines());
7537 }
7538
Selim Cinek384804b2018-04-18 14:31:07 +08007539 private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first,
Selim Cinek1c72fa02018-04-23 18:00:54 +08007540 int marginEndValue) {
Selim Cinek1e0bf612015-11-20 15:57:26 -08007541 int endMargin = 0;
Selim Cinek247fa012016-02-18 09:50:48 -08007542 if (first) {
7543 final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0);
7544 final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
7545 boolean hasProgress = max != 0 || ind;
Selim Cinek384804b2018-04-18 14:31:07 +08007546 if (!hasProgress) {
Selim Cinek1c72fa02018-04-23 18:00:54 +08007547 endMargin = marginEndValue;
Selim Cinek247fa012016-02-18 09:50:48 -08007548 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007549 }
Selim Cinek1c72fa02018-04-23 18:00:54 +08007550 contentView.setViewLayoutMarginEnd(id, endMargin);
Selim Cinek1e0bf612015-11-20 15:57:26 -08007551 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04007552 }
Dan Sandler842dd772014-05-15 09:36:47 -04007553
7554 /**
7555 * Notification style for media playback notifications.
7556 *
7557 * In the expanded form, {@link Notification#bigContentView}, up to 5
7558 * {@link Notification.Action}s specified with
Dan Sandler86647982015-05-13 23:41:13 -04007559 * {@link Notification.Builder#addAction(Action) addAction} will be
Dan Sandler842dd772014-05-15 09:36:47 -04007560 * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
7561 * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be
7562 * treated as album artwork.
Selim Cinek99104832017-01-25 14:47:33 -08007563 * <p>
Dan Sandler842dd772014-05-15 09:36:47 -04007564 * Unlike the other styles provided here, MediaStyle can also modify the standard-size
7565 * {@link Notification#contentView}; by providing action indices to
Christoph Studerfde6f4d2014-12-12 13:23:26 +01007566 * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed
Dan Sandler842dd772014-05-15 09:36:47 -04007567 * in the standard view alongside the usual content.
Selim Cinek99104832017-01-25 14:47:33 -08007568 * <p>
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007569 * Notifications created with MediaStyle will have their category set to
7570 * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different
7571 * category using {@link Notification.Builder#setCategory(String) setCategory()}.
Selim Cinek99104832017-01-25 14:47:33 -08007572 * <p>
Jeff Browndba34ba2014-06-24 20:46:03 -07007573 * Finally, if you attach a {@link android.media.session.MediaSession.Token} using
7574 * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)},
Dan Sandler842dd772014-05-15 09:36:47 -04007575 * the System UI can identify this as a notification representing an active media session
7576 * and respond accordingly (by showing album artwork in the lockscreen, for example).
7577 *
Selim Cinek99104832017-01-25 14:47:33 -08007578 * <p>
7579 * Starting at {@link android.os.Build.VERSION_CODES#O Android O} any notification that has a
7580 * media session attached with {@link #setMediaSession(MediaSession.Token)} will be colorized.
7581 * You can opt-out of this behavior by using {@link Notification.Builder#setColorized(boolean)}.
7582 * <p>
7583 *
Dan Sandler842dd772014-05-15 09:36:47 -04007584 * To use this style with your Notification, feed it to
7585 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7586 * <pre class="prettyprint">
7587 * Notification noti = new Notification.Builder()
7588 * .setSmallIcon(R.drawable.ic_stat_player)
Christoph Studere935fe92014-11-24 14:18:06 +01007589 * .setContentTitle(&quot;Track title&quot;)
7590 * .setContentText(&quot;Artist - Album&quot;)
7591 * .setLargeIcon(albumArtBitmap))
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007592 * .setStyle(<b>new Notification.MediaStyle()</b>
7593 * .setMediaSession(mySession))
Dan Sandler842dd772014-05-15 09:36:47 -04007594 * .build();
7595 * </pre>
7596 *
7597 * @see Notification#bigContentView
Selim Cinek99104832017-01-25 14:47:33 -08007598 * @see Notification.Builder#setColorized(boolean)
Dan Sandler842dd772014-05-15 09:36:47 -04007599 */
7600 public static class MediaStyle extends Style {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007601 static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3;
Dan Sandler842dd772014-05-15 09:36:47 -04007602 static final int MAX_MEDIA_BUTTONS = 5;
7603
7604 private int[] mActionsToShowInCompact = null;
Jeff Browndba34ba2014-06-24 20:46:03 -07007605 private MediaSession.Token mToken;
Dan Sandler842dd772014-05-15 09:36:47 -04007606
7607 public MediaStyle() {
7608 }
7609
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007610 /**
7611 * @deprecated use {@code MediaStyle()}.
7612 */
7613 @Deprecated
Dan Sandler842dd772014-05-15 09:36:47 -04007614 public MediaStyle(Builder builder) {
7615 setBuilder(builder);
7616 }
7617
7618 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007619 * 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 -04007620 * notification view.
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007621 *
7622 * @param actions the indices of the actions to show in the compact notification view
Dan Sandler842dd772014-05-15 09:36:47 -04007623 */
7624 public MediaStyle setShowActionsInCompactView(int...actions) {
7625 mActionsToShowInCompact = actions;
7626 return this;
7627 }
7628
7629 /**
Jeff Browndba34ba2014-06-24 20:46:03 -07007630 * Attach a {@link android.media.session.MediaSession.Token} to this Notification
7631 * to provide additional playback information and control to the SystemUI.
Dan Sandler842dd772014-05-15 09:36:47 -04007632 */
Jeff Browndba34ba2014-06-24 20:46:03 -07007633 public MediaStyle setMediaSession(MediaSession.Token token) {
Dan Sandler842dd772014-05-15 09:36:47 -04007634 mToken = token;
7635 return this;
7636 }
7637
Christoph Studer4600f9b2014-07-22 22:44:43 +02007638 /**
7639 * @hide
7640 */
Dan Sandler842dd772014-05-15 09:36:47 -04007641 @Override
7642 public Notification buildStyled(Notification wip) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02007643 super.buildStyled(wip);
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007644 if (wip.category == null) {
7645 wip.category = Notification.CATEGORY_TRANSPORT;
7646 }
Dan Sandler842dd772014-05-15 09:36:47 -04007647 return wip;
7648 }
7649
Christoph Studer4600f9b2014-07-22 22:44:43 +02007650 /**
7651 * @hide
7652 */
7653 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007654 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007655 return makeMediaContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007656 }
7657
7658 /**
7659 * @hide
7660 */
7661 @Override
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007662 public RemoteViews makeBigContentView() {
7663 return makeMediaBigContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007664 }
7665
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007666 /**
7667 * @hide
7668 */
7669 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007670 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007671 RemoteViews expanded = makeMediaBigContentView();
7672 return expanded != null ? expanded : makeMediaContentView();
7673 }
7674
Dan Sandler842dd772014-05-15 09:36:47 -04007675 /** @hide */
7676 @Override
7677 public void addExtras(Bundle extras) {
7678 super.addExtras(extras);
7679
7680 if (mToken != null) {
7681 extras.putParcelable(EXTRA_MEDIA_SESSION, mToken);
7682 }
Bryan Mawhinneye191f902014-07-22 12:50:09 +01007683 if (mActionsToShowInCompact != null) {
7684 extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact);
7685 }
Dan Sandler842dd772014-05-15 09:36:47 -04007686 }
7687
Christoph Studer4600f9b2014-07-22 22:44:43 +02007688 /**
7689 * @hide
7690 */
7691 @Override
7692 protected void restoreFromExtras(Bundle extras) {
7693 super.restoreFromExtras(extras);
7694
7695 if (extras.containsKey(EXTRA_MEDIA_SESSION)) {
7696 mToken = extras.getParcelable(EXTRA_MEDIA_SESSION);
7697 }
7698 if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) {
7699 mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS);
7700 }
7701 }
7702
Julia Reynolds7217dc92018-03-07 12:12:09 -05007703 /**
7704 * @hide
7705 */
7706 @Override
7707 public boolean areNotificationsVisiblyDifferent(Style other) {
7708 if (other == null || getClass() != other.getClass()) {
7709 return true;
7710 }
7711 // All fields to compare are on the Notification object
7712 return false;
7713 }
7714
Selim Cinek5bf069a2015-11-10 19:14:27 -05007715 private RemoteViews generateMediaActionButton(Action action, int color) {
Dan Sandler842dd772014-05-15 09:36:47 -04007716 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07007717 RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(),
Alan Viverette3cb07a462014-06-06 14:19:53 -07007718 R.layout.notification_material_media_action);
Dan Sandler68079d52015-07-22 10:45:30 -04007719 button.setImageViewIcon(R.id.action0, action.getIcon());
Anthony Chenad4d1582017-04-10 16:07:58 -07007720
7721 // If the action buttons should not be tinted, then just use the default
7722 // notification color. Otherwise, just use the passed-in color.
7723 int tintColor = mBuilder.shouldTintActionButtons() || mBuilder.isColorized()
7724 ? color
7725 : NotificationColorUtil.resolveColor(mBuilder.mContext,
7726 Notification.COLOR_DEFAULT);
7727
Sunny Goyal5b153922017-09-21 21:00:36 -07007728 button.setDrawableTint(R.id.action0, false, tintColor,
7729 PorterDuff.Mode.SRC_ATOP);
Dan Sandler842dd772014-05-15 09:36:47 -04007730 if (!tombstone) {
7731 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
7732 }
7733 button.setContentDescription(R.id.action0, action.title);
7734 return button;
7735 }
7736
7737 private RemoteViews makeMediaContentView() {
7738 RemoteViews view = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007739 R.layout.notification_template_material_media, false, /* hasProgress */
7740 null /* result */);
Dan Sandler842dd772014-05-15 09:36:47 -04007741
7742 final int numActions = mBuilder.mActions.size();
7743 final int N = mActionsToShowInCompact == null
7744 ? 0
7745 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
7746 if (N > 0) {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007747 view.removeAllViews(com.android.internal.R.id.media_actions);
Dan Sandler842dd772014-05-15 09:36:47 -04007748 for (int i = 0; i < N; i++) {
7749 if (i >= numActions) {
7750 throw new IllegalArgumentException(String.format(
7751 "setShowActionsInCompactView: action %d out of bounds (max %d)",
7752 i, numActions - 1));
7753 }
7754
7755 final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]);
Selim Cinekc7f5a822018-03-20 19:32:06 -07007756 final RemoteViews button = generateMediaActionButton(action, getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007757 view.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007758 }
7759 }
Selim Cinekfdc738f2016-01-27 20:04:27 -08007760 handleImage(view);
7761 // handle the content margin
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007762 int endMargin = R.dimen.notification_content_margin_end;
Selim Cinek279fa862016-06-14 10:57:25 -07007763 if (mBuilder.mN.hasLargeIcon()) {
Selim Cinek384804b2018-04-18 14:31:07 +08007764 endMargin = R.dimen.notification_media_image_margin_end;
Selim Cinekfdc738f2016-01-27 20:04:27 -08007765 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007766 view.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
Dan Sandler842dd772014-05-15 09:36:47 -04007767 return view;
7768 }
7769
Selim Cinekc7f5a822018-03-20 19:32:06 -07007770 private int getActionColor() {
7771 return mBuilder.isColorized() ? mBuilder.getPrimaryTextColor()
7772 : mBuilder.resolveContrastColor();
Selim Cinek99104832017-01-25 14:47:33 -08007773 }
7774
Dan Sandler842dd772014-05-15 09:36:47 -04007775 private RemoteViews makeMediaBigContentView() {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007776 final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007777 // Dont add an expanded view if there is no more content to be revealed
7778 int actionsInCompact = mActionsToShowInCompact == null
7779 ? 0
7780 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
Selim Cinek279fa862016-06-14 10:57:25 -07007781 if (!mBuilder.mN.hasLargeIcon() && actionCount <= actionsInCompact) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007782 return null;
7783 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007784 RemoteViews big = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007785 R.layout.notification_template_material_big_media, false, null /* result */);
Dan Sandler842dd772014-05-15 09:36:47 -04007786
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007787 if (actionCount > 0) {
7788 big.removeAllViews(com.android.internal.R.id.media_actions);
7789 for (int i = 0; i < actionCount; i++) {
Selim Cinek5bf069a2015-11-10 19:14:27 -05007790 final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i),
Selim Cinekc7f5a822018-03-20 19:32:06 -07007791 getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007792 big.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007793 }
7794 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007795 handleImage(big);
Dan Sandler842dd772014-05-15 09:36:47 -04007796 return big;
7797 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007798
Selim Cinek5bf069a2015-11-10 19:14:27 -05007799 private void handleImage(RemoteViews contentView) {
Selim Cinek279fa862016-06-14 10:57:25 -07007800 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007801 contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
7802 contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007803 }
7804 }
7805
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007806 /**
7807 * @hide
7808 */
7809 @Override
7810 protected boolean hasProgress() {
7811 return false;
7812 }
Dan Sandler842dd772014-05-15 09:36:47 -04007813 }
Griff Hazen61a9e862014-05-22 16:05:19 -07007814
Selim Cinek593610c2016-02-16 18:42:57 -08007815 /**
7816 * Notification style for custom views that are decorated by the system
7817 *
7818 * <p>Instead of providing a notification that is completely custom, a developer can set this
7819 * style and still obtain system decorations like the notification header with the expand
7820 * affordance and actions.
7821 *
7822 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7823 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7824 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7825 * corresponding custom views to display.
7826 *
7827 * To use this style with your Notification, feed it to
7828 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7829 * <pre class="prettyprint">
7830 * Notification noti = new Notification.Builder()
7831 * .setSmallIcon(R.drawable.ic_stat_player)
7832 * .setLargeIcon(albumArtBitmap))
7833 * .setCustomContentView(contentView);
7834 * .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>)
7835 * .build();
7836 * </pre>
7837 */
7838 public static class DecoratedCustomViewStyle extends Style {
7839
7840 public DecoratedCustomViewStyle() {
7841 }
7842
Selim Cinek593610c2016-02-16 18:42:57 -08007843 /**
7844 * @hide
7845 */
7846 public boolean displayCustomViewInline() {
7847 return true;
7848 }
7849
7850 /**
7851 * @hide
7852 */
7853 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007854 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007855 return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView);
7856 }
7857
7858 /**
7859 * @hide
7860 */
7861 @Override
7862 public RemoteViews makeBigContentView() {
7863 return makeDecoratedBigContentView();
7864 }
7865
7866 /**
7867 * @hide
7868 */
7869 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007870 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007871 return makeDecoratedHeadsUpContentView();
7872 }
7873
Selim Cinek593610c2016-02-16 18:42:57 -08007874 private RemoteViews makeDecoratedHeadsUpContentView() {
7875 RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null
7876 ? mBuilder.mN.contentView
7877 : mBuilder.mN.headsUpContentView;
7878 if (mBuilder.mActions.size() == 0) {
7879 return makeStandardTemplateWithCustomContent(headsUpContentView);
7880 }
Selim Cinek384804b2018-04-18 14:31:07 +08007881 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08007882 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
Selim Cinek384804b2018-04-18 14:31:07 +08007883 mBuilder.getBigBaseLayoutResource(), result);
7884 buildIntoRemoteViewContent(remoteViews, headsUpContentView, result);
Selim Cinek593610c2016-02-16 18:42:57 -08007885 return remoteViews;
7886 }
7887
Selim Cinek593610c2016-02-16 18:42:57 -08007888 private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) {
Selim Cinek384804b2018-04-18 14:31:07 +08007889 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08007890 RemoteViews remoteViews = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007891 mBuilder.getBaseLayoutResource(), result);
7892 buildIntoRemoteViewContent(remoteViews, customContent, result);
Selim Cinek593610c2016-02-16 18:42:57 -08007893 return remoteViews;
7894 }
7895
Selim Cinek593610c2016-02-16 18:42:57 -08007896 private RemoteViews makeDecoratedBigContentView() {
7897 RemoteViews bigContentView = mBuilder.mN.bigContentView == null
7898 ? mBuilder.mN.contentView
7899 : mBuilder.mN.bigContentView;
7900 if (mBuilder.mActions.size() == 0) {
7901 return makeStandardTemplateWithCustomContent(bigContentView);
7902 }
Selim Cinek384804b2018-04-18 14:31:07 +08007903 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08007904 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
Selim Cinek384804b2018-04-18 14:31:07 +08007905 mBuilder.getBigBaseLayoutResource(), result);
7906 buildIntoRemoteViewContent(remoteViews, bigContentView, result);
Selim Cinek593610c2016-02-16 18:42:57 -08007907 return remoteViews;
7908 }
Selim Cinek247fa012016-02-18 09:50:48 -08007909
7910 private void buildIntoRemoteViewContent(RemoteViews remoteViews,
Selim Cinek384804b2018-04-18 14:31:07 +08007911 RemoteViews customContent, TemplateBindResult result) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08007912 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07007913 // Need to clone customContent before adding, because otherwise it can no longer be
7914 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08007915 customContent = customContent.clone();
Anthony Chen8f5f3582017-04-11 11:18:37 -07007916 remoteViews.removeAllViewsExceptId(R.id.notification_main_column, R.id.progress);
7917 remoteViews.addView(R.id.notification_main_column, customContent, 0 /* index */);
Selim Cinekfc8073c2017-08-16 17:50:20 -07007918 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08007919 }
Selim Cinek247fa012016-02-18 09:50:48 -08007920 // also update the end margin if there is an image
Selim Cinek384804b2018-04-18 14:31:07 +08007921 Resources resources = mBuilder.mContext.getResources();
7922 int endMargin = resources.getDimensionPixelSize(
Selim Cinek1c72fa02018-04-23 18:00:54 +08007923 R.dimen.notification_content_margin_end) + result.getIconMarginEnd();
Selim Cinek384804b2018-04-18 14:31:07 +08007924 remoteViews.setViewLayoutMarginEnd(R.id.notification_main_column, endMargin);
Selim Cinek247fa012016-02-18 09:50:48 -08007925 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05007926
7927 /**
7928 * @hide
7929 */
7930 @Override
7931 public boolean areNotificationsVisiblyDifferent(Style other) {
7932 if (other == null || getClass() != other.getClass()) {
7933 return true;
7934 }
7935 // Comparison done for all custom RemoteViews, independent of style
7936 return false;
7937 }
Selim Cinek593610c2016-02-16 18:42:57 -08007938 }
7939
Selim Cinek03eb3b72016-02-18 10:39:45 -08007940 /**
7941 * Notification style for media custom views that are decorated by the system
7942 *
7943 * <p>Instead of providing a media notification that is completely custom, a developer can set
7944 * this style and still obtain system decorations like the notification header with the expand
7945 * affordance and actions.
7946 *
7947 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7948 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7949 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7950 * corresponding custom views to display.
Selim Cinek99104832017-01-25 14:47:33 -08007951 * <p>
7952 * Contrary to {@link MediaStyle} a developer has to opt-in to the colorizing of the
7953 * notification by using {@link Notification.Builder#setColorized(boolean)}.
7954 * <p>
Selim Cinek03eb3b72016-02-18 10:39:45 -08007955 * To use this style with your Notification, feed it to
7956 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7957 * <pre class="prettyprint">
7958 * Notification noti = new Notification.Builder()
7959 * .setSmallIcon(R.drawable.ic_stat_player)
7960 * .setLargeIcon(albumArtBitmap))
7961 * .setCustomContentView(contentView);
7962 * .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b>
7963 * .setMediaSession(mySession))
7964 * .build();
7965 * </pre>
7966 *
7967 * @see android.app.Notification.DecoratedCustomViewStyle
7968 * @see android.app.Notification.MediaStyle
7969 */
7970 public static class DecoratedMediaCustomViewStyle extends MediaStyle {
7971
7972 public DecoratedMediaCustomViewStyle() {
7973 }
7974
Selim Cinek03eb3b72016-02-18 10:39:45 -08007975 /**
7976 * @hide
7977 */
7978 public boolean displayCustomViewInline() {
7979 return true;
7980 }
7981
7982 /**
7983 * @hide
7984 */
7985 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007986 public RemoteViews makeContentView(boolean increasedHeight) {
7987 RemoteViews remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08007988 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
7989 mBuilder.mN.contentView);
7990 }
7991
7992 /**
7993 * @hide
7994 */
7995 @Override
7996 public RemoteViews makeBigContentView() {
7997 RemoteViews customRemoteView = mBuilder.mN.bigContentView != null
7998 ? mBuilder.mN.bigContentView
7999 : mBuilder.mN.contentView;
8000 return makeBigContentViewWithCustomContent(customRemoteView);
8001 }
8002
8003 private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) {
8004 RemoteViews remoteViews = super.makeBigContentView();
8005 if (remoteViews != null) {
8006 return buildIntoRemoteView(remoteViews, R.id.notification_main_column,
8007 customRemoteView);
8008 } else if (customRemoteView != mBuilder.mN.contentView){
Selim Cinek7d1009b2017-01-25 15:28:28 -08008009 remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08008010 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
8011 customRemoteView);
8012 } else {
8013 return null;
8014 }
8015 }
8016
8017 /**
8018 * @hide
8019 */
8020 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08008021 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek03eb3b72016-02-18 10:39:45 -08008022 RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null
8023 ? mBuilder.mN.headsUpContentView
8024 : mBuilder.mN.contentView;
8025 return makeBigContentViewWithCustomContent(customRemoteView);
8026 }
8027
Julia Reynolds7217dc92018-03-07 12:12:09 -05008028 /**
8029 * @hide
8030 */
8031 @Override
8032 public boolean areNotificationsVisiblyDifferent(Style other) {
8033 if (other == null || getClass() != other.getClass()) {
8034 return true;
8035 }
8036 // Comparison done for all custom RemoteViews, independent of style
8037 return false;
8038 }
8039
Selim Cinek03eb3b72016-02-18 10:39:45 -08008040 private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id,
8041 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08008042 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07008043 // Need to clone customContent before adding, because otherwise it can no longer be
8044 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08008045 customContent = customContent.clone();
Selim Cinek87c31532017-08-18 18:53:44 -07008046 customContent.overrideTextColors(mBuilder.getPrimaryTextColor());
Selim Cinekf91017e2016-03-14 12:25:09 -07008047 remoteViews.removeAllViews(id);
8048 remoteViews.addView(id, customContent);
Selim Cinekfc8073c2017-08-16 17:50:20 -07008049 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08008050 }
Selim Cinek03eb3b72016-02-18 10:39:45 -08008051 return remoteViews;
8052 }
8053 }
8054
Christoph Studer4600f9b2014-07-22 22:44:43 +02008055 // When adding a new Style subclass here, don't forget to update
8056 // Builder.getNotificationStyleClass.
8057
Griff Hazen61a9e862014-05-22 16:05:19 -07008058 /**
8059 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
8060 * metadata or change options on a notification builder.
8061 */
8062 public interface Extender {
8063 /**
8064 * Apply this extender to a notification builder.
8065 * @param builder the builder to be modified.
8066 * @return the build object for chaining.
8067 */
8068 public Builder extend(Builder builder);
8069 }
8070
8071 /**
8072 * Helper class to add wearable extensions to notifications.
8073 * <p class="note"> See
8074 * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications
8075 * for Android Wear</a> for more information on how to use this class.
8076 * <p>
8077 * To create a notification with wearable extensions:
8078 * <ol>
8079 * <li>Create a {@link android.app.Notification.Builder}, setting any desired
8080 * properties.
8081 * <li>Create a {@link android.app.Notification.WearableExtender}.
8082 * <li>Set wearable-specific properties using the
8083 * {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}.
8084 * <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a
8085 * notification.
8086 * <li>Post the notification to the notification system with the
8087 * {@code NotificationManager.notify(...)} methods.
8088 * </ol>
8089 *
8090 * <pre class="prettyprint">
8091 * Notification notif = new Notification.Builder(mContext)
8092 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
8093 * .setContentText(subject)
8094 * .setSmallIcon(R.drawable.new_mail)
8095 * .extend(new Notification.WearableExtender()
8096 * .setContentIcon(R.drawable.new_mail))
8097 * .build();
8098 * NotificationManager notificationManger =
8099 * (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
8100 * notificationManger.notify(0, notif);</pre>
8101 *
8102 * <p>Wearable extensions can be accessed on an existing notification by using the
8103 * {@code WearableExtender(Notification)} constructor,
8104 * and then using the {@code get} methods to access values.
8105 *
8106 * <pre class="prettyprint">
8107 * Notification.WearableExtender wearableExtender = new Notification.WearableExtender(
8108 * notification);
Griff Hazen14f57992014-05-26 09:07:14 -07008109 * List&lt;Notification&gt; pages = wearableExtender.getPages();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07008110 */
8111 public static final class WearableExtender implements Extender {
8112 /**
8113 * Sentinel value for an action index that is unset.
8114 */
8115 public static final int UNSET_ACTION_INDEX = -1;
8116
8117 /**
8118 * Size value for use with {@link #setCustomSizePreset} to show this notification with
8119 * default sizing.
8120 * <p>For custom display notifications created using {@link #setDisplayIntent},
Paul Soulosaa4f4bf2015-08-04 11:59:45 -07008121 * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based
Griff Hazen61a9e862014-05-22 16:05:19 -07008122 * on their content.
8123 */
8124 public static final int SIZE_DEFAULT = 0;
8125
8126 /**
8127 * Size value for use with {@link #setCustomSizePreset} to show this notification
8128 * with an extra small size.
8129 * <p>This value is only applicable for custom display notifications created using
8130 * {@link #setDisplayIntent}.
8131 */
8132 public static final int SIZE_XSMALL = 1;
8133
8134 /**
8135 * Size value for use with {@link #setCustomSizePreset} to show this notification
8136 * with a small size.
8137 * <p>This value is only applicable for custom display notifications created using
8138 * {@link #setDisplayIntent}.
8139 */
8140 public static final int SIZE_SMALL = 2;
8141
8142 /**
8143 * Size value for use with {@link #setCustomSizePreset} to show this notification
8144 * with a medium size.
8145 * <p>This value is only applicable for custom display notifications created using
8146 * {@link #setDisplayIntent}.
8147 */
8148 public static final int SIZE_MEDIUM = 3;
8149
8150 /**
8151 * Size value for use with {@link #setCustomSizePreset} to show this notification
8152 * with a large size.
8153 * <p>This value is only applicable for custom display notifications created using
8154 * {@link #setDisplayIntent}.
8155 */
8156 public static final int SIZE_LARGE = 4;
8157
Griff Hazend5f11f92014-05-27 15:40:09 -07008158 /**
8159 * Size value for use with {@link #setCustomSizePreset} to show this notification
8160 * full screen.
8161 * <p>This value is only applicable for custom display notifications created using
8162 * {@link #setDisplayIntent}.
8163 */
8164 public static final int SIZE_FULL_SCREEN = 5;
8165
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008166 /**
8167 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a
8168 * short amount of time when this notification is displayed on the screen. This
8169 * is the default value.
8170 */
8171 public static final int SCREEN_TIMEOUT_SHORT = 0;
8172
8173 /**
8174 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on
8175 * for a longer amount of time when this notification is displayed on the screen.
8176 */
8177 public static final int SCREEN_TIMEOUT_LONG = -1;
8178
Griff Hazen61a9e862014-05-22 16:05:19 -07008179 /** Notification extra which contains wearable extensions */
8180 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
8181
Pete Gastaf6781d2014-10-07 15:17:05 -04008182 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07008183 private static final String KEY_ACTIONS = "actions";
8184 private static final String KEY_FLAGS = "flags";
8185 private static final String KEY_DISPLAY_INTENT = "displayIntent";
8186 private static final String KEY_PAGES = "pages";
8187 private static final String KEY_BACKGROUND = "background";
8188 private static final String KEY_CONTENT_ICON = "contentIcon";
8189 private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity";
8190 private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex";
8191 private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset";
8192 private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight";
8193 private static final String KEY_GRAVITY = "gravity";
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008194 private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout";
Nadia Benbernou948627e2016-04-14 14:41:08 -04008195 private static final String KEY_DISMISSAL_ID = "dismissalId";
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008196 private static final String KEY_BRIDGE_TAG = "bridgeTag";
Griff Hazen61a9e862014-05-22 16:05:19 -07008197
8198 // Flags bitwise-ored to mFlags
8199 private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1;
8200 private static final int FLAG_HINT_HIDE_ICON = 1 << 1;
8201 private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2;
8202 private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008203 private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4;
Alex Hills4bcb06b2016-04-05 14:26:25 -04008204 private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5;
Alex Hills9ab3a232016-04-05 14:54:56 -04008205 private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6;
Griff Hazen61a9e862014-05-22 16:05:19 -07008206
8207 // Default value for flags integer
8208 private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE;
8209
8210 private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END;
8211 private static final int DEFAULT_GRAVITY = Gravity.BOTTOM;
8212
8213 private ArrayList<Action> mActions = new ArrayList<Action>();
8214 private int mFlags = DEFAULT_FLAGS;
8215 private PendingIntent mDisplayIntent;
8216 private ArrayList<Notification> mPages = new ArrayList<Notification>();
8217 private Bitmap mBackground;
8218 private int mContentIcon;
8219 private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY;
8220 private int mContentActionIndex = UNSET_ACTION_INDEX;
8221 private int mCustomSizePreset = SIZE_DEFAULT;
8222 private int mCustomContentHeight;
8223 private int mGravity = DEFAULT_GRAVITY;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008224 private int mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04008225 private String mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008226 private String mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07008227
8228 /**
8229 * Create a {@link android.app.Notification.WearableExtender} with default
8230 * options.
8231 */
8232 public WearableExtender() {
8233 }
8234
8235 public WearableExtender(Notification notif) {
8236 Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS);
8237 if (wearableBundle != null) {
8238 List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS);
8239 if (actions != null) {
8240 mActions.addAll(actions);
8241 }
8242
8243 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
8244 mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT);
8245
8246 Notification[] pages = getNotificationArrayFromBundle(
8247 wearableBundle, KEY_PAGES);
8248 if (pages != null) {
8249 Collections.addAll(mPages, pages);
8250 }
8251
8252 mBackground = wearableBundle.getParcelable(KEY_BACKGROUND);
8253 mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON);
8254 mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY,
8255 DEFAULT_CONTENT_ICON_GRAVITY);
8256 mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX,
8257 UNSET_ACTION_INDEX);
8258 mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET,
8259 SIZE_DEFAULT);
8260 mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT);
8261 mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY);
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008262 mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT);
Nadia Benbernou948627e2016-04-14 14:41:08 -04008263 mDismissalId = wearableBundle.getString(KEY_DISMISSAL_ID);
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008264 mBridgeTag = wearableBundle.getString(KEY_BRIDGE_TAG);
Griff Hazen61a9e862014-05-22 16:05:19 -07008265 }
8266 }
8267
8268 /**
8269 * Apply wearable extensions to a notification that is being built. This is typically
8270 * called by the {@link android.app.Notification.Builder#extend} method of
8271 * {@link android.app.Notification.Builder}.
8272 */
8273 @Override
8274 public Notification.Builder extend(Notification.Builder builder) {
8275 Bundle wearableBundle = new Bundle();
8276
8277 if (!mActions.isEmpty()) {
8278 wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions);
8279 }
8280 if (mFlags != DEFAULT_FLAGS) {
8281 wearableBundle.putInt(KEY_FLAGS, mFlags);
8282 }
8283 if (mDisplayIntent != null) {
8284 wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent);
8285 }
8286 if (!mPages.isEmpty()) {
8287 wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray(
8288 new Notification[mPages.size()]));
8289 }
8290 if (mBackground != null) {
8291 wearableBundle.putParcelable(KEY_BACKGROUND, mBackground);
8292 }
8293 if (mContentIcon != 0) {
8294 wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon);
8295 }
8296 if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) {
8297 wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity);
8298 }
8299 if (mContentActionIndex != UNSET_ACTION_INDEX) {
8300 wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX,
8301 mContentActionIndex);
8302 }
8303 if (mCustomSizePreset != SIZE_DEFAULT) {
8304 wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset);
8305 }
8306 if (mCustomContentHeight != 0) {
8307 wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight);
8308 }
8309 if (mGravity != DEFAULT_GRAVITY) {
8310 wearableBundle.putInt(KEY_GRAVITY, mGravity);
8311 }
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008312 if (mHintScreenTimeout != 0) {
8313 wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout);
8314 }
Nadia Benbernou948627e2016-04-14 14:41:08 -04008315 if (mDismissalId != null) {
8316 wearableBundle.putString(KEY_DISMISSAL_ID, mDismissalId);
8317 }
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008318 if (mBridgeTag != null) {
8319 wearableBundle.putString(KEY_BRIDGE_TAG, mBridgeTag);
8320 }
Griff Hazen61a9e862014-05-22 16:05:19 -07008321
8322 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
8323 return builder;
8324 }
8325
8326 @Override
8327 public WearableExtender clone() {
8328 WearableExtender that = new WearableExtender();
8329 that.mActions = new ArrayList<Action>(this.mActions);
8330 that.mFlags = this.mFlags;
8331 that.mDisplayIntent = this.mDisplayIntent;
8332 that.mPages = new ArrayList<Notification>(this.mPages);
8333 that.mBackground = this.mBackground;
8334 that.mContentIcon = this.mContentIcon;
8335 that.mContentIconGravity = this.mContentIconGravity;
8336 that.mContentActionIndex = this.mContentActionIndex;
8337 that.mCustomSizePreset = this.mCustomSizePreset;
8338 that.mCustomContentHeight = this.mCustomContentHeight;
8339 that.mGravity = this.mGravity;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008340 that.mHintScreenTimeout = this.mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04008341 that.mDismissalId = this.mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008342 that.mBridgeTag = this.mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07008343 return that;
8344 }
8345
8346 /**
8347 * Add a wearable action to this notification.
8348 *
8349 * <p>When wearable actions are added using this method, the set of actions that
8350 * show on a wearable device splits from devices that only show actions added
8351 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8352 * of which actions display on different devices.
8353 *
8354 * @param action the action to add to this notification
8355 * @return this object for method chaining
8356 * @see android.app.Notification.Action
8357 */
8358 public WearableExtender addAction(Action action) {
8359 mActions.add(action);
8360 return this;
8361 }
8362
8363 /**
8364 * Adds wearable actions to this notification.
8365 *
8366 * <p>When wearable actions are added using this method, the set of actions that
8367 * show on a wearable device splits from devices that only show actions added
8368 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8369 * of which actions display on different devices.
8370 *
8371 * @param actions the actions to add to this notification
8372 * @return this object for method chaining
8373 * @see android.app.Notification.Action
8374 */
8375 public WearableExtender addActions(List<Action> actions) {
8376 mActions.addAll(actions);
8377 return this;
8378 }
8379
8380 /**
8381 * Clear all wearable actions present on this builder.
8382 * @return this object for method chaining.
8383 * @see #addAction
8384 */
8385 public WearableExtender clearActions() {
8386 mActions.clear();
8387 return this;
8388 }
8389
8390 /**
8391 * Get the wearable actions present on this notification.
8392 */
8393 public List<Action> getActions() {
8394 return mActions;
8395 }
8396
8397 /**
8398 * Set an intent to launch inside of an activity view when displaying
Griff Hazen14f57992014-05-26 09:07:14 -07008399 * this notification. The {@link PendingIntent} provided should be for an activity.
8400 *
8401 * <pre class="prettyprint">
8402 * Intent displayIntent = new Intent(context, MyDisplayActivity.class);
8403 * PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
8404 * 0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
8405 * Notification notif = new Notification.Builder(context)
8406 * .extend(new Notification.WearableExtender()
8407 * .setDisplayIntent(displayPendingIntent)
8408 * .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM))
8409 * .build();</pre>
8410 *
8411 * <p>The activity to launch needs to allow embedding, must be exported, and
Griff Hazen831ca9d2014-06-17 00:38:38 -07008412 * should have an empty task affinity. It is also recommended to use the device
8413 * default light theme.
Griff Hazen14f57992014-05-26 09:07:14 -07008414 *
8415 * <p>Example AndroidManifest.xml entry:
8416 * <pre class="prettyprint">
8417 * &lt;activity android:name=&quot;com.example.MyDisplayActivity&quot;
8418 * android:exported=&quot;true&quot;
8419 * android:allowEmbedded=&quot;true&quot;
Griff Hazen831ca9d2014-06-17 00:38:38 -07008420 * android:taskAffinity=&quot;&quot;
8421 * android:theme=&quot;@android:style/Theme.DeviceDefault.Light&quot; /&gt;</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07008422 *
8423 * @param intent the {@link PendingIntent} for an activity
8424 * @return this object for method chaining
8425 * @see android.app.Notification.WearableExtender#getDisplayIntent
8426 */
8427 public WearableExtender setDisplayIntent(PendingIntent intent) {
8428 mDisplayIntent = intent;
8429 return this;
8430 }
8431
8432 /**
8433 * Get the intent to launch inside of an activity view when displaying this
8434 * notification. This {@code PendingIntent} should be for an activity.
8435 */
8436 public PendingIntent getDisplayIntent() {
8437 return mDisplayIntent;
8438 }
8439
8440 /**
8441 * Add an additional page of content to display with this notification. The current
8442 * notification forms the first page, and pages added using this function form
8443 * subsequent pages. This field can be used to separate a notification into multiple
8444 * sections.
8445 *
8446 * @param page the notification to add as another page
8447 * @return this object for method chaining
8448 * @see android.app.Notification.WearableExtender#getPages
8449 */
8450 public WearableExtender addPage(Notification page) {
8451 mPages.add(page);
8452 return this;
8453 }
8454
8455 /**
8456 * Add additional pages of content to display with this notification. The current
8457 * notification forms the first page, and pages added using this function form
8458 * subsequent pages. This field can be used to separate a notification into multiple
8459 * sections.
8460 *
8461 * @param pages a list of notifications
8462 * @return this object for method chaining
8463 * @see android.app.Notification.WearableExtender#getPages
8464 */
8465 public WearableExtender addPages(List<Notification> pages) {
8466 mPages.addAll(pages);
8467 return this;
8468 }
8469
8470 /**
8471 * Clear all additional pages present on this builder.
8472 * @return this object for method chaining.
8473 * @see #addPage
8474 */
8475 public WearableExtender clearPages() {
8476 mPages.clear();
8477 return this;
8478 }
8479
8480 /**
8481 * Get the array of additional pages of content for displaying this notification. The
8482 * current notification forms the first page, and elements within this array form
8483 * subsequent pages. This field can be used to separate a notification into multiple
8484 * sections.
8485 * @return the pages for this notification
8486 */
8487 public List<Notification> getPages() {
8488 return mPages;
8489 }
8490
8491 /**
8492 * Set a background image to be displayed behind the notification content.
8493 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8494 * will work with any notification style.
8495 *
8496 * @param background the background bitmap
8497 * @return this object for method chaining
8498 * @see android.app.Notification.WearableExtender#getBackground
8499 */
8500 public WearableExtender setBackground(Bitmap background) {
8501 mBackground = background;
8502 return this;
8503 }
8504
8505 /**
8506 * Get a background image to be displayed behind the notification content.
8507 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8508 * will work with any notification style.
8509 *
8510 * @return the background image
8511 * @see android.app.Notification.WearableExtender#setBackground
8512 */
8513 public Bitmap getBackground() {
8514 return mBackground;
8515 }
8516
8517 /**
8518 * Set an icon that goes with the content of this notification.
8519 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008520 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008521 public WearableExtender setContentIcon(int icon) {
8522 mContentIcon = icon;
8523 return this;
8524 }
8525
8526 /**
8527 * Get an icon that goes with the content of this notification.
8528 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008529 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008530 public int getContentIcon() {
8531 return mContentIcon;
8532 }
8533
8534 /**
8535 * Set the gravity that the content icon should have within the notification display.
8536 * Supported values include {@link android.view.Gravity#START} and
8537 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8538 * @see #setContentIcon
8539 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008540 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008541 public WearableExtender setContentIconGravity(int contentIconGravity) {
8542 mContentIconGravity = contentIconGravity;
8543 return this;
8544 }
8545
8546 /**
8547 * Get the gravity that the content icon should have within the notification display.
8548 * Supported values include {@link android.view.Gravity#START} and
8549 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8550 * @see #getContentIcon
8551 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008552 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008553 public int getContentIconGravity() {
8554 return mContentIconGravity;
8555 }
8556
8557 /**
8558 * Set an action from this notification's actions to be clickable with the content of
Griff Hazen14f57992014-05-26 09:07:14 -07008559 * this notification. This action will no longer display separately from the
8560 * notification's content.
8561 *
Griff Hazenca48d352014-05-28 22:37:13 -07008562 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008563 * set, although the list of available actions comes from the main notification and not
8564 * from the child page's notification.
8565 *
8566 * @param actionIndex The index of the action to hoist onto the current notification page.
8567 * If wearable actions were added to the main notification, this index
8568 * will apply to that list, otherwise it will apply to the regular
8569 * actions list.
Griff Hazen61a9e862014-05-22 16:05:19 -07008570 */
8571 public WearableExtender setContentAction(int actionIndex) {
8572 mContentActionIndex = actionIndex;
8573 return this;
8574 }
8575
8576 /**
Griff Hazenca48d352014-05-28 22:37:13 -07008577 * Get the index of the notification action, if any, that was specified as being clickable
8578 * with the content of this notification. This action will no longer display separately
Griff Hazen14f57992014-05-26 09:07:14 -07008579 * from the notification's content.
Griff Hazen61a9e862014-05-22 16:05:19 -07008580 *
Griff Hazenca48d352014-05-28 22:37:13 -07008581 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008582 * set, although the list of available actions comes from the main notification and not
8583 * from the child page's notification.
8584 *
8585 * <p>If wearable specific actions were added to the main notification, this index will
8586 * apply to that list, otherwise it will apply to the regular actions list.
Griff Hazenca48d352014-05-28 22:37:13 -07008587 *
8588 * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected.
Griff Hazen61a9e862014-05-22 16:05:19 -07008589 */
8590 public int getContentAction() {
8591 return mContentActionIndex;
8592 }
8593
8594 /**
8595 * Set the gravity that this notification should have within the available viewport space.
8596 * Supported values include {@link android.view.Gravity#TOP},
8597 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8598 * The default value is {@link android.view.Gravity#BOTTOM}.
8599 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008600 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008601 public WearableExtender setGravity(int gravity) {
8602 mGravity = gravity;
8603 return this;
8604 }
8605
8606 /**
8607 * Get the gravity that this notification should have within the available viewport space.
8608 * Supported values include {@link android.view.Gravity#TOP},
8609 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8610 * The default value is {@link android.view.Gravity#BOTTOM}.
8611 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008612 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008613 public int getGravity() {
8614 return mGravity;
8615 }
8616
8617 /**
8618 * Set the custom size preset for the display of this notification out of the available
8619 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8620 * {@link #SIZE_LARGE}.
8621 * <p>Some custom size presets are only applicable for custom display notifications created
8622 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the
8623 * documentation for the preset in question. See also
8624 * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}.
8625 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008626 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008627 public WearableExtender setCustomSizePreset(int sizePreset) {
8628 mCustomSizePreset = sizePreset;
8629 return this;
8630 }
8631
8632 /**
8633 * Get the custom size preset for the display of this notification out of the available
8634 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8635 * {@link #SIZE_LARGE}.
8636 * <p>Some custom size presets are only applicable for custom display notifications created
8637 * using {@link #setDisplayIntent}. Check the documentation for the preset in question.
8638 * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}.
8639 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008640 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008641 public int getCustomSizePreset() {
8642 return mCustomSizePreset;
8643 }
8644
8645 /**
8646 * Set the custom height in pixels for the display of this notification's content.
8647 * <p>This option is only available for custom display notifications created
8648 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also
8649 * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and
8650 * {@link #getCustomContentHeight}.
8651 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008652 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008653 public WearableExtender setCustomContentHeight(int height) {
8654 mCustomContentHeight = height;
8655 return this;
8656 }
8657
8658 /**
8659 * Get the custom height in pixels for the display of this notification's content.
8660 * <p>This option is only available for custom display notifications created
8661 * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and
8662 * {@link #setCustomContentHeight}.
8663 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008664 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008665 public int getCustomContentHeight() {
8666 return mCustomContentHeight;
8667 }
8668
8669 /**
8670 * Set whether the scrolling position for the contents of this notification should start
8671 * at the bottom of the contents instead of the top when the contents are too long to
8672 * display within the screen. Default is false (start scroll at the top).
8673 */
8674 public WearableExtender setStartScrollBottom(boolean startScrollBottom) {
8675 setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom);
8676 return this;
8677 }
8678
8679 /**
8680 * Get whether the scrolling position for the contents of this notification should start
8681 * at the bottom of the contents instead of the top when the contents are too long to
8682 * display within the screen. Default is false (start scroll at the top).
8683 */
8684 public boolean getStartScrollBottom() {
8685 return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0;
8686 }
8687
8688 /**
8689 * Set whether the content intent is available when the wearable device is not connected
8690 * to a companion device. The user can still trigger this intent when the wearable device
8691 * is offline, but a visual hint will indicate that the content intent may not be available.
8692 * Defaults to true.
8693 */
8694 public WearableExtender setContentIntentAvailableOffline(
8695 boolean contentIntentAvailableOffline) {
8696 setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline);
8697 return this;
8698 }
8699
8700 /**
8701 * Get whether the content intent is available when the wearable device is not connected
8702 * to a companion device. The user can still trigger this intent when the wearable device
8703 * is offline, but a visual hint will indicate that the content intent may not be available.
8704 * Defaults to true.
8705 */
8706 public boolean getContentIntentAvailableOffline() {
8707 return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0;
8708 }
8709
8710 /**
8711 * Set a hint that this notification's icon should not be displayed.
8712 * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise.
8713 * @return this object for method chaining
8714 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008715 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008716 public WearableExtender setHintHideIcon(boolean hintHideIcon) {
8717 setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon);
8718 return this;
8719 }
8720
8721 /**
8722 * Get a hint that this notification's icon should not be displayed.
8723 * @return {@code true} if this icon should not be displayed, false otherwise.
8724 * The default value is {@code false} if this was never set.
8725 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008726 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008727 public boolean getHintHideIcon() {
8728 return (mFlags & FLAG_HINT_HIDE_ICON) != 0;
8729 }
8730
8731 /**
8732 * Set a visual hint that only the background image of this notification should be
8733 * displayed, and other semantic content should be hidden. This hint is only applicable
8734 * to sub-pages added using {@link #addPage}.
8735 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008736 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008737 public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) {
8738 setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly);
8739 return this;
8740 }
8741
8742 /**
8743 * Get a visual hint that only the background image of this notification should be
8744 * displayed, and other semantic content should be hidden. This hint is only applicable
8745 * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}.
8746 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008747 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008748 public boolean getHintShowBackgroundOnly() {
8749 return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0;
8750 }
8751
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008752 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008753 * Set a hint that this notification's background should not be clipped if possible,
8754 * and should instead be resized to fully display on the screen, retaining the aspect
8755 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008756 * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
8757 * @return this object for method chaining
8758 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008759 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008760 public WearableExtender setHintAvoidBackgroundClipping(
8761 boolean hintAvoidBackgroundClipping) {
8762 setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping);
8763 return this;
8764 }
8765
8766 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008767 * Get a hint that this notification's background should not be clipped if possible,
8768 * and should instead be resized to fully display on the screen, retaining the aspect
8769 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008770 * @return {@code true} if it's ok if the background is clipped on the screen, false
8771 * otherwise. The default value is {@code false} if this was never set.
8772 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008773 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008774 public boolean getHintAvoidBackgroundClipping() {
8775 return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0;
8776 }
8777
8778 /**
8779 * Set a hint that the screen should remain on for at least this duration when
8780 * this notification is displayed on the screen.
8781 * @param timeout The requested screen timeout in milliseconds. Can also be either
8782 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8783 * @return this object for method chaining
8784 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008785 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008786 public WearableExtender setHintScreenTimeout(int timeout) {
8787 mHintScreenTimeout = timeout;
8788 return this;
8789 }
8790
8791 /**
8792 * Get the duration, in milliseconds, that the screen should remain on for
8793 * when this notification is displayed.
8794 * @return the duration in milliseconds if > 0, or either one of the sentinel values
8795 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8796 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008797 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008798 public int getHintScreenTimeout() {
8799 return mHintScreenTimeout;
8800 }
8801
Alex Hills9ab3a232016-04-05 14:54:56 -04008802 /**
Alex Hills4bcb06b2016-04-05 14:26:25 -04008803 * Set a hint that this notification's {@link BigPictureStyle} (if present) should be
8804 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8805 * qr codes, as well as other simple black-and-white tickets.
8806 * @param hintAmbientBigPicture {@code true} to enable converstion and ambient.
8807 * @return this object for method chaining
8808 */
8809 public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) {
8810 setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture);
8811 return this;
8812 }
8813
8814 /**
8815 * Get a hint that this notification's {@link BigPictureStyle} (if present) should be
8816 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8817 * qr codes, as well as other simple black-and-white tickets.
8818 * @return {@code true} if it should be displayed in ambient, false otherwise
8819 * otherwise. The default value is {@code false} if this was never set.
8820 */
8821 public boolean getHintAmbientBigPicture() {
8822 return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0;
8823 }
8824
8825 /**
Alex Hills9ab3a232016-04-05 14:54:56 -04008826 * Set a hint that this notification's content intent will launch an {@link Activity}
8827 * directly, telling the platform that it can generate the appropriate transitions.
8828 * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch
8829 * an activity and transitions should be generated, false otherwise.
8830 * @return this object for method chaining
8831 */
8832 public WearableExtender setHintContentIntentLaunchesActivity(
8833 boolean hintContentIntentLaunchesActivity) {
8834 setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity);
8835 return this;
8836 }
8837
8838 /**
8839 * Get a hint that this notification's content intent will launch an {@link Activity}
8840 * directly, telling the platform that it can generate the appropriate transitions
8841 * @return {@code true} if the content intent will launch an activity and transitions should
8842 * be generated, false otherwise. The default value is {@code false} if this was never set.
8843 */
8844 public boolean getHintContentIntentLaunchesActivity() {
8845 return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0;
8846 }
8847
Nadia Benbernou948627e2016-04-14 14:41:08 -04008848 /**
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008849 * Sets the dismissal id for this notification. If a notification is posted with a
8850 * dismissal id, then when that notification is canceled, notifications on other wearables
8851 * and the paired Android phone having that same dismissal id will also be canceled. See
Nadia Benbernou948627e2016-04-14 14:41:08 -04008852 * <a href="{@docRoot}wear/notifications/index.html">Adding Wearable Features to
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008853 * Notifications</a> for more information.
Nadia Benbernou948627e2016-04-14 14:41:08 -04008854 * @param dismissalId the dismissal id of the notification.
8855 * @return this object for method chaining
8856 */
8857 public WearableExtender setDismissalId(String dismissalId) {
8858 mDismissalId = dismissalId;
8859 return this;
8860 }
8861
8862 /**
8863 * Returns the dismissal id of the notification.
8864 * @return the dismissal id of the notification or null if it has not been set.
8865 */
8866 public String getDismissalId() {
8867 return mDismissalId;
8868 }
8869
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008870 /**
8871 * Sets a bridge tag for this notification. A bridge tag can be set for notifications
8872 * posted from a phone to provide finer-grained control on what notifications are bridged
8873 * to wearables. See <a href="{@docRoot}wear/notifications/index.html">Adding Wearable
8874 * Features to Notifications</a> for more information.
8875 * @param bridgeTag the bridge tag of the notification.
8876 * @return this object for method chaining
8877 */
8878 public WearableExtender setBridgeTag(String bridgeTag) {
8879 mBridgeTag = bridgeTag;
8880 return this;
8881 }
8882
8883 /**
8884 * Returns the bridge tag of the notification.
8885 * @return the bridge tag or null if not present.
8886 */
8887 public String getBridgeTag() {
8888 return mBridgeTag;
8889 }
8890
Griff Hazen61a9e862014-05-22 16:05:19 -07008891 private void setFlag(int mask, boolean value) {
8892 if (value) {
8893 mFlags |= mask;
8894 } else {
8895 mFlags &= ~mask;
8896 }
8897 }
8898 }
8899
8900 /**
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008901 * <p>Helper class to add Android Auto extensions to notifications. To create a notification
8902 * with car extensions:
8903 *
8904 * <ol>
8905 * <li>Create an {@link Notification.Builder}, setting any desired
8906 * properties.
8907 * <li>Create a {@link CarExtender}.
8908 * <li>Set car-specific properties using the {@code add} and {@code set} methods of
8909 * {@link CarExtender}.
8910 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
8911 * to apply the extensions to a notification.
8912 * </ol>
8913 *
8914 * <pre class="prettyprint">
8915 * Notification notification = new Notification.Builder(context)
8916 * ...
8917 * .extend(new CarExtender()
8918 * .set*(...))
8919 * .build();
8920 * </pre>
8921 *
8922 * <p>Car extensions can be accessed on an existing notification by using the
8923 * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods
8924 * to access values.
8925 */
8926 public static final class CarExtender implements Extender {
8927 private static final String TAG = "CarExtender";
8928
8929 private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS";
8930 private static final String EXTRA_LARGE_ICON = "large_icon";
8931 private static final String EXTRA_CONVERSATION = "car_conversation";
8932 private static final String EXTRA_COLOR = "app_color";
8933
8934 private Bitmap mLargeIcon;
8935 private UnreadConversation mUnreadConversation;
8936 private int mColor = Notification.COLOR_DEFAULT;
8937
8938 /**
8939 * Create a {@link CarExtender} with default options.
8940 */
8941 public CarExtender() {
8942 }
8943
8944 /**
8945 * Create a {@link CarExtender} from the CarExtender options of an existing Notification.
8946 *
8947 * @param notif The notification from which to copy options.
8948 */
8949 public CarExtender(Notification notif) {
8950 Bundle carBundle = notif.extras == null ?
8951 null : notif.extras.getBundle(EXTRA_CAR_EXTENDER);
8952 if (carBundle != null) {
8953 mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON);
8954 mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT);
8955
8956 Bundle b = carBundle.getBundle(EXTRA_CONVERSATION);
8957 mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b);
8958 }
8959 }
8960
8961 /**
8962 * Apply car extensions to a notification that is being built. This is typically called by
8963 * the {@link Notification.Builder#extend(Notification.Extender)}
8964 * method of {@link Notification.Builder}.
8965 */
8966 @Override
8967 public Notification.Builder extend(Notification.Builder builder) {
8968 Bundle carExtensions = new Bundle();
8969
8970 if (mLargeIcon != null) {
8971 carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon);
8972 }
8973 if (mColor != Notification.COLOR_DEFAULT) {
8974 carExtensions.putInt(EXTRA_COLOR, mColor);
8975 }
8976
8977 if (mUnreadConversation != null) {
8978 Bundle b = mUnreadConversation.getBundleForUnreadConversation();
8979 carExtensions.putBundle(EXTRA_CONVERSATION, b);
8980 }
8981
8982 builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions);
8983 return builder;
8984 }
8985
8986 /**
8987 * Sets the accent color to use when Android Auto presents the notification.
8988 *
8989 * Android Auto uses the color set with {@link Notification.Builder#setColor(int)}
8990 * to accent the displayed notification. However, not all colors are acceptable in an
8991 * automotive setting. This method can be used to override the color provided in the
8992 * notification in such a situation.
8993 */
Tor Norbye80756e32015-03-02 09:39:27 -08008994 public CarExtender setColor(@ColorInt int color) {
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008995 mColor = color;
8996 return this;
8997 }
8998
8999 /**
9000 * Gets the accent color.
9001 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04009002 * @see #setColor
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009003 */
Tor Norbye80756e32015-03-02 09:39:27 -08009004 @ColorInt
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08009005 public int getColor() {
9006 return mColor;
9007 }
9008
9009 /**
9010 * Sets the large icon of the car notification.
9011 *
9012 * If no large icon is set in the extender, Android Auto will display the icon
9013 * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)}
9014 *
9015 * @param largeIcon The large icon to use in the car notification.
9016 * @return This object for method chaining.
9017 */
9018 public CarExtender setLargeIcon(Bitmap largeIcon) {
9019 mLargeIcon = largeIcon;
9020 return this;
9021 }
9022
9023 /**
9024 * Gets the large icon used in this car notification, or null if no icon has been set.
9025 *
9026 * @return The large icon for the car notification.
9027 * @see CarExtender#setLargeIcon
9028 */
9029 public Bitmap getLargeIcon() {
9030 return mLargeIcon;
9031 }
9032
9033 /**
9034 * Sets the unread conversation in a message notification.
9035 *
9036 * @param unreadConversation The unread part of the conversation this notification conveys.
9037 * @return This object for method chaining.
9038 */
9039 public CarExtender setUnreadConversation(UnreadConversation unreadConversation) {
9040 mUnreadConversation = unreadConversation;
9041 return this;
9042 }
9043
9044 /**
9045 * Returns the unread conversation conveyed by this notification.
9046 * @see #setUnreadConversation(UnreadConversation)
9047 */
9048 public UnreadConversation getUnreadConversation() {
9049 return mUnreadConversation;
9050 }
9051
9052 /**
9053 * A class which holds the unread messages from a conversation.
9054 */
9055 public static class UnreadConversation {
9056 private static final String KEY_AUTHOR = "author";
9057 private static final String KEY_TEXT = "text";
9058 private static final String KEY_MESSAGES = "messages";
9059 private static final String KEY_REMOTE_INPUT = "remote_input";
9060 private static final String KEY_ON_REPLY = "on_reply";
9061 private static final String KEY_ON_READ = "on_read";
9062 private static final String KEY_PARTICIPANTS = "participants";
9063 private static final String KEY_TIMESTAMP = "timestamp";
9064
9065 private final String[] mMessages;
9066 private final RemoteInput mRemoteInput;
9067 private final PendingIntent mReplyPendingIntent;
9068 private final PendingIntent mReadPendingIntent;
9069 private final String[] mParticipants;
9070 private final long mLatestTimestamp;
9071
9072 UnreadConversation(String[] messages, RemoteInput remoteInput,
9073 PendingIntent replyPendingIntent, PendingIntent readPendingIntent,
9074 String[] participants, long latestTimestamp) {
9075 mMessages = messages;
9076 mRemoteInput = remoteInput;
9077 mReadPendingIntent = readPendingIntent;
9078 mReplyPendingIntent = replyPendingIntent;
9079 mParticipants = participants;
9080 mLatestTimestamp = latestTimestamp;
9081 }
9082
9083 /**
9084 * Gets the list of messages conveyed by this notification.
9085 */
9086 public String[] getMessages() {
9087 return mMessages;
9088 }
9089
9090 /**
9091 * Gets the remote input that will be used to convey the response to a message list, or
9092 * null if no such remote input exists.
9093 */
9094 public RemoteInput getRemoteInput() {
9095 return mRemoteInput;
9096 }
9097
9098 /**
9099 * Gets the pending intent that will be triggered when the user replies to this
9100 * notification.
9101 */
9102 public PendingIntent getReplyPendingIntent() {
9103 return mReplyPendingIntent;
9104 }
9105
9106 /**
9107 * Gets the pending intent that Android Auto will send after it reads aloud all messages
9108 * in this object's message list.
9109 */
9110 public PendingIntent getReadPendingIntent() {
9111 return mReadPendingIntent;
9112 }
9113
9114 /**
9115 * Gets the participants in the conversation.
9116 */
9117 public String[] getParticipants() {
9118 return mParticipants;
9119 }
9120
9121 /**
9122 * Gets the firs participant in the conversation.
9123 */
9124 public String getParticipant() {
9125 return mParticipants.length > 0 ? mParticipants[0] : null;
9126 }
9127
9128 /**
9129 * Gets the timestamp of the conversation.
9130 */
9131 public long getLatestTimestamp() {
9132 return mLatestTimestamp;
9133 }
9134
9135 Bundle getBundleForUnreadConversation() {
9136 Bundle b = new Bundle();
9137 String author = null;
9138 if (mParticipants != null && mParticipants.length > 1) {
9139 author = mParticipants[0];
9140 }
9141 Parcelable[] messages = new Parcelable[mMessages.length];
9142 for (int i = 0; i < messages.length; i++) {
9143 Bundle m = new Bundle();
9144 m.putString(KEY_TEXT, mMessages[i]);
9145 m.putString(KEY_AUTHOR, author);
9146 messages[i] = m;
9147 }
9148 b.putParcelableArray(KEY_MESSAGES, messages);
9149 if (mRemoteInput != null) {
9150 b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput);
9151 }
9152 b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent);
9153 b.putParcelable(KEY_ON_READ, mReadPendingIntent);
9154 b.putStringArray(KEY_PARTICIPANTS, mParticipants);
9155 b.putLong(KEY_TIMESTAMP, mLatestTimestamp);
9156 return b;
9157 }
9158
9159 static UnreadConversation getUnreadConversationFromBundle(Bundle b) {
9160 if (b == null) {
9161 return null;
9162 }
9163 Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES);
9164 String[] messages = null;
9165 if (parcelableMessages != null) {
9166 String[] tmp = new String[parcelableMessages.length];
9167 boolean success = true;
9168 for (int i = 0; i < tmp.length; i++) {
9169 if (!(parcelableMessages[i] instanceof Bundle)) {
9170 success = false;
9171 break;
9172 }
9173 tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT);
9174 if (tmp[i] == null) {
9175 success = false;
9176 break;
9177 }
9178 }
9179 if (success) {
9180 messages = tmp;
9181 } else {
9182 return null;
9183 }
9184 }
9185
9186 PendingIntent onRead = b.getParcelable(KEY_ON_READ);
9187 PendingIntent onReply = b.getParcelable(KEY_ON_REPLY);
9188
9189 RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT);
9190
9191 String[] participants = b.getStringArray(KEY_PARTICIPANTS);
9192 if (participants == null || participants.length != 1) {
9193 return null;
9194 }
9195
9196 return new UnreadConversation(messages,
9197 remoteInput,
9198 onReply,
9199 onRead,
9200 participants, b.getLong(KEY_TIMESTAMP));
9201 }
9202 };
9203
9204 /**
9205 * Builder class for {@link CarExtender.UnreadConversation} objects.
9206 */
9207 public static class Builder {
9208 private final List<String> mMessages = new ArrayList<String>();
9209 private final String mParticipant;
9210 private RemoteInput mRemoteInput;
9211 private PendingIntent mReadPendingIntent;
9212 private PendingIntent mReplyPendingIntent;
9213 private long mLatestTimestamp;
9214
9215 /**
9216 * Constructs a new builder for {@link CarExtender.UnreadConversation}.
9217 *
9218 * @param name The name of the other participant in the conversation.
9219 */
9220 public Builder(String name) {
9221 mParticipant = name;
9222 }
9223
9224 /**
9225 * Appends a new unread message to the list of messages for this conversation.
9226 *
9227 * The messages should be added from oldest to newest.
9228 *
9229 * @param message The text of the new unread message.
9230 * @return This object for method chaining.
9231 */
9232 public Builder addMessage(String message) {
9233 mMessages.add(message);
9234 return this;
9235 }
9236
9237 /**
9238 * Sets the pending intent and remote input which will convey the reply to this
9239 * notification.
9240 *
9241 * @param pendingIntent The pending intent which will be triggered on a reply.
9242 * @param remoteInput The remote input parcelable which will carry the reply.
9243 * @return This object for method chaining.
9244 *
9245 * @see CarExtender.UnreadConversation#getRemoteInput
9246 * @see CarExtender.UnreadConversation#getReplyPendingIntent
9247 */
9248 public Builder setReplyAction(
9249 PendingIntent pendingIntent, RemoteInput remoteInput) {
9250 mRemoteInput = remoteInput;
9251 mReplyPendingIntent = pendingIntent;
9252
9253 return this;
9254 }
9255
9256 /**
9257 * Sets the pending intent that will be sent once the messages in this notification
9258 * are read.
9259 *
9260 * @param pendingIntent The pending intent to use.
9261 * @return This object for method chaining.
9262 */
9263 public Builder setReadPendingIntent(PendingIntent pendingIntent) {
9264 mReadPendingIntent = pendingIntent;
9265 return this;
9266 }
9267
9268 /**
9269 * Sets the timestamp of the most recent message in an unread conversation.
9270 *
9271 * If a messaging notification has been posted by your application and has not
9272 * yet been cancelled, posting a later notification with the same id and tag
9273 * but without a newer timestamp may result in Android Auto not displaying a
9274 * heads up notification for the later notification.
9275 *
9276 * @param timestamp The timestamp of the most recent message in the conversation.
9277 * @return This object for method chaining.
9278 */
9279 public Builder setLatestTimestamp(long timestamp) {
9280 mLatestTimestamp = timestamp;
9281 return this;
9282 }
9283
9284 /**
9285 * Builds a new unread conversation object.
9286 *
9287 * @return The new unread conversation object.
9288 */
9289 public UnreadConversation build() {
9290 String[] messages = mMessages.toArray(new String[mMessages.size()]);
9291 String[] participants = { mParticipant };
9292 return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent,
9293 mReadPendingIntent, participants, mLatestTimestamp);
9294 }
9295 }
9296 }
9297
9298 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009299 * <p>Helper class to add Android TV extensions to notifications. To create a notification
9300 * with a TV extension:
9301 *
9302 * <ol>
9303 * <li>Create an {@link Notification.Builder}, setting any desired properties.
9304 * <li>Create a {@link TvExtender}.
9305 * <li>Set TV-specific properties using the {@code set} methods of
9306 * {@link TvExtender}.
9307 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
9308 * to apply the extension to a notification.
9309 * </ol>
9310 *
9311 * <pre class="prettyprint">
9312 * Notification notification = new Notification.Builder(context)
9313 * ...
9314 * .extend(new TvExtender()
9315 * .set*(...))
9316 * .build();
9317 * </pre>
9318 *
9319 * <p>TV extensions can be accessed on an existing notification by using the
9320 * {@code TvExtender(Notification)} constructor, and then using the {@code get} methods
9321 * to access values.
9322 *
9323 * @hide
9324 */
9325 @SystemApi
9326 public static final class TvExtender implements Extender {
9327 private static final String TAG = "TvExtender";
9328
9329 private static final String EXTRA_TV_EXTENDER = "android.tv.EXTENSIONS";
9330 private static final String EXTRA_FLAGS = "flags";
9331 private static final String EXTRA_CONTENT_INTENT = "content_intent";
9332 private static final String EXTRA_DELETE_INTENT = "delete_intent";
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009333 private static final String EXTRA_CHANNEL_ID = "channel_id";
Rhiannon Malia1a083932018-01-24 15:02:30 -08009334 private static final String EXTRA_SUPPRESS_SHOW_OVER_APPS = "suppressShowOverApps";
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009335
9336 // Flags bitwise-ored to mFlags
9337 private static final int FLAG_AVAILABLE_ON_TV = 0x1;
9338
9339 private int mFlags;
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009340 private String mChannelId;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009341 private PendingIntent mContentIntent;
9342 private PendingIntent mDeleteIntent;
Rhiannon Malia1a083932018-01-24 15:02:30 -08009343 private boolean mSuppressShowOverApps;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009344
9345 /**
9346 * Create a {@link TvExtender} with default options.
9347 */
9348 public TvExtender() {
9349 mFlags = FLAG_AVAILABLE_ON_TV;
9350 }
9351
9352 /**
9353 * Create a {@link TvExtender} from the TvExtender options of an existing Notification.
9354 *
9355 * @param notif The notification from which to copy options.
9356 */
9357 public TvExtender(Notification notif) {
9358 Bundle bundle = notif.extras == null ?
9359 null : notif.extras.getBundle(EXTRA_TV_EXTENDER);
9360 if (bundle != null) {
9361 mFlags = bundle.getInt(EXTRA_FLAGS);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009362 mChannelId = bundle.getString(EXTRA_CHANNEL_ID);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009363 mSuppressShowOverApps = bundle.getBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009364 mContentIntent = bundle.getParcelable(EXTRA_CONTENT_INTENT);
9365 mDeleteIntent = bundle.getParcelable(EXTRA_DELETE_INTENT);
9366 }
9367 }
9368
9369 /**
9370 * Apply a TV extension to a notification that is being built. This is typically called by
9371 * the {@link Notification.Builder#extend(Notification.Extender)}
9372 * method of {@link Notification.Builder}.
9373 */
9374 @Override
9375 public Notification.Builder extend(Notification.Builder builder) {
9376 Bundle bundle = new Bundle();
9377
9378 bundle.putInt(EXTRA_FLAGS, mFlags);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009379 bundle.putString(EXTRA_CHANNEL_ID, mChannelId);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009380 bundle.putBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS, mSuppressShowOverApps);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009381 if (mContentIntent != null) {
9382 bundle.putParcelable(EXTRA_CONTENT_INTENT, mContentIntent);
9383 }
9384
9385 if (mDeleteIntent != null) {
9386 bundle.putParcelable(EXTRA_DELETE_INTENT, mDeleteIntent);
9387 }
9388
9389 builder.getExtras().putBundle(EXTRA_TV_EXTENDER, bundle);
9390 return builder;
9391 }
9392
9393 /**
9394 * Returns true if this notification should be shown on TV. This method return true
9395 * if the notification was extended with a TvExtender.
9396 */
9397 public boolean isAvailableOnTv() {
9398 return (mFlags & FLAG_AVAILABLE_ON_TV) != 0;
9399 }
9400
9401 /**
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009402 * Specifies the channel the notification should be delivered on when shown on TV.
9403 * It can be different from the channel that the notification is delivered to when
9404 * posting on a non-TV device.
9405 */
9406 public TvExtender setChannel(String channelId) {
9407 mChannelId = channelId;
9408 return this;
9409 }
9410
9411 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009412 * Specifies the channel the notification should be delivered on when shown on TV.
9413 * It can be different from the channel that the notification is delivered to when
9414 * posting on a non-TV device.
9415 */
9416 public TvExtender setChannelId(String channelId) {
9417 mChannelId = channelId;
9418 return this;
9419 }
9420
Jeff Sharkey000ce802017-04-29 13:13:27 -06009421 /** @removed */
9422 @Deprecated
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009423 public String getChannel() {
9424 return mChannelId;
9425 }
9426
9427 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009428 * Returns the id of the channel this notification posts to on TV.
9429 */
9430 public String getChannelId() {
9431 return mChannelId;
9432 }
9433
9434 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009435 * Supplies a {@link PendingIntent} to be sent when the notification is selected on TV.
9436 * If provided, it is used instead of the content intent specified
9437 * at the level of Notification.
9438 */
9439 public TvExtender setContentIntent(PendingIntent intent) {
9440 mContentIntent = intent;
9441 return this;
9442 }
9443
9444 /**
9445 * Returns the TV-specific content intent. If this method returns null, the
9446 * main content intent on the notification should be used.
9447 *
9448 * @see {@link Notification#contentIntent}
9449 */
9450 public PendingIntent getContentIntent() {
9451 return mContentIntent;
9452 }
9453
9454 /**
9455 * Supplies a {@link PendingIntent} to send when the notification is cleared explicitly
9456 * by the user on TV. If provided, it is used instead of the delete intent specified
9457 * at the level of Notification.
9458 */
9459 public TvExtender setDeleteIntent(PendingIntent intent) {
9460 mDeleteIntent = intent;
9461 return this;
9462 }
9463
9464 /**
9465 * Returns the TV-specific delete intent. If this method returns null, the
9466 * main delete intent on the notification should be used.
9467 *
9468 * @see {@link Notification#deleteIntent}
9469 */
9470 public PendingIntent getDeleteIntent() {
9471 return mDeleteIntent;
9472 }
Rhiannon Malia1a083932018-01-24 15:02:30 -08009473
9474 /**
9475 * Specifies whether this notification should suppress showing a message over top of apps
9476 * outside of the launcher.
9477 */
9478 public TvExtender setSuppressShowOverApps(boolean suppress) {
9479 mSuppressShowOverApps = suppress;
9480 return this;
9481 }
9482
9483 /**
9484 * Returns true if this notification should not show messages over top of apps
9485 * outside of the launcher.
9486 */
9487 public boolean getSuppressShowOverApps() {
9488 return mSuppressShowOverApps;
9489 }
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009490 }
9491
9492 /**
Griff Hazen61a9e862014-05-22 16:05:19 -07009493 * Get an array of Notification objects from a parcelable array bundle field.
9494 * Update the bundle to have a typed array so fetches in the future don't need
9495 * to do an array copy.
9496 */
9497 private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) {
9498 Parcelable[] array = bundle.getParcelableArray(key);
9499 if (array instanceof Notification[] || array == null) {
9500 return (Notification[]) array;
9501 }
9502 Notification[] typedArray = Arrays.copyOf(array, array.length,
9503 Notification[].class);
9504 bundle.putParcelableArray(key, typedArray);
9505 return typedArray;
9506 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02009507
9508 private static class BuilderRemoteViews extends RemoteViews {
9509 public BuilderRemoteViews(Parcel parcel) {
9510 super(parcel);
9511 }
9512
Kenny Guy77320062014-08-27 21:37:15 +01009513 public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) {
9514 super(appInfo, layoutId);
Christoph Studer4600f9b2014-07-22 22:44:43 +02009515 }
9516
9517 @Override
9518 public BuilderRemoteViews clone() {
9519 Parcel p = Parcel.obtain();
9520 writeToParcel(p, 0);
9521 p.setDataPosition(0);
9522 BuilderRemoteViews brv = new BuilderRemoteViews(p);
9523 p.recycle();
9524 return brv;
9525 }
9526 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08009527
Selim Cinek384804b2018-04-18 14:31:07 +08009528 /**
9529 * A result object where information about the template that was created is saved.
9530 */
9531 private static class TemplateBindResult {
Selim Cinek1c72fa02018-04-23 18:00:54 +08009532 int mIconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009533
9534 /**
Selim Cinek1c72fa02018-04-23 18:00:54 +08009535 * Get the margin end that needs to be added to any fields that may overlap
Selim Cinek384804b2018-04-18 14:31:07 +08009536 * with the right actions.
9537 */
Selim Cinek1c72fa02018-04-23 18:00:54 +08009538 public int getIconMarginEnd() {
9539 return mIconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009540 }
9541
Selim Cinek1c72fa02018-04-23 18:00:54 +08009542 public void setIconMarginEnd(int iconMarginEnd) {
9543 this.mIconMarginEnd = iconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009544 }
9545 }
9546
Adrian Roos70d7aa32017-01-11 15:39:06 -08009547 private static class StandardTemplateParams {
9548 boolean hasProgress = true;
9549 boolean ambient = false;
9550 CharSequence title;
9551 CharSequence text;
Selim Cinekafeed292017-12-12 17:32:44 -08009552 CharSequence headerTextSecondary;
Selim Cinek88188f22017-09-19 16:46:56 -07009553 boolean hideLargeIcon;
Selim Cinek384804b2018-04-18 14:31:07 +08009554 boolean hideReplyIcon;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009555
9556 final StandardTemplateParams reset() {
9557 hasProgress = true;
9558 ambient = false;
9559 title = null;
9560 text = null;
Selim Cinekafeed292017-12-12 17:32:44 -08009561 headerTextSecondary = null;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009562 return this;
9563 }
9564
9565 final StandardTemplateParams hasProgress(boolean hasProgress) {
9566 this.hasProgress = hasProgress;
9567 return this;
9568 }
9569
9570 final StandardTemplateParams title(CharSequence title) {
9571 this.title = title;
9572 return this;
9573 }
9574
9575 final StandardTemplateParams text(CharSequence text) {
9576 this.text = text;
9577 return this;
9578 }
9579
Selim Cinekafeed292017-12-12 17:32:44 -08009580 final StandardTemplateParams headerTextSecondary(CharSequence text) {
9581 this.headerTextSecondary = text;
9582 return this;
9583 }
9584
Selim Cinek384804b2018-04-18 14:31:07 +08009585 final StandardTemplateParams hideLargeIcon(boolean hideLargeIcon) {
9586 this.hideLargeIcon = hideLargeIcon;
Selim Cinek88188f22017-09-19 16:46:56 -07009587 return this;
9588 }
9589
Selim Cinek384804b2018-04-18 14:31:07 +08009590 final StandardTemplateParams hideReplyIcon(boolean hideReplyIcon) {
9591 this.hideReplyIcon = hideReplyIcon;
Selim Cinek88188f22017-09-19 16:46:56 -07009592 return this;
9593 }
9594
Adrian Roos70d7aa32017-01-11 15:39:06 -08009595 final StandardTemplateParams ambient(boolean ambient) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08009596 Preconditions.checkState(title == null && text == null, "must set ambient before text");
Adrian Roos70d7aa32017-01-11 15:39:06 -08009597 this.ambient = ambient;
9598 return this;
9599 }
9600
9601 final StandardTemplateParams fillTextsFrom(Builder b) {
9602 Bundle extras = b.mN.extras;
Lucas Dupin06c5e642017-09-13 16:34:58 -07009603 this.title = b.processLegacyText(extras.getCharSequence(EXTRA_TITLE), ambient);
9604
9605 // Big text notifications should contain their content when viewed in ambient mode.
9606 CharSequence text = extras.getCharSequence(EXTRA_BIG_TEXT);
9607 if (!ambient || TextUtils.isEmpty(text)) {
9608 text = extras.getCharSequence(EXTRA_TEXT);
9609 }
9610 this.text = b.processLegacyText(text, ambient);
Adrian Roos70d7aa32017-01-11 15:39:06 -08009611 return this;
9612 }
9613 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009614}