blob: c5b80196cf2666b6ebf842520d44db0a31ab1e78 [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) {
2725 return !first.usesStandardHeader() || !second.usesStandardHeader();
2726 }
2727
2728 /**
Robin Leead7e72a2017-12-04 15:45:46 +01002729 * Parcelling creates multiple copies of objects in {@code extras}. Fix them.
2730 * <p>
2731 * For backwards compatibility {@code extras} holds some references to "real" member data such
2732 * as {@link getLargeIcon()} which is mirrored by {@link #EXTRA_LARGE_ICON}. This is mostly
2733 * fine as long as the object stays in one process.
2734 * <p>
2735 * However, once the notification goes into a parcel each reference gets marshalled separately,
2736 * wasting memory. Especially with large images on Auto and TV, this is worth fixing.
2737 */
2738 private void fixDuplicateExtras() {
2739 if (extras != null) {
2740 fixDuplicateExtra(mSmallIcon, EXTRA_SMALL_ICON);
2741 fixDuplicateExtra(mLargeIcon, EXTRA_LARGE_ICON);
2742 }
2743 }
2744
2745 /**
2746 * If we find an extra that's exactly the same as one of the "real" fields but refers to a
2747 * separate object, replace it with the field's version to avoid holding duplicate copies.
2748 */
2749 private void fixDuplicateExtra(@Nullable Parcelable original, @NonNull String extraName) {
2750 if (original != null && extras.getParcelable(extraName) != null) {
2751 extras.putParcelable(extraName, original);
2752 }
2753 }
2754
2755 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002756 * Sets the {@link #contentView} field to be a view with the standard "Latest Event"
2757 * layout.
2758 *
2759 * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields
2760 * in the view.</p>
2761 * @param context The context for your application / activity.
2762 * @param contentTitle The title that goes in the expanded entry.
2763 * @param contentText The text that goes in the expanded entry.
2764 * @param contentIntent The intent to launch when the user clicks the expanded notification.
2765 * If this is an activity, it must include the
2766 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -08002767 * that you take care of task management as described in the
2768 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2769 * Stack</a> document.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002770 *
Joe Onorato46439ce2010-11-19 13:56:21 -08002771 * @deprecated Use {@link Builder} instead.
Chris Wrena05db382015-06-24 15:18:34 -04002772 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002773 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002774 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002775 public void setLatestEventInfo(Context context,
2776 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002777 if (context.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.LOLLIPOP_MR1){
2778 Log.e(TAG, "setLatestEventInfo() is deprecated and you should feel deprecated.",
2779 new Throwable());
2780 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002781
Selim Cinek4ac6f602016-06-13 15:47:03 -07002782 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
2783 extras.putBoolean(EXTRA_SHOW_WHEN, true);
2784 }
2785
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002786 // ensure that any information already set directly is preserved
2787 final Notification.Builder builder = new Notification.Builder(context, this);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002788
2789 // now apply the latestEventInfo fields
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002790 if (contentTitle != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002791 builder.setContentTitle(contentTitle);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002792 }
2793 if (contentText != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002794 builder.setContentText(contentText);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002795 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002796 builder.setContentIntent(contentIntent);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002797
2798 builder.build(); // callers expect this notification to be ready to use
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002799 }
2800
Julia Reynoldsda303542015-11-23 14:00:20 -05002801 /**
2802 * @hide
2803 */
2804 public static void addFieldsFromContext(Context context, Notification notification) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04002805 addFieldsFromContext(context.getApplicationInfo(), notification);
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002806 }
2807
2808 /**
2809 * @hide
2810 */
Julia Reynoldse071abd2017-03-22 10:52:11 -04002811 public static void addFieldsFromContext(ApplicationInfo ai, Notification notification) {
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002812 notification.extras.putParcelable(EXTRA_BUILDER_APPLICATION_INFO, ai);
Julia Reynoldsda303542015-11-23 14:00:20 -05002813 }
2814
Yi Jin6b514142017-10-30 14:54:12 -07002815 /**
2816 * @hide
2817 */
2818 public void writeToProto(ProtoOutputStream proto, long fieldId) {
2819 long token = proto.start(fieldId);
2820 proto.write(NotificationProto.CHANNEL_ID, getChannelId());
2821 proto.write(NotificationProto.HAS_TICKER_TEXT, this.tickerText != null);
2822 proto.write(NotificationProto.FLAGS, this.flags);
2823 proto.write(NotificationProto.COLOR, this.color);
2824 proto.write(NotificationProto.CATEGORY, this.category);
2825 proto.write(NotificationProto.GROUP_KEY, this.mGroupKey);
2826 proto.write(NotificationProto.SORT_KEY, this.mSortKey);
2827 if (this.actions != null) {
2828 proto.write(NotificationProto.ACTION_LENGTH, this.actions.length);
2829 }
2830 if (this.visibility >= VISIBILITY_SECRET && this.visibility <= VISIBILITY_PUBLIC) {
2831 proto.write(NotificationProto.VISIBILITY, this.visibility);
2832 }
2833 if (publicVersion != null) {
2834 publicVersion.writeToProto(proto, NotificationProto.PUBLIC_VERSION);
2835 }
2836 proto.end(token);
2837 }
2838
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002839 @Override
2840 public String toString() {
2841 StringBuilder sb = new StringBuilder();
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002842 sb.append("Notification(channel=");
Julia Reynoldsbad42972017-04-25 13:52:49 -04002843 sb.append(getChannelId());
Julia Reynoldsb9e712e2017-04-17 10:31:03 -04002844 sb.append(" pri=");
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002845 sb.append(priority);
2846 sb.append(" contentView=");
Joe Onoratoc9596d62011-01-12 17:03:11 -08002847 if (contentView != null) {
2848 sb.append(contentView.getPackage());
2849 sb.append("/0x");
2850 sb.append(Integer.toHexString(contentView.getLayoutId()));
2851 } else {
2852 sb.append("null");
2853 }
2854 sb.append(" vibrate=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002855 if ((this.defaults & DEFAULT_VIBRATE) != 0) {
2856 sb.append("default");
2857 } else if (this.vibrate != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002858 int N = this.vibrate.length-1;
2859 sb.append("[");
2860 for (int i=0; i<N; i++) {
2861 sb.append(this.vibrate[i]);
2862 sb.append(',');
2863 }
Simon Schoar8cf97d92009-06-10 22:08:37 +02002864 if (N != -1) {
2865 sb.append(this.vibrate[N]);
2866 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002867 sb.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002868 } else {
2869 sb.append("null");
2870 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002871 sb.append(" sound=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002872 if ((this.defaults & DEFAULT_SOUND) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002873 sb.append("default");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002874 } else if (this.sound != null) {
2875 sb.append(this.sound.toString());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002876 } else {
2877 sb.append("null");
2878 }
Chris Wren365b6d32015-07-16 10:39:26 -04002879 if (this.tickerText != null) {
2880 sb.append(" tick");
2881 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002882 sb.append(" defaults=0x");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002883 sb.append(Integer.toHexString(this.defaults));
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002884 sb.append(" flags=0x");
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002885 sb.append(Integer.toHexString(this.flags));
Dan Sandler26e81cf2014-05-06 10:01:27 -04002886 sb.append(String.format(" color=0x%08x", this.color));
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002887 if (this.category != null) {
2888 sb.append(" category=");
2889 sb.append(this.category);
2890 }
2891 if (this.mGroupKey != null) {
2892 sb.append(" groupKey=");
2893 sb.append(this.mGroupKey);
2894 }
2895 if (this.mSortKey != null) {
2896 sb.append(" sortKey=");
2897 sb.append(this.mSortKey);
2898 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002899 if (actions != null) {
Dan Sandler1b718782014-07-18 12:43:45 -04002900 sb.append(" actions=");
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002901 sb.append(actions.length);
Dan Sandler1b718782014-07-18 12:43:45 -04002902 }
2903 sb.append(" vis=");
2904 sb.append(visibilityToString(this.visibility));
2905 if (this.publicVersion != null) {
2906 sb.append(" publicVersion=");
2907 sb.append(publicVersion.toString());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002908 }
2909 sb.append(")");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002910 return sb.toString();
2911 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002912
Dan Sandler1b718782014-07-18 12:43:45 -04002913 /**
2914 * {@hide}
2915 */
2916 public static String visibilityToString(int vis) {
2917 switch (vis) {
2918 case VISIBILITY_PRIVATE:
2919 return "PRIVATE";
2920 case VISIBILITY_PUBLIC:
2921 return "PUBLIC";
2922 case VISIBILITY_SECRET:
2923 return "SECRET";
2924 default:
2925 return "UNKNOWN(" + String.valueOf(vis) + ")";
2926 }
2927 }
2928
Joe Onoratocb109a02011-01-18 17:57:41 -08002929 /**
John Spurlock1d881a12015-03-18 19:21:54 -04002930 * {@hide}
2931 */
2932 public static String priorityToString(@Priority int pri) {
2933 switch (pri) {
2934 case PRIORITY_MIN:
2935 return "MIN";
2936 case PRIORITY_LOW:
2937 return "LOW";
2938 case PRIORITY_DEFAULT:
2939 return "DEFAULT";
2940 case PRIORITY_HIGH:
2941 return "HIGH";
2942 case PRIORITY_MAX:
2943 return "MAX";
2944 default:
2945 return "UNKNOWN(" + String.valueOf(pri) + ")";
2946 }
2947 }
2948
Julia Reynolds6ad0aec2017-07-05 08:47:03 -04002949 /**
2950 * @hide
2951 */
2952 public boolean hasCompletedProgress() {
2953 // not a progress notification; can't be complete
2954 if (!extras.containsKey(EXTRA_PROGRESS)
2955 || !extras.containsKey(EXTRA_PROGRESS_MAX)) {
2956 return false;
2957 }
2958 // many apps use max 0 for 'indeterminate'; not complete
2959 if (extras.getInt(EXTRA_PROGRESS_MAX) == 0) {
2960 return false;
2961 }
2962 return extras.getInt(EXTRA_PROGRESS) == extras.getInt(EXTRA_PROGRESS_MAX);
2963 }
2964
Jeff Sharkey000ce802017-04-29 13:13:27 -06002965 /** @removed */
2966 @Deprecated
Julia Reynolds37856052016-11-11 09:20:07 -05002967 public String getChannel() {
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04002968 return mChannelId;
2969 }
2970
2971 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04002972 * Returns the id of the channel this notification posts to.
2973 */
2974 public String getChannelId() {
2975 return mChannelId;
2976 }
2977
Jeff Sharkey000ce802017-04-29 13:13:27 -06002978 /** @removed */
2979 @Deprecated
Julia Reynolds2a128742016-11-28 14:29:25 -05002980 public long getTimeout() {
2981 return mTimeout;
2982 }
2983
2984 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04002985 * Returns the duration from posting after which this notification should be canceled by the
2986 * system, if it's not canceled already.
2987 */
2988 public long getTimeoutAfter() {
2989 return mTimeout;
2990 }
2991
2992 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04002993 * Returns what icon should be shown for this notification if it is being displayed in a
2994 * Launcher that supports badging. Will be one of {@link #BADGE_ICON_NONE},
2995 * {@link #BADGE_ICON_SMALL}, or {@link #BADGE_ICON_LARGE}.
2996 */
2997 public int getBadgeIconType() {
2998 return mBadgeIcon;
2999 }
3000
3001 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003002 * Returns the {@link ShortcutInfo#getId() id} that this notification supersedes, if any.
Julia Reynoldsbad42972017-04-25 13:52:49 -04003003 *
3004 * <p>Used by some Launchers that display notification content to hide shortcuts that duplicate
3005 * notifications.
Julia Reynolds13d898c2017-02-02 12:22:05 -05003006 */
3007 public String getShortcutId() {
3008 return mShortcutId;
3009 }
3010
Julia Reynolds3aedded2017-03-31 14:42:09 -04003011
3012 /**
3013 * Returns the settings text provided to {@link Builder#setSettingsText(CharSequence)}.
3014 */
3015 public CharSequence getSettingsText() {
3016 return mSettingsText;
3017 }
3018
Julia Reynolds13d898c2017-02-02 12:22:05 -05003019 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003020 * Returns which type of notifications in a group are responsible for audibly alerting the
3021 * user. See {@link #GROUP_ALERT_ALL}, {@link #GROUP_ALERT_CHILDREN},
3022 * {@link #GROUP_ALERT_SUMMARY}.
3023 */
3024 public @GroupAlertBehavior int getGroupAlertBehavior() {
3025 return mGroupAlertBehavior;
3026 }
3027
3028 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04003029 * The small icon representing this notification in the status bar and content view.
3030 *
3031 * @return the small icon representing this notification.
3032 *
3033 * @see Builder#getSmallIcon()
3034 * @see Builder#setSmallIcon(Icon)
3035 */
3036 public Icon getSmallIcon() {
3037 return mSmallIcon;
3038 }
3039
3040 /**
3041 * Used when notifying to clean up legacy small icons.
3042 * @hide
3043 */
3044 public void setSmallIcon(Icon icon) {
3045 mSmallIcon = icon;
3046 }
3047
3048 /**
3049 * The large icon shown in this notification's content view.
3050 * @see Builder#getLargeIcon()
3051 * @see Builder#setLargeIcon(Icon)
3052 */
3053 public Icon getLargeIcon() {
3054 return mLargeIcon;
3055 }
3056
3057 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +02003058 * @hide
3059 */
Christoph Studerc8db24b2014-07-25 17:50:30 +02003060 public boolean isGroupSummary() {
3061 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) != 0;
3062 }
3063
3064 /**
3065 * @hide
3066 */
3067 public boolean isGroupChild() {
3068 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) == 0;
3069 }
3070
3071 /**
Julia Reynolds30203152017-05-26 13:36:31 -04003072 * @hide
3073 */
3074 public boolean suppressAlertingDueToGrouping() {
3075 if (isGroupSummary()
3076 && getGroupAlertBehavior() == Notification.GROUP_ALERT_CHILDREN) {
3077 return true;
3078 } else if (isGroupChild()
3079 && getGroupAlertBehavior() == Notification.GROUP_ALERT_SUMMARY) {
3080 return true;
3081 }
3082 return false;
3083 }
3084
3085 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003086 * Builder class for {@link Notification} objects.
Joe Malin8d40d042012-11-05 11:36:40 -08003087 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003088 * Provides a convenient way to set the various fields of a {@link Notification} and generate
Scott Main183bf112012-08-13 19:12:13 -07003089 * content views using the platform's notification layout template. If your app supports
3090 * versions of Android as old as API level 4, you can instead use
3091 * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder},
3092 * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support
3093 * library</a>.
Joe Malin8d40d042012-11-05 11:36:40 -08003094 *
Scott Main183bf112012-08-13 19:12:13 -07003095 * <p>Example:
Joe Malin8d40d042012-11-05 11:36:40 -08003096 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003097 * <pre class="prettyprint">
Scott Main183bf112012-08-13 19:12:13 -07003098 * Notification noti = new Notification.Builder(mContext)
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003099 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
3100 * .setContentText(subject)
3101 * .setSmallIcon(R.drawable.new_mail)
3102 * .setLargeIcon(aBitmap)
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003103 * .build();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003104 * </pre>
Joe Onoratocb109a02011-01-18 17:57:41 -08003105 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003106 public static class Builder {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003107 /**
3108 * @hide
3109 */
3110 public static final String EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT =
3111 "android.rebuild.contentViewActionCount";
3112 /**
3113 * @hide
3114 */
3115 public static final String EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT
3116 = "android.rebuild.bigViewActionCount";
3117 /**
3118 * @hide
3119 */
3120 public static final String EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT
3121 = "android.rebuild.hudViewActionCount";
3122
Daniel Sandler602ad1c2012-06-12 16:06:27 -04003123 private static final int MAX_ACTION_BUTTONS = 3;
Daniel Sandler8680bf82012-05-15 16:52:52 -04003124
Selim Cinek6743c0b2017-01-18 18:24:01 -08003125 private static final boolean USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY =
3126 SystemProperties.getBoolean("notifications.only_title", true);
3127
Selim Cinek389edcd2017-05-11 19:16:44 -07003128 /**
3129 * The lightness difference that has to be added to the primary text color to obtain the
3130 * secondary text color when the background is light.
3131 */
3132 private static final int LIGHTNESS_TEXT_DIFFERENCE_LIGHT = 20;
3133
3134 /**
3135 * The lightness difference that has to be added to the primary text color to obtain the
3136 * secondary text color when the background is dark.
3137 * A bit less then the above value, since it looks better on dark backgrounds.
3138 */
3139 private static final int LIGHTNESS_TEXT_DIFFERENCE_DARK = -10;
3140
Joe Onorato46439ce2010-11-19 13:56:21 -08003141 private Context mContext;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003142 private Notification mN;
3143 private Bundle mUserExtras = new Bundle();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003144 private Style mStyle;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003145 private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS);
Selim Cineke7238dd2017-12-14 17:48:32 -08003146 private ArrayList<Person> mPersonList = new ArrayList<>();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003147 private NotificationColorUtil mColorUtil;
Selim Cinek7b9605b2017-01-19 17:36:00 -08003148 private boolean mIsLegacy;
3149 private boolean mIsLegacyInitialized;
Christoph Studer7ac80e62014-08-04 16:01:57 +02003150
3151 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -08003152 * Caches a contrast-enhanced version of {@link #mCachedContrastColorIsFor}.
3153 */
3154 private int mCachedContrastColor = COLOR_INVALID;
3155 private int mCachedContrastColorIsFor = COLOR_INVALID;
Adrian Roos487374f2017-01-11 15:48:14 -08003156 /**
Selim Cinek4717d862018-04-19 09:19:15 +08003157 * Caches a ambient version of {@link #mCachedAmbientColorIsFor}.
Adrian Roos487374f2017-01-11 15:48:14 -08003158 */
3159 private int mCachedAmbientColor = COLOR_INVALID;
3160 private int mCachedAmbientColorIsFor = COLOR_INVALID;
Selim Cinek4717d862018-04-19 09:19:15 +08003161 /**
3162 * A neutral color color that can be used for icons.
3163 */
3164 private int mNeutralColor = COLOR_INVALID;
Adrian Roos4ff3b122016-02-01 12:26:13 -08003165
3166 /**
Adrian Roos70d7aa32017-01-11 15:39:06 -08003167 * Caches an instance of StandardTemplateParams. Note that this may have been used before,
3168 * so make sure to call {@link StandardTemplateParams#reset()} before using it.
3169 */
3170 StandardTemplateParams mParams = new StandardTemplateParams();
Selim Cinek7b9605b2017-01-19 17:36:00 -08003171 private int mTextColorsAreForBackground = COLOR_INVALID;
3172 private int mPrimaryTextColor = COLOR_INVALID;
3173 private int mSecondaryTextColor = COLOR_INVALID;
Selim Cinek5fb73f82017-04-20 16:55:38 -07003174 private int mBackgroundColor = COLOR_INVALID;
3175 private int mForegroundColor = COLOR_INVALID;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07003176 /**
3177 * A temporary location where actions are stored. If != null the view originally has action
3178 * but doesn't have any for this inflation.
3179 */
3180 private ArrayList<Action> mOriginalActions;
Selim Cineka7679b62017-05-10 16:33:25 -07003181 private boolean mRebuildStyledRemoteViews;
Adrian Roos70d7aa32017-01-11 15:39:06 -08003182
Anthony Chenad4d1582017-04-10 16:07:58 -07003183 private boolean mTintActionButtons;
3184 private boolean mInNightMode;
3185
Adrian Roos70d7aa32017-01-11 15:39:06 -08003186 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003187 * Constructs a new Builder with the defaults:
Joe Onoratocb109a02011-01-18 17:57:41 -08003188 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003189 * @param context
3190 * A {@link Context} that will be used by the Builder to construct the
3191 * RemoteViews. The Context will not be held past the lifetime of this Builder
3192 * object.
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003193 * @param channelId
3194 * The constructed Notification will be posted on this
3195 * {@link NotificationChannel}. To use a NotificationChannel, it must first be
3196 * created using {@link NotificationManager#createNotificationChannel}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003197 */
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003198 public Builder(Context context, String channelId) {
3199 this(context, (Notification) null);
3200 mN.mChannelId = channelId;
3201 }
3202
3203 /**
3204 * @deprecated use {@link Notification.Builder#Notification.Builder(Context, String)}
3205 * instead. All posted Notifications must specify a NotificationChannel Id.
3206 */
3207 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003208 public Builder(Context context) {
Geoffrey Pitsch5caa2762017-01-12 09:35:54 -05003209 this(context, (Notification) null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003210 }
3211
Joe Onoratocb109a02011-01-18 17:57:41 -08003212 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003213 * @hide
Christoph Studer4600f9b2014-07-22 22:44:43 +02003214 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003215 public Builder(Context context, Notification toAdopt) {
3216 mContext = context;
Anthony Chenad4d1582017-04-10 16:07:58 -07003217 Resources res = mContext.getResources();
3218 mTintActionButtons = res.getBoolean(R.bool.config_tintNotificationActionButtons);
3219
3220 if (res.getBoolean(R.bool.config_enableNightMode)) {
3221 Configuration currentConfig = res.getConfiguration();
3222 mInNightMode = (currentConfig.uiMode & Configuration.UI_MODE_NIGHT_MASK)
3223 == Configuration.UI_MODE_NIGHT_YES;
3224 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02003225
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003226 if (toAdopt == null) {
3227 mN = new Notification();
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003228 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
3229 mN.extras.putBoolean(EXTRA_SHOW_WHEN, true);
3230 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003231 mN.priority = PRIORITY_DEFAULT;
3232 mN.visibility = VISIBILITY_PRIVATE;
3233 } else {
3234 mN = toAdopt;
3235 if (mN.actions != null) {
3236 Collections.addAll(mActions, mN.actions);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003237 }
3238
Selim Cineke7238dd2017-12-14 17:48:32 -08003239 if (mN.extras.containsKey(EXTRA_PEOPLE_LIST)) {
3240 ArrayList<Person> people = mN.extras.getParcelableArrayList(EXTRA_PEOPLE_LIST);
3241 mPersonList.addAll(people);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003242 }
3243
Selim Cinek4ac6f602016-06-13 15:47:03 -07003244 if (mN.getSmallIcon() == null && mN.icon != 0) {
3245 setSmallIcon(mN.icon);
3246 }
3247
3248 if (mN.getLargeIcon() == null && mN.largeIcon != null) {
3249 setLargeIcon(mN.largeIcon);
3250 }
3251
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003252 String templateClass = mN.extras.getString(EXTRA_TEMPLATE);
3253 if (!TextUtils.isEmpty(templateClass)) {
3254 final Class<? extends Style> styleClass
3255 = getNotificationStyleClass(templateClass);
3256 if (styleClass == null) {
3257 Log.d(TAG, "Unknown style class: " + templateClass);
3258 } else {
3259 try {
Adrian Roosc1a80b02016-04-05 14:54:55 -07003260 final Constructor<? extends Style> ctor =
3261 styleClass.getDeclaredConstructor();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003262 ctor.setAccessible(true);
3263 final Style style = ctor.newInstance();
3264 style.restoreFromExtras(mN.extras);
3265
3266 if (style != null) {
3267 setStyle(style);
3268 }
3269 } catch (Throwable t) {
3270 Log.e(TAG, "Could not create Style", t);
3271 }
3272 }
3273 }
3274
3275 }
3276 }
3277
3278 private NotificationColorUtil getColorUtil() {
Selim Cinek99104832017-01-25 14:47:33 -08003279 if (mColorUtil == null) {
3280 mColorUtil = NotificationColorUtil.getInstance(mContext);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003281 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003282 return mColorUtil;
Christoph Studer4600f9b2014-07-22 22:44:43 +02003283 }
3284
3285 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003286 * If this notification is duplicative of a Launcher shortcut, sets the
3287 * {@link ShortcutInfo#getId() id} of the shortcut, in case the Launcher wants to hide
3288 * the shortcut.
3289 *
Julia Reynoldsbad42972017-04-25 13:52:49 -04003290 * This field will be ignored by Launchers that don't support badging, don't show
3291 * notification content, or don't show {@link android.content.pm.ShortcutManager shortcuts}.
Julia Reynolds13d898c2017-02-02 12:22:05 -05003292 *
3293 * @param shortcutId the {@link ShortcutInfo#getId() id} of the shortcut this notification
3294 * supersedes
3295 */
3296 public Builder setShortcutId(String shortcutId) {
3297 mN.mShortcutId = shortcutId;
3298 return this;
3299 }
3300
3301 /**
Julia Reynoldse071abd2017-03-22 10:52:11 -04003302 * Sets which icon to display as a badge for this notification.
3303 *
3304 * Must be one of {@link #BADGE_ICON_NONE}, {@link #BADGE_ICON_SMALL},
3305 * {@link #BADGE_ICON_LARGE}.
3306 *
3307 * Note: This value might be ignored, for launchers that don't support badge icons.
3308 */
Julia Reynolds612beb22017-03-30 10:48:30 -04003309 public Builder setBadgeIconType(int icon) {
Julia Reynoldse071abd2017-03-22 10:52:11 -04003310 mN.mBadgeIcon = icon;
3311 return this;
3312 }
3313
3314 /**
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003315 * Sets the group alert behavior for this notification. Use this method to mute this
3316 * notification if alerts for this notification's group should be handled by a different
3317 * notification. This is only applicable for notifications that belong to a
Julia Reynolds399d9bf2017-08-11 12:52:14 -04003318 * {@link #setGroup(String) group}. This must be called on all notifications you want to
3319 * mute. For example, if you want only the summary of your group to make noise, all
3320 * children in the group should have the group alert behavior {@link #GROUP_ALERT_SUMMARY}.
Julia Reynoldsa79c3712017-04-21 10:29:57 -04003321 *
3322 * <p> The default value is {@link #GROUP_ALERT_ALL}.</p>
3323 */
3324 public Builder setGroupAlertBehavior(@GroupAlertBehavior int groupAlertBehavior) {
3325 mN.mGroupAlertBehavior = groupAlertBehavior;
3326 return this;
3327 }
3328
Jeff Sharkey000ce802017-04-29 13:13:27 -06003329 /** @removed */
3330 @Deprecated
Julia Reynoldsb5e44b72016-08-16 15:00:25 -04003331 public Builder setChannel(String channelId) {
3332 mN.mChannelId = channelId;
3333 return this;
3334 }
3335
3336 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003337 * Specifies the channel the notification should be delivered on.
3338 */
3339 public Builder setChannelId(String channelId) {
3340 mN.mChannelId = channelId;
3341 return this;
3342 }
3343
Jeff Sharkey000ce802017-04-29 13:13:27 -06003344 /** @removed */
3345 @Deprecated
Julia Reynolds50989772017-02-23 14:32:16 -05003346 public Builder setTimeout(long durationMs) {
3347 mN.mTimeout = durationMs;
Julia Reynolds2a128742016-11-28 14:29:25 -05003348 return this;
3349 }
3350
3351 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04003352 * Specifies a duration in milliseconds after which this notification should be canceled,
3353 * if it is not already canceled.
3354 */
3355 public Builder setTimeoutAfter(long durationMs) {
3356 mN.mTimeout = durationMs;
3357 return this;
3358 }
3359
3360 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003361 * Add a timestamp pertaining to the notification (usually the time the event occurred).
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003362 *
3363 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not
3364 * shown anymore by default and must be opted into by using
3365 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003366 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003367 * @see Notification#when
Joe Onoratocb109a02011-01-18 17:57:41 -08003368 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003369 public Builder setWhen(long when) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003370 mN.when = when;
Joe Onorato46439ce2010-11-19 13:56:21 -08003371 return this;
3372 }
3373
Joe Onoratocb109a02011-01-18 17:57:41 -08003374 /**
Griff Hazen50c11652014-05-16 09:46:31 -07003375 * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown
Daniel Sandler0c890492012-09-12 17:23:10 -07003376 * in the content view.
Selim Cinek0ff1ce602016-04-05 18:27:16 -07003377 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to
3378 * {@code false}. For earlier apps, the default is {@code true}.
Daniel Sandler0c890492012-09-12 17:23:10 -07003379 */
3380 public Builder setShowWhen(boolean show) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003381 mN.extras.putBoolean(EXTRA_SHOW_WHEN, show);
Daniel Sandler0c890492012-09-12 17:23:10 -07003382 return this;
3383 }
3384
3385 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003386 * Show the {@link Notification#when} field as a stopwatch.
Joe Malin8d40d042012-11-05 11:36:40 -08003387 *
3388 * Instead of presenting <code>when</code> as a timestamp, the notification will show an
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003389 * automatically updating display of the minutes and seconds since <code>when</code>.
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003390 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003391 * Useful when showing an elapsed time (like an ongoing phone call).
3392 *
Selim Cinek81c23aa2016-02-25 16:23:13 -08003393 * The counter can also be set to count down to <code>when</code> when using
Adrian Roos96b7e202016-05-17 13:50:38 -07003394 * {@link #setChronometerCountDown(boolean)}.
Selim Cinek81c23aa2016-02-25 16:23:13 -08003395 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04003396 * @see android.widget.Chronometer
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003397 * @see Notification#when
Adrian Roos96b7e202016-05-17 13:50:38 -07003398 * @see #setChronometerCountDown(boolean)
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003399 */
3400 public Builder setUsesChronometer(boolean b) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003401 mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b);
Daniel Sandlera2985ed2012-04-03 16:42:00 -04003402 return this;
3403 }
3404
3405 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08003406 * Sets the Chronometer to count down instead of counting up.
3407 *
3408 * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true.
3409 * If it isn't set the chronometer will count up.
3410 *
3411 * @see #setUsesChronometer(boolean)
3412 */
Adrian Roos96b7e202016-05-17 13:50:38 -07003413 public Builder setChronometerCountDown(boolean countDown) {
3414 mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, countDown);
Selim Cinek81c23aa2016-02-25 16:23:13 -08003415 return this;
3416 }
3417
3418 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003419 * Set the small icon resource, which will be used to represent the notification in the
3420 * status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -08003421 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003422
3423 * The platform template for the expanded view will draw this icon in the left, unless a
3424 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
3425 * icon will be moved to the right-hand side.
3426 *
3427
3428 * @param icon
3429 * A resource ID in the application's package of the drawable to use.
3430 * @see Notification#icon
Joe Onoratocb109a02011-01-18 17:57:41 -08003431 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003432 public Builder setSmallIcon(@DrawableRes int icon) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04003433 return setSmallIcon(icon != 0
3434 ? Icon.createWithResource(mContext, icon)
3435 : null);
Joe Onorato46439ce2010-11-19 13:56:21 -08003436 }
3437
Joe Onoratocb109a02011-01-18 17:57:41 -08003438 /**
3439 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
3440 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
3441 * LevelListDrawable}.
3442 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003443 * @param icon A resource ID in the application's package of the drawable to use.
Joe Onoratocb109a02011-01-18 17:57:41 -08003444 * @param level The level to use for the icon.
3445 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003446 * @see Notification#icon
3447 * @see Notification#iconLevel
Joe Onoratocb109a02011-01-18 17:57:41 -08003448 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07003449 public Builder setSmallIcon(@DrawableRes int icon, int level) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003450 mN.iconLevel = level;
Dan Sandlerd63f9322015-05-06 15:18:49 -04003451 return setSmallIcon(icon);
3452 }
3453
3454 /**
3455 * Set the small icon, which will be used to represent the notification in the
3456 * status bar and content view (unless overriden there by a
3457 * {@link #setLargeIcon(Bitmap) large icon}).
3458 *
3459 * @param icon An Icon object to use.
3460 * @see Notification#icon
3461 */
3462 public Builder setSmallIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003463 mN.setSmallIcon(icon);
3464 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
3465 mN.icon = icon.getResId();
3466 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003467 return this;
3468 }
3469
Joe Onoratocb109a02011-01-18 17:57:41 -08003470 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003471 * Set the first line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003472 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003473 public Builder setContentTitle(CharSequence title) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003474 mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title));
Joe Onorato46439ce2010-11-19 13:56:21 -08003475 return this;
3476 }
3477
Joe Onoratocb109a02011-01-18 17:57:41 -08003478 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003479 * Set the second line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08003480 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003481 public Builder setContentText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003482 mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text));
Joe Onorato46439ce2010-11-19 13:56:21 -08003483 return this;
3484 }
3485
Joe Onoratocb109a02011-01-18 17:57:41 -08003486 /**
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003487 * This provides some additional information that is displayed in the notification. No
3488 * guarantees are given where exactly it is displayed.
3489 *
3490 * <p>This information should only be provided if it provides an essential
3491 * benefit to the understanding of the notification. The more text you provide the
3492 * less readable it becomes. For example, an email client should only provide the account
3493 * name here if more than one email account has been added.</p>
3494 *
3495 * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the
3496 * notification header area.
3497 *
3498 * On Android versions before {@link android.os.Build.VERSION_CODES#N}
3499 * this will be shown in the third line of text in the platform notification template.
3500 * You should not be using {@link #setProgress(int, int, boolean)} at the
3501 * same time on those versions; they occupy the same place.
3502 * </p>
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003503 */
3504 public Builder setSubText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003505 mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text));
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003506 return this;
3507 }
3508
3509 /**
Julia Reynolds3aedded2017-03-31 14:42:09 -04003510 * Provides text that will appear as a link to your application's settings.
3511 *
3512 * <p>This text does not appear within notification {@link Style templates} but may
3513 * appear when the user uses an affordance to learn more about the notification.
3514 * Additionally, this text will not appear unless you provide a valid link target by
3515 * handling {@link #INTENT_CATEGORY_NOTIFICATION_PREFERENCES}.
3516 *
3517 * <p>This text is meant to be concise description about what the user can customize
3518 * when they click on this link. The recommended maximum length is 40 characters.
3519 * @param text
3520 * @return
3521 */
3522 public Builder setSettingsText(CharSequence text) {
3523 mN.mSettingsText = safeCharSequence(text);
3524 return this;
3525 }
3526
3527 /**
Adrian Roose458aa82015-12-08 16:17:19 -08003528 * Set the remote input history.
3529 *
3530 * This should be set to the most recent inputs that have been sent
3531 * through a {@link RemoteInput} of this Notification and cleared once the it is no
3532 * longer relevant (e.g. for chat notifications once the other party has responded).
3533 *
3534 * The most recent input must be stored at the 0 index, the second most recent at the
3535 * 1 index, etc. Note that the system will limit both how far back the inputs will be shown
3536 * and how much of each individual input is shown.
3537 *
3538 * <p>Note: The reply text will only be shown on notifications that have least one action
3539 * with a {@code RemoteInput}.</p>
3540 */
3541 public Builder setRemoteInputHistory(CharSequence[] text) {
3542 if (text == null) {
3543 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null);
3544 } else {
3545 final int N = Math.min(MAX_REPLY_HISTORY, text.length);
3546 CharSequence[] safe = new CharSequence[N];
3547 for (int i = 0; i < N; i++) {
3548 safe[i] = safeCharSequence(text[i]);
3549 }
3550 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe);
3551 }
3552 return this;
3553 }
3554
3555 /**
Kenny Guya0f6de82018-04-06 16:20:16 +01003556 * Sets whether remote history entries view should have a spinner.
3557 * @hide
3558 */
3559 public Builder setShowRemoteInputSpinner(boolean showSpinner) {
3560 mN.extras.putBoolean(EXTRA_SHOW_REMOTE_INPUT_SPINNER, showSpinner);
3561 return this;
3562 }
3563
3564 /**
Julia Reynolds13d898c2017-02-02 12:22:05 -05003565 * Sets the number of items this notification represents. May be displayed as a badge count
3566 * for Launchers that support badging.
Joe Onoratocb109a02011-01-18 17:57:41 -08003567 */
Joe Onorato8595a3d2010-11-19 18:12:07 -08003568 public Builder setNumber(int number) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003569 mN.number = number;
Joe Onorato8595a3d2010-11-19 18:12:07 -08003570 return this;
3571 }
3572
Joe Onoratocb109a02011-01-18 17:57:41 -08003573 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003574 * A small piece of additional information pertaining to this notification.
3575 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003576 * The platform template will draw this on the last line of the notification, at the far
3577 * right (to the right of a smallIcon if it has been placed there).
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003578 *
3579 * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header.
3580 * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this
3581 * field will still show up, but the subtext will take precedence.
Joe Onoratocb109a02011-01-18 17:57:41 -08003582 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003583 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003584 public Builder setContentInfo(CharSequence info) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003585 mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info));
Joe Onorato46439ce2010-11-19 13:56:21 -08003586 return this;
3587 }
3588
Joe Onoratocb109a02011-01-18 17:57:41 -08003589 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003590 * Set the progress this notification represents.
3591 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003592 * The platform template will represent this using a {@link ProgressBar}.
Jeff Sharkey1c400132011-08-05 14:50:13 -07003593 */
3594 public Builder setProgress(int max, int progress, boolean indeterminate) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003595 mN.extras.putInt(EXTRA_PROGRESS, progress);
3596 mN.extras.putInt(EXTRA_PROGRESS_MAX, max);
3597 mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate);
Jeff Sharkey1c400132011-08-05 14:50:13 -07003598 return this;
3599 }
3600
3601 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003602 * Supply a custom RemoteViews to use instead of the platform template.
3603 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003604 * Use {@link #setCustomContentView(RemoteViews)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003605 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003606 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003607 public Builder setContent(RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003608 return setCustomContentView(views);
3609 }
3610
3611 /**
3612 * Supply custom RemoteViews to use instead of the platform template.
3613 *
3614 * This will override the layout that would otherwise be constructed by this Builder
3615 * object.
3616 */
3617 public Builder setCustomContentView(RemoteViews contentView) {
3618 mN.contentView = contentView;
3619 return this;
3620 }
3621
3622 /**
3623 * Supply custom RemoteViews to use instead of the platform template in the expanded form.
3624 *
3625 * This will override the expanded layout that would otherwise be constructed by this
3626 * Builder object.
3627 */
3628 public Builder setCustomBigContentView(RemoteViews contentView) {
3629 mN.bigContentView = contentView;
3630 return this;
3631 }
3632
3633 /**
3634 * Supply custom RemoteViews to use instead of the platform template in the heads up dialog.
3635 *
3636 * This will override the heads-up layout that would otherwise be constructed by this
3637 * Builder object.
3638 */
3639 public Builder setCustomHeadsUpContentView(RemoteViews contentView) {
3640 mN.headsUpContentView = contentView;
Joe Onorato46439ce2010-11-19 13:56:21 -08003641 return this;
3642 }
3643
Joe Onoratocb109a02011-01-18 17:57:41 -08003644 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003645 * Supply a {@link PendingIntent} to be sent when the notification is clicked.
3646 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003647 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
3648 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
3649 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003650 * to assign PendingIntents to individual views in that custom layout (i.e., to create
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003651 * clickable buttons inside the notification view).
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003652 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003653 * @see Notification#contentIntent Notification.contentIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003654 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003655 public Builder setContentIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003656 mN.contentIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003657 return this;
3658 }
3659
Joe Onoratocb109a02011-01-18 17:57:41 -08003660 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003661 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
3662 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003663 * @see Notification#deleteIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003664 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003665 public Builder setDeleteIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003666 mN.deleteIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003667 return this;
3668 }
3669
Joe Onoratocb109a02011-01-18 17:57:41 -08003670 /**
3671 * An intent to launch instead of posting the notification to the status bar.
3672 * Only for use with extremely high-priority notifications demanding the user's
3673 * <strong>immediate</strong> attention, such as an incoming phone call or
3674 * alarm clock that the user has explicitly set to a particular time.
3675 * If this facility is used for something else, please give the user an option
3676 * to turn it off and use a normal notification, as this can be extremely
3677 * disruptive.
3678 *
Chris Wren47c20a12014-06-18 17:27:29 -04003679 * <p>
3680 * The system UI may choose to display a heads-up notification, instead of
3681 * launching this intent, while the user is using the device.
3682 * </p>
3683 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003684 * @param intent The pending intent to launch.
3685 * @param highPriority Passing true will cause this notification to be sent
3686 * even if other notifications are suppressed.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003687 *
3688 * @see Notification#fullScreenIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08003689 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003690 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003691 mN.fullScreenIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08003692 setFlag(FLAG_HIGH_PRIORITY, highPriority);
3693 return this;
3694 }
3695
Joe Onoratocb109a02011-01-18 17:57:41 -08003696 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003697 * Set the "ticker" text which is sent to accessibility services.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003698 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003699 * @see Notification#tickerText
Joe Onoratocb109a02011-01-18 17:57:41 -08003700 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003701 public Builder setTicker(CharSequence tickerText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003702 mN.tickerText = safeCharSequence(tickerText);
Joe Onorato46439ce2010-11-19 13:56:21 -08003703 return this;
3704 }
3705
Joe Onoratocb109a02011-01-18 17:57:41 -08003706 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003707 * Obsolete version of {@link #setTicker(CharSequence)}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003708 *
Joe Onoratocb109a02011-01-18 17:57:41 -08003709 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04003710 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003711 public Builder setTicker(CharSequence tickerText, RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003712 setTicker(tickerText);
3713 // views is ignored
Joe Onorato46439ce2010-11-19 13:56:21 -08003714 return this;
3715 }
3716
Joe Onoratocb109a02011-01-18 17:57:41 -08003717 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04003718 * Add a large icon to the notification content view.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003719 *
3720 * In the platform template, this image will be shown on the left of the notification view
Dan Sandlerd63f9322015-05-06 15:18:49 -04003721 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3722 * badge atop the large icon).
Dan Sandler08a04c12015-05-06 15:18:49 -04003723 */
Dan Sandlerd63f9322015-05-06 15:18:49 -04003724 public Builder setLargeIcon(Bitmap b) {
3725 return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
3726 }
3727
3728 /**
3729 * Add a large icon to the notification content view.
3730 *
3731 * In the platform template, this image will be shown on the left of the notification view
3732 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
3733 * badge atop the large icon).
3734 */
3735 public Builder setLargeIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003736 mN.mLargeIcon = icon;
3737 mN.extras.putParcelable(EXTRA_LARGE_ICON, icon);
Joe Onorato46439ce2010-11-19 13:56:21 -08003738 return this;
3739 }
3740
Joe Onoratocb109a02011-01-18 17:57:41 -08003741 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003742 * Set the sound to play.
3743 *
John Spurlockc0650f022014-07-19 13:22:39 -04003744 * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes}
3745 * for notifications.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003746 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003747 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003748 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003749 @Deprecated
Joe Onorato52f80cd2010-11-21 15:34:48 -08003750 public Builder setSound(Uri sound) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003751 mN.sound = sound;
3752 mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
Joe Onorato52f80cd2010-11-21 15:34:48 -08003753 return this;
3754 }
3755
Joe Onoratocb109a02011-01-18 17:57:41 -08003756 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003757 * Set the sound to play, along with a specific stream on which to play it.
Joe Onoratocb109a02011-01-18 17:57:41 -08003758 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003759 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
3760 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003761 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)}.
Joe Onoratocb109a02011-01-18 17:57:41 -08003762 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -07003763 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003764 public Builder setSound(Uri sound, int streamType) {
Jean-Michel Trivi2f7511f2016-11-28 15:40:27 -08003765 PlayerBase.deprecateStreamTypeForPlayback(streamType, "Notification", "setSound()");
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003766 mN.sound = sound;
3767 mN.audioStreamType = streamType;
Joe Onorato46439ce2010-11-19 13:56:21 -08003768 return this;
3769 }
3770
Joe Onoratocb109a02011-01-18 17:57:41 -08003771 /**
John Spurlockc0650f022014-07-19 13:22:39 -04003772 * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to
3773 * use during playback.
3774 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003775 * @deprecated use {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
John Spurlockc0650f022014-07-19 13:22:39 -04003776 * @see Notification#sound
3777 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003778 @Deprecated
John Spurlockc0650f022014-07-19 13:22:39 -04003779 public Builder setSound(Uri sound, AudioAttributes audioAttributes) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003780 mN.sound = sound;
3781 mN.audioAttributes = audioAttributes;
John Spurlockc0650f022014-07-19 13:22:39 -04003782 return this;
3783 }
3784
3785 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003786 * Set the vibration pattern to use.
3787 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003788 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
3789 * <code>pattern</code> parameter.
3790 *
Chris Wren47c20a12014-06-18 17:27:29 -04003791 * <p>
3792 * A notification that vibrates is more likely to be presented as a heads-up notification.
3793 * </p>
3794 *
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003795 * @deprecated use {@link NotificationChannel#setVibrationPattern(long[])} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003796 * @see Notification#vibrate
Joe Onoratocb109a02011-01-18 17:57:41 -08003797 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003798 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003799 public Builder setVibrate(long[] pattern) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003800 mN.vibrate = pattern;
Joe Onorato46439ce2010-11-19 13:56:21 -08003801 return this;
3802 }
3803
Joe Onoratocb109a02011-01-18 17:57:41 -08003804 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003805 * Set the desired color for the indicator LED on the device, as well as the
3806 * blink duty cycle (specified in milliseconds).
3807 *
3808
3809 * Not all devices will honor all (or even any) of these values.
3810 *
Julia Reynolds529e3322017-02-06 08:33:01 -05003811 * @deprecated use {@link NotificationChannel#enableLights(boolean)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003812 * @see Notification#ledARGB
3813 * @see Notification#ledOnMS
3814 * @see Notification#ledOffMS
Joe Onoratocb109a02011-01-18 17:57:41 -08003815 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003816 @Deprecated
Tor Norbye80756e32015-03-02 09:39:27 -08003817 public Builder setLights(@ColorInt int argb, int onMs, int offMs) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003818 mN.ledARGB = argb;
3819 mN.ledOnMS = onMs;
3820 mN.ledOffMS = offMs;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05003821 if (onMs != 0 || offMs != 0) {
3822 mN.flags |= FLAG_SHOW_LIGHTS;
3823 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003824 return this;
3825 }
3826
Joe Onoratocb109a02011-01-18 17:57:41 -08003827 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003828 * Set whether this is an "ongoing" notification.
Joe Onoratocb109a02011-01-18 17:57:41 -08003829 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003830
3831 * Ongoing notifications cannot be dismissed by the user, so your application or service
3832 * must take care of canceling them.
3833 *
3834
3835 * They are typically used to indicate a background task that the user is actively engaged
3836 * with (e.g., playing music) or is pending in some way and therefore occupying the device
3837 * (e.g., a file download, sync operation, active network connection).
3838 *
3839
3840 * @see Notification#FLAG_ONGOING_EVENT
3841 * @see Service#setForeground(boolean)
Joe Onoratocb109a02011-01-18 17:57:41 -08003842 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003843 public Builder setOngoing(boolean ongoing) {
3844 setFlag(FLAG_ONGOING_EVENT, ongoing);
3845 return this;
3846 }
3847
Joe Onoratocb109a02011-01-18 17:57:41 -08003848 /**
Selim Cinek7b9605b2017-01-19 17:36:00 -08003849 * Set whether this notification should be colorized. When set, the color set with
3850 * {@link #setColor(int)} will be used as the background color of this notification.
3851 * <p>
Selim Cinek7b9605b2017-01-19 17:36:00 -08003852 * This should only be used for high priority ongoing tasks like navigation, an ongoing
3853 * call, or other similarly high-priority events for the user.
Selim Cinek99104832017-01-25 14:47:33 -08003854 * <p>
Selim Cinek22714f12017-04-13 16:23:53 -07003855 * For most styles, the coloring will only be applied if the notification is for a
3856 * foreground service notification.
Selim Cinek99104832017-01-25 14:47:33 -08003857 * However, for {@link MediaStyle} and {@link DecoratedMediaCustomViewStyle} notifications
Selim Cinek22714f12017-04-13 16:23:53 -07003858 * that have a media session attached there is no such requirement.
Selim Cinek7b9605b2017-01-19 17:36:00 -08003859 *
Selim Cinek7b9605b2017-01-19 17:36:00 -08003860 * @see Builder#setColor(int)
Selim Cinek99104832017-01-25 14:47:33 -08003861 * @see MediaStyle#setMediaSession(MediaSession.Token)
Selim Cinek7b9605b2017-01-19 17:36:00 -08003862 */
3863 public Builder setColorized(boolean colorize) {
3864 mN.extras.putBoolean(EXTRA_COLORIZED, colorize);
3865 return this;
3866 }
3867
3868 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08003869 * Set this flag if you would only like the sound, vibrate
3870 * and ticker to be played if the notification is not already showing.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003871 *
3872 * @see Notification#FLAG_ONLY_ALERT_ONCE
Joe Onoratocb109a02011-01-18 17:57:41 -08003873 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003874 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
3875 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
3876 return this;
3877 }
3878
Joe Onoratocb109a02011-01-18 17:57:41 -08003879 /**
Julia Reynolds04499532016-09-13 14:04:53 -04003880 * Make this notification automatically dismissed when the user touches it.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003881 *
3882 * @see Notification#FLAG_AUTO_CANCEL
Joe Onoratocb109a02011-01-18 17:57:41 -08003883 */
Joe Onorato46439ce2010-11-19 13:56:21 -08003884 public Builder setAutoCancel(boolean autoCancel) {
Joe Onorato281d83f2011-01-04 17:13:10 -08003885 setFlag(FLAG_AUTO_CANCEL, autoCancel);
Joe Onorato46439ce2010-11-19 13:56:21 -08003886 return this;
3887 }
3888
Joe Onoratocb109a02011-01-18 17:57:41 -08003889 /**
Griff Hazendfcb0802014-02-11 12:00:00 -08003890 * Set whether or not this notification should not bridge to other devices.
3891 *
3892 * <p>Some notifications can be bridged to other devices for remote display.
3893 * This hint can be set to recommend this notification not be bridged.
3894 */
3895 public Builder setLocalOnly(boolean localOnly) {
3896 setFlag(FLAG_LOCAL_ONLY, localOnly);
3897 return this;
3898 }
3899
3900 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003901 * Set which notification properties will be inherited from system defaults.
Joe Onoratocb109a02011-01-18 17:57:41 -08003902 * <p>
3903 * The value should be one or more of the following fields combined with
3904 * bitwise-or:
3905 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
3906 * <p>
3907 * For all default values, use {@link #DEFAULT_ALL}.
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003908 *
3909 * @deprecated use {@link NotificationChannel#enableVibration(boolean)} and
Julia Reynolds529e3322017-02-06 08:33:01 -05003910 * {@link NotificationChannel#enableLights(boolean)} and
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003911 * {@link NotificationChannel#setSound(Uri, AudioAttributes)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08003912 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003913 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08003914 public Builder setDefaults(int defaults) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003915 mN.defaults = defaults;
Joe Onorato46439ce2010-11-19 13:56:21 -08003916 return this;
3917 }
3918
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003919 /**
3920 * Set the priority of this notification.
3921 *
3922 * @see Notification#priority
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003923 * @deprecated use {@link NotificationChannel#setImportance(int)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003924 */
Julia Reynoldsa33f5c42017-01-31 16:53:35 -05003925 @Deprecated
Tor Norbyed9273d62013-05-30 15:59:53 -07003926 public Builder setPriority(@Priority int pri) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003927 mN.priority = pri;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003928 return this;
3929 }
Joe Malin8d40d042012-11-05 11:36:40 -08003930
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003931 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04003932 * Set the notification category.
Joe Malin8d40d042012-11-05 11:36:40 -08003933 *
John Spurlockfd7f1e02014-03-18 16:41:57 -04003934 * @see Notification#category
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003935 */
John Spurlockfd7f1e02014-03-18 16:41:57 -04003936 public Builder setCategory(String category) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003937 mN.category = category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003938 return this;
3939 }
3940
3941 /**
Chris Wrendde75302014-03-26 17:24:15 -04003942 * Add a person that is relevant to this notification.
3943 *
Chris Wrene6c48932014-09-29 17:19:27 -04003944 * <P>
3945 * Depending on user preferences, this annotation may allow the notification to pass
Julia Reynoldse071abd2017-03-22 10:52:11 -04003946 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3947 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3948 * appear more prominently in the user interface.
Chris Wrene6c48932014-09-29 17:19:27 -04003949 * </P>
3950 *
3951 * <P>
3952 * The person should be specified by the {@code String} representation of a
3953 * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
3954 * </P>
3955 *
3956 * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
3957 * URIs. The path part of these URIs must exist in the contacts database, in the
3958 * appropriate column, or the reference will be discarded as invalid. Telephone schema
3959 * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
Selim Cineke7238dd2017-12-14 17:48:32 -08003960 * It is also possible to provide a URI with the schema {@code name:} in order to uniquely
3961 * identify a person without an entry in the contacts database.
Chris Wrene6c48932014-09-29 17:19:27 -04003962 * </P>
3963 *
3964 * @param uri A URI for the person.
Chris Wrendde75302014-03-26 17:24:15 -04003965 * @see Notification#EXTRA_PEOPLE
Selim Cineke7238dd2017-12-14 17:48:32 -08003966 * @deprecated use {@link #addPerson(Person)}
Chris Wrendde75302014-03-26 17:24:15 -04003967 */
Chris Wrene6c48932014-09-29 17:19:27 -04003968 public Builder addPerson(String uri) {
Selim Cinek9acd6732018-03-23 16:39:02 -07003969 addPerson(new Person.Builder().setUri(uri).build());
Selim Cineke7238dd2017-12-14 17:48:32 -08003970 return this;
3971 }
3972
3973 /**
3974 * Add a person that is relevant to this notification.
3975 *
3976 * <P>
3977 * Depending on user preferences, this annotation may allow the notification to pass
3978 * through interruption filters, if this notification is of category {@link #CATEGORY_CALL}
3979 * or {@link #CATEGORY_MESSAGE}. The addition of people may also cause this notification to
3980 * appear more prominently in the user interface.
3981 * </P>
3982 *
3983 * <P>
3984 * A person should usually contain a uri in order to benefit from the ranking boost.
3985 * However, even if no uri is provided, it's beneficial to provide other people in the
3986 * notification, such that listeners and voice only devices can announce and handle them
3987 * properly.
3988 * </P>
3989 *
3990 * @param person the person to add.
3991 * @see Notification#EXTRA_PEOPLE_LIST
3992 */
3993 public Builder addPerson(Person person) {
3994 mPersonList.add(person);
Chris Wrendde75302014-03-26 17:24:15 -04003995 return this;
3996 }
3997
3998 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003999 * Set this notification to be part of a group of notifications sharing the same key.
4000 * Grouped notifications may display in a cluster or stack on devices which
4001 * support such rendering.
4002 *
4003 * <p>To make this notification the summary for its group, also call
4004 * {@link #setGroupSummary}. A sort order can be specified for group members by using
4005 * {@link #setSortKey}.
4006 * @param groupKey The group key of the group.
4007 * @return this object for method chaining
4008 */
4009 public Builder setGroup(String groupKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004010 mN.mGroupKey = groupKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004011 return this;
4012 }
4013
4014 /**
4015 * Set this notification to be the group summary for a group of notifications.
4016 * Grouped notifications may display in a cluster or stack on devices which
Julia Reynolds04499532016-09-13 14:04:53 -04004017 * support such rendering. If thereRequires a group key also be set using {@link #setGroup}.
4018 * The group summary may be suppressed if too few notifications are included in the group.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004019 * @param isGroupSummary Whether this notification should be a group summary.
4020 * @return this object for method chaining
4021 */
4022 public Builder setGroupSummary(boolean isGroupSummary) {
4023 setFlag(FLAG_GROUP_SUMMARY, isGroupSummary);
4024 return this;
4025 }
4026
4027 /**
4028 * Set a sort key that orders this notification among other notifications from the
4029 * same package. This can be useful if an external sort was already applied and an app
4030 * would like to preserve this. Notifications will be sorted lexicographically using this
4031 * value, although providing different priorities in addition to providing sort key may
4032 * cause this value to be ignored.
4033 *
4034 * <p>This sort key can also be used to order members of a notification group. See
Griff Hazen9e1379f2014-05-20 12:50:51 -07004035 * {@link #setGroup}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004036 *
4037 * @see String#compareTo(String)
4038 */
4039 public Builder setSortKey(String sortKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004040 mN.mSortKey = sortKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004041 return this;
4042 }
4043
4044 /**
Griff Hazen720042b2014-02-24 15:46:56 -08004045 * Merge additional metadata into this notification.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004046 *
Griff Hazen720042b2014-02-24 15:46:56 -08004047 * <p>Values within the Bundle will replace existing extras values in this Builder.
4048 *
4049 * @see Notification#extras
4050 */
Griff Hazen959591e2014-05-15 22:26:18 -07004051 public Builder addExtras(Bundle extras) {
4052 if (extras != null) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004053 mUserExtras.putAll(extras);
Griff Hazen720042b2014-02-24 15:46:56 -08004054 }
4055 return this;
4056 }
4057
4058 /**
4059 * Set metadata for this notification.
4060 *
4061 * <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 -04004062 * current contents are copied into the Notification each time {@link #build()} is
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004063 * called.
4064 *
Griff Hazen720042b2014-02-24 15:46:56 -08004065 * <p>Replaces any existing extras values with those from the provided Bundle.
4066 * Use {@link #addExtras} to merge in metadata instead.
4067 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004068 * @see Notification#extras
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004069 */
Griff Hazen959591e2014-05-15 22:26:18 -07004070 public Builder setExtras(Bundle extras) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004071 if (extras != null) {
4072 mUserExtras = extras;
4073 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05004074 return this;
4075 }
4076
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004077 /**
Griff Hazen720042b2014-02-24 15:46:56 -08004078 * Get the current metadata Bundle used by this notification Builder.
4079 *
4080 * <p>The returned Bundle is shared with this Builder.
4081 *
4082 * <p>The current contents of this Bundle are copied into the Notification each time
4083 * {@link #build()} is called.
4084 *
4085 * @see Notification#extras
4086 */
4087 public Bundle getExtras() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004088 return mUserExtras;
4089 }
4090
4091 private Bundle getAllExtras() {
4092 final Bundle saveExtras = (Bundle) mUserExtras.clone();
4093 saveExtras.putAll(mN.extras);
4094 return saveExtras;
Griff Hazen720042b2014-02-24 15:46:56 -08004095 }
4096
4097 /**
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004098 * Add an action to this notification. Actions are typically displayed by
4099 * the system as a button adjacent to the notification content.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004100 * <p>
4101 * Every action must have an icon (32dp square and matching the
4102 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4103 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4104 * <p>
4105 * A notification in its expanded form can display up to 3 actions, from left to right in
4106 * the order they were added. Actions will not be displayed when the notification is
4107 * collapsed, however, so be sure that any essential functions may be accessed by the user
4108 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004109 *
4110 * @param icon Resource ID of a drawable that represents the action.
4111 * @param title Text describing the action.
4112 * @param intent PendingIntent to be fired when the action is invoked.
Dan Sandler86647982015-05-13 23:41:13 -04004113 *
4114 * @deprecated Use {@link #addAction(Action)} instead.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004115 */
Dan Sandler86647982015-05-13 23:41:13 -04004116 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004117 public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004118 mActions.add(new Action(icon, safeCharSequence(title), intent));
Daniel Sandlera0a938c2012-03-15 08:42:37 -04004119 return this;
4120 }
4121
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004122 /**
Griff Hazen959591e2014-05-15 22:26:18 -07004123 * Add an action to this notification. Actions are typically displayed by
4124 * the system as a button adjacent to the notification content.
4125 * <p>
4126 * Every action must have an icon (32dp square and matching the
4127 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
4128 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
4129 * <p>
4130 * A notification in its expanded form can display up to 3 actions, from left to right in
4131 * the order they were added. Actions will not be displayed when the notification is
4132 * collapsed, however, so be sure that any essential functions may be accessed by the user
4133 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
4134 *
4135 * @param action The action to add.
4136 */
4137 public Builder addAction(Action action) {
liangweikang63b03b52017-03-16 19:22:15 +08004138 if (action != null) {
4139 mActions.add(action);
4140 }
Griff Hazen959591e2014-05-15 22:26:18 -07004141 return this;
4142 }
4143
4144 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004145 * Alter the complete list of actions attached to this notification.
4146 * @see #addAction(Action).
4147 *
4148 * @param actions
4149 * @return
4150 */
4151 public Builder setActions(Action... actions) {
4152 mActions.clear();
4153 for (int i = 0; i < actions.length; i++) {
liangweikang63b03b52017-03-16 19:22:15 +08004154 if (actions[i] != null) {
4155 mActions.add(actions[i]);
4156 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004157 }
4158 return this;
4159 }
4160
4161 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004162 * Add a rich notification style to be applied at build time.
4163 *
4164 * @param style Object responsible for modifying the notification style.
4165 */
4166 public Builder setStyle(Style style) {
4167 if (mStyle != style) {
4168 mStyle = style;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004169 if (mStyle != null) {
4170 mStyle.setBuilder(this);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004171 mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName());
4172 } else {
4173 mN.extras.remove(EXTRA_TEMPLATE);
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004174 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004175 }
4176 return this;
4177 }
4178
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004179 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05004180 * Returns the style set by {@link #setStyle(Style)}.
4181 */
4182 public Style getStyle() {
4183 return mStyle;
4184 }
4185
4186 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004187 * Specify the value of {@link #visibility}.
Griff Hazenb720abe2014-05-20 13:15:30 -07004188 *
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004189 * @return The same Builder.
4190 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004191 public Builder setVisibility(@Visibility int visibility) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004192 mN.visibility = visibility;
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004193 return this;
4194 }
4195
4196 /**
4197 * Supply a replacement Notification whose contents should be shown in insecure contexts
4198 * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}.
4199 * @param n A replacement notification, presumably with some or all info redacted.
4200 * @return The same Builder.
4201 */
4202 public Builder setPublicVersion(Notification n) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004203 if (n != null) {
4204 mN.publicVersion = new Notification();
4205 n.cloneInto(mN.publicVersion, /*heavy=*/ true);
4206 } else {
4207 mN.publicVersion = null;
4208 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06004209 return this;
4210 }
4211
Griff Hazenb720abe2014-05-20 13:15:30 -07004212 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004213 * Apply an extender to this notification builder. Extenders may be used to add
4214 * metadata or change options on this builder.
4215 */
Griff Hazen61a9e862014-05-22 16:05:19 -07004216 public Builder extend(Extender extender) {
4217 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07004218 return this;
4219 }
4220
Dan Sandler4e787062015-06-17 15:09:48 -04004221 /**
4222 * @hide
4223 */
Julia Reynoldse46bb372016-03-17 11:05:58 -04004224 public Builder setFlag(int mask, boolean value) {
Joe Onorato46439ce2010-11-19 13:56:21 -08004225 if (value) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004226 mN.flags |= mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004227 } else {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004228 mN.flags &= ~mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08004229 }
Julia Reynoldse46bb372016-03-17 11:05:58 -04004230 return this;
Joe Onorato46439ce2010-11-19 13:56:21 -08004231 }
4232
Dan Sandler26e81cf2014-05-06 10:01:27 -04004233 /**
4234 * Sets {@link Notification#color}.
4235 *
4236 * @param argb The accent color to use
4237 *
4238 * @return The same Builder.
4239 */
Tor Norbye80756e32015-03-02 09:39:27 -08004240 public Builder setColor(@ColorInt int argb) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004241 mN.color = argb;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05004242 sanitizeColor();
Dan Sandler26e81cf2014-05-06 10:01:27 -04004243 return this;
4244 }
4245
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004246 private Drawable getProfileBadgeDrawable() {
Chris Wren66619a22016-05-12 16:42:37 -04004247 if (mContext.getUserId() == UserHandle.USER_SYSTEM) {
4248 // This user can never be a badged profile,
4249 // and also includes USER_ALL system notifications.
4250 return null;
4251 }
Christoph Studer7ac80e62014-08-04 16:01:57 +02004252 // Note: This assumes that the current user can read the profile badge of the
4253 // originating user.
Selim Cineke6ff9462016-01-15 15:07:06 -08004254 return mContext.getPackageManager().getUserBadgeForDensityNoBackground(
Julia Reynoldsda303542015-11-23 14:00:20 -05004255 new UserHandle(mContext.getUserId()), 0);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004256 }
4257
4258 private Bitmap getProfileBadge() {
4259 Drawable badge = getProfileBadgeDrawable();
Kenny Guy8a0101b2014-05-08 23:34:12 +01004260 if (badge == null) {
4261 return null;
4262 }
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004263 final int size = mContext.getResources().getDimensionPixelSize(
4264 R.dimen.notification_badge_size);
4265 Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004266 Canvas canvas = new Canvas(bitmap);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02004267 badge.setBounds(0, 0, size, size);
Kenny Guy8a0101b2014-05-08 23:34:12 +01004268 badge.draw(canvas);
4269 return bitmap;
4270 }
4271
Selim Cinekc848c3a2016-01-13 15:27:30 -08004272 private void bindProfileBadge(RemoteViews contentView) {
Kenny Guy98193ea2014-07-24 19:54:37 +01004273 Bitmap profileBadge = getProfileBadge();
4274
Kenny Guy98193ea2014-07-24 19:54:37 +01004275 if (profileBadge != null) {
Selim Cinekc848c3a2016-01-13 15:27:30 -08004276 contentView.setImageViewBitmap(R.id.profile_badge, profileBadge);
4277 contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004278 if (isColorized()) {
Sunny Goyal5b153922017-09-21 21:00:36 -07004279 contentView.setDrawableTint(R.id.profile_badge, false,
4280 getPrimaryTextColor(), PorterDuff.Mode.SRC_ATOP);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004281 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004282 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004283 }
4284
Julia Reynoldsfc640012018-02-21 12:25:27 -05004285 /**
4286 * @hide
4287 */
4288 public boolean usesStandardHeader() {
4289 if (mN.mUsesStandardHeader) {
4290 return true;
4291 }
4292 if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.N) {
4293 if (mN.contentView == null && mN.bigContentView == null) {
4294 return true;
4295 }
4296 }
4297 boolean contentViewUsesHeader = mN.contentView == null
4298 || STANDARD_LAYOUTS.contains(mN.contentView.getLayoutId());
4299 boolean bigContentViewUsesHeader = mN.bigContentView == null
4300 || STANDARD_LAYOUTS.contains(mN.bigContentView.getLayoutId());
4301 return contentViewUsesHeader && bigContentViewUsesHeader;
4302 }
4303
Christoph Studerfe718432014-09-01 18:21:18 +02004304 private void resetStandardTemplate(RemoteViews contentView) {
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004305 resetNotificationHeader(contentView);
Christoph Studerfe718432014-09-01 18:21:18 +02004306 contentView.setViewVisibility(R.id.right_icon, View.GONE);
Selim Cinek860b6da2015-12-16 19:02:19 -08004307 contentView.setViewVisibility(R.id.title, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004308 contentView.setTextViewText(R.id.title, null);
Selim Cinek41598732016-01-11 16:58:37 -08004309 contentView.setViewVisibility(R.id.text, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004310 contentView.setTextViewText(R.id.text, null);
Selim Cinek29603462015-11-17 19:04:39 -08004311 contentView.setViewVisibility(R.id.text_line_1, View.GONE);
Selim Cinek41598732016-01-11 16:58:37 -08004312 contentView.setTextViewText(R.id.text_line_1, null);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004313 }
4314
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004315 /**
4316 * Resets the notification header to its original state
4317 */
4318 private void resetNotificationHeader(RemoteViews contentView) {
Adrian Roosc4337a32016-08-02 18:30:34 -07004319 // Small icon doesn't need to be reset, as it's always set. Resetting would prevent
4320 // re-using the drawable when the notification is updated.
Selim Cinek7b836392015-12-04 20:02:59 -08004321 contentView.setBoolean(R.id.notification_header, "setExpanded", false);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004322 contentView.setTextViewText(R.id.app_name_text, null);
Christoph Studerca1db712014-09-10 17:31:33 +02004323 contentView.setViewVisibility(R.id.chronometer, View.GONE);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004324 contentView.setViewVisibility(R.id.header_text, View.GONE);
Adrian Roos9dfb78f2016-06-30 15:43:44 -07004325 contentView.setTextViewText(R.id.header_text, null);
Selim Cinekafeed292017-12-12 17:32:44 -08004326 contentView.setViewVisibility(R.id.header_text_secondary, View.GONE);
4327 contentView.setTextViewText(R.id.header_text_secondary, null);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004328 contentView.setViewVisibility(R.id.header_text_divider, View.GONE);
Selim Cinekafeed292017-12-12 17:32:44 -08004329 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004330 contentView.setViewVisibility(R.id.time_divider, View.GONE);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004331 contentView.setViewVisibility(R.id.time, View.GONE);
Selim Cinekc848c3a2016-01-13 15:27:30 -08004332 contentView.setImageViewIcon(R.id.profile_badge, null);
4333 contentView.setViewVisibility(R.id.profile_badge, View.GONE);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004334 mN.mUsesStandardHeader = false;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004335 }
4336
Selim Cinek384804b2018-04-18 14:31:07 +08004337 private RemoteViews applyStandardTemplate(int resId, TemplateBindResult result) {
4338 return applyStandardTemplate(resId, mParams.reset().fillTextsFrom(this),
4339 result);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004340 }
4341
4342 /**
4343 * @param hasProgress whether the progress bar should be shown and set
Selim Cinek384804b2018-04-18 14:31:07 +08004344 * @param result
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004345 */
Selim Cinek384804b2018-04-18 14:31:07 +08004346 private RemoteViews applyStandardTemplate(int resId, boolean hasProgress,
4347 TemplateBindResult result) {
Adrian Roos70d7aa32017-01-11 15:39:06 -08004348 return applyStandardTemplate(resId, mParams.reset().hasProgress(hasProgress)
Selim Cinek384804b2018-04-18 14:31:07 +08004349 .fillTextsFrom(this), result);
Adrian Roosc1a80b02016-04-05 14:54:55 -07004350 }
4351
Selim Cinek384804b2018-04-18 14:31:07 +08004352 private RemoteViews applyStandardTemplate(int resId, StandardTemplateParams p,
4353 TemplateBindResult result) {
Kenny Guy77320062014-08-27 21:37:15 +01004354 RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId);
Dan Sandler539aad42014-08-04 00:43:39 -04004355
Christoph Studerfe718432014-09-01 18:21:18 +02004356 resetStandardTemplate(contentView);
4357
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004358 final Bundle ex = mN.extras;
Selim Cinek7b9605b2017-01-19 17:36:00 -08004359 updateBackgroundColor(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004360 bindNotificationHeader(contentView, p.ambient, p.headerTextSecondary);
Selim Cinek384804b2018-04-18 14:31:07 +08004361 bindLargeIconAndReply(contentView, p, result);
Adrian Roos70d7aa32017-01-11 15:39:06 -08004362 boolean showProgress = handleProgressBar(p.hasProgress, contentView, ex);
4363 if (p.title != null) {
Selim Cinek860b6da2015-12-16 19:02:19 -08004364 contentView.setViewVisibility(R.id.title, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004365 contentView.setTextViewText(R.id.title, processTextSpans(p.title));
Adrian Roos72171622017-01-27 10:32:06 -08004366 if (!p.ambient) {
4367 setTextViewColorPrimary(contentView, R.id.title);
4368 }
Selim Cinek954cc232016-05-20 13:29:23 -07004369 contentView.setViewLayoutWidth(R.id.title, showProgress
4370 ? ViewGroup.LayoutParams.WRAP_CONTENT
4371 : ViewGroup.LayoutParams.MATCH_PARENT);
Joe Onorato561d3852010-11-20 18:09:34 -08004372 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08004373 if (p.text != null) {
Selim Cinek41598732016-01-11 16:58:37 -08004374 int textId = showProgress ? com.android.internal.R.id.text_line_1
4375 : com.android.internal.R.id.text;
Selim Cinek48f66b72017-08-18 16:17:51 -07004376 contentView.setTextViewText(textId, processTextSpans(p.text));
Adrian Roos72171622017-01-27 10:32:06 -08004377 if (!p.ambient) {
4378 setTextViewColorSecondary(contentView, textId);
4379 }
Selim Cinek41598732016-01-11 16:58:37 -08004380 contentView.setViewVisibility(textId, View.VISIBLE);
Joe Onorato561d3852010-11-20 18:09:34 -08004381 }
Selim Cinekc848c3a2016-01-13 15:27:30 -08004382
Selim Cinek279fa862016-06-14 10:57:25 -07004383 setContentMinHeight(contentView, showProgress || mN.hasLargeIcon());
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004384
Selim Cinek29603462015-11-17 19:04:39 -08004385 return contentView;
4386 }
4387
Selim Cinek48f66b72017-08-18 16:17:51 -07004388 private CharSequence processTextSpans(CharSequence text) {
4389 if (hasForegroundColor()) {
Selim Cinek87c31532017-08-18 18:53:44 -07004390 return NotificationColorUtil.clearColorSpans(text);
Selim Cinek48f66b72017-08-18 16:17:51 -07004391 }
4392 return text;
4393 }
4394
Selim Cinek7b9605b2017-01-19 17:36:00 -08004395 private void setTextViewColorPrimary(RemoteViews contentView, int id) {
4396 ensureColors();
4397 contentView.setTextColor(id, mPrimaryTextColor);
4398 }
4399
Selim Cinek48f66b72017-08-18 16:17:51 -07004400 private boolean hasForegroundColor() {
4401 return mForegroundColor != COLOR_INVALID;
4402 }
4403
Selim Cinek389edcd2017-05-11 19:16:44 -07004404 /**
4405 * @return the primary text color
4406 * @hide
4407 */
4408 @VisibleForTesting
4409 public int getPrimaryTextColor() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004410 ensureColors();
4411 return mPrimaryTextColor;
4412 }
4413
Selim Cinek389edcd2017-05-11 19:16:44 -07004414 /**
4415 * @return the secondary text color
4416 * @hide
4417 */
4418 @VisibleForTesting
4419 public int getSecondaryTextColor() {
4420 ensureColors();
4421 return mSecondaryTextColor;
4422 }
4423
Selim Cinek7b9605b2017-01-19 17:36:00 -08004424 private void setTextViewColorSecondary(RemoteViews contentView, int id) {
4425 ensureColors();
4426 contentView.setTextColor(id, mSecondaryTextColor);
4427 }
4428
4429 private void ensureColors() {
4430 int backgroundColor = getBackgroundColor();
4431 if (mPrimaryTextColor == COLOR_INVALID
4432 || mSecondaryTextColor == COLOR_INVALID
Selim Cinek7b9605b2017-01-19 17:36:00 -08004433 || mTextColorsAreForBackground != backgroundColor) {
4434 mTextColorsAreForBackground = backgroundColor;
Selim Cinek48f66b72017-08-18 16:17:51 -07004435 if (!hasForegroundColor() || !isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004436 mPrimaryTextColor = NotificationColorUtil.resolvePrimaryColor(mContext,
4437 backgroundColor);
4438 mSecondaryTextColor = NotificationColorUtil.resolveSecondaryColor(mContext,
4439 backgroundColor);
Selim Cinekc7f5a822018-03-20 19:32:06 -07004440 if (backgroundColor != COLOR_DEFAULT && isColorized()) {
Selim Cinekac5f0272017-05-02 16:05:41 -07004441 mPrimaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4442 mPrimaryTextColor, backgroundColor, 4.5);
4443 mSecondaryTextColor = NotificationColorUtil.findAlphaToMeetContrast(
4444 mSecondaryTextColor, backgroundColor, 4.5);
4445 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07004446 } else {
4447 double backLum = NotificationColorUtil.calculateLuminance(backgroundColor);
4448 double textLum = NotificationColorUtil.calculateLuminance(mForegroundColor);
4449 double contrast = NotificationColorUtil.calculateContrast(mForegroundColor,
4450 backgroundColor);
Selim Cinek389edcd2017-05-11 19:16:44 -07004451 // We only respect the given colors if worst case Black or White still has
4452 // contrast
4453 boolean backgroundLight = backLum > textLum
4454 && satisfiesTextContrast(backgroundColor, Color.BLACK)
4455 || backLum <= textLum
4456 && !satisfiesTextContrast(backgroundColor, Color.WHITE);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004457 if (contrast < 4.5f) {
Selim Cinek389edcd2017-05-11 19:16:44 -07004458 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004459 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4460 mForegroundColor,
4461 backgroundColor,
4462 true /* findFG */,
4463 4.5f);
4464 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004465 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_LIGHT);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004466 } else {
4467 mSecondaryTextColor =
4468 NotificationColorUtil.findContrastColorAgainstDark(
4469 mForegroundColor,
4470 backgroundColor,
4471 true /* findFG */,
4472 4.5f);
4473 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004474 mSecondaryTextColor, -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004475 }
4476 } else {
4477 mPrimaryTextColor = mForegroundColor;
4478 mSecondaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004479 mPrimaryTextColor, backgroundLight ? LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4480 : LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004481 if (NotificationColorUtil.calculateContrast(mSecondaryTextColor,
4482 backgroundColor) < 4.5f) {
4483 // oh well the secondary is not good enough
Selim Cinek389edcd2017-05-11 19:16:44 -07004484 if (backgroundLight) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07004485 mSecondaryTextColor = NotificationColorUtil.findContrastColor(
4486 mSecondaryTextColor,
4487 backgroundColor,
4488 true /* findFG */,
4489 4.5f);
4490 } else {
4491 mSecondaryTextColor
4492 = NotificationColorUtil.findContrastColorAgainstDark(
4493 mSecondaryTextColor,
4494 backgroundColor,
4495 true /* findFG */,
4496 4.5f);
4497 }
4498 mPrimaryTextColor = NotificationColorUtil.changeColorLightness(
Selim Cinek389edcd2017-05-11 19:16:44 -07004499 mSecondaryTextColor, backgroundLight
4500 ? -LIGHTNESS_TEXT_DIFFERENCE_LIGHT
4501 : -LIGHTNESS_TEXT_DIFFERENCE_DARK);
Selim Cinek5fb73f82017-04-20 16:55:38 -07004502 }
4503 }
4504 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08004505 }
4506 }
4507
4508 private void updateBackgroundColor(RemoteViews contentView) {
4509 if (isColorized()) {
4510 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundColor",
4511 getBackgroundColor());
4512 } else {
4513 // Clear it!
4514 contentView.setInt(R.id.status_bar_latest_event_content, "setBackgroundResource",
4515 0);
4516 }
4517 }
4518
Selim Cinek860b6da2015-12-16 19:02:19 -08004519 /**
4520 * @param remoteView the remote view to update the minheight in
4521 * @param hasMinHeight does it have a mimHeight
4522 * @hide
4523 */
4524 void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) {
4525 int minHeight = 0;
4526 if (hasMinHeight) {
4527 // we need to set the minHeight of the notification
4528 minHeight = mContext.getResources().getDimensionPixelSize(
4529 com.android.internal.R.dimen.notification_min_content_height);
4530 }
4531 remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight);
4532 }
4533
Selim Cinek29603462015-11-17 19:04:39 -08004534 private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004535 final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0);
4536 final int progress = ex.getInt(EXTRA_PROGRESS, 0);
4537 final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
4538 if (hasProgress && (max != 0 || ind)) {
Selim Cinek29603462015-11-17 19:04:39 -08004539 contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004540 contentView.setProgressBar(
Selim Cinek29603462015-11-17 19:04:39 -08004541 R.id.progress, max, progress, ind);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004542 contentView.setProgressBackgroundTintList(
4543 R.id.progress, ColorStateList.valueOf(mContext.getColor(
4544 R.color.notification_progress_background_color)));
Selim Cinek29603462015-11-17 19:04:39 -08004545 if (mN.color != COLOR_DEFAULT) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08004546 ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004547 contentView.setProgressTintList(R.id.progress, colorStateList);
4548 contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004549 }
Selim Cinek29603462015-11-17 19:04:39 -08004550 return true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004551 } else {
4552 contentView.setViewVisibility(R.id.progress, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08004553 return false;
Jeff Sharkey1c400132011-08-05 14:50:13 -07004554 }
Joe Onorato561d3852010-11-20 18:09:34 -08004555 }
4556
Selim Cinek384804b2018-04-18 14:31:07 +08004557 private void bindLargeIconAndReply(RemoteViews contentView, StandardTemplateParams p,
4558 TemplateBindResult result) {
4559 boolean largeIconShown = bindLargeIcon(contentView, p.hideLargeIcon || p.ambient);
Selim Cinek1c72fa02018-04-23 18:00:54 +08004560 boolean replyIconShown = bindReplyIcon(contentView, p.hideReplyIcon || p.ambient);
Selim Cinek384804b2018-04-18 14:31:07 +08004561 contentView.setViewVisibility(R.id.right_icon_container,
Selim Cinek1c72fa02018-04-23 18:00:54 +08004562 largeIconShown || replyIconShown ? View.VISIBLE : View.GONE);
4563 int marginEnd = calculateMarginEnd(largeIconShown, replyIconShown);
4564 contentView.setViewLayoutMarginEnd(R.id.line1, marginEnd);
4565 contentView.setViewLayoutMarginEnd(R.id.text, marginEnd);
4566 contentView.setViewLayoutMarginEnd(R.id.progress, marginEnd);
Selim Cinek384804b2018-04-18 14:31:07 +08004567 if (result != null) {
Selim Cinek1c72fa02018-04-23 18:00:54 +08004568 result.setIconMarginEnd(marginEnd);
Selim Cinek384804b2018-04-18 14:31:07 +08004569 }
4570 }
4571
Selim Cinek1c72fa02018-04-23 18:00:54 +08004572 private int calculateMarginEnd(boolean largeIconShown, boolean replyIconShown) {
4573 int marginEnd = 0;
4574 int contentMargin = mContext.getResources().getDimensionPixelSize(
4575 R.dimen.notification_content_margin_end);
4576 int iconSize = mContext.getResources().getDimensionPixelSize(
4577 R.dimen.notification_right_icon_size);
4578 if (replyIconShown) {
4579 // The size of the reply icon
4580 marginEnd += iconSize;
4581
4582 int replyInset = mContext.getResources().getDimensionPixelSize(
4583 R.dimen.notification_reply_inset);
4584 // We're subtracting the inset of the reply icon to make sure it's
4585 // aligned nicely on the right, and remove it from the following padding
4586 marginEnd -= replyInset * 2;
4587 }
4588 if (largeIconShown) {
4589 // adding size of the right icon
4590 marginEnd += iconSize;
4591
4592 if (replyIconShown) {
4593 // We also add some padding to the reply icon if it's around
4594 marginEnd += contentMargin;
4595 }
4596 }
4597 if (replyIconShown || largeIconShown) {
4598 // The padding to the content
4599 marginEnd += contentMargin;
4600 }
4601 return marginEnd;
4602 }
4603
Selim Cinek384804b2018-04-18 14:31:07 +08004604 /**
4605 * Bind the large icon.
4606 * @return if the largeIcon is visible
4607 */
4608 private boolean bindLargeIcon(RemoteViews contentView, boolean hideLargeIcon) {
Selim Cinek279fa862016-06-14 10:57:25 -07004609 if (mN.mLargeIcon == null && mN.largeIcon != null) {
4610 mN.mLargeIcon = Icon.createWithBitmap(mN.largeIcon);
4611 }
Selim Cinek88188f22017-09-19 16:46:56 -07004612 boolean showLargeIcon = mN.mLargeIcon != null && !hideLargeIcon;
4613 if (showLargeIcon) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004614 contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
4615 contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon);
4616 processLargeLegacyIcon(mN.mLargeIcon, contentView);
Selim Cinek88188f22017-09-19 16:46:56 -07004617 }
Selim Cinek384804b2018-04-18 14:31:07 +08004618 return showLargeIcon;
4619 }
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004620
Selim Cinek384804b2018-04-18 14:31:07 +08004621 /**
4622 * Bind the reply icon.
4623 * @return if the reply icon is visible
4624 */
4625 private boolean bindReplyIcon(RemoteViews contentView, boolean hideReplyIcon) {
4626 boolean actionVisible = !hideReplyIcon;
4627 Action action = null;
Selim Cinek88188f22017-09-19 16:46:56 -07004628 if (actionVisible) {
Selim Cinek384804b2018-04-18 14:31:07 +08004629 action = findReplyAction();
4630 actionVisible = action != null;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004631 }
Selim Cinek384804b2018-04-18 14:31:07 +08004632 if (actionVisible) {
4633 contentView.setViewVisibility(R.id.reply_icon_action, View.VISIBLE);
4634 contentView.setDrawableTint(R.id.reply_icon_action,
4635 false /* targetBackground */,
Selim Cinek4717d862018-04-19 09:19:15 +08004636 getNeutralColor(),
Selim Cinek384804b2018-04-18 14:31:07 +08004637 PorterDuff.Mode.SRC_ATOP);
4638 contentView.setOnClickPendingIntent(R.id.reply_icon_action, action.actionIntent);
4639 contentView.setRemoteInputs(R.id.reply_icon_action, action.mRemoteInputs);
4640 } else {
4641 contentView.setRemoteInputs(R.id.reply_icon_action, null);
4642 }
4643 contentView.setViewVisibility(R.id.reply_icon_action,
4644 actionVisible ? View.VISIBLE : View.GONE);
4645 return actionVisible;
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07004646 }
4647
4648 private Action findReplyAction() {
4649 ArrayList<Action> actions = mActions;
4650 if (mOriginalActions != null) {
4651 actions = mOriginalActions;
4652 }
4653 int numActions = actions.size();
4654 for (int i = 0; i < numActions; i++) {
4655 Action action = actions.get(i);
4656 if (hasValidRemoteInput(action)) {
4657 return action;
4658 }
4659 }
4660 return null;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004661 }
4662
Selim Cinekafeed292017-12-12 17:32:44 -08004663 private void bindNotificationHeader(RemoteViews contentView, boolean ambient,
4664 CharSequence secondaryHeaderText) {
Adrian Roos487374f2017-01-11 15:48:14 -08004665 bindSmallIcon(contentView, ambient);
4666 bindHeaderAppName(contentView, ambient);
4667 if (!ambient) {
4668 // Ambient view does not have these
4669 bindHeaderText(contentView);
Selim Cinekafeed292017-12-12 17:32:44 -08004670 bindHeaderTextSecondary(contentView, secondaryHeaderText);
Adrian Roos487374f2017-01-11 15:48:14 -08004671 bindHeaderChronometerAndTime(contentView);
Adrian Roos487374f2017-01-11 15:48:14 -08004672 bindProfileBadge(contentView);
4673 }
Julia Reynolds6013e5c2018-04-18 08:43:34 -04004674 bindActivePermissions(contentView, ambient);
Adrian Roosd83e9992017-03-16 15:17:57 -07004675 bindExpandButton(contentView);
Julia Reynoldsfc640012018-02-21 12:25:27 -05004676 mN.mUsesStandardHeader = true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004677 }
4678
Julia Reynolds6013e5c2018-04-18 08:43:34 -04004679 private void bindActivePermissions(RemoteViews contentView, boolean ambient) {
Selim Cinek4717d862018-04-19 09:19:15 +08004680 int color = ambient ? resolveAmbientColor() : getNeutralColor();
Julia Reynoldsb887b232018-04-10 16:38:08 -04004681 contentView.setDrawableTint(R.id.camera, false, color, PorterDuff.Mode.SRC_ATOP);
4682 contentView.setDrawableTint(R.id.mic, false, color, PorterDuff.Mode.SRC_ATOP);
4683 contentView.setDrawableTint(R.id.overlay, false, color, PorterDuff.Mode.SRC_ATOP);
4684 }
4685
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004686 private void bindExpandButton(RemoteViews contentView) {
Selim Cinekc7f5a822018-03-20 19:32:06 -07004687 int color = isColorized() ? getPrimaryTextColor() : getSecondaryTextColor();
Sunny Goyal5b153922017-09-21 21:00:36 -07004688 contentView.setDrawableTint(R.id.expand_button, false, color,
4689 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08004690 contentView.setInt(R.id.notification_header, "setOriginalNotificationColor",
Selim Cinek7b9605b2017-01-19 17:36:00 -08004691 color);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004692 }
4693
4694 private void bindHeaderChronometerAndTime(RemoteViews contentView) {
4695 if (showsTimeOrChronometer()) {
Selim Cinek29603462015-11-17 19:04:39 -08004696 contentView.setViewVisibility(R.id.time_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004697 setTextViewColorSecondary(contentView, R.id.time_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004698 if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) {
4699 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
4700 contentView.setLong(R.id.chronometer, "setBase",
4701 mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
4702 contentView.setBoolean(R.id.chronometer, "setStarted", true);
Adrian Roos96b7e202016-05-17 13:50:38 -07004703 boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN);
Selim Cinekc3b752e2016-04-20 16:13:59 -07004704 contentView.setChronometerCountDown(R.id.chronometer, countsDown);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004705 setTextViewColorSecondary(contentView, R.id.chronometer);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004706 } else {
4707 contentView.setViewVisibility(R.id.time, View.VISIBLE);
4708 contentView.setLong(R.id.time, "setTime", mN.when);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004709 setTextViewColorSecondary(contentView, R.id.time);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004710 }
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004711 } else {
4712 // We still want a time to be set but gone, such that we can show and hide it
4713 // on demand in case it's a child notification without anything in the header
4714 contentView.setLong(R.id.time, "setTime", mN.when != 0 ? mN.when : mN.creationTime);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004715 }
4716 }
4717
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004718 private void bindHeaderText(RemoteViews contentView) {
4719 CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
4720 if (headerText == null && mStyle != null && mStyle.mSummaryTextSet
Selim Cinek03d0d652015-11-13 13:18:09 -05004721 && mStyle.hasSummaryInHeader()) {
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004722 headerText = mStyle.mSummaryText;
Selim Cinek03d0d652015-11-13 13:18:09 -05004723 }
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004724 if (headerText == null
4725 && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
4726 && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) {
4727 headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT);
4728 }
4729 if (headerText != null) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004730 // TODO: Remove the span entirely to only have the string with propper formating.
Selim Cinek48f66b72017-08-18 16:17:51 -07004731 contentView.setTextViewText(R.id.header_text, processTextSpans(
4732 processLegacyText(headerText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004733 setTextViewColorSecondary(contentView, R.id.header_text);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07004734 contentView.setViewVisibility(R.id.header_text, View.VISIBLE);
4735 contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE);
Selim Cinek7b9605b2017-01-19 17:36:00 -08004736 setTextViewColorSecondary(contentView, R.id.header_text_divider);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004737 }
4738 }
4739
Selim Cinekafeed292017-12-12 17:32:44 -08004740 private void bindHeaderTextSecondary(RemoteViews contentView, CharSequence secondaryText) {
4741 if (!TextUtils.isEmpty(secondaryText)) {
4742 contentView.setTextViewText(R.id.header_text_secondary, processTextSpans(
4743 processLegacyText(secondaryText)));
4744 setTextViewColorSecondary(contentView, R.id.header_text_secondary);
4745 contentView.setViewVisibility(R.id.header_text_secondary, View.VISIBLE);
4746 contentView.setViewVisibility(R.id.header_text_secondary_divider, View.VISIBLE);
4747 setTextViewColorSecondary(contentView, R.id.header_text_secondary_divider);
4748 }
4749 }
4750
Adrian Rooseba05822016-04-22 17:09:27 -07004751 /**
4752 * @hide
4753 */
4754 public String loadHeaderAppName() {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004755 CharSequence name = null;
4756 final PackageManager pm = mContext.getPackageManager();
4757 if (mN.extras.containsKey(EXTRA_SUBSTITUTE_APP_NAME)) {
4758 // only system packages which lump together a bunch of unrelated stuff
4759 // may substitute a different name to make the purpose of the
4760 // notification more clear. the correct package label should always
4761 // be accessible via SystemUI.
4762 final String pkg = mContext.getPackageName();
4763 final String subName = mN.extras.getString(EXTRA_SUBSTITUTE_APP_NAME);
4764 if (PackageManager.PERMISSION_GRANTED == pm.checkPermission(
4765 android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME, pkg)) {
4766 name = subName;
4767 } else {
4768 Log.w(TAG, "warning: pkg "
4769 + pkg + " attempting to substitute app name '" + subName
4770 + "' without holding perm "
4771 + android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME);
4772 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004773 }
Dan Sandler732bd6c2016-04-12 14:20:32 -04004774 if (TextUtils.isEmpty(name)) {
4775 name = pm.getApplicationLabel(mContext.getApplicationInfo());
4776 }
4777 if (TextUtils.isEmpty(name)) {
4778 // still nothing?
4779 return null;
4780 }
4781
4782 return String.valueOf(name);
4783 }
Adrian Roos487374f2017-01-11 15:48:14 -08004784 private void bindHeaderAppName(RemoteViews contentView, boolean ambient) {
Dan Sandler732bd6c2016-04-12 14:20:32 -04004785 contentView.setTextViewText(R.id.app_name_text, loadHeaderAppName());
Adrian Roos72171622017-01-27 10:32:06 -08004786 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08004787 setTextViewColorPrimary(contentView, R.id.app_name_text);
4788 } else {
4789 contentView.setTextColor(R.id.app_name_text,
Selim Cinekc7f5a822018-03-20 19:32:06 -07004790 ambient ? resolveAmbientColor() : getSecondaryTextColor());
Selim Cinek7b9605b2017-01-19 17:36:00 -08004791 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004792 }
4793
Adrian Roos487374f2017-01-11 15:48:14 -08004794 private void bindSmallIcon(RemoteViews contentView, boolean ambient) {
Selim Cinek279fa862016-06-14 10:57:25 -07004795 if (mN.mSmallIcon == null && mN.icon != 0) {
4796 mN.mSmallIcon = Icon.createWithResource(mContext, mN.icon);
4797 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004798 contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon);
Sunny Goyal5b153922017-09-21 21:00:36 -07004799 contentView.setInt(R.id.icon, "setImageLevel", mN.iconLevel);
Adrian Roos487374f2017-01-11 15:48:14 -08004800 processSmallIconColor(mN.mSmallIcon, contentView, ambient);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07004801 }
4802
Jorim Jaggi445d3c02014-08-19 22:33:42 +02004803 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004804 * @return true if the built notification will show the time or the chronometer; false
4805 * otherwise
4806 */
4807 private boolean showsTimeOrChronometer() {
Selim Cinekc2c0b042016-05-18 17:13:46 -07004808 return mN.showsTime() || mN.showsChronometer();
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004809 }
4810
Christoph Studerfe718432014-09-01 18:21:18 +02004811 private void resetStandardTemplateWithActions(RemoteViews big) {
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004812 // actions_container is only reset when there are no actions to avoid focus issues with
4813 // remote inputs.
Christoph Studerfe718432014-09-01 18:21:18 +02004814 big.setViewVisibility(R.id.actions, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02004815 big.removeAllViews(R.id.actions);
Adrian Roose458aa82015-12-08 16:17:19 -08004816
4817 big.setViewVisibility(R.id.notification_material_reply_container, View.GONE);
4818 big.setTextViewText(R.id.notification_material_reply_text_1, null);
Kenny Guya0f6de82018-04-06 16:20:16 +01004819 big.setViewVisibility(R.id.notification_material_reply_text_1_container, View.GONE);
4820 big.setViewVisibility(R.id.notification_material_reply_progress, View.GONE);
Adrian Roose458aa82015-12-08 16:17:19 -08004821
4822 big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE);
4823 big.setTextViewText(R.id.notification_material_reply_text_2, null);
4824 big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE);
4825 big.setTextViewText(R.id.notification_material_reply_text_3, null);
Adrian Roosf852a422016-06-03 13:33:43 -07004826
Selim Cineked64a142018-02-06 18:06:01 -08004827 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target,
4828 R.dimen.notification_content_margin);
Christoph Studerfe718432014-09-01 18:21:18 +02004829 }
4830
Selim Cinek384804b2018-04-18 14:31:07 +08004831 private RemoteViews applyStandardTemplateWithActions(int layoutId,
4832 TemplateBindResult result) {
4833 return applyStandardTemplateWithActions(layoutId, mParams.reset().fillTextsFrom(this),
4834 result);
Adrian Roos48d746a2016-04-12 14:57:28 -07004835 }
4836
Adrian Roos70d7aa32017-01-11 15:39:06 -08004837 private RemoteViews applyStandardTemplateWithActions(int layoutId,
Selim Cinek384804b2018-04-18 14:31:07 +08004838 StandardTemplateParams p, TemplateBindResult result) {
4839 RemoteViews big = applyStandardTemplate(layoutId, p, result);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004840
Christoph Studerfe718432014-09-01 18:21:18 +02004841 resetStandardTemplateWithActions(big);
4842
Adrian Roose458aa82015-12-08 16:17:19 -08004843 boolean validRemoteInput = false;
4844
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004845 int N = mActions.size();
Adrian Roos487374f2017-01-11 15:48:14 -08004846 boolean emphazisedMode = mN.fullScreenIntent != null && !p.ambient;
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004847 big.setBoolean(R.id.actions, "setEmphasizedMode", emphazisedMode);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004848 if (N > 0) {
Adrian Roos7052de52016-03-03 15:53:34 -08004849 big.setViewVisibility(R.id.actions_container, View.VISIBLE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004850 big.setViewVisibility(R.id.actions, View.VISIBLE);
Selim Cineked64a142018-02-06 18:06:01 -08004851 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, 0);
Daniel Sandler8680bf82012-05-15 16:52:52 -04004852 if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004853 for (int i=0; i<N; i++) {
Adrian Roose458aa82015-12-08 16:17:19 -08004854 Action action = mActions.get(i);
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004855 boolean actionHasValidInput = hasValidRemoteInput(action);
4856 validRemoteInput |= actionHasValidInput;
Adrian Roose458aa82015-12-08 16:17:19 -08004857
Selim Cinek06e9e1f2016-07-08 17:14:16 -07004858 final RemoteViews button = generateActionButton(action, emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07004859 p.ambient);
4860 if (actionHasValidInput && !emphazisedMode) {
Selim Cinekffcc7cf2018-02-06 17:43:51 -08004861 // Clear the drawable
4862 button.setInt(R.id.action0, "setBackgroundResource", 0);
4863 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004864 big.addView(R.id.actions, button);
4865 }
Adrian Roos4c1fcc82016-03-31 14:39:39 -07004866 } else {
4867 big.setViewVisibility(R.id.actions_container, View.GONE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004868 }
Adrian Roose458aa82015-12-08 16:17:19 -08004869
4870 CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
Adrian Roos487374f2017-01-11 15:48:14 -08004871 if (!p.ambient && validRemoteInput && replyText != null
Adrian Roose458aa82015-12-08 16:17:19 -08004872 && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])) {
Kenny Guya0f6de82018-04-06 16:20:16 +01004873 boolean showSpinner = mN.extras.getBoolean(EXTRA_SHOW_REMOTE_INPUT_SPINNER);
Adrian Roose458aa82015-12-08 16:17:19 -08004874 big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE);
Kenny Guya0f6de82018-04-06 16:20:16 +01004875 big.setViewVisibility(R.id.notification_material_reply_text_1_container,
4876 View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004877 big.setTextViewText(R.id.notification_material_reply_text_1,
4878 processTextSpans(replyText[0]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004879 setTextViewColorSecondary(big, R.id.notification_material_reply_text_1);
Kenny Guya0f6de82018-04-06 16:20:16 +01004880 big.setViewVisibility(R.id.notification_material_reply_progress,
4881 showSpinner ? View.VISIBLE : View.GONE);
4882 big.setProgressIndeterminateTintList(
4883 R.id.notification_material_reply_progress,
4884 ColorStateList.valueOf(
4885 isColorized() ? getPrimaryTextColor() : resolveContrastColor()));
Adrian Roose458aa82015-12-08 16:17:19 -08004886
4887 if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])) {
4888 big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004889 big.setTextViewText(R.id.notification_material_reply_text_2,
4890 processTextSpans(replyText[1]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004891 setTextViewColorSecondary(big, R.id.notification_material_reply_text_2);
Adrian Roose458aa82015-12-08 16:17:19 -08004892
4893 if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])) {
4894 big.setViewVisibility(
4895 R.id.notification_material_reply_text_3, View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07004896 big.setTextViewText(R.id.notification_material_reply_text_3,
4897 processTextSpans(replyText[2]));
Selim Cinek7b9605b2017-01-19 17:36:00 -08004898 setTextViewColorSecondary(big, R.id.notification_material_reply_text_3);
Adrian Roose458aa82015-12-08 16:17:19 -08004899 }
4900 }
4901 }
4902
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004903 return big;
4904 }
4905
Adrian Roose458aa82015-12-08 16:17:19 -08004906 private boolean hasValidRemoteInput(Action action) {
4907 if (TextUtils.isEmpty(action.title) || action.actionIntent == null) {
4908 // Weird actions
4909 return false;
4910 }
4911
4912 RemoteInput[] remoteInputs = action.getRemoteInputs();
4913 if (remoteInputs == null) {
4914 return false;
4915 }
4916
4917 for (RemoteInput r : remoteInputs) {
4918 CharSequence[] choices = r.getChoices();
4919 if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) {
4920 return true;
4921 }
4922 }
4923 return false;
4924 }
4925
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004926 /**
4927 * Construct a RemoteViews for the final 1U notification layout. In order:
4928 * 1. Custom contentView from the caller
4929 * 2. Style's proposed content view
4930 * 3. Standard template view
4931 */
Julia Reynolds3b848122016-02-26 10:45:32 -05004932 public RemoteViews createContentView() {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004933 return createContentView(false /* increasedheight */ );
4934 }
4935
4936 /**
4937 * Construct a RemoteViews for the smaller content view.
4938 *
4939 * @param increasedHeight true if this layout be created with an increased height. Some
4940 * styles may support showing more then just that basic 1U size
4941 * and the system may decide to render important notifications
4942 * slightly bigger even when collapsed.
4943 *
4944 * @hide
4945 */
4946 public RemoteViews createContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07004947 if (mN.contentView != null && useExistingRemoteView()) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004948 return mN.contentView;
4949 } else if (mStyle != null) {
Selim Cinek7d1009b2017-01-25 15:28:28 -08004950 final RemoteViews styleView = mStyle.makeContentView(increasedHeight);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004951 if (styleView != null) {
4952 return styleView;
4953 }
Joe Onorato46439ce2010-11-19 13:56:21 -08004954 }
Selim Cinek384804b2018-04-18 14:31:07 +08004955 return applyStandardTemplate(getBaseLayoutResource(), null /* result */);
Joe Onorato46439ce2010-11-19 13:56:21 -08004956 }
4957
Selim Cineka7679b62017-05-10 16:33:25 -07004958 private boolean useExistingRemoteView() {
4959 return mStyle == null || (!mStyle.displayCustomViewInline()
4960 && !mRebuildStyledRemoteViews);
4961 }
4962
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004963 /**
4964 * Construct a RemoteViews for the final big notification layout.
4965 */
Julia Reynolds3b848122016-02-26 10:45:32 -05004966 public RemoteViews createBigContentView() {
Selim Cinek850a8542015-11-11 11:48:36 -05004967 RemoteViews result = null;
Selim Cineka7679b62017-05-10 16:33:25 -07004968 if (mN.bigContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05004969 return mN.bigContentView;
4970 } else if (mStyle != null) {
Selim Cinek850a8542015-11-11 11:48:36 -05004971 result = mStyle.makeBigContentView();
Selim Cinek90dcf6d2015-11-18 20:24:13 -08004972 hideLine1Text(result);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08004973 } else if (mActions.size() != 0) {
Selim Cinek384804b2018-04-18 14:31:07 +08004974 result = applyStandardTemplateWithActions(getBigBaseLayoutResource(),
4975 null /* result */);
Selim Cinek850a8542015-11-11 11:48:36 -05004976 }
Selim Cinek6743c0b2017-01-18 18:24:01 -08004977 makeHeaderExpanded(result);
Selim Cinek850a8542015-11-11 11:48:36 -05004978 return result;
4979 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04004980
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004981 /**
Selim Cinek414ad332017-02-24 19:06:12 -08004982 * Construct a RemoteViews for the final notification header only. This will not be
4983 * colorized.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004984 *
Adrian Roos6f6e1592017-05-02 16:22:53 -07004985 * @param ambient if true, generate the header for the ambient display layout.
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004986 * @hide
4987 */
Adrian Roos6f6e1592017-05-02 16:22:53 -07004988 public RemoteViews makeNotificationHeader(boolean ambient) {
Selim Cinek414ad332017-02-24 19:06:12 -08004989 Boolean colorized = (Boolean) mN.extras.get(EXTRA_COLORIZED);
4990 mN.extras.putBoolean(EXTRA_COLORIZED, false);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004991 RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(),
Adrian Roos6f6e1592017-05-02 16:22:53 -07004992 ambient ? R.layout.notification_template_ambient_header
4993 : R.layout.notification_template_header);
Selim Cinekeaa29ca2015-11-23 13:51:13 -08004994 resetNotificationHeader(header);
Selim Cinekafeed292017-12-12 17:32:44 -08004995 bindNotificationHeader(header, ambient, null);
Selim Cinek414ad332017-02-24 19:06:12 -08004996 if (colorized != null) {
4997 mN.extras.putBoolean(EXTRA_COLORIZED, colorized);
4998 } else {
4999 mN.extras.remove(EXTRA_COLORIZED);
5000 }
Selim Cinekeaa29ca2015-11-23 13:51:13 -08005001 return header;
5002 }
5003
Adrian Roos487374f2017-01-11 15:48:14 -08005004 /**
5005 * Construct a RemoteViews for the ambient version of the notification.
5006 *
5007 * @hide
5008 */
5009 public RemoteViews makeAmbientNotification() {
5010 RemoteViews ambient = applyStandardTemplateWithActions(
5011 R.layout.notification_template_material_ambient,
Selim Cinek384804b2018-04-18 14:31:07 +08005012 mParams.reset().ambient(true).fillTextsFrom(this).hasProgress(false),
5013 null /* result */);
Adrian Roos487374f2017-01-11 15:48:14 -08005014 return ambient;
5015 }
5016
Selim Cinek29603462015-11-17 19:04:39 -08005017 private void hideLine1Text(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005018 if (result != null) {
5019 result.setViewVisibility(R.id.text_line_1, View.GONE);
5020 }
Selim Cinek29603462015-11-17 19:04:39 -08005021 }
5022
Selim Cinek6743c0b2017-01-18 18:24:01 -08005023 /**
5024 * Adapt the Notification header if this view is used as an expanded view.
5025 *
5026 * @hide
5027 */
5028 public static void makeHeaderExpanded(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005029 if (result != null) {
5030 result.setBoolean(R.id.notification_header, "setExpanded", true);
5031 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005032 }
5033
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005034 /**
5035 * Construct a RemoteViews for the final heads-up notification layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08005036 *
5037 * @param increasedHeight true if this layout be created with an increased height. Some
5038 * styles may support showing more then just that basic 1U size
5039 * and the system may decide to render important notifications
5040 * slightly bigger even when collapsed.
5041 *
5042 * @hide
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005043 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08005044 public RemoteViews createHeadsUpContentView(boolean increasedHeight) {
Selim Cineka7679b62017-05-10 16:33:25 -07005045 if (mN.headsUpContentView != null && useExistingRemoteView()) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05005046 return mN.headsUpContentView;
5047 } else if (mStyle != null) {
Selim Cinek87ed69b2017-02-09 15:59:43 -08005048 final RemoteViews styleView = mStyle.makeHeadsUpContentView(increasedHeight);
5049 if (styleView != null) {
5050 return styleView;
5051 }
Julia Reynolds089e3e42015-11-18 09:59:57 -05005052 } else if (mActions.size() == 0) {
5053 return null;
5054 }
5055
Selim Cinek384804b2018-04-18 14:31:07 +08005056 return applyStandardTemplateWithActions(getBigBaseLayoutResource(), null /* result */);
Chris Wren8fd39ec2014-02-27 17:43:26 -05005057 }
5058
Selim Cinek624c02db2015-12-14 21:00:02 -08005059 /**
Selim Cinek87ed69b2017-02-09 15:59:43 -08005060 * Construct a RemoteViews for the final heads-up notification layout.
5061 */
5062 public RemoteViews createHeadsUpContentView() {
5063 return createHeadsUpContentView(false /* useIncreasedHeight */);
5064 }
5065
5066 /**
Selim Cinek624c02db2015-12-14 21:00:02 -08005067 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
5068 *
5069 * @hide
5070 */
5071 public RemoteViews makePublicContentView() {
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005072 return makePublicView(false /* ambient */);
5073 }
5074
5075 /**
5076 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
5077 *
5078 * @hide
5079 */
5080 public RemoteViews makePublicAmbientNotification() {
5081 return makePublicView(true /* ambient */);
5082 }
5083
5084 private RemoteViews makePublicView(boolean ambient) {
Selim Cinek624c02db2015-12-14 21:00:02 -08005085 if (mN.publicVersion != null) {
5086 final Builder builder = recoverBuilder(mContext, mN.publicVersion);
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005087 return ambient ? builder.makeAmbientNotification() : builder.createContentView();
Selim Cinek624c02db2015-12-14 21:00:02 -08005088 }
5089 Bundle savedBundle = mN.extras;
5090 Style style = mStyle;
5091 mStyle = null;
5092 Icon largeIcon = mN.mLargeIcon;
5093 mN.mLargeIcon = null;
Selim Cinek279fa862016-06-14 10:57:25 -07005094 Bitmap largeIconLegacy = mN.largeIcon;
5095 mN.largeIcon = null;
Adrian Roosb19b06b2017-05-02 18:54:40 -07005096 ArrayList<Action> actions = mActions;
5097 mActions = new ArrayList<>();
Selim Cinek624c02db2015-12-14 21:00:02 -08005098 Bundle publicExtras = new Bundle();
5099 publicExtras.putBoolean(EXTRA_SHOW_WHEN,
5100 savedBundle.getBoolean(EXTRA_SHOW_WHEN));
5101 publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER,
5102 savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER));
Adrian Roos96b7e202016-05-17 13:50:38 -07005103 publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN,
5104 savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN));
Selim Cinek624c02db2015-12-14 21:00:02 -08005105 mN.extras = publicExtras;
Selim Cinek499c20f2017-07-20 14:06:09 -07005106 RemoteViews view;
5107 if (ambient) {
5108 publicExtras.putCharSequence(EXTRA_TITLE,
5109 mContext.getString(com.android.internal.R.string.notification_hidden_text));
5110 view = makeAmbientNotification();
5111 } else{
5112 view = makeNotificationHeader(false /* ambient */);
5113 view.setBoolean(R.id.notification_header, "setExpandOnlyOnButton", true);
5114 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005115 mN.extras = savedBundle;
5116 mN.mLargeIcon = largeIcon;
Selim Cinek279fa862016-06-14 10:57:25 -07005117 mN.largeIcon = largeIconLegacy;
Adrian Roosb19b06b2017-05-02 18:54:40 -07005118 mActions = actions;
Selim Cinek624c02db2015-12-14 21:00:02 -08005119 mStyle = style;
Adrian Roos1a1ecfc2017-04-17 11:17:59 -07005120 return view;
Selim Cinek624c02db2015-12-14 21:00:02 -08005121 }
5122
Selim Cinek6743c0b2017-01-18 18:24:01 -08005123 /**
5124 * Construct a content view for the display when low - priority
5125 *
5126 * @param useRegularSubtext uses the normal subtext set if there is one available. Otherwise
5127 * a new subtext is created consisting of the content of the
5128 * notification.
5129 * @hide
5130 */
5131 public RemoteViews makeLowPriorityContentView(boolean useRegularSubtext) {
5132 int color = mN.color;
5133 mN.color = COLOR_DEFAULT;
5134 CharSequence summary = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
5135 if (!useRegularSubtext || TextUtils.isEmpty(summary)) {
5136 CharSequence newSummary = createSummaryText();
5137 if (!TextUtils.isEmpty(newSummary)) {
5138 mN.extras.putCharSequence(EXTRA_SUB_TEXT, newSummary);
5139 }
5140 }
Selim Cinek875ba9b2017-02-13 16:20:17 -08005141
Adrian Roos6f6e1592017-05-02 16:22:53 -07005142 RemoteViews header = makeNotificationHeader(false /* ambient */);
Selim Cinek1b554392017-02-28 17:22:49 -08005143 header.setBoolean(R.id.notification_header, "setAcceptAllTouches", true);
Selim Cinek6743c0b2017-01-18 18:24:01 -08005144 if (summary != null) {
5145 mN.extras.putCharSequence(EXTRA_SUB_TEXT, summary);
5146 } else {
5147 mN.extras.remove(EXTRA_SUB_TEXT);
5148 }
5149 mN.color = color;
5150 return header;
5151 }
Selim Cinek624c02db2015-12-14 21:00:02 -08005152
Selim Cinek6743c0b2017-01-18 18:24:01 -08005153 private CharSequence createSummaryText() {
5154 CharSequence titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE);
5155 if (USE_ONLY_TITLE_IN_LOW_PRIORITY_SUMMARY) {
5156 return titleText;
5157 }
5158 SpannableStringBuilder summary = new SpannableStringBuilder();
5159 if (titleText == null) {
5160 titleText = mN.extras.getCharSequence(Notification.EXTRA_TITLE_BIG);
5161 }
5162 BidiFormatter bidi = BidiFormatter.getInstance();
5163 if (titleText != null) {
5164 summary.append(bidi.unicodeWrap(titleText));
5165 }
5166 CharSequence contentText = mN.extras.getCharSequence(Notification.EXTRA_TEXT);
5167 if (titleText != null && contentText != null) {
5168 summary.append(bidi.unicodeWrap(mContext.getText(
5169 R.string.notification_header_divider_symbol_with_spaces)));
5170 }
5171 if (contentText != null) {
5172 summary.append(bidi.unicodeWrap(contentText));
5173 }
5174 return summary;
5175 }
Chris Wren8fd39ec2014-02-27 17:43:26 -05005176
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005177 private RemoteViews generateActionButton(Action action, boolean emphazisedMode,
Selim Cinek396caca2018-04-10 17:46:46 -07005178 boolean ambient) {
Daniel Sandler8680bf82012-05-15 16:52:52 -04005179 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07005180 RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(),
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005181 emphazisedMode ? getEmphasizedActionLayoutResource()
5182 : tombstone ? getActionTombstoneLayoutResource()
5183 : getActionLayoutResource());
Daniel Sandler8680bf82012-05-15 16:52:52 -04005184 if (!tombstone) {
Daniel Sandlere5518842012-05-10 16:20:40 -04005185 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
Daniel Sandlere5518842012-05-10 16:20:40 -04005186 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005187 button.setContentDescription(R.id.action0, action.title);
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005188 if (action.mRemoteInputs != null) {
5189 button.setRemoteInputs(R.id.action0, action.mRemoteInputs);
5190 }
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005191 if (emphazisedMode) {
Selim Cinek981962e2016-07-20 20:41:58 -07005192 // change the background bgColor
Selim Cinek981962e2016-07-20 20:41:58 -07005193 CharSequence title = action.title;
5194 ColorStateList[] outResultColor = null;
Selim Cinek396caca2018-04-10 17:46:46 -07005195 int background = resolveBackgroundColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005196 if (isLegacy()) {
Selim Cinek87c31532017-08-18 18:53:44 -07005197 title = NotificationColorUtil.clearColorSpans(title);
Selim Cinek981962e2016-07-20 20:41:58 -07005198 } else {
5199 outResultColor = new ColorStateList[1];
Selim Cinek396caca2018-04-10 17:46:46 -07005200 title = ensureColorSpanContrast(title, background, outResultColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005201 }
Selim Cinek48f66b72017-08-18 16:17:51 -07005202 button.setTextViewText(R.id.action0, processTextSpans(title));
Selim Cinek7b9605b2017-01-19 17:36:00 -08005203 setTextViewColorPrimary(button, R.id.action0);
Selim Cinek396caca2018-04-10 17:46:46 -07005204 int rippleColor;
5205 boolean hasColorOverride = outResultColor != null && outResultColor[0] != null;
5206 if (hasColorOverride) {
5207 // There's a span spanning the full text, let's take it and use it as the
5208 // background color
5209 background = outResultColor[0].getDefaultColor();
5210 int textColor = NotificationColorUtil.resolvePrimaryColor(mContext,
5211 background);
5212 button.setTextColor(R.id.action0, textColor);
5213 rippleColor = textColor;
Anthony Chenad4d1582017-04-10 16:07:58 -07005214 } else if (mN.color != COLOR_DEFAULT && !isColorized() && mTintActionButtons) {
Selim Cinek396caca2018-04-10 17:46:46 -07005215 rippleColor = resolveContrastColor();
5216 button.setTextColor(R.id.action0, rippleColor);
5217 } else {
5218 rippleColor = getPrimaryTextColor();
Selim Cinek981962e2016-07-20 20:41:58 -07005219 }
Selim Cinek396caca2018-04-10 17:46:46 -07005220 // We only want about 20% alpha for the ripple
5221 rippleColor = (rippleColor & 0x00ffffff) | 0x33000000;
5222 button.setColorStateList(R.id.action0, "setRippleColor",
5223 ColorStateList.valueOf(rippleColor));
5224 button.setColorStateList(R.id.action0, "setButtonBackground",
5225 ColorStateList.valueOf(background));
5226 button.setBoolean(R.id.action0, "setHasStroke", !hasColorOverride);
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005227 } else {
Selim Cinek48f66b72017-08-18 16:17:51 -07005228 button.setTextViewText(R.id.action0, processTextSpans(
5229 processLegacyText(action.title)));
Adrian Roos72171622017-01-27 10:32:06 -08005230 if (isColorized() && !ambient) {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005231 setTextViewColorPrimary(button, R.id.action0);
Anthony Chenad4d1582017-04-10 16:07:58 -07005232 } else if (mN.color != COLOR_DEFAULT && mTintActionButtons) {
Adrian Roos487374f2017-01-11 15:48:14 -08005233 button.setTextColor(R.id.action0,
5234 ambient ? resolveAmbientColor() : resolveContrastColor());
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005235 }
Adrian Roosfe84e1f2015-11-04 15:55:39 -08005236 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04005237 return button;
5238 }
5239
Joe Onoratocb109a02011-01-18 17:57:41 -08005240 /**
Selim Cinek981962e2016-07-20 20:41:58 -07005241 * Ensures contrast on color spans against a background color. also returns the color of the
5242 * text if a span was found that spans over the whole text.
5243 *
5244 * @param charSequence the charSequence on which the spans are
5245 * @param background the background color to ensure the contrast against
5246 * @param outResultColor an array in which a color will be returned as the first element if
5247 * there exists a full length color span.
5248 * @return the contrasted charSequence
5249 */
5250 private CharSequence ensureColorSpanContrast(CharSequence charSequence, int background,
5251 ColorStateList[] outResultColor) {
5252 if (charSequence instanceof Spanned) {
5253 Spanned ss = (Spanned) charSequence;
5254 Object[] spans = ss.getSpans(0, ss.length(), Object.class);
5255 SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
5256 for (Object span : spans) {
5257 Object resultSpan = span;
5258 int spanStart = ss.getSpanStart(span);
5259 int spanEnd = ss.getSpanEnd(span);
5260 boolean fullLength = (spanEnd - spanStart) == charSequence.length();
5261 if (resultSpan instanceof CharacterStyle) {
5262 resultSpan = ((CharacterStyle) span).getUnderlying();
5263 }
5264 if (resultSpan instanceof TextAppearanceSpan) {
5265 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
5266 ColorStateList textColor = originalSpan.getTextColor();
5267 if (textColor != null) {
5268 int[] colors = textColor.getColors();
5269 int[] newColors = new int[colors.length];
5270 for (int i = 0; i < newColors.length; i++) {
5271 newColors[i] = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005272 colors[i], background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005273 }
5274 textColor = new ColorStateList(textColor.getStates().clone(),
5275 newColors);
Selim Cinek396caca2018-04-10 17:46:46 -07005276 if (fullLength) {
5277 outResultColor[0] = textColor;
5278 // Let's drop the color from the span
5279 textColor = null;
5280 }
Selim Cinek981962e2016-07-20 20:41:58 -07005281 resultSpan = new TextAppearanceSpan(
5282 originalSpan.getFamily(),
5283 originalSpan.getTextStyle(),
5284 originalSpan.getTextSize(),
5285 textColor,
5286 originalSpan.getLinkTextColor());
Selim Cinek981962e2016-07-20 20:41:58 -07005287 }
5288 } else if (resultSpan instanceof ForegroundColorSpan) {
5289 ForegroundColorSpan originalSpan = (ForegroundColorSpan) resultSpan;
5290 int foregroundColor = originalSpan.getForegroundColor();
5291 foregroundColor = NotificationColorUtil.ensureLargeTextContrast(
Anthony Chenad4d1582017-04-10 16:07:58 -07005292 foregroundColor, background, mInNightMode);
Selim Cinek981962e2016-07-20 20:41:58 -07005293 if (fullLength) {
5294 outResultColor[0] = ColorStateList.valueOf(foregroundColor);
Selim Cinek396caca2018-04-10 17:46:46 -07005295 resultSpan = null;
5296 } else {
5297 resultSpan = new ForegroundColorSpan(foregroundColor);
Selim Cinek981962e2016-07-20 20:41:58 -07005298 }
5299 } else {
5300 resultSpan = span;
5301 }
Selim Cinek396caca2018-04-10 17:46:46 -07005302 if (resultSpan != null) {
5303 builder.setSpan(resultSpan, spanStart, spanEnd, ss.getSpanFlags(span));
5304 }
Selim Cinek981962e2016-07-20 20:41:58 -07005305 }
5306 return builder;
5307 }
5308 return charSequence;
5309 }
5310
5311 /**
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005312 * @return Whether we are currently building a notification from a legacy (an app that
Alan Viverette3cb07a462014-06-06 14:19:53 -07005313 * doesn't create material notifications by itself) app.
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005314 */
5315 private boolean isLegacy() {
Selim Cinek7b9605b2017-01-19 17:36:00 -08005316 if (!mIsLegacyInitialized) {
5317 mIsLegacy = mContext.getApplicationInfo().targetSdkVersion
5318 < Build.VERSION_CODES.LOLLIPOP;
5319 mIsLegacyInitialized = true;
5320 }
5321 return mIsLegacy;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005322 }
5323
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005324 private CharSequence processLegacyText(CharSequence charSequence) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08005325 return processLegacyText(charSequence, false /* ambient */);
5326 }
5327
5328 private CharSequence processLegacyText(CharSequence charSequence, boolean ambient) {
5329 boolean isAlreadyLightText = isLegacy() || textColorsNeedInversion();
5330 boolean wantLightText = ambient;
5331 if (isAlreadyLightText != wantLightText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005332 return getColorUtil().invertCharSequenceColors(charSequence);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005333 } else {
5334 return charSequence;
5335 }
5336 }
5337
Dan Sandler26e81cf2014-05-06 10:01:27 -04005338 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005339 * Apply any necessariy colors to the small icon
Dan Sandler26e81cf2014-05-06 10:01:27 -04005340 */
Adrian Roos487374f2017-01-11 15:48:14 -08005341 private void processSmallIconColor(Icon smallIcon, RemoteViews contentView,
5342 boolean ambient) {
Selim Cinekea4bef72015-12-02 15:51:10 -08005343 boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon);
Selim Cinekc7f5a822018-03-20 19:32:06 -07005344 int color;
5345 if (ambient) {
5346 color = resolveAmbientColor();
5347 } else if (isColorized()) {
5348 color = getPrimaryTextColor();
5349 } else {
5350 color = resolveContrastColor();
5351 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005352 if (colorable) {
Sunny Goyal5b153922017-09-21 21:00:36 -07005353 contentView.setDrawableTint(R.id.icon, false, color,
5354 PorterDuff.Mode.SRC_ATOP);
Selim Cinekea4bef72015-12-02 15:51:10 -08005355
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005356 }
Selim Cinekea4bef72015-12-02 15:51:10 -08005357 contentView.setInt(R.id.notification_header, "setOriginalIconColor",
Adrian Roos487374f2017-01-11 15:48:14 -08005358 colorable ? color : NotificationHeaderView.NO_COLOR);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005359 }
5360
Dan Sandler26e81cf2014-05-06 10:01:27 -04005361 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005362 * Make the largeIcon dark if it's a fake smallIcon (that is,
Dan Sandler26e81cf2014-05-06 10:01:27 -04005363 * if it's grayscale).
5364 */
5365 // TODO: also check bounds, transparency, that sort of thing.
Dan Sandlerd63f9322015-05-06 15:18:49 -04005366 private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) {
5367 if (largeIcon != null && isLegacy()
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005368 && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07005369 // resolve color will fall back to the default when legacy
Sunny Goyal5b153922017-09-21 21:00:36 -07005370 contentView.setDrawableTint(R.id.icon, false, resolveContrastColor(),
5371 PorterDuff.Mode.SRC_ATOP);
Jorim Jaggi92df1f22014-12-16 19:44:41 +01005372 }
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005373 }
5374
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05005375 private void sanitizeColor() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005376 if (mN.color != COLOR_DEFAULT) {
5377 mN.color |= 0xFF000000; // no alpha for custom colors
Jorim Jaggi74419312014-06-10 20:57:21 +02005378 }
Jorim Jaggi74419312014-06-10 20:57:21 +02005379 }
5380
Adrian Roos4ff3b122016-02-01 12:26:13 -08005381 int resolveContrastColor() {
5382 if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) {
5383 return mCachedContrastColor;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005384 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005385
Selim Cinekac5f0272017-05-02 16:05:41 -07005386 int color;
Selim Cinekc7f5a822018-03-20 19:32:06 -07005387 int background = mContext.getColor(
5388 com.android.internal.R.color.notification_material_background_color);
Selim Cinekac5f0272017-05-02 16:05:41 -07005389 if (mN.color == COLOR_DEFAULT) {
5390 ensureColors();
Selim Cinekc7f5a822018-03-20 19:32:06 -07005391 color = NotificationColorUtil.resolveDefaultColor(mContext, background);
Selim Cinekac5f0272017-05-02 16:05:41 -07005392 } else {
5393 color = NotificationColorUtil.resolveContrastColor(mContext, mN.color,
Anthony Chenad4d1582017-04-10 16:07:58 -07005394 background, mInNightMode);
Selim Cinekac5f0272017-05-02 16:05:41 -07005395 }
5396 if (Color.alpha(color) < 255) {
5397 // alpha doesn't go well for color filters, so let's blend it manually
5398 color = NotificationColorUtil.compositeColors(color, background);
5399 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08005400 mCachedContrastColorIsFor = mN.color;
Selim Cinekac5f0272017-05-02 16:05:41 -07005401 return mCachedContrastColor = color;
Dan Sandler26e81cf2014-05-06 10:01:27 -04005402 }
5403
Selim Cinek4717d862018-04-19 09:19:15 +08005404 int resolveNeutralColor() {
5405 if (mNeutralColor != COLOR_INVALID) {
5406 return mNeutralColor;
5407 }
5408 int background = mContext.getColor(
5409 com.android.internal.R.color.notification_material_background_color);
5410 mNeutralColor = NotificationColorUtil.resolveDefaultColor(mContext, background);
5411 if (Color.alpha(mNeutralColor) < 255) {
5412 // alpha doesn't go well for color filters, so let's blend it manually
5413 mNeutralColor = NotificationColorUtil.compositeColors(mNeutralColor, background);
5414 }
5415 return mNeutralColor;
5416 }
5417
Adrian Roos487374f2017-01-11 15:48:14 -08005418 int resolveAmbientColor() {
5419 if (mCachedAmbientColorIsFor == mN.color && mCachedAmbientColorIsFor != COLOR_INVALID) {
5420 return mCachedAmbientColor;
5421 }
5422 final int contrasted = NotificationColorUtil.resolveAmbientColor(mContext, mN.color);
5423
5424 mCachedAmbientColorIsFor = mN.color;
5425 return mCachedAmbientColor = contrasted;
5426 }
5427
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005428 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005429 * Apply the unstyled operations and return a new {@link Notification} object.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005430 * @hide
Joe Onoratocb109a02011-01-18 17:57:41 -08005431 */
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04005432 public Notification buildUnstyled() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005433 if (mActions.size() > 0) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005434 mN.actions = new Action[mActions.size()];
5435 mActions.toArray(mN.actions);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04005436 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005437 if (!mPersonList.isEmpty()) {
Selim Cineke7238dd2017-12-14 17:48:32 -08005438 mN.extras.putParcelableArrayList(EXTRA_PEOPLE_LIST, mPersonList);
Dan Sandler0bf2ed82013-12-21 23:33:41 -06005439 }
Selim Cinek247fa012016-02-18 09:50:48 -08005440 if (mN.bigContentView != null || mN.contentView != null
5441 || mN.headsUpContentView != null) {
5442 mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true);
5443 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005444 return mN;
Joe Onorato46439ce2010-11-19 13:56:21 -08005445 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005446
Julia Reynolds3b848122016-02-26 10:45:32 -05005447 /**
5448 * Creates a Builder from an existing notification so further changes can be made.
5449 * @param context The context for your application / activity.
5450 * @param n The notification to create a Builder from.
5451 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005452 public static Notification.Builder recoverBuilder(Context context, Notification n) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02005453 // Re-create notification context so we can access app resources.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005454 ApplicationInfo applicationInfo = n.extras.getParcelable(
5455 EXTRA_BUILDER_APPLICATION_INFO);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005456 Context builderContext;
Julia Reynoldsda303542015-11-23 14:00:20 -05005457 if (applicationInfo != null) {
5458 try {
5459 builderContext = context.createApplicationContext(applicationInfo,
5460 Context.CONTEXT_RESTRICTED);
5461 } catch (NameNotFoundException e) {
5462 Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found");
5463 builderContext = context; // try with our context
5464 }
5465 } else {
5466 builderContext = context; // try with given context
Christoph Studer4600f9b2014-07-22 22:44:43 +02005467 }
5468
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005469 return new Builder(builderContext, n);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005470 }
5471
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005472 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005473 * @deprecated Use {@link #build()} instead.
5474 */
5475 @Deprecated
5476 public Notification getNotification() {
5477 return build();
5478 }
5479
5480 /**
5481 * Combine all of the options that have been set and return a new {@link Notification}
5482 * object.
5483 */
5484 public Notification build() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005485 // first, add any extras from the calling code
5486 if (mUserExtras != null) {
5487 mN.extras = getAllExtras();
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07005488 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005489
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005490 mN.creationTime = System.currentTimeMillis();
5491
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005492 // lazy stuff from mContext; see comment in Builder(Context, Notification)
Julia Reynoldsda303542015-11-23 14:00:20 -05005493 Notification.addFieldsFromContext(mContext, mN);
Christoph Studer943aa672014-08-03 20:31:16 +02005494
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005495 buildUnstyled();
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005496
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005497 if (mStyle != null) {
Selim Cinekd0426622017-07-11 13:19:59 +02005498 mStyle.reduceImageSizes(mContext);
5499 mStyle.purgeResources();
Selim Cinek90343862018-02-01 11:07:11 -08005500 mStyle.validate(mContext);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005501 mStyle.buildStyled(mN);
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005502 }
Selim Cinekd0426622017-07-11 13:19:59 +02005503 mN.reduceImageSizes(mContext);
5504
Adrian Roos5081c0d2016-02-26 16:04:19 -08005505 if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
Selim Cineka7679b62017-05-10 16:33:25 -07005506 && (useExistingRemoteView())) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005507 if (mN.contentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005508 mN.contentView = createContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005509 mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT,
5510 mN.contentView.getSequenceNumber());
5511 }
5512 if (mN.bigContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005513 mN.bigContentView = createBigContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005514 if (mN.bigContentView != null) {
5515 mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT,
5516 mN.bigContentView.getSequenceNumber());
5517 }
5518 }
5519 if (mN.headsUpContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05005520 mN.headsUpContentView = createHeadsUpContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005521 if (mN.headsUpContentView != null) {
5522 mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT,
5523 mN.headsUpContentView.getSequenceNumber());
5524 }
5525 }
5526 }
5527
Julia Reynolds4c0c2022016-02-02 15:11:59 -05005528 if ((mN.defaults & DEFAULT_LIGHTS) != 0) {
5529 mN.flags |= FLAG_SHOW_LIGHTS;
5530 }
5531
Adrian Roosfb921842017-10-26 14:49:56 +02005532 mN.allPendingIntents = null;
5533
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005534 return mN;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005535 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005536
5537 /**
5538 * Apply this Builder to an existing {@link Notification} object.
5539 *
5540 * @hide
5541 */
5542 public Notification buildInto(Notification n) {
Daniel Sandler1a497d32013-04-18 14:52:45 -04005543 build().cloneInto(n, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05005544 return n;
5545 }
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005546
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005547 /**
Adrian Roos184bfe022016-03-03 13:41:44 -08005548 * Removes RemoteViews that were created for compatibility from {@param n}, if they did not
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005549 * change. Also removes extenders on low ram devices, as
5550 * {@link android.service.notification.NotificationListenerService} services are disabled.
Adrian Roos184bfe022016-03-03 13:41:44 -08005551 *
5552 * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}.
5553 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005554 * @hide
5555 */
Kristian Monsen30f59b22018-04-09 10:27:16 +02005556 public static Notification maybeCloneStrippedForDelivery(Notification n, boolean isLowRam,
5557 Context context) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005558 String templateClass = n.extras.getString(EXTRA_TEMPLATE);
Adrian Roos184bfe022016-03-03 13:41:44 -08005559
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005560 // Only strip views for known Styles because we won't know how to
5561 // re-create them otherwise.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005562 if (!isLowRam
5563 && !TextUtils.isEmpty(templateClass)
Adrian Roos184bfe022016-03-03 13:41:44 -08005564 && getNotificationStyleClass(templateClass) == null) {
5565 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005566 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005567
5568 // Only strip unmodified BuilderRemoteViews.
5569 boolean stripContentView = n.contentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005570 n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005571 n.contentView.getSequenceNumber();
5572 boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005573 n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005574 n.bigContentView.getSequenceNumber();
5575 boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005576 n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08005577 n.headsUpContentView.getSequenceNumber();
5578
5579 // Nothing to do here, no need to clone.
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005580 if (!isLowRam
5581 && !stripContentView && !stripBigContentView && !stripHeadsUpContentView) {
Adrian Roos184bfe022016-03-03 13:41:44 -08005582 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005583 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005584
5585 Notification clone = n.clone();
5586 if (stripContentView) {
5587 clone.contentView = null;
5588 clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT);
5589 }
5590 if (stripBigContentView) {
5591 clone.bigContentView = null;
5592 clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT);
5593 }
5594 if (stripHeadsUpContentView) {
5595 clone.headsUpContentView = null;
5596 clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT);
5597 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005598 if (isLowRam) {
Kristian Monsen30f59b22018-04-09 10:27:16 +02005599 String[] allowedServices = context.getResources().getStringArray(
5600 R.array.config_allowedManagedServicesOnLowRamDevices);
5601 if (allowedServices.length == 0) {
5602 clone.extras.remove(Notification.TvExtender.EXTRA_TV_EXTENDER);
5603 clone.extras.remove(WearableExtender.EXTRA_WEARABLE_EXTENSIONS);
5604 clone.extras.remove(CarExtender.EXTRA_CAR_EXTENDER);
5605 }
Julia Reynolds8a3b4592017-06-26 17:15:14 -04005606 }
Adrian Roos184bfe022016-03-03 13:41:44 -08005607 return clone;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05005608 }
5609
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005610 private int getBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005611 return R.layout.notification_template_material_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005612 }
5613
5614 private int getBigBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005615 return R.layout.notification_template_material_big_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005616 }
5617
5618 private int getBigPictureLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005619 return R.layout.notification_template_material_big_picture;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005620 }
5621
5622 private int getBigTextLayoutResource() {
Jorim Jaggi445d3c02014-08-19 22:33:42 +02005623 return R.layout.notification_template_material_big_text;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005624 }
5625
5626 private int getInboxLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005627 return R.layout.notification_template_material_inbox;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005628 }
5629
Adrian Roosc1a80b02016-04-05 14:54:55 -07005630 private int getMessagingLayoutResource() {
5631 return R.layout.notification_template_material_messaging;
5632 }
5633
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005634 private int getActionLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005635 return R.layout.notification_material_action;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005636 }
5637
Selim Cinek06e9e1f2016-07-08 17:14:16 -07005638 private int getEmphasizedActionLayoutResource() {
5639 return R.layout.notification_material_action_emphasized;
5640 }
5641
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005642 private int getActionTombstoneLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07005643 return R.layout.notification_material_action_tombstone;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005644 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005645
5646 private int getBackgroundColor() {
5647 if (isColorized()) {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005648 return mBackgroundColor != COLOR_INVALID ? mBackgroundColor : mN.color;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005649 } else {
Selim Cinekc7f5a822018-03-20 19:32:06 -07005650 return COLOR_DEFAULT;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005651 }
5652 }
5653
Selim Cinek396caca2018-04-10 17:46:46 -07005654 /**
Selim Cinek4717d862018-04-19 09:19:15 +08005655 * Gets a neutral color that can be used for icons or similar that should not stand out.
5656 */
5657 private int getNeutralColor() {
5658 if (isColorized()) {
5659 return getSecondaryTextColor();
5660 } else {
5661 return resolveNeutralColor();
5662 }
5663 }
5664
5665 /**
Selim Cinek396caca2018-04-10 17:46:46 -07005666 * Same as getBackgroundColor but also resolved the default color to the background.
5667 */
5668 private int resolveBackgroundColor() {
5669 int backgroundColor = getBackgroundColor();
5670 if (backgroundColor == COLOR_DEFAULT) {
5671 backgroundColor = mContext.getColor(
5672 com.android.internal.R.color.notification_material_background_color);
5673 }
5674 return backgroundColor;
5675 }
5676
Selim Cinek7b9605b2017-01-19 17:36:00 -08005677 private boolean isColorized() {
5678 return mN.isColorized();
5679 }
Selim Cinek99104832017-01-25 14:47:33 -08005680
Anthony Chenad4d1582017-04-10 16:07:58 -07005681 private boolean shouldTintActionButtons() {
5682 return mTintActionButtons;
5683 }
5684
Selim Cinek99104832017-01-25 14:47:33 -08005685 private boolean textColorsNeedInversion() {
5686 if (mStyle == null || !MediaStyle.class.equals(mStyle.getClass())) {
5687 return false;
5688 }
5689 int targetSdkVersion = mContext.getApplicationInfo().targetSdkVersion;
5690 return targetSdkVersion > Build.VERSION_CODES.M
5691 && targetSdkVersion < Build.VERSION_CODES.O;
5692 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005693
5694 /**
5695 * Set a color palette to be used as the background and textColors
5696 *
5697 * @param backgroundColor the color to be used as the background
5698 * @param foregroundColor the color to be used as the foreground
5699 *
5700 * @hide
5701 */
5702 public void setColorPalette(int backgroundColor, int foregroundColor) {
5703 mBackgroundColor = backgroundColor;
5704 mForegroundColor = foregroundColor;
5705 mTextColorsAreForBackground = COLOR_INVALID;
5706 ensureColors();
5707 }
Selim Cinekac5f0272017-05-02 16:05:41 -07005708
5709 /**
Selim Cineka7679b62017-05-10 16:33:25 -07005710 * Forces all styled remoteViews to be built from scratch and not use any cached
5711 * RemoteViews.
5712 * This is needed for legacy apps that are baking in their remoteviews into the
5713 * notification.
5714 *
5715 * @hide
5716 */
5717 public void setRebuildStyledRemoteViews(boolean rebuild) {
5718 mRebuildStyledRemoteViews = rebuild;
5719 }
Selim Cinekaa9db1f2018-02-27 17:35:47 -08005720
5721 /**
5722 * Get the text that should be displayed in the statusBar when heads upped. This is
5723 * usually just the app name, but may be different depending on the style.
5724 *
5725 * @param publicMode If true, return a text that is safe to display in public.
5726 *
5727 * @hide
5728 */
5729 public CharSequence getHeadsUpStatusBarText(boolean publicMode) {
5730 if (mStyle != null && !publicMode) {
5731 CharSequence text = mStyle.getHeadsUpStatusBarText();
5732 if (!TextUtils.isEmpty(text)) {
5733 return text;
5734 }
5735 }
5736 return loadHeaderAppName();
5737 }
Selim Cinek7b9605b2017-01-19 17:36:00 -08005738 }
5739
5740 /**
Selim Cinekd0426622017-07-11 13:19:59 +02005741 * Reduces the image sizes to conform to a maximum allowed size. This also processes all custom
5742 * remote views.
5743 *
5744 * @hide
5745 */
5746 void reduceImageSizes(Context context) {
5747 if (extras.getBoolean(EXTRA_REDUCED_IMAGES)) {
5748 return;
5749 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005750 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02005751 if (mLargeIcon != null || largeIcon != null) {
5752 Resources resources = context.getResources();
5753 Class<? extends Style> style = getNotificationStyle();
Selim Cineka8cb1262017-08-15 16:53:44 -07005754 int maxWidth = resources.getDimensionPixelSize(isLowRam
5755 ? R.dimen.notification_right_icon_size_low_ram
5756 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02005757 int maxHeight = maxWidth;
5758 if (MediaStyle.class.equals(style)
5759 || DecoratedMediaCustomViewStyle.class.equals(style)) {
Selim Cineka8cb1262017-08-15 16:53:44 -07005760 maxHeight = resources.getDimensionPixelSize(isLowRam
5761 ? R.dimen.notification_media_image_max_height_low_ram
5762 : R.dimen.notification_media_image_max_height);
5763 maxWidth = resources.getDimensionPixelSize(isLowRam
5764 ? R.dimen.notification_media_image_max_width_low_ram
5765 : R.dimen.notification_media_image_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02005766 }
5767 if (mLargeIcon != null) {
5768 mLargeIcon.scaleDownIfNecessary(maxWidth, maxHeight);
5769 }
5770 if (largeIcon != null) {
5771 largeIcon = Icon.scaleDownIfNecessary(largeIcon, maxWidth, maxHeight);
5772 }
5773 }
Selim Cineka8cb1262017-08-15 16:53:44 -07005774 reduceImageSizesForRemoteView(contentView, context, isLowRam);
5775 reduceImageSizesForRemoteView(headsUpContentView, context, isLowRam);
5776 reduceImageSizesForRemoteView(bigContentView, context, isLowRam);
Selim Cinekd0426622017-07-11 13:19:59 +02005777 extras.putBoolean(EXTRA_REDUCED_IMAGES, true);
5778 }
5779
Selim Cineka8cb1262017-08-15 16:53:44 -07005780 private void reduceImageSizesForRemoteView(RemoteViews remoteView, Context context,
5781 boolean isLowRam) {
Selim Cinekd0426622017-07-11 13:19:59 +02005782 if (remoteView != null) {
5783 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07005784 int maxWidth = resources.getDimensionPixelSize(isLowRam
5785 ? R.dimen.notification_custom_view_max_image_width_low_ram
5786 : R.dimen.notification_custom_view_max_image_width);
5787 int maxHeight = resources.getDimensionPixelSize(isLowRam
5788 ? R.dimen.notification_custom_view_max_image_height_low_ram
5789 : R.dimen.notification_custom_view_max_image_height);
Selim Cinekd0426622017-07-11 13:19:59 +02005790 remoteView.reduceImageSizes(maxWidth, maxHeight);
5791 }
5792 }
5793
5794 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005795 * @return whether this notification is a foreground service notification
Selim Cinek7b9605b2017-01-19 17:36:00 -08005796 */
Selim Cinek22714f12017-04-13 16:23:53 -07005797 private boolean isForegroundService() {
5798 return (flags & Notification.FLAG_FOREGROUND_SERVICE) != 0;
Selim Cinek7b9605b2017-01-19 17:36:00 -08005799 }
5800
5801 /**
Selim Cinek99104832017-01-25 14:47:33 -08005802 * @return whether this notification has a media session attached
5803 * @hide
5804 */
5805 public boolean hasMediaSession() {
5806 return extras.getParcelable(Notification.EXTRA_MEDIA_SESSION) != null;
5807 }
5808
5809 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08005810 * @return the style class of this notification
5811 * @hide
5812 */
5813 public Class<? extends Notification.Style> getNotificationStyle() {
5814 String templateClass = extras.getString(Notification.EXTRA_TEMPLATE);
5815
5816 if (!TextUtils.isEmpty(templateClass)) {
5817 return Notification.getNotificationStyleClass(templateClass);
5818 }
5819 return null;
5820 }
5821
5822 /**
Selim Cinek22714f12017-04-13 16:23:53 -07005823 * @return true if this notification is colorized.
Selim Cinek7b9605b2017-01-19 17:36:00 -08005824 *
5825 * @hide
5826 */
5827 public boolean isColorized() {
Selim Cinek5fb73f82017-04-20 16:55:38 -07005828 if (isColorizedMedia()) {
5829 return true;
5830 }
Julia Reynolds4db59552017-06-30 13:34:01 -04005831 return extras.getBoolean(EXTRA_COLORIZED)
5832 && (hasColorizedPermission() || isForegroundService());
5833 }
5834
5835 /**
5836 * Returns whether an app can colorize due to the android.permission.USE_COLORIZED_NOTIFICATIONS
5837 * permission. The permission is checked when a notification is enqueued.
5838 */
5839 private boolean hasColorizedPermission() {
5840 return (flags & Notification.FLAG_CAN_COLORIZE) != 0;
Selim Cinek5fb73f82017-04-20 16:55:38 -07005841 }
5842
5843 /**
5844 * @return true if this notification is colorized and it is a media notification
5845 *
5846 * @hide
5847 */
5848 public boolean isColorizedMedia() {
Selim Cinek99104832017-01-25 14:47:33 -08005849 Class<? extends Style> style = getNotificationStyle();
5850 if (MediaStyle.class.equals(style)) {
5851 Boolean colorized = (Boolean) extras.get(EXTRA_COLORIZED);
5852 if ((colorized == null || colorized) && hasMediaSession()) {
5853 return true;
5854 }
5855 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5856 if (extras.getBoolean(EXTRA_COLORIZED) && hasMediaSession()) {
5857 return true;
5858 }
5859 }
Selim Cinek5fb73f82017-04-20 16:55:38 -07005860 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005861 }
5862
Selim Cinek0847acd2017-04-24 19:48:29 -07005863
5864 /**
5865 * @return true if this is a media notification
5866 *
5867 * @hide
5868 */
5869 public boolean isMediaNotification() {
5870 Class<? extends Style> style = getNotificationStyle();
5871 if (MediaStyle.class.equals(style)) {
5872 return true;
5873 } else if (DecoratedMediaCustomViewStyle.class.equals(style)) {
5874 return true;
5875 }
5876 return false;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005877 }
5878
Selim Cinek279fa862016-06-14 10:57:25 -07005879 private boolean hasLargeIcon() {
5880 return mLargeIcon != null || largeIcon != null;
5881 }
5882
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005883 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005884 * @return true if the notification will show the time; false otherwise
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005885 * @hide
5886 */
Selim Cinekc2c0b042016-05-18 17:13:46 -07005887 public boolean showsTime() {
Selim Cinekb85f36fd2016-04-20 18:46:36 -07005888 return when != 0 && extras.getBoolean(EXTRA_SHOW_WHEN);
5889 }
5890
5891 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07005892 * @return true if the notification will show a chronometer; false otherwise
5893 * @hide
5894 */
5895 public boolean showsChronometer() {
5896 return when != 0 && extras.getBoolean(EXTRA_SHOW_CHRONOMETER);
5897 }
5898
5899 /**
Julia Reynolds7ca33072017-06-29 13:58:24 -04005900 * @removed
Julia Reynolds4a02afb2016-12-13 13:39:52 -05005901 */
5902 @SystemApi
5903 public static Class<? extends Style> getNotificationStyleClass(String templateClass) {
5904 Class<? extends Style>[] classes = new Class[] {
5905 BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class,
5906 DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class,
5907 MessagingStyle.class };
5908 for (Class<? extends Style> innerClass : classes) {
5909 if (templateClass.equals(innerClass.getName())) {
5910 return innerClass;
5911 }
5912 }
5913 return null;
5914 }
5915
5916 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005917 * An object that can apply a rich notification style to a {@link Notification.Builder}
5918 * object.
5919 */
Griff Hazendfcb0802014-02-11 12:00:00 -08005920 public static abstract class Style {
Chris Wrend6297db2012-05-03 16:20:13 -04005921 private CharSequence mBigContentTitle;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02005922
5923 /**
5924 * @hide
5925 */
5926 protected CharSequence mSummaryText = null;
5927
5928 /**
5929 * @hide
5930 */
5931 protected boolean mSummaryTextSet = false;
Chris Wrend6297db2012-05-03 16:20:13 -04005932
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005933 protected Builder mBuilder;
5934
Chris Wrend6297db2012-05-03 16:20:13 -04005935 /**
5936 * Overrides ContentTitle in the big form of the template.
5937 * This defaults to the value passed to setContentTitle().
5938 */
5939 protected void internalSetBigContentTitle(CharSequence title) {
5940 mBigContentTitle = title;
5941 }
5942
5943 /**
5944 * Set the first line of text after the detail section in the big form of the template.
5945 */
5946 protected void internalSetSummaryText(CharSequence cs) {
5947 mSummaryText = cs;
Daniel Sandler619738c2012-06-07 16:33:08 -04005948 mSummaryTextSet = true;
Chris Wrend6297db2012-05-03 16:20:13 -04005949 }
5950
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005951 public void setBuilder(Builder builder) {
5952 if (mBuilder != builder) {
5953 mBuilder = builder;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07005954 if (mBuilder != null) {
5955 mBuilder.setStyle(this);
5956 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005957 }
5958 }
5959
Chris Wrend6297db2012-05-03 16:20:13 -04005960 protected void checkBuilder() {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005961 if (mBuilder == null) {
5962 throw new IllegalArgumentException("Style requires a valid Builder object");
5963 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005964 }
Chris Wrend6297db2012-05-03 16:20:13 -04005965
5966 protected RemoteViews getStandardView(int layoutId) {
Selim Cinek384804b2018-04-18 14:31:07 +08005967 return getStandardView(layoutId, null);
5968 }
5969
5970 /**
5971 * Get the standard view for this style.
5972 *
5973 * @param layoutId The layout id to use
5974 * @param result The result where template bind information is saved.
5975 * @return A remoteView for this style.
5976 * @hide
5977 */
5978 protected RemoteViews getStandardView(int layoutId, TemplateBindResult result) {
Chris Wrend6297db2012-05-03 16:20:13 -04005979 checkBuilder();
5980
Christoph Studer4600f9b2014-07-22 22:44:43 +02005981 // Nasty.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005982 CharSequence oldBuilderContentTitle =
5983 mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE);
Chris Wrend6297db2012-05-03 16:20:13 -04005984 if (mBigContentTitle != null) {
5985 mBuilder.setContentTitle(mBigContentTitle);
5986 }
5987
Selim Cinek384804b2018-04-18 14:31:07 +08005988 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId, result);
Chris Wrend6297db2012-05-03 16:20:13 -04005989
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005990 mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005991
Chris Wrend6297db2012-05-03 16:20:13 -04005992 if (mBigContentTitle != null && mBigContentTitle.equals("")) {
5993 contentView.setViewVisibility(R.id.line1, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04005994 } else {
5995 contentView.setViewVisibility(R.id.line1, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04005996 }
5997
Chris Wrend6297db2012-05-03 16:20:13 -04005998 return contentView;
5999 }
6000
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006001 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08006002 * Construct a Style-specific RemoteViews for the collapsed notification layout.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006003 * The default implementation has nothing additional to add.
Selim Cinek7d1009b2017-01-25 15:28:28 -08006004 *
6005 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006006 * @hide
6007 */
Selim Cinek7d1009b2017-01-25 15:28:28 -08006008 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006009 return null;
6010 }
6011
6012 /**
6013 * Construct a Style-specific RemoteViews for the final big notification layout.
6014 * @hide
6015 */
6016 public RemoteViews makeBigContentView() {
6017 return null;
6018 }
6019
6020 /**
6021 * Construct a Style-specific RemoteViews for the final HUN layout.
Selim Cinek87ed69b2017-02-09 15:59:43 -08006022 *
6023 * @param increasedHeight true if this layout be created with an increased height.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006024 * @hide
6025 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08006026 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006027 return null;
6028 }
6029
6030 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006031 * Apply any style-specific extras to this notification before shipping it out.
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006032 * @hide
6033 */
6034 public void addExtras(Bundle extras) {
6035 if (mSummaryTextSet) {
6036 extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
6037 }
6038 if (mBigContentTitle != null) {
6039 extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
6040 }
Chris Wren91ad5632013-06-05 15:05:57 -04006041 extras.putString(EXTRA_TEMPLATE, this.getClass().getName());
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006042 }
6043
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006044 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006045 * Reconstruct the internal state of this Style object from extras.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006046 * @hide
6047 */
Christoph Studer4600f9b2014-07-22 22:44:43 +02006048 protected void restoreFromExtras(Bundle extras) {
6049 if (extras.containsKey(EXTRA_SUMMARY_TEXT)) {
6050 mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT);
6051 mSummaryTextSet = true;
6052 }
6053 if (extras.containsKey(EXTRA_TITLE_BIG)) {
6054 mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG);
6055 }
6056 }
6057
6058
6059 /**
6060 * @hide
6061 */
6062 public Notification buildStyled(Notification wip) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006063 addExtras(wip.extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006064 return wip;
6065 }
6066
Daniel Sandler0ec46202015-06-24 01:27:05 -04006067 /**
6068 * @hide
6069 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006070 public void purgeResources() {}
6071
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006072 /**
6073 * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is
6074 * attached to.
6075 *
6076 * @return the fully constructed Notification.
6077 */
6078 public Notification build() {
6079 checkBuilder();
6080 return mBuilder.build();
6081 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02006082
6083 /**
6084 * @hide
6085 * @return true if the style positions the progress bar on the second line; false if the
6086 * style hides the progress bar
6087 */
6088 protected boolean hasProgress() {
6089 return true;
6090 }
Selim Cinek03d0d652015-11-13 13:18:09 -05006091
6092 /**
6093 * @hide
6094 * @return Whether we should put the summary be put into the notification header
6095 */
6096 public boolean hasSummaryInHeader() {
6097 return true;
6098 }
Selim Cinek593610c2016-02-16 18:42:57 -08006099
6100 /**
6101 * @hide
6102 * @return Whether custom content views are displayed inline in the style
6103 */
6104 public boolean displayCustomViewInline() {
6105 return false;
6106 }
Selim Cinekd0426622017-07-11 13:19:59 +02006107
6108 /**
6109 * Reduces the image sizes contained in this style.
6110 *
6111 * @hide
6112 */
6113 public void reduceImageSizes(Context context) {
6114 }
Selim Cinek90343862018-02-01 11:07:11 -08006115
6116 /**
6117 * Validate that this style was properly composed. This is called at build time.
6118 * @hide
6119 */
6120 public void validate(Context context) {
6121 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05006122
6123 /**
6124 * @hide
6125 */
6126 public abstract boolean areNotificationsVisiblyDifferent(Style other);
Selim Cinekc7f5a822018-03-20 19:32:06 -07006127
Selim Cinekaa9db1f2018-02-27 17:35:47 -08006128 /**
6129 * @return the the text that should be displayed in the statusBar when heads-upped.
6130 * If {@code null} is returned, the default implementation will be used.
6131 *
6132 * @hide
6133 */
6134 public CharSequence getHeadsUpStatusBarText() {
6135 return null;
6136 }
Joe Onorato46439ce2010-11-19 13:56:21 -08006137 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006138
6139 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006140 * Helper class for generating large-format notifications that include a large image attachment.
Joe Malin8d40d042012-11-05 11:36:40 -08006141 *
Robert Ly91c5ce32014-06-08 15:37:00 -07006142 * Here's how you'd set the <code>BigPictureStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006143 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07006144 * Notification notif = new Notification.Builder(mContext)
6145 * .setContentTitle(&quot;New photo from &quot; + sender.toString())
6146 * .setContentText(subject)
6147 * .setSmallIcon(R.drawable.new_post)
6148 * .setLargeIcon(aBitmap)
6149 * .setStyle(new Notification.BigPictureStyle()
6150 * .bigPicture(aBigBitmap))
6151 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006152 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006153 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006154 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006155 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006156 public static class BigPictureStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006157 private Bitmap mPicture;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006158 private Icon mBigLargeIcon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006159 private boolean mBigLargeIconSet = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006160
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006161 public BigPictureStyle() {
6162 }
6163
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006164 /**
6165 * @deprecated use {@code BigPictureStyle()}.
6166 */
6167 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006168 public BigPictureStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006169 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006170 }
6171
Chris Wrend6297db2012-05-03 16:20:13 -04006172 /**
6173 * Overrides ContentTitle in the big form of the template.
6174 * This defaults to the value passed to setContentTitle().
6175 */
6176 public BigPictureStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006177 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006178 return this;
6179 }
6180
6181 /**
6182 * Set the first line of text after the detail section in the big form of the template.
6183 */
6184 public BigPictureStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006185 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006186 return this;
6187 }
6188
Chris Wren0bd664d2012-08-01 13:56:56 -04006189 /**
Julia Reynolds7217dc92018-03-07 12:12:09 -05006190 * @hide
6191 */
6192 public Bitmap getBigPicture() {
6193 return mPicture;
6194 }
6195
6196 /**
Chris Wren0bd664d2012-08-01 13:56:56 -04006197 * Provide the bitmap to be used as the payload for the BigPicture notification.
6198 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006199 public BigPictureStyle bigPicture(Bitmap b) {
6200 mPicture = b;
6201 return this;
6202 }
6203
Chris Wren3745a3d2012-05-22 15:11:52 -04006204 /**
Chris Wren3745a3d2012-05-22 15:11:52 -04006205 * Override the large icon when the big notification is shown.
6206 */
6207 public BigPictureStyle bigLargeIcon(Bitmap b) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04006208 return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
6209 }
6210
6211 /**
6212 * Override the large icon when the big notification is shown.
6213 */
6214 public BigPictureStyle bigLargeIcon(Icon icon) {
Chris Wren3745a3d2012-05-22 15:11:52 -04006215 mBigLargeIconSet = true;
Dan Sandlerd63f9322015-05-06 15:18:49 -04006216 mBigLargeIcon = icon;
Chris Wren3745a3d2012-05-22 15:11:52 -04006217 return this;
6218 }
6219
Riley Andrews0394a0c2015-11-03 23:36:52 -08006220 /** @hide */
6221 public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10);
6222
Daniel Sandler0ec46202015-06-24 01:27:05 -04006223 /**
6224 * @hide
6225 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006226 @Override
6227 public void purgeResources() {
6228 super.purgeResources();
Riley Andrews8cee7c12015-11-01 23:36:04 -08006229 if (mPicture != null &&
6230 mPicture.isMutable() &&
Riley Andrews0394a0c2015-11-03 23:36:52 -08006231 mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) {
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07006232 mPicture = mPicture.createAshmemBitmap();
6233 }
6234 if (mBigLargeIcon != null) {
6235 mBigLargeIcon.convertToAshmem();
6236 }
6237 }
Christoph Studer5c510ee2014-12-15 16:32:27 +01006238
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006239 /**
6240 * @hide
6241 */
Selim Cinekd0426622017-07-11 13:19:59 +02006242 @Override
6243 public void reduceImageSizes(Context context) {
6244 super.reduceImageSizes(context);
6245 Resources resources = context.getResources();
Selim Cineka8cb1262017-08-15 16:53:44 -07006246 boolean isLowRam = ActivityManager.isLowRamDeviceStatic();
Selim Cinekd0426622017-07-11 13:19:59 +02006247 if (mPicture != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006248 int maxPictureWidth = resources.getDimensionPixelSize(isLowRam
6249 ? R.dimen.notification_big_picture_max_height_low_ram
6250 : R.dimen.notification_big_picture_max_height);
6251 int maxPictureHeight = resources.getDimensionPixelSize(isLowRam
6252 ? R.dimen.notification_big_picture_max_width_low_ram
6253 : R.dimen.notification_big_picture_max_width);
Selim Cinekd0426622017-07-11 13:19:59 +02006254 mPicture = Icon.scaleDownIfNecessary(mPicture, maxPictureWidth, maxPictureHeight);
6255 }
6256 if (mBigLargeIcon != null) {
Selim Cineka8cb1262017-08-15 16:53:44 -07006257 int rightIconSize = resources.getDimensionPixelSize(isLowRam
6258 ? R.dimen.notification_right_icon_size_low_ram
6259 : R.dimen.notification_right_icon_size);
Selim Cinekd0426622017-07-11 13:19:59 +02006260 mBigLargeIcon.scaleDownIfNecessary(rightIconSize, rightIconSize);
6261 }
6262 }
6263
6264 /**
6265 * @hide
6266 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006267 public RemoteViews makeBigContentView() {
6268 // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet
Christoph Studer5c510ee2014-12-15 16:32:27 +01006269 // This covers the following cases:
6270 // 1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006271 // mN.mLargeIcon
6272 // 2. !mBigLargeIconSet -> mN.mLargeIcon applies
Dan Sandlerd63f9322015-05-06 15:18:49 -04006273 Icon oldLargeIcon = null;
Selim Cineke99acb22016-08-04 12:55:48 -07006274 Bitmap largeIconLegacy = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006275 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006276 oldLargeIcon = mBuilder.mN.mLargeIcon;
6277 mBuilder.mN.mLargeIcon = mBigLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006278 // The legacy largeIcon might not allow us to clear the image, as it's taken in
6279 // replacement if the other one is null. Because we're restoring these legacy icons
6280 // for old listeners, this is in general non-null.
6281 largeIconLegacy = mBuilder.mN.largeIcon;
6282 mBuilder.mN.largeIcon = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006283 }
6284
Selim Cinek384804b2018-04-18 14:31:07 +08006285 RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource(),
6286 null /* result */);
Selim Cinek03d0d652015-11-13 13:18:09 -05006287 if (mSummaryTextSet) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006288 contentView.setTextViewText(R.id.text, mBuilder.processTextSpans(
6289 mBuilder.processLegacyText(mSummaryText)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006290 mBuilder.setTextViewColorSecondary(contentView, R.id.text);
Selim Cinekc848c3a2016-01-13 15:27:30 -08006291 contentView.setViewVisibility(R.id.text, View.VISIBLE);
Selim Cinek03d0d652015-11-13 13:18:09 -05006292 }
Selim Cinek279fa862016-06-14 10:57:25 -07006293 mBuilder.setContentMinHeight(contentView, mBuilder.mN.hasLargeIcon());
Selim Cinek53e64a42015-11-16 10:40:56 -08006294
Christoph Studer5c510ee2014-12-15 16:32:27 +01006295 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006296 mBuilder.mN.mLargeIcon = oldLargeIcon;
Selim Cineke99acb22016-08-04 12:55:48 -07006297 mBuilder.mN.largeIcon = largeIconLegacy;
Christoph Studer5c510ee2014-12-15 16:32:27 +01006298 }
6299
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006300 contentView.setImageViewBitmap(R.id.big_picture, mPicture);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006301 return contentView;
6302 }
6303
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006304 /**
6305 * @hide
6306 */
6307 public void addExtras(Bundle extras) {
6308 super.addExtras(extras);
6309
6310 if (mBigLargeIconSet) {
6311 extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
6312 }
6313 extras.putParcelable(EXTRA_PICTURE, mPicture);
6314 }
6315
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04006316 /**
6317 * @hide
6318 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006319 @Override
Christoph Studer4600f9b2014-07-22 22:44:43 +02006320 protected void restoreFromExtras(Bundle extras) {
6321 super.restoreFromExtras(extras);
6322
6323 if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) {
Christoph Studer5c510ee2014-12-15 16:32:27 +01006324 mBigLargeIconSet = true;
Christoph Studer4600f9b2014-07-22 22:44:43 +02006325 mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG);
Chris Wren3745a3d2012-05-22 15:11:52 -04006326 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02006327 mPicture = extras.getParcelable(EXTRA_PICTURE);
6328 }
Selim Cinek03d0d652015-11-13 13:18:09 -05006329
6330 /**
6331 * @hide
6332 */
6333 @Override
6334 public boolean hasSummaryInHeader() {
6335 return false;
6336 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05006337
6338 /**
6339 * @hide
6340 */
6341 @Override
6342 public boolean areNotificationsVisiblyDifferent(Style other) {
6343 if (other == null || getClass() != other.getClass()) {
6344 return true;
6345 }
6346 BigPictureStyle otherS = (BigPictureStyle) other;
6347 return !Objects.equals(getBigPicture(), otherS.getBigPicture());
6348 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006349 }
6350
6351 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006352 * Helper class for generating large-format notifications that include a lot of text.
Joe Malin8d40d042012-11-05 11:36:40 -08006353 *
Robert Ly91c5ce32014-06-08 15:37:00 -07006354 * Here's how you'd set the <code>BigTextStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006355 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07006356 * Notification notif = new Notification.Builder(mContext)
6357 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
6358 * .setContentText(subject)
6359 * .setSmallIcon(R.drawable.new_mail)
6360 * .setLargeIcon(aBitmap)
6361 * .setStyle(new Notification.BigTextStyle()
6362 * .bigText(aVeryLongString))
6363 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006364 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08006365 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04006366 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006367 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006368 public static class BigTextStyle extends Style {
Jorim Jaggi457a10d2014-09-08 16:18:23 +02006369
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006370 private CharSequence mBigText;
6371
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006372 public BigTextStyle() {
6373 }
6374
Adrian Roosf5faf9d2016-05-23 13:56:15 -07006375 /**
6376 * @deprecated use {@code BigTextStyle()}.
6377 */
6378 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006379 public BigTextStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04006380 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006381 }
6382
Chris Wrend6297db2012-05-03 16:20:13 -04006383 /**
6384 * Overrides ContentTitle in the big form of the template.
6385 * This defaults to the value passed to setContentTitle().
6386 */
6387 public BigTextStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006388 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04006389 return this;
6390 }
6391
6392 /**
6393 * Set the first line of text after the detail section in the big form of the template.
6394 */
6395 public BigTextStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006396 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04006397 return this;
6398 }
6399
Chris Wren0bd664d2012-08-01 13:56:56 -04006400 /**
6401 * Provide the longer text to be displayed in the big form of the
6402 * template in place of the content text.
6403 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006404 public BigTextStyle bigText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04006405 mBigText = safeCharSequence(cs);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006406 return this;
6407 }
6408
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006409 /**
6410 * @hide
6411 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05006412 public CharSequence getBigText() {
6413 return mBigText;
6414 }
6415
6416 /**
6417 * @hide
6418 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006419 public void addExtras(Bundle extras) {
6420 super.addExtras(extras);
6421
Christoph Studer4600f9b2014-07-22 22:44:43 +02006422 extras.putCharSequence(EXTRA_BIG_TEXT, mBigText);
6423 }
6424
6425 /**
6426 * @hide
6427 */
6428 @Override
6429 protected void restoreFromExtras(Bundle extras) {
6430 super.restoreFromExtras(extras);
6431
6432 mBigText = extras.getCharSequence(EXTRA_BIG_TEXT);
Daniel Sandlerf45564e2013-04-15 15:05:08 -04006433 }
6434
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006435 /**
Selim Cinek7d1009b2017-01-25 15:28:28 -08006436 * @param increasedHeight true if this layout be created with an increased height.
6437 *
6438 * @hide
6439 */
6440 @Override
6441 public RemoteViews makeContentView(boolean increasedHeight) {
6442 if (increasedHeight) {
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006443 mBuilder.mOriginalActions = mBuilder.mActions;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006444 mBuilder.mActions = new ArrayList<>();
6445 RemoteViews remoteViews = makeBigContentView();
Selim Cinek5d6ef8d2017-05-18 22:16:00 -07006446 mBuilder.mActions = mBuilder.mOriginalActions;
6447 mBuilder.mOriginalActions = null;
Selim Cinek7d1009b2017-01-25 15:28:28 -08006448 return remoteViews;
6449 }
6450 return super.makeContentView(increasedHeight);
6451 }
6452
6453 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006454 * @hide
6455 */
Selim Cinek87ed69b2017-02-09 15:59:43 -08006456 @Override
6457 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
6458 if (increasedHeight && mBuilder.mActions.size() > 0) {
6459 return makeBigContentView();
6460 }
6461 return super.makeHeadsUpContentView(increasedHeight);
6462 }
6463
6464 /**
6465 * @hide
6466 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006467 public RemoteViews makeBigContentView() {
Christoph Studer4600f9b2014-07-22 22:44:43 +02006468
6469 // Nasty
Selim Cinek75998782016-04-26 10:39:17 -07006470 CharSequence text = mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006471 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Daniel Sandler916ad912012-06-13 12:17:07 -04006472
Selim Cinek384804b2018-04-18 14:31:07 +08006473 TemplateBindResult result = new TemplateBindResult();
6474 RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource(), result);
Selim Cinek1c72fa02018-04-23 18:00:54 +08006475 contentView.setInt(R.id.big_text, "setImageEndMargin", result.getIconMarginEnd());
Joe Malin8d40d042012-11-05 11:36:40 -08006476
Selim Cinek75998782016-04-26 10:39:17 -07006477 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, text);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006478
Selim Cinek3a2c4b92015-12-17 17:01:17 -08006479 CharSequence bigTextText = mBuilder.processLegacyText(mBigText);
Selim Cinek75998782016-04-26 10:39:17 -07006480 if (TextUtils.isEmpty(bigTextText)) {
6481 // In case the bigtext is null / empty fall back to the normal text to avoid a weird
6482 // experience
6483 bigTextText = mBuilder.processLegacyText(text);
6484 }
Adrian Roosb1f427c2016-05-26 12:27:15 -07006485 applyBigTextContentView(mBuilder, contentView, bigTextText);
Selim Cinek4fb12d32015-11-19 18:10:48 -08006486
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006487 return contentView;
6488 }
6489
Julia Reynolds7217dc92018-03-07 12:12:09 -05006490 /**
6491 * @hide
6492 */
6493 @Override
6494 public boolean areNotificationsVisiblyDifferent(Style other) {
6495 if (other == null || getClass() != other.getClass()) {
6496 return true;
6497 }
6498 BigTextStyle newS = (BigTextStyle) other;
6499 return !Objects.equals(getBigText(), newS.getBigText());
6500 }
6501
Adrian Roosb1f427c2016-05-26 12:27:15 -07006502 static void applyBigTextContentView(Builder builder,
6503 RemoteViews contentView, CharSequence bigTextText) {
Selim Cinek48f66b72017-08-18 16:17:51 -07006504 contentView.setTextViewText(R.id.big_text, builder.processTextSpans(bigTextText));
Selim Cinek7b9605b2017-01-19 17:36:00 -08006505 builder.setTextViewColorSecondary(contentView, R.id.big_text);
Adrian Roosb1f427c2016-05-26 12:27:15 -07006506 contentView.setViewVisibility(R.id.big_text,
6507 TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE);
Selim Cinek279fa862016-06-14 10:57:25 -07006508 contentView.setBoolean(R.id.big_text, "setHasImage", builder.mN.hasLargeIcon());
Adrian Roosb1f427c2016-05-26 12:27:15 -07006509 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04006510 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04006511
6512 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006513 * Helper class for generating large-format notifications that include multiple back-and-forth
6514 * messages of varying types between any number of people.
6515 *
6516 * <br>
6517 * If the platform does not provide large-format notifications, this method has no effect. The
6518 * user will always see the normal notification view.
6519 * <br>
6520 * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like
6521 * so:
6522 * <pre class="prettyprint">
6523 *
6524 * Notification noti = new Notification.Builder()
6525 * .setContentTitle(&quot;2 new messages wtih &quot; + sender.toString())
6526 * .setContentText(subject)
6527 * .setSmallIcon(R.drawable.new_message)
6528 * .setLargeIcon(aBitmap)
6529 * .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name))
6530 * .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender())
6531 * .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender()))
6532 * .build();
6533 * </pre>
6534 */
6535 public static class MessagingStyle extends Style {
6536
6537 /**
6538 * The maximum number of messages that will be retained in the Notification itself (the
6539 * number displayed is up to the platform).
6540 */
6541 public static final int MAXIMUM_RETAINED_MESSAGES = 25;
6542
Selim Cinekcb8b9852017-12-15 18:01:52 -08006543 @NonNull Person mUser;
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006544 @Nullable CharSequence mConversationTitle;
Alex Hillsd9b04d92016-04-11 16:38:16 -04006545 List<Message> mMessages = new ArrayList<>();
Adrian Roos437cd562017-01-18 15:47:03 -08006546 List<Message> mHistoricMessages = new ArrayList<>();
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006547 boolean mIsGroupConversation;
Alex Hillsfc737de2016-03-23 17:33:02 -04006548
6549 MessagingStyle() {
6550 }
6551
6552 /**
Alex Hillsfd590442016-10-07 09:52:44 -04006553 * @param userDisplayName Required - the name to be displayed for any replies sent by the
6554 * user before the posting app reposts the notification with those messages after they've
6555 * been actually sent and in previous messages sent by the user added in
Alex Hillsfc737de2016-03-23 17:33:02 -04006556 * {@link #addMessage(Notification.MessagingStyle.Message)}
Selim Cinekcb8b9852017-12-15 18:01:52 -08006557 *
6558 * @deprecated use {@code MessagingStyle(Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006559 */
Alex Hillsfd590442016-10-07 09:52:44 -04006560 public MessagingStyle(@NonNull CharSequence userDisplayName) {
Selim Cinek9acd6732018-03-23 16:39:02 -07006561 this(new Person.Builder().setName(userDisplayName).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006562 }
6563
6564 /**
6565 * @param user Required - The person displayed for any messages that are sent by the
6566 * user. Any messages added with {@link #addMessage(Notification.MessagingStyle.Message)}
6567 * who don't have a Person associated with it will be displayed as if they were sent
Selim Cinek90343862018-02-01 11:07:11 -08006568 * by this user. The user also needs to have a valid name associated with it, which will
6569 * be enforced starting in Android P.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006570 */
6571 public MessagingStyle(@NonNull Person user) {
6572 mUser = user;
Selim Cinek90343862018-02-01 11:07:11 -08006573 }
6574
6575 /**
6576 * Validate that this style was properly composed. This is called at build time.
6577 * @hide
6578 */
6579 @Override
6580 public void validate(Context context) {
6581 super.validate(context);
6582 if (context.getApplicationInfo().targetSdkVersion
6583 >= Build.VERSION_CODES.P && (mUser == null || mUser.getName() == null)) {
6584 throw new RuntimeException("User must be valid and have a name.");
Selim Cinekcb8b9852017-12-15 18:01:52 -08006585 }
6586 }
6587
6588 /**
Selim Cinekaa9db1f2018-02-27 17:35:47 -08006589 * @return the the text that should be displayed in the statusBar when heads upped.
6590 * If {@code null} is returned, the default implementation will be used.
6591 *
6592 * @hide
6593 */
6594 @Override
6595 public CharSequence getHeadsUpStatusBarText() {
6596 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
6597 ? super.mBigContentTitle
6598 : mConversationTitle;
6599 if (!TextUtils.isEmpty(conversationTitle) && !hasOnlyWhiteSpaceSenders()) {
6600 return conversationTitle;
6601 }
6602 return null;
6603 }
6604
6605 /**
Selim Cinekcb8b9852017-12-15 18:01:52 -08006606 * @return the user to be displayed for any replies sent by the user
6607 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006608 @NonNull
Selim Cinekcb8b9852017-12-15 18:01:52 -08006609 public Person getUser() {
6610 return mUser;
Alex Hillsfc737de2016-03-23 17:33:02 -04006611 }
6612
6613 /**
6614 * Returns the name to be displayed for any replies sent by the user
Selim Cinekcb8b9852017-12-15 18:01:52 -08006615 *
6616 * @deprecated use {@link #getUser()} instead
Alex Hillsfc737de2016-03-23 17:33:02 -04006617 */
6618 public CharSequence getUserDisplayName() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006619 return mUser.getName();
Alex Hillsfc737de2016-03-23 17:33:02 -04006620 }
6621
6622 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006623 * Sets the title to be displayed on this conversation. May be set to {@code null}.
6624 *
Kodlee Yin14656422017-12-22 17:00:46 -08006625 * <p>This API's behavior was changed in SDK version {@link Build.VERSION_CODES#P}. If your
6626 * application's target version is less than {@link Build.VERSION_CODES#P}, setting a
6627 * conversation title to a non-null value will make {@link #isGroupConversation()} return
6628 * {@code true} and passing {@code null} will make it return {@code false}. In
6629 * {@link Build.VERSION_CODES#P} and beyond, use {@link #setGroupConversation(boolean)}
6630 * to set group conversation status.
6631 *
6632 * @param conversationTitle Title displayed for this conversation
6633 * @return this object for method chaining
Alex Hillsfc737de2016-03-23 17:33:02 -04006634 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006635 public MessagingStyle setConversationTitle(@Nullable CharSequence conversationTitle) {
Alex Hillsfc737de2016-03-23 17:33:02 -04006636 mConversationTitle = conversationTitle;
6637 return this;
6638 }
6639
6640 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006641 * Return the title to be displayed on this conversation. May return {@code null}.
Alex Hillsfc737de2016-03-23 17:33:02 -04006642 */
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006643 @Nullable
Alex Hillsfc737de2016-03-23 17:33:02 -04006644 public CharSequence getConversationTitle() {
6645 return mConversationTitle;
6646 }
6647
6648 /**
6649 * Adds a message for display by this notification. Convenience call for a simple
6650 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6651 * @param text A {@link CharSequence} to be displayed as the message content
6652 * @param timestamp Time at which the message arrived
6653 * @param sender A {@link CharSequence} to be used for displaying the name of the
6654 * sender. Should be <code>null</code> for messages by the current user, in which case
6655 * the platform will insert {@link #getUserDisplayName()}.
6656 * Should be unique amongst all individuals in the conversation, and should be
6657 * consistent during re-posts of the notification.
6658 *
6659 * @see Message#Message(CharSequence, long, CharSequence)
6660 *
6661 * @return this object for method chaining
Selim Cinekcb8b9852017-12-15 18:01:52 -08006662 *
6663 * @deprecated use {@link #addMessage(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04006664 */
6665 public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08006666 return addMessage(text, timestamp,
Selim Cinek9acd6732018-03-23 16:39:02 -07006667 sender == null ? null : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08006668 }
6669
6670 /**
6671 * Adds a message for display by this notification. Convenience call for a simple
6672 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
6673 * @param text A {@link CharSequence} to be displayed as the message content
6674 * @param timestamp Time at which the message arrived
6675 * @param sender The {@link Person} who sent the message.
6676 * Should be <code>null</code> for messages by the current user, in which case
6677 * the platform will insert the user set in {@code MessagingStyle(Person)}.
6678 *
6679 * @see Message#Message(CharSequence, long, CharSequence)
6680 *
6681 * @return this object for method chaining
6682 */
Selim Cinekeb53c222018-04-06 12:56:09 -07006683 public MessagingStyle addMessage(@NonNull CharSequence text, long timestamp,
6684 @Nullable Person sender) {
Adrian Roos437cd562017-01-18 15:47:03 -08006685 return addMessage(new Message(text, timestamp, sender));
Alex Hillsfc737de2016-03-23 17:33:02 -04006686 }
6687
6688 /**
6689 * Adds a {@link Message} for display in this notification.
Adrian Roos437cd562017-01-18 15:47:03 -08006690 *
6691 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6692 * the newest last.
6693 *
Alex Hillsfc737de2016-03-23 17:33:02 -04006694 * @param message The {@link Message} to be displayed
6695 * @return this object for method chaining
6696 */
6697 public MessagingStyle addMessage(Message message) {
6698 mMessages.add(message);
6699 if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6700 mMessages.remove(0);
6701 }
6702 return this;
6703 }
6704
6705 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006706 * Adds a {@link Message} for historic context in this notification.
6707 *
6708 * <p>Messages should be added as historic if they are not the main subject of the
6709 * notification but may give context to a conversation. The system may choose to present
6710 * them only when relevant, e.g. when replying to a message through a {@link RemoteInput}.
6711 *
6712 * <p>The messages should be added in chronologic order, i.e. the oldest first,
6713 * the newest last.
6714 *
6715 * @param message The historic {@link Message} to be added
6716 * @return this object for method chaining
6717 */
6718 public MessagingStyle addHistoricMessage(Message message) {
6719 mHistoricMessages.add(message);
6720 if (mHistoricMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
6721 mHistoricMessages.remove(0);
6722 }
6723 return this;
6724 }
6725
6726 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006727 * Gets the list of {@code Message} objects that represent the notification
6728 */
6729 public List<Message> getMessages() {
6730 return mMessages;
6731 }
6732
6733 /**
Adrian Roos437cd562017-01-18 15:47:03 -08006734 * Gets the list of historic {@code Message}s in the notification.
6735 */
6736 public List<Message> getHistoricMessages() {
6737 return mHistoricMessages;
6738 }
6739
6740 /**
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006741 * Sets whether this conversation notification represents a group.
Kodlee Yin14656422017-12-22 17:00:46 -08006742 *
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006743 * @param isGroupConversation {@code true} if the conversation represents a group,
6744 * {@code false} otherwise.
6745 * @return this object for method chaining
6746 */
6747 public MessagingStyle setGroupConversation(boolean isGroupConversation) {
6748 mIsGroupConversation = isGroupConversation;
6749 return this;
6750 }
6751
6752 /**
Kodlee Yin14656422017-12-22 17:00:46 -08006753 * Returns {@code true} if this notification represents a group conversation, otherwise
6754 * {@code false}.
6755 *
6756 * <p> If the application that generated this {@link MessagingStyle} targets an SDK version
6757 * less than {@link Build.VERSION_CODES#P}, this method becomes dependent on whether or
6758 * not the conversation title is set; returning {@code true} if the conversation title is
6759 * a non-null value, or {@code false} otherwise. From {@link Build.VERSION_CODES#P} forward,
6760 * this method returns what's set by {@link #setGroupConversation(boolean)} allowing for
6761 * named, non-group conversations.
6762 *
6763 * @see #setConversationTitle(CharSequence)
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006764 */
6765 public boolean isGroupConversation() {
Kodlee Yin14656422017-12-22 17:00:46 -08006766 // When target SDK version is < P, a non-null conversation title dictates if this is
6767 // as group conversation.
6768 if (mBuilder != null
6769 && mBuilder.mContext.getApplicationInfo().targetSdkVersion
6770 < Build.VERSION_CODES.P) {
6771 return mConversationTitle != null;
6772 }
6773
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006774 return mIsGroupConversation;
6775 }
6776
6777 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04006778 * @hide
6779 */
6780 @Override
6781 public void addExtras(Bundle extras) {
6782 super.addExtras(extras);
Selim Cinekcb8b9852017-12-15 18:01:52 -08006783 if (mUser != null) {
6784 // For legacy usages
6785 extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUser.getName());
6786 extras.putParcelable(EXTRA_MESSAGING_PERSON, mUser);
Alex Hillsfc737de2016-03-23 17:33:02 -04006787 }
6788 if (mConversationTitle != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04006789 extras.putCharSequence(EXTRA_CONVERSATION_TITLE, mConversationTitle);
Alex Hillsfc737de2016-03-23 17:33:02 -04006790 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04006791 if (!mMessages.isEmpty()) { extras.putParcelableArray(EXTRA_MESSAGES,
6792 Message.getBundleArrayForMessages(mMessages));
Alex Hillsfc737de2016-03-23 17:33:02 -04006793 }
Adrian Roos437cd562017-01-18 15:47:03 -08006794 if (!mHistoricMessages.isEmpty()) { extras.putParcelableArray(EXTRA_HISTORIC_MESSAGES,
6795 Message.getBundleArrayForMessages(mHistoricMessages));
6796 }
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006797
6798 fixTitleAndTextExtras(extras);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006799 extras.putBoolean(EXTRA_IS_GROUP_CONVERSATION, mIsGroupConversation);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006800 }
6801
6802 private void fixTitleAndTextExtras(Bundle extras) {
6803 Message m = findLatestIncomingMessage();
6804 CharSequence text = (m == null) ? null : m.mText;
6805 CharSequence sender = m == null ? null
Selim Cinekcb8b9852017-12-15 18:01:52 -08006806 : m.mSender == null || TextUtils.isEmpty(m.mSender.getName())
6807 ? mUser.getName() : m.mSender.getName();
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006808 CharSequence title;
6809 if (!TextUtils.isEmpty(mConversationTitle)) {
6810 if (!TextUtils.isEmpty(sender)) {
6811 BidiFormatter bidi = BidiFormatter.getInstance();
6812 title = mBuilder.mContext.getString(
6813 com.android.internal.R.string.notification_messaging_title_template,
Selim Cinekcb8b9852017-12-15 18:01:52 -08006814 bidi.unicodeWrap(mConversationTitle), bidi.unicodeWrap(sender));
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006815 } else {
6816 title = mConversationTitle;
6817 }
6818 } else {
6819 title = sender;
6820 }
6821
6822 if (title != null) {
6823 extras.putCharSequence(EXTRA_TITLE, title);
6824 }
6825 if (text != null) {
6826 extras.putCharSequence(EXTRA_TEXT, text);
6827 }
Alex Hillsfc737de2016-03-23 17:33:02 -04006828 }
6829
6830 /**
6831 * @hide
6832 */
6833 @Override
6834 protected void restoreFromExtras(Bundle extras) {
6835 super.restoreFromExtras(extras);
6836
Selim Cinekcb8b9852017-12-15 18:01:52 -08006837 mUser = extras.getParcelable(EXTRA_MESSAGING_PERSON);
6838 if (mUser == null) {
6839 CharSequence displayName = extras.getCharSequence(EXTRA_SELF_DISPLAY_NAME);
Selim Cinek9acd6732018-03-23 16:39:02 -07006840 mUser = new Person.Builder().setName(displayName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08006841 }
Adrian Roos96b7e202016-05-17 13:50:38 -07006842 mConversationTitle = extras.getCharSequence(EXTRA_CONVERSATION_TITLE);
Adrian Roos437cd562017-01-18 15:47:03 -08006843 Parcelable[] messages = extras.getParcelableArray(EXTRA_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006844 mMessages = Message.getMessagesFromBundleArray(messages);
Adrian Roos437cd562017-01-18 15:47:03 -08006845 Parcelable[] histMessages = extras.getParcelableArray(EXTRA_HISTORIC_MESSAGES);
Selim Cinek88188f22017-09-19 16:46:56 -07006846 mHistoricMessages = Message.getMessagesFromBundleArray(histMessages);
Kodlee Yin9ac617c2017-12-19 11:20:50 -08006847 mIsGroupConversation = extras.getBoolean(EXTRA_IS_GROUP_CONVERSATION);
Alex Hillsfc737de2016-03-23 17:33:02 -04006848 }
6849
6850 /**
6851 * @hide
6852 */
Adrian Roosc1a80b02016-04-05 14:54:55 -07006853 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08006854 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cineke62255c2017-09-28 18:23:23 -07006855 mBuilder.mOriginalActions = mBuilder.mActions;
6856 mBuilder.mActions = new ArrayList<>();
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006857 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
Selim Cinek384804b2018-04-18 14:31:07 +08006858 false /* hideLargeIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07006859 mBuilder.mActions = mBuilder.mOriginalActions;
6860 mBuilder.mOriginalActions = null;
6861 return remoteViews;
Adrian Roosc1a80b02016-04-05 14:54:55 -07006862 }
6863
Julia Reynolds7217dc92018-03-07 12:12:09 -05006864 /**
6865 * @hide
6866 */
6867 @Override
6868 public boolean areNotificationsVisiblyDifferent(Style other) {
6869 if (other == null || getClass() != other.getClass()) {
6870 return true;
6871 }
6872 MessagingStyle newS = (MessagingStyle) other;
6873 List<MessagingStyle.Message> oldMs = getMessages();
6874 List<MessagingStyle.Message> newMs = newS.getMessages();
6875
6876 if (oldMs == null) {
6877 oldMs = new ArrayList<>();
6878 }
6879 if (newMs == null) {
6880 newMs = new ArrayList<>();
6881 }
6882
6883 int n = oldMs.size();
6884 if (n != newMs.size()) {
6885 return true;
6886 }
6887 for (int i = 0; i < n; i++) {
6888 MessagingStyle.Message oldM = oldMs.get(i);
6889 MessagingStyle.Message newM = newMs.get(i);
6890 if (!Objects.equals(oldM.getText(), newM.getText())) {
6891 return true;
6892 }
6893 if (!Objects.equals(oldM.getDataUri(), newM.getDataUri())) {
6894 return true;
6895 }
6896 CharSequence oldSender = oldM.getSenderPerson() == null ? oldM.getSender()
6897 : oldM.getSenderPerson().getName();
6898 CharSequence newSender = newM.getSenderPerson() == null ? newM.getSender()
6899 : newM.getSenderPerson().getName();
6900 if (!Objects.equals(oldSender, newSender)) {
6901 return true;
6902 }
6903
6904 String oldKey = oldM.getSenderPerson() == null
6905 ? null : oldM.getSenderPerson().getKey();
6906 String newKey = newM.getSenderPerson() == null
6907 ? null : newM.getSenderPerson().getKey();
6908 if (!Objects.equals(oldKey, newKey)) {
6909 return true;
6910 }
6911 // Other fields (like timestamp) intentionally excluded
6912 }
6913 return false;
6914 }
6915
Adrian Roosc1a80b02016-04-05 14:54:55 -07006916 private Message findLatestIncomingMessage() {
Selim Cinek88188f22017-09-19 16:46:56 -07006917 return findLatestIncomingMessage(mMessages);
6918 }
6919
6920 /**
6921 * @hide
6922 */
6923 @Nullable
6924 public static Message findLatestIncomingMessage(
6925 List<Message> messages) {
6926 for (int i = messages.size() - 1; i >= 0; i--) {
6927 Message m = messages.get(i);
Adrian Roosc1a80b02016-04-05 14:54:55 -07006928 // Incoming messages have a non-empty sender.
Selim Cinekcb8b9852017-12-15 18:01:52 -08006929 if (m.mSender != null && !TextUtils.isEmpty(m.mSender.getName())) {
Adrian Roosc1a80b02016-04-05 14:54:55 -07006930 return m;
6931 }
6932 }
Selim Cinek88188f22017-09-19 16:46:56 -07006933 if (!messages.isEmpty()) {
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006934 // No incoming messages, fall back to outgoing message
Selim Cinek88188f22017-09-19 16:46:56 -07006935 return messages.get(messages.size() - 1);
Adrian Roos33fbd2c2016-05-27 15:35:28 -07006936 }
Adrian Roosc1a80b02016-04-05 14:54:55 -07006937 return null;
6938 }
6939
6940 /**
6941 * @hide
6942 */
6943 @Override
6944 public RemoteViews makeBigContentView() {
Selim Cinek384804b2018-04-18 14:31:07 +08006945 return makeMessagingView(false /* displayImagesAtEnd */, true /* hideLargeIcon */);
Selim Cinekafeed292017-12-12 17:32:44 -08006946 }
6947
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006948 /**
6949 * Create a messaging layout.
6950 *
6951 * @param displayImagesAtEnd should images be displayed at the end of the content instead
6952 * of inline.
Selim Cinek384804b2018-04-18 14:31:07 +08006953 * @param hideRightIcons Should the reply affordance be shown at the end of the notification
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006954 * @return the created remoteView.
6955 */
Selim Cinekafeed292017-12-12 17:32:44 -08006956 @NonNull
Selim Cinek384804b2018-04-18 14:31:07 +08006957 private RemoteViews makeMessagingView(boolean displayImagesAtEnd, boolean hideRightIcons) {
Selim Cinek88188f22017-09-19 16:46:56 -07006958 CharSequence conversationTitle = !TextUtils.isEmpty(super.mBigContentTitle)
Adrian Roosc1a80b02016-04-05 14:54:55 -07006959 ? super.mBigContentTitle
6960 : mConversationTitle;
Selim Cinek88188f22017-09-19 16:46:56 -07006961 boolean isOneToOne = TextUtils.isEmpty(conversationTitle);
Selim Cinek2dd3e722018-01-19 11:06:06 -08006962 CharSequence nameReplacement = null;
Selim Cinekafeed292017-12-12 17:32:44 -08006963 if (hasOnlyWhiteSpaceSenders()) {
Selim Cinekf7409db2017-10-24 16:17:14 -07006964 isOneToOne = true;
Selim Cinek2dd3e722018-01-19 11:06:06 -08006965 nameReplacement = conversationTitle;
6966 conversationTitle = null;
Adrian Roosb1f427c2016-05-26 12:27:15 -07006967 }
Selim Cinek384804b2018-04-18 14:31:07 +08006968 TemplateBindResult bindResult = new TemplateBindResult();
Adrian Roos48d746a2016-04-12 14:57:28 -07006969 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
Adrian Roosc1a80b02016-04-05 14:54:55 -07006970 mBuilder.getMessagingLayoutResource(),
Selim Cinek88188f22017-09-19 16:46:56 -07006971 mBuilder.mParams.reset().hasProgress(false).title(conversationTitle).text(null)
Selim Cinek384804b2018-04-18 14:31:07 +08006972 .hideLargeIcon(hideRightIcons || isOneToOne)
6973 .hideReplyIcon(hideRightIcons)
6974 .headerTextSecondary(conversationTitle),
6975 bindResult);
Selim Cinek88188f22017-09-19 16:46:56 -07006976 addExtras(mBuilder.mN.extras);
Selim Cinekafeed292017-12-12 17:32:44 -08006977 // also update the end margin if there is an image
Selim Cinek1c72fa02018-04-23 18:00:54 +08006978 contentView.setViewLayoutMarginEnd(R.id.notification_messaging,
6979 bindResult.getIconMarginEnd());
Selim Cinek88188f22017-09-19 16:46:56 -07006980 contentView.setInt(R.id.status_bar_latest_event_content, "setLayoutColor",
6981 mBuilder.resolveContrastColor());
Selim Cinek85d0e6e2018-03-23 18:08:32 -07006982 contentView.setBoolean(R.id.status_bar_latest_event_content, "setDisplayImagesAtEnd",
6983 displayImagesAtEnd);
Selim Cinek88188f22017-09-19 16:46:56 -07006984 contentView.setIcon(R.id.status_bar_latest_event_content, "setLargeIcon",
6985 mBuilder.mN.mLargeIcon);
Selim Cinek2dd3e722018-01-19 11:06:06 -08006986 contentView.setCharSequence(R.id.status_bar_latest_event_content, "setNameReplacement",
6987 nameReplacement);
Selim Cinek88188f22017-09-19 16:46:56 -07006988 contentView.setBoolean(R.id.status_bar_latest_event_content, "setIsOneToOne",
6989 isOneToOne);
6990 contentView.setBundle(R.id.status_bar_latest_event_content, "setData",
6991 mBuilder.mN.extras);
Alex Hillsfc737de2016-03-23 17:33:02 -04006992 return contentView;
6993 }
6994
Selim Cinekf7409db2017-10-24 16:17:14 -07006995 private boolean hasOnlyWhiteSpaceSenders() {
6996 for (int i = 0; i < mMessages.size(); i++) {
6997 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08006998 Person sender = m.getSenderPerson();
6999 if (sender != null && !isWhiteSpace(sender.getName())) {
Selim Cinekf7409db2017-10-24 16:17:14 -07007000 return false;
7001 }
7002 }
7003 return true;
7004 }
7005
7006 private boolean isWhiteSpace(CharSequence sender) {
7007 if (TextUtils.isEmpty(sender)) {
7008 return true;
7009 }
7010 if (sender.toString().matches("^\\s*$")) {
7011 return true;
7012 }
7013 // Let's check if we only have 0 whitespace chars. Some apps did this as a workaround
7014 // For the presentation that we had.
7015 for (int i = 0; i < sender.length(); i++) {
7016 char c = sender.charAt(i);
7017 if (c != '\u200B') {
7018 return false;
7019 }
7020 }
7021 return true;
7022 }
7023
Selim Cinek88188f22017-09-19 16:46:56 -07007024 private CharSequence createConversationTitleFromMessages() {
7025 ArraySet<CharSequence> names = new ArraySet<>();
7026 for (int i = 0; i < mMessages.size(); i++) {
7027 Message m = mMessages.get(i);
Selim Cinekcb8b9852017-12-15 18:01:52 -08007028 Person sender = m.getSenderPerson();
Selim Cinek88188f22017-09-19 16:46:56 -07007029 if (sender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007030 names.add(sender.getName());
Selim Cinek88188f22017-09-19 16:46:56 -07007031 }
7032 }
7033 SpannableStringBuilder title = new SpannableStringBuilder();
7034 int size = names.size();
7035 for (int i = 0; i < size; i++) {
7036 CharSequence name = names.valueAt(i);
7037 if (!TextUtils.isEmpty(title)) {
7038 title.append(", ");
7039 }
7040 title.append(BidiFormatter.getInstance().unicodeWrap(name));
7041 }
7042 return title;
7043 }
7044
Adrian Roosdedd1df2016-04-26 16:38:47 -07007045 /**
7046 * @hide
7047 */
7048 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007049 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek85d0e6e2018-03-23 18:08:32 -07007050 RemoteViews remoteViews = makeMessagingView(true /* displayImagesAtEnd */,
Selim Cinek384804b2018-04-18 14:31:07 +08007051 true /* hideLargeIcon */);
Selim Cineke62255c2017-09-28 18:23:23 -07007052 remoteViews.setInt(R.id.notification_messaging, "setMaxDisplayedLines", 1);
7053 return remoteViews;
Adrian Roosdedd1df2016-04-26 16:38:47 -07007054 }
7055
Adrian Roosc1a80b02016-04-05 14:54:55 -07007056 private static TextAppearanceSpan makeFontColorSpan(int color) {
7057 return new TextAppearanceSpan(null, 0, 0,
7058 ColorStateList.valueOf(color), null);
7059 }
7060
Alex Hillsd9b04d92016-04-11 16:38:16 -04007061 public static final class Message {
7062
7063 static final String KEY_TEXT = "text";
7064 static final String KEY_TIMESTAMP = "time";
7065 static final String KEY_SENDER = "sender";
Selim Cinekcb8b9852017-12-15 18:01:52 -08007066 static final String KEY_SENDER_PERSON = "sender_person";
Alex Hillsd9b04d92016-04-11 16:38:16 -04007067 static final String KEY_DATA_MIME_TYPE = "type";
7068 static final String KEY_DATA_URI= "uri";
Shane Brennan5a871862017-03-11 13:14:17 -08007069 static final String KEY_EXTRAS_BUNDLE = "extras";
Kenny Guya0f6de82018-04-06 16:20:16 +01007070 static final String KEY_REMOTE_INPUT_HISTORY = "remote_input_history";
Alex Hillsfc737de2016-03-23 17:33:02 -04007071
7072 private final CharSequence mText;
7073 private final long mTimestamp;
Selim Cinekcb8b9852017-12-15 18:01:52 -08007074 @Nullable
7075 private final Person mSender;
Kenny Guya0f6de82018-04-06 16:20:16 +01007076 /** True if this message was generated from the extra
7077 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}
7078 */
7079 private final boolean mRemoteInputHistory;
Alex Hillsfc737de2016-03-23 17:33:02 -04007080
Shane Brennan5a871862017-03-11 13:14:17 -08007081 private Bundle mExtras = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04007082 private String mDataMimeType;
7083 private Uri mDataUri;
7084
7085 /**
7086 * Constructor
7087 * @param text A {@link CharSequence} to be displayed as the message content
7088 * @param timestamp Time at which the message arrived
7089 * @param sender A {@link CharSequence} to be used for displaying the name of the
7090 * sender. Should be <code>null</code> for messages by the current user, in which case
7091 * the platform will insert {@link MessagingStyle#getUserDisplayName()}.
7092 * Should be unique amongst all individuals in the conversation, and should be
7093 * consistent during re-posts of the notification.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007094 *
7095 * @deprecated use {@code Message(CharSequence, long, Person)}
Alex Hillsfc737de2016-03-23 17:33:02 -04007096 */
7097 public Message(CharSequence text, long timestamp, CharSequence sender){
Selim Cinek9acd6732018-03-23 16:39:02 -07007098 this(text, timestamp, sender == null ? null
7099 : new Person.Builder().setName(sender).build());
Selim Cinekcb8b9852017-12-15 18:01:52 -08007100 }
7101
7102 /**
7103 * Constructor
7104 * @param text A {@link CharSequence} to be displayed as the message content
7105 * @param timestamp Time at which the message arrived
7106 * @param sender The {@link Person} who sent the message.
7107 * Should be <code>null</code> for messages by the current user, in which case
7108 * the platform will insert the user set in {@code MessagingStyle(Person)}.
7109 * <p>
Selim Cinek9acd6732018-03-23 16:39:02 -07007110 * The person provided should contain an Icon, set with
7111 * {@link Person.Builder#setIcon(Icon)} and also have a name provided
7112 * with {@link Person.Builder#setName(CharSequence)}. If multiple users have the same
7113 * name, consider providing a key with {@link Person.Builder#setKey(String)} in order
7114 * to differentiate between the different users.
Selim Cinekcb8b9852017-12-15 18:01:52 -08007115 * </p>
7116 */
Selim Cinekeb53c222018-04-06 12:56:09 -07007117 public Message(@NonNull CharSequence text, long timestamp, @Nullable Person sender) {
Kenny Guya0f6de82018-04-06 16:20:16 +01007118 this(text, timestamp, sender, false /* remoteHistory */);
7119 }
7120
7121 /**
7122 * Constructor
7123 * @param text A {@link CharSequence} to be displayed as the message content
7124 * @param timestamp Time at which the message arrived
7125 * @param sender The {@link Person} who sent the message.
7126 * Should be <code>null</code> for messages by the current user, in which case
7127 * the platform will insert the user set in {@code MessagingStyle(Person)}.
7128 * @param remoteInputHistory True if the messages was generated from the extra
7129 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}.
7130 * <p>
7131 * The person provided should contain an Icon, set with
7132 * {@link Person.Builder#setIcon(Icon)} and also have a name provided
7133 * with {@link Person.Builder#setName(CharSequence)}. If multiple users have the same
7134 * name, consider providing a key with {@link Person.Builder#setKey(String)} in order
7135 * to differentiate between the different users.
7136 * </p>
7137 * @hide
7138 */
7139 public Message(@NonNull CharSequence text, long timestamp, @Nullable Person sender,
7140 boolean remoteInputHistory) {
Alex Hillsfc737de2016-03-23 17:33:02 -04007141 mText = text;
7142 mTimestamp = timestamp;
7143 mSender = sender;
Kenny Guya0f6de82018-04-06 16:20:16 +01007144 mRemoteInputHistory = remoteInputHistory;
Alex Hillsfc737de2016-03-23 17:33:02 -04007145 }
7146
7147 /**
7148 * Sets a binary blob of data and an associated MIME type for a message. In the case
7149 * where the platform doesn't support the MIME type, the original text provided in the
7150 * constructor will be used.
7151 * @param dataMimeType The MIME type of the content. See
7152 * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME
7153 * types on Android and Android Wear.
7154 * @param dataUri The uri containing the content whose type is given by the MIME type.
7155 * <p class="note">
7156 * <ol>
7157 * <li>Notification Listeners including the System UI need permission to access the
7158 * data the Uri points to. The recommended ways to do this are:</li>
7159 * <li>Store the data in your own ContentProvider, making sure that other apps have
7160 * the correct permission to access your provider. The preferred mechanism for
7161 * providing access is to use per-URI permissions which are temporary and only
7162 * grant access to the receiving application. An easy way to create a
7163 * ContentProvider like this is to use the FileProvider helper class.</li>
7164 * <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio
7165 * and image MIME types, however beginning with Android 3.0 (API level 11) it can
7166 * also store non-media types (see MediaStore.Files for more info). Files can be
7167 * inserted into the MediaStore using scanFile() after which a content:// style
7168 * Uri suitable for sharing is passed to the provided onScanCompleted() callback.
7169 * Note that once added to the system MediaStore the content is accessible to any
7170 * app on the device.</li>
7171 * </ol>
7172 * @return this object for method chaining
7173 */
7174 public Message setData(String dataMimeType, Uri dataUri) {
7175 mDataMimeType = dataMimeType;
7176 mDataUri = dataUri;
7177 return this;
7178 }
7179
Alex Hillsfc737de2016-03-23 17:33:02 -04007180 /**
7181 * Get the text to be used for this message, or the fallback text if a type and content
7182 * Uri have been set
7183 */
7184 public CharSequence getText() {
7185 return mText;
7186 }
7187
7188 /**
7189 * Get the time at which this message arrived
7190 */
7191 public long getTimestamp() {
7192 return mTimestamp;
7193 }
7194
7195 /**
Shane Brennan5a871862017-03-11 13:14:17 -08007196 * Get the extras Bundle for this message.
7197 */
7198 public Bundle getExtras() {
7199 return mExtras;
7200 }
7201
7202 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04007203 * Get the text used to display the contact's name in the messaging experience
Selim Cinekcb8b9852017-12-15 18:01:52 -08007204 *
7205 * @deprecated use {@link #getSenderPerson()}
Alex Hillsfc737de2016-03-23 17:33:02 -04007206 */
7207 public CharSequence getSender() {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007208 return mSender == null ? null : mSender.getName();
7209 }
7210
7211 /**
7212 * Get the sender associated with this message.
7213 */
7214 @Nullable
7215 public Person getSenderPerson() {
Alex Hillsfc737de2016-03-23 17:33:02 -04007216 return mSender;
7217 }
7218
7219 /**
7220 * Get the MIME type of the data pointed to by the Uri
7221 */
7222 public String getDataMimeType() {
7223 return mDataMimeType;
7224 }
7225
7226 /**
7227 * Get the the Uri pointing to the content of the message. Can be null, in which case
7228 * {@see #getText()} is used.
7229 */
7230 public Uri getDataUri() {
7231 return mDataUri;
7232 }
7233
Kenny Guya0f6de82018-04-06 16:20:16 +01007234 /**
7235 * @return True if the message was generated from
7236 * {@link Notification#EXTRA_REMOTE_INPUT_HISTORY}.
7237 * @hide
7238 */
7239 public boolean isRemoteInputHistory() {
7240 return mRemoteInputHistory;
7241 }
7242
Alex Hillsd9b04d92016-04-11 16:38:16 -04007243 private Bundle toBundle() {
7244 Bundle bundle = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04007245 if (mText != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007246 bundle.putCharSequence(KEY_TEXT, mText);
Alex Hillsfc737de2016-03-23 17:33:02 -04007247 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007248 bundle.putLong(KEY_TIMESTAMP, mTimestamp);
Alex Hillsfc737de2016-03-23 17:33:02 -04007249 if (mSender != null) {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007250 // Legacy listeners need this
7251 bundle.putCharSequence(KEY_SENDER, mSender.getName());
7252 bundle.putParcelable(KEY_SENDER_PERSON, mSender);
Alex Hillsfc737de2016-03-23 17:33:02 -04007253 }
7254 if (mDataMimeType != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007255 bundle.putString(KEY_DATA_MIME_TYPE, mDataMimeType);
Alex Hillsfc737de2016-03-23 17:33:02 -04007256 }
7257 if (mDataUri != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007258 bundle.putParcelable(KEY_DATA_URI, mDataUri);
Alex Hillsfc737de2016-03-23 17:33:02 -04007259 }
Shane Brennan5a871862017-03-11 13:14:17 -08007260 if (mExtras != null) {
7261 bundle.putBundle(KEY_EXTRAS_BUNDLE, mExtras);
7262 }
Kenny Guya0f6de82018-04-06 16:20:16 +01007263 if (mRemoteInputHistory) {
7264 bundle.putBoolean(KEY_REMOTE_INPUT_HISTORY, mRemoteInputHistory);
7265 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007266 return bundle;
Alex Hillsfc737de2016-03-23 17:33:02 -04007267 }
7268
Alex Hillsd9b04d92016-04-11 16:38:16 -04007269 static Bundle[] getBundleArrayForMessages(List<Message> messages) {
7270 Bundle[] bundles = new Bundle[messages.size()];
7271 final int N = messages.size();
7272 for (int i = 0; i < N; i++) {
7273 bundles[i] = messages.get(i).toBundle();
7274 }
7275 return bundles;
7276 }
7277
Selim Cinek88188f22017-09-19 16:46:56 -07007278 /**
7279 * @return A list of messages read from the bundles.
7280 *
7281 * @hide
7282 */
7283 public static List<Message> getMessagesFromBundleArray(Parcelable[] bundles) {
7284 if (bundles == null) {
7285 return new ArrayList<>();
7286 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007287 List<Message> messages = new ArrayList<>(bundles.length);
7288 for (int i = 0; i < bundles.length; i++) {
Adrian Roosdedd1df2016-04-26 16:38:47 -07007289 if (bundles[i] instanceof Bundle) {
7290 Message message = getMessageFromBundle((Bundle)bundles[i]);
7291 if (message != null) {
7292 messages.add(message);
7293 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007294 }
7295 }
7296 return messages;
7297 }
7298
7299 static Message getMessageFromBundle(Bundle bundle) {
7300 try {
Adrian Roosfbddd2c2016-05-13 12:57:20 -07007301 if (!bundle.containsKey(KEY_TEXT) || !bundle.containsKey(KEY_TIMESTAMP)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007302 return null;
7303 } else {
Selim Cinekcb8b9852017-12-15 18:01:52 -08007304
7305 Person senderPerson = bundle.getParcelable(KEY_SENDER_PERSON);
7306 if (senderPerson == null) {
7307 // Legacy apps that use compat don't actually provide the sender objects
7308 // We need to fix the compat version to provide people / use
7309 // the native api instead
7310 CharSequence senderName = bundle.getCharSequence(KEY_SENDER);
7311 if (senderName != null) {
Selim Cinek9acd6732018-03-23 16:39:02 -07007312 senderPerson = new Person.Builder().setName(senderName).build();
Selim Cinekcb8b9852017-12-15 18:01:52 -08007313 }
7314 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007315 Message message = new Message(bundle.getCharSequence(KEY_TEXT),
Selim Cinekcb8b9852017-12-15 18:01:52 -08007316 bundle.getLong(KEY_TIMESTAMP),
Kenny Guya0f6de82018-04-06 16:20:16 +01007317 senderPerson,
7318 bundle.getBoolean(KEY_REMOTE_INPUT_HISTORY, false));
Alex Hillsd9b04d92016-04-11 16:38:16 -04007319 if (bundle.containsKey(KEY_DATA_MIME_TYPE) &&
7320 bundle.containsKey(KEY_DATA_URI)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04007321 message.setData(bundle.getString(KEY_DATA_MIME_TYPE),
7322 (Uri) bundle.getParcelable(KEY_DATA_URI));
Alex Hillsfc737de2016-03-23 17:33:02 -04007323 }
Shane Brennan5a871862017-03-11 13:14:17 -08007324 if (bundle.containsKey(KEY_EXTRAS_BUNDLE)) {
7325 message.getExtras().putAll(bundle.getBundle(KEY_EXTRAS_BUNDLE));
7326 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04007327 return message;
7328 }
7329 } catch (ClassCastException e) {
7330 return null;
7331 }
7332 }
Alex Hillsfc737de2016-03-23 17:33:02 -04007333 }
7334 }
7335
7336 /**
Daniel Sandler879c5e02012-04-17 16:46:51 -04007337 * Helper class for generating large-format notifications that include a list of (up to 5) strings.
Joe Malin8d40d042012-11-05 11:36:40 -08007338 *
Robert Ly91c5ce32014-06-08 15:37:00 -07007339 * Here's how you'd set the <code>InboxStyle</code> on a notification:
Daniel Sandler879c5e02012-04-17 16:46:51 -04007340 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07007341 * Notification notif = new Notification.Builder(mContext)
7342 * .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
7343 * .setContentText(subject)
7344 * .setSmallIcon(R.drawable.new_mail)
7345 * .setLargeIcon(aBitmap)
7346 * .setStyle(new Notification.InboxStyle()
7347 * .addLine(str1)
7348 * .addLine(str2)
7349 * .setContentTitle(&quot;&quot;)
7350 * .setSummaryText(&quot;+3 more&quot;))
7351 * .build();
Daniel Sandler879c5e02012-04-17 16:46:51 -04007352 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08007353 *
Daniel Sandler879c5e02012-04-17 16:46:51 -04007354 * @see Notification#bigContentView
7355 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007356 public static class InboxStyle extends Style {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007357 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
7358
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007359 public InboxStyle() {
7360 }
7361
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007362 /**
7363 * @deprecated use {@code InboxStyle()}.
7364 */
7365 @Deprecated
Daniel Sandler879c5e02012-04-17 16:46:51 -04007366 public InboxStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04007367 setBuilder(builder);
Daniel Sandler879c5e02012-04-17 16:46:51 -04007368 }
7369
Chris Wrend6297db2012-05-03 16:20:13 -04007370 /**
7371 * Overrides ContentTitle in the big form of the template.
7372 * This defaults to the value passed to setContentTitle().
7373 */
7374 public InboxStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007375 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04007376 return this;
7377 }
7378
7379 /**
7380 * Set the first line of text after the detail section in the big form of the template.
7381 */
7382 public InboxStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007383 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04007384 return this;
7385 }
7386
Chris Wren0bd664d2012-08-01 13:56:56 -04007387 /**
7388 * Append a line to the digest section of the Inbox notification.
7389 */
Daniel Sandler879c5e02012-04-17 16:46:51 -04007390 public InboxStyle addLine(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04007391 mTexts.add(safeCharSequence(cs));
Daniel Sandler879c5e02012-04-17 16:46:51 -04007392 return this;
7393 }
7394
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007395 /**
7396 * @hide
7397 */
Julia Reynolds7217dc92018-03-07 12:12:09 -05007398 public ArrayList<CharSequence> getLines() {
7399 return mTexts;
7400 }
7401
7402 /**
7403 * @hide
7404 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007405 public void addExtras(Bundle extras) {
7406 super.addExtras(extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007407
Daniel Sandlerf45564e2013-04-15 15:05:08 -04007408 CharSequence[] a = new CharSequence[mTexts.size()];
7409 extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
7410 }
7411
Christoph Studer4600f9b2014-07-22 22:44:43 +02007412 /**
7413 * @hide
7414 */
7415 @Override
7416 protected void restoreFromExtras(Bundle extras) {
7417 super.restoreFromExtras(extras);
7418
7419 mTexts.clear();
7420 if (extras.containsKey(EXTRA_TEXT_LINES)) {
7421 Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES));
7422 }
7423 }
7424
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007425 /**
7426 * @hide
7427 */
7428 public RemoteViews makeBigContentView() {
Selim Cinekc848c3a2016-01-13 15:27:30 -08007429 // Remove the content text so it disappears unless you have a summary
Christoph Studer4600f9b2014-07-22 22:44:43 +02007430 // Nasty
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007431 CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT);
7432 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007433
Selim Cinek384804b2018-04-18 14:31:07 +08007434 TemplateBindResult result = new TemplateBindResult();
7435 RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource(), result);
Daniel Sandler619738c2012-06-07 16:33:08 -04007436
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007437 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
Christoph Studer4600f9b2014-07-22 22:44:43 +02007438
Chris Wrend6297db2012-05-03 16:20:13 -04007439 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 -04007440 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
Chris Wrend6297db2012-05-03 16:20:13 -04007441
Chris Wren4ed80d52012-05-17 09:30:03 -04007442 // Make sure all rows are gone in case we reuse a view.
7443 for (int rowId : rowIds) {
7444 contentView.setViewVisibility(rowId, View.GONE);
7445 }
7446
Daniel Sandler879c5e02012-04-17 16:46:51 -04007447 int i=0;
Selim Cinek07c80172016-04-21 16:40:47 -07007448 int topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7449 R.dimen.notification_inbox_item_top_padding);
Selim Cinek247fa012016-02-18 09:50:48 -08007450 boolean first = true;
Selim Cinek07c80172016-04-21 16:40:47 -07007451 int onlyViewId = 0;
7452 int maxRows = rowIds.length;
7453 if (mBuilder.mActions.size() > 0) {
7454 maxRows--;
7455 }
7456 while (i < mTexts.size() && i < maxRows) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007457 CharSequence str = mTexts.get(i);
Selim Cinek07c80172016-04-21 16:40:47 -07007458 if (!TextUtils.isEmpty(str)) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04007459 contentView.setViewVisibility(rowIds[i], View.VISIBLE);
Selim Cinek48f66b72017-08-18 16:17:51 -07007460 contentView.setTextViewText(rowIds[i],
7461 mBuilder.processTextSpans(mBuilder.processLegacyText(str)));
Selim Cinek7b9605b2017-01-19 17:36:00 -08007462 mBuilder.setTextViewColorSecondary(contentView, rowIds[i]);
Selim Cinek07c80172016-04-21 16:40:47 -07007463 contentView.setViewPadding(rowIds[i], 0, topPadding, 0, 0);
Selim Cinek384804b2018-04-18 14:31:07 +08007464 handleInboxImageMargin(contentView, rowIds[i], first,
Selim Cinek1c72fa02018-04-23 18:00:54 +08007465 result.getIconMarginEnd());
Selim Cinek07c80172016-04-21 16:40:47 -07007466 if (first) {
7467 onlyViewId = rowIds[i];
7468 } else {
7469 onlyViewId = 0;
7470 }
Selim Cinek247fa012016-02-18 09:50:48 -08007471 first = false;
Daniel Sandler879c5e02012-04-17 16:46:51 -04007472 }
7473 i++;
7474 }
Selim Cinek07c80172016-04-21 16:40:47 -07007475 if (onlyViewId != 0) {
7476 // We only have 1 entry, lets make it look like the normal Text of a Bigtext
7477 topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
7478 R.dimen.notification_text_margin_top);
7479 contentView.setViewPadding(onlyViewId, 0, topPadding, 0, 0);
7480 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007481
Daniel Sandler879c5e02012-04-17 16:46:51 -04007482 return contentView;
7483 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007484
Julia Reynolds7217dc92018-03-07 12:12:09 -05007485 /**
7486 * @hide
7487 */
7488 @Override
7489 public boolean areNotificationsVisiblyDifferent(Style other) {
7490 if (other == null || getClass() != other.getClass()) {
7491 return true;
7492 }
7493 InboxStyle newS = (InboxStyle) other;
7494 return !Objects.equals(getLines(), newS.getLines());
7495 }
7496
Selim Cinek384804b2018-04-18 14:31:07 +08007497 private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first,
Selim Cinek1c72fa02018-04-23 18:00:54 +08007498 int marginEndValue) {
Selim Cinek1e0bf612015-11-20 15:57:26 -08007499 int endMargin = 0;
Selim Cinek247fa012016-02-18 09:50:48 -08007500 if (first) {
7501 final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0);
7502 final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
7503 boolean hasProgress = max != 0 || ind;
Selim Cinek384804b2018-04-18 14:31:07 +08007504 if (!hasProgress) {
Selim Cinek1c72fa02018-04-23 18:00:54 +08007505 endMargin = marginEndValue;
Selim Cinek247fa012016-02-18 09:50:48 -08007506 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08007507 }
Selim Cinek1c72fa02018-04-23 18:00:54 +08007508 contentView.setViewLayoutMarginEnd(id, endMargin);
Selim Cinek1e0bf612015-11-20 15:57:26 -08007509 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04007510 }
Dan Sandler842dd772014-05-15 09:36:47 -04007511
7512 /**
7513 * Notification style for media playback notifications.
7514 *
7515 * In the expanded form, {@link Notification#bigContentView}, up to 5
7516 * {@link Notification.Action}s specified with
Dan Sandler86647982015-05-13 23:41:13 -04007517 * {@link Notification.Builder#addAction(Action) addAction} will be
Dan Sandler842dd772014-05-15 09:36:47 -04007518 * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
7519 * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be
7520 * treated as album artwork.
Selim Cinek99104832017-01-25 14:47:33 -08007521 * <p>
Dan Sandler842dd772014-05-15 09:36:47 -04007522 * Unlike the other styles provided here, MediaStyle can also modify the standard-size
7523 * {@link Notification#contentView}; by providing action indices to
Christoph Studerfde6f4d2014-12-12 13:23:26 +01007524 * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed
Dan Sandler842dd772014-05-15 09:36:47 -04007525 * in the standard view alongside the usual content.
Selim Cinek99104832017-01-25 14:47:33 -08007526 * <p>
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007527 * Notifications created with MediaStyle will have their category set to
7528 * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different
7529 * category using {@link Notification.Builder#setCategory(String) setCategory()}.
Selim Cinek99104832017-01-25 14:47:33 -08007530 * <p>
Jeff Browndba34ba2014-06-24 20:46:03 -07007531 * Finally, if you attach a {@link android.media.session.MediaSession.Token} using
7532 * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)},
Dan Sandler842dd772014-05-15 09:36:47 -04007533 * the System UI can identify this as a notification representing an active media session
7534 * and respond accordingly (by showing album artwork in the lockscreen, for example).
7535 *
Selim Cinek99104832017-01-25 14:47:33 -08007536 * <p>
7537 * Starting at {@link android.os.Build.VERSION_CODES#O Android O} any notification that has a
7538 * media session attached with {@link #setMediaSession(MediaSession.Token)} will be colorized.
7539 * You can opt-out of this behavior by using {@link Notification.Builder#setColorized(boolean)}.
7540 * <p>
7541 *
Dan Sandler842dd772014-05-15 09:36:47 -04007542 * To use this style with your Notification, feed it to
7543 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7544 * <pre class="prettyprint">
7545 * Notification noti = new Notification.Builder()
7546 * .setSmallIcon(R.drawable.ic_stat_player)
Christoph Studere935fe92014-11-24 14:18:06 +01007547 * .setContentTitle(&quot;Track title&quot;)
7548 * .setContentText(&quot;Artist - Album&quot;)
7549 * .setLargeIcon(albumArtBitmap))
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007550 * .setStyle(<b>new Notification.MediaStyle()</b>
7551 * .setMediaSession(mySession))
Dan Sandler842dd772014-05-15 09:36:47 -04007552 * .build();
7553 * </pre>
7554 *
7555 * @see Notification#bigContentView
Selim Cinek99104832017-01-25 14:47:33 -08007556 * @see Notification.Builder#setColorized(boolean)
Dan Sandler842dd772014-05-15 09:36:47 -04007557 */
7558 public static class MediaStyle extends Style {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007559 static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3;
Dan Sandler842dd772014-05-15 09:36:47 -04007560 static final int MAX_MEDIA_BUTTONS = 5;
7561
7562 private int[] mActionsToShowInCompact = null;
Jeff Browndba34ba2014-06-24 20:46:03 -07007563 private MediaSession.Token mToken;
Dan Sandler842dd772014-05-15 09:36:47 -04007564
7565 public MediaStyle() {
7566 }
7567
Adrian Roosf5faf9d2016-05-23 13:56:15 -07007568 /**
7569 * @deprecated use {@code MediaStyle()}.
7570 */
7571 @Deprecated
Dan Sandler842dd772014-05-15 09:36:47 -04007572 public MediaStyle(Builder builder) {
7573 setBuilder(builder);
7574 }
7575
7576 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007577 * 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 -04007578 * notification view.
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007579 *
7580 * @param actions the indices of the actions to show in the compact notification view
Dan Sandler842dd772014-05-15 09:36:47 -04007581 */
7582 public MediaStyle setShowActionsInCompactView(int...actions) {
7583 mActionsToShowInCompact = actions;
7584 return this;
7585 }
7586
7587 /**
Jeff Browndba34ba2014-06-24 20:46:03 -07007588 * Attach a {@link android.media.session.MediaSession.Token} to this Notification
7589 * to provide additional playback information and control to the SystemUI.
Dan Sandler842dd772014-05-15 09:36:47 -04007590 */
Jeff Browndba34ba2014-06-24 20:46:03 -07007591 public MediaStyle setMediaSession(MediaSession.Token token) {
Dan Sandler842dd772014-05-15 09:36:47 -04007592 mToken = token;
7593 return this;
7594 }
7595
Christoph Studer4600f9b2014-07-22 22:44:43 +02007596 /**
7597 * @hide
7598 */
Dan Sandler842dd772014-05-15 09:36:47 -04007599 @Override
7600 public Notification buildStyled(Notification wip) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02007601 super.buildStyled(wip);
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01007602 if (wip.category == null) {
7603 wip.category = Notification.CATEGORY_TRANSPORT;
7604 }
Dan Sandler842dd772014-05-15 09:36:47 -04007605 return wip;
7606 }
7607
Christoph Studer4600f9b2014-07-22 22:44:43 +02007608 /**
7609 * @hide
7610 */
7611 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007612 public RemoteViews makeContentView(boolean increasedHeight) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007613 return makeMediaContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007614 }
7615
7616 /**
7617 * @hide
7618 */
7619 @Override
Julia Reynoldsd9228f12015-10-20 10:37:27 -04007620 public RemoteViews makeBigContentView() {
7621 return makeMediaBigContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02007622 }
7623
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007624 /**
7625 * @hide
7626 */
7627 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007628 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007629 RemoteViews expanded = makeMediaBigContentView();
7630 return expanded != null ? expanded : makeMediaContentView();
7631 }
7632
Dan Sandler842dd772014-05-15 09:36:47 -04007633 /** @hide */
7634 @Override
7635 public void addExtras(Bundle extras) {
7636 super.addExtras(extras);
7637
7638 if (mToken != null) {
7639 extras.putParcelable(EXTRA_MEDIA_SESSION, mToken);
7640 }
Bryan Mawhinneye191f902014-07-22 12:50:09 +01007641 if (mActionsToShowInCompact != null) {
7642 extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact);
7643 }
Dan Sandler842dd772014-05-15 09:36:47 -04007644 }
7645
Christoph Studer4600f9b2014-07-22 22:44:43 +02007646 /**
7647 * @hide
7648 */
7649 @Override
7650 protected void restoreFromExtras(Bundle extras) {
7651 super.restoreFromExtras(extras);
7652
7653 if (extras.containsKey(EXTRA_MEDIA_SESSION)) {
7654 mToken = extras.getParcelable(EXTRA_MEDIA_SESSION);
7655 }
7656 if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) {
7657 mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS);
7658 }
7659 }
7660
Julia Reynolds7217dc92018-03-07 12:12:09 -05007661 /**
7662 * @hide
7663 */
7664 @Override
7665 public boolean areNotificationsVisiblyDifferent(Style other) {
7666 if (other == null || getClass() != other.getClass()) {
7667 return true;
7668 }
7669 // All fields to compare are on the Notification object
7670 return false;
7671 }
7672
Selim Cinek5bf069a2015-11-10 19:14:27 -05007673 private RemoteViews generateMediaActionButton(Action action, int color) {
Dan Sandler842dd772014-05-15 09:36:47 -04007674 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07007675 RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(),
Alan Viverette3cb07a462014-06-06 14:19:53 -07007676 R.layout.notification_material_media_action);
Dan Sandler68079d52015-07-22 10:45:30 -04007677 button.setImageViewIcon(R.id.action0, action.getIcon());
Anthony Chenad4d1582017-04-10 16:07:58 -07007678
7679 // If the action buttons should not be tinted, then just use the default
7680 // notification color. Otherwise, just use the passed-in color.
7681 int tintColor = mBuilder.shouldTintActionButtons() || mBuilder.isColorized()
7682 ? color
7683 : NotificationColorUtil.resolveColor(mBuilder.mContext,
7684 Notification.COLOR_DEFAULT);
7685
Sunny Goyal5b153922017-09-21 21:00:36 -07007686 button.setDrawableTint(R.id.action0, false, tintColor,
7687 PorterDuff.Mode.SRC_ATOP);
Dan Sandler842dd772014-05-15 09:36:47 -04007688 if (!tombstone) {
7689 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
7690 }
7691 button.setContentDescription(R.id.action0, action.title);
7692 return button;
7693 }
7694
7695 private RemoteViews makeMediaContentView() {
7696 RemoteViews view = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007697 R.layout.notification_template_material_media, false, /* hasProgress */
7698 null /* result */);
Dan Sandler842dd772014-05-15 09:36:47 -04007699
7700 final int numActions = mBuilder.mActions.size();
7701 final int N = mActionsToShowInCompact == null
7702 ? 0
7703 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
7704 if (N > 0) {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007705 view.removeAllViews(com.android.internal.R.id.media_actions);
Dan Sandler842dd772014-05-15 09:36:47 -04007706 for (int i = 0; i < N; i++) {
7707 if (i >= numActions) {
7708 throw new IllegalArgumentException(String.format(
7709 "setShowActionsInCompactView: action %d out of bounds (max %d)",
7710 i, numActions - 1));
7711 }
7712
7713 final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]);
Selim Cinekc7f5a822018-03-20 19:32:06 -07007714 final RemoteViews button = generateMediaActionButton(action, getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007715 view.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007716 }
7717 }
Selim Cinekfdc738f2016-01-27 20:04:27 -08007718 handleImage(view);
7719 // handle the content margin
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007720 int endMargin = R.dimen.notification_content_margin_end;
Selim Cinek279fa862016-06-14 10:57:25 -07007721 if (mBuilder.mN.hasLargeIcon()) {
Selim Cinek384804b2018-04-18 14:31:07 +08007722 endMargin = R.dimen.notification_media_image_margin_end;
Selim Cinekfdc738f2016-01-27 20:04:27 -08007723 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007724 view.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
Dan Sandler842dd772014-05-15 09:36:47 -04007725 return view;
7726 }
7727
Selim Cinekc7f5a822018-03-20 19:32:06 -07007728 private int getActionColor() {
7729 return mBuilder.isColorized() ? mBuilder.getPrimaryTextColor()
7730 : mBuilder.resolveContrastColor();
Selim Cinek99104832017-01-25 14:47:33 -08007731 }
7732
Dan Sandler842dd772014-05-15 09:36:47 -04007733 private RemoteViews makeMediaBigContentView() {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007734 final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007735 // Dont add an expanded view if there is no more content to be revealed
7736 int actionsInCompact = mActionsToShowInCompact == null
7737 ? 0
7738 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
Selim Cinek279fa862016-06-14 10:57:25 -07007739 if (!mBuilder.mN.hasLargeIcon() && actionCount <= actionsInCompact) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08007740 return null;
7741 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007742 RemoteViews big = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007743 R.layout.notification_template_material_big_media, false, null /* result */);
Dan Sandler842dd772014-05-15 09:36:47 -04007744
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007745 if (actionCount > 0) {
7746 big.removeAllViews(com.android.internal.R.id.media_actions);
7747 for (int i = 0; i < actionCount; i++) {
Selim Cinek5bf069a2015-11-10 19:14:27 -05007748 final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i),
Selim Cinekc7f5a822018-03-20 19:32:06 -07007749 getActionColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007750 big.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04007751 }
7752 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05007753 handleImage(big);
Dan Sandler842dd772014-05-15 09:36:47 -04007754 return big;
7755 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007756
Selim Cinek5bf069a2015-11-10 19:14:27 -05007757 private void handleImage(RemoteViews contentView) {
Selim Cinek279fa862016-06-14 10:57:25 -07007758 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07007759 contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
7760 contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007761 }
7762 }
7763
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02007764 /**
7765 * @hide
7766 */
7767 @Override
7768 protected boolean hasProgress() {
7769 return false;
7770 }
Dan Sandler842dd772014-05-15 09:36:47 -04007771 }
Griff Hazen61a9e862014-05-22 16:05:19 -07007772
Selim Cinek593610c2016-02-16 18:42:57 -08007773 /**
7774 * Notification style for custom views that are decorated by the system
7775 *
7776 * <p>Instead of providing a notification that is completely custom, a developer can set this
7777 * style and still obtain system decorations like the notification header with the expand
7778 * affordance and actions.
7779 *
7780 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7781 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7782 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7783 * corresponding custom views to display.
7784 *
7785 * To use this style with your Notification, feed it to
7786 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7787 * <pre class="prettyprint">
7788 * Notification noti = new Notification.Builder()
7789 * .setSmallIcon(R.drawable.ic_stat_player)
7790 * .setLargeIcon(albumArtBitmap))
7791 * .setCustomContentView(contentView);
7792 * .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>)
7793 * .build();
7794 * </pre>
7795 */
7796 public static class DecoratedCustomViewStyle extends Style {
7797
7798 public DecoratedCustomViewStyle() {
7799 }
7800
Selim Cinek593610c2016-02-16 18:42:57 -08007801 /**
7802 * @hide
7803 */
7804 public boolean displayCustomViewInline() {
7805 return true;
7806 }
7807
7808 /**
7809 * @hide
7810 */
7811 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007812 public RemoteViews makeContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007813 return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView);
7814 }
7815
7816 /**
7817 * @hide
7818 */
7819 @Override
7820 public RemoteViews makeBigContentView() {
7821 return makeDecoratedBigContentView();
7822 }
7823
7824 /**
7825 * @hide
7826 */
7827 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007828 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek593610c2016-02-16 18:42:57 -08007829 return makeDecoratedHeadsUpContentView();
7830 }
7831
Selim Cinek593610c2016-02-16 18:42:57 -08007832 private RemoteViews makeDecoratedHeadsUpContentView() {
7833 RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null
7834 ? mBuilder.mN.contentView
7835 : mBuilder.mN.headsUpContentView;
7836 if (mBuilder.mActions.size() == 0) {
7837 return makeStandardTemplateWithCustomContent(headsUpContentView);
7838 }
Selim Cinek384804b2018-04-18 14:31:07 +08007839 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08007840 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
Selim Cinek384804b2018-04-18 14:31:07 +08007841 mBuilder.getBigBaseLayoutResource(), result);
7842 buildIntoRemoteViewContent(remoteViews, headsUpContentView, result);
Selim Cinek593610c2016-02-16 18:42:57 -08007843 return remoteViews;
7844 }
7845
Selim Cinek593610c2016-02-16 18:42:57 -08007846 private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) {
Selim Cinek384804b2018-04-18 14:31:07 +08007847 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08007848 RemoteViews remoteViews = mBuilder.applyStandardTemplate(
Selim Cinek384804b2018-04-18 14:31:07 +08007849 mBuilder.getBaseLayoutResource(), result);
7850 buildIntoRemoteViewContent(remoteViews, customContent, result);
Selim Cinek593610c2016-02-16 18:42:57 -08007851 return remoteViews;
7852 }
7853
Selim Cinek593610c2016-02-16 18:42:57 -08007854 private RemoteViews makeDecoratedBigContentView() {
7855 RemoteViews bigContentView = mBuilder.mN.bigContentView == null
7856 ? mBuilder.mN.contentView
7857 : mBuilder.mN.bigContentView;
7858 if (mBuilder.mActions.size() == 0) {
7859 return makeStandardTemplateWithCustomContent(bigContentView);
7860 }
Selim Cinek384804b2018-04-18 14:31:07 +08007861 TemplateBindResult result = new TemplateBindResult();
Selim Cinek593610c2016-02-16 18:42:57 -08007862 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
Selim Cinek384804b2018-04-18 14:31:07 +08007863 mBuilder.getBigBaseLayoutResource(), result);
7864 buildIntoRemoteViewContent(remoteViews, bigContentView, result);
Selim Cinek593610c2016-02-16 18:42:57 -08007865 return remoteViews;
7866 }
Selim Cinek247fa012016-02-18 09:50:48 -08007867
7868 private void buildIntoRemoteViewContent(RemoteViews remoteViews,
Selim Cinek384804b2018-04-18 14:31:07 +08007869 RemoteViews customContent, TemplateBindResult result) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08007870 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07007871 // Need to clone customContent before adding, because otherwise it can no longer be
7872 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08007873 customContent = customContent.clone();
Anthony Chen8f5f3582017-04-11 11:18:37 -07007874 remoteViews.removeAllViewsExceptId(R.id.notification_main_column, R.id.progress);
7875 remoteViews.addView(R.id.notification_main_column, customContent, 0 /* index */);
Selim Cinekfc8073c2017-08-16 17:50:20 -07007876 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08007877 }
Selim Cinek247fa012016-02-18 09:50:48 -08007878 // also update the end margin if there is an image
Selim Cinek384804b2018-04-18 14:31:07 +08007879 Resources resources = mBuilder.mContext.getResources();
7880 int endMargin = resources.getDimensionPixelSize(
Selim Cinek1c72fa02018-04-23 18:00:54 +08007881 R.dimen.notification_content_margin_end) + result.getIconMarginEnd();
Selim Cinek384804b2018-04-18 14:31:07 +08007882 remoteViews.setViewLayoutMarginEnd(R.id.notification_main_column, endMargin);
Selim Cinek247fa012016-02-18 09:50:48 -08007883 }
Julia Reynolds7217dc92018-03-07 12:12:09 -05007884
7885 /**
7886 * @hide
7887 */
7888 @Override
7889 public boolean areNotificationsVisiblyDifferent(Style other) {
7890 if (other == null || getClass() != other.getClass()) {
7891 return true;
7892 }
7893 // Comparison done for all custom RemoteViews, independent of style
7894 return false;
7895 }
Selim Cinek593610c2016-02-16 18:42:57 -08007896 }
7897
Selim Cinek03eb3b72016-02-18 10:39:45 -08007898 /**
7899 * Notification style for media custom views that are decorated by the system
7900 *
7901 * <p>Instead of providing a media notification that is completely custom, a developer can set
7902 * this style and still obtain system decorations like the notification header with the expand
7903 * affordance and actions.
7904 *
7905 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
7906 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
7907 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
7908 * corresponding custom views to display.
Selim Cinek99104832017-01-25 14:47:33 -08007909 * <p>
7910 * Contrary to {@link MediaStyle} a developer has to opt-in to the colorizing of the
7911 * notification by using {@link Notification.Builder#setColorized(boolean)}.
7912 * <p>
Selim Cinek03eb3b72016-02-18 10:39:45 -08007913 * To use this style with your Notification, feed it to
7914 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
7915 * <pre class="prettyprint">
7916 * Notification noti = new Notification.Builder()
7917 * .setSmallIcon(R.drawable.ic_stat_player)
7918 * .setLargeIcon(albumArtBitmap))
7919 * .setCustomContentView(contentView);
7920 * .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b>
7921 * .setMediaSession(mySession))
7922 * .build();
7923 * </pre>
7924 *
7925 * @see android.app.Notification.DecoratedCustomViewStyle
7926 * @see android.app.Notification.MediaStyle
7927 */
7928 public static class DecoratedMediaCustomViewStyle extends MediaStyle {
7929
7930 public DecoratedMediaCustomViewStyle() {
7931 }
7932
Selim Cinek03eb3b72016-02-18 10:39:45 -08007933 /**
7934 * @hide
7935 */
7936 public boolean displayCustomViewInline() {
7937 return true;
7938 }
7939
7940 /**
7941 * @hide
7942 */
7943 @Override
Selim Cinek7d1009b2017-01-25 15:28:28 -08007944 public RemoteViews makeContentView(boolean increasedHeight) {
7945 RemoteViews remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08007946 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
7947 mBuilder.mN.contentView);
7948 }
7949
7950 /**
7951 * @hide
7952 */
7953 @Override
7954 public RemoteViews makeBigContentView() {
7955 RemoteViews customRemoteView = mBuilder.mN.bigContentView != null
7956 ? mBuilder.mN.bigContentView
7957 : mBuilder.mN.contentView;
7958 return makeBigContentViewWithCustomContent(customRemoteView);
7959 }
7960
7961 private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) {
7962 RemoteViews remoteViews = super.makeBigContentView();
7963 if (remoteViews != null) {
7964 return buildIntoRemoteView(remoteViews, R.id.notification_main_column,
7965 customRemoteView);
7966 } else if (customRemoteView != mBuilder.mN.contentView){
Selim Cinek7d1009b2017-01-25 15:28:28 -08007967 remoteViews = super.makeContentView(false /* increasedHeight */);
Selim Cinek03eb3b72016-02-18 10:39:45 -08007968 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
7969 customRemoteView);
7970 } else {
7971 return null;
7972 }
7973 }
7974
7975 /**
7976 * @hide
7977 */
7978 @Override
Selim Cinek87ed69b2017-02-09 15:59:43 -08007979 public RemoteViews makeHeadsUpContentView(boolean increasedHeight) {
Selim Cinek03eb3b72016-02-18 10:39:45 -08007980 RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null
7981 ? mBuilder.mN.headsUpContentView
7982 : mBuilder.mN.contentView;
7983 return makeBigContentViewWithCustomContent(customRemoteView);
7984 }
7985
Julia Reynolds7217dc92018-03-07 12:12:09 -05007986 /**
7987 * @hide
7988 */
7989 @Override
7990 public boolean areNotificationsVisiblyDifferent(Style other) {
7991 if (other == null || getClass() != other.getClass()) {
7992 return true;
7993 }
7994 // Comparison done for all custom RemoteViews, independent of style
7995 return false;
7996 }
7997
Selim Cinek03eb3b72016-02-18 10:39:45 -08007998 private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id,
7999 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08008000 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07008001 // Need to clone customContent before adding, because otherwise it can no longer be
8002 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08008003 customContent = customContent.clone();
Selim Cinek87c31532017-08-18 18:53:44 -07008004 customContent.overrideTextColors(mBuilder.getPrimaryTextColor());
Selim Cinekf91017e2016-03-14 12:25:09 -07008005 remoteViews.removeAllViews(id);
8006 remoteViews.addView(id, customContent);
Selim Cinekfc8073c2017-08-16 17:50:20 -07008007 remoteViews.setReapplyDisallowed();
Adrian Roos5081c0d2016-02-26 16:04:19 -08008008 }
Selim Cinek03eb3b72016-02-18 10:39:45 -08008009 return remoteViews;
8010 }
8011 }
8012
Christoph Studer4600f9b2014-07-22 22:44:43 +02008013 // When adding a new Style subclass here, don't forget to update
8014 // Builder.getNotificationStyleClass.
8015
Griff Hazen61a9e862014-05-22 16:05:19 -07008016 /**
8017 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
8018 * metadata or change options on a notification builder.
8019 */
8020 public interface Extender {
8021 /**
8022 * Apply this extender to a notification builder.
8023 * @param builder the builder to be modified.
8024 * @return the build object for chaining.
8025 */
8026 public Builder extend(Builder builder);
8027 }
8028
8029 /**
8030 * Helper class to add wearable extensions to notifications.
8031 * <p class="note"> See
8032 * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications
8033 * for Android Wear</a> for more information on how to use this class.
8034 * <p>
8035 * To create a notification with wearable extensions:
8036 * <ol>
8037 * <li>Create a {@link android.app.Notification.Builder}, setting any desired
8038 * properties.
8039 * <li>Create a {@link android.app.Notification.WearableExtender}.
8040 * <li>Set wearable-specific properties using the
8041 * {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}.
8042 * <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a
8043 * notification.
8044 * <li>Post the notification to the notification system with the
8045 * {@code NotificationManager.notify(...)} methods.
8046 * </ol>
8047 *
8048 * <pre class="prettyprint">
8049 * Notification notif = new Notification.Builder(mContext)
8050 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
8051 * .setContentText(subject)
8052 * .setSmallIcon(R.drawable.new_mail)
8053 * .extend(new Notification.WearableExtender()
8054 * .setContentIcon(R.drawable.new_mail))
8055 * .build();
8056 * NotificationManager notificationManger =
8057 * (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
8058 * notificationManger.notify(0, notif);</pre>
8059 *
8060 * <p>Wearable extensions can be accessed on an existing notification by using the
8061 * {@code WearableExtender(Notification)} constructor,
8062 * and then using the {@code get} methods to access values.
8063 *
8064 * <pre class="prettyprint">
8065 * Notification.WearableExtender wearableExtender = new Notification.WearableExtender(
8066 * notification);
Griff Hazen14f57992014-05-26 09:07:14 -07008067 * List&lt;Notification&gt; pages = wearableExtender.getPages();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07008068 */
8069 public static final class WearableExtender implements Extender {
8070 /**
8071 * Sentinel value for an action index that is unset.
8072 */
8073 public static final int UNSET_ACTION_INDEX = -1;
8074
8075 /**
8076 * Size value for use with {@link #setCustomSizePreset} to show this notification with
8077 * default sizing.
8078 * <p>For custom display notifications created using {@link #setDisplayIntent},
Paul Soulosaa4f4bf2015-08-04 11:59:45 -07008079 * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based
Griff Hazen61a9e862014-05-22 16:05:19 -07008080 * on their content.
8081 */
8082 public static final int SIZE_DEFAULT = 0;
8083
8084 /**
8085 * Size value for use with {@link #setCustomSizePreset} to show this notification
8086 * with an extra small size.
8087 * <p>This value is only applicable for custom display notifications created using
8088 * {@link #setDisplayIntent}.
8089 */
8090 public static final int SIZE_XSMALL = 1;
8091
8092 /**
8093 * Size value for use with {@link #setCustomSizePreset} to show this notification
8094 * with a small size.
8095 * <p>This value is only applicable for custom display notifications created using
8096 * {@link #setDisplayIntent}.
8097 */
8098 public static final int SIZE_SMALL = 2;
8099
8100 /**
8101 * Size value for use with {@link #setCustomSizePreset} to show this notification
8102 * with a medium size.
8103 * <p>This value is only applicable for custom display notifications created using
8104 * {@link #setDisplayIntent}.
8105 */
8106 public static final int SIZE_MEDIUM = 3;
8107
8108 /**
8109 * Size value for use with {@link #setCustomSizePreset} to show this notification
8110 * with a large size.
8111 * <p>This value is only applicable for custom display notifications created using
8112 * {@link #setDisplayIntent}.
8113 */
8114 public static final int SIZE_LARGE = 4;
8115
Griff Hazend5f11f92014-05-27 15:40:09 -07008116 /**
8117 * Size value for use with {@link #setCustomSizePreset} to show this notification
8118 * full screen.
8119 * <p>This value is only applicable for custom display notifications created using
8120 * {@link #setDisplayIntent}.
8121 */
8122 public static final int SIZE_FULL_SCREEN = 5;
8123
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008124 /**
8125 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a
8126 * short amount of time when this notification is displayed on the screen. This
8127 * is the default value.
8128 */
8129 public static final int SCREEN_TIMEOUT_SHORT = 0;
8130
8131 /**
8132 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on
8133 * for a longer amount of time when this notification is displayed on the screen.
8134 */
8135 public static final int SCREEN_TIMEOUT_LONG = -1;
8136
Griff Hazen61a9e862014-05-22 16:05:19 -07008137 /** Notification extra which contains wearable extensions */
8138 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
8139
Pete Gastaf6781d2014-10-07 15:17:05 -04008140 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07008141 private static final String KEY_ACTIONS = "actions";
8142 private static final String KEY_FLAGS = "flags";
8143 private static final String KEY_DISPLAY_INTENT = "displayIntent";
8144 private static final String KEY_PAGES = "pages";
8145 private static final String KEY_BACKGROUND = "background";
8146 private static final String KEY_CONTENT_ICON = "contentIcon";
8147 private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity";
8148 private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex";
8149 private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset";
8150 private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight";
8151 private static final String KEY_GRAVITY = "gravity";
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008152 private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout";
Nadia Benbernou948627e2016-04-14 14:41:08 -04008153 private static final String KEY_DISMISSAL_ID = "dismissalId";
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008154 private static final String KEY_BRIDGE_TAG = "bridgeTag";
Griff Hazen61a9e862014-05-22 16:05:19 -07008155
8156 // Flags bitwise-ored to mFlags
8157 private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1;
8158 private static final int FLAG_HINT_HIDE_ICON = 1 << 1;
8159 private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2;
8160 private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008161 private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4;
Alex Hills4bcb06b2016-04-05 14:26:25 -04008162 private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5;
Alex Hills9ab3a232016-04-05 14:54:56 -04008163 private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6;
Griff Hazen61a9e862014-05-22 16:05:19 -07008164
8165 // Default value for flags integer
8166 private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE;
8167
8168 private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END;
8169 private static final int DEFAULT_GRAVITY = Gravity.BOTTOM;
8170
8171 private ArrayList<Action> mActions = new ArrayList<Action>();
8172 private int mFlags = DEFAULT_FLAGS;
8173 private PendingIntent mDisplayIntent;
8174 private ArrayList<Notification> mPages = new ArrayList<Notification>();
8175 private Bitmap mBackground;
8176 private int mContentIcon;
8177 private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY;
8178 private int mContentActionIndex = UNSET_ACTION_INDEX;
8179 private int mCustomSizePreset = SIZE_DEFAULT;
8180 private int mCustomContentHeight;
8181 private int mGravity = DEFAULT_GRAVITY;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008182 private int mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04008183 private String mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008184 private String mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07008185
8186 /**
8187 * Create a {@link android.app.Notification.WearableExtender} with default
8188 * options.
8189 */
8190 public WearableExtender() {
8191 }
8192
8193 public WearableExtender(Notification notif) {
8194 Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS);
8195 if (wearableBundle != null) {
8196 List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS);
8197 if (actions != null) {
8198 mActions.addAll(actions);
8199 }
8200
8201 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
8202 mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT);
8203
8204 Notification[] pages = getNotificationArrayFromBundle(
8205 wearableBundle, KEY_PAGES);
8206 if (pages != null) {
8207 Collections.addAll(mPages, pages);
8208 }
8209
8210 mBackground = wearableBundle.getParcelable(KEY_BACKGROUND);
8211 mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON);
8212 mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY,
8213 DEFAULT_CONTENT_ICON_GRAVITY);
8214 mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX,
8215 UNSET_ACTION_INDEX);
8216 mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET,
8217 SIZE_DEFAULT);
8218 mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT);
8219 mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY);
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008220 mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT);
Nadia Benbernou948627e2016-04-14 14:41:08 -04008221 mDismissalId = wearableBundle.getString(KEY_DISMISSAL_ID);
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008222 mBridgeTag = wearableBundle.getString(KEY_BRIDGE_TAG);
Griff Hazen61a9e862014-05-22 16:05:19 -07008223 }
8224 }
8225
8226 /**
8227 * Apply wearable extensions to a notification that is being built. This is typically
8228 * called by the {@link android.app.Notification.Builder#extend} method of
8229 * {@link android.app.Notification.Builder}.
8230 */
8231 @Override
8232 public Notification.Builder extend(Notification.Builder builder) {
8233 Bundle wearableBundle = new Bundle();
8234
8235 if (!mActions.isEmpty()) {
8236 wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions);
8237 }
8238 if (mFlags != DEFAULT_FLAGS) {
8239 wearableBundle.putInt(KEY_FLAGS, mFlags);
8240 }
8241 if (mDisplayIntent != null) {
8242 wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent);
8243 }
8244 if (!mPages.isEmpty()) {
8245 wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray(
8246 new Notification[mPages.size()]));
8247 }
8248 if (mBackground != null) {
8249 wearableBundle.putParcelable(KEY_BACKGROUND, mBackground);
8250 }
8251 if (mContentIcon != 0) {
8252 wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon);
8253 }
8254 if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) {
8255 wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity);
8256 }
8257 if (mContentActionIndex != UNSET_ACTION_INDEX) {
8258 wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX,
8259 mContentActionIndex);
8260 }
8261 if (mCustomSizePreset != SIZE_DEFAULT) {
8262 wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset);
8263 }
8264 if (mCustomContentHeight != 0) {
8265 wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight);
8266 }
8267 if (mGravity != DEFAULT_GRAVITY) {
8268 wearableBundle.putInt(KEY_GRAVITY, mGravity);
8269 }
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008270 if (mHintScreenTimeout != 0) {
8271 wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout);
8272 }
Nadia Benbernou948627e2016-04-14 14:41:08 -04008273 if (mDismissalId != null) {
8274 wearableBundle.putString(KEY_DISMISSAL_ID, mDismissalId);
8275 }
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008276 if (mBridgeTag != null) {
8277 wearableBundle.putString(KEY_BRIDGE_TAG, mBridgeTag);
8278 }
Griff Hazen61a9e862014-05-22 16:05:19 -07008279
8280 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
8281 return builder;
8282 }
8283
8284 @Override
8285 public WearableExtender clone() {
8286 WearableExtender that = new WearableExtender();
8287 that.mActions = new ArrayList<Action>(this.mActions);
8288 that.mFlags = this.mFlags;
8289 that.mDisplayIntent = this.mDisplayIntent;
8290 that.mPages = new ArrayList<Notification>(this.mPages);
8291 that.mBackground = this.mBackground;
8292 that.mContentIcon = this.mContentIcon;
8293 that.mContentIconGravity = this.mContentIconGravity;
8294 that.mContentActionIndex = this.mContentActionIndex;
8295 that.mCustomSizePreset = this.mCustomSizePreset;
8296 that.mCustomContentHeight = this.mCustomContentHeight;
8297 that.mGravity = this.mGravity;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008298 that.mHintScreenTimeout = this.mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04008299 that.mDismissalId = this.mDismissalId;
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008300 that.mBridgeTag = this.mBridgeTag;
Griff Hazen61a9e862014-05-22 16:05:19 -07008301 return that;
8302 }
8303
8304 /**
8305 * Add a wearable action to this notification.
8306 *
8307 * <p>When wearable actions are added using this method, the set of actions that
8308 * show on a wearable device splits from devices that only show actions added
8309 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8310 * of which actions display on different devices.
8311 *
8312 * @param action the action to add to this notification
8313 * @return this object for method chaining
8314 * @see android.app.Notification.Action
8315 */
8316 public WearableExtender addAction(Action action) {
8317 mActions.add(action);
8318 return this;
8319 }
8320
8321 /**
8322 * Adds wearable actions to this notification.
8323 *
8324 * <p>When wearable actions are added using this method, the set of actions that
8325 * show on a wearable device splits from devices that only show actions added
8326 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
8327 * of which actions display on different devices.
8328 *
8329 * @param actions the actions to add to this notification
8330 * @return this object for method chaining
8331 * @see android.app.Notification.Action
8332 */
8333 public WearableExtender addActions(List<Action> actions) {
8334 mActions.addAll(actions);
8335 return this;
8336 }
8337
8338 /**
8339 * Clear all wearable actions present on this builder.
8340 * @return this object for method chaining.
8341 * @see #addAction
8342 */
8343 public WearableExtender clearActions() {
8344 mActions.clear();
8345 return this;
8346 }
8347
8348 /**
8349 * Get the wearable actions present on this notification.
8350 */
8351 public List<Action> getActions() {
8352 return mActions;
8353 }
8354
8355 /**
8356 * Set an intent to launch inside of an activity view when displaying
Griff Hazen14f57992014-05-26 09:07:14 -07008357 * this notification. The {@link PendingIntent} provided should be for an activity.
8358 *
8359 * <pre class="prettyprint">
8360 * Intent displayIntent = new Intent(context, MyDisplayActivity.class);
8361 * PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
8362 * 0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
8363 * Notification notif = new Notification.Builder(context)
8364 * .extend(new Notification.WearableExtender()
8365 * .setDisplayIntent(displayPendingIntent)
8366 * .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM))
8367 * .build();</pre>
8368 *
8369 * <p>The activity to launch needs to allow embedding, must be exported, and
Griff Hazen831ca9d2014-06-17 00:38:38 -07008370 * should have an empty task affinity. It is also recommended to use the device
8371 * default light theme.
Griff Hazen14f57992014-05-26 09:07:14 -07008372 *
8373 * <p>Example AndroidManifest.xml entry:
8374 * <pre class="prettyprint">
8375 * &lt;activity android:name=&quot;com.example.MyDisplayActivity&quot;
8376 * android:exported=&quot;true&quot;
8377 * android:allowEmbedded=&quot;true&quot;
Griff Hazen831ca9d2014-06-17 00:38:38 -07008378 * android:taskAffinity=&quot;&quot;
8379 * android:theme=&quot;@android:style/Theme.DeviceDefault.Light&quot; /&gt;</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07008380 *
8381 * @param intent the {@link PendingIntent} for an activity
8382 * @return this object for method chaining
8383 * @see android.app.Notification.WearableExtender#getDisplayIntent
8384 */
8385 public WearableExtender setDisplayIntent(PendingIntent intent) {
8386 mDisplayIntent = intent;
8387 return this;
8388 }
8389
8390 /**
8391 * Get the intent to launch inside of an activity view when displaying this
8392 * notification. This {@code PendingIntent} should be for an activity.
8393 */
8394 public PendingIntent getDisplayIntent() {
8395 return mDisplayIntent;
8396 }
8397
8398 /**
8399 * Add an additional page of content to display with this notification. The current
8400 * notification forms the first page, and pages added using this function form
8401 * subsequent pages. This field can be used to separate a notification into multiple
8402 * sections.
8403 *
8404 * @param page the notification to add as another page
8405 * @return this object for method chaining
8406 * @see android.app.Notification.WearableExtender#getPages
8407 */
8408 public WearableExtender addPage(Notification page) {
8409 mPages.add(page);
8410 return this;
8411 }
8412
8413 /**
8414 * Add additional pages of content to display with this notification. The current
8415 * notification forms the first page, and pages added using this function form
8416 * subsequent pages. This field can be used to separate a notification into multiple
8417 * sections.
8418 *
8419 * @param pages a list of notifications
8420 * @return this object for method chaining
8421 * @see android.app.Notification.WearableExtender#getPages
8422 */
8423 public WearableExtender addPages(List<Notification> pages) {
8424 mPages.addAll(pages);
8425 return this;
8426 }
8427
8428 /**
8429 * Clear all additional pages present on this builder.
8430 * @return this object for method chaining.
8431 * @see #addPage
8432 */
8433 public WearableExtender clearPages() {
8434 mPages.clear();
8435 return this;
8436 }
8437
8438 /**
8439 * Get the array of additional pages of content for displaying this notification. The
8440 * current notification forms the first page, and elements within this array form
8441 * subsequent pages. This field can be used to separate a notification into multiple
8442 * sections.
8443 * @return the pages for this notification
8444 */
8445 public List<Notification> getPages() {
8446 return mPages;
8447 }
8448
8449 /**
8450 * Set a background image to be displayed behind the notification content.
8451 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8452 * will work with any notification style.
8453 *
8454 * @param background the background bitmap
8455 * @return this object for method chaining
8456 * @see android.app.Notification.WearableExtender#getBackground
8457 */
8458 public WearableExtender setBackground(Bitmap background) {
8459 mBackground = background;
8460 return this;
8461 }
8462
8463 /**
8464 * Get a background image to be displayed behind the notification content.
8465 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
8466 * will work with any notification style.
8467 *
8468 * @return the background image
8469 * @see android.app.Notification.WearableExtender#setBackground
8470 */
8471 public Bitmap getBackground() {
8472 return mBackground;
8473 }
8474
8475 /**
8476 * Set an icon that goes with the content of this notification.
8477 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008478 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008479 public WearableExtender setContentIcon(int icon) {
8480 mContentIcon = icon;
8481 return this;
8482 }
8483
8484 /**
8485 * Get an icon that goes with the content of this notification.
8486 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008487 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008488 public int getContentIcon() {
8489 return mContentIcon;
8490 }
8491
8492 /**
8493 * Set the gravity that the content icon should have within the notification display.
8494 * Supported values include {@link android.view.Gravity#START} and
8495 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8496 * @see #setContentIcon
8497 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008498 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008499 public WearableExtender setContentIconGravity(int contentIconGravity) {
8500 mContentIconGravity = contentIconGravity;
8501 return this;
8502 }
8503
8504 /**
8505 * Get the gravity that the content icon should have within the notification display.
8506 * Supported values include {@link android.view.Gravity#START} and
8507 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
8508 * @see #getContentIcon
8509 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008510 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008511 public int getContentIconGravity() {
8512 return mContentIconGravity;
8513 }
8514
8515 /**
8516 * Set an action from this notification's actions to be clickable with the content of
Griff Hazen14f57992014-05-26 09:07:14 -07008517 * this notification. This action will no longer display separately from the
8518 * notification's content.
8519 *
Griff Hazenca48d352014-05-28 22:37:13 -07008520 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008521 * set, although the list of available actions comes from the main notification and not
8522 * from the child page's notification.
8523 *
8524 * @param actionIndex The index of the action to hoist onto the current notification page.
8525 * If wearable actions were added to the main notification, this index
8526 * will apply to that list, otherwise it will apply to the regular
8527 * actions list.
Griff Hazen61a9e862014-05-22 16:05:19 -07008528 */
8529 public WearableExtender setContentAction(int actionIndex) {
8530 mContentActionIndex = actionIndex;
8531 return this;
8532 }
8533
8534 /**
Griff Hazenca48d352014-05-28 22:37:13 -07008535 * Get the index of the notification action, if any, that was specified as being clickable
8536 * with the content of this notification. This action will no longer display separately
Griff Hazen14f57992014-05-26 09:07:14 -07008537 * from the notification's content.
Griff Hazen61a9e862014-05-22 16:05:19 -07008538 *
Griff Hazenca48d352014-05-28 22:37:13 -07008539 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07008540 * set, although the list of available actions comes from the main notification and not
8541 * from the child page's notification.
8542 *
8543 * <p>If wearable specific actions were added to the main notification, this index will
8544 * apply to that list, otherwise it will apply to the regular actions list.
Griff Hazenca48d352014-05-28 22:37:13 -07008545 *
8546 * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected.
Griff Hazen61a9e862014-05-22 16:05:19 -07008547 */
8548 public int getContentAction() {
8549 return mContentActionIndex;
8550 }
8551
8552 /**
8553 * Set the gravity that this notification should have within the available viewport space.
8554 * Supported values include {@link android.view.Gravity#TOP},
8555 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8556 * The default value is {@link android.view.Gravity#BOTTOM}.
8557 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008558 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008559 public WearableExtender setGravity(int gravity) {
8560 mGravity = gravity;
8561 return this;
8562 }
8563
8564 /**
8565 * Get the gravity that this notification should have within the available viewport space.
8566 * Supported values include {@link android.view.Gravity#TOP},
8567 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
8568 * The default value is {@link android.view.Gravity#BOTTOM}.
8569 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008570 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008571 public int getGravity() {
8572 return mGravity;
8573 }
8574
8575 /**
8576 * Set the custom size preset for the display of this notification out of the available
8577 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8578 * {@link #SIZE_LARGE}.
8579 * <p>Some custom size presets are only applicable for custom display notifications created
8580 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the
8581 * documentation for the preset in question. See also
8582 * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}.
8583 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008584 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008585 public WearableExtender setCustomSizePreset(int sizePreset) {
8586 mCustomSizePreset = sizePreset;
8587 return this;
8588 }
8589
8590 /**
8591 * Get the custom size preset for the display of this notification out of the available
8592 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
8593 * {@link #SIZE_LARGE}.
8594 * <p>Some custom size presets are only applicable for custom display notifications created
8595 * using {@link #setDisplayIntent}. Check the documentation for the preset in question.
8596 * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}.
8597 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008598 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008599 public int getCustomSizePreset() {
8600 return mCustomSizePreset;
8601 }
8602
8603 /**
8604 * Set the custom height in pixels for the display of this notification's content.
8605 * <p>This option is only available for custom display notifications created
8606 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also
8607 * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and
8608 * {@link #getCustomContentHeight}.
8609 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008610 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008611 public WearableExtender setCustomContentHeight(int height) {
8612 mCustomContentHeight = height;
8613 return this;
8614 }
8615
8616 /**
8617 * Get the custom height in pixels for the display of this notification's content.
8618 * <p>This option is only available for custom display notifications created
8619 * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and
8620 * {@link #setCustomContentHeight}.
8621 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008622 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008623 public int getCustomContentHeight() {
8624 return mCustomContentHeight;
8625 }
8626
8627 /**
8628 * Set whether the scrolling position for the contents of this notification should start
8629 * at the bottom of the contents instead of the top when the contents are too long to
8630 * display within the screen. Default is false (start scroll at the top).
8631 */
8632 public WearableExtender setStartScrollBottom(boolean startScrollBottom) {
8633 setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom);
8634 return this;
8635 }
8636
8637 /**
8638 * Get whether the scrolling position for the contents of this notification should start
8639 * at the bottom of the contents instead of the top when the contents are too long to
8640 * display within the screen. Default is false (start scroll at the top).
8641 */
8642 public boolean getStartScrollBottom() {
8643 return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0;
8644 }
8645
8646 /**
8647 * Set whether the content intent is available when the wearable device is not connected
8648 * to a companion device. The user can still trigger this intent when the wearable device
8649 * is offline, but a visual hint will indicate that the content intent may not be available.
8650 * Defaults to true.
8651 */
8652 public WearableExtender setContentIntentAvailableOffline(
8653 boolean contentIntentAvailableOffline) {
8654 setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline);
8655 return this;
8656 }
8657
8658 /**
8659 * Get whether the content intent is available when the wearable device is not connected
8660 * to a companion device. The user can still trigger this intent when the wearable device
8661 * is offline, but a visual hint will indicate that the content intent may not be available.
8662 * Defaults to true.
8663 */
8664 public boolean getContentIntentAvailableOffline() {
8665 return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0;
8666 }
8667
8668 /**
8669 * Set a hint that this notification's icon should not be displayed.
8670 * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise.
8671 * @return this object for method chaining
8672 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008673 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008674 public WearableExtender setHintHideIcon(boolean hintHideIcon) {
8675 setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon);
8676 return this;
8677 }
8678
8679 /**
8680 * Get a hint that this notification's icon should not be displayed.
8681 * @return {@code true} if this icon should not be displayed, false otherwise.
8682 * The default value is {@code false} if this was never set.
8683 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008684 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008685 public boolean getHintHideIcon() {
8686 return (mFlags & FLAG_HINT_HIDE_ICON) != 0;
8687 }
8688
8689 /**
8690 * Set a visual hint that only the background image of this notification should be
8691 * displayed, and other semantic content should be hidden. This hint is only applicable
8692 * to sub-pages added using {@link #addPage}.
8693 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008694 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008695 public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) {
8696 setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly);
8697 return this;
8698 }
8699
8700 /**
8701 * Get a visual hint that only the background image of this notification should be
8702 * displayed, and other semantic content should be hidden. This hint is only applicable
8703 * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}.
8704 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008705 @Deprecated
Griff Hazen61a9e862014-05-22 16:05:19 -07008706 public boolean getHintShowBackgroundOnly() {
8707 return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0;
8708 }
8709
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008710 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008711 * Set a hint that this notification's background should not be clipped if possible,
8712 * and should instead be resized to fully display on the screen, retaining the aspect
8713 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008714 * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
8715 * @return this object for method chaining
8716 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008717 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008718 public WearableExtender setHintAvoidBackgroundClipping(
8719 boolean hintAvoidBackgroundClipping) {
8720 setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping);
8721 return this;
8722 }
8723
8724 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08008725 * Get a hint that this notification's background should not be clipped if possible,
8726 * and should instead be resized to fully display on the screen, retaining the aspect
8727 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008728 * @return {@code true} if it's ok if the background is clipped on the screen, false
8729 * otherwise. The default value is {@code false} if this was never set.
8730 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008731 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008732 public boolean getHintAvoidBackgroundClipping() {
8733 return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0;
8734 }
8735
8736 /**
8737 * Set a hint that the screen should remain on for at least this duration when
8738 * this notification is displayed on the screen.
8739 * @param timeout The requested screen timeout in milliseconds. Can also be either
8740 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8741 * @return this object for method chaining
8742 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008743 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008744 public WearableExtender setHintScreenTimeout(int timeout) {
8745 mHintScreenTimeout = timeout;
8746 return this;
8747 }
8748
8749 /**
8750 * Get the duration, in milliseconds, that the screen should remain on for
8751 * when this notification is displayed.
8752 * @return the duration in milliseconds if > 0, or either one of the sentinel values
8753 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
8754 */
Gus Prevasb5f9cf52018-02-21 14:21:50 -05008755 @Deprecated
Griff Hazen5f2edfc2014-09-29 16:28:44 -07008756 public int getHintScreenTimeout() {
8757 return mHintScreenTimeout;
8758 }
8759
Alex Hills9ab3a232016-04-05 14:54:56 -04008760 /**
Alex Hills4bcb06b2016-04-05 14:26:25 -04008761 * Set a hint that this notification's {@link BigPictureStyle} (if present) should be
8762 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8763 * qr codes, as well as other simple black-and-white tickets.
8764 * @param hintAmbientBigPicture {@code true} to enable converstion and ambient.
8765 * @return this object for method chaining
8766 */
8767 public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) {
8768 setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture);
8769 return this;
8770 }
8771
8772 /**
8773 * Get a hint that this notification's {@link BigPictureStyle} (if present) should be
8774 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
8775 * qr codes, as well as other simple black-and-white tickets.
8776 * @return {@code true} if it should be displayed in ambient, false otherwise
8777 * otherwise. The default value is {@code false} if this was never set.
8778 */
8779 public boolean getHintAmbientBigPicture() {
8780 return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0;
8781 }
8782
8783 /**
Alex Hills9ab3a232016-04-05 14:54:56 -04008784 * Set a hint that this notification's content intent will launch an {@link Activity}
8785 * directly, telling the platform that it can generate the appropriate transitions.
8786 * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch
8787 * an activity and transitions should be generated, false otherwise.
8788 * @return this object for method chaining
8789 */
8790 public WearableExtender setHintContentIntentLaunchesActivity(
8791 boolean hintContentIntentLaunchesActivity) {
8792 setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity);
8793 return this;
8794 }
8795
8796 /**
8797 * Get a hint that this notification's content intent will launch an {@link Activity}
8798 * directly, telling the platform that it can generate the appropriate transitions
8799 * @return {@code true} if the content intent will launch an activity and transitions should
8800 * be generated, false otherwise. The default value is {@code false} if this was never set.
8801 */
8802 public boolean getHintContentIntentLaunchesActivity() {
8803 return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0;
8804 }
8805
Nadia Benbernou948627e2016-04-14 14:41:08 -04008806 /**
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008807 * Sets the dismissal id for this notification. If a notification is posted with a
8808 * dismissal id, then when that notification is canceled, notifications on other wearables
8809 * and the paired Android phone having that same dismissal id will also be canceled. See
Nadia Benbernou948627e2016-04-14 14:41:08 -04008810 * <a href="{@docRoot}wear/notifications/index.html">Adding Wearable Features to
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008811 * Notifications</a> for more information.
Nadia Benbernou948627e2016-04-14 14:41:08 -04008812 * @param dismissalId the dismissal id of the notification.
8813 * @return this object for method chaining
8814 */
8815 public WearableExtender setDismissalId(String dismissalId) {
8816 mDismissalId = dismissalId;
8817 return this;
8818 }
8819
8820 /**
8821 * Returns the dismissal id of the notification.
8822 * @return the dismissal id of the notification or null if it has not been set.
8823 */
8824 public String getDismissalId() {
8825 return mDismissalId;
8826 }
8827
Ariel Gertzenstein95ab5222016-09-02 17:00:16 -04008828 /**
8829 * Sets a bridge tag for this notification. A bridge tag can be set for notifications
8830 * posted from a phone to provide finer-grained control on what notifications are bridged
8831 * to wearables. See <a href="{@docRoot}wear/notifications/index.html">Adding Wearable
8832 * Features to Notifications</a> for more information.
8833 * @param bridgeTag the bridge tag of the notification.
8834 * @return this object for method chaining
8835 */
8836 public WearableExtender setBridgeTag(String bridgeTag) {
8837 mBridgeTag = bridgeTag;
8838 return this;
8839 }
8840
8841 /**
8842 * Returns the bridge tag of the notification.
8843 * @return the bridge tag or null if not present.
8844 */
8845 public String getBridgeTag() {
8846 return mBridgeTag;
8847 }
8848
Griff Hazen61a9e862014-05-22 16:05:19 -07008849 private void setFlag(int mask, boolean value) {
8850 if (value) {
8851 mFlags |= mask;
8852 } else {
8853 mFlags &= ~mask;
8854 }
8855 }
8856 }
8857
8858 /**
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008859 * <p>Helper class to add Android Auto extensions to notifications. To create a notification
8860 * with car extensions:
8861 *
8862 * <ol>
8863 * <li>Create an {@link Notification.Builder}, setting any desired
8864 * properties.
8865 * <li>Create a {@link CarExtender}.
8866 * <li>Set car-specific properties using the {@code add} and {@code set} methods of
8867 * {@link CarExtender}.
8868 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
8869 * to apply the extensions to a notification.
8870 * </ol>
8871 *
8872 * <pre class="prettyprint">
8873 * Notification notification = new Notification.Builder(context)
8874 * ...
8875 * .extend(new CarExtender()
8876 * .set*(...))
8877 * .build();
8878 * </pre>
8879 *
8880 * <p>Car extensions can be accessed on an existing notification by using the
8881 * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods
8882 * to access values.
8883 */
8884 public static final class CarExtender implements Extender {
8885 private static final String TAG = "CarExtender";
8886
8887 private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS";
8888 private static final String EXTRA_LARGE_ICON = "large_icon";
8889 private static final String EXTRA_CONVERSATION = "car_conversation";
8890 private static final String EXTRA_COLOR = "app_color";
8891
8892 private Bitmap mLargeIcon;
8893 private UnreadConversation mUnreadConversation;
8894 private int mColor = Notification.COLOR_DEFAULT;
8895
8896 /**
8897 * Create a {@link CarExtender} with default options.
8898 */
8899 public CarExtender() {
8900 }
8901
8902 /**
8903 * Create a {@link CarExtender} from the CarExtender options of an existing Notification.
8904 *
8905 * @param notif The notification from which to copy options.
8906 */
8907 public CarExtender(Notification notif) {
8908 Bundle carBundle = notif.extras == null ?
8909 null : notif.extras.getBundle(EXTRA_CAR_EXTENDER);
8910 if (carBundle != null) {
8911 mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON);
8912 mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT);
8913
8914 Bundle b = carBundle.getBundle(EXTRA_CONVERSATION);
8915 mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b);
8916 }
8917 }
8918
8919 /**
8920 * Apply car extensions to a notification that is being built. This is typically called by
8921 * the {@link Notification.Builder#extend(Notification.Extender)}
8922 * method of {@link Notification.Builder}.
8923 */
8924 @Override
8925 public Notification.Builder extend(Notification.Builder builder) {
8926 Bundle carExtensions = new Bundle();
8927
8928 if (mLargeIcon != null) {
8929 carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon);
8930 }
8931 if (mColor != Notification.COLOR_DEFAULT) {
8932 carExtensions.putInt(EXTRA_COLOR, mColor);
8933 }
8934
8935 if (mUnreadConversation != null) {
8936 Bundle b = mUnreadConversation.getBundleForUnreadConversation();
8937 carExtensions.putBundle(EXTRA_CONVERSATION, b);
8938 }
8939
8940 builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions);
8941 return builder;
8942 }
8943
8944 /**
8945 * Sets the accent color to use when Android Auto presents the notification.
8946 *
8947 * Android Auto uses the color set with {@link Notification.Builder#setColor(int)}
8948 * to accent the displayed notification. However, not all colors are acceptable in an
8949 * automotive setting. This method can be used to override the color provided in the
8950 * notification in such a situation.
8951 */
Tor Norbye80756e32015-03-02 09:39:27 -08008952 public CarExtender setColor(@ColorInt int color) {
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008953 mColor = color;
8954 return this;
8955 }
8956
8957 /**
8958 * Gets the accent color.
8959 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04008960 * @see #setColor
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008961 */
Tor Norbye80756e32015-03-02 09:39:27 -08008962 @ColorInt
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08008963 public int getColor() {
8964 return mColor;
8965 }
8966
8967 /**
8968 * Sets the large icon of the car notification.
8969 *
8970 * If no large icon is set in the extender, Android Auto will display the icon
8971 * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)}
8972 *
8973 * @param largeIcon The large icon to use in the car notification.
8974 * @return This object for method chaining.
8975 */
8976 public CarExtender setLargeIcon(Bitmap largeIcon) {
8977 mLargeIcon = largeIcon;
8978 return this;
8979 }
8980
8981 /**
8982 * Gets the large icon used in this car notification, or null if no icon has been set.
8983 *
8984 * @return The large icon for the car notification.
8985 * @see CarExtender#setLargeIcon
8986 */
8987 public Bitmap getLargeIcon() {
8988 return mLargeIcon;
8989 }
8990
8991 /**
8992 * Sets the unread conversation in a message notification.
8993 *
8994 * @param unreadConversation The unread part of the conversation this notification conveys.
8995 * @return This object for method chaining.
8996 */
8997 public CarExtender setUnreadConversation(UnreadConversation unreadConversation) {
8998 mUnreadConversation = unreadConversation;
8999 return this;
9000 }
9001
9002 /**
9003 * Returns the unread conversation conveyed by this notification.
9004 * @see #setUnreadConversation(UnreadConversation)
9005 */
9006 public UnreadConversation getUnreadConversation() {
9007 return mUnreadConversation;
9008 }
9009
9010 /**
9011 * A class which holds the unread messages from a conversation.
9012 */
9013 public static class UnreadConversation {
9014 private static final String KEY_AUTHOR = "author";
9015 private static final String KEY_TEXT = "text";
9016 private static final String KEY_MESSAGES = "messages";
9017 private static final String KEY_REMOTE_INPUT = "remote_input";
9018 private static final String KEY_ON_REPLY = "on_reply";
9019 private static final String KEY_ON_READ = "on_read";
9020 private static final String KEY_PARTICIPANTS = "participants";
9021 private static final String KEY_TIMESTAMP = "timestamp";
9022
9023 private final String[] mMessages;
9024 private final RemoteInput mRemoteInput;
9025 private final PendingIntent mReplyPendingIntent;
9026 private final PendingIntent mReadPendingIntent;
9027 private final String[] mParticipants;
9028 private final long mLatestTimestamp;
9029
9030 UnreadConversation(String[] messages, RemoteInput remoteInput,
9031 PendingIntent replyPendingIntent, PendingIntent readPendingIntent,
9032 String[] participants, long latestTimestamp) {
9033 mMessages = messages;
9034 mRemoteInput = remoteInput;
9035 mReadPendingIntent = readPendingIntent;
9036 mReplyPendingIntent = replyPendingIntent;
9037 mParticipants = participants;
9038 mLatestTimestamp = latestTimestamp;
9039 }
9040
9041 /**
9042 * Gets the list of messages conveyed by this notification.
9043 */
9044 public String[] getMessages() {
9045 return mMessages;
9046 }
9047
9048 /**
9049 * Gets the remote input that will be used to convey the response to a message list, or
9050 * null if no such remote input exists.
9051 */
9052 public RemoteInput getRemoteInput() {
9053 return mRemoteInput;
9054 }
9055
9056 /**
9057 * Gets the pending intent that will be triggered when the user replies to this
9058 * notification.
9059 */
9060 public PendingIntent getReplyPendingIntent() {
9061 return mReplyPendingIntent;
9062 }
9063
9064 /**
9065 * Gets the pending intent that Android Auto will send after it reads aloud all messages
9066 * in this object's message list.
9067 */
9068 public PendingIntent getReadPendingIntent() {
9069 return mReadPendingIntent;
9070 }
9071
9072 /**
9073 * Gets the participants in the conversation.
9074 */
9075 public String[] getParticipants() {
9076 return mParticipants;
9077 }
9078
9079 /**
9080 * Gets the firs participant in the conversation.
9081 */
9082 public String getParticipant() {
9083 return mParticipants.length > 0 ? mParticipants[0] : null;
9084 }
9085
9086 /**
9087 * Gets the timestamp of the conversation.
9088 */
9089 public long getLatestTimestamp() {
9090 return mLatestTimestamp;
9091 }
9092
9093 Bundle getBundleForUnreadConversation() {
9094 Bundle b = new Bundle();
9095 String author = null;
9096 if (mParticipants != null && mParticipants.length > 1) {
9097 author = mParticipants[0];
9098 }
9099 Parcelable[] messages = new Parcelable[mMessages.length];
9100 for (int i = 0; i < messages.length; i++) {
9101 Bundle m = new Bundle();
9102 m.putString(KEY_TEXT, mMessages[i]);
9103 m.putString(KEY_AUTHOR, author);
9104 messages[i] = m;
9105 }
9106 b.putParcelableArray(KEY_MESSAGES, messages);
9107 if (mRemoteInput != null) {
9108 b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput);
9109 }
9110 b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent);
9111 b.putParcelable(KEY_ON_READ, mReadPendingIntent);
9112 b.putStringArray(KEY_PARTICIPANTS, mParticipants);
9113 b.putLong(KEY_TIMESTAMP, mLatestTimestamp);
9114 return b;
9115 }
9116
9117 static UnreadConversation getUnreadConversationFromBundle(Bundle b) {
9118 if (b == null) {
9119 return null;
9120 }
9121 Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES);
9122 String[] messages = null;
9123 if (parcelableMessages != null) {
9124 String[] tmp = new String[parcelableMessages.length];
9125 boolean success = true;
9126 for (int i = 0; i < tmp.length; i++) {
9127 if (!(parcelableMessages[i] instanceof Bundle)) {
9128 success = false;
9129 break;
9130 }
9131 tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT);
9132 if (tmp[i] == null) {
9133 success = false;
9134 break;
9135 }
9136 }
9137 if (success) {
9138 messages = tmp;
9139 } else {
9140 return null;
9141 }
9142 }
9143
9144 PendingIntent onRead = b.getParcelable(KEY_ON_READ);
9145 PendingIntent onReply = b.getParcelable(KEY_ON_REPLY);
9146
9147 RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT);
9148
9149 String[] participants = b.getStringArray(KEY_PARTICIPANTS);
9150 if (participants == null || participants.length != 1) {
9151 return null;
9152 }
9153
9154 return new UnreadConversation(messages,
9155 remoteInput,
9156 onReply,
9157 onRead,
9158 participants, b.getLong(KEY_TIMESTAMP));
9159 }
9160 };
9161
9162 /**
9163 * Builder class for {@link CarExtender.UnreadConversation} objects.
9164 */
9165 public static class Builder {
9166 private final List<String> mMessages = new ArrayList<String>();
9167 private final String mParticipant;
9168 private RemoteInput mRemoteInput;
9169 private PendingIntent mReadPendingIntent;
9170 private PendingIntent mReplyPendingIntent;
9171 private long mLatestTimestamp;
9172
9173 /**
9174 * Constructs a new builder for {@link CarExtender.UnreadConversation}.
9175 *
9176 * @param name The name of the other participant in the conversation.
9177 */
9178 public Builder(String name) {
9179 mParticipant = name;
9180 }
9181
9182 /**
9183 * Appends a new unread message to the list of messages for this conversation.
9184 *
9185 * The messages should be added from oldest to newest.
9186 *
9187 * @param message The text of the new unread message.
9188 * @return This object for method chaining.
9189 */
9190 public Builder addMessage(String message) {
9191 mMessages.add(message);
9192 return this;
9193 }
9194
9195 /**
9196 * Sets the pending intent and remote input which will convey the reply to this
9197 * notification.
9198 *
9199 * @param pendingIntent The pending intent which will be triggered on a reply.
9200 * @param remoteInput The remote input parcelable which will carry the reply.
9201 * @return This object for method chaining.
9202 *
9203 * @see CarExtender.UnreadConversation#getRemoteInput
9204 * @see CarExtender.UnreadConversation#getReplyPendingIntent
9205 */
9206 public Builder setReplyAction(
9207 PendingIntent pendingIntent, RemoteInput remoteInput) {
9208 mRemoteInput = remoteInput;
9209 mReplyPendingIntent = pendingIntent;
9210
9211 return this;
9212 }
9213
9214 /**
9215 * Sets the pending intent that will be sent once the messages in this notification
9216 * are read.
9217 *
9218 * @param pendingIntent The pending intent to use.
9219 * @return This object for method chaining.
9220 */
9221 public Builder setReadPendingIntent(PendingIntent pendingIntent) {
9222 mReadPendingIntent = pendingIntent;
9223 return this;
9224 }
9225
9226 /**
9227 * Sets the timestamp of the most recent message in an unread conversation.
9228 *
9229 * If a messaging notification has been posted by your application and has not
9230 * yet been cancelled, posting a later notification with the same id and tag
9231 * but without a newer timestamp may result in Android Auto not displaying a
9232 * heads up notification for the later notification.
9233 *
9234 * @param timestamp The timestamp of the most recent message in the conversation.
9235 * @return This object for method chaining.
9236 */
9237 public Builder setLatestTimestamp(long timestamp) {
9238 mLatestTimestamp = timestamp;
9239 return this;
9240 }
9241
9242 /**
9243 * Builds a new unread conversation object.
9244 *
9245 * @return The new unread conversation object.
9246 */
9247 public UnreadConversation build() {
9248 String[] messages = mMessages.toArray(new String[mMessages.size()]);
9249 String[] participants = { mParticipant };
9250 return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent,
9251 mReadPendingIntent, participants, mLatestTimestamp);
9252 }
9253 }
9254 }
9255
9256 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009257 * <p>Helper class to add Android TV extensions to notifications. To create a notification
9258 * with a TV extension:
9259 *
9260 * <ol>
9261 * <li>Create an {@link Notification.Builder}, setting any desired properties.
9262 * <li>Create a {@link TvExtender}.
9263 * <li>Set TV-specific properties using the {@code set} methods of
9264 * {@link TvExtender}.
9265 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
9266 * to apply the extension to a notification.
9267 * </ol>
9268 *
9269 * <pre class="prettyprint">
9270 * Notification notification = new Notification.Builder(context)
9271 * ...
9272 * .extend(new TvExtender()
9273 * .set*(...))
9274 * .build();
9275 * </pre>
9276 *
9277 * <p>TV extensions can be accessed on an existing notification by using the
9278 * {@code TvExtender(Notification)} constructor, and then using the {@code get} methods
9279 * to access values.
9280 *
9281 * @hide
9282 */
9283 @SystemApi
9284 public static final class TvExtender implements Extender {
9285 private static final String TAG = "TvExtender";
9286
9287 private static final String EXTRA_TV_EXTENDER = "android.tv.EXTENSIONS";
9288 private static final String EXTRA_FLAGS = "flags";
9289 private static final String EXTRA_CONTENT_INTENT = "content_intent";
9290 private static final String EXTRA_DELETE_INTENT = "delete_intent";
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009291 private static final String EXTRA_CHANNEL_ID = "channel_id";
Rhiannon Malia1a083932018-01-24 15:02:30 -08009292 private static final String EXTRA_SUPPRESS_SHOW_OVER_APPS = "suppressShowOverApps";
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009293
9294 // Flags bitwise-ored to mFlags
9295 private static final int FLAG_AVAILABLE_ON_TV = 0x1;
9296
9297 private int mFlags;
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009298 private String mChannelId;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009299 private PendingIntent mContentIntent;
9300 private PendingIntent mDeleteIntent;
Rhiannon Malia1a083932018-01-24 15:02:30 -08009301 private boolean mSuppressShowOverApps;
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009302
9303 /**
9304 * Create a {@link TvExtender} with default options.
9305 */
9306 public TvExtender() {
9307 mFlags = FLAG_AVAILABLE_ON_TV;
9308 }
9309
9310 /**
9311 * Create a {@link TvExtender} from the TvExtender options of an existing Notification.
9312 *
9313 * @param notif The notification from which to copy options.
9314 */
9315 public TvExtender(Notification notif) {
9316 Bundle bundle = notif.extras == null ?
9317 null : notif.extras.getBundle(EXTRA_TV_EXTENDER);
9318 if (bundle != null) {
9319 mFlags = bundle.getInt(EXTRA_FLAGS);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009320 mChannelId = bundle.getString(EXTRA_CHANNEL_ID);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009321 mSuppressShowOverApps = bundle.getBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009322 mContentIntent = bundle.getParcelable(EXTRA_CONTENT_INTENT);
9323 mDeleteIntent = bundle.getParcelable(EXTRA_DELETE_INTENT);
9324 }
9325 }
9326
9327 /**
9328 * Apply a TV extension to a notification that is being built. This is typically called by
9329 * the {@link Notification.Builder#extend(Notification.Extender)}
9330 * method of {@link Notification.Builder}.
9331 */
9332 @Override
9333 public Notification.Builder extend(Notification.Builder builder) {
9334 Bundle bundle = new Bundle();
9335
9336 bundle.putInt(EXTRA_FLAGS, mFlags);
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009337 bundle.putString(EXTRA_CHANNEL_ID, mChannelId);
Rhiannon Malia1a083932018-01-24 15:02:30 -08009338 bundle.putBoolean(EXTRA_SUPPRESS_SHOW_OVER_APPS, mSuppressShowOverApps);
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009339 if (mContentIntent != null) {
9340 bundle.putParcelable(EXTRA_CONTENT_INTENT, mContentIntent);
9341 }
9342
9343 if (mDeleteIntent != null) {
9344 bundle.putParcelable(EXTRA_DELETE_INTENT, mDeleteIntent);
9345 }
9346
9347 builder.getExtras().putBundle(EXTRA_TV_EXTENDER, bundle);
9348 return builder;
9349 }
9350
9351 /**
9352 * Returns true if this notification should be shown on TV. This method return true
9353 * if the notification was extended with a TvExtender.
9354 */
9355 public boolean isAvailableOnTv() {
9356 return (mFlags & FLAG_AVAILABLE_ON_TV) != 0;
9357 }
9358
9359 /**
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009360 * Specifies the channel the notification should be delivered on when shown on TV.
9361 * It can be different from the channel that the notification is delivered to when
9362 * posting on a non-TV device.
9363 */
9364 public TvExtender setChannel(String channelId) {
9365 mChannelId = channelId;
9366 return this;
9367 }
9368
9369 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009370 * Specifies the channel the notification should be delivered on when shown on TV.
9371 * It can be different from the channel that the notification is delivered to when
9372 * posting on a non-TV device.
9373 */
9374 public TvExtender setChannelId(String channelId) {
9375 mChannelId = channelId;
9376 return this;
9377 }
9378
Jeff Sharkey000ce802017-04-29 13:13:27 -06009379 /** @removed */
9380 @Deprecated
Dmitri Plotnikovb8a04ee2017-01-20 10:39:22 -08009381 public String getChannel() {
9382 return mChannelId;
9383 }
9384
9385 /**
Julia Reynoldsbad42972017-04-25 13:52:49 -04009386 * Returns the id of the channel this notification posts to on TV.
9387 */
9388 public String getChannelId() {
9389 return mChannelId;
9390 }
9391
9392 /**
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009393 * Supplies a {@link PendingIntent} to be sent when the notification is selected on TV.
9394 * If provided, it is used instead of the content intent specified
9395 * at the level of Notification.
9396 */
9397 public TvExtender setContentIntent(PendingIntent intent) {
9398 mContentIntent = intent;
9399 return this;
9400 }
9401
9402 /**
9403 * Returns the TV-specific content intent. If this method returns null, the
9404 * main content intent on the notification should be used.
9405 *
9406 * @see {@link Notification#contentIntent}
9407 */
9408 public PendingIntent getContentIntent() {
9409 return mContentIntent;
9410 }
9411
9412 /**
9413 * Supplies a {@link PendingIntent} to send when the notification is cleared explicitly
9414 * by the user on TV. If provided, it is used instead of the delete intent specified
9415 * at the level of Notification.
9416 */
9417 public TvExtender setDeleteIntent(PendingIntent intent) {
9418 mDeleteIntent = intent;
9419 return this;
9420 }
9421
9422 /**
9423 * Returns the TV-specific delete intent. If this method returns null, the
9424 * main delete intent on the notification should be used.
9425 *
9426 * @see {@link Notification#deleteIntent}
9427 */
9428 public PendingIntent getDeleteIntent() {
9429 return mDeleteIntent;
9430 }
Rhiannon Malia1a083932018-01-24 15:02:30 -08009431
9432 /**
9433 * Specifies whether this notification should suppress showing a message over top of apps
9434 * outside of the launcher.
9435 */
9436 public TvExtender setSuppressShowOverApps(boolean suppress) {
9437 mSuppressShowOverApps = suppress;
9438 return this;
9439 }
9440
9441 /**
9442 * Returns true if this notification should not show messages over top of apps
9443 * outside of the launcher.
9444 */
9445 public boolean getSuppressShowOverApps() {
9446 return mSuppressShowOverApps;
9447 }
Dmitri Plotnikov9e9cfd92016-12-21 10:52:26 -08009448 }
9449
9450 /**
Griff Hazen61a9e862014-05-22 16:05:19 -07009451 * Get an array of Notification objects from a parcelable array bundle field.
9452 * Update the bundle to have a typed array so fetches in the future don't need
9453 * to do an array copy.
9454 */
9455 private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) {
9456 Parcelable[] array = bundle.getParcelableArray(key);
9457 if (array instanceof Notification[] || array == null) {
9458 return (Notification[]) array;
9459 }
9460 Notification[] typedArray = Arrays.copyOf(array, array.length,
9461 Notification[].class);
9462 bundle.putParcelableArray(key, typedArray);
9463 return typedArray;
9464 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02009465
9466 private static class BuilderRemoteViews extends RemoteViews {
9467 public BuilderRemoteViews(Parcel parcel) {
9468 super(parcel);
9469 }
9470
Kenny Guy77320062014-08-27 21:37:15 +01009471 public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) {
9472 super(appInfo, layoutId);
Christoph Studer4600f9b2014-07-22 22:44:43 +02009473 }
9474
9475 @Override
9476 public BuilderRemoteViews clone() {
9477 Parcel p = Parcel.obtain();
9478 writeToParcel(p, 0);
9479 p.setDataPosition(0);
9480 BuilderRemoteViews brv = new BuilderRemoteViews(p);
9481 p.recycle();
9482 return brv;
9483 }
9484 }
Adrian Roos70d7aa32017-01-11 15:39:06 -08009485
Selim Cinek384804b2018-04-18 14:31:07 +08009486 /**
9487 * A result object where information about the template that was created is saved.
9488 */
9489 private static class TemplateBindResult {
Selim Cinek1c72fa02018-04-23 18:00:54 +08009490 int mIconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009491
9492 /**
Selim Cinek1c72fa02018-04-23 18:00:54 +08009493 * Get the margin end that needs to be added to any fields that may overlap
Selim Cinek384804b2018-04-18 14:31:07 +08009494 * with the right actions.
9495 */
Selim Cinek1c72fa02018-04-23 18:00:54 +08009496 public int getIconMarginEnd() {
9497 return mIconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009498 }
9499
Selim Cinek1c72fa02018-04-23 18:00:54 +08009500 public void setIconMarginEnd(int iconMarginEnd) {
9501 this.mIconMarginEnd = iconMarginEnd;
Selim Cinek384804b2018-04-18 14:31:07 +08009502 }
9503 }
9504
Adrian Roos70d7aa32017-01-11 15:39:06 -08009505 private static class StandardTemplateParams {
9506 boolean hasProgress = true;
9507 boolean ambient = false;
9508 CharSequence title;
9509 CharSequence text;
Selim Cinekafeed292017-12-12 17:32:44 -08009510 CharSequence headerTextSecondary;
Selim Cinek88188f22017-09-19 16:46:56 -07009511 boolean hideLargeIcon;
Selim Cinek384804b2018-04-18 14:31:07 +08009512 boolean hideReplyIcon;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009513
9514 final StandardTemplateParams reset() {
9515 hasProgress = true;
9516 ambient = false;
9517 title = null;
9518 text = null;
Selim Cinekafeed292017-12-12 17:32:44 -08009519 headerTextSecondary = null;
Adrian Roos70d7aa32017-01-11 15:39:06 -08009520 return this;
9521 }
9522
9523 final StandardTemplateParams hasProgress(boolean hasProgress) {
9524 this.hasProgress = hasProgress;
9525 return this;
9526 }
9527
9528 final StandardTemplateParams title(CharSequence title) {
9529 this.title = title;
9530 return this;
9531 }
9532
9533 final StandardTemplateParams text(CharSequence text) {
9534 this.text = text;
9535 return this;
9536 }
9537
Selim Cinekafeed292017-12-12 17:32:44 -08009538 final StandardTemplateParams headerTextSecondary(CharSequence text) {
9539 this.headerTextSecondary = text;
9540 return this;
9541 }
9542
Selim Cinek384804b2018-04-18 14:31:07 +08009543 final StandardTemplateParams hideLargeIcon(boolean hideLargeIcon) {
9544 this.hideLargeIcon = hideLargeIcon;
Selim Cinek88188f22017-09-19 16:46:56 -07009545 return this;
9546 }
9547
Selim Cinek384804b2018-04-18 14:31:07 +08009548 final StandardTemplateParams hideReplyIcon(boolean hideReplyIcon) {
9549 this.hideReplyIcon = hideReplyIcon;
Selim Cinek88188f22017-09-19 16:46:56 -07009550 return this;
9551 }
9552
Adrian Roos70d7aa32017-01-11 15:39:06 -08009553 final StandardTemplateParams ambient(boolean ambient) {
Adrian Roos0bc3f6a2017-03-06 11:54:05 -08009554 Preconditions.checkState(title == null && text == null, "must set ambient before text");
Adrian Roos70d7aa32017-01-11 15:39:06 -08009555 this.ambient = ambient;
9556 return this;
9557 }
9558
9559 final StandardTemplateParams fillTextsFrom(Builder b) {
9560 Bundle extras = b.mN.extras;
Lucas Dupin06c5e642017-09-13 16:34:58 -07009561 this.title = b.processLegacyText(extras.getCharSequence(EXTRA_TITLE), ambient);
9562
9563 // Big text notifications should contain their content when viewed in ambient mode.
9564 CharSequence text = extras.getCharSequence(EXTRA_BIG_TEXT);
9565 if (!ambient || TextUtils.isEmpty(text)) {
9566 text = extras.getCharSequence(EXTRA_TEXT);
9567 }
9568 this.text = b.processLegacyText(text, ambient);
Adrian Roos70d7aa32017-01-11 15:39:06 -08009569 return this;
9570 }
9571 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009572}