blob: 2e37db2fef24f32b94bfe6ff96e3209ace750c62 [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
Tor Norbye80756e32015-03-02 09:39:27 -080019import android.annotation.ColorInt;
Tor Norbye7b9c9122013-05-30 16:48:33 -070020import android.annotation.DrawableRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070021import android.annotation.IntDef;
Daniel Sandler01df1c62014-06-09 10:54:01 -040022import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
Julia Reynoldse46bb372016-03-17 11:05:58 -040024import android.annotation.SystemApi;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080025import android.content.Context;
26import android.content.Intent;
Kenny Guy77320062014-08-27 21:37:15 +010027import android.content.pm.ApplicationInfo;
Dan Sandler732bd6c2016-04-12 14:20:32 -040028import android.content.pm.PackageManager;
Christoph Studer4600f9b2014-07-22 22:44:43 +020029import android.content.pm.PackageManager.NameNotFoundException;
Jorim Jaggief72a192014-08-26 21:57:46 +020030import android.content.res.ColorStateList;
Joe Onoratoef1e7762010-09-17 18:38:38 -040031import android.graphics.Bitmap;
Kenny Guy8a0101b2014-05-08 23:34:12 +010032import android.graphics.Canvas;
Adrian Roosc1a80b02016-04-05 14:54:55 -070033import android.graphics.Color;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +010034import android.graphics.PorterDuff;
Kenny Guy8a0101b2014-05-08 23:34:12 +010035import android.graphics.drawable.Drawable;
Dan Sandlerd63f9322015-05-06 15:18:49 -040036import android.graphics.drawable.Icon;
John Spurlockc0650f022014-07-19 13:22:39 -040037import android.media.AudioAttributes;
Jeff Sharkey098d5802012-04-26 17:30:34 -070038import android.media.AudioManager;
Jeff Browndba34ba2014-06-24 20:46:03 -070039import android.media.session.MediaSession;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080040import android.net.Uri;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -040041import android.os.BadParcelableException;
Svet Ganovddb94882016-06-23 19:55:24 -070042import android.os.BaseBundle;
Christoph Studer239f8352014-08-25 15:13:18 +020043import android.os.Build;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050044import android.os.Bundle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080045import android.os.Parcel;
46import android.os.Parcelable;
Daniel Sandlera2985ed2012-04-03 16:42:00 -040047import android.os.SystemClock;
Jeff Sharkey6d515712012-09-20 16:06:08 -070048import android.os.UserHandle;
Adrian Roosc1a80b02016-04-05 14:54:55 -070049import android.text.BidiFormatter;
Selim Cinek60a54252016-02-26 17:03:25 -080050import android.text.SpannableStringBuilder;
51import android.text.Spanned;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080052import android.text.TextUtils;
Selim Cinek60a54252016-02-26 17:03:25 -080053import android.text.style.AbsoluteSizeSpan;
Selim Cinek89991a22016-03-07 19:51:54 -080054import android.text.style.CharacterStyle;
Selim Cinek60a54252016-02-26 17:03:25 -080055import android.text.style.RelativeSizeSpan;
56import android.text.style.TextAppearanceSpan;
Svet Ganovddb94882016-06-23 19:55:24 -070057import android.util.ArraySet;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -040058import android.util.Log;
Dan Sandler50128532015-12-08 15:42:41 -050059import android.util.SparseArray;
Griff Hazen61a9e862014-05-22 16:05:19 -070060import android.view.Gravity;
Selim Cinekea4bef72015-12-02 15:51:10 -080061import android.view.NotificationHeaderView;
Joe Onorato8595a3d2010-11-19 18:12:07 -080062import android.view.View;
Selim Cinek954cc232016-05-20 13:29:23 -070063import android.view.ViewGroup;
Jeff Sharkey1c400132011-08-05 14:50:13 -070064import android.widget.ProgressBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080065import android.widget.RemoteViews;
66
Griff Hazen959591e2014-05-15 22:26:18 -070067import com.android.internal.R;
Svet Ganovddb94882016-06-23 19:55:24 -070068import com.android.internal.util.ArrayUtils;
Griff Hazenc091ba82014-05-16 10:13:26 -070069import com.android.internal.util.NotificationColorUtil;
Griff Hazen959591e2014-05-15 22:26:18 -070070
Tor Norbyed9273d62013-05-30 15:59:53 -070071import java.lang.annotation.Retention;
72import java.lang.annotation.RetentionPolicy;
Christoph Studer4600f9b2014-07-22 22:44:43 +020073import java.lang.reflect.Constructor;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050074import java.util.ArrayList;
Griff Hazen61a9e862014-05-22 16:05:19 -070075import java.util.Arrays;
Svet Ganovddb94882016-06-23 19:55:24 -070076import java.util.Collection;
Griff Hazen5cadc3b2014-05-20 09:55:39 -070077import java.util.Collections;
Griff Hazen61a9e862014-05-22 16:05:19 -070078import java.util.List;
Dan Sandler50128532015-12-08 15:42:41 -050079import java.util.Set;
Joe Onorato561d3852010-11-20 18:09:34 -080080
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080081/**
82 * A class that represents how a persistent notification is to be presented to
83 * the user using the {@link android.app.NotificationManager}.
84 *
Joe Onoratocb109a02011-01-18 17:57:41 -080085 * <p>The {@link Notification.Builder Notification.Builder} has been added to make it
86 * easier to construct Notifications.</p>
87 *
Joe Fernandez558459f2011-10-13 16:47:36 -070088 * <div class="special reference">
89 * <h3>Developer Guides</h3>
90 * <p>For a guide to creating notifications, read the
91 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Status Bar Notifications</a>
92 * developer guide.</p>
93 * </div>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080094 */
95public class Notification implements Parcelable
96{
Daniel Sandlerdcbaf662013-04-26 16:23:09 -040097 private static final String TAG = "Notification";
98
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080099 /**
Daniel Sandler01df1c62014-06-09 10:54:01 -0400100 * An activity that provides a user interface for adjusting notification preferences for its
101 * containing application. Optional but recommended for apps that post
102 * {@link android.app.Notification Notifications}.
103 */
104 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
105 public static final String INTENT_CATEGORY_NOTIFICATION_PREFERENCES
106 = "android.intent.category.NOTIFICATION_PREFERENCES";
107
108 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800109 * Use all default values (where applicable).
110 */
111 public static final int DEFAULT_ALL = ~0;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500112
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800113 /**
114 * Use the default notification sound. This will ignore any given
115 * {@link #sound}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500116 *
Chris Wren47c20a12014-06-18 17:27:29 -0400117 * <p>
118 * A notification that is noisy is more likely to be presented as a heads-up notification.
119 * </p>
120 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800121 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500122 */
123
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800124 public static final int DEFAULT_SOUND = 1;
125
126 /**
127 * Use the default notification vibrate. This will ignore any given
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500128 * {@link #vibrate}. Using phone vibration requires the
Scott Mainb8b36452009-04-26 15:50:49 -0700129 * {@link android.Manifest.permission#VIBRATE VIBRATE} permission.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500130 *
Chris Wren47c20a12014-06-18 17:27:29 -0400131 * <p>
132 * A notification that vibrates is more likely to be presented as a heads-up notification.
133 * </p>
134 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800135 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500136 */
137
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800138 public static final int DEFAULT_VIBRATE = 2;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500139
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800140 /**
141 * Use the default notification lights. This will ignore the
142 * {@link #FLAG_SHOW_LIGHTS} bit, and {@link #ledARGB}, {@link #ledOffMS}, or
143 * {@link #ledOnMS}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500144 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800145 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500146 */
147
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800148 public static final int DEFAULT_LIGHTS = 4;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500149
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800150 /**
Christoph Studer535ec612014-09-03 15:47:47 +0200151 * Maximum length of CharSequences accepted by Builder and friends.
152 *
153 * <p>
154 * Avoids spamming the system with overly large strings such as full e-mails.
155 */
156 private static final int MAX_CHARSEQUENCE_LENGTH = 5 * 1024;
157
158 /**
Adrian Roose458aa82015-12-08 16:17:19 -0800159 * Maximum entries of reply text that are accepted by Builder and friends.
160 */
161 private static final int MAX_REPLY_HISTORY = 5;
162
163 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500164 * A timestamp related to this notification, in milliseconds since the epoch.
Joe Malin8d40d042012-11-05 11:36:40 -0800165 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500166 * Default value: {@link System#currentTimeMillis() Now}.
167 *
168 * Choose a timestamp that will be most relevant to the user. For most finite events, this
169 * corresponds to the time the event happened (or will happen, in the case of events that have
170 * yet to occur but about which the user is being informed). Indefinite events should be
Joe Malin8d40d042012-11-05 11:36:40 -0800171 * timestamped according to when the activity began.
172 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500173 * Some examples:
Joe Malin8d40d042012-11-05 11:36:40 -0800174 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500175 * <ul>
176 * <li>Notification of a new chat message should be stamped when the message was received.</li>
177 * <li>Notification of an ongoing file download (with a progress bar, for example) should be stamped when the download started.</li>
178 * <li>Notification of a completed file download should be stamped when the download finished.</li>
179 * <li>Notification of an upcoming meeting should be stamped with the time the meeting will begin (that is, in the future).</li>
180 * <li>Notification of an ongoing stopwatch (increasing timer) should be stamped with the watch's start time.
181 * <li>Notification of an ongoing countdown timer should be stamped with the timer's end time.
Joe Malin8d40d042012-11-05 11:36:40 -0800182 * </ul>
183 *
Selim Cinek0ff1ce602016-04-05 18:27:16 -0700184 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not shown
185 * anymore by default and must be opted into by using
186 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800187 */
188 public long when;
189
190 /**
Selim Cinekb85f36fd2016-04-20 18:46:36 -0700191 * The creation time of the notification
192 */
193 private long creationTime;
194
195 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800196 * The resource id of a drawable to use as the icon in the status bar.
Dan Sandler86647982015-05-13 23:41:13 -0400197 *
198 * @deprecated Use {@link Builder#setSmallIcon(Icon)} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800199 */
Dan Sandler86647982015-05-13 23:41:13 -0400200 @Deprecated
Tor Norbye7b9c9122013-05-30 16:48:33 -0700201 @DrawableRes
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800202 public int icon;
203
204 /**
Joe Onorato46439ce2010-11-19 13:56:21 -0800205 * If the icon in the status bar is to have more than one level, you can set this. Otherwise,
206 * leave it at its default value of 0.
207 *
208 * @see android.widget.ImageView#setImageLevel
Griff Hazen959591e2014-05-15 22:26:18 -0700209 * @see android.graphics.drawable.Drawable#setLevel
Joe Onorato46439ce2010-11-19 13:56:21 -0800210 */
211 public int iconLevel;
212
213 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500214 * The number of events that this notification represents. For example, in a new mail
215 * notification, this could be the number of unread messages.
Joe Malin8d40d042012-11-05 11:36:40 -0800216 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500217 * The system may or may not use this field to modify the appearance of the notification. For
218 * example, before {@link android.os.Build.VERSION_CODES#HONEYCOMB}, this number was
219 * superimposed over the icon in the status bar. Starting with
220 * {@link android.os.Build.VERSION_CODES#HONEYCOMB}, the template used by
221 * {@link Notification.Builder} has displayed the number in the expanded notification view.
Joe Malin8d40d042012-11-05 11:36:40 -0800222 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500223 * If the number is 0 or negative, it is never shown.
Selim Cinek0f9dd1e2016-04-05 17:03:40 -0700224 *
225 * @deprecated this number is not shown anymore
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800226 */
227 public int number;
228
229 /**
230 * The intent to execute when the expanded status entry is clicked. If
231 * this is an activity, it must include the
232 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -0800233 * that you take care of task management as described in the
234 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
Dianne Hackborn6ceca582012-01-10 15:24:26 -0800235 * Stack</a> document. In particular, make sure to read the notification section
236 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html#HandlingNotifications">Handling
237 * Notifications</a> for the correct ways to launch an application from a
238 * notification.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800239 */
240 public PendingIntent contentIntent;
241
242 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500243 * The intent to execute when the notification is explicitly dismissed by the user, either with
244 * the "Clear All" button or by swiping it away individually.
245 *
246 * This probably shouldn't be launching an activity since several of those will be sent
247 * at the same time.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800248 */
249 public PendingIntent deleteIntent;
250
251 /**
Dianne Hackborn170bae72010-09-03 15:14:28 -0700252 * An intent to launch instead of posting the notification to the status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -0800253 *
Chris Wren47c20a12014-06-18 17:27:29 -0400254 * <p>
255 * The system UI may choose to display a heads-up notification, instead of
256 * launching this intent, while the user is using the device.
257 * </p>
258 *
Joe Onoratocb109a02011-01-18 17:57:41 -0800259 * @see Notification.Builder#setFullScreenIntent
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400260 */
261 public PendingIntent fullScreenIntent;
262
263 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400264 * Text that summarizes this notification for accessibility services.
265 *
266 * As of the L release, this text is no longer shown on screen, but it is still useful to
267 * accessibility services (where it serves as an audible announcement of the notification's
268 * appearance).
Joe Onoratoef1e7762010-09-17 18:38:38 -0400269 *
Joe Onorato46439ce2010-11-19 13:56:21 -0800270 * @see #tickerView
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800271 */
272 public CharSequence tickerText;
273
274 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400275 * Formerly, a view showing the {@link #tickerText}.
276 *
277 * No longer displayed in the status bar as of API 21.
Joe Onoratoef1e7762010-09-17 18:38:38 -0400278 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400279 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -0800280 public RemoteViews tickerView;
Joe Onoratoef1e7762010-09-17 18:38:38 -0400281
282 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400283 * The view that will represent this notification in the notification list (which is pulled
284 * down from the status bar).
285 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500286 * As of N, this field may be null. The notification view is determined by the inputs
287 * to {@link Notification.Builder}; a custom RemoteViews can optionally be
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400288 * supplied with {@link Notification.Builder#setCustomContentView(RemoteViews)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800289 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400290 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800291 public RemoteViews contentView;
292
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400293 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -0400294 * A large-format version of {@link #contentView}, giving the Notification an
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400295 * opportunity to show more detail. The system UI may choose to show this
296 * instead of the normal content view at its discretion.
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400297 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500298 * As of N, this field may be null. The expanded notification view is determined by the
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400299 * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
300 * supplied with {@link Notification.Builder#setCustomBigContentView(RemoteViews)}.
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400301 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400302 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400303 public RemoteViews bigContentView;
304
Chris Wren8fd39ec2014-02-27 17:43:26 -0500305
306 /**
Chris Wren47c20a12014-06-18 17:27:29 -0400307 * A medium-format version of {@link #contentView}, providing the Notification an
308 * opportunity to add action buttons to contentView. At its discretion, the system UI may
309 * choose to show this as a heads-up notification, which will pop up so the user can see
310 * it without leaving their current activity.
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400311 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500312 * As of N, this field may be null. The heads-up notification view is determined by the
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400313 * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
314 * supplied with {@link Notification.Builder#setCustomHeadsUpContentView(RemoteViews)}.
Chris Wren8fd39ec2014-02-27 17:43:26 -0500315 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400316 @Deprecated
Chris Wren8fd39ec2014-02-27 17:43:26 -0500317 public RemoteViews headsUpContentView;
318
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400319 /**
Dan Sandler86647982015-05-13 23:41:13 -0400320 * A large bitmap to be shown in the notification content area.
321 *
322 * @deprecated Use {@link Builder#setLargeIcon(Icon)} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800323 */
Dan Sandler86647982015-05-13 23:41:13 -0400324 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -0800325 public Bitmap largeIcon;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800326
327 /**
328 * The sound to play.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500329 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800330 * <p>
Chris Wren47c20a12014-06-18 17:27:29 -0400331 * A notification that is noisy is more likely to be presented as a heads-up notification.
332 * </p>
333 *
334 * <p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500335 * To play the default notification sound, see {@link #defaults}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800336 * </p>
337 */
338 public Uri sound;
339
340 /**
341 * Use this constant as the value for audioStreamType to request that
342 * the default stream type for notifications be used. Currently the
Jeff Sharkey098d5802012-04-26 17:30:34 -0700343 * default stream type is {@link AudioManager#STREAM_NOTIFICATION}.
John Spurlockc0650f022014-07-19 13:22:39 -0400344 *
345 * @deprecated Use {@link #audioAttributes} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800346 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -0700347 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800348 public static final int STREAM_DEFAULT = -1;
349
350 /**
351 * The audio stream type to use when playing the sound.
352 * Should be one of the STREAM_ constants from
353 * {@link android.media.AudioManager}.
John Spurlockc0650f022014-07-19 13:22:39 -0400354 *
355 * @deprecated Use {@link #audioAttributes} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800356 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -0700357 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800358 public int audioStreamType = STREAM_DEFAULT;
359
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800360 /**
John Spurlockc0650f022014-07-19 13:22:39 -0400361 * The default value of {@link #audioAttributes}.
362 */
363 public static final AudioAttributes AUDIO_ATTRIBUTES_DEFAULT = new AudioAttributes.Builder()
364 .setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION)
365 .setUsage(AudioAttributes.USAGE_NOTIFICATION)
366 .build();
367
368 /**
369 * The {@link AudioAttributes audio attributes} to use when playing the sound.
370 */
371 public AudioAttributes audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
372
373 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500374 * The pattern with which to vibrate.
375 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800376 * <p>
377 * To vibrate the default pattern, see {@link #defaults}.
378 * </p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500379 *
Chris Wren47c20a12014-06-18 17:27:29 -0400380 * <p>
381 * A notification that vibrates is more likely to be presented as a heads-up notification.
382 * </p>
383 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800384 * @see android.os.Vibrator#vibrate(long[],int)
385 */
386 public long[] vibrate;
387
388 /**
389 * The color of the led. The hardware will do its best approximation.
390 *
391 * @see #FLAG_SHOW_LIGHTS
392 * @see #flags
393 */
Tor Norbye80756e32015-03-02 09:39:27 -0800394 @ColorInt
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800395 public int ledARGB;
396
397 /**
398 * The number of milliseconds for the LED to be on while it's flashing.
399 * The hardware will do its best approximation.
400 *
401 * @see #FLAG_SHOW_LIGHTS
402 * @see #flags
403 */
404 public int ledOnMS;
405
406 /**
407 * The number of milliseconds for the LED to be off while it's flashing.
408 * The hardware will do its best approximation.
409 *
410 * @see #FLAG_SHOW_LIGHTS
411 * @see #flags
412 */
413 public int ledOffMS;
414
415 /**
416 * Specifies which values should be taken from the defaults.
417 * <p>
418 * To set, OR the desired from {@link #DEFAULT_SOUND},
419 * {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}. For all default
420 * values, use {@link #DEFAULT_ALL}.
421 * </p>
422 */
423 public int defaults;
424
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800425 /**
426 * Bit to be bitwise-ored into the {@link #flags} field that should be
427 * set if you want the LED on for this notification.
428 * <ul>
429 * <li>To turn the LED off, pass 0 in the alpha channel for colorARGB
430 * or 0 for both ledOnMS and ledOffMS.</li>
431 * <li>To turn the LED on, pass 1 for ledOnMS and 0 for ledOffMS.</li>
432 * <li>To flash the LED, pass the number of milliseconds that it should
433 * be on and off to ledOnMS and ledOffMS.</li>
434 * </ul>
435 * <p>
436 * Since hardware varies, you are not guaranteed that any of the values
437 * you pass are honored exactly. Use the system defaults (TODO) if possible
438 * because they will be set to values that work on any given hardware.
439 * <p>
440 * The alpha channel must be set for forward compatibility.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500441 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800442 */
443 public static final int FLAG_SHOW_LIGHTS = 0x00000001;
444
445 /**
446 * Bit to be bitwise-ored into the {@link #flags} field that should be
447 * set if this notification is in reference to something that is ongoing,
448 * like a phone call. It should not be set if this notification is in
449 * reference to something that happened at a particular point in time,
450 * like a missed phone call.
451 */
452 public static final int FLAG_ONGOING_EVENT = 0x00000002;
453
454 /**
455 * Bit to be bitwise-ored into the {@link #flags} field that if set,
Scott Mainb8b36452009-04-26 15:50:49 -0700456 * the audio will be repeated until the notification is
457 * cancelled or the notification window is opened.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800458 */
459 public static final int FLAG_INSISTENT = 0x00000004;
460
461 /**
462 * Bit to be bitwise-ored into the {@link #flags} field that should be
Griff Hazen293977b2014-04-28 08:37:20 -0700463 * set if you would only like the sound, vibrate and ticker to be played
464 * if the notification was not already showing.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800465 */
466 public static final int FLAG_ONLY_ALERT_ONCE = 0x00000008;
467
468 /**
469 * Bit to be bitwise-ored into the {@link #flags} field that should be
470 * set if the notification should be canceled when it is clicked by the
Daniel Sandler8aa9ae62012-12-04 23:31:47 -0500471 * user.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800472 */
473 public static final int FLAG_AUTO_CANCEL = 0x00000010;
474
475 /**
476 * Bit to be bitwise-ored into the {@link #flags} field that should be
477 * set if the notification should not be canceled when the user clicks
478 * the Clear all button.
479 */
480 public static final int FLAG_NO_CLEAR = 0x00000020;
481
Dianne Hackbornd8a43f62009-08-17 23:33:56 -0700482 /**
483 * Bit to be bitwise-ored into the {@link #flags} field that should be
484 * set if this notification represents a currently running service. This
485 * will normally be set for you by {@link Service#startForeground}.
486 */
487 public static final int FLAG_FOREGROUND_SERVICE = 0x00000040;
488
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400489 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500490 * Obsolete flag indicating high-priority notifications; use the priority field instead.
Joe Malin8d40d042012-11-05 11:36:40 -0800491 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500492 * @deprecated Use {@link #priority} with a positive value.
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400493 */
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500494 public static final int FLAG_HIGH_PRIORITY = 0x00000080;
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400495
Griff Hazendfcb0802014-02-11 12:00:00 -0800496 /**
497 * Bit to be bitswise-ored into the {@link #flags} field that should be
498 * set if this notification is relevant to the current device only
499 * and it is not recommended that it bridge to other devices.
500 */
501 public static final int FLAG_LOCAL_ONLY = 0x00000100;
502
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700503 /**
504 * Bit to be bitswise-ored into the {@link #flags} field that should be
505 * set if this notification is the group summary for a group of notifications.
506 * Grouped notifications may display in a cluster or stack on devices which
507 * support such rendering. Requires a group key also be set using {@link Builder#setGroup}.
508 */
509 public static final int FLAG_GROUP_SUMMARY = 0x00000200;
510
Julia Reynoldse46bb372016-03-17 11:05:58 -0400511 /**
512 * Bit to be bitswise-ored into the {@link #flags} field that should be
513 * set if this notification is the group summary for an auto-group of notifications.
514 *
515 * @hide
516 */
517 @SystemApi
518 public static final int FLAG_AUTOGROUP_SUMMARY = 0x00000400;
519
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800520 public int flags;
521
Tor Norbyed9273d62013-05-30 15:59:53 -0700522 /** @hide */
523 @IntDef({PRIORITY_DEFAULT,PRIORITY_LOW,PRIORITY_MIN,PRIORITY_HIGH,PRIORITY_MAX})
524 @Retention(RetentionPolicy.SOURCE)
525 public @interface Priority {}
526
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800527 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500528 * Default notification {@link #priority}. If your application does not prioritize its own
529 * notifications, use this value for all notifications.
530 */
531 public static final int PRIORITY_DEFAULT = 0;
532
533 /**
534 * Lower {@link #priority}, for items that are less important. The UI may choose to show these
535 * items smaller, or at a different position in the list, compared with your app's
536 * {@link #PRIORITY_DEFAULT} items.
537 */
538 public static final int PRIORITY_LOW = -1;
539
540 /**
541 * Lowest {@link #priority}; these items might not be shown to the user except under special
542 * circumstances, such as detailed notification logs.
543 */
544 public static final int PRIORITY_MIN = -2;
545
546 /**
547 * Higher {@link #priority}, for more important notifications or alerts. The UI may choose to
548 * show these items larger, or at a different position in notification lists, compared with
549 * your app's {@link #PRIORITY_DEFAULT} items.
550 */
551 public static final int PRIORITY_HIGH = 1;
552
553 /**
554 * Highest {@link #priority}, for your application's most important items that require the
555 * user's prompt attention or input.
556 */
557 public static final int PRIORITY_MAX = 2;
558
559 /**
560 * Relative priority for this notification.
Joe Malin8d40d042012-11-05 11:36:40 -0800561 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500562 * Priority is an indication of how much of the user's valuable attention should be consumed by
563 * this notification. Low-priority notifications may be hidden from the user in certain
564 * situations, while the user might be interrupted for a higher-priority notification. The
Daniel Sandler6738eee2012-11-16 12:03:32 -0500565 * system will make a determination about how to interpret this priority when presenting
566 * the notification.
Chris Wren47c20a12014-06-18 17:27:29 -0400567 *
568 * <p>
569 * A notification that is at least {@link #PRIORITY_HIGH} is more likely to be presented
570 * as a heads-up notification.
571 * </p>
572 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500573 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700574 @Priority
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500575 public int priority;
Joe Malin8d40d042012-11-05 11:36:40 -0800576
Dan Sandler26e81cf2014-05-06 10:01:27 -0400577 /**
578 * Accent color (an ARGB integer like the constants in {@link android.graphics.Color})
579 * to be applied by the standard Style templates when presenting this notification.
580 *
581 * The current template design constructs a colorful header image by overlaying the
582 * {@link #icon} image (stenciled in white) atop a field of this color. Alpha components are
583 * ignored.
584 */
Tor Norbye80756e32015-03-02 09:39:27 -0800585 @ColorInt
Dan Sandler26e81cf2014-05-06 10:01:27 -0400586 public int color = COLOR_DEFAULT;
587
588 /**
589 * Special value of {@link #color} telling the system not to decorate this notification with
590 * any special color but instead use default colors when presenting this notification.
591 */
Tor Norbye80756e32015-03-02 09:39:27 -0800592 @ColorInt
Dan Sandler26e81cf2014-05-06 10:01:27 -0400593 public static final int COLOR_DEFAULT = 0; // AKA Color.TRANSPARENT
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600594
595 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -0800596 * Special value of {@link #color} used as a place holder for an invalid color.
597 */
598 @ColorInt
599 private static final int COLOR_INVALID = 1;
600
601 /**
Adrian Roosc1a80b02016-04-05 14:54:55 -0700602 * Sphere of visibility of this notification, which affects how and when the SystemUI reveals
603 * the notification's presence and contents in untrusted situations (namely, on the secure
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600604 * lockscreen).
605 *
606 * The default level, {@link #VISIBILITY_PRIVATE}, behaves exactly as notifications have always
607 * done on Android: The notification's {@link #icon} and {@link #tickerText} (if available) are
608 * shown in all situations, but the contents are only available if the device is unlocked for
609 * the appropriate user.
610 *
611 * A more permissive policy can be expressed by {@link #VISIBILITY_PUBLIC}; such a notification
612 * can be read even in an "insecure" context (that is, above a secure lockscreen).
613 * To modify the public version of this notification—for example, to redact some portions—see
614 * {@link Builder#setPublicVersion(Notification)}.
615 *
616 * Finally, a notification can be made {@link #VISIBILITY_SECRET}, which will suppress its icon
617 * and ticker until the user has bypassed the lockscreen.
618 */
619 public int visibility;
620
Griff Hazenfc3922d2014-08-20 11:56:44 -0700621 /**
622 * Notification visibility: Show this notification in its entirety on all lockscreens.
623 *
624 * {@see #visibility}
625 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600626 public static final int VISIBILITY_PUBLIC = 1;
Griff Hazenfc3922d2014-08-20 11:56:44 -0700627
628 /**
629 * Notification visibility: Show this notification on all lockscreens, but conceal sensitive or
630 * private information on secure lockscreens.
631 *
632 * {@see #visibility}
633 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600634 public static final int VISIBILITY_PRIVATE = 0;
Griff Hazenfc3922d2014-08-20 11:56:44 -0700635
636 /**
637 * Notification visibility: Do not reveal any part of this notification on a secure lockscreen.
638 *
639 * {@see #visibility}
640 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600641 public static final int VISIBILITY_SECRET = -1;
642
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500643 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400644 * Notification category: incoming call (voice or video) or similar synchronous communication request.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500645 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400646 public static final String CATEGORY_CALL = "call";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500647
648 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400649 * Notification category: incoming direct message (SMS, instant message, etc.).
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500650 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400651 public static final String CATEGORY_MESSAGE = "msg";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500652
653 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400654 * Notification category: asynchronous bulk message (email).
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500655 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400656 public static final String CATEGORY_EMAIL = "email";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500657
658 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400659 * Notification category: calendar event.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500660 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400661 public static final String CATEGORY_EVENT = "event";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500662
663 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400664 * Notification category: promotion or advertisement.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500665 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400666 public static final String CATEGORY_PROMO = "promo";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500667
668 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400669 * Notification category: alarm or timer.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500670 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400671 public static final String CATEGORY_ALARM = "alarm";
672
673 /**
674 * Notification category: progress of a long-running background operation.
675 */
676 public static final String CATEGORY_PROGRESS = "progress";
677
678 /**
679 * Notification category: social network or sharing update.
680 */
681 public static final String CATEGORY_SOCIAL = "social";
682
683 /**
684 * Notification category: error in background operation or authentication status.
685 */
686 public static final String CATEGORY_ERROR = "err";
687
688 /**
689 * Notification category: media transport control for playback.
690 */
691 public static final String CATEGORY_TRANSPORT = "transport";
692
693 /**
694 * Notification category: system or device status update. Reserved for system use.
695 */
696 public static final String CATEGORY_SYSTEM = "sys";
697
698 /**
699 * Notification category: indication of running background service.
700 */
701 public static final String CATEGORY_SERVICE = "service";
702
703 /**
John Spurlock0a69c8c2014-03-21 13:30:57 -0400704 * Notification category: a specific, timely recommendation for a single thing.
705 * For example, a news app might want to recommend a news story it believes the user will
706 * want to read next.
707 */
708 public static final String CATEGORY_RECOMMENDATION = "recommendation";
709
710 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400711 * Notification category: ongoing information about device or contextual status.
712 */
713 public static final String CATEGORY_STATUS = "status";
714
715 /**
John Spurlock24d3dad2015-04-02 12:24:02 -0400716 * Notification category: user-scheduled reminder.
717 */
718 public static final String CATEGORY_REMINDER = "reminder";
719
720 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400721 * One of the predefined notification categories (see the <code>CATEGORY_*</code> constants)
722 * that best describes this Notification. May be used by the system for ranking and filtering.
723 */
724 public String category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500725
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700726 private String mGroupKey;
727
728 /**
729 * Get the key used to group this notification into a cluster or stack
730 * with other notifications on devices which support such rendering.
731 */
732 public String getGroup() {
733 return mGroupKey;
734 }
735
736 private String mSortKey;
737
738 /**
739 * Get a sort key that orders this notification among other notifications from the
740 * same package. This can be useful if an external sort was already applied and an app
741 * would like to preserve this. Notifications will be sorted lexicographically using this
742 * value, although providing different priorities in addition to providing sort key may
743 * cause this value to be ignored.
744 *
745 * <p>This sort key can also be used to order members of a notification group. See
746 * {@link Builder#setGroup}.
747 *
748 * @see String#compareTo(String)
749 */
750 public String getSortKey() {
751 return mSortKey;
752 }
753
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500754 /**
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400755 * Additional semantic data to be carried around with this Notification.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400756 * <p>
757 * The extras keys defined here are intended to capture the original inputs to {@link Builder}
758 * APIs, and are intended to be used by
759 * {@link android.service.notification.NotificationListenerService} implementations to extract
760 * detailed information from notification objects.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500761 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400762 public Bundle extras = new Bundle();
763
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400764 /**
Felipe Lemedd85da62016-06-28 11:29:54 -0700765 * All pending intents in the notification as the system needs to be able to access them but
766 * touching the extras bundle in the system process is not safe because the bundle may contain
Svet Ganovddb94882016-06-23 19:55:24 -0700767 * custom parcelable objects.
768 *
769 * @hide
770 */
Felipe Lemedd85da62016-06-28 11:29:54 -0700771 public ArraySet<PendingIntent> allPendingIntents;
Svet Ganovddb94882016-06-23 19:55:24 -0700772
773 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400774 * {@link #extras} key: this is the title of the notification,
775 * as supplied to {@link Builder#setContentTitle(CharSequence)}.
776 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500777 public static final String EXTRA_TITLE = "android.title";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400778
779 /**
780 * {@link #extras} key: this is the title of the notification when shown in expanded form,
781 * e.g. as supplied to {@link BigTextStyle#setBigContentTitle(CharSequence)}.
782 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400783 public static final String EXTRA_TITLE_BIG = EXTRA_TITLE + ".big";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400784
785 /**
786 * {@link #extras} key: this is the main text payload, as supplied to
787 * {@link Builder#setContentText(CharSequence)}.
788 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500789 public static final String EXTRA_TEXT = "android.text";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400790
791 /**
792 * {@link #extras} key: this is a third line of text, as supplied to
793 * {@link Builder#setSubText(CharSequence)}.
794 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400795 public static final String EXTRA_SUB_TEXT = "android.subText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400796
797 /**
Adrian Roose458aa82015-12-08 16:17:19 -0800798 * {@link #extras} key: this is the remote input history, as supplied to
799 * {@link Builder#setRemoteInputHistory(CharSequence[])}.
Adrian Roos005e7742016-04-13 15:02:20 -0700800 *
801 * Apps can fill this through {@link Builder#setRemoteInputHistory(CharSequence[])}
802 * with the most recent inputs that have been sent through a {@link RemoteInput} of this
803 * Notification and are expected to clear it once the it is no longer relevant (e.g. for chat
804 * notifications once the other party has responded).
805 *
806 * The extra with this key is of type CharSequence[] and contains the most recent entry at
807 * the 0 index, the second most recent at the 1 index, etc.
808 *
809 * @see Builder#setRemoteInputHistory(CharSequence[])
Adrian Roose458aa82015-12-08 16:17:19 -0800810 */
811 public static final String EXTRA_REMOTE_INPUT_HISTORY = "android.remoteInputHistory";
812
813 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400814 * {@link #extras} key: this is a small piece of additional text as supplied to
815 * {@link Builder#setContentInfo(CharSequence)}.
816 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400817 public static final String EXTRA_INFO_TEXT = "android.infoText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400818
819 /**
820 * {@link #extras} key: this is a line of summary information intended to be shown
821 * alongside expanded notifications, as supplied to (e.g.)
822 * {@link BigTextStyle#setSummaryText(CharSequence)}.
823 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400824 public static final String EXTRA_SUMMARY_TEXT = "android.summaryText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400825
826 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +0200827 * {@link #extras} key: this is the longer text shown in the big form of a
828 * {@link BigTextStyle} notification, as supplied to
829 * {@link BigTextStyle#bigText(CharSequence)}.
830 */
831 public static final String EXTRA_BIG_TEXT = "android.bigText";
832
833 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400834 * {@link #extras} key: this is the resource ID of the notification's main small icon, as
835 * supplied to {@link Builder#setSmallIcon(int)}.
836 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500837 public static final String EXTRA_SMALL_ICON = "android.icon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400838
839 /**
840 * {@link #extras} key: this is a bitmap to be used instead of the small icon when showing the
841 * notification payload, as
842 * supplied to {@link Builder#setLargeIcon(android.graphics.Bitmap)}.
843 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400844 public static final String EXTRA_LARGE_ICON = "android.largeIcon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400845
846 /**
847 * {@link #extras} key: this is a bitmap to be used instead of the one from
848 * {@link Builder#setLargeIcon(android.graphics.Bitmap)} when the notification is
849 * shown in its expanded form, as supplied to
850 * {@link BigPictureStyle#bigLargeIcon(android.graphics.Bitmap)}.
851 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400852 public static final String EXTRA_LARGE_ICON_BIG = EXTRA_LARGE_ICON + ".big";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400853
854 /**
855 * {@link #extras} key: this is the progress value supplied to
856 * {@link Builder#setProgress(int, int, boolean)}.
857 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400858 public static final String EXTRA_PROGRESS = "android.progress";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400859
860 /**
861 * {@link #extras} key: this is the maximum value supplied to
862 * {@link Builder#setProgress(int, int, boolean)}.
863 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400864 public static final String EXTRA_PROGRESS_MAX = "android.progressMax";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400865
866 /**
867 * {@link #extras} key: whether the progress bar is indeterminate, supplied to
868 * {@link Builder#setProgress(int, int, boolean)}.
869 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400870 public static final String EXTRA_PROGRESS_INDETERMINATE = "android.progressIndeterminate";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400871
872 /**
873 * {@link #extras} key: whether {@link #when} should be shown as a count-up timer (specifically
874 * a {@link android.widget.Chronometer}) instead of a timestamp, as supplied to
875 * {@link Builder#setUsesChronometer(boolean)}.
876 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400877 public static final String EXTRA_SHOW_CHRONOMETER = "android.showChronometer";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400878
879 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -0800880 * {@link #extras} key: whether the chronometer set on the notification should count down
881 * instead of counting up. Is only relevant if key {@link #EXTRA_SHOW_CHRONOMETER} is present.
Adrian Roos96b7e202016-05-17 13:50:38 -0700882 * This extra is a boolean. The default is false.
Selim Cinek81c23aa2016-02-25 16:23:13 -0800883 */
Adrian Roos96b7e202016-05-17 13:50:38 -0700884 public static final String EXTRA_CHRONOMETER_COUNT_DOWN = "android.chronometerCountDown";
Selim Cinek81c23aa2016-02-25 16:23:13 -0800885
886 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400887 * {@link #extras} key: whether {@link #when} should be shown,
888 * as supplied to {@link Builder#setShowWhen(boolean)}.
889 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400890 public static final String EXTRA_SHOW_WHEN = "android.showWhen";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400891
892 /**
893 * {@link #extras} key: this is a bitmap to be shown in {@link BigPictureStyle} expanded
894 * notifications, supplied to {@link BigPictureStyle#bigPicture(android.graphics.Bitmap)}.
895 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400896 public static final String EXTRA_PICTURE = "android.picture";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400897
898 /**
899 * {@link #extras} key: An array of CharSequences to show in {@link InboxStyle} expanded
900 * notifications, each of which was supplied to {@link InboxStyle#addLine(CharSequence)}.
901 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400902 public static final String EXTRA_TEXT_LINES = "android.textLines";
Dan Sandler842dd772014-05-15 09:36:47 -0400903
904 /**
905 * {@link #extras} key: A string representing the name of the specific
906 * {@link android.app.Notification.Style} used to create this notification.
907 */
Chris Wren91ad5632013-06-05 15:05:57 -0400908 public static final String EXTRA_TEMPLATE = "android.template";
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400909
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400910 /**
Chris Wrene6c48932014-09-29 17:19:27 -0400911 * {@link #extras} key: A String array containing the people that this notification relates to,
912 * each of which was supplied to {@link Builder#addPerson(String)}.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400913 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400914 public static final String EXTRA_PEOPLE = "android.people";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500915
916 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400917 * Allow certain system-generated notifications to appear before the device is provisioned.
918 * Only available to notifications coming from the android package.
919 * @hide
920 */
921 public static final String EXTRA_ALLOW_DURING_SETUP = "android.allowDuringSetup";
922
923 /**
Jose Limae9e3b3b2014-05-18 23:44:50 -0700924 * {@link #extras} key: A
925 * {@link android.content.ContentUris content URI} pointing to an image that can be displayed
926 * in the background when the notification is selected. The URI must point to an image stream
927 * suitable for passing into
928 * {@link android.graphics.BitmapFactory#decodeStream(java.io.InputStream)
929 * BitmapFactory.decodeStream}; all other content types will be ignored. The content provider
930 * URI used for this purpose must require no permissions to read the image data.
931 */
932 public static final String EXTRA_BACKGROUND_IMAGE_URI = "android.backgroundImageUri";
933
934 /**
Dan Sandler842dd772014-05-15 09:36:47 -0400935 * {@link #extras} key: A
Jeff Browndba34ba2014-06-24 20:46:03 -0700936 * {@link android.media.session.MediaSession.Token} associated with a
Dan Sandler842dd772014-05-15 09:36:47 -0400937 * {@link android.app.Notification.MediaStyle} notification.
938 */
939 public static final String EXTRA_MEDIA_SESSION = "android.mediaSession";
940
941 /**
Bryan Mawhinneye191f902014-07-22 12:50:09 +0100942 * {@link #extras} key: the indices of actions to be shown in the compact view,
943 * as supplied to (e.g.) {@link MediaStyle#setShowActionsInCompactView(int...)}.
944 */
945 public static final String EXTRA_COMPACT_ACTIONS = "android.compactActions";
946
Christoph Studer943aa672014-08-03 20:31:16 +0200947 /**
Alex Hillsfc737de2016-03-23 17:33:02 -0400948 * {@link #extras} key: the username to be displayed for all messages sent by the user including
949 * direct replies
Adrian Roos96b7e202016-05-17 13:50:38 -0700950 * {@link android.app.Notification.MessagingStyle} notification. This extra is a
951 * {@link CharSequence}
Alex Hillsfc737de2016-03-23 17:33:02 -0400952 */
953 public static final String EXTRA_SELF_DISPLAY_NAME = "android.selfDisplayName";
954
955 /**
Adrian Roos96b7e202016-05-17 13:50:38 -0700956 * {@link #extras} key: a {@link CharSequence} to be displayed as the title to a conversation
Alex Hillsd9b04d92016-04-11 16:38:16 -0400957 * represented by a {@link android.app.Notification.MessagingStyle}
Alex Hillsfc737de2016-03-23 17:33:02 -0400958 */
Alex Hillsd9b04d92016-04-11 16:38:16 -0400959 public static final String EXTRA_CONVERSATION_TITLE = "android.conversationTitle";
Alex Hillsfc737de2016-03-23 17:33:02 -0400960
961 /**
962 * {@link #extras} key: an array of {@link android.app.Notification.MessagingStyle.Message}
963 * bundles provided by a
Adrian Roos96b7e202016-05-17 13:50:38 -0700964 * {@link android.app.Notification.MessagingStyle} notification. This extra is a parcelable
965 * array of bundles.
Alex Hillsfc737de2016-03-23 17:33:02 -0400966 */
967 public static final String EXTRA_MESSAGES = "android.messages";
968
969 /**
Kenny Guy8942bcd2014-09-08 21:09:47 +0100970 * {@link #extras} key: the user that built the notification.
971 *
972 * @hide
973 */
974 public static final String EXTRA_ORIGINATING_USERID = "android.originatingUserId";
975
976 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400977 * @hide
978 */
979 public static final String EXTRA_BUILDER_APPLICATION_INFO = "android.appInfo";
980
Selim Cinek247fa012016-02-18 09:50:48 -0800981 /**
982 * @hide
983 */
984 public static final String EXTRA_CONTAINS_CUSTOM_VIEW = "android.contains.customView";
985
Dan Sandler80eaa592016-04-14 23:34:54 -0400986 /** @hide */
987 @SystemApi
Dan Sandler732bd6c2016-04-12 14:20:32 -0400988 public static final String EXTRA_SUBSTITUTE_APP_NAME = "android.substName";
989
Dan Sandlerd63f9322015-05-06 15:18:49 -0400990 private Icon mSmallIcon;
991 private Icon mLargeIcon;
992
Chris Wren51c75102013-07-16 20:49:17 -0400993 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400994 * Structure to encapsulate a named action that can be shown as part of this notification.
995 * It must include an icon, a label, and a {@link PendingIntent} to be fired when the action is
996 * selected by the user.
997 * <p>
Griff Hazen959591e2014-05-15 22:26:18 -0700998 * Apps should use {@link Notification.Builder#addAction(int, CharSequence, PendingIntent)}
999 * or {@link Notification.Builder#addAction(Notification.Action)}
1000 * to attach actions.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001001 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -05001002 public static class Action implements Parcelable {
Griff Hazen959591e2014-05-15 22:26:18 -07001003 private final Bundle mExtras;
Dan Sandler86647982015-05-13 23:41:13 -04001004 private Icon mIcon;
Griff Hazen61a9e862014-05-22 16:05:19 -07001005 private final RemoteInput[] mRemoteInputs;
Alex Hills42b0c4d2016-04-26 13:35:36 -04001006 private boolean mAllowGeneratedReplies = false;
Griff Hazen959591e2014-05-15 22:26:18 -07001007
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001008 /**
1009 * Small icon representing the action.
Dan Sandler86647982015-05-13 23:41:13 -04001010 *
1011 * @deprecated Use {@link Action#getIcon()} instead.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001012 */
Dan Sandler86647982015-05-13 23:41:13 -04001013 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001014 public int icon;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001015
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001016 /**
1017 * Title of the action.
1018 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001019 public CharSequence title;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001020
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001021 /**
1022 * Intent to send when the user invokes this action. May be null, in which case the action
1023 * may be rendered in a disabled presentation by the system UI.
1024 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001025 public PendingIntent actionIntent;
Griff Hazen959591e2014-05-15 22:26:18 -07001026
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001027 private Action(Parcel in) {
Dan Sandler86647982015-05-13 23:41:13 -04001028 if (in.readInt() != 0) {
1029 mIcon = Icon.CREATOR.createFromParcel(in);
Dan Sandler68079d52015-07-22 10:45:30 -04001030 if (mIcon.getType() == Icon.TYPE_RESOURCE) {
1031 icon = mIcon.getResId();
1032 }
Dan Sandler86647982015-05-13 23:41:13 -04001033 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001034 title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
1035 if (in.readInt() == 1) {
1036 actionIntent = PendingIntent.CREATOR.createFromParcel(in);
1037 }
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06001038 mExtras = Bundle.setDefusable(in.readBundle(), true);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001039 mRemoteInputs = in.createTypedArray(RemoteInput.CREATOR);
Alex Hills42b0c4d2016-04-26 13:35:36 -04001040 mAllowGeneratedReplies = in.readInt() == 1;
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001041 }
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001042
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001043 /**
Dan Sandler86647982015-05-13 23:41:13 -04001044 * @deprecated Use {@link android.app.Notification.Action.Builder}.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001045 */
Dan Sandler86647982015-05-13 23:41:13 -04001046 @Deprecated
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001047 public Action(int icon, CharSequence title, PendingIntent intent) {
Alex Hills42b0c4d2016-04-26 13:35:36 -04001048 this(Icon.createWithResource("", icon), title, intent, new Bundle(), null, false);
Griff Hazen959591e2014-05-15 22:26:18 -07001049 }
1050
Dan Sandler86647982015-05-13 23:41:13 -04001051 private Action(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Alex Hills42b0c4d2016-04-26 13:35:36 -04001052 RemoteInput[] remoteInputs, boolean allowGeneratedReplies) {
Dan Sandler86647982015-05-13 23:41:13 -04001053 this.mIcon = icon;
Gus Prevasf5bff46f2015-08-24 10:34:28 -04001054 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
1055 this.icon = icon.getResId();
1056 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001057 this.title = title;
1058 this.actionIntent = intent;
Griff Hazen959591e2014-05-15 22:26:18 -07001059 this.mExtras = extras != null ? extras : new Bundle();
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001060 this.mRemoteInputs = remoteInputs;
Alex Hills42b0c4d2016-04-26 13:35:36 -04001061 this.mAllowGeneratedReplies = allowGeneratedReplies;
Griff Hazen959591e2014-05-15 22:26:18 -07001062 }
1063
1064 /**
Dan Sandler86647982015-05-13 23:41:13 -04001065 * Return an icon representing the action.
1066 */
1067 public Icon getIcon() {
1068 if (mIcon == null && icon != 0) {
1069 // you snuck an icon in here without using the builder; let's try to keep it
1070 mIcon = Icon.createWithResource("", icon);
1071 }
1072 return mIcon;
1073 }
1074
1075 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001076 * Get additional metadata carried around with this Action.
1077 */
1078 public Bundle getExtras() {
1079 return mExtras;
1080 }
1081
1082 /**
Alex Hills42b0c4d2016-04-26 13:35:36 -04001083 * Return whether the platform should automatically generate possible replies for this
1084 * {@link Action}
1085 */
1086 public boolean getAllowGeneratedReplies() {
1087 return mAllowGeneratedReplies;
1088 }
1089
1090 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001091 * Get the list of inputs to be collected from the user when this action is sent.
1092 * May return null if no remote inputs were added.
1093 */
1094 public RemoteInput[] getRemoteInputs() {
1095 return mRemoteInputs;
1096 }
1097
1098 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001099 * Builder class for {@link Action} objects.
1100 */
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001101 public static final class Builder {
Dan Sandler86647982015-05-13 23:41:13 -04001102 private final Icon mIcon;
Griff Hazen959591e2014-05-15 22:26:18 -07001103 private final CharSequence mTitle;
1104 private final PendingIntent mIntent;
Alex Hills42b0c4d2016-04-26 13:35:36 -04001105 private boolean mAllowGeneratedReplies;
Griff Hazen959591e2014-05-15 22:26:18 -07001106 private final Bundle mExtras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001107 private ArrayList<RemoteInput> mRemoteInputs;
Griff Hazen959591e2014-05-15 22:26:18 -07001108
1109 /**
1110 * Construct a new builder for {@link Action} object.
1111 * @param icon icon to show for this action
1112 * @param title the title of the action
1113 * @param intent the {@link PendingIntent} to fire when users trigger this action
1114 */
Dan Sandler86647982015-05-13 23:41:13 -04001115 @Deprecated
Griff Hazen959591e2014-05-15 22:26:18 -07001116 public Builder(int icon, CharSequence title, PendingIntent intent) {
Dan Sandler86647982015-05-13 23:41:13 -04001117 this(Icon.createWithResource("", icon), title, intent, new Bundle(), null);
1118 }
1119
1120 /**
1121 * Construct a new builder for {@link Action} object.
1122 * @param icon icon to show for this action
1123 * @param title the title of the action
1124 * @param intent the {@link PendingIntent} to fire when users trigger this action
1125 */
1126 public Builder(Icon icon, CharSequence title, PendingIntent intent) {
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001127 this(icon, title, intent, new Bundle(), null);
Griff Hazen959591e2014-05-15 22:26:18 -07001128 }
1129
1130 /**
1131 * Construct a new builder for {@link Action} object using the fields from an
1132 * {@link Action}.
1133 * @param action the action to read fields from.
1134 */
1135 public Builder(Action action) {
Dan Sandler86647982015-05-13 23:41:13 -04001136 this(action.getIcon(), action.title, action.actionIntent, new Bundle(action.mExtras),
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001137 action.getRemoteInputs());
Griff Hazen959591e2014-05-15 22:26:18 -07001138 }
1139
Dan Sandler86647982015-05-13 23:41:13 -04001140 private Builder(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001141 RemoteInput[] remoteInputs) {
Griff Hazen959591e2014-05-15 22:26:18 -07001142 mIcon = icon;
1143 mTitle = title;
1144 mIntent = intent;
1145 mExtras = extras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001146 if (remoteInputs != null) {
1147 mRemoteInputs = new ArrayList<RemoteInput>(remoteInputs.length);
1148 Collections.addAll(mRemoteInputs, remoteInputs);
1149 }
Griff Hazen959591e2014-05-15 22:26:18 -07001150 }
1151
1152 /**
1153 * Merge additional metadata into this builder.
1154 *
1155 * <p>Values within the Bundle will replace existing extras values in this Builder.
1156 *
1157 * @see Notification.Action#extras
1158 */
1159 public Builder addExtras(Bundle extras) {
1160 if (extras != null) {
1161 mExtras.putAll(extras);
1162 }
1163 return this;
1164 }
1165
1166 /**
1167 * Get the metadata Bundle used by this Builder.
1168 *
1169 * <p>The returned Bundle is shared with this Builder.
1170 */
1171 public Bundle getExtras() {
1172 return mExtras;
1173 }
1174
1175 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001176 * Add an input to be collected from the user when this action is sent.
1177 * Response values can be retrieved from the fired intent by using the
1178 * {@link RemoteInput#getResultsFromIntent} function.
1179 * @param remoteInput a {@link RemoteInput} to add to the action
1180 * @return this object for method chaining
1181 */
1182 public Builder addRemoteInput(RemoteInput remoteInput) {
1183 if (mRemoteInputs == null) {
1184 mRemoteInputs = new ArrayList<RemoteInput>();
1185 }
1186 mRemoteInputs.add(remoteInput);
1187 return this;
1188 }
1189
1190 /**
Alex Hills42b0c4d2016-04-26 13:35:36 -04001191 * Set whether the platform should automatically generate possible replies to add to
1192 * {@link RemoteInput#getChoices()}. If the {@link Action} doesn't have a
1193 * {@link RemoteInput}, this has no effect.
1194 * @param allowGeneratedReplies {@code true} to allow generated replies, {@code false}
1195 * otherwise
1196 * @return this object for method chaining
1197 * The default value is {@code false}
1198 */
1199 public Builder setAllowGeneratedReplies(boolean allowGeneratedReplies) {
1200 mAllowGeneratedReplies = allowGeneratedReplies;
1201 return this;
1202 }
1203
1204 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001205 * Apply an extender to this action builder. Extenders may be used to add
1206 * metadata or change options on this builder.
1207 */
Griff Hazen61a9e862014-05-22 16:05:19 -07001208 public Builder extend(Extender extender) {
1209 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001210 return this;
1211 }
1212
1213 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001214 * Combine all of the options that have been set and return a new {@link Action}
1215 * object.
1216 * @return the built action
1217 */
1218 public Action build() {
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001219 RemoteInput[] remoteInputs = mRemoteInputs != null
1220 ? mRemoteInputs.toArray(new RemoteInput[mRemoteInputs.size()]) : null;
Alex Hills42b0c4d2016-04-26 13:35:36 -04001221 return new Action(mIcon, mTitle, mIntent, mExtras, remoteInputs,
1222 mAllowGeneratedReplies);
Griff Hazen959591e2014-05-15 22:26:18 -07001223 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001224 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001225
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001226 @Override
1227 public Action clone() {
1228 return new Action(
Dan Sandler86647982015-05-13 23:41:13 -04001229 getIcon(),
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001230 title,
1231 actionIntent, // safe to alias
1232 new Bundle(mExtras),
Alex Hills42b0c4d2016-04-26 13:35:36 -04001233 getRemoteInputs(),
1234 getAllowGeneratedReplies());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001235 }
1236 @Override
1237 public int describeContents() {
1238 return 0;
1239 }
1240 @Override
1241 public void writeToParcel(Parcel out, int flags) {
Dan Sandler86647982015-05-13 23:41:13 -04001242 final Icon ic = getIcon();
1243 if (ic != null) {
1244 out.writeInt(1);
1245 ic.writeToParcel(out, 0);
1246 } else {
1247 out.writeInt(0);
1248 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001249 TextUtils.writeToParcel(title, out, flags);
1250 if (actionIntent != null) {
1251 out.writeInt(1);
1252 actionIntent.writeToParcel(out, flags);
1253 } else {
1254 out.writeInt(0);
1255 }
Griff Hazen959591e2014-05-15 22:26:18 -07001256 out.writeBundle(mExtras);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001257 out.writeTypedArray(mRemoteInputs, flags);
Alex Hills42b0c4d2016-04-26 13:35:36 -04001258 out.writeInt(mAllowGeneratedReplies ? 1 : 0);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001259 }
Griff Hazen959591e2014-05-15 22:26:18 -07001260 public static final Parcelable.Creator<Action> CREATOR =
1261 new Parcelable.Creator<Action>() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001262 public Action createFromParcel(Parcel in) {
1263 return new Action(in);
1264 }
1265 public Action[] newArray(int size) {
1266 return new Action[size];
1267 }
1268 };
Griff Hazen61a9e862014-05-22 16:05:19 -07001269
1270 /**
1271 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
1272 * metadata or change options on an action builder.
1273 */
1274 public interface Extender {
1275 /**
1276 * Apply this extender to a notification action builder.
1277 * @param builder the builder to be modified.
1278 * @return the build object for chaining.
1279 */
1280 public Builder extend(Builder builder);
1281 }
1282
1283 /**
1284 * Wearable extender for notification actions. To add extensions to an action,
1285 * create a new {@link android.app.Notification.Action.WearableExtender} object using
1286 * the {@code WearableExtender()} constructor and apply it to a
1287 * {@link android.app.Notification.Action.Builder} using
1288 * {@link android.app.Notification.Action.Builder#extend}.
1289 *
1290 * <pre class="prettyprint">
1291 * Notification.Action action = new Notification.Action.Builder(
1292 * R.drawable.archive_all, "Archive all", actionIntent)
Griff Hazen14f57992014-05-26 09:07:14 -07001293 * .extend(new Notification.Action.WearableExtender()
Griff Hazen61a9e862014-05-22 16:05:19 -07001294 * .setAvailableOffline(false))
Griff Hazen14f57992014-05-26 09:07:14 -07001295 * .build();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07001296 */
1297 public static final class WearableExtender implements Extender {
1298 /** Notification action extra which contains wearable extensions */
1299 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
1300
Pete Gastaf6781d2014-10-07 15:17:05 -04001301 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07001302 private static final String KEY_FLAGS = "flags";
Pete Gastaf6781d2014-10-07 15:17:05 -04001303 private static final String KEY_IN_PROGRESS_LABEL = "inProgressLabel";
1304 private static final String KEY_CONFIRM_LABEL = "confirmLabel";
1305 private static final String KEY_CANCEL_LABEL = "cancelLabel";
Griff Hazen61a9e862014-05-22 16:05:19 -07001306
1307 // Flags bitwise-ored to mFlags
1308 private static final int FLAG_AVAILABLE_OFFLINE = 0x1;
Alex Hills9ab3a232016-04-05 14:54:56 -04001309 private static final int FLAG_HINT_LAUNCHES_ACTIVITY = 1 << 1;
Alex Hills9f087612016-06-07 09:08:59 -04001310 private static final int FLAG_HINT_DISPLAY_INLINE = 1 << 2;
Griff Hazen61a9e862014-05-22 16:05:19 -07001311
1312 // Default value for flags integer
1313 private static final int DEFAULT_FLAGS = FLAG_AVAILABLE_OFFLINE;
1314
1315 private int mFlags = DEFAULT_FLAGS;
1316
Pete Gastaf6781d2014-10-07 15:17:05 -04001317 private CharSequence mInProgressLabel;
1318 private CharSequence mConfirmLabel;
1319 private CharSequence mCancelLabel;
1320
Griff Hazen61a9e862014-05-22 16:05:19 -07001321 /**
1322 * Create a {@link android.app.Notification.Action.WearableExtender} with default
1323 * options.
1324 */
1325 public WearableExtender() {
1326 }
1327
1328 /**
1329 * Create a {@link android.app.Notification.Action.WearableExtender} by reading
1330 * wearable options present in an existing notification action.
1331 * @param action the notification action to inspect.
1332 */
1333 public WearableExtender(Action action) {
1334 Bundle wearableBundle = action.getExtras().getBundle(EXTRA_WEARABLE_EXTENSIONS);
1335 if (wearableBundle != null) {
1336 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
Pete Gastaf6781d2014-10-07 15:17:05 -04001337 mInProgressLabel = wearableBundle.getCharSequence(KEY_IN_PROGRESS_LABEL);
1338 mConfirmLabel = wearableBundle.getCharSequence(KEY_CONFIRM_LABEL);
1339 mCancelLabel = wearableBundle.getCharSequence(KEY_CANCEL_LABEL);
Griff Hazen61a9e862014-05-22 16:05:19 -07001340 }
1341 }
1342
1343 /**
1344 * Apply wearable extensions to a notification action that is being built. This is
1345 * typically called by the {@link android.app.Notification.Action.Builder#extend}
1346 * method of {@link android.app.Notification.Action.Builder}.
1347 */
1348 @Override
1349 public Action.Builder extend(Action.Builder builder) {
1350 Bundle wearableBundle = new Bundle();
1351
1352 if (mFlags != DEFAULT_FLAGS) {
1353 wearableBundle.putInt(KEY_FLAGS, mFlags);
1354 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001355 if (mInProgressLabel != null) {
1356 wearableBundle.putCharSequence(KEY_IN_PROGRESS_LABEL, mInProgressLabel);
1357 }
1358 if (mConfirmLabel != null) {
1359 wearableBundle.putCharSequence(KEY_CONFIRM_LABEL, mConfirmLabel);
1360 }
1361 if (mCancelLabel != null) {
1362 wearableBundle.putCharSequence(KEY_CANCEL_LABEL, mCancelLabel);
1363 }
Griff Hazen61a9e862014-05-22 16:05:19 -07001364
1365 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
1366 return builder;
1367 }
1368
1369 @Override
1370 public WearableExtender clone() {
1371 WearableExtender that = new WearableExtender();
1372 that.mFlags = this.mFlags;
Pete Gastaf6781d2014-10-07 15:17:05 -04001373 that.mInProgressLabel = this.mInProgressLabel;
1374 that.mConfirmLabel = this.mConfirmLabel;
1375 that.mCancelLabel = this.mCancelLabel;
Griff Hazen61a9e862014-05-22 16:05:19 -07001376 return that;
1377 }
1378
1379 /**
1380 * Set whether this action is available when the wearable device is not connected to
1381 * a companion device. The user can still trigger this action when the wearable device is
1382 * offline, but a visual hint will indicate that the action may not be available.
1383 * Defaults to true.
1384 */
1385 public WearableExtender setAvailableOffline(boolean availableOffline) {
1386 setFlag(FLAG_AVAILABLE_OFFLINE, availableOffline);
1387 return this;
1388 }
1389
1390 /**
1391 * Get whether this action is available when the wearable device is not connected to
1392 * a companion device. The user can still trigger this action when the wearable device is
1393 * offline, but a visual hint will indicate that the action may not be available.
1394 * Defaults to true.
1395 */
1396 public boolean isAvailableOffline() {
1397 return (mFlags & FLAG_AVAILABLE_OFFLINE) != 0;
1398 }
1399
1400 private void setFlag(int mask, boolean value) {
1401 if (value) {
1402 mFlags |= mask;
1403 } else {
1404 mFlags &= ~mask;
1405 }
1406 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001407
1408 /**
1409 * Set a label to display while the wearable is preparing to automatically execute the
1410 * action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1411 *
1412 * @param label the label to display while the action is being prepared to execute
1413 * @return this object for method chaining
1414 */
1415 public WearableExtender setInProgressLabel(CharSequence label) {
1416 mInProgressLabel = label;
1417 return this;
1418 }
1419
1420 /**
1421 * Get the label to display while the wearable is preparing to automatically execute
1422 * the action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1423 *
1424 * @return the label to display while the action is being prepared to execute
1425 */
1426 public CharSequence getInProgressLabel() {
1427 return mInProgressLabel;
1428 }
1429
1430 /**
1431 * Set a label to display to confirm that the action should be executed.
1432 * This is usually an imperative verb like "Send".
1433 *
1434 * @param label the label to confirm the action should be executed
1435 * @return this object for method chaining
1436 */
1437 public WearableExtender setConfirmLabel(CharSequence label) {
1438 mConfirmLabel = label;
1439 return this;
1440 }
1441
1442 /**
1443 * Get the label to display to confirm that the action should be executed.
1444 * This is usually an imperative verb like "Send".
1445 *
1446 * @return the label to confirm the action should be executed
1447 */
1448 public CharSequence getConfirmLabel() {
1449 return mConfirmLabel;
1450 }
1451
1452 /**
1453 * Set a label to display to cancel the action.
1454 * This is usually an imperative verb, like "Cancel".
1455 *
1456 * @param label the label to display to cancel the action
1457 * @return this object for method chaining
1458 */
1459 public WearableExtender setCancelLabel(CharSequence label) {
1460 mCancelLabel = label;
1461 return this;
1462 }
1463
1464 /**
1465 * Get the label to display to cancel the action.
1466 * This is usually an imperative verb like "Cancel".
1467 *
1468 * @return the label to display to cancel the action
1469 */
1470 public CharSequence getCancelLabel() {
1471 return mCancelLabel;
1472 }
Alex Hills9ab3a232016-04-05 14:54:56 -04001473
1474 /**
1475 * Set a hint that this Action will launch an {@link Activity} directly, telling the
1476 * platform that it can generate the appropriate transitions.
1477 * @param hintLaunchesActivity {@code true} if the content intent will launch
1478 * an activity and transitions should be generated, false otherwise.
1479 * @return this object for method chaining
1480 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001481 public WearableExtender setHintLaunchesActivity(
Alex Hills9ab3a232016-04-05 14:54:56 -04001482 boolean hintLaunchesActivity) {
1483 setFlag(FLAG_HINT_LAUNCHES_ACTIVITY, hintLaunchesActivity);
1484 return this;
1485 }
1486
1487 /**
1488 * Get a hint that this Action will launch an {@link Activity} directly, telling the
1489 * platform that it can generate the appropriate transitions
1490 * @return {@code true} if the content intent will launch an activity and transitions
1491 * should be generated, false otherwise. The default value is {@code false} if this was
1492 * never set.
1493 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001494 public boolean getHintLaunchesActivity() {
Alex Hills9ab3a232016-04-05 14:54:56 -04001495 return (mFlags & FLAG_HINT_LAUNCHES_ACTIVITY) != 0;
1496 }
Alex Hills9f087612016-06-07 09:08:59 -04001497
1498 /**
1499 * Set a hint that this Action should be displayed inline.
1500 *
1501 * @param hintDisplayInline {@code true} if action should be displayed inline, false
1502 * otherwise
1503 * @return this object for method chaining
1504 */
1505 public WearableExtender setHintDisplayActionInline(
1506 boolean hintDisplayInline) {
1507 setFlag(FLAG_HINT_DISPLAY_INLINE, hintDisplayInline);
1508 return this;
1509 }
1510
1511 /**
1512 * Get a hint that this Action should be displayed inline.
1513 *
1514 * @return {@code true} if the Action should be displayed inline, {@code false}
1515 * otherwise. The default value is {@code false} if this was never set.
1516 */
1517 public boolean getHintDisplayActionInline() {
1518 return (mFlags & FLAG_HINT_DISPLAY_INLINE) != 0;
1519 }
Griff Hazen61a9e862014-05-22 16:05:19 -07001520 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001521 }
1522
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001523 /**
1524 * Array of all {@link Action} structures attached to this notification by
1525 * {@link Builder#addAction(int, CharSequence, PendingIntent)}. Mostly useful for instances of
1526 * {@link android.service.notification.NotificationListenerService} that provide an alternative
1527 * interface for invoking actions.
1528 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -05001529 public Action[] actions;
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001530
1531 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001532 * Replacement version of this notification whose content will be shown
1533 * in an insecure context such as atop a secure keyguard. See {@link #visibility}
1534 * and {@link #VISIBILITY_PUBLIC}.
1535 */
1536 public Notification publicVersion;
1537
1538 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001539 * Constructs a Notification object with default values.
Joe Onorato46439ce2010-11-19 13:56:21 -08001540 * You might want to consider using {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001541 */
1542 public Notification()
1543 {
1544 this.when = System.currentTimeMillis();
Selim Cinekb85f36fd2016-04-20 18:46:36 -07001545 this.creationTime = System.currentTimeMillis();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001546 this.priority = PRIORITY_DEFAULT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001547 }
1548
1549 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001550 * @hide
1551 */
1552 public Notification(Context context, int icon, CharSequence tickerText, long when,
1553 CharSequence contentTitle, CharSequence contentText, Intent contentIntent)
1554 {
Chris Wren1ce4b6d2015-06-11 10:19:43 -04001555 new Builder(context)
1556 .setWhen(when)
1557 .setSmallIcon(icon)
1558 .setTicker(tickerText)
1559 .setContentTitle(contentTitle)
1560 .setContentText(contentText)
1561 .setContentIntent(PendingIntent.getActivity(context, 0, contentIntent, 0))
1562 .buildInto(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001563 }
1564
1565 /**
1566 * Constructs a Notification object with the information needed to
1567 * have a status bar icon without the standard expanded view.
1568 *
1569 * @param icon The resource id of the icon to put in the status bar.
1570 * @param tickerText The text that flows by in the status bar when the notification first
1571 * activates.
1572 * @param when The time to show in the time field. In the System.currentTimeMillis
1573 * timebase.
Joe Onorato46439ce2010-11-19 13:56:21 -08001574 *
1575 * @deprecated Use {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001576 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001577 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001578 public Notification(int icon, CharSequence tickerText, long when)
1579 {
1580 this.icon = icon;
1581 this.tickerText = tickerText;
1582 this.when = when;
Selim Cinekb85f36fd2016-04-20 18:46:36 -07001583 this.creationTime = System.currentTimeMillis();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001584 }
1585
1586 /**
1587 * Unflatten the notification from a parcel.
1588 */
Svet Ganovddb94882016-06-23 19:55:24 -07001589 @SuppressWarnings("unchecked")
1590 public Notification(Parcel parcel) {
1591 // IMPORTANT: Add unmarshaling code in readFromParcel as the pending
1592 // intents in extras are always written as the last entry.
1593 readFromParcelImpl(parcel);
1594 // Must be read last!
Felipe Lemedd85da62016-06-28 11:29:54 -07001595 allPendingIntents = (ArraySet<PendingIntent>) parcel.readArraySet(null);
Svet Ganovddb94882016-06-23 19:55:24 -07001596 }
1597
1598 private void readFromParcelImpl(Parcel parcel)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001599 {
1600 int version = parcel.readInt();
1601
1602 when = parcel.readLong();
Selim Cinekb85f36fd2016-04-20 18:46:36 -07001603 creationTime = parcel.readLong();
Dan Sandler3936e7a2015-05-19 20:59:12 -04001604 if (parcel.readInt() != 0) {
1605 mSmallIcon = Icon.CREATOR.createFromParcel(parcel);
Dan Sandler4e787062015-06-17 15:09:48 -04001606 if (mSmallIcon.getType() == Icon.TYPE_RESOURCE) {
1607 icon = mSmallIcon.getResId();
1608 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04001609 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001610 number = parcel.readInt();
1611 if (parcel.readInt() != 0) {
1612 contentIntent = PendingIntent.CREATOR.createFromParcel(parcel);
1613 }
1614 if (parcel.readInt() != 0) {
1615 deleteIntent = PendingIntent.CREATOR.createFromParcel(parcel);
1616 }
1617 if (parcel.readInt() != 0) {
1618 tickerText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
1619 }
1620 if (parcel.readInt() != 0) {
Joe Onorato46439ce2010-11-19 13:56:21 -08001621 tickerView = RemoteViews.CREATOR.createFromParcel(parcel);
Joe Onoratoef1e7762010-09-17 18:38:38 -04001622 }
1623 if (parcel.readInt() != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001624 contentView = RemoteViews.CREATOR.createFromParcel(parcel);
1625 }
Joe Onorato561d3852010-11-20 18:09:34 -08001626 if (parcel.readInt() != 0) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04001627 mLargeIcon = Icon.CREATOR.createFromParcel(parcel);
Joe Onorato561d3852010-11-20 18:09:34 -08001628 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001629 defaults = parcel.readInt();
1630 flags = parcel.readInt();
1631 if (parcel.readInt() != 0) {
1632 sound = Uri.CREATOR.createFromParcel(parcel);
1633 }
1634
1635 audioStreamType = parcel.readInt();
John Spurlockc0650f022014-07-19 13:22:39 -04001636 if (parcel.readInt() != 0) {
1637 audioAttributes = AudioAttributes.CREATOR.createFromParcel(parcel);
1638 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001639 vibrate = parcel.createLongArray();
1640 ledARGB = parcel.readInt();
1641 ledOnMS = parcel.readInt();
1642 ledOffMS = parcel.readInt();
1643 iconLevel = parcel.readInt();
Daniel Sandlere46cbd32010-06-17 10:35:26 -04001644
1645 if (parcel.readInt() != 0) {
1646 fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel);
1647 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001648
1649 priority = parcel.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001650
John Spurlockfd7f1e02014-03-18 16:41:57 -04001651 category = parcel.readString();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001652
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001653 mGroupKey = parcel.readString();
1654
1655 mSortKey = parcel.readString();
1656
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06001657 extras = Bundle.setDefusable(parcel.readBundle(), true); // may be null
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001658
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001659 actions = parcel.createTypedArray(Action.CREATOR); // may be null
1660
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001661 if (parcel.readInt() != 0) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001662 bigContentView = RemoteViews.CREATOR.createFromParcel(parcel);
1663 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001664
Chris Wren8fd39ec2014-02-27 17:43:26 -05001665 if (parcel.readInt() != 0) {
1666 headsUpContentView = RemoteViews.CREATOR.createFromParcel(parcel);
1667 }
1668
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001669 visibility = parcel.readInt();
1670
1671 if (parcel.readInt() != 0) {
1672 publicVersion = Notification.CREATOR.createFromParcel(parcel);
1673 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04001674
1675 color = parcel.readInt();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001676 }
1677
Andy Stadler110988c2010-12-03 14:29:16 -08001678 @Override
Joe Onorato18e69df2010-05-17 22:26:12 -07001679 public Notification clone() {
1680 Notification that = new Notification();
Daniel Sandler1a497d32013-04-18 14:52:45 -04001681 cloneInto(that, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001682 return that;
1683 }
Joe Onorato18e69df2010-05-17 22:26:12 -07001684
Daniel Sandler1a497d32013-04-18 14:52:45 -04001685 /**
1686 * Copy all (or if heavy is false, all except Bitmaps and RemoteViews) members
1687 * of this into that.
1688 * @hide
1689 */
1690 public void cloneInto(Notification that, boolean heavy) {
Joe Onorato18e69df2010-05-17 22:26:12 -07001691 that.when = this.when;
Selim Cinekb85f36fd2016-04-20 18:46:36 -07001692 that.creationTime = this.creationTime;
Dan Sandlerd63f9322015-05-06 15:18:49 -04001693 that.mSmallIcon = this.mSmallIcon;
Joe Onorato18e69df2010-05-17 22:26:12 -07001694 that.number = this.number;
1695
1696 // PendingIntents are global, so there's no reason (or way) to clone them.
1697 that.contentIntent = this.contentIntent;
1698 that.deleteIntent = this.deleteIntent;
Daniel Sandlere46cbd32010-06-17 10:35:26 -04001699 that.fullScreenIntent = this.fullScreenIntent;
Joe Onorato18e69df2010-05-17 22:26:12 -07001700
1701 if (this.tickerText != null) {
1702 that.tickerText = this.tickerText.toString();
1703 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04001704 if (heavy && this.tickerView != null) {
Joe Onorato46439ce2010-11-19 13:56:21 -08001705 that.tickerView = this.tickerView.clone();
Joe Onoratoef1e7762010-09-17 18:38:38 -04001706 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04001707 if (heavy && this.contentView != null) {
Joe Onorato18e69df2010-05-17 22:26:12 -07001708 that.contentView = this.contentView.clone();
1709 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04001710 if (heavy && this.mLargeIcon != null) {
1711 that.mLargeIcon = this.mLargeIcon;
Joe Onorato561d3852010-11-20 18:09:34 -08001712 }
Jozef BABJAKa8b91832011-02-22 08:05:08 +01001713 that.iconLevel = this.iconLevel;
Joe Onorato18e69df2010-05-17 22:26:12 -07001714 that.sound = this.sound; // android.net.Uri is immutable
1715 that.audioStreamType = this.audioStreamType;
John Spurlockc0650f022014-07-19 13:22:39 -04001716 if (this.audioAttributes != null) {
1717 that.audioAttributes = new AudioAttributes.Builder(this.audioAttributes).build();
1718 }
Joe Onorato18e69df2010-05-17 22:26:12 -07001719
1720 final long[] vibrate = this.vibrate;
1721 if (vibrate != null) {
1722 final int N = vibrate.length;
1723 final long[] vib = that.vibrate = new long[N];
1724 System.arraycopy(vibrate, 0, vib, 0, N);
1725 }
1726
1727 that.ledARGB = this.ledARGB;
1728 that.ledOnMS = this.ledOnMS;
1729 that.ledOffMS = this.ledOffMS;
1730 that.defaults = this.defaults;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001731
Joe Onorato18e69df2010-05-17 22:26:12 -07001732 that.flags = this.flags;
1733
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001734 that.priority = this.priority;
Joe Malin8d40d042012-11-05 11:36:40 -08001735
John Spurlockfd7f1e02014-03-18 16:41:57 -04001736 that.category = this.category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001737
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001738 that.mGroupKey = this.mGroupKey;
1739
1740 that.mSortKey = this.mSortKey;
1741
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001742 if (this.extras != null) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001743 try {
1744 that.extras = new Bundle(this.extras);
1745 // will unparcel
1746 that.extras.size();
1747 } catch (BadParcelableException e) {
1748 Log.e(TAG, "could not unparcel extras from notification: " + this, e);
1749 that.extras = null;
1750 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001751 }
1752
Felipe Lemedd85da62016-06-28 11:29:54 -07001753 if (!ArrayUtils.isEmpty(allPendingIntents)) {
1754 that.allPendingIntents = new ArraySet<>(allPendingIntents);
Svet Ganovddb94882016-06-23 19:55:24 -07001755 }
1756
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001757 if (this.actions != null) {
1758 that.actions = new Action[this.actions.length];
1759 for(int i=0; i<this.actions.length; i++) {
1760 that.actions[i] = this.actions[i].clone();
1761 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001762 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001763
Daniel Sandler1a497d32013-04-18 14:52:45 -04001764 if (heavy && this.bigContentView != null) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001765 that.bigContentView = this.bigContentView.clone();
1766 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04001767
Chris Wren8fd39ec2014-02-27 17:43:26 -05001768 if (heavy && this.headsUpContentView != null) {
1769 that.headsUpContentView = this.headsUpContentView.clone();
1770 }
1771
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001772 that.visibility = this.visibility;
1773
1774 if (this.publicVersion != null) {
1775 that.publicVersion = new Notification();
1776 this.publicVersion.cloneInto(that.publicVersion, heavy);
1777 }
1778
Dan Sandler26e81cf2014-05-06 10:01:27 -04001779 that.color = this.color;
1780
Daniel Sandler1a497d32013-04-18 14:52:45 -04001781 if (!heavy) {
1782 that.lightenPayload(); // will clean out extras
1783 }
1784 }
1785
1786 /**
1787 * Removes heavyweight parts of the Notification object for archival or for sending to
1788 * listeners when the full contents are not necessary.
1789 * @hide
1790 */
1791 public final void lightenPayload() {
1792 tickerView = null;
1793 contentView = null;
1794 bigContentView = null;
Chris Wren8fd39ec2014-02-27 17:43:26 -05001795 headsUpContentView = null;
Dan Sandlerd63f9322015-05-06 15:18:49 -04001796 mLargeIcon = null;
Dan Sandler50128532015-12-08 15:42:41 -05001797 if (extras != null && !extras.isEmpty()) {
1798 final Set<String> keyset = extras.keySet();
1799 final int N = keyset.size();
1800 final String[] keys = keyset.toArray(new String[N]);
1801 for (int i=0; i<N; i++) {
1802 final String key = keys[i];
1803 final Object obj = extras.get(key);
1804 if (obj != null &&
1805 ( obj instanceof Parcelable
1806 || obj instanceof Parcelable[]
1807 || obj instanceof SparseArray
1808 || obj instanceof ArrayList)) {
1809 extras.remove(key);
1810 }
1811 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04001812 }
Joe Onorato18e69df2010-05-17 22:26:12 -07001813 }
1814
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001815 /**
1816 * Make sure this CharSequence is safe to put into a bundle, which basically
1817 * means it had better not be some custom Parcelable implementation.
1818 * @hide
1819 */
1820 public static CharSequence safeCharSequence(CharSequence cs) {
Christoph Studer535ec612014-09-03 15:47:47 +02001821 if (cs == null) return cs;
1822 if (cs.length() > MAX_CHARSEQUENCE_LENGTH) {
1823 cs = cs.subSequence(0, MAX_CHARSEQUENCE_LENGTH);
1824 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001825 if (cs instanceof Parcelable) {
1826 Log.e(TAG, "warning: " + cs.getClass().getCanonicalName()
1827 + " instance is a custom Parcelable and not allowed in Notification");
1828 return cs.toString();
1829 }
Selim Cinek60a54252016-02-26 17:03:25 -08001830 return removeTextSizeSpans(cs);
1831 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001832
Selim Cinek60a54252016-02-26 17:03:25 -08001833 private static CharSequence removeTextSizeSpans(CharSequence charSequence) {
1834 if (charSequence instanceof Spanned) {
1835 Spanned ss = (Spanned) charSequence;
1836 Object[] spans = ss.getSpans(0, ss.length(), Object.class);
1837 SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
1838 for (Object span : spans) {
1839 Object resultSpan = span;
Selim Cinek89991a22016-03-07 19:51:54 -08001840 if (resultSpan instanceof CharacterStyle) {
1841 resultSpan = ((CharacterStyle) span).getUnderlying();
1842 }
1843 if (resultSpan instanceof TextAppearanceSpan) {
1844 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
Selim Cinek60a54252016-02-26 17:03:25 -08001845 resultSpan = new TextAppearanceSpan(
1846 originalSpan.getFamily(),
1847 originalSpan.getTextStyle(),
1848 -1,
1849 originalSpan.getTextColor(),
1850 originalSpan.getLinkTextColor());
Selim Cinek89991a22016-03-07 19:51:54 -08001851 } else if (resultSpan instanceof RelativeSizeSpan
1852 || resultSpan instanceof AbsoluteSizeSpan) {
Selim Cinek60a54252016-02-26 17:03:25 -08001853 continue;
Selim Cinek89991a22016-03-07 19:51:54 -08001854 } else {
1855 resultSpan = span;
Selim Cinek60a54252016-02-26 17:03:25 -08001856 }
1857 builder.setSpan(resultSpan, ss.getSpanStart(span), ss.getSpanEnd(span),
1858 ss.getSpanFlags(span));
1859 }
1860 return builder;
1861 }
1862 return charSequence;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001863 }
1864
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001865 public int describeContents() {
1866 return 0;
1867 }
1868
1869 /**
Dan Sandler4e787062015-06-17 15:09:48 -04001870 * Flatten this notification into a parcel.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001871 */
Svet Ganovddb94882016-06-23 19:55:24 -07001872 public void writeToParcel(Parcel parcel, int flags) {
1873 // We need to mark all pending intents getting into the notification
1874 // system as being put there to later allow the notification ranker
1875 // to launch them and by doing so add the app to the battery saver white
1876 // list for a short period of time. The problem is that the system
1877 // cannot look into the extras as there may be parcelables there that
1878 // the platform does not know how to handle. To go around that we have
1879 // an explicit list of the pending intents in the extras bundle.
Felipe Lemedd85da62016-06-28 11:29:54 -07001880 final boolean collectPendingIntents = (allPendingIntents == null);
Svet Ganovddb94882016-06-23 19:55:24 -07001881 if (collectPendingIntents) {
1882 PendingIntent.setOnMarshaledListener(
1883 (PendingIntent intent, Parcel out, int outFlags) -> {
1884 if (parcel == out) {
Felipe Lemedd85da62016-06-28 11:29:54 -07001885 if (allPendingIntents == null) {
1886 allPendingIntents = new ArraySet<>();
Svet Ganovddb94882016-06-23 19:55:24 -07001887 }
Felipe Lemedd85da62016-06-28 11:29:54 -07001888 allPendingIntents.add(intent);
Svet Ganovddb94882016-06-23 19:55:24 -07001889 }
1890 });
1891 }
1892 try {
1893 // IMPORTANT: Add marshaling code in writeToParcelImpl as we
1894 // want to intercept all pending events written to the pacel.
1895 writeToParcelImpl(parcel, flags);
1896 // Must be written last!
Felipe Lemedd85da62016-06-28 11:29:54 -07001897 parcel.writeArraySet(allPendingIntents);
Svet Ganovddb94882016-06-23 19:55:24 -07001898 } finally {
1899 if (collectPendingIntents) {
1900 PendingIntent.setOnMarshaledListener(null);
1901 }
1902 }
1903 }
1904
1905 private void writeToParcelImpl(Parcel parcel, int flags) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001906 parcel.writeInt(1);
1907
1908 parcel.writeLong(when);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07001909 parcel.writeLong(creationTime);
Dan Sandler4e787062015-06-17 15:09:48 -04001910 if (mSmallIcon == null && icon != 0) {
1911 // you snuck an icon in here without using the builder; let's try to keep it
1912 mSmallIcon = Icon.createWithResource("", icon);
1913 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04001914 if (mSmallIcon != null) {
1915 parcel.writeInt(1);
1916 mSmallIcon.writeToParcel(parcel, 0);
1917 } else {
1918 parcel.writeInt(0);
1919 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001920 parcel.writeInt(number);
1921 if (contentIntent != null) {
1922 parcel.writeInt(1);
1923 contentIntent.writeToParcel(parcel, 0);
1924 } else {
1925 parcel.writeInt(0);
1926 }
1927 if (deleteIntent != null) {
1928 parcel.writeInt(1);
1929 deleteIntent.writeToParcel(parcel, 0);
1930 } else {
1931 parcel.writeInt(0);
1932 }
1933 if (tickerText != null) {
1934 parcel.writeInt(1);
1935 TextUtils.writeToParcel(tickerText, parcel, flags);
1936 } else {
1937 parcel.writeInt(0);
1938 }
Joe Onorato46439ce2010-11-19 13:56:21 -08001939 if (tickerView != null) {
Joe Onoratoef1e7762010-09-17 18:38:38 -04001940 parcel.writeInt(1);
Joe Onorato46439ce2010-11-19 13:56:21 -08001941 tickerView.writeToParcel(parcel, 0);
Joe Onoratoef1e7762010-09-17 18:38:38 -04001942 } else {
1943 parcel.writeInt(0);
1944 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001945 if (contentView != null) {
1946 parcel.writeInt(1);
1947 contentView.writeToParcel(parcel, 0);
1948 } else {
1949 parcel.writeInt(0);
1950 }
Selim Cinek279fa862016-06-14 10:57:25 -07001951 if (mLargeIcon == null && largeIcon != null) {
1952 // you snuck an icon in here without using the builder; let's try to keep it
1953 mLargeIcon = Icon.createWithBitmap(largeIcon);
1954 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04001955 if (mLargeIcon != null) {
Joe Onorato561d3852010-11-20 18:09:34 -08001956 parcel.writeInt(1);
Dan Sandlerd63f9322015-05-06 15:18:49 -04001957 mLargeIcon.writeToParcel(parcel, 0);
Joe Onorato561d3852010-11-20 18:09:34 -08001958 } else {
1959 parcel.writeInt(0);
1960 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001961
1962 parcel.writeInt(defaults);
1963 parcel.writeInt(this.flags);
1964
1965 if (sound != null) {
1966 parcel.writeInt(1);
1967 sound.writeToParcel(parcel, 0);
1968 } else {
1969 parcel.writeInt(0);
1970 }
1971 parcel.writeInt(audioStreamType);
John Spurlockc0650f022014-07-19 13:22:39 -04001972
1973 if (audioAttributes != null) {
1974 parcel.writeInt(1);
1975 audioAttributes.writeToParcel(parcel, 0);
1976 } else {
1977 parcel.writeInt(0);
1978 }
1979
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001980 parcel.writeLongArray(vibrate);
1981 parcel.writeInt(ledARGB);
1982 parcel.writeInt(ledOnMS);
1983 parcel.writeInt(ledOffMS);
1984 parcel.writeInt(iconLevel);
Daniel Sandlere46cbd32010-06-17 10:35:26 -04001985
1986 if (fullScreenIntent != null) {
1987 parcel.writeInt(1);
1988 fullScreenIntent.writeToParcel(parcel, 0);
1989 } else {
1990 parcel.writeInt(0);
1991 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001992
1993 parcel.writeInt(priority);
Joe Malin8d40d042012-11-05 11:36:40 -08001994
John Spurlockfd7f1e02014-03-18 16:41:57 -04001995 parcel.writeString(category);
Joe Malin8d40d042012-11-05 11:36:40 -08001996
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001997 parcel.writeString(mGroupKey);
1998
1999 parcel.writeString(mSortKey);
2000
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002001 parcel.writeBundle(extras); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002002
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002003 parcel.writeTypedArray(actions, 0); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002004
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002005 if (bigContentView != null) {
2006 parcel.writeInt(1);
2007 bigContentView.writeToParcel(parcel, 0);
2008 } else {
2009 parcel.writeInt(0);
2010 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002011
Chris Wren8fd39ec2014-02-27 17:43:26 -05002012 if (headsUpContentView != null) {
2013 parcel.writeInt(1);
2014 headsUpContentView.writeToParcel(parcel, 0);
2015 } else {
2016 parcel.writeInt(0);
2017 }
2018
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002019 parcel.writeInt(visibility);
2020
2021 if (publicVersion != null) {
2022 parcel.writeInt(1);
2023 publicVersion.writeToParcel(parcel, 0);
2024 } else {
2025 parcel.writeInt(0);
2026 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04002027
2028 parcel.writeInt(color);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002029 }
2030
2031 /**
2032 * Parcelable.Creator that instantiates Notification objects
2033 */
2034 public static final Parcelable.Creator<Notification> CREATOR
2035 = new Parcelable.Creator<Notification>()
2036 {
2037 public Notification createFromParcel(Parcel parcel)
2038 {
2039 return new Notification(parcel);
2040 }
2041
2042 public Notification[] newArray(int size)
2043 {
2044 return new Notification[size];
2045 }
2046 };
2047
2048 /**
2049 * Sets the {@link #contentView} field to be a view with the standard "Latest Event"
2050 * layout.
2051 *
2052 * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields
2053 * in the view.</p>
2054 * @param context The context for your application / activity.
2055 * @param contentTitle The title that goes in the expanded entry.
2056 * @param contentText The text that goes in the expanded entry.
2057 * @param contentIntent The intent to launch when the user clicks the expanded notification.
2058 * If this is an activity, it must include the
2059 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -08002060 * that you take care of task management as described in the
2061 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2062 * Stack</a> document.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002063 *
Joe Onorato46439ce2010-11-19 13:56:21 -08002064 * @deprecated Use {@link Builder} instead.
Chris Wrena05db382015-06-24 15:18:34 -04002065 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002066 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002067 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002068 public void setLatestEventInfo(Context context,
2069 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002070 if (context.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.LOLLIPOP_MR1){
2071 Log.e(TAG, "setLatestEventInfo() is deprecated and you should feel deprecated.",
2072 new Throwable());
2073 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002074
Selim Cinek4ac6f602016-06-13 15:47:03 -07002075 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
2076 extras.putBoolean(EXTRA_SHOW_WHEN, true);
2077 }
2078
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002079 // ensure that any information already set directly is preserved
2080 final Notification.Builder builder = new Notification.Builder(context, this);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002081
2082 // now apply the latestEventInfo fields
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002083 if (contentTitle != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002084 builder.setContentTitle(contentTitle);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002085 }
2086 if (contentText != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002087 builder.setContentText(contentText);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002088 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05002089 builder.setContentIntent(contentIntent);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002090
2091 builder.build(); // callers expect this notification to be ready to use
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002092 }
2093
Julia Reynoldsda303542015-11-23 14:00:20 -05002094 /**
2095 * @hide
2096 */
2097 public static void addFieldsFromContext(Context context, Notification notification) {
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06002098 addFieldsFromContext(context.getApplicationInfo(), context.getUserId(), notification);
2099 }
2100
2101 /**
2102 * @hide
2103 */
2104 public static void addFieldsFromContext(ApplicationInfo ai, int userId,
2105 Notification notification) {
2106 notification.extras.putParcelable(EXTRA_BUILDER_APPLICATION_INFO, ai);
2107 notification.extras.putInt(EXTRA_ORIGINATING_USERID, userId);
Julia Reynoldsda303542015-11-23 14:00:20 -05002108 }
2109
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002110 @Override
2111 public String toString() {
2112 StringBuilder sb = new StringBuilder();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002113 sb.append("Notification(pri=");
2114 sb.append(priority);
2115 sb.append(" contentView=");
Joe Onoratoc9596d62011-01-12 17:03:11 -08002116 if (contentView != null) {
2117 sb.append(contentView.getPackage());
2118 sb.append("/0x");
2119 sb.append(Integer.toHexString(contentView.getLayoutId()));
2120 } else {
2121 sb.append("null");
2122 }
2123 sb.append(" vibrate=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002124 if ((this.defaults & DEFAULT_VIBRATE) != 0) {
2125 sb.append("default");
2126 } else if (this.vibrate != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002127 int N = this.vibrate.length-1;
2128 sb.append("[");
2129 for (int i=0; i<N; i++) {
2130 sb.append(this.vibrate[i]);
2131 sb.append(',');
2132 }
Simon Schoar8cf97d92009-06-10 22:08:37 +02002133 if (N != -1) {
2134 sb.append(this.vibrate[N]);
2135 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002136 sb.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002137 } else {
2138 sb.append("null");
2139 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002140 sb.append(" sound=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002141 if ((this.defaults & DEFAULT_SOUND) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002142 sb.append("default");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002143 } else if (this.sound != null) {
2144 sb.append(this.sound.toString());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002145 } else {
2146 sb.append("null");
2147 }
Chris Wren365b6d32015-07-16 10:39:26 -04002148 if (this.tickerText != null) {
2149 sb.append(" tick");
2150 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002151 sb.append(" defaults=0x");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002152 sb.append(Integer.toHexString(this.defaults));
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002153 sb.append(" flags=0x");
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002154 sb.append(Integer.toHexString(this.flags));
Dan Sandler26e81cf2014-05-06 10:01:27 -04002155 sb.append(String.format(" color=0x%08x", this.color));
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002156 if (this.category != null) {
2157 sb.append(" category=");
2158 sb.append(this.category);
2159 }
2160 if (this.mGroupKey != null) {
2161 sb.append(" groupKey=");
2162 sb.append(this.mGroupKey);
2163 }
2164 if (this.mSortKey != null) {
2165 sb.append(" sortKey=");
2166 sb.append(this.mSortKey);
2167 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002168 if (actions != null) {
Dan Sandler1b718782014-07-18 12:43:45 -04002169 sb.append(" actions=");
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002170 sb.append(actions.length);
Dan Sandler1b718782014-07-18 12:43:45 -04002171 }
2172 sb.append(" vis=");
2173 sb.append(visibilityToString(this.visibility));
2174 if (this.publicVersion != null) {
2175 sb.append(" publicVersion=");
2176 sb.append(publicVersion.toString());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002177 }
2178 sb.append(")");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002179 return sb.toString();
2180 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002181
Dan Sandler1b718782014-07-18 12:43:45 -04002182 /**
2183 * {@hide}
2184 */
2185 public static String visibilityToString(int vis) {
2186 switch (vis) {
2187 case VISIBILITY_PRIVATE:
2188 return "PRIVATE";
2189 case VISIBILITY_PUBLIC:
2190 return "PUBLIC";
2191 case VISIBILITY_SECRET:
2192 return "SECRET";
2193 default:
2194 return "UNKNOWN(" + String.valueOf(vis) + ")";
2195 }
2196 }
2197
Joe Onoratocb109a02011-01-18 17:57:41 -08002198 /**
John Spurlock1d881a12015-03-18 19:21:54 -04002199 * {@hide}
2200 */
2201 public static String priorityToString(@Priority int pri) {
2202 switch (pri) {
2203 case PRIORITY_MIN:
2204 return "MIN";
2205 case PRIORITY_LOW:
2206 return "LOW";
2207 case PRIORITY_DEFAULT:
2208 return "DEFAULT";
2209 case PRIORITY_HIGH:
2210 return "HIGH";
2211 case PRIORITY_MAX:
2212 return "MAX";
2213 default:
2214 return "UNKNOWN(" + String.valueOf(pri) + ")";
2215 }
2216 }
2217
2218 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04002219 * The small icon representing this notification in the status bar and content view.
2220 *
2221 * @return the small icon representing this notification.
2222 *
2223 * @see Builder#getSmallIcon()
2224 * @see Builder#setSmallIcon(Icon)
2225 */
2226 public Icon getSmallIcon() {
2227 return mSmallIcon;
2228 }
2229
2230 /**
2231 * Used when notifying to clean up legacy small icons.
2232 * @hide
2233 */
2234 public void setSmallIcon(Icon icon) {
2235 mSmallIcon = icon;
2236 }
2237
2238 /**
2239 * The large icon shown in this notification's content view.
2240 * @see Builder#getLargeIcon()
2241 * @see Builder#setLargeIcon(Icon)
2242 */
2243 public Icon getLargeIcon() {
2244 return mLargeIcon;
2245 }
2246
2247 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +02002248 * @hide
2249 */
Christoph Studerc8db24b2014-07-25 17:50:30 +02002250 public boolean isGroupSummary() {
2251 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) != 0;
2252 }
2253
2254 /**
2255 * @hide
2256 */
2257 public boolean isGroupChild() {
2258 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) == 0;
2259 }
2260
2261 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002262 * Builder class for {@link Notification} objects.
Joe Malin8d40d042012-11-05 11:36:40 -08002263 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002264 * Provides a convenient way to set the various fields of a {@link Notification} and generate
Scott Main183bf112012-08-13 19:12:13 -07002265 * content views using the platform's notification layout template. If your app supports
2266 * versions of Android as old as API level 4, you can instead use
2267 * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder},
2268 * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support
2269 * library</a>.
Joe Malin8d40d042012-11-05 11:36:40 -08002270 *
Scott Main183bf112012-08-13 19:12:13 -07002271 * <p>Example:
Joe Malin8d40d042012-11-05 11:36:40 -08002272 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002273 * <pre class="prettyprint">
Scott Main183bf112012-08-13 19:12:13 -07002274 * Notification noti = new Notification.Builder(mContext)
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002275 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
2276 * .setContentText(subject)
2277 * .setSmallIcon(R.drawable.new_mail)
2278 * .setLargeIcon(aBitmap)
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002279 * .build();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002280 * </pre>
Joe Onoratocb109a02011-01-18 17:57:41 -08002281 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002282 public static class Builder {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05002283 /**
2284 * @hide
2285 */
2286 public static final String EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT =
2287 "android.rebuild.contentViewActionCount";
2288 /**
2289 * @hide
2290 */
2291 public static final String EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT
2292 = "android.rebuild.bigViewActionCount";
2293 /**
2294 * @hide
2295 */
2296 public static final String EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT
2297 = "android.rebuild.hudViewActionCount";
2298
Daniel Sandler602ad1c2012-06-12 16:06:27 -04002299 private static final int MAX_ACTION_BUTTONS = 3;
Daniel Sandler8680bf82012-05-15 16:52:52 -04002300
Joe Onorato46439ce2010-11-19 13:56:21 -08002301 private Context mContext;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002302 private Notification mN;
2303 private Bundle mUserExtras = new Bundle();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002304 private Style mStyle;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002305 private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS);
2306 private ArrayList<String> mPersonList = new ArrayList<String>();
2307 private NotificationColorUtil mColorUtil;
2308 private boolean mColorUtilInited = false;
Christoph Studer7ac80e62014-08-04 16:01:57 +02002309
2310 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -08002311 * Caches a contrast-enhanced version of {@link #mCachedContrastColorIsFor}.
2312 */
2313 private int mCachedContrastColor = COLOR_INVALID;
2314 private int mCachedContrastColorIsFor = COLOR_INVALID;
2315
2316 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002317 * Constructs a new Builder with the defaults:
Joe Onoratocb109a02011-01-18 17:57:41 -08002318 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002319
2320 * <table>
2321 * <tr><th align=right>priority</th>
2322 * <td>{@link #PRIORITY_DEFAULT}</td></tr>
2323 * <tr><th align=right>when</th>
2324 * <td>now ({@link System#currentTimeMillis()})</td></tr>
2325 * <tr><th align=right>audio stream</th>
2326 * <td>{@link #STREAM_DEFAULT}</td></tr>
2327 * </table>
Joe Onoratocb109a02011-01-18 17:57:41 -08002328 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002329
2330 * @param context
2331 * A {@link Context} that will be used by the Builder to construct the
2332 * RemoteViews. The Context will not be held past the lifetime of this Builder
2333 * object.
Joe Onoratocb109a02011-01-18 17:57:41 -08002334 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002335 public Builder(Context context) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002336 this(context, null);
Joe Onorato46439ce2010-11-19 13:56:21 -08002337 }
2338
Joe Onoratocb109a02011-01-18 17:57:41 -08002339 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002340 * @hide
Christoph Studer4600f9b2014-07-22 22:44:43 +02002341 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002342 public Builder(Context context, Notification toAdopt) {
2343 mContext = context;
Christoph Studer4600f9b2014-07-22 22:44:43 +02002344
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002345 if (toAdopt == null) {
2346 mN = new Notification();
Selim Cinek0ff1ce602016-04-05 18:27:16 -07002347 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
2348 mN.extras.putBoolean(EXTRA_SHOW_WHEN, true);
2349 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002350 mN.priority = PRIORITY_DEFAULT;
2351 mN.visibility = VISIBILITY_PRIVATE;
2352 } else {
2353 mN = toAdopt;
2354 if (mN.actions != null) {
2355 Collections.addAll(mActions, mN.actions);
Christoph Studer4600f9b2014-07-22 22:44:43 +02002356 }
2357
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002358 if (mN.extras.containsKey(EXTRA_PEOPLE)) {
2359 Collections.addAll(mPersonList, mN.extras.getStringArray(EXTRA_PEOPLE));
2360 }
2361
Selim Cinek4ac6f602016-06-13 15:47:03 -07002362 if (mN.getSmallIcon() == null && mN.icon != 0) {
2363 setSmallIcon(mN.icon);
2364 }
2365
2366 if (mN.getLargeIcon() == null && mN.largeIcon != null) {
2367 setLargeIcon(mN.largeIcon);
2368 }
2369
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002370 String templateClass = mN.extras.getString(EXTRA_TEMPLATE);
2371 if (!TextUtils.isEmpty(templateClass)) {
2372 final Class<? extends Style> styleClass
2373 = getNotificationStyleClass(templateClass);
2374 if (styleClass == null) {
2375 Log.d(TAG, "Unknown style class: " + templateClass);
2376 } else {
2377 try {
Adrian Roosc1a80b02016-04-05 14:54:55 -07002378 final Constructor<? extends Style> ctor =
2379 styleClass.getDeclaredConstructor();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002380 ctor.setAccessible(true);
2381 final Style style = ctor.newInstance();
2382 style.restoreFromExtras(mN.extras);
2383
2384 if (style != null) {
2385 setStyle(style);
2386 }
2387 } catch (Throwable t) {
2388 Log.e(TAG, "Could not create Style", t);
2389 }
2390 }
2391 }
2392
2393 }
2394 }
2395
2396 private NotificationColorUtil getColorUtil() {
2397 if (!mColorUtilInited) {
2398 mColorUtilInited = true;
2399 if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.LOLLIPOP) {
2400 mColorUtil = NotificationColorUtil.getInstance(mContext);
Christoph Studer4600f9b2014-07-22 22:44:43 +02002401 }
2402 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002403 return mColorUtil;
Christoph Studer4600f9b2014-07-22 22:44:43 +02002404 }
2405
2406 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002407 * Add a timestamp pertaining to the notification (usually the time the event occurred).
Selim Cinek0ff1ce602016-04-05 18:27:16 -07002408 *
2409 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not
2410 * shown anymore by default and must be opted into by using
2411 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002412 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002413 * @see Notification#when
Joe Onoratocb109a02011-01-18 17:57:41 -08002414 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002415 public Builder setWhen(long when) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002416 mN.when = when;
Joe Onorato46439ce2010-11-19 13:56:21 -08002417 return this;
2418 }
2419
Joe Onoratocb109a02011-01-18 17:57:41 -08002420 /**
Griff Hazen50c11652014-05-16 09:46:31 -07002421 * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown
Daniel Sandler0c890492012-09-12 17:23:10 -07002422 * in the content view.
Selim Cinek0ff1ce602016-04-05 18:27:16 -07002423 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to
2424 * {@code false}. For earlier apps, the default is {@code true}.
Daniel Sandler0c890492012-09-12 17:23:10 -07002425 */
2426 public Builder setShowWhen(boolean show) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002427 mN.extras.putBoolean(EXTRA_SHOW_WHEN, show);
Daniel Sandler0c890492012-09-12 17:23:10 -07002428 return this;
2429 }
2430
2431 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04002432 * Show the {@link Notification#when} field as a stopwatch.
Joe Malin8d40d042012-11-05 11:36:40 -08002433 *
2434 * Instead of presenting <code>when</code> as a timestamp, the notification will show an
Daniel Sandlerd33b8032012-05-10 11:41:48 -04002435 * automatically updating display of the minutes and seconds since <code>when</code>.
Daniel Sandlera2985ed2012-04-03 16:42:00 -04002436 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04002437 * Useful when showing an elapsed time (like an ongoing phone call).
2438 *
Selim Cinek81c23aa2016-02-25 16:23:13 -08002439 * The counter can also be set to count down to <code>when</code> when using
Adrian Roos96b7e202016-05-17 13:50:38 -07002440 * {@link #setChronometerCountDown(boolean)}.
Selim Cinek81c23aa2016-02-25 16:23:13 -08002441 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04002442 * @see android.widget.Chronometer
Daniel Sandlera2985ed2012-04-03 16:42:00 -04002443 * @see Notification#when
Adrian Roos96b7e202016-05-17 13:50:38 -07002444 * @see #setChronometerCountDown(boolean)
Daniel Sandlera2985ed2012-04-03 16:42:00 -04002445 */
2446 public Builder setUsesChronometer(boolean b) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002447 mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b);
Daniel Sandlera2985ed2012-04-03 16:42:00 -04002448 return this;
2449 }
2450
2451 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08002452 * Sets the Chronometer to count down instead of counting up.
2453 *
2454 * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true.
2455 * If it isn't set the chronometer will count up.
2456 *
2457 * @see #setUsesChronometer(boolean)
2458 */
Adrian Roos96b7e202016-05-17 13:50:38 -07002459 public Builder setChronometerCountDown(boolean countDown) {
2460 mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, countDown);
Selim Cinek81c23aa2016-02-25 16:23:13 -08002461 return this;
2462 }
2463
2464 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002465 * Set the small icon resource, which will be used to represent the notification in the
2466 * status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -08002467 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002468
2469 * The platform template for the expanded view will draw this icon in the left, unless a
2470 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
2471 * icon will be moved to the right-hand side.
2472 *
2473
2474 * @param icon
2475 * A resource ID in the application's package of the drawable to use.
2476 * @see Notification#icon
Joe Onoratocb109a02011-01-18 17:57:41 -08002477 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07002478 public Builder setSmallIcon(@DrawableRes int icon) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04002479 return setSmallIcon(icon != 0
2480 ? Icon.createWithResource(mContext, icon)
2481 : null);
Joe Onorato46439ce2010-11-19 13:56:21 -08002482 }
2483
Joe Onoratocb109a02011-01-18 17:57:41 -08002484 /**
2485 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
2486 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
2487 * LevelListDrawable}.
2488 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002489 * @param icon A resource ID in the application's package of the drawable to use.
Joe Onoratocb109a02011-01-18 17:57:41 -08002490 * @param level The level to use for the icon.
2491 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002492 * @see Notification#icon
2493 * @see Notification#iconLevel
Joe Onoratocb109a02011-01-18 17:57:41 -08002494 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07002495 public Builder setSmallIcon(@DrawableRes int icon, int level) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002496 mN.iconLevel = level;
Dan Sandlerd63f9322015-05-06 15:18:49 -04002497 return setSmallIcon(icon);
2498 }
2499
2500 /**
2501 * Set the small icon, which will be used to represent the notification in the
2502 * status bar and content view (unless overriden there by a
2503 * {@link #setLargeIcon(Bitmap) large icon}).
2504 *
2505 * @param icon An Icon object to use.
2506 * @see Notification#icon
2507 */
2508 public Builder setSmallIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002509 mN.setSmallIcon(icon);
2510 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
2511 mN.icon = icon.getResId();
2512 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002513 return this;
2514 }
2515
Joe Onoratocb109a02011-01-18 17:57:41 -08002516 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002517 * Set the first line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08002518 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002519 public Builder setContentTitle(CharSequence title) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002520 mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title));
Joe Onorato46439ce2010-11-19 13:56:21 -08002521 return this;
2522 }
2523
Joe Onoratocb109a02011-01-18 17:57:41 -08002524 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002525 * Set the second line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08002526 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002527 public Builder setContentText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002528 mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text));
Joe Onorato46439ce2010-11-19 13:56:21 -08002529 return this;
2530 }
2531
Joe Onoratocb109a02011-01-18 17:57:41 -08002532 /**
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07002533 * This provides some additional information that is displayed in the notification. No
2534 * guarantees are given where exactly it is displayed.
2535 *
2536 * <p>This information should only be provided if it provides an essential
2537 * benefit to the understanding of the notification. The more text you provide the
2538 * less readable it becomes. For example, an email client should only provide the account
2539 * name here if more than one email account has been added.</p>
2540 *
2541 * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the
2542 * notification header area.
2543 *
2544 * On Android versions before {@link android.os.Build.VERSION_CODES#N}
2545 * this will be shown in the third line of text in the platform notification template.
2546 * You should not be using {@link #setProgress(int, int, boolean)} at the
2547 * same time on those versions; they occupy the same place.
2548 * </p>
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002549 */
2550 public Builder setSubText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002551 mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text));
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002552 return this;
2553 }
2554
2555 /**
Adrian Roose458aa82015-12-08 16:17:19 -08002556 * Set the remote input history.
2557 *
2558 * This should be set to the most recent inputs that have been sent
2559 * through a {@link RemoteInput} of this Notification and cleared once the it is no
2560 * longer relevant (e.g. for chat notifications once the other party has responded).
2561 *
2562 * The most recent input must be stored at the 0 index, the second most recent at the
2563 * 1 index, etc. Note that the system will limit both how far back the inputs will be shown
2564 * and how much of each individual input is shown.
2565 *
2566 * <p>Note: The reply text will only be shown on notifications that have least one action
2567 * with a {@code RemoteInput}.</p>
2568 */
2569 public Builder setRemoteInputHistory(CharSequence[] text) {
2570 if (text == null) {
2571 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null);
2572 } else {
2573 final int N = Math.min(MAX_REPLY_HISTORY, text.length);
2574 CharSequence[] safe = new CharSequence[N];
2575 for (int i = 0; i < N; i++) {
2576 safe[i] = safeCharSequence(text[i]);
2577 }
2578 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe);
2579 }
2580 return this;
2581 }
2582
2583 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08002584 * Set the large number at the right-hand side of the notification. This is
2585 * equivalent to setContentInfo, although it might show the number in a different
2586 * font size for readability.
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07002587 *
2588 * @deprecated this number is not shown anywhere anymore
Joe Onoratocb109a02011-01-18 17:57:41 -08002589 */
Joe Onorato8595a3d2010-11-19 18:12:07 -08002590 public Builder setNumber(int number) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002591 mN.number = number;
Joe Onorato8595a3d2010-11-19 18:12:07 -08002592 return this;
2593 }
2594
Joe Onoratocb109a02011-01-18 17:57:41 -08002595 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002596 * A small piece of additional information pertaining to this notification.
2597 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002598 * The platform template will draw this on the last line of the notification, at the far
2599 * right (to the right of a smallIcon if it has been placed there).
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07002600 *
2601 * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header.
2602 * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this
2603 * field will still show up, but the subtext will take precedence.
Joe Onoratocb109a02011-01-18 17:57:41 -08002604 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002605 public Builder setContentInfo(CharSequence info) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002606 mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info));
Joe Onorato46439ce2010-11-19 13:56:21 -08002607 return this;
2608 }
2609
Joe Onoratocb109a02011-01-18 17:57:41 -08002610 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002611 * Set the progress this notification represents.
2612 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002613 * The platform template will represent this using a {@link ProgressBar}.
Jeff Sharkey1c400132011-08-05 14:50:13 -07002614 */
2615 public Builder setProgress(int max, int progress, boolean indeterminate) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002616 mN.extras.putInt(EXTRA_PROGRESS, progress);
2617 mN.extras.putInt(EXTRA_PROGRESS_MAX, max);
2618 mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate);
Jeff Sharkey1c400132011-08-05 14:50:13 -07002619 return this;
2620 }
2621
2622 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002623 * Supply a custom RemoteViews to use instead of the platform template.
2624 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002625 * Use {@link #setCustomContentView(RemoteViews)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08002626 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002627 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08002628 public Builder setContent(RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002629 return setCustomContentView(views);
2630 }
2631
2632 /**
2633 * Supply custom RemoteViews to use instead of the platform template.
2634 *
2635 * This will override the layout that would otherwise be constructed by this Builder
2636 * object.
2637 */
2638 public Builder setCustomContentView(RemoteViews contentView) {
2639 mN.contentView = contentView;
2640 return this;
2641 }
2642
2643 /**
2644 * Supply custom RemoteViews to use instead of the platform template in the expanded form.
2645 *
2646 * This will override the expanded layout that would otherwise be constructed by this
2647 * Builder object.
2648 */
2649 public Builder setCustomBigContentView(RemoteViews contentView) {
2650 mN.bigContentView = contentView;
2651 return this;
2652 }
2653
2654 /**
2655 * Supply custom RemoteViews to use instead of the platform template in the heads up dialog.
2656 *
2657 * This will override the heads-up layout that would otherwise be constructed by this
2658 * Builder object.
2659 */
2660 public Builder setCustomHeadsUpContentView(RemoteViews contentView) {
2661 mN.headsUpContentView = contentView;
Joe Onorato46439ce2010-11-19 13:56:21 -08002662 return this;
2663 }
2664
Joe Onoratocb109a02011-01-18 17:57:41 -08002665 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002666 * Supply a {@link PendingIntent} to be sent when the notification is clicked.
2667 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002668 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
2669 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
2670 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002671 * to assign PendingIntents to individual views in that custom layout (i.e., to create
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002672 * clickable buttons inside the notification view).
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002673 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002674 * @see Notification#contentIntent Notification.contentIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08002675 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002676 public Builder setContentIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002677 mN.contentIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08002678 return this;
2679 }
2680
Joe Onoratocb109a02011-01-18 17:57:41 -08002681 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002682 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
2683 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002684 * @see Notification#deleteIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08002685 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002686 public Builder setDeleteIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002687 mN.deleteIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08002688 return this;
2689 }
2690
Joe Onoratocb109a02011-01-18 17:57:41 -08002691 /**
2692 * An intent to launch instead of posting the notification to the status bar.
2693 * Only for use with extremely high-priority notifications demanding the user's
2694 * <strong>immediate</strong> attention, such as an incoming phone call or
2695 * alarm clock that the user has explicitly set to a particular time.
2696 * If this facility is used for something else, please give the user an option
2697 * to turn it off and use a normal notification, as this can be extremely
2698 * disruptive.
2699 *
Chris Wren47c20a12014-06-18 17:27:29 -04002700 * <p>
2701 * The system UI may choose to display a heads-up notification, instead of
2702 * launching this intent, while the user is using the device.
2703 * </p>
2704 *
Joe Onoratocb109a02011-01-18 17:57:41 -08002705 * @param intent The pending intent to launch.
2706 * @param highPriority Passing true will cause this notification to be sent
2707 * even if other notifications are suppressed.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002708 *
2709 * @see Notification#fullScreenIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08002710 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002711 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002712 mN.fullScreenIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08002713 setFlag(FLAG_HIGH_PRIORITY, highPriority);
2714 return this;
2715 }
2716
Joe Onoratocb109a02011-01-18 17:57:41 -08002717 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04002718 * Set the "ticker" text which is sent to accessibility services.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002719 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002720 * @see Notification#tickerText
Joe Onoratocb109a02011-01-18 17:57:41 -08002721 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002722 public Builder setTicker(CharSequence tickerText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002723 mN.tickerText = safeCharSequence(tickerText);
Joe Onorato46439ce2010-11-19 13:56:21 -08002724 return this;
2725 }
2726
Joe Onoratocb109a02011-01-18 17:57:41 -08002727 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04002728 * Obsolete version of {@link #setTicker(CharSequence)}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002729 *
Joe Onoratocb109a02011-01-18 17:57:41 -08002730 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04002731 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08002732 public Builder setTicker(CharSequence tickerText, RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002733 setTicker(tickerText);
2734 // views is ignored
Joe Onorato46439ce2010-11-19 13:56:21 -08002735 return this;
2736 }
2737
Joe Onoratocb109a02011-01-18 17:57:41 -08002738 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04002739 * Add a large icon to the notification content view.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002740 *
2741 * In the platform template, this image will be shown on the left of the notification view
Dan Sandlerd63f9322015-05-06 15:18:49 -04002742 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
2743 * badge atop the large icon).
Dan Sandler08a04c12015-05-06 15:18:49 -04002744 */
Dan Sandlerd63f9322015-05-06 15:18:49 -04002745 public Builder setLargeIcon(Bitmap b) {
2746 return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
2747 }
2748
2749 /**
2750 * Add a large icon to the notification content view.
2751 *
2752 * In the platform template, this image will be shown on the left of the notification view
2753 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
2754 * badge atop the large icon).
2755 */
2756 public Builder setLargeIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002757 mN.mLargeIcon = icon;
2758 mN.extras.putParcelable(EXTRA_LARGE_ICON, icon);
Joe Onorato46439ce2010-11-19 13:56:21 -08002759 return this;
2760 }
2761
Joe Onoratocb109a02011-01-18 17:57:41 -08002762 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002763 * Set the sound to play.
2764 *
John Spurlockc0650f022014-07-19 13:22:39 -04002765 * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes}
2766 * for notifications.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002767 *
Chris Wren47c20a12014-06-18 17:27:29 -04002768 * <p>
2769 * A notification that is noisy is more likely to be presented as a heads-up notification.
2770 * </p>
2771 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002772 * @see Notification#sound
Joe Onoratocb109a02011-01-18 17:57:41 -08002773 */
Joe Onorato52f80cd2010-11-21 15:34:48 -08002774 public Builder setSound(Uri sound) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002775 mN.sound = sound;
2776 mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
Joe Onorato52f80cd2010-11-21 15:34:48 -08002777 return this;
2778 }
2779
Joe Onoratocb109a02011-01-18 17:57:41 -08002780 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002781 * Set the sound to play, along with a specific stream on which to play it.
Joe Onoratocb109a02011-01-18 17:57:41 -08002782 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002783 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
2784 *
Chris Wren47c20a12014-06-18 17:27:29 -04002785 * <p>
2786 * A notification that is noisy is more likely to be presented as a heads-up notification.
2787 * </p>
John Spurlockc0650f022014-07-19 13:22:39 -04002788 * @deprecated use {@link #setSound(Uri, AudioAttributes)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002789 * @see Notification#sound
Joe Onoratocb109a02011-01-18 17:57:41 -08002790 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -07002791 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08002792 public Builder setSound(Uri sound, int streamType) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002793 mN.sound = sound;
2794 mN.audioStreamType = streamType;
Joe Onorato46439ce2010-11-19 13:56:21 -08002795 return this;
2796 }
2797
Joe Onoratocb109a02011-01-18 17:57:41 -08002798 /**
John Spurlockc0650f022014-07-19 13:22:39 -04002799 * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to
2800 * use during playback.
2801 *
2802 * <p>
2803 * A notification that is noisy is more likely to be presented as a heads-up notification.
2804 * </p>
2805 *
2806 * @see Notification#sound
2807 */
2808 public Builder setSound(Uri sound, AudioAttributes audioAttributes) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002809 mN.sound = sound;
2810 mN.audioAttributes = audioAttributes;
John Spurlockc0650f022014-07-19 13:22:39 -04002811 return this;
2812 }
2813
2814 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08002815 * Set the vibration pattern to use.
2816 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002817 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
2818 * <code>pattern</code> parameter.
2819 *
Chris Wren47c20a12014-06-18 17:27:29 -04002820 * <p>
2821 * A notification that vibrates is more likely to be presented as a heads-up notification.
2822 * </p>
2823 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002824 * @see Notification#vibrate
Joe Onoratocb109a02011-01-18 17:57:41 -08002825 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002826 public Builder setVibrate(long[] pattern) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002827 mN.vibrate = pattern;
Joe Onorato46439ce2010-11-19 13:56:21 -08002828 return this;
2829 }
2830
Joe Onoratocb109a02011-01-18 17:57:41 -08002831 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002832 * Set the desired color for the indicator LED on the device, as well as the
2833 * blink duty cycle (specified in milliseconds).
2834 *
2835
2836 * Not all devices will honor all (or even any) of these values.
2837 *
2838
2839 * @see Notification#ledARGB
2840 * @see Notification#ledOnMS
2841 * @see Notification#ledOffMS
Joe Onoratocb109a02011-01-18 17:57:41 -08002842 */
Tor Norbye80756e32015-03-02 09:39:27 -08002843 public Builder setLights(@ColorInt int argb, int onMs, int offMs) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002844 mN.ledARGB = argb;
2845 mN.ledOnMS = onMs;
2846 mN.ledOffMS = offMs;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05002847 if (onMs != 0 || offMs != 0) {
2848 mN.flags |= FLAG_SHOW_LIGHTS;
2849 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002850 return this;
2851 }
2852
Joe Onoratocb109a02011-01-18 17:57:41 -08002853 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002854 * Set whether this is an "ongoing" notification.
Joe Onoratocb109a02011-01-18 17:57:41 -08002855 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002856
2857 * Ongoing notifications cannot be dismissed by the user, so your application or service
2858 * must take care of canceling them.
2859 *
2860
2861 * They are typically used to indicate a background task that the user is actively engaged
2862 * with (e.g., playing music) or is pending in some way and therefore occupying the device
2863 * (e.g., a file download, sync operation, active network connection).
2864 *
2865
2866 * @see Notification#FLAG_ONGOING_EVENT
2867 * @see Service#setForeground(boolean)
Joe Onoratocb109a02011-01-18 17:57:41 -08002868 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002869 public Builder setOngoing(boolean ongoing) {
2870 setFlag(FLAG_ONGOING_EVENT, ongoing);
2871 return this;
2872 }
2873
Joe Onoratocb109a02011-01-18 17:57:41 -08002874 /**
2875 * Set this flag if you would only like the sound, vibrate
2876 * and ticker to be played if the notification is not already showing.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002877 *
2878 * @see Notification#FLAG_ONLY_ALERT_ONCE
Joe Onoratocb109a02011-01-18 17:57:41 -08002879 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002880 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
2881 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
2882 return this;
2883 }
2884
Joe Onoratocb109a02011-01-18 17:57:41 -08002885 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002886 * Make this notification automatically dismissed when the user touches it. The
2887 * PendingIntent set with {@link #setDeleteIntent} will be sent when this happens.
2888 *
2889 * @see Notification#FLAG_AUTO_CANCEL
Joe Onoratocb109a02011-01-18 17:57:41 -08002890 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002891 public Builder setAutoCancel(boolean autoCancel) {
Joe Onorato281d83f2011-01-04 17:13:10 -08002892 setFlag(FLAG_AUTO_CANCEL, autoCancel);
Joe Onorato46439ce2010-11-19 13:56:21 -08002893 return this;
2894 }
2895
Joe Onoratocb109a02011-01-18 17:57:41 -08002896 /**
Griff Hazendfcb0802014-02-11 12:00:00 -08002897 * Set whether or not this notification should not bridge to other devices.
2898 *
2899 * <p>Some notifications can be bridged to other devices for remote display.
2900 * This hint can be set to recommend this notification not be bridged.
2901 */
2902 public Builder setLocalOnly(boolean localOnly) {
2903 setFlag(FLAG_LOCAL_ONLY, localOnly);
2904 return this;
2905 }
2906
2907 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002908 * Set which notification properties will be inherited from system defaults.
Joe Onoratocb109a02011-01-18 17:57:41 -08002909 * <p>
2910 * The value should be one or more of the following fields combined with
2911 * bitwise-or:
2912 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
2913 * <p>
2914 * For all default values, use {@link #DEFAULT_ALL}.
2915 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002916 public Builder setDefaults(int defaults) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002917 mN.defaults = defaults;
Joe Onorato46439ce2010-11-19 13:56:21 -08002918 return this;
2919 }
2920
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002921 /**
2922 * Set the priority of this notification.
2923 *
2924 * @see Notification#priority
2925 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002926 public Builder setPriority(@Priority int pri) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002927 mN.priority = pri;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002928 return this;
2929 }
Joe Malin8d40d042012-11-05 11:36:40 -08002930
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002931 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04002932 * Set the notification category.
Joe Malin8d40d042012-11-05 11:36:40 -08002933 *
John Spurlockfd7f1e02014-03-18 16:41:57 -04002934 * @see Notification#category
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002935 */
John Spurlockfd7f1e02014-03-18 16:41:57 -04002936 public Builder setCategory(String category) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002937 mN.category = category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002938 return this;
2939 }
2940
2941 /**
Chris Wrendde75302014-03-26 17:24:15 -04002942 * Add a person that is relevant to this notification.
2943 *
Chris Wrene6c48932014-09-29 17:19:27 -04002944 * <P>
2945 * Depending on user preferences, this annotation may allow the notification to pass
2946 * through interruption filters, and to appear more prominently in the user interface.
2947 * </P>
2948 *
2949 * <P>
2950 * The person should be specified by the {@code String} representation of a
2951 * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
2952 * </P>
2953 *
2954 * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
2955 * URIs. The path part of these URIs must exist in the contacts database, in the
2956 * appropriate column, or the reference will be discarded as invalid. Telephone schema
2957 * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
2958 * </P>
2959 *
2960 * @param uri A URI for the person.
Chris Wrendde75302014-03-26 17:24:15 -04002961 * @see Notification#EXTRA_PEOPLE
2962 */
Chris Wrene6c48932014-09-29 17:19:27 -04002963 public Builder addPerson(String uri) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002964 mPersonList.add(uri);
Chris Wrendde75302014-03-26 17:24:15 -04002965 return this;
2966 }
2967
2968 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002969 * Set this notification to be part of a group of notifications sharing the same key.
2970 * Grouped notifications may display in a cluster or stack on devices which
2971 * support such rendering.
2972 *
2973 * <p>To make this notification the summary for its group, also call
2974 * {@link #setGroupSummary}. A sort order can be specified for group members by using
2975 * {@link #setSortKey}.
2976 * @param groupKey The group key of the group.
2977 * @return this object for method chaining
2978 */
2979 public Builder setGroup(String groupKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002980 mN.mGroupKey = groupKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002981 return this;
2982 }
2983
2984 /**
2985 * Set this notification to be the group summary for a group of notifications.
2986 * Grouped notifications may display in a cluster or stack on devices which
2987 * support such rendering. Requires a group key also be set using {@link #setGroup}.
2988 * @param isGroupSummary Whether this notification should be a group summary.
2989 * @return this object for method chaining
2990 */
2991 public Builder setGroupSummary(boolean isGroupSummary) {
2992 setFlag(FLAG_GROUP_SUMMARY, isGroupSummary);
2993 return this;
2994 }
2995
2996 /**
2997 * Set a sort key that orders this notification among other notifications from the
2998 * same package. This can be useful if an external sort was already applied and an app
2999 * would like to preserve this. Notifications will be sorted lexicographically using this
3000 * value, although providing different priorities in addition to providing sort key may
3001 * cause this value to be ignored.
3002 *
3003 * <p>This sort key can also be used to order members of a notification group. See
Griff Hazen9e1379f2014-05-20 12:50:51 -07003004 * {@link #setGroup}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003005 *
3006 * @see String#compareTo(String)
3007 */
3008 public Builder setSortKey(String sortKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003009 mN.mSortKey = sortKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003010 return this;
3011 }
3012
3013 /**
Griff Hazen720042b2014-02-24 15:46:56 -08003014 * Merge additional metadata into this notification.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003015 *
Griff Hazen720042b2014-02-24 15:46:56 -08003016 * <p>Values within the Bundle will replace existing extras values in this Builder.
3017 *
3018 * @see Notification#extras
3019 */
Griff Hazen959591e2014-05-15 22:26:18 -07003020 public Builder addExtras(Bundle extras) {
3021 if (extras != null) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003022 mUserExtras.putAll(extras);
Griff Hazen720042b2014-02-24 15:46:56 -08003023 }
3024 return this;
3025 }
3026
3027 /**
3028 * Set metadata for this notification.
3029 *
3030 * <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 -04003031 * current contents are copied into the Notification each time {@link #build()} is
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003032 * called.
3033 *
Griff Hazen720042b2014-02-24 15:46:56 -08003034 * <p>Replaces any existing extras values with those from the provided Bundle.
3035 * Use {@link #addExtras} to merge in metadata instead.
3036 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003037 * @see Notification#extras
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003038 */
Griff Hazen959591e2014-05-15 22:26:18 -07003039 public Builder setExtras(Bundle extras) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003040 if (extras != null) {
3041 mUserExtras = extras;
3042 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05003043 return this;
3044 }
3045
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003046 /**
Griff Hazen720042b2014-02-24 15:46:56 -08003047 * Get the current metadata Bundle used by this notification Builder.
3048 *
3049 * <p>The returned Bundle is shared with this Builder.
3050 *
3051 * <p>The current contents of this Bundle are copied into the Notification each time
3052 * {@link #build()} is called.
3053 *
3054 * @see Notification#extras
3055 */
3056 public Bundle getExtras() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003057 return mUserExtras;
3058 }
3059
3060 private Bundle getAllExtras() {
3061 final Bundle saveExtras = (Bundle) mUserExtras.clone();
3062 saveExtras.putAll(mN.extras);
3063 return saveExtras;
Griff Hazen720042b2014-02-24 15:46:56 -08003064 }
3065
3066 /**
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003067 * Add an action to this notification. Actions are typically displayed by
3068 * the system as a button adjacent to the notification content.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04003069 * <p>
3070 * Every action must have an icon (32dp square and matching the
3071 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
3072 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
3073 * <p>
3074 * A notification in its expanded form can display up to 3 actions, from left to right in
3075 * the order they were added. Actions will not be displayed when the notification is
3076 * collapsed, however, so be sure that any essential functions may be accessed by the user
3077 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003078 *
3079 * @param icon Resource ID of a drawable that represents the action.
3080 * @param title Text describing the action.
3081 * @param intent PendingIntent to be fired when the action is invoked.
Dan Sandler86647982015-05-13 23:41:13 -04003082 *
3083 * @deprecated Use {@link #addAction(Action)} instead.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003084 */
Dan Sandler86647982015-05-13 23:41:13 -04003085 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003086 public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04003087 mActions.add(new Action(icon, safeCharSequence(title), intent));
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003088 return this;
3089 }
3090
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003091 /**
Griff Hazen959591e2014-05-15 22:26:18 -07003092 * Add an action to this notification. Actions are typically displayed by
3093 * the system as a button adjacent to the notification content.
3094 * <p>
3095 * Every action must have an icon (32dp square and matching the
3096 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
3097 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
3098 * <p>
3099 * A notification in its expanded form can display up to 3 actions, from left to right in
3100 * the order they were added. Actions will not be displayed when the notification is
3101 * collapsed, however, so be sure that any essential functions may be accessed by the user
3102 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
3103 *
3104 * @param action The action to add.
3105 */
3106 public Builder addAction(Action action) {
3107 mActions.add(action);
3108 return this;
3109 }
3110
3111 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003112 * Alter the complete list of actions attached to this notification.
3113 * @see #addAction(Action).
3114 *
3115 * @param actions
3116 * @return
3117 */
3118 public Builder setActions(Action... actions) {
3119 mActions.clear();
3120 for (int i = 0; i < actions.length; i++) {
3121 mActions.add(actions[i]);
3122 }
3123 return this;
3124 }
3125
3126 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003127 * Add a rich notification style to be applied at build time.
3128 *
3129 * @param style Object responsible for modifying the notification style.
3130 */
3131 public Builder setStyle(Style style) {
3132 if (mStyle != style) {
3133 mStyle = style;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07003134 if (mStyle != null) {
3135 mStyle.setBuilder(this);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003136 mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName());
3137 } else {
3138 mN.extras.remove(EXTRA_TEMPLATE);
Daniel Sandlerc08dea22012-06-28 08:35:24 -07003139 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003140 }
3141 return this;
3142 }
3143
Dan Sandler0bf2ed82013-12-21 23:33:41 -06003144 /**
3145 * Specify the value of {@link #visibility}.
Griff Hazenb720abe2014-05-20 13:15:30 -07003146 *
Dan Sandler0bf2ed82013-12-21 23:33:41 -06003147 * @param visibility One of {@link #VISIBILITY_PRIVATE} (the default),
3148 * {@link #VISIBILITY_SECRET}, or {@link #VISIBILITY_PUBLIC}.
3149 *
3150 * @return The same Builder.
3151 */
3152 public Builder setVisibility(int visibility) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003153 mN.visibility = visibility;
Dan Sandler0bf2ed82013-12-21 23:33:41 -06003154 return this;
3155 }
3156
3157 /**
3158 * Supply a replacement Notification whose contents should be shown in insecure contexts
3159 * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}.
3160 * @param n A replacement notification, presumably with some or all info redacted.
3161 * @return The same Builder.
3162 */
3163 public Builder setPublicVersion(Notification n) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003164 if (n != null) {
3165 mN.publicVersion = new Notification();
3166 n.cloneInto(mN.publicVersion, /*heavy=*/ true);
3167 } else {
3168 mN.publicVersion = null;
3169 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06003170 return this;
3171 }
3172
Griff Hazenb720abe2014-05-20 13:15:30 -07003173 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003174 * Apply an extender to this notification builder. Extenders may be used to add
3175 * metadata or change options on this builder.
3176 */
Griff Hazen61a9e862014-05-22 16:05:19 -07003177 public Builder extend(Extender extender) {
3178 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003179 return this;
3180 }
3181
Dan Sandler4e787062015-06-17 15:09:48 -04003182 /**
3183 * @hide
3184 */
Julia Reynoldse46bb372016-03-17 11:05:58 -04003185 public Builder setFlag(int mask, boolean value) {
Joe Onorato46439ce2010-11-19 13:56:21 -08003186 if (value) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003187 mN.flags |= mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08003188 } else {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003189 mN.flags &= ~mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08003190 }
Julia Reynoldse46bb372016-03-17 11:05:58 -04003191 return this;
Joe Onorato46439ce2010-11-19 13:56:21 -08003192 }
3193
Dan Sandler26e81cf2014-05-06 10:01:27 -04003194 /**
3195 * Sets {@link Notification#color}.
3196 *
3197 * @param argb The accent color to use
3198 *
3199 * @return The same Builder.
3200 */
Tor Norbye80756e32015-03-02 09:39:27 -08003201 public Builder setColor(@ColorInt int argb) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003202 mN.color = argb;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05003203 sanitizeColor();
Dan Sandler26e81cf2014-05-06 10:01:27 -04003204 return this;
3205 }
3206
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02003207 private Drawable getProfileBadgeDrawable() {
Chris Wren66619a22016-05-12 16:42:37 -04003208 if (mContext.getUserId() == UserHandle.USER_SYSTEM) {
3209 // This user can never be a badged profile,
3210 // and also includes USER_ALL system notifications.
3211 return null;
3212 }
Christoph Studer7ac80e62014-08-04 16:01:57 +02003213 // Note: This assumes that the current user can read the profile badge of the
3214 // originating user.
Selim Cineke6ff9462016-01-15 15:07:06 -08003215 return mContext.getPackageManager().getUserBadgeForDensityNoBackground(
Julia Reynoldsda303542015-11-23 14:00:20 -05003216 new UserHandle(mContext.getUserId()), 0);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02003217 }
3218
3219 private Bitmap getProfileBadge() {
3220 Drawable badge = getProfileBadgeDrawable();
Kenny Guy8a0101b2014-05-08 23:34:12 +01003221 if (badge == null) {
3222 return null;
3223 }
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02003224 final int size = mContext.getResources().getDimensionPixelSize(
3225 R.dimen.notification_badge_size);
3226 Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
Kenny Guy8a0101b2014-05-08 23:34:12 +01003227 Canvas canvas = new Canvas(bitmap);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02003228 badge.setBounds(0, 0, size, size);
Kenny Guy8a0101b2014-05-08 23:34:12 +01003229 badge.draw(canvas);
3230 return bitmap;
3231 }
3232
Selim Cinekc848c3a2016-01-13 15:27:30 -08003233 private void bindProfileBadge(RemoteViews contentView) {
Kenny Guy98193ea2014-07-24 19:54:37 +01003234 Bitmap profileBadge = getProfileBadge();
3235
Kenny Guy98193ea2014-07-24 19:54:37 +01003236 if (profileBadge != null) {
Selim Cinekc848c3a2016-01-13 15:27:30 -08003237 contentView.setImageViewBitmap(R.id.profile_badge, profileBadge);
3238 contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE);
Kenny Guy98193ea2014-07-24 19:54:37 +01003239 }
Kenny Guy98193ea2014-07-24 19:54:37 +01003240 }
3241
Christoph Studerfe718432014-09-01 18:21:18 +02003242 private void resetStandardTemplate(RemoteViews contentView) {
Selim Cinekeaa29ca2015-11-23 13:51:13 -08003243 resetNotificationHeader(contentView);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003244 resetContentMargins(contentView);
Christoph Studerfe718432014-09-01 18:21:18 +02003245 contentView.setViewVisibility(R.id.right_icon, View.GONE);
Selim Cinek860b6da2015-12-16 19:02:19 -08003246 contentView.setViewVisibility(R.id.title, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02003247 contentView.setTextViewText(R.id.title, null);
Selim Cinek41598732016-01-11 16:58:37 -08003248 contentView.setViewVisibility(R.id.text, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02003249 contentView.setTextViewText(R.id.text, null);
Selim Cinek29603462015-11-17 19:04:39 -08003250 contentView.setViewVisibility(R.id.text_line_1, View.GONE);
Selim Cinek41598732016-01-11 16:58:37 -08003251 contentView.setTextViewText(R.id.text_line_1, null);
Christoph Studerfe718432014-09-01 18:21:18 +02003252 contentView.setViewVisibility(R.id.progress, View.GONE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003253 }
3254
Selim Cinekeaa29ca2015-11-23 13:51:13 -08003255 /**
3256 * Resets the notification header to its original state
3257 */
3258 private void resetNotificationHeader(RemoteViews contentView) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003259 contentView.setImageViewResource(R.id.icon, 0);
Selim Cinek7b836392015-12-04 20:02:59 -08003260 contentView.setBoolean(R.id.notification_header, "setExpanded", false);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003261 contentView.setTextViewText(R.id.app_name_text, null);
Christoph Studerca1db712014-09-10 17:31:33 +02003262 contentView.setViewVisibility(R.id.chronometer, View.GONE);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003263 contentView.setViewVisibility(R.id.header_text, View.GONE);
Adrian Roos9dfb78f2016-06-30 15:43:44 -07003264 contentView.setTextViewText(R.id.header_text, null);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003265 contentView.setViewVisibility(R.id.header_text_divider, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08003266 contentView.setViewVisibility(R.id.time_divider, View.GONE);
Selim Cinekb85f36fd2016-04-20 18:46:36 -07003267 contentView.setViewVisibility(R.id.time, View.GONE);
Selim Cinekc848c3a2016-01-13 15:27:30 -08003268 contentView.setImageViewIcon(R.id.profile_badge, null);
3269 contentView.setViewVisibility(R.id.profile_badge, View.GONE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003270 }
3271
3272 private void resetContentMargins(RemoteViews contentView) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07003273 contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
3274 contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
Christoph Studerfe718432014-09-01 18:21:18 +02003275 }
3276
Jorim Jaggi445d3c02014-08-19 22:33:42 +02003277 private RemoteViews applyStandardTemplate(int resId) {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02003278 return applyStandardTemplate(resId, true /* hasProgress */);
3279 }
3280
3281 /**
3282 * @param hasProgress whether the progress bar should be shown and set
3283 */
3284 private RemoteViews applyStandardTemplate(int resId, boolean hasProgress) {
Adrian Roosc1a80b02016-04-05 14:54:55 -07003285 final Bundle ex = mN.extras;
3286
3287 CharSequence title = processLegacyText(ex.getCharSequence(EXTRA_TITLE));
3288 CharSequence text = processLegacyText(ex.getCharSequence(EXTRA_TEXT));
3289 return applyStandardTemplate(resId, hasProgress, title, text);
3290 }
3291
3292 /**
3293 * @param hasProgress whether the progress bar should be shown and set
3294 */
3295 private RemoteViews applyStandardTemplate(int resId, boolean hasProgress,
3296 CharSequence title, CharSequence text) {
Kenny Guy77320062014-08-27 21:37:15 +01003297 RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId);
Dan Sandler539aad42014-08-04 00:43:39 -04003298
Christoph Studerfe718432014-09-01 18:21:18 +02003299 resetStandardTemplate(contentView);
3300
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003301 final Bundle ex = mN.extras;
Dan Sandler190d58d2014-05-15 09:33:39 -04003302
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003303 bindNotificationHeader(contentView);
3304 bindLargeIcon(contentView);
Selim Cinek954cc232016-05-20 13:29:23 -07003305 boolean showProgress = handleProgressBar(hasProgress, contentView, ex);
Adrian Roosc1a80b02016-04-05 14:54:55 -07003306 if (title != null) {
Selim Cinek860b6da2015-12-16 19:02:19 -08003307 contentView.setViewVisibility(R.id.title, View.VISIBLE);
Adrian Roosc1a80b02016-04-05 14:54:55 -07003308 contentView.setTextViewText(R.id.title, title);
Selim Cinek954cc232016-05-20 13:29:23 -07003309 contentView.setViewLayoutWidth(R.id.title, showProgress
3310 ? ViewGroup.LayoutParams.WRAP_CONTENT
3311 : ViewGroup.LayoutParams.MATCH_PARENT);
Joe Onorato561d3852010-11-20 18:09:34 -08003312 }
Adrian Roosc1a80b02016-04-05 14:54:55 -07003313 if (text != null) {
Selim Cinek41598732016-01-11 16:58:37 -08003314 int textId = showProgress ? com.android.internal.R.id.text_line_1
3315 : com.android.internal.R.id.text;
Adrian Roosc1a80b02016-04-05 14:54:55 -07003316 contentView.setTextViewText(textId, text);
Selim Cinek41598732016-01-11 16:58:37 -08003317 contentView.setViewVisibility(textId, View.VISIBLE);
Joe Onorato561d3852010-11-20 18:09:34 -08003318 }
Selim Cinekc848c3a2016-01-13 15:27:30 -08003319
Selim Cinek279fa862016-06-14 10:57:25 -07003320 setContentMinHeight(contentView, showProgress || mN.hasLargeIcon());
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003321
Selim Cinek29603462015-11-17 19:04:39 -08003322 return contentView;
3323 }
3324
Selim Cinek860b6da2015-12-16 19:02:19 -08003325 /**
3326 * @param remoteView the remote view to update the minheight in
3327 * @param hasMinHeight does it have a mimHeight
3328 * @hide
3329 */
3330 void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) {
3331 int minHeight = 0;
3332 if (hasMinHeight) {
3333 // we need to set the minHeight of the notification
3334 minHeight = mContext.getResources().getDimensionPixelSize(
3335 com.android.internal.R.dimen.notification_min_content_height);
3336 }
3337 remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight);
3338 }
3339
Selim Cinek29603462015-11-17 19:04:39 -08003340 private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003341 final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0);
3342 final int progress = ex.getInt(EXTRA_PROGRESS, 0);
3343 final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
3344 if (hasProgress && (max != 0 || ind)) {
Selim Cinek29603462015-11-17 19:04:39 -08003345 contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003346 contentView.setProgressBar(
Selim Cinek29603462015-11-17 19:04:39 -08003347 R.id.progress, max, progress, ind);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003348 contentView.setProgressBackgroundTintList(
3349 R.id.progress, ColorStateList.valueOf(mContext.getColor(
3350 R.color.notification_progress_background_color)));
Selim Cinek29603462015-11-17 19:04:39 -08003351 if (mN.color != COLOR_DEFAULT) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08003352 ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003353 contentView.setProgressTintList(R.id.progress, colorStateList);
3354 contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003355 }
Selim Cinek29603462015-11-17 19:04:39 -08003356 return true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003357 } else {
3358 contentView.setViewVisibility(R.id.progress, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08003359 return false;
Jeff Sharkey1c400132011-08-05 14:50:13 -07003360 }
Joe Onorato561d3852010-11-20 18:09:34 -08003361 }
3362
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003363 private void bindLargeIcon(RemoteViews contentView) {
Selim Cinek279fa862016-06-14 10:57:25 -07003364 if (mN.mLargeIcon == null && mN.largeIcon != null) {
3365 mN.mLargeIcon = Icon.createWithBitmap(mN.largeIcon);
3366 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003367 if (mN.mLargeIcon != null) {
3368 contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
3369 contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon);
3370 processLargeLegacyIcon(mN.mLargeIcon, contentView);
Adrian Roos2d5dbba2016-06-08 17:11:53 -07003371 int endMargin = R.dimen.notification_content_picture_margin;
3372 contentView.setViewLayoutMarginEndDimen(R.id.line1, endMargin);
3373 contentView.setViewLayoutMarginEndDimen(R.id.text, endMargin);
3374 contentView.setViewLayoutMarginEndDimen(R.id.progress, endMargin);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003375 }
3376 }
3377
3378 private void bindNotificationHeader(RemoteViews contentView) {
3379 bindSmallIcon(contentView);
3380 bindHeaderAppName(contentView);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003381 bindHeaderText(contentView);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003382 bindHeaderChronometerAndTime(contentView);
3383 bindExpandButton(contentView);
Selim Cinekc848c3a2016-01-13 15:27:30 -08003384 bindProfileBadge(contentView);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003385 }
3386
3387 private void bindExpandButton(RemoteViews contentView) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08003388 contentView.setDrawableParameters(R.id.expand_button, false, -1, resolveContrastColor(),
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003389 PorterDuff.Mode.SRC_ATOP, -1);
Selim Cinekea4bef72015-12-02 15:51:10 -08003390 contentView.setInt(R.id.notification_header, "setOriginalNotificationColor",
Adrian Roos4ff3b122016-02-01 12:26:13 -08003391 resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003392 }
3393
3394 private void bindHeaderChronometerAndTime(RemoteViews contentView) {
3395 if (showsTimeOrChronometer()) {
Selim Cinek29603462015-11-17 19:04:39 -08003396 contentView.setViewVisibility(R.id.time_divider, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003397 if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) {
3398 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
3399 contentView.setLong(R.id.chronometer, "setBase",
3400 mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
3401 contentView.setBoolean(R.id.chronometer, "setStarted", true);
Adrian Roos96b7e202016-05-17 13:50:38 -07003402 boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN);
Selim Cinekc3b752e2016-04-20 16:13:59 -07003403 contentView.setChronometerCountDown(R.id.chronometer, countsDown);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003404 } else {
3405 contentView.setViewVisibility(R.id.time, View.VISIBLE);
3406 contentView.setLong(R.id.time, "setTime", mN.when);
3407 }
Selim Cinekb85f36fd2016-04-20 18:46:36 -07003408 } else {
3409 // We still want a time to be set but gone, such that we can show and hide it
3410 // on demand in case it's a child notification without anything in the header
3411 contentView.setLong(R.id.time, "setTime", mN.when != 0 ? mN.when : mN.creationTime);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003412 }
3413 }
3414
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003415 private void bindHeaderText(RemoteViews contentView) {
3416 CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
3417 if (headerText == null && mStyle != null && mStyle.mSummaryTextSet
Selim Cinek03d0d652015-11-13 13:18:09 -05003418 && mStyle.hasSummaryInHeader()) {
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003419 headerText = mStyle.mSummaryText;
Selim Cinek03d0d652015-11-13 13:18:09 -05003420 }
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003421 if (headerText == null
3422 && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
3423 && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) {
3424 headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT);
3425 }
3426 if (headerText != null) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003427 // TODO: Remove the span entirely to only have the string with propper formating.
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003428 contentView.setTextViewText(R.id.header_text, processLegacyText(headerText));
3429 contentView.setViewVisibility(R.id.header_text, View.VISIBLE);
3430 contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003431 }
3432 }
3433
Adrian Rooseba05822016-04-22 17:09:27 -07003434 /**
3435 * @hide
3436 */
3437 public String loadHeaderAppName() {
Dan Sandler732bd6c2016-04-12 14:20:32 -04003438 CharSequence name = null;
3439 final PackageManager pm = mContext.getPackageManager();
3440 if (mN.extras.containsKey(EXTRA_SUBSTITUTE_APP_NAME)) {
3441 // only system packages which lump together a bunch of unrelated stuff
3442 // may substitute a different name to make the purpose of the
3443 // notification more clear. the correct package label should always
3444 // be accessible via SystemUI.
3445 final String pkg = mContext.getPackageName();
3446 final String subName = mN.extras.getString(EXTRA_SUBSTITUTE_APP_NAME);
3447 if (PackageManager.PERMISSION_GRANTED == pm.checkPermission(
3448 android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME, pkg)) {
3449 name = subName;
3450 } else {
3451 Log.w(TAG, "warning: pkg "
3452 + pkg + " attempting to substitute app name '" + subName
3453 + "' without holding perm "
3454 + android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME);
3455 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003456 }
Dan Sandler732bd6c2016-04-12 14:20:32 -04003457 if (TextUtils.isEmpty(name)) {
3458 name = pm.getApplicationLabel(mContext.getApplicationInfo());
3459 }
3460 if (TextUtils.isEmpty(name)) {
3461 // still nothing?
3462 return null;
3463 }
3464
3465 return String.valueOf(name);
3466 }
3467 private void bindHeaderAppName(RemoteViews contentView) {
3468 contentView.setTextViewText(R.id.app_name_text, loadHeaderAppName());
Adrian Roos4ff3b122016-02-01 12:26:13 -08003469 contentView.setTextColor(R.id.app_name_text, resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003470 }
3471
3472 private void bindSmallIcon(RemoteViews contentView) {
Selim Cinek279fa862016-06-14 10:57:25 -07003473 if (mN.mSmallIcon == null && mN.icon != 0) {
3474 mN.mSmallIcon = Icon.createWithResource(mContext, mN.icon);
3475 }
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003476 contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon);
3477 processSmallIconColor(mN.mSmallIcon, contentView);
3478 }
3479
Jorim Jaggi445d3c02014-08-19 22:33:42 +02003480 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02003481 * @return true if the built notification will show the time or the chronometer; false
3482 * otherwise
3483 */
3484 private boolean showsTimeOrChronometer() {
Selim Cinekc2c0b042016-05-18 17:13:46 -07003485 return mN.showsTime() || mN.showsChronometer();
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02003486 }
3487
Christoph Studerfe718432014-09-01 18:21:18 +02003488 private void resetStandardTemplateWithActions(RemoteViews big) {
Adrian Roos4c1fcc82016-03-31 14:39:39 -07003489 // actions_container is only reset when there are no actions to avoid focus issues with
3490 // remote inputs.
Christoph Studerfe718432014-09-01 18:21:18 +02003491 big.setViewVisibility(R.id.actions, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02003492 big.removeAllViews(R.id.actions);
Adrian Roose458aa82015-12-08 16:17:19 -08003493
3494 big.setViewVisibility(R.id.notification_material_reply_container, View.GONE);
3495 big.setTextViewText(R.id.notification_material_reply_text_1, null);
3496
3497 big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE);
3498 big.setTextViewText(R.id.notification_material_reply_text_2, null);
3499 big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE);
3500 big.setTextViewText(R.id.notification_material_reply_text_3, null);
Adrian Roosf852a422016-06-03 13:33:43 -07003501
3502 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, 0);
Christoph Studerfe718432014-09-01 18:21:18 +02003503 }
3504
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003505 private RemoteViews applyStandardTemplateWithActions(int layoutId) {
Adrian Roos48d746a2016-04-12 14:57:28 -07003506 final Bundle ex = mN.extras;
3507
3508 CharSequence title = processLegacyText(ex.getCharSequence(EXTRA_TITLE));
3509 CharSequence text = processLegacyText(ex.getCharSequence(EXTRA_TEXT));
3510 return applyStandardTemplateWithActions(layoutId, true /* hasProgress */, title, text);
3511 }
3512
3513 private RemoteViews applyStandardTemplateWithActions(int layoutId, boolean hasProgress,
3514 CharSequence title, CharSequence text) {
3515 RemoteViews big = applyStandardTemplate(layoutId, hasProgress, title, text);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003516
Christoph Studerfe718432014-09-01 18:21:18 +02003517 resetStandardTemplateWithActions(big);
3518
Adrian Roose458aa82015-12-08 16:17:19 -08003519 boolean validRemoteInput = false;
3520
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003521 int N = mActions.size();
Selim Cinek06e9e1f2016-07-08 17:14:16 -07003522 boolean emphazisedMode = mN.fullScreenIntent != null;
3523 big.setBoolean(R.id.actions, "setEmphasizedMode", emphazisedMode);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003524 if (N > 0) {
Adrian Roos7052de52016-03-03 15:53:34 -08003525 big.setViewVisibility(R.id.actions_container, View.VISIBLE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003526 big.setViewVisibility(R.id.actions, View.VISIBLE);
Adrian Roosf852a422016-06-03 13:33:43 -07003527 big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target,
3528 R.dimen.notification_action_list_height);
Daniel Sandler8680bf82012-05-15 16:52:52 -04003529 if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003530 for (int i=0; i<N; i++) {
Adrian Roose458aa82015-12-08 16:17:19 -08003531 Action action = mActions.get(i);
3532 validRemoteInput |= hasValidRemoteInput(action);
3533
Selim Cinek06e9e1f2016-07-08 17:14:16 -07003534 final RemoteViews button = generateActionButton(action, emphazisedMode,
3535 i % 2 != 0);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003536 big.addView(R.id.actions, button);
3537 }
Adrian Roos4c1fcc82016-03-31 14:39:39 -07003538 } else {
3539 big.setViewVisibility(R.id.actions_container, View.GONE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003540 }
Adrian Roose458aa82015-12-08 16:17:19 -08003541
3542 CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
3543 if (validRemoteInput && replyText != null
3544 && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])) {
3545 big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE);
3546 big.setTextViewText(R.id.notification_material_reply_text_1, replyText[0]);
3547
3548 if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])) {
3549 big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE);
3550 big.setTextViewText(R.id.notification_material_reply_text_2, replyText[1]);
3551
3552 if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])) {
3553 big.setViewVisibility(
3554 R.id.notification_material_reply_text_3, View.VISIBLE);
3555 big.setTextViewText(R.id.notification_material_reply_text_3, replyText[2]);
3556 }
3557 }
3558 }
3559
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003560 return big;
3561 }
3562
Adrian Roose458aa82015-12-08 16:17:19 -08003563 private boolean hasValidRemoteInput(Action action) {
3564 if (TextUtils.isEmpty(action.title) || action.actionIntent == null) {
3565 // Weird actions
3566 return false;
3567 }
3568
3569 RemoteInput[] remoteInputs = action.getRemoteInputs();
3570 if (remoteInputs == null) {
3571 return false;
3572 }
3573
3574 for (RemoteInput r : remoteInputs) {
3575 CharSequence[] choices = r.getChoices();
3576 if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) {
3577 return true;
3578 }
3579 }
3580 return false;
3581 }
3582
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003583 /**
3584 * Construct a RemoteViews for the final 1U notification layout. In order:
3585 * 1. Custom contentView from the caller
3586 * 2. Style's proposed content view
3587 * 3. Standard template view
3588 */
Julia Reynolds3b848122016-02-26 10:45:32 -05003589 public RemoteViews createContentView() {
Selim Cinek593610c2016-02-16 18:42:57 -08003590 if (mN.contentView != null && (mStyle == null || !mStyle.displayCustomViewInline())) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003591 return mN.contentView;
3592 } else if (mStyle != null) {
3593 final RemoteViews styleView = mStyle.makeContentView();
3594 if (styleView != null) {
3595 return styleView;
3596 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003597 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003598 return applyStandardTemplate(getBaseLayoutResource());
Joe Onorato46439ce2010-11-19 13:56:21 -08003599 }
3600
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003601 /**
3602 * Construct a RemoteViews for the final big notification layout.
3603 */
Julia Reynolds3b848122016-02-26 10:45:32 -05003604 public RemoteViews createBigContentView() {
Selim Cinek850a8542015-11-11 11:48:36 -05003605 RemoteViews result = null;
Selim Cinek593610c2016-02-16 18:42:57 -08003606 if (mN.bigContentView != null
3607 && (mStyle == null || !mStyle.displayCustomViewInline())) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05003608 return mN.bigContentView;
3609 } else if (mStyle != null) {
Selim Cinek850a8542015-11-11 11:48:36 -05003610 result = mStyle.makeBigContentView();
Selim Cinek90dcf6d2015-11-18 20:24:13 -08003611 hideLine1Text(result);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08003612 } else if (mActions.size() != 0) {
3613 result = applyStandardTemplateWithActions(getBigBaseLayoutResource());
Selim Cinek850a8542015-11-11 11:48:36 -05003614 }
3615 adaptNotificationHeaderForBigContentView(result);
3616 return result;
3617 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003618
Selim Cinekeaa29ca2015-11-23 13:51:13 -08003619 /**
3620 * Construct a RemoteViews for the final notification header only
3621 *
3622 * @hide
3623 */
3624 public RemoteViews makeNotificationHeader() {
3625 RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(),
3626 R.layout.notification_template_header);
3627 resetNotificationHeader(header);
3628 bindNotificationHeader(header);
3629 return header;
3630 }
3631
Selim Cinek29603462015-11-17 19:04:39 -08003632 private void hideLine1Text(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08003633 if (result != null) {
3634 result.setViewVisibility(R.id.text_line_1, View.GONE);
3635 }
Selim Cinek29603462015-11-17 19:04:39 -08003636 }
3637
Selim Cinek850a8542015-11-11 11:48:36 -05003638 private void adaptNotificationHeaderForBigContentView(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08003639 if (result != null) {
3640 result.setBoolean(R.id.notification_header, "setExpanded", true);
3641 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003642 }
3643
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003644 /**
3645 * Construct a RemoteViews for the final heads-up notification layout.
3646 */
Julia Reynolds3b848122016-02-26 10:45:32 -05003647 public RemoteViews createHeadsUpContentView() {
Selim Cinek593610c2016-02-16 18:42:57 -08003648 if (mN.headsUpContentView != null
3649 && (mStyle == null || !mStyle.displayCustomViewInline())) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05003650 return mN.headsUpContentView;
3651 } else if (mStyle != null) {
3652 final RemoteViews styleView = mStyle.makeHeadsUpContentView();
3653 if (styleView != null) {
3654 return styleView;
3655 }
3656 } else if (mActions.size() == 0) {
3657 return null;
3658 }
3659
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003660 return applyStandardTemplateWithActions(getBigBaseLayoutResource());
Chris Wren8fd39ec2014-02-27 17:43:26 -05003661 }
3662
Selim Cinek624c02db2015-12-14 21:00:02 -08003663 /**
3664 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
3665 *
3666 * @hide
3667 */
3668 public RemoteViews makePublicContentView() {
3669 if (mN.publicVersion != null) {
3670 final Builder builder = recoverBuilder(mContext, mN.publicVersion);
Julia Reynolds3b848122016-02-26 10:45:32 -05003671 return builder.createContentView();
Selim Cinek624c02db2015-12-14 21:00:02 -08003672 }
3673 Bundle savedBundle = mN.extras;
3674 Style style = mStyle;
3675 mStyle = null;
3676 Icon largeIcon = mN.mLargeIcon;
3677 mN.mLargeIcon = null;
Selim Cinek279fa862016-06-14 10:57:25 -07003678 Bitmap largeIconLegacy = mN.largeIcon;
3679 mN.largeIcon = null;
Selim Cinek624c02db2015-12-14 21:00:02 -08003680 Bundle publicExtras = new Bundle();
3681 publicExtras.putBoolean(EXTRA_SHOW_WHEN,
3682 savedBundle.getBoolean(EXTRA_SHOW_WHEN));
3683 publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER,
3684 savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER));
Adrian Roos96b7e202016-05-17 13:50:38 -07003685 publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN,
3686 savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN));
Selim Cinek624c02db2015-12-14 21:00:02 -08003687 publicExtras.putCharSequence(EXTRA_TITLE,
3688 mContext.getString(R.string.notification_hidden_text));
3689 mN.extras = publicExtras;
3690 final RemoteViews publicView = applyStandardTemplate(getBaseLayoutResource());
3691 mN.extras = savedBundle;
3692 mN.mLargeIcon = largeIcon;
Selim Cinek279fa862016-06-14 10:57:25 -07003693 mN.largeIcon = largeIconLegacy;
Selim Cinek624c02db2015-12-14 21:00:02 -08003694 mStyle = style;
3695 return publicView;
3696 }
3697
3698
Chris Wren8fd39ec2014-02-27 17:43:26 -05003699
Selim Cinek06e9e1f2016-07-08 17:14:16 -07003700 private RemoteViews generateActionButton(Action action, boolean emphazisedMode,
3701 boolean oddAction) {
Daniel Sandler8680bf82012-05-15 16:52:52 -04003702 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07003703 RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(),
Selim Cinek06e9e1f2016-07-08 17:14:16 -07003704 emphazisedMode ? getEmphasizedActionLayoutResource()
3705 : tombstone ? getActionTombstoneLayoutResource()
3706 : getActionLayoutResource());
Dan Sandler68079d52015-07-22 10:45:30 -04003707 final Icon ai = action.getIcon();
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003708 button.setTextViewText(R.id.action0, processLegacyText(action.title));
Daniel Sandler8680bf82012-05-15 16:52:52 -04003709 if (!tombstone) {
Daniel Sandlere5518842012-05-10 16:20:40 -04003710 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
Daniel Sandlere5518842012-05-10 16:20:40 -04003711 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003712 button.setContentDescription(R.id.action0, action.title);
Adrian Roosfe84e1f2015-11-04 15:55:39 -08003713 if (action.mRemoteInputs != null) {
3714 button.setRemoteInputs(R.id.action0, action.mRemoteInputs);
3715 }
Selim Cinek06e9e1f2016-07-08 17:14:16 -07003716 if (emphazisedMode) {
3717 // change the background color
3718 int color = resolveContrastColor();
3719 if (oddAction) {
3720 color = NotificationColorUtil.lightenColor(color, 10);
3721 }
3722 button.setDrawableParameters(R.id.button_holder, true, -1, color,
3723 PorterDuff.Mode.SRC_ATOP, -1);
3724 } else {
3725 if (mN.color != COLOR_DEFAULT) {
3726 button.setTextColor(R.id.action0, resolveContrastColor());
3727 }
Adrian Roosfe84e1f2015-11-04 15:55:39 -08003728 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003729 return button;
3730 }
3731
Joe Onoratocb109a02011-01-18 17:57:41 -08003732 /**
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003733 * @return Whether we are currently building a notification from a legacy (an app that
Alan Viverette3cb07a462014-06-06 14:19:53 -07003734 * doesn't create material notifications by itself) app.
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003735 */
3736 private boolean isLegacy() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003737 return getColorUtil() != null;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003738 }
3739
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003740 private CharSequence processLegacyText(CharSequence charSequence) {
3741 if (isLegacy()) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003742 return getColorUtil().invertCharSequenceColors(charSequence);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003743 } else {
3744 return charSequence;
3745 }
3746 }
3747
Dan Sandler26e81cf2014-05-06 10:01:27 -04003748 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003749 * Apply any necessariy colors to the small icon
Dan Sandler26e81cf2014-05-06 10:01:27 -04003750 */
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003751 private void processSmallIconColor(Icon smallIcon, RemoteViews contentView) {
Selim Cinekea4bef72015-12-02 15:51:10 -08003752 boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon);
3753 if (colorable) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08003754 contentView.setDrawableParameters(R.id.icon, false, -1, resolveContrastColor(),
Jorim Jaggi92df1f22014-12-16 19:44:41 +01003755 PorterDuff.Mode.SRC_ATOP, -1);
Selim Cinekea4bef72015-12-02 15:51:10 -08003756
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003757 }
Selim Cinekea4bef72015-12-02 15:51:10 -08003758 contentView.setInt(R.id.notification_header, "setOriginalIconColor",
Adrian Roos4ff3b122016-02-01 12:26:13 -08003759 colorable ? resolveContrastColor() : NotificationHeaderView.NO_COLOR);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003760 }
3761
Dan Sandler26e81cf2014-05-06 10:01:27 -04003762 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003763 * Make the largeIcon dark if it's a fake smallIcon (that is,
Dan Sandler26e81cf2014-05-06 10:01:27 -04003764 * if it's grayscale).
3765 */
3766 // TODO: also check bounds, transparency, that sort of thing.
Dan Sandlerd63f9322015-05-06 15:18:49 -04003767 private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) {
3768 if (largeIcon != null && isLegacy()
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003769 && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003770 // resolve color will fall back to the default when legacy
Adrian Roos4ff3b122016-02-01 12:26:13 -08003771 contentView.setDrawableParameters(R.id.icon, false, -1, resolveContrastColor(),
Dan Sandler190d58d2014-05-15 09:33:39 -04003772 PorterDuff.Mode.SRC_ATOP, -1);
Jorim Jaggi92df1f22014-12-16 19:44:41 +01003773 }
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003774 }
3775
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05003776 private void sanitizeColor() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003777 if (mN.color != COLOR_DEFAULT) {
3778 mN.color |= 0xFF000000; // no alpha for custom colors
Jorim Jaggi74419312014-06-10 20:57:21 +02003779 }
Jorim Jaggi74419312014-06-10 20:57:21 +02003780 }
3781
Adrian Roos4ff3b122016-02-01 12:26:13 -08003782 int resolveContrastColor() {
3783 if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) {
3784 return mCachedContrastColor;
Dan Sandler26e81cf2014-05-06 10:01:27 -04003785 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08003786 final int contrasted = NotificationColorUtil.resolveContrastColor(mContext, mN.color);
3787
3788 mCachedContrastColorIsFor = mN.color;
3789 return mCachedContrastColor = contrasted;
Dan Sandler26e81cf2014-05-06 10:01:27 -04003790 }
3791
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003792 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003793 * Apply the unstyled operations and return a new {@link Notification} object.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04003794 * @hide
Joe Onoratocb109a02011-01-18 17:57:41 -08003795 */
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04003796 public Notification buildUnstyled() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003797 if (mActions.size() > 0) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003798 mN.actions = new Action[mActions.size()];
3799 mActions.toArray(mN.actions);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003800 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003801 if (!mPersonList.isEmpty()) {
3802 mN.extras.putStringArray(EXTRA_PEOPLE,
3803 mPersonList.toArray(new String[mPersonList.size()]));
Dan Sandler0bf2ed82013-12-21 23:33:41 -06003804 }
Selim Cinek247fa012016-02-18 09:50:48 -08003805 if (mN.bigContentView != null || mN.contentView != null
3806 || mN.headsUpContentView != null) {
3807 mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true);
3808 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003809 return mN;
Joe Onorato46439ce2010-11-19 13:56:21 -08003810 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003811
Julia Reynolds3b848122016-02-26 10:45:32 -05003812 /**
3813 * Creates a Builder from an existing notification so further changes can be made.
3814 * @param context The context for your application / activity.
3815 * @param n The notification to create a Builder from.
3816 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003817 public static Notification.Builder recoverBuilder(Context context, Notification n) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02003818 // Re-create notification context so we can access app resources.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003819 ApplicationInfo applicationInfo = n.extras.getParcelable(
3820 EXTRA_BUILDER_APPLICATION_INFO);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003821 Context builderContext;
Julia Reynoldsda303542015-11-23 14:00:20 -05003822 if (applicationInfo != null) {
3823 try {
3824 builderContext = context.createApplicationContext(applicationInfo,
3825 Context.CONTEXT_RESTRICTED);
3826 } catch (NameNotFoundException e) {
3827 Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found");
3828 builderContext = context; // try with our context
3829 }
3830 } else {
3831 builderContext = context; // try with given context
Christoph Studer4600f9b2014-07-22 22:44:43 +02003832 }
3833
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003834 return new Builder(builderContext, n);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003835 }
3836
3837 private static Class<? extends Style> getNotificationStyleClass(String templateClass) {
Selim Cinek593610c2016-02-16 18:42:57 -08003838 Class<? extends Style>[] classes = new Class[] {
3839 BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class,
Alex Hillsfc737de2016-03-23 17:33:02 -04003840 DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class,
3841 MessagingStyle.class };
Christoph Studer4600f9b2014-07-22 22:44:43 +02003842 for (Class<? extends Style> innerClass : classes) {
3843 if (templateClass.equals(innerClass.getName())) {
3844 return innerClass;
3845 }
3846 }
3847 return null;
3848 }
3849
Daniel Sandlerf45564e2013-04-15 15:05:08 -04003850 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003851 * @deprecated Use {@link #build()} instead.
3852 */
3853 @Deprecated
3854 public Notification getNotification() {
3855 return build();
3856 }
3857
3858 /**
3859 * Combine all of the options that have been set and return a new {@link Notification}
3860 * object.
3861 */
3862 public Notification build() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003863 // first, add any extras from the calling code
3864 if (mUserExtras != null) {
3865 mN.extras = getAllExtras();
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07003866 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003867
Selim Cinekb85f36fd2016-04-20 18:46:36 -07003868 mN.creationTime = System.currentTimeMillis();
3869
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003870 // lazy stuff from mContext; see comment in Builder(Context, Notification)
Julia Reynoldsda303542015-11-23 14:00:20 -05003871 Notification.addFieldsFromContext(mContext, mN);
Christoph Studer943aa672014-08-03 20:31:16 +02003872
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003873 buildUnstyled();
Daniel Sandlerf45564e2013-04-15 15:05:08 -04003874
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003875 if (mStyle != null) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003876 mStyle.buildStyled(mN);
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003877 }
Daniel Sandlerf45564e2013-04-15 15:05:08 -04003878
Adrian Roos5081c0d2016-02-26 16:04:19 -08003879 if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
3880 && (mStyle == null || !mStyle.displayCustomViewInline())) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003881 if (mN.contentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05003882 mN.contentView = createContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003883 mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT,
3884 mN.contentView.getSequenceNumber());
3885 }
3886 if (mN.bigContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05003887 mN.bigContentView = createBigContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003888 if (mN.bigContentView != null) {
3889 mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT,
3890 mN.bigContentView.getSequenceNumber());
3891 }
3892 }
3893 if (mN.headsUpContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05003894 mN.headsUpContentView = createHeadsUpContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003895 if (mN.headsUpContentView != null) {
3896 mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT,
3897 mN.headsUpContentView.getSequenceNumber());
3898 }
3899 }
3900 }
3901
Julia Reynolds4c0c2022016-02-02 15:11:59 -05003902 if ((mN.defaults & DEFAULT_LIGHTS) != 0) {
3903 mN.flags |= FLAG_SHOW_LIGHTS;
3904 }
3905
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003906 return mN;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003907 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05003908
3909 /**
3910 * Apply this Builder to an existing {@link Notification} object.
3911 *
3912 * @hide
3913 */
3914 public Notification buildInto(Notification n) {
Daniel Sandler1a497d32013-04-18 14:52:45 -04003915 build().cloneInto(n, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05003916 return n;
3917 }
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003918
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003919 /**
Adrian Roos184bfe022016-03-03 13:41:44 -08003920 * Removes RemoteViews that were created for compatibility from {@param n}, if they did not
3921 * change.
3922 *
3923 * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}.
3924 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003925 * @hide
3926 */
Adrian Roos184bfe022016-03-03 13:41:44 -08003927 public static Notification maybeCloneStrippedForDelivery(Notification n) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003928 String templateClass = n.extras.getString(EXTRA_TEMPLATE);
Adrian Roos184bfe022016-03-03 13:41:44 -08003929
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003930 // Only strip views for known Styles because we won't know how to
3931 // re-create them otherwise.
Adrian Roos184bfe022016-03-03 13:41:44 -08003932 if (!TextUtils.isEmpty(templateClass)
3933 && getNotificationStyleClass(templateClass) == null) {
3934 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003935 }
Adrian Roos184bfe022016-03-03 13:41:44 -08003936
3937 // Only strip unmodified BuilderRemoteViews.
3938 boolean stripContentView = n.contentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003939 n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08003940 n.contentView.getSequenceNumber();
3941 boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003942 n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08003943 n.bigContentView.getSequenceNumber();
3944 boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003945 n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08003946 n.headsUpContentView.getSequenceNumber();
3947
3948 // Nothing to do here, no need to clone.
3949 if (!stripContentView && !stripBigContentView && !stripHeadsUpContentView) {
3950 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003951 }
Adrian Roos184bfe022016-03-03 13:41:44 -08003952
3953 Notification clone = n.clone();
3954 if (stripContentView) {
3955 clone.contentView = null;
3956 clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT);
3957 }
3958 if (stripBigContentView) {
3959 clone.bigContentView = null;
3960 clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT);
3961 }
3962 if (stripHeadsUpContentView) {
3963 clone.headsUpContentView = null;
3964 clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT);
3965 }
3966 return clone;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003967 }
3968
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003969 private int getBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003970 return R.layout.notification_template_material_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003971 }
3972
3973 private int getBigBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003974 return R.layout.notification_template_material_big_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003975 }
3976
3977 private int getBigPictureLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003978 return R.layout.notification_template_material_big_picture;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003979 }
3980
3981 private int getBigTextLayoutResource() {
Jorim Jaggi445d3c02014-08-19 22:33:42 +02003982 return R.layout.notification_template_material_big_text;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003983 }
3984
3985 private int getInboxLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003986 return R.layout.notification_template_material_inbox;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003987 }
3988
Adrian Roosc1a80b02016-04-05 14:54:55 -07003989 private int getMessagingLayoutResource() {
3990 return R.layout.notification_template_material_messaging;
3991 }
3992
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003993 private int getActionLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003994 return R.layout.notification_material_action;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003995 }
3996
Selim Cinek06e9e1f2016-07-08 17:14:16 -07003997 private int getEmphasizedActionLayoutResource() {
3998 return R.layout.notification_material_action_emphasized;
3999 }
4000
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01004001 private int getActionTombstoneLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07004002 return R.layout.notification_material_action_tombstone;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01004003 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004004 }
4005
Selim Cinek279fa862016-06-14 10:57:25 -07004006 private boolean hasLargeIcon() {
4007 return mLargeIcon != null || largeIcon != null;
4008 }
4009
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004010 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07004011 * @return true if the notification will show the time; false otherwise
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004012 * @hide
4013 */
Selim Cinekc2c0b042016-05-18 17:13:46 -07004014 public boolean showsTime() {
Selim Cinekb85f36fd2016-04-20 18:46:36 -07004015 return when != 0 && extras.getBoolean(EXTRA_SHOW_WHEN);
4016 }
4017
4018 /**
Selim Cinekc2c0b042016-05-18 17:13:46 -07004019 * @return true if the notification will show a chronometer; false otherwise
4020 * @hide
4021 */
4022 public boolean showsChronometer() {
4023 return when != 0 && extras.getBoolean(EXTRA_SHOW_CHRONOMETER);
4024 }
4025
4026 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004027 * An object that can apply a rich notification style to a {@link Notification.Builder}
4028 * object.
4029 */
Griff Hazendfcb0802014-02-11 12:00:00 -08004030 public static abstract class Style {
Chris Wrend6297db2012-05-03 16:20:13 -04004031 private CharSequence mBigContentTitle;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004032
4033 /**
4034 * @hide
4035 */
4036 protected CharSequence mSummaryText = null;
4037
4038 /**
4039 * @hide
4040 */
4041 protected boolean mSummaryTextSet = false;
Chris Wrend6297db2012-05-03 16:20:13 -04004042
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004043 protected Builder mBuilder;
4044
Chris Wrend6297db2012-05-03 16:20:13 -04004045 /**
4046 * Overrides ContentTitle in the big form of the template.
4047 * This defaults to the value passed to setContentTitle().
4048 */
4049 protected void internalSetBigContentTitle(CharSequence title) {
4050 mBigContentTitle = title;
4051 }
4052
4053 /**
4054 * Set the first line of text after the detail section in the big form of the template.
4055 */
4056 protected void internalSetSummaryText(CharSequence cs) {
4057 mSummaryText = cs;
Daniel Sandler619738c2012-06-07 16:33:08 -04004058 mSummaryTextSet = true;
Chris Wrend6297db2012-05-03 16:20:13 -04004059 }
4060
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004061 public void setBuilder(Builder builder) {
4062 if (mBuilder != builder) {
4063 mBuilder = builder;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07004064 if (mBuilder != null) {
4065 mBuilder.setStyle(this);
4066 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004067 }
4068 }
4069
Chris Wrend6297db2012-05-03 16:20:13 -04004070 protected void checkBuilder() {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004071 if (mBuilder == null) {
4072 throw new IllegalArgumentException("Style requires a valid Builder object");
4073 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004074 }
Chris Wrend6297db2012-05-03 16:20:13 -04004075
4076 protected RemoteViews getStandardView(int layoutId) {
4077 checkBuilder();
4078
Christoph Studer4600f9b2014-07-22 22:44:43 +02004079 // Nasty.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004080 CharSequence oldBuilderContentTitle =
4081 mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE);
Chris Wrend6297db2012-05-03 16:20:13 -04004082 if (mBigContentTitle != null) {
4083 mBuilder.setContentTitle(mBigContentTitle);
4084 }
4085
Chris Wrend6297db2012-05-03 16:20:13 -04004086 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId);
4087
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004088 mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle);
Christoph Studer4600f9b2014-07-22 22:44:43 +02004089
Chris Wrend6297db2012-05-03 16:20:13 -04004090 if (mBigContentTitle != null && mBigContentTitle.equals("")) {
4091 contentView.setViewVisibility(R.id.line1, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04004092 } else {
4093 contentView.setViewVisibility(R.id.line1, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04004094 }
4095
Chris Wrend6297db2012-05-03 16:20:13 -04004096 return contentView;
4097 }
4098
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004099 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004100 * Construct a Style-specific RemoteViews for the final 1U notification layout.
4101 * The default implementation has nothing additional to add.
4102 * @hide
4103 */
4104 public RemoteViews makeContentView() {
4105 return null;
4106 }
4107
4108 /**
4109 * Construct a Style-specific RemoteViews for the final big notification layout.
4110 * @hide
4111 */
4112 public RemoteViews makeBigContentView() {
4113 return null;
4114 }
4115
4116 /**
4117 * Construct a Style-specific RemoteViews for the final HUN layout.
4118 * @hide
4119 */
4120 public RemoteViews makeHeadsUpContentView() {
4121 return null;
4122 }
4123
4124 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004125 * Apply any style-specific extras to this notification before shipping it out.
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004126 * @hide
4127 */
4128 public void addExtras(Bundle extras) {
4129 if (mSummaryTextSet) {
4130 extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
4131 }
4132 if (mBigContentTitle != null) {
4133 extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
4134 }
Chris Wren91ad5632013-06-05 15:05:57 -04004135 extras.putString(EXTRA_TEMPLATE, this.getClass().getName());
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004136 }
4137
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004138 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004139 * Reconstruct the internal state of this Style object from extras.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004140 * @hide
4141 */
Christoph Studer4600f9b2014-07-22 22:44:43 +02004142 protected void restoreFromExtras(Bundle extras) {
4143 if (extras.containsKey(EXTRA_SUMMARY_TEXT)) {
4144 mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT);
4145 mSummaryTextSet = true;
4146 }
4147 if (extras.containsKey(EXTRA_TITLE_BIG)) {
4148 mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG);
4149 }
4150 }
4151
4152
4153 /**
4154 * @hide
4155 */
4156 public Notification buildStyled(Notification wip) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004157 addExtras(wip.extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02004158 return wip;
4159 }
4160
Daniel Sandler0ec46202015-06-24 01:27:05 -04004161 /**
4162 * @hide
4163 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07004164 public void purgeResources() {}
4165
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004166 /**
4167 * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is
4168 * attached to.
4169 *
4170 * @return the fully constructed Notification.
4171 */
4172 public Notification build() {
4173 checkBuilder();
4174 return mBuilder.build();
4175 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004176
4177 /**
4178 * @hide
4179 * @return true if the style positions the progress bar on the second line; false if the
4180 * style hides the progress bar
4181 */
4182 protected boolean hasProgress() {
4183 return true;
4184 }
Selim Cinek03d0d652015-11-13 13:18:09 -05004185
4186 /**
4187 * @hide
4188 * @return Whether we should put the summary be put into the notification header
4189 */
4190 public boolean hasSummaryInHeader() {
4191 return true;
4192 }
Selim Cinek593610c2016-02-16 18:42:57 -08004193
4194 /**
4195 * @hide
4196 * @return Whether custom content views are displayed inline in the style
4197 */
4198 public boolean displayCustomViewInline() {
4199 return false;
4200 }
Joe Onorato46439ce2010-11-19 13:56:21 -08004201 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004202
4203 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04004204 * Helper class for generating large-format notifications that include a large image attachment.
Joe Malin8d40d042012-11-05 11:36:40 -08004205 *
Robert Ly91c5ce32014-06-08 15:37:00 -07004206 * Here's how you'd set the <code>BigPictureStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004207 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07004208 * Notification notif = new Notification.Builder(mContext)
4209 * .setContentTitle(&quot;New photo from &quot; + sender.toString())
4210 * .setContentText(subject)
4211 * .setSmallIcon(R.drawable.new_post)
4212 * .setLargeIcon(aBitmap)
4213 * .setStyle(new Notification.BigPictureStyle()
4214 * .bigPicture(aBigBitmap))
4215 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004216 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08004217 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04004218 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004219 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004220 public static class BigPictureStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004221 private Bitmap mPicture;
Dan Sandlerd63f9322015-05-06 15:18:49 -04004222 private Icon mBigLargeIcon;
Chris Wren3745a3d2012-05-22 15:11:52 -04004223 private boolean mBigLargeIconSet = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004224
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004225 public BigPictureStyle() {
4226 }
4227
Adrian Roosf5faf9d2016-05-23 13:56:15 -07004228 /**
4229 * @deprecated use {@code BigPictureStyle()}.
4230 */
4231 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004232 public BigPictureStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004233 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004234 }
4235
Chris Wrend6297db2012-05-03 16:20:13 -04004236 /**
4237 * Overrides ContentTitle in the big form of the template.
4238 * This defaults to the value passed to setContentTitle().
4239 */
4240 public BigPictureStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004241 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04004242 return this;
4243 }
4244
4245 /**
4246 * Set the first line of text after the detail section in the big form of the template.
4247 */
4248 public BigPictureStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004249 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04004250 return this;
4251 }
4252
Chris Wren0bd664d2012-08-01 13:56:56 -04004253 /**
4254 * Provide the bitmap to be used as the payload for the BigPicture notification.
4255 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004256 public BigPictureStyle bigPicture(Bitmap b) {
4257 mPicture = b;
4258 return this;
4259 }
4260
Chris Wren3745a3d2012-05-22 15:11:52 -04004261 /**
Chris Wren3745a3d2012-05-22 15:11:52 -04004262 * Override the large icon when the big notification is shown.
4263 */
4264 public BigPictureStyle bigLargeIcon(Bitmap b) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04004265 return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
4266 }
4267
4268 /**
4269 * Override the large icon when the big notification is shown.
4270 */
4271 public BigPictureStyle bigLargeIcon(Icon icon) {
Chris Wren3745a3d2012-05-22 15:11:52 -04004272 mBigLargeIconSet = true;
Dan Sandlerd63f9322015-05-06 15:18:49 -04004273 mBigLargeIcon = icon;
Chris Wren3745a3d2012-05-22 15:11:52 -04004274 return this;
4275 }
4276
Riley Andrews0394a0c2015-11-03 23:36:52 -08004277 /** @hide */
4278 public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10);
4279
Daniel Sandler0ec46202015-06-24 01:27:05 -04004280 /**
4281 * @hide
4282 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07004283 @Override
4284 public void purgeResources() {
4285 super.purgeResources();
Riley Andrews8cee7c12015-11-01 23:36:04 -08004286 if (mPicture != null &&
4287 mPicture.isMutable() &&
Riley Andrews0394a0c2015-11-03 23:36:52 -08004288 mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) {
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07004289 mPicture = mPicture.createAshmemBitmap();
4290 }
4291 if (mBigLargeIcon != null) {
4292 mBigLargeIcon.convertToAshmem();
4293 }
4294 }
Christoph Studer5c510ee2014-12-15 16:32:27 +01004295
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004296 /**
4297 * @hide
4298 */
4299 public RemoteViews makeBigContentView() {
4300 // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet
Christoph Studer5c510ee2014-12-15 16:32:27 +01004301 // This covers the following cases:
4302 // 1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004303 // mN.mLargeIcon
4304 // 2. !mBigLargeIconSet -> mN.mLargeIcon applies
Dan Sandlerd63f9322015-05-06 15:18:49 -04004305 Icon oldLargeIcon = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01004306 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004307 oldLargeIcon = mBuilder.mN.mLargeIcon;
4308 mBuilder.mN.mLargeIcon = mBigLargeIcon;
Christoph Studer5c510ee2014-12-15 16:32:27 +01004309 }
4310
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01004311 RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource());
Selim Cinek03d0d652015-11-13 13:18:09 -05004312 if (mSummaryTextSet) {
4313 contentView.setTextViewText(R.id.text, mBuilder.processLegacyText(mSummaryText));
Selim Cinekc848c3a2016-01-13 15:27:30 -08004314 contentView.setViewVisibility(R.id.text, View.VISIBLE);
Selim Cinek03d0d652015-11-13 13:18:09 -05004315 }
Selim Cinek279fa862016-06-14 10:57:25 -07004316 mBuilder.setContentMinHeight(contentView, mBuilder.mN.hasLargeIcon());
Selim Cinek53e64a42015-11-16 10:40:56 -08004317
Christoph Studer5c510ee2014-12-15 16:32:27 +01004318 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004319 mBuilder.mN.mLargeIcon = oldLargeIcon;
Christoph Studer5c510ee2014-12-15 16:32:27 +01004320 }
4321
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004322 contentView.setImageViewBitmap(R.id.big_picture, mPicture);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004323 return contentView;
4324 }
4325
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004326 /**
4327 * @hide
4328 */
4329 public void addExtras(Bundle extras) {
4330 super.addExtras(extras);
4331
4332 if (mBigLargeIconSet) {
4333 extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
4334 }
4335 extras.putParcelable(EXTRA_PICTURE, mPicture);
4336 }
4337
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004338 /**
4339 * @hide
4340 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004341 @Override
Christoph Studer4600f9b2014-07-22 22:44:43 +02004342 protected void restoreFromExtras(Bundle extras) {
4343 super.restoreFromExtras(extras);
4344
4345 if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) {
Christoph Studer5c510ee2014-12-15 16:32:27 +01004346 mBigLargeIconSet = true;
Christoph Studer4600f9b2014-07-22 22:44:43 +02004347 mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG);
Chris Wren3745a3d2012-05-22 15:11:52 -04004348 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02004349 mPicture = extras.getParcelable(EXTRA_PICTURE);
4350 }
Selim Cinek03d0d652015-11-13 13:18:09 -05004351
4352 /**
4353 * @hide
4354 */
4355 @Override
4356 public boolean hasSummaryInHeader() {
4357 return false;
4358 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004359 }
4360
4361 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04004362 * Helper class for generating large-format notifications that include a lot of text.
Joe Malin8d40d042012-11-05 11:36:40 -08004363 *
Robert Ly91c5ce32014-06-08 15:37:00 -07004364 * Here's how you'd set the <code>BigTextStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004365 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07004366 * Notification notif = new Notification.Builder(mContext)
4367 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
4368 * .setContentText(subject)
4369 * .setSmallIcon(R.drawable.new_mail)
4370 * .setLargeIcon(aBitmap)
4371 * .setStyle(new Notification.BigTextStyle()
4372 * .bigText(aVeryLongString))
4373 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004374 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08004375 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04004376 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004377 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004378 public static class BigTextStyle extends Style {
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004379
4380 private static final int MAX_LINES = 13;
Selim Cinek3a2c4b92015-12-17 17:01:17 -08004381 private static final int LINES_CONSUMED_BY_ACTIONS = 4;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004382
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004383 private CharSequence mBigText;
4384
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004385 public BigTextStyle() {
4386 }
4387
Adrian Roosf5faf9d2016-05-23 13:56:15 -07004388 /**
4389 * @deprecated use {@code BigTextStyle()}.
4390 */
4391 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004392 public BigTextStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004393 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004394 }
4395
Chris Wrend6297db2012-05-03 16:20:13 -04004396 /**
4397 * Overrides ContentTitle in the big form of the template.
4398 * This defaults to the value passed to setContentTitle().
4399 */
4400 public BigTextStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004401 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04004402 return this;
4403 }
4404
4405 /**
4406 * Set the first line of text after the detail section in the big form of the template.
4407 */
4408 public BigTextStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004409 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04004410 return this;
4411 }
4412
Chris Wren0bd664d2012-08-01 13:56:56 -04004413 /**
4414 * Provide the longer text to be displayed in the big form of the
4415 * template in place of the content text.
4416 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004417 public BigTextStyle bigText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004418 mBigText = safeCharSequence(cs);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004419 return this;
4420 }
4421
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004422 /**
4423 * @hide
4424 */
4425 public void addExtras(Bundle extras) {
4426 super.addExtras(extras);
4427
Christoph Studer4600f9b2014-07-22 22:44:43 +02004428 extras.putCharSequence(EXTRA_BIG_TEXT, mBigText);
4429 }
4430
4431 /**
4432 * @hide
4433 */
4434 @Override
4435 protected void restoreFromExtras(Bundle extras) {
4436 super.restoreFromExtras(extras);
4437
4438 mBigText = extras.getCharSequence(EXTRA_BIG_TEXT);
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004439 }
4440
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004441 /**
4442 * @hide
4443 */
4444 public RemoteViews makeBigContentView() {
Christoph Studer4600f9b2014-07-22 22:44:43 +02004445
4446 // Nasty
Selim Cinek75998782016-04-26 10:39:17 -07004447 CharSequence text = mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004448 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Daniel Sandler916ad912012-06-13 12:17:07 -04004449
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01004450 RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource());
Joe Malin8d40d042012-11-05 11:36:40 -08004451
Selim Cinek75998782016-04-26 10:39:17 -07004452 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, text);
Christoph Studer4600f9b2014-07-22 22:44:43 +02004453
Selim Cinek3a2c4b92015-12-17 17:01:17 -08004454 CharSequence bigTextText = mBuilder.processLegacyText(mBigText);
Selim Cinek75998782016-04-26 10:39:17 -07004455 if (TextUtils.isEmpty(bigTextText)) {
4456 // In case the bigtext is null / empty fall back to the normal text to avoid a weird
4457 // experience
4458 bigTextText = mBuilder.processLegacyText(text);
4459 }
Adrian Roosb1f427c2016-05-26 12:27:15 -07004460 applyBigTextContentView(mBuilder, contentView, bigTextText);
Selim Cinek4fb12d32015-11-19 18:10:48 -08004461
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004462 return contentView;
4463 }
4464
Adrian Roosb1f427c2016-05-26 12:27:15 -07004465 static void applyBigTextContentView(Builder builder,
4466 RemoteViews contentView, CharSequence bigTextText) {
4467 contentView.setTextViewText(R.id.big_text, bigTextText);
4468 contentView.setViewVisibility(R.id.big_text,
4469 TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE);
4470 contentView.setInt(R.id.big_text, "setMaxLines", calculateMaxLines(builder));
Selim Cinek279fa862016-06-14 10:57:25 -07004471 contentView.setBoolean(R.id.big_text, "setHasImage", builder.mN.hasLargeIcon());
Adrian Roosb1f427c2016-05-26 12:27:15 -07004472 }
4473
4474 private static int calculateMaxLines(Builder builder) {
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004475 int lineCount = MAX_LINES;
Adrian Roosb1f427c2016-05-26 12:27:15 -07004476 boolean hasActions = builder.mActions.size() > 0;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004477 if (hasActions) {
4478 lineCount -= LINES_CONSUMED_BY_ACTIONS;
4479 }
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004480 return lineCount;
4481 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004482 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04004483
4484 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04004485 * Helper class for generating large-format notifications that include multiple back-and-forth
4486 * messages of varying types between any number of people.
4487 *
4488 * <br>
4489 * If the platform does not provide large-format notifications, this method has no effect. The
4490 * user will always see the normal notification view.
4491 * <br>
4492 * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like
4493 * so:
4494 * <pre class="prettyprint">
4495 *
4496 * Notification noti = new Notification.Builder()
4497 * .setContentTitle(&quot;2 new messages wtih &quot; + sender.toString())
4498 * .setContentText(subject)
4499 * .setSmallIcon(R.drawable.new_message)
4500 * .setLargeIcon(aBitmap)
4501 * .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name))
4502 * .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender())
4503 * .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender()))
4504 * .build();
4505 * </pre>
4506 */
4507 public static class MessagingStyle extends Style {
4508
4509 /**
4510 * The maximum number of messages that will be retained in the Notification itself (the
4511 * number displayed is up to the platform).
4512 */
4513 public static final int MAXIMUM_RETAINED_MESSAGES = 25;
4514
4515 CharSequence mUserDisplayName;
4516 CharSequence mConversationTitle;
Alex Hillsd9b04d92016-04-11 16:38:16 -04004517 List<Message> mMessages = new ArrayList<>();
Alex Hillsfc737de2016-03-23 17:33:02 -04004518
4519 MessagingStyle() {
4520 }
4521
4522 /**
4523 * @param userDisplayName the name to be displayed for any replies sent by the user before the
4524 * posting app reposts the notification with those messages after they've been actually
4525 * sent and in previous messages sent by the user added in
4526 * {@link #addMessage(Notification.MessagingStyle.Message)}
4527 */
4528 public MessagingStyle(CharSequence userDisplayName) {
4529 mUserDisplayName = userDisplayName;
4530 }
4531
4532 /**
4533 * Returns the name to be displayed for any replies sent by the user
4534 */
4535 public CharSequence getUserDisplayName() {
4536 return mUserDisplayName;
4537 }
4538
4539 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04004540 * Sets the title to be displayed on this conversation. This should only be used for
4541 * group messaging and left unset for one-on-one conversations.
4542 * @param conversationTitle
4543 * @return this object for method chaining.
4544 */
4545 public MessagingStyle setConversationTitle(CharSequence conversationTitle) {
4546 mConversationTitle = conversationTitle;
4547 return this;
4548 }
4549
4550 /**
4551 * Return the title to be displayed on this conversation. Can be <code>null</code> and
4552 * should be for one-on-one conversations
4553 */
4554 public CharSequence getConversationTitle() {
4555 return mConversationTitle;
4556 }
4557
4558 /**
4559 * Adds a message for display by this notification. Convenience call for a simple
4560 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
4561 * @param text A {@link CharSequence} to be displayed as the message content
4562 * @param timestamp Time at which the message arrived
4563 * @param sender A {@link CharSequence} to be used for displaying the name of the
4564 * sender. Should be <code>null</code> for messages by the current user, in which case
4565 * the platform will insert {@link #getUserDisplayName()}.
4566 * Should be unique amongst all individuals in the conversation, and should be
4567 * consistent during re-posts of the notification.
4568 *
4569 * @see Message#Message(CharSequence, long, CharSequence)
4570 *
4571 * @return this object for method chaining
4572 */
4573 public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) {
4574 mMessages.add(new Message(text, timestamp, sender));
4575 if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
4576 mMessages.remove(0);
4577 }
4578 return this;
4579 }
4580
4581 /**
4582 * Adds a {@link Message} for display in this notification.
4583 * @param message The {@link Message} to be displayed
4584 * @return this object for method chaining
4585 */
4586 public MessagingStyle addMessage(Message message) {
4587 mMessages.add(message);
4588 if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
4589 mMessages.remove(0);
4590 }
4591 return this;
4592 }
4593
4594 /**
4595 * Gets the list of {@code Message} objects that represent the notification
4596 */
4597 public List<Message> getMessages() {
4598 return mMessages;
4599 }
4600
4601 /**
4602 * @hide
4603 */
4604 @Override
4605 public void addExtras(Bundle extras) {
4606 super.addExtras(extras);
4607 if (mUserDisplayName != null) {
4608 extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUserDisplayName);
4609 }
4610 if (mConversationTitle != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04004611 extras.putCharSequence(EXTRA_CONVERSATION_TITLE, mConversationTitle);
Alex Hillsfc737de2016-03-23 17:33:02 -04004612 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04004613 if (!mMessages.isEmpty()) { extras.putParcelableArray(EXTRA_MESSAGES,
4614 Message.getBundleArrayForMessages(mMessages));
Alex Hillsfc737de2016-03-23 17:33:02 -04004615 }
Adrian Roos33fbd2c2016-05-27 15:35:28 -07004616
4617 fixTitleAndTextExtras(extras);
4618 }
4619
4620 private void fixTitleAndTextExtras(Bundle extras) {
4621 Message m = findLatestIncomingMessage();
4622 CharSequence text = (m == null) ? null : m.mText;
4623 CharSequence sender = m == null ? null
4624 : TextUtils.isEmpty(m.mSender) ? mUserDisplayName : m.mSender;
4625 CharSequence title;
4626 if (!TextUtils.isEmpty(mConversationTitle)) {
4627 if (!TextUtils.isEmpty(sender)) {
4628 BidiFormatter bidi = BidiFormatter.getInstance();
4629 title = mBuilder.mContext.getString(
4630 com.android.internal.R.string.notification_messaging_title_template,
4631 bidi.unicodeWrap(mConversationTitle), bidi.unicodeWrap(m.mSender));
4632 } else {
4633 title = mConversationTitle;
4634 }
4635 } else {
4636 title = sender;
4637 }
4638
4639 if (title != null) {
4640 extras.putCharSequence(EXTRA_TITLE, title);
4641 }
4642 if (text != null) {
4643 extras.putCharSequence(EXTRA_TEXT, text);
4644 }
Alex Hillsfc737de2016-03-23 17:33:02 -04004645 }
4646
4647 /**
4648 * @hide
4649 */
4650 @Override
4651 protected void restoreFromExtras(Bundle extras) {
4652 super.restoreFromExtras(extras);
4653
4654 mMessages.clear();
Adrian Roos96b7e202016-05-17 13:50:38 -07004655 mUserDisplayName = extras.getCharSequence(EXTRA_SELF_DISPLAY_NAME);
4656 mConversationTitle = extras.getCharSequence(EXTRA_CONVERSATION_TITLE);
Alex Hillsd9b04d92016-04-11 16:38:16 -04004657 Parcelable[] parcelables = extras.getParcelableArray(EXTRA_MESSAGES);
Adrian Roosdedd1df2016-04-26 16:38:47 -07004658 if (parcelables != null && parcelables instanceof Parcelable[]) {
4659 mMessages = Message.getMessagesFromBundleArray(parcelables);
Alex Hillsfc737de2016-03-23 17:33:02 -04004660 }
4661 }
4662
4663 /**
4664 * @hide
4665 */
Adrian Roosc1a80b02016-04-05 14:54:55 -07004666 @Override
4667 public RemoteViews makeContentView() {
4668 Message m = findLatestIncomingMessage();
4669 CharSequence title = mConversationTitle != null
4670 ? mConversationTitle
4671 : (m == null) ? null : m.mSender;
4672 CharSequence text = (m == null)
4673 ? null
4674 : mConversationTitle != null ? makeMessageLine(m) : m.mText;
Alex Hillsfc737de2016-03-23 17:33:02 -04004675
Adrian Roosc1a80b02016-04-05 14:54:55 -07004676 return mBuilder.applyStandardTemplate(mBuilder.getBaseLayoutResource(),
4677 false /* hasProgress */,
4678 title,
4679 text);
4680 }
4681
4682 private Message findLatestIncomingMessage() {
4683 for (int i = mMessages.size() - 1; i >= 0; i--) {
4684 Message m = mMessages.get(i);
4685 // Incoming messages have a non-empty sender.
4686 if (!TextUtils.isEmpty(m.mSender)) {
4687 return m;
4688 }
4689 }
Adrian Roos33fbd2c2016-05-27 15:35:28 -07004690 if (!mMessages.isEmpty()) {
4691 // No incoming messages, fall back to outgoing message
4692 return mMessages.get(mMessages.size() - 1);
4693 }
Adrian Roosc1a80b02016-04-05 14:54:55 -07004694 return null;
4695 }
4696
4697 /**
4698 * @hide
4699 */
4700 @Override
4701 public RemoteViews makeBigContentView() {
4702 CharSequence title = !TextUtils.isEmpty(super.mBigContentTitle)
4703 ? super.mBigContentTitle
4704 : mConversationTitle;
4705 boolean hasTitle = !TextUtils.isEmpty(title);
4706
Adrian Roosfeafa052016-06-01 17:09:45 -07004707 if (mMessages.size() == 1) {
4708 // Special case for a single message: Use the big text style
4709 // so the collapsed and expanded versions match nicely.
4710 CharSequence bigTitle;
4711 CharSequence text;
4712 if (hasTitle) {
4713 bigTitle = title;
4714 text = makeMessageLine(mMessages.get(0));
4715 } else {
4716 bigTitle = mMessages.get(0).mSender;
4717 text = mMessages.get(0).mText;
4718 }
Adrian Roosb1f427c2016-05-26 12:27:15 -07004719 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
4720 mBuilder.getBigTextLayoutResource(),
Adrian Roosfeafa052016-06-01 17:09:45 -07004721 false /* progress */, bigTitle, null /* text */);
Adrian Roosb1f427c2016-05-26 12:27:15 -07004722 BigTextStyle.applyBigTextContentView(mBuilder, contentView, text);
4723 return contentView;
4724 }
4725
Adrian Roos48d746a2016-04-12 14:57:28 -07004726 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
Adrian Roosc1a80b02016-04-05 14:54:55 -07004727 mBuilder.getMessagingLayoutResource(),
4728 false /* hasProgress */,
4729 title,
4730 null /* text */);
4731
4732 int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3,
4733 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
4734
4735 // Make sure all rows are gone in case we reuse a view.
4736 for (int rowId : rowIds) {
4737 contentView.setViewVisibility(rowId, View.GONE);
4738 }
4739
4740 int i=0;
Adrian Roos2d5dbba2016-06-08 17:11:53 -07004741 contentView.setViewLayoutMarginBottomDimen(R.id.line1,
4742 hasTitle ? R.dimen.notification_messaging_spacing : 0);
Adrian Roosc1a80b02016-04-05 14:54:55 -07004743 contentView.setInt(R.id.notification_messaging, "setNumIndentLines",
Selim Cinek279fa862016-06-14 10:57:25 -07004744 !mBuilder.mN.hasLargeIcon() ? 0 : (hasTitle ? 1 : 2));
Adrian Roosc1a80b02016-04-05 14:54:55 -07004745
Adrian Roosfeafa052016-06-01 17:09:45 -07004746 int contractedChildId = View.NO_ID;
4747 Message contractedMessage = findLatestIncomingMessage();
Adrian Roosc1a80b02016-04-05 14:54:55 -07004748 int firstMessage = Math.max(0, mMessages.size() - rowIds.length);
4749 while (firstMessage + i < mMessages.size() && i < rowIds.length) {
4750 Message m = mMessages.get(firstMessage + i);
4751 int rowId = rowIds[i];
4752
4753 contentView.setViewVisibility(rowId, View.VISIBLE);
4754 contentView.setTextViewText(rowId, makeMessageLine(m));
4755
Adrian Roosfeafa052016-06-01 17:09:45 -07004756 if (contractedMessage == m) {
4757 contractedChildId = rowId;
4758 }
4759
Adrian Roosc1a80b02016-04-05 14:54:55 -07004760 i++;
4761 }
Adrian Roosfeafa052016-06-01 17:09:45 -07004762 // Record this here to allow transformation between the contracted and expanded views.
4763 contentView.setInt(R.id.notification_messaging, "setContractedChildId",
4764 contractedChildId);
Alex Hillsfc737de2016-03-23 17:33:02 -04004765 return contentView;
4766 }
4767
Adrian Roosc1a80b02016-04-05 14:54:55 -07004768 private CharSequence makeMessageLine(Message m) {
4769 BidiFormatter bidi = BidiFormatter.getInstance();
4770 SpannableStringBuilder sb = new SpannableStringBuilder();
4771 if (TextUtils.isEmpty(m.mSender)) {
4772 CharSequence replyName = mUserDisplayName == null ? "" : mUserDisplayName;
4773 sb.append(bidi.unicodeWrap(replyName),
4774 makeFontColorSpan(mBuilder.resolveContrastColor()),
4775 0 /* flags */);
4776 } else {
4777 sb.append(bidi.unicodeWrap(m.mSender),
4778 makeFontColorSpan(Color.BLACK),
4779 0 /* flags */);
4780 }
4781 CharSequence text = m.mText == null ? "" : m.mText;
4782 sb.append(" ").append(bidi.unicodeWrap(text));
4783 return sb;
4784 }
4785
Adrian Roosdedd1df2016-04-26 16:38:47 -07004786 /**
4787 * @hide
4788 */
4789 @Override
4790 public RemoteViews makeHeadsUpContentView() {
4791 Message m = findLatestIncomingMessage();
4792 CharSequence title = mConversationTitle != null
4793 ? mConversationTitle
4794 : (m == null) ? null : m.mSender;
4795 CharSequence text = (m == null)
4796 ? null
4797 : mConversationTitle != null ? makeMessageLine(m) : m.mText;
4798
4799 return mBuilder.applyStandardTemplateWithActions(mBuilder.getBigBaseLayoutResource(),
4800 false /* hasProgress */,
4801 title,
4802 text);
4803 }
4804
Adrian Roosc1a80b02016-04-05 14:54:55 -07004805 private static TextAppearanceSpan makeFontColorSpan(int color) {
4806 return new TextAppearanceSpan(null, 0, 0,
4807 ColorStateList.valueOf(color), null);
4808 }
4809
Alex Hillsd9b04d92016-04-11 16:38:16 -04004810 public static final class Message {
4811
4812 static final String KEY_TEXT = "text";
4813 static final String KEY_TIMESTAMP = "time";
4814 static final String KEY_SENDER = "sender";
4815 static final String KEY_DATA_MIME_TYPE = "type";
4816 static final String KEY_DATA_URI= "uri";
Alex Hillsfc737de2016-03-23 17:33:02 -04004817
4818 private final CharSequence mText;
4819 private final long mTimestamp;
4820 private final CharSequence mSender;
4821
4822 private String mDataMimeType;
4823 private Uri mDataUri;
4824
4825 /**
4826 * Constructor
4827 * @param text A {@link CharSequence} to be displayed as the message content
4828 * @param timestamp Time at which the message arrived
4829 * @param sender A {@link CharSequence} to be used for displaying the name of the
4830 * sender. Should be <code>null</code> for messages by the current user, in which case
4831 * the platform will insert {@link MessagingStyle#getUserDisplayName()}.
4832 * Should be unique amongst all individuals in the conversation, and should be
4833 * consistent during re-posts of the notification.
4834 */
4835 public Message(CharSequence text, long timestamp, CharSequence sender){
4836 mText = text;
4837 mTimestamp = timestamp;
4838 mSender = sender;
4839 }
4840
4841 /**
4842 * Sets a binary blob of data and an associated MIME type for a message. In the case
4843 * where the platform doesn't support the MIME type, the original text provided in the
4844 * constructor will be used.
4845 * @param dataMimeType The MIME type of the content. See
4846 * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME
4847 * types on Android and Android Wear.
4848 * @param dataUri The uri containing the content whose type is given by the MIME type.
4849 * <p class="note">
4850 * <ol>
4851 * <li>Notification Listeners including the System UI need permission to access the
4852 * data the Uri points to. The recommended ways to do this are:</li>
4853 * <li>Store the data in your own ContentProvider, making sure that other apps have
4854 * the correct permission to access your provider. The preferred mechanism for
4855 * providing access is to use per-URI permissions which are temporary and only
4856 * grant access to the receiving application. An easy way to create a
4857 * ContentProvider like this is to use the FileProvider helper class.</li>
4858 * <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio
4859 * and image MIME types, however beginning with Android 3.0 (API level 11) it can
4860 * also store non-media types (see MediaStore.Files for more info). Files can be
4861 * inserted into the MediaStore using scanFile() after which a content:// style
4862 * Uri suitable for sharing is passed to the provided onScanCompleted() callback.
4863 * Note that once added to the system MediaStore the content is accessible to any
4864 * app on the device.</li>
4865 * </ol>
4866 * @return this object for method chaining
4867 */
4868 public Message setData(String dataMimeType, Uri dataUri) {
4869 mDataMimeType = dataMimeType;
4870 mDataUri = dataUri;
4871 return this;
4872 }
4873
Alex Hillsfc737de2016-03-23 17:33:02 -04004874 /**
4875 * Get the text to be used for this message, or the fallback text if a type and content
4876 * Uri have been set
4877 */
4878 public CharSequence getText() {
4879 return mText;
4880 }
4881
4882 /**
4883 * Get the time at which this message arrived
4884 */
4885 public long getTimestamp() {
4886 return mTimestamp;
4887 }
4888
4889 /**
4890 * Get the text used to display the contact's name in the messaging experience
4891 */
4892 public CharSequence getSender() {
4893 return mSender;
4894 }
4895
4896 /**
4897 * Get the MIME type of the data pointed to by the Uri
4898 */
4899 public String getDataMimeType() {
4900 return mDataMimeType;
4901 }
4902
4903 /**
4904 * Get the the Uri pointing to the content of the message. Can be null, in which case
4905 * {@see #getText()} is used.
4906 */
4907 public Uri getDataUri() {
4908 return mDataUri;
4909 }
4910
Alex Hillsd9b04d92016-04-11 16:38:16 -04004911 private Bundle toBundle() {
4912 Bundle bundle = new Bundle();
Alex Hillsfc737de2016-03-23 17:33:02 -04004913 if (mText != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04004914 bundle.putCharSequence(KEY_TEXT, mText);
Alex Hillsfc737de2016-03-23 17:33:02 -04004915 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04004916 bundle.putLong(KEY_TIMESTAMP, mTimestamp);
Alex Hillsfc737de2016-03-23 17:33:02 -04004917 if (mSender != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04004918 bundle.putCharSequence(KEY_SENDER, mSender);
Alex Hillsfc737de2016-03-23 17:33:02 -04004919 }
4920 if (mDataMimeType != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04004921 bundle.putString(KEY_DATA_MIME_TYPE, mDataMimeType);
Alex Hillsfc737de2016-03-23 17:33:02 -04004922 }
4923 if (mDataUri != null) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04004924 bundle.putParcelable(KEY_DATA_URI, mDataUri);
Alex Hillsfc737de2016-03-23 17:33:02 -04004925 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04004926 return bundle;
Alex Hillsfc737de2016-03-23 17:33:02 -04004927 }
4928
Alex Hillsd9b04d92016-04-11 16:38:16 -04004929 static Bundle[] getBundleArrayForMessages(List<Message> messages) {
4930 Bundle[] bundles = new Bundle[messages.size()];
4931 final int N = messages.size();
4932 for (int i = 0; i < N; i++) {
4933 bundles[i] = messages.get(i).toBundle();
4934 }
4935 return bundles;
4936 }
4937
Adrian Roosdedd1df2016-04-26 16:38:47 -07004938 static List<Message> getMessagesFromBundleArray(Parcelable[] bundles) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04004939 List<Message> messages = new ArrayList<>(bundles.length);
4940 for (int i = 0; i < bundles.length; i++) {
Adrian Roosdedd1df2016-04-26 16:38:47 -07004941 if (bundles[i] instanceof Bundle) {
4942 Message message = getMessageFromBundle((Bundle)bundles[i]);
4943 if (message != null) {
4944 messages.add(message);
4945 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04004946 }
4947 }
4948 return messages;
4949 }
4950
4951 static Message getMessageFromBundle(Bundle bundle) {
4952 try {
Adrian Roosfbddd2c2016-05-13 12:57:20 -07004953 if (!bundle.containsKey(KEY_TEXT) || !bundle.containsKey(KEY_TIMESTAMP)) {
Alex Hillsd9b04d92016-04-11 16:38:16 -04004954 return null;
4955 } else {
4956 Message message = new Message(bundle.getCharSequence(KEY_TEXT),
4957 bundle.getLong(KEY_TIMESTAMP), bundle.getCharSequence(KEY_SENDER));
4958 if (bundle.containsKey(KEY_DATA_MIME_TYPE) &&
4959 bundle.containsKey(KEY_DATA_URI)) {
4960
4961 message.setData(bundle.getString(KEY_DATA_MIME_TYPE),
4962 (Uri) bundle.getParcelable(KEY_DATA_URI));
Alex Hillsfc737de2016-03-23 17:33:02 -04004963 }
Alex Hillsd9b04d92016-04-11 16:38:16 -04004964 return message;
4965 }
4966 } catch (ClassCastException e) {
4967 return null;
4968 }
4969 }
Alex Hillsfc737de2016-03-23 17:33:02 -04004970 }
4971 }
4972
4973 /**
Daniel Sandler879c5e02012-04-17 16:46:51 -04004974 * Helper class for generating large-format notifications that include a list of (up to 5) strings.
Joe Malin8d40d042012-11-05 11:36:40 -08004975 *
Robert Ly91c5ce32014-06-08 15:37:00 -07004976 * Here's how you'd set the <code>InboxStyle</code> on a notification:
Daniel Sandler879c5e02012-04-17 16:46:51 -04004977 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07004978 * Notification notif = new Notification.Builder(mContext)
4979 * .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
4980 * .setContentText(subject)
4981 * .setSmallIcon(R.drawable.new_mail)
4982 * .setLargeIcon(aBitmap)
4983 * .setStyle(new Notification.InboxStyle()
4984 * .addLine(str1)
4985 * .addLine(str2)
4986 * .setContentTitle(&quot;&quot;)
4987 * .setSummaryText(&quot;+3 more&quot;))
4988 * .build();
Daniel Sandler879c5e02012-04-17 16:46:51 -04004989 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08004990 *
Daniel Sandler879c5e02012-04-17 16:46:51 -04004991 * @see Notification#bigContentView
4992 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004993 public static class InboxStyle extends Style {
Daniel Sandler879c5e02012-04-17 16:46:51 -04004994 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
4995
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004996 public InboxStyle() {
4997 }
4998
Adrian Roosf5faf9d2016-05-23 13:56:15 -07004999 /**
5000 * @deprecated use {@code InboxStyle()}.
5001 */
5002 @Deprecated
Daniel Sandler879c5e02012-04-17 16:46:51 -04005003 public InboxStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04005004 setBuilder(builder);
Daniel Sandler879c5e02012-04-17 16:46:51 -04005005 }
5006
Chris Wrend6297db2012-05-03 16:20:13 -04005007 /**
5008 * Overrides ContentTitle in the big form of the template.
5009 * This defaults to the value passed to setContentTitle().
5010 */
5011 public InboxStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04005012 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04005013 return this;
5014 }
5015
5016 /**
5017 * Set the first line of text after the detail section in the big form of the template.
5018 */
5019 public InboxStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04005020 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04005021 return this;
5022 }
5023
Chris Wren0bd664d2012-08-01 13:56:56 -04005024 /**
5025 * Append a line to the digest section of the Inbox notification.
5026 */
Daniel Sandler879c5e02012-04-17 16:46:51 -04005027 public InboxStyle addLine(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04005028 mTexts.add(safeCharSequence(cs));
Daniel Sandler879c5e02012-04-17 16:46:51 -04005029 return this;
5030 }
5031
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005032 /**
5033 * @hide
5034 */
5035 public void addExtras(Bundle extras) {
5036 super.addExtras(extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005037
Daniel Sandlerf45564e2013-04-15 15:05:08 -04005038 CharSequence[] a = new CharSequence[mTexts.size()];
5039 extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
5040 }
5041
Christoph Studer4600f9b2014-07-22 22:44:43 +02005042 /**
5043 * @hide
5044 */
5045 @Override
5046 protected void restoreFromExtras(Bundle extras) {
5047 super.restoreFromExtras(extras);
5048
5049 mTexts.clear();
5050 if (extras.containsKey(EXTRA_TEXT_LINES)) {
5051 Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES));
5052 }
5053 }
5054
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005055 /**
5056 * @hide
5057 */
5058 public RemoteViews makeBigContentView() {
Selim Cinekc848c3a2016-01-13 15:27:30 -08005059 // Remove the content text so it disappears unless you have a summary
Christoph Studer4600f9b2014-07-22 22:44:43 +02005060 // Nasty
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005061 CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT);
5062 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005063
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01005064 RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource());
Daniel Sandler619738c2012-06-07 16:33:08 -04005065
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005066 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
Christoph Studer4600f9b2014-07-22 22:44:43 +02005067
Chris Wrend6297db2012-05-03 16:20:13 -04005068 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 -04005069 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
Chris Wrend6297db2012-05-03 16:20:13 -04005070
Chris Wren4ed80d52012-05-17 09:30:03 -04005071 // Make sure all rows are gone in case we reuse a view.
5072 for (int rowId : rowIds) {
5073 contentView.setViewVisibility(rowId, View.GONE);
5074 }
5075
Daniel Sandler879c5e02012-04-17 16:46:51 -04005076 int i=0;
Selim Cinek07c80172016-04-21 16:40:47 -07005077 int topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
5078 R.dimen.notification_inbox_item_top_padding);
Selim Cinek247fa012016-02-18 09:50:48 -08005079 boolean first = true;
Selim Cinek07c80172016-04-21 16:40:47 -07005080 int onlyViewId = 0;
5081 int maxRows = rowIds.length;
5082 if (mBuilder.mActions.size() > 0) {
5083 maxRows--;
5084 }
5085 while (i < mTexts.size() && i < maxRows) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04005086 CharSequence str = mTexts.get(i);
Selim Cinek07c80172016-04-21 16:40:47 -07005087 if (!TextUtils.isEmpty(str)) {
Daniel Sandler879c5e02012-04-17 16:46:51 -04005088 contentView.setViewVisibility(rowIds[i], View.VISIBLE);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01005089 contentView.setTextViewText(rowIds[i], mBuilder.processLegacyText(str));
Selim Cinek07c80172016-04-21 16:40:47 -07005090 contentView.setViewPadding(rowIds[i], 0, topPadding, 0, 0);
Selim Cinek247fa012016-02-18 09:50:48 -08005091 handleInboxImageMargin(contentView, rowIds[i], first);
Selim Cinek07c80172016-04-21 16:40:47 -07005092 if (first) {
5093 onlyViewId = rowIds[i];
5094 } else {
5095 onlyViewId = 0;
5096 }
Selim Cinek247fa012016-02-18 09:50:48 -08005097 first = false;
Daniel Sandler879c5e02012-04-17 16:46:51 -04005098 }
5099 i++;
5100 }
Selim Cinek07c80172016-04-21 16:40:47 -07005101 if (onlyViewId != 0) {
5102 // We only have 1 entry, lets make it look like the normal Text of a Bigtext
5103 topPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
5104 R.dimen.notification_text_margin_top);
5105 contentView.setViewPadding(onlyViewId, 0, topPadding, 0, 0);
5106 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08005107
Daniel Sandler879c5e02012-04-17 16:46:51 -04005108 return contentView;
5109 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08005110
Selim Cinek247fa012016-02-18 09:50:48 -08005111 private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first) {
Selim Cinek1e0bf612015-11-20 15:57:26 -08005112 int endMargin = 0;
Selim Cinek247fa012016-02-18 09:50:48 -08005113 if (first) {
5114 final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0);
5115 final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
5116 boolean hasProgress = max != 0 || ind;
Selim Cinek279fa862016-06-14 10:57:25 -07005117 if (mBuilder.mN.hasLargeIcon() && !hasProgress) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07005118 endMargin = R.dimen.notification_content_picture_margin;
Selim Cinek247fa012016-02-18 09:50:48 -08005119 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08005120 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07005121 contentView.setViewLayoutMarginEndDimen(id, endMargin);
Selim Cinek1e0bf612015-11-20 15:57:26 -08005122 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04005123 }
Dan Sandler842dd772014-05-15 09:36:47 -04005124
5125 /**
5126 * Notification style for media playback notifications.
5127 *
5128 * In the expanded form, {@link Notification#bigContentView}, up to 5
5129 * {@link Notification.Action}s specified with
Dan Sandler86647982015-05-13 23:41:13 -04005130 * {@link Notification.Builder#addAction(Action) addAction} will be
Dan Sandler842dd772014-05-15 09:36:47 -04005131 * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
5132 * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be
5133 * treated as album artwork.
5134 *
5135 * Unlike the other styles provided here, MediaStyle can also modify the standard-size
5136 * {@link Notification#contentView}; by providing action indices to
Christoph Studerfde6f4d2014-12-12 13:23:26 +01005137 * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed
Dan Sandler842dd772014-05-15 09:36:47 -04005138 * in the standard view alongside the usual content.
5139 *
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01005140 * Notifications created with MediaStyle will have their category set to
5141 * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different
5142 * category using {@link Notification.Builder#setCategory(String) setCategory()}.
5143 *
Jeff Browndba34ba2014-06-24 20:46:03 -07005144 * Finally, if you attach a {@link android.media.session.MediaSession.Token} using
5145 * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)},
Dan Sandler842dd772014-05-15 09:36:47 -04005146 * the System UI can identify this as a notification representing an active media session
5147 * and respond accordingly (by showing album artwork in the lockscreen, for example).
5148 *
5149 * To use this style with your Notification, feed it to
5150 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
5151 * <pre class="prettyprint">
5152 * Notification noti = new Notification.Builder()
5153 * .setSmallIcon(R.drawable.ic_stat_player)
Christoph Studere935fe92014-11-24 14:18:06 +01005154 * .setContentTitle(&quot;Track title&quot;)
5155 * .setContentText(&quot;Artist - Album&quot;)
5156 * .setLargeIcon(albumArtBitmap))
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01005157 * .setStyle(<b>new Notification.MediaStyle()</b>
5158 * .setMediaSession(mySession))
Dan Sandler842dd772014-05-15 09:36:47 -04005159 * .build();
5160 * </pre>
5161 *
5162 * @see Notification#bigContentView
5163 */
5164 public static class MediaStyle extends Style {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005165 static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3;
Dan Sandler842dd772014-05-15 09:36:47 -04005166 static final int MAX_MEDIA_BUTTONS = 5;
5167
5168 private int[] mActionsToShowInCompact = null;
Jeff Browndba34ba2014-06-24 20:46:03 -07005169 private MediaSession.Token mToken;
Dan Sandler842dd772014-05-15 09:36:47 -04005170
5171 public MediaStyle() {
5172 }
5173
Adrian Roosf5faf9d2016-05-23 13:56:15 -07005174 /**
5175 * @deprecated use {@code MediaStyle()}.
5176 */
5177 @Deprecated
Dan Sandler842dd772014-05-15 09:36:47 -04005178 public MediaStyle(Builder builder) {
5179 setBuilder(builder);
5180 }
5181
5182 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005183 * 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 -04005184 * notification view.
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005185 *
5186 * @param actions the indices of the actions to show in the compact notification view
Dan Sandler842dd772014-05-15 09:36:47 -04005187 */
5188 public MediaStyle setShowActionsInCompactView(int...actions) {
5189 mActionsToShowInCompact = actions;
5190 return this;
5191 }
5192
5193 /**
Jeff Browndba34ba2014-06-24 20:46:03 -07005194 * Attach a {@link android.media.session.MediaSession.Token} to this Notification
5195 * to provide additional playback information and control to the SystemUI.
Dan Sandler842dd772014-05-15 09:36:47 -04005196 */
Jeff Browndba34ba2014-06-24 20:46:03 -07005197 public MediaStyle setMediaSession(MediaSession.Token token) {
Dan Sandler842dd772014-05-15 09:36:47 -04005198 mToken = token;
5199 return this;
5200 }
5201
Christoph Studer4600f9b2014-07-22 22:44:43 +02005202 /**
5203 * @hide
5204 */
Dan Sandler842dd772014-05-15 09:36:47 -04005205 @Override
5206 public Notification buildStyled(Notification wip) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02005207 super.buildStyled(wip);
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01005208 if (wip.category == null) {
5209 wip.category = Notification.CATEGORY_TRANSPORT;
5210 }
Dan Sandler842dd772014-05-15 09:36:47 -04005211 return wip;
5212 }
5213
Christoph Studer4600f9b2014-07-22 22:44:43 +02005214 /**
5215 * @hide
5216 */
5217 @Override
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005218 public RemoteViews makeContentView() {
5219 return makeMediaContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02005220 }
5221
5222 /**
5223 * @hide
5224 */
5225 @Override
Julia Reynoldsd9228f12015-10-20 10:37:27 -04005226 public RemoteViews makeBigContentView() {
5227 return makeMediaBigContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02005228 }
5229
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005230 /**
5231 * @hide
5232 */
5233 @Override
5234 public RemoteViews makeHeadsUpContentView() {
5235 RemoteViews expanded = makeMediaBigContentView();
5236 return expanded != null ? expanded : makeMediaContentView();
5237 }
5238
Dan Sandler842dd772014-05-15 09:36:47 -04005239 /** @hide */
5240 @Override
5241 public void addExtras(Bundle extras) {
5242 super.addExtras(extras);
5243
5244 if (mToken != null) {
5245 extras.putParcelable(EXTRA_MEDIA_SESSION, mToken);
5246 }
Bryan Mawhinneye191f902014-07-22 12:50:09 +01005247 if (mActionsToShowInCompact != null) {
5248 extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact);
5249 }
Dan Sandler842dd772014-05-15 09:36:47 -04005250 }
5251
Christoph Studer4600f9b2014-07-22 22:44:43 +02005252 /**
5253 * @hide
5254 */
5255 @Override
5256 protected void restoreFromExtras(Bundle extras) {
5257 super.restoreFromExtras(extras);
5258
5259 if (extras.containsKey(EXTRA_MEDIA_SESSION)) {
5260 mToken = extras.getParcelable(EXTRA_MEDIA_SESSION);
5261 }
5262 if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) {
5263 mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS);
5264 }
5265 }
5266
Selim Cinek5bf069a2015-11-10 19:14:27 -05005267 private RemoteViews generateMediaActionButton(Action action, int color) {
Dan Sandler842dd772014-05-15 09:36:47 -04005268 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07005269 RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(),
Alan Viverette3cb07a462014-06-06 14:19:53 -07005270 R.layout.notification_material_media_action);
Dan Sandler68079d52015-07-22 10:45:30 -04005271 button.setImageViewIcon(R.id.action0, action.getIcon());
Selim Cinek5bf069a2015-11-10 19:14:27 -05005272 button.setDrawableParameters(R.id.action0, false, -1, color, PorterDuff.Mode.SRC_ATOP,
5273 -1);
Dan Sandler842dd772014-05-15 09:36:47 -04005274 if (!tombstone) {
5275 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
5276 }
5277 button.setContentDescription(R.id.action0, action.title);
5278 return button;
5279 }
5280
5281 private RemoteViews makeMediaContentView() {
5282 RemoteViews view = mBuilder.applyStandardTemplate(
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005283 R.layout.notification_template_material_media, false /* hasProgress */);
Dan Sandler842dd772014-05-15 09:36:47 -04005284
5285 final int numActions = mBuilder.mActions.size();
5286 final int N = mActionsToShowInCompact == null
5287 ? 0
5288 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
5289 if (N > 0) {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005290 view.removeAllViews(com.android.internal.R.id.media_actions);
Dan Sandler842dd772014-05-15 09:36:47 -04005291 for (int i = 0; i < N; i++) {
5292 if (i >= numActions) {
5293 throw new IllegalArgumentException(String.format(
5294 "setShowActionsInCompactView: action %d out of bounds (max %d)",
5295 i, numActions - 1));
5296 }
5297
5298 final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]);
Selim Cinek5bf069a2015-11-10 19:14:27 -05005299 final RemoteViews button = generateMediaActionButton(action,
Adrian Roos4ff3b122016-02-01 12:26:13 -08005300 mBuilder.resolveContrastColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005301 view.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04005302 }
5303 }
Selim Cinekfdc738f2016-01-27 20:04:27 -08005304 handleImage(view);
5305 // handle the content margin
Adrian Roos2d5dbba2016-06-08 17:11:53 -07005306 int endMargin = R.dimen.notification_content_margin_end;
Selim Cinek279fa862016-06-14 10:57:25 -07005307 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07005308 endMargin = R.dimen.notification_content_plus_picture_margin_end;
Selim Cinekfdc738f2016-01-27 20:04:27 -08005309 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07005310 view.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
Dan Sandler842dd772014-05-15 09:36:47 -04005311 return view;
5312 }
5313
5314 private RemoteViews makeMediaBigContentView() {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005315 final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005316 // Dont add an expanded view if there is no more content to be revealed
5317 int actionsInCompact = mActionsToShowInCompact == null
5318 ? 0
5319 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
Selim Cinek279fa862016-06-14 10:57:25 -07005320 if (!mBuilder.mN.hasLargeIcon() && actionCount <= actionsInCompact) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08005321 return null;
5322 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05005323 RemoteViews big = mBuilder.applyStandardTemplate(
5324 R.layout.notification_template_material_big_media,
5325 false);
Dan Sandler842dd772014-05-15 09:36:47 -04005326
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005327 if (actionCount > 0) {
5328 big.removeAllViews(com.android.internal.R.id.media_actions);
5329 for (int i = 0; i < actionCount; i++) {
Selim Cinek5bf069a2015-11-10 19:14:27 -05005330 final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i),
Adrian Roos4ff3b122016-02-01 12:26:13 -08005331 mBuilder.resolveContrastColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005332 big.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04005333 }
5334 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05005335 handleImage(big);
Dan Sandler842dd772014-05-15 09:36:47 -04005336 return big;
5337 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005338
Selim Cinek5bf069a2015-11-10 19:14:27 -05005339 private void handleImage(RemoteViews contentView) {
Selim Cinek279fa862016-06-14 10:57:25 -07005340 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07005341 contentView.setViewLayoutMarginEndDimen(R.id.line1, 0);
5342 contentView.setViewLayoutMarginEndDimen(R.id.text, 0);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005343 }
5344 }
5345
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005346 /**
5347 * @hide
5348 */
5349 @Override
5350 protected boolean hasProgress() {
5351 return false;
5352 }
Dan Sandler842dd772014-05-15 09:36:47 -04005353 }
Griff Hazen61a9e862014-05-22 16:05:19 -07005354
Selim Cinek593610c2016-02-16 18:42:57 -08005355 /**
5356 * Notification style for custom views that are decorated by the system
5357 *
5358 * <p>Instead of providing a notification that is completely custom, a developer can set this
5359 * style and still obtain system decorations like the notification header with the expand
5360 * affordance and actions.
5361 *
5362 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
5363 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
5364 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
5365 * corresponding custom views to display.
5366 *
5367 * To use this style with your Notification, feed it to
5368 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
5369 * <pre class="prettyprint">
5370 * Notification noti = new Notification.Builder()
5371 * .setSmallIcon(R.drawable.ic_stat_player)
5372 * .setLargeIcon(albumArtBitmap))
5373 * .setCustomContentView(contentView);
5374 * .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>)
5375 * .build();
5376 * </pre>
5377 */
5378 public static class DecoratedCustomViewStyle extends Style {
5379
5380 public DecoratedCustomViewStyle() {
5381 }
5382
Selim Cinek593610c2016-02-16 18:42:57 -08005383 /**
5384 * @hide
5385 */
5386 public boolean displayCustomViewInline() {
5387 return true;
5388 }
5389
5390 /**
5391 * @hide
5392 */
5393 @Override
5394 public RemoteViews makeContentView() {
5395 return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView);
5396 }
5397
5398 /**
5399 * @hide
5400 */
5401 @Override
5402 public RemoteViews makeBigContentView() {
5403 return makeDecoratedBigContentView();
5404 }
5405
5406 /**
5407 * @hide
5408 */
5409 @Override
5410 public RemoteViews makeHeadsUpContentView() {
5411 return makeDecoratedHeadsUpContentView();
5412 }
5413
Selim Cinek593610c2016-02-16 18:42:57 -08005414 private RemoteViews makeDecoratedHeadsUpContentView() {
5415 RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null
5416 ? mBuilder.mN.contentView
5417 : mBuilder.mN.headsUpContentView;
5418 if (mBuilder.mActions.size() == 0) {
5419 return makeStandardTemplateWithCustomContent(headsUpContentView);
5420 }
5421 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
5422 mBuilder.getBigBaseLayoutResource());
Selim Cinek247fa012016-02-18 09:50:48 -08005423 buildIntoRemoteViewContent(remoteViews, headsUpContentView);
Selim Cinek593610c2016-02-16 18:42:57 -08005424 return remoteViews;
5425 }
5426
Selim Cinek593610c2016-02-16 18:42:57 -08005427 private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) {
5428 RemoteViews remoteViews = mBuilder.applyStandardTemplate(
5429 mBuilder.getBaseLayoutResource());
Selim Cinek247fa012016-02-18 09:50:48 -08005430 buildIntoRemoteViewContent(remoteViews, customContent);
Selim Cinek593610c2016-02-16 18:42:57 -08005431 return remoteViews;
5432 }
5433
Selim Cinek593610c2016-02-16 18:42:57 -08005434 private RemoteViews makeDecoratedBigContentView() {
5435 RemoteViews bigContentView = mBuilder.mN.bigContentView == null
5436 ? mBuilder.mN.contentView
5437 : mBuilder.mN.bigContentView;
5438 if (mBuilder.mActions.size() == 0) {
5439 return makeStandardTemplateWithCustomContent(bigContentView);
5440 }
5441 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
5442 mBuilder.getBigBaseLayoutResource());
Selim Cinek247fa012016-02-18 09:50:48 -08005443 buildIntoRemoteViewContent(remoteViews, bigContentView);
Selim Cinek593610c2016-02-16 18:42:57 -08005444 return remoteViews;
5445 }
Selim Cinek247fa012016-02-18 09:50:48 -08005446
5447 private void buildIntoRemoteViewContent(RemoteViews remoteViews,
5448 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08005449 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07005450 // Need to clone customContent before adding, because otherwise it can no longer be
5451 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08005452 customContent = customContent.clone();
Selim Cinekf91017e2016-03-14 12:25:09 -07005453 remoteViews.removeAllViews(R.id.notification_main_column);
5454 remoteViews.addView(R.id.notification_main_column, customContent);
Adrian Roos5081c0d2016-02-26 16:04:19 -08005455 }
Selim Cinek247fa012016-02-18 09:50:48 -08005456 // also update the end margin if there is an image
Adrian Roos2d5dbba2016-06-08 17:11:53 -07005457 int endMargin = R.dimen.notification_content_margin_end;
Selim Cinek279fa862016-06-14 10:57:25 -07005458 if (mBuilder.mN.hasLargeIcon()) {
Adrian Roos2d5dbba2016-06-08 17:11:53 -07005459 endMargin = R.dimen.notification_content_plus_picture_margin_end;
Selim Cinek247fa012016-02-18 09:50:48 -08005460 }
Adrian Roos2d5dbba2016-06-08 17:11:53 -07005461 remoteViews.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin);
Selim Cinek247fa012016-02-18 09:50:48 -08005462 }
Selim Cinek593610c2016-02-16 18:42:57 -08005463 }
5464
Selim Cinek03eb3b72016-02-18 10:39:45 -08005465 /**
5466 * Notification style for media custom views that are decorated by the system
5467 *
5468 * <p>Instead of providing a media notification that is completely custom, a developer can set
5469 * this style and still obtain system decorations like the notification header with the expand
5470 * affordance and actions.
5471 *
5472 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
5473 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
5474 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
5475 * corresponding custom views to display.
5476 *
5477 * To use this style with your Notification, feed it to
5478 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
5479 * <pre class="prettyprint">
5480 * Notification noti = new Notification.Builder()
5481 * .setSmallIcon(R.drawable.ic_stat_player)
5482 * .setLargeIcon(albumArtBitmap))
5483 * .setCustomContentView(contentView);
5484 * .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b>
5485 * .setMediaSession(mySession))
5486 * .build();
5487 * </pre>
5488 *
5489 * @see android.app.Notification.DecoratedCustomViewStyle
5490 * @see android.app.Notification.MediaStyle
5491 */
5492 public static class DecoratedMediaCustomViewStyle extends MediaStyle {
5493
5494 public DecoratedMediaCustomViewStyle() {
5495 }
5496
Selim Cinek03eb3b72016-02-18 10:39:45 -08005497 /**
5498 * @hide
5499 */
5500 public boolean displayCustomViewInline() {
5501 return true;
5502 }
5503
5504 /**
5505 * @hide
5506 */
5507 @Override
5508 public RemoteViews makeContentView() {
5509 RemoteViews remoteViews = super.makeContentView();
5510 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
5511 mBuilder.mN.contentView);
5512 }
5513
5514 /**
5515 * @hide
5516 */
5517 @Override
5518 public RemoteViews makeBigContentView() {
5519 RemoteViews customRemoteView = mBuilder.mN.bigContentView != null
5520 ? mBuilder.mN.bigContentView
5521 : mBuilder.mN.contentView;
5522 return makeBigContentViewWithCustomContent(customRemoteView);
5523 }
5524
5525 private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) {
5526 RemoteViews remoteViews = super.makeBigContentView();
5527 if (remoteViews != null) {
5528 return buildIntoRemoteView(remoteViews, R.id.notification_main_column,
5529 customRemoteView);
5530 } else if (customRemoteView != mBuilder.mN.contentView){
5531 remoteViews = super.makeContentView();
5532 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
5533 customRemoteView);
5534 } else {
5535 return null;
5536 }
5537 }
5538
5539 /**
5540 * @hide
5541 */
5542 @Override
5543 public RemoteViews makeHeadsUpContentView() {
5544 RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null
5545 ? mBuilder.mN.headsUpContentView
5546 : mBuilder.mN.contentView;
5547 return makeBigContentViewWithCustomContent(customRemoteView);
5548 }
5549
5550 private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id,
5551 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08005552 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07005553 // Need to clone customContent before adding, because otherwise it can no longer be
5554 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08005555 customContent = customContent.clone();
Selim Cinekf91017e2016-03-14 12:25:09 -07005556 remoteViews.removeAllViews(id);
5557 remoteViews.addView(id, customContent);
Adrian Roos5081c0d2016-02-26 16:04:19 -08005558 }
Selim Cinek03eb3b72016-02-18 10:39:45 -08005559 return remoteViews;
5560 }
5561 }
5562
Christoph Studer4600f9b2014-07-22 22:44:43 +02005563 // When adding a new Style subclass here, don't forget to update
5564 // Builder.getNotificationStyleClass.
5565
Griff Hazen61a9e862014-05-22 16:05:19 -07005566 /**
5567 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
5568 * metadata or change options on a notification builder.
5569 */
5570 public interface Extender {
5571 /**
5572 * Apply this extender to a notification builder.
5573 * @param builder the builder to be modified.
5574 * @return the build object for chaining.
5575 */
5576 public Builder extend(Builder builder);
5577 }
5578
5579 /**
5580 * Helper class to add wearable extensions to notifications.
5581 * <p class="note"> See
5582 * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications
5583 * for Android Wear</a> for more information on how to use this class.
5584 * <p>
5585 * To create a notification with wearable extensions:
5586 * <ol>
5587 * <li>Create a {@link android.app.Notification.Builder}, setting any desired
5588 * properties.
5589 * <li>Create a {@link android.app.Notification.WearableExtender}.
5590 * <li>Set wearable-specific properties using the
5591 * {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}.
5592 * <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a
5593 * notification.
5594 * <li>Post the notification to the notification system with the
5595 * {@code NotificationManager.notify(...)} methods.
5596 * </ol>
5597 *
5598 * <pre class="prettyprint">
5599 * Notification notif = new Notification.Builder(mContext)
5600 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
5601 * .setContentText(subject)
5602 * .setSmallIcon(R.drawable.new_mail)
5603 * .extend(new Notification.WearableExtender()
5604 * .setContentIcon(R.drawable.new_mail))
5605 * .build();
5606 * NotificationManager notificationManger =
5607 * (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
5608 * notificationManger.notify(0, notif);</pre>
5609 *
5610 * <p>Wearable extensions can be accessed on an existing notification by using the
5611 * {@code WearableExtender(Notification)} constructor,
5612 * and then using the {@code get} methods to access values.
5613 *
5614 * <pre class="prettyprint">
5615 * Notification.WearableExtender wearableExtender = new Notification.WearableExtender(
5616 * notification);
Griff Hazen14f57992014-05-26 09:07:14 -07005617 * List&lt;Notification&gt; pages = wearableExtender.getPages();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07005618 */
5619 public static final class WearableExtender implements Extender {
5620 /**
5621 * Sentinel value for an action index that is unset.
5622 */
5623 public static final int UNSET_ACTION_INDEX = -1;
5624
5625 /**
5626 * Size value for use with {@link #setCustomSizePreset} to show this notification with
5627 * default sizing.
5628 * <p>For custom display notifications created using {@link #setDisplayIntent},
Paul Soulosaa4f4bf2015-08-04 11:59:45 -07005629 * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based
Griff Hazen61a9e862014-05-22 16:05:19 -07005630 * on their content.
5631 */
5632 public static final int SIZE_DEFAULT = 0;
5633
5634 /**
5635 * Size value for use with {@link #setCustomSizePreset} to show this notification
5636 * with an extra small size.
5637 * <p>This value is only applicable for custom display notifications created using
5638 * {@link #setDisplayIntent}.
5639 */
5640 public static final int SIZE_XSMALL = 1;
5641
5642 /**
5643 * Size value for use with {@link #setCustomSizePreset} to show this notification
5644 * with a small size.
5645 * <p>This value is only applicable for custom display notifications created using
5646 * {@link #setDisplayIntent}.
5647 */
5648 public static final int SIZE_SMALL = 2;
5649
5650 /**
5651 * Size value for use with {@link #setCustomSizePreset} to show this notification
5652 * with a medium size.
5653 * <p>This value is only applicable for custom display notifications created using
5654 * {@link #setDisplayIntent}.
5655 */
5656 public static final int SIZE_MEDIUM = 3;
5657
5658 /**
5659 * Size value for use with {@link #setCustomSizePreset} to show this notification
5660 * with a large size.
5661 * <p>This value is only applicable for custom display notifications created using
5662 * {@link #setDisplayIntent}.
5663 */
5664 public static final int SIZE_LARGE = 4;
5665
Griff Hazend5f11f92014-05-27 15:40:09 -07005666 /**
5667 * Size value for use with {@link #setCustomSizePreset} to show this notification
5668 * full screen.
5669 * <p>This value is only applicable for custom display notifications created using
5670 * {@link #setDisplayIntent}.
5671 */
5672 public static final int SIZE_FULL_SCREEN = 5;
5673
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005674 /**
5675 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a
5676 * short amount of time when this notification is displayed on the screen. This
5677 * is the default value.
5678 */
5679 public static final int SCREEN_TIMEOUT_SHORT = 0;
5680
5681 /**
5682 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on
5683 * for a longer amount of time when this notification is displayed on the screen.
5684 */
5685 public static final int SCREEN_TIMEOUT_LONG = -1;
5686
Griff Hazen61a9e862014-05-22 16:05:19 -07005687 /** Notification extra which contains wearable extensions */
5688 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
5689
Pete Gastaf6781d2014-10-07 15:17:05 -04005690 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07005691 private static final String KEY_ACTIONS = "actions";
5692 private static final String KEY_FLAGS = "flags";
5693 private static final String KEY_DISPLAY_INTENT = "displayIntent";
5694 private static final String KEY_PAGES = "pages";
5695 private static final String KEY_BACKGROUND = "background";
5696 private static final String KEY_CONTENT_ICON = "contentIcon";
5697 private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity";
5698 private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex";
5699 private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset";
5700 private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight";
5701 private static final String KEY_GRAVITY = "gravity";
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005702 private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout";
Nadia Benbernou948627e2016-04-14 14:41:08 -04005703 private static final String KEY_DISMISSAL_ID = "dismissalId";
Griff Hazen61a9e862014-05-22 16:05:19 -07005704
5705 // Flags bitwise-ored to mFlags
5706 private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1;
5707 private static final int FLAG_HINT_HIDE_ICON = 1 << 1;
5708 private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2;
5709 private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005710 private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4;
Alex Hills4bcb06b2016-04-05 14:26:25 -04005711 private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5;
Alex Hills9ab3a232016-04-05 14:54:56 -04005712 private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6;
Griff Hazen61a9e862014-05-22 16:05:19 -07005713
5714 // Default value for flags integer
5715 private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE;
5716
5717 private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END;
5718 private static final int DEFAULT_GRAVITY = Gravity.BOTTOM;
5719
5720 private ArrayList<Action> mActions = new ArrayList<Action>();
5721 private int mFlags = DEFAULT_FLAGS;
5722 private PendingIntent mDisplayIntent;
5723 private ArrayList<Notification> mPages = new ArrayList<Notification>();
5724 private Bitmap mBackground;
5725 private int mContentIcon;
5726 private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY;
5727 private int mContentActionIndex = UNSET_ACTION_INDEX;
5728 private int mCustomSizePreset = SIZE_DEFAULT;
5729 private int mCustomContentHeight;
5730 private int mGravity = DEFAULT_GRAVITY;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005731 private int mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04005732 private String mDismissalId;
Griff Hazen61a9e862014-05-22 16:05:19 -07005733
5734 /**
5735 * Create a {@link android.app.Notification.WearableExtender} with default
5736 * options.
5737 */
5738 public WearableExtender() {
5739 }
5740
5741 public WearableExtender(Notification notif) {
5742 Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS);
5743 if (wearableBundle != null) {
5744 List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS);
5745 if (actions != null) {
5746 mActions.addAll(actions);
5747 }
5748
5749 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
5750 mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT);
5751
5752 Notification[] pages = getNotificationArrayFromBundle(
5753 wearableBundle, KEY_PAGES);
5754 if (pages != null) {
5755 Collections.addAll(mPages, pages);
5756 }
5757
5758 mBackground = wearableBundle.getParcelable(KEY_BACKGROUND);
5759 mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON);
5760 mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY,
5761 DEFAULT_CONTENT_ICON_GRAVITY);
5762 mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX,
5763 UNSET_ACTION_INDEX);
5764 mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET,
5765 SIZE_DEFAULT);
5766 mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT);
5767 mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY);
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005768 mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT);
Nadia Benbernou948627e2016-04-14 14:41:08 -04005769 mDismissalId = wearableBundle.getString(KEY_DISMISSAL_ID);
Griff Hazen61a9e862014-05-22 16:05:19 -07005770 }
5771 }
5772
5773 /**
5774 * Apply wearable extensions to a notification that is being built. This is typically
5775 * called by the {@link android.app.Notification.Builder#extend} method of
5776 * {@link android.app.Notification.Builder}.
5777 */
5778 @Override
5779 public Notification.Builder extend(Notification.Builder builder) {
5780 Bundle wearableBundle = new Bundle();
5781
5782 if (!mActions.isEmpty()) {
5783 wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions);
5784 }
5785 if (mFlags != DEFAULT_FLAGS) {
5786 wearableBundle.putInt(KEY_FLAGS, mFlags);
5787 }
5788 if (mDisplayIntent != null) {
5789 wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent);
5790 }
5791 if (!mPages.isEmpty()) {
5792 wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray(
5793 new Notification[mPages.size()]));
5794 }
5795 if (mBackground != null) {
5796 wearableBundle.putParcelable(KEY_BACKGROUND, mBackground);
5797 }
5798 if (mContentIcon != 0) {
5799 wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon);
5800 }
5801 if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) {
5802 wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity);
5803 }
5804 if (mContentActionIndex != UNSET_ACTION_INDEX) {
5805 wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX,
5806 mContentActionIndex);
5807 }
5808 if (mCustomSizePreset != SIZE_DEFAULT) {
5809 wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset);
5810 }
5811 if (mCustomContentHeight != 0) {
5812 wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight);
5813 }
5814 if (mGravity != DEFAULT_GRAVITY) {
5815 wearableBundle.putInt(KEY_GRAVITY, mGravity);
5816 }
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005817 if (mHintScreenTimeout != 0) {
5818 wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout);
5819 }
Nadia Benbernou948627e2016-04-14 14:41:08 -04005820 if (mDismissalId != null) {
5821 wearableBundle.putString(KEY_DISMISSAL_ID, mDismissalId);
5822 }
Griff Hazen61a9e862014-05-22 16:05:19 -07005823
5824 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
5825 return builder;
5826 }
5827
5828 @Override
5829 public WearableExtender clone() {
5830 WearableExtender that = new WearableExtender();
5831 that.mActions = new ArrayList<Action>(this.mActions);
5832 that.mFlags = this.mFlags;
5833 that.mDisplayIntent = this.mDisplayIntent;
5834 that.mPages = new ArrayList<Notification>(this.mPages);
5835 that.mBackground = this.mBackground;
5836 that.mContentIcon = this.mContentIcon;
5837 that.mContentIconGravity = this.mContentIconGravity;
5838 that.mContentActionIndex = this.mContentActionIndex;
5839 that.mCustomSizePreset = this.mCustomSizePreset;
5840 that.mCustomContentHeight = this.mCustomContentHeight;
5841 that.mGravity = this.mGravity;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005842 that.mHintScreenTimeout = this.mHintScreenTimeout;
Nadia Benbernou948627e2016-04-14 14:41:08 -04005843 that.mDismissalId = this.mDismissalId;
Griff Hazen61a9e862014-05-22 16:05:19 -07005844 return that;
5845 }
5846
5847 /**
5848 * Add a wearable action to this notification.
5849 *
5850 * <p>When wearable actions are added using this method, the set of actions that
5851 * show on a wearable device splits from devices that only show actions added
5852 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
5853 * of which actions display on different devices.
5854 *
5855 * @param action the action to add to this notification
5856 * @return this object for method chaining
5857 * @see android.app.Notification.Action
5858 */
5859 public WearableExtender addAction(Action action) {
5860 mActions.add(action);
5861 return this;
5862 }
5863
5864 /**
5865 * Adds wearable actions to this notification.
5866 *
5867 * <p>When wearable actions are added using this method, the set of actions that
5868 * show on a wearable device splits from devices that only show actions added
5869 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
5870 * of which actions display on different devices.
5871 *
5872 * @param actions the actions to add to this notification
5873 * @return this object for method chaining
5874 * @see android.app.Notification.Action
5875 */
5876 public WearableExtender addActions(List<Action> actions) {
5877 mActions.addAll(actions);
5878 return this;
5879 }
5880
5881 /**
5882 * Clear all wearable actions present on this builder.
5883 * @return this object for method chaining.
5884 * @see #addAction
5885 */
5886 public WearableExtender clearActions() {
5887 mActions.clear();
5888 return this;
5889 }
5890
5891 /**
5892 * Get the wearable actions present on this notification.
5893 */
5894 public List<Action> getActions() {
5895 return mActions;
5896 }
5897
5898 /**
5899 * Set an intent to launch inside of an activity view when displaying
Griff Hazen14f57992014-05-26 09:07:14 -07005900 * this notification. The {@link PendingIntent} provided should be for an activity.
5901 *
5902 * <pre class="prettyprint">
5903 * Intent displayIntent = new Intent(context, MyDisplayActivity.class);
5904 * PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
5905 * 0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
5906 * Notification notif = new Notification.Builder(context)
5907 * .extend(new Notification.WearableExtender()
5908 * .setDisplayIntent(displayPendingIntent)
5909 * .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM))
5910 * .build();</pre>
5911 *
5912 * <p>The activity to launch needs to allow embedding, must be exported, and
Griff Hazen831ca9d2014-06-17 00:38:38 -07005913 * should have an empty task affinity. It is also recommended to use the device
5914 * default light theme.
Griff Hazen14f57992014-05-26 09:07:14 -07005915 *
5916 * <p>Example AndroidManifest.xml entry:
5917 * <pre class="prettyprint">
5918 * &lt;activity android:name=&quot;com.example.MyDisplayActivity&quot;
5919 * android:exported=&quot;true&quot;
5920 * android:allowEmbedded=&quot;true&quot;
Griff Hazen831ca9d2014-06-17 00:38:38 -07005921 * android:taskAffinity=&quot;&quot;
5922 * android:theme=&quot;@android:style/Theme.DeviceDefault.Light&quot; /&gt;</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07005923 *
5924 * @param intent the {@link PendingIntent} for an activity
5925 * @return this object for method chaining
5926 * @see android.app.Notification.WearableExtender#getDisplayIntent
5927 */
5928 public WearableExtender setDisplayIntent(PendingIntent intent) {
5929 mDisplayIntent = intent;
5930 return this;
5931 }
5932
5933 /**
5934 * Get the intent to launch inside of an activity view when displaying this
5935 * notification. This {@code PendingIntent} should be for an activity.
5936 */
5937 public PendingIntent getDisplayIntent() {
5938 return mDisplayIntent;
5939 }
5940
5941 /**
5942 * Add an additional page of content to display with this notification. The current
5943 * notification forms the first page, and pages added using this function form
5944 * subsequent pages. This field can be used to separate a notification into multiple
5945 * sections.
5946 *
5947 * @param page the notification to add as another page
5948 * @return this object for method chaining
5949 * @see android.app.Notification.WearableExtender#getPages
5950 */
5951 public WearableExtender addPage(Notification page) {
5952 mPages.add(page);
5953 return this;
5954 }
5955
5956 /**
5957 * Add additional pages of content to display with this notification. The current
5958 * notification forms the first page, and pages added using this function form
5959 * subsequent pages. This field can be used to separate a notification into multiple
5960 * sections.
5961 *
5962 * @param pages a list of notifications
5963 * @return this object for method chaining
5964 * @see android.app.Notification.WearableExtender#getPages
5965 */
5966 public WearableExtender addPages(List<Notification> pages) {
5967 mPages.addAll(pages);
5968 return this;
5969 }
5970
5971 /**
5972 * Clear all additional pages present on this builder.
5973 * @return this object for method chaining.
5974 * @see #addPage
5975 */
5976 public WearableExtender clearPages() {
5977 mPages.clear();
5978 return this;
5979 }
5980
5981 /**
5982 * Get the array of additional pages of content for displaying this notification. The
5983 * current notification forms the first page, and elements within this array form
5984 * subsequent pages. This field can be used to separate a notification into multiple
5985 * sections.
5986 * @return the pages for this notification
5987 */
5988 public List<Notification> getPages() {
5989 return mPages;
5990 }
5991
5992 /**
5993 * Set a background image to be displayed behind the notification content.
5994 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
5995 * will work with any notification style.
5996 *
5997 * @param background the background bitmap
5998 * @return this object for method chaining
5999 * @see android.app.Notification.WearableExtender#getBackground
6000 */
6001 public WearableExtender setBackground(Bitmap background) {
6002 mBackground = background;
6003 return this;
6004 }
6005
6006 /**
6007 * Get a background image to be displayed behind the notification content.
6008 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
6009 * will work with any notification style.
6010 *
6011 * @return the background image
6012 * @see android.app.Notification.WearableExtender#setBackground
6013 */
6014 public Bitmap getBackground() {
6015 return mBackground;
6016 }
6017
6018 /**
6019 * Set an icon that goes with the content of this notification.
6020 */
6021 public WearableExtender setContentIcon(int icon) {
6022 mContentIcon = icon;
6023 return this;
6024 }
6025
6026 /**
6027 * Get an icon that goes with the content of this notification.
6028 */
6029 public int getContentIcon() {
6030 return mContentIcon;
6031 }
6032
6033 /**
6034 * Set the gravity that the content icon should have within the notification display.
6035 * Supported values include {@link android.view.Gravity#START} and
6036 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
6037 * @see #setContentIcon
6038 */
6039 public WearableExtender setContentIconGravity(int contentIconGravity) {
6040 mContentIconGravity = contentIconGravity;
6041 return this;
6042 }
6043
6044 /**
6045 * Get the gravity that the content icon should have within the notification display.
6046 * Supported values include {@link android.view.Gravity#START} and
6047 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
6048 * @see #getContentIcon
6049 */
6050 public int getContentIconGravity() {
6051 return mContentIconGravity;
6052 }
6053
6054 /**
6055 * Set an action from this notification's actions to be clickable with the content of
Griff Hazen14f57992014-05-26 09:07:14 -07006056 * this notification. This action will no longer display separately from the
6057 * notification's content.
6058 *
Griff Hazenca48d352014-05-28 22:37:13 -07006059 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07006060 * set, although the list of available actions comes from the main notification and not
6061 * from the child page's notification.
6062 *
6063 * @param actionIndex The index of the action to hoist onto the current notification page.
6064 * If wearable actions were added to the main notification, this index
6065 * will apply to that list, otherwise it will apply to the regular
6066 * actions list.
Griff Hazen61a9e862014-05-22 16:05:19 -07006067 */
6068 public WearableExtender setContentAction(int actionIndex) {
6069 mContentActionIndex = actionIndex;
6070 return this;
6071 }
6072
6073 /**
Griff Hazenca48d352014-05-28 22:37:13 -07006074 * Get the index of the notification action, if any, that was specified as being clickable
6075 * with the content of this notification. This action will no longer display separately
Griff Hazen14f57992014-05-26 09:07:14 -07006076 * from the notification's content.
Griff Hazen61a9e862014-05-22 16:05:19 -07006077 *
Griff Hazenca48d352014-05-28 22:37:13 -07006078 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07006079 * set, although the list of available actions comes from the main notification and not
6080 * from the child page's notification.
6081 *
6082 * <p>If wearable specific actions were added to the main notification, this index will
6083 * apply to that list, otherwise it will apply to the regular actions list.
Griff Hazenca48d352014-05-28 22:37:13 -07006084 *
6085 * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected.
Griff Hazen61a9e862014-05-22 16:05:19 -07006086 */
6087 public int getContentAction() {
6088 return mContentActionIndex;
6089 }
6090
6091 /**
6092 * Set the gravity that this notification should have within the available viewport space.
6093 * Supported values include {@link android.view.Gravity#TOP},
6094 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
6095 * The default value is {@link android.view.Gravity#BOTTOM}.
6096 */
6097 public WearableExtender setGravity(int gravity) {
6098 mGravity = gravity;
6099 return this;
6100 }
6101
6102 /**
6103 * Get the gravity that this notification should have within the available viewport space.
6104 * Supported values include {@link android.view.Gravity#TOP},
6105 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
6106 * The default value is {@link android.view.Gravity#BOTTOM}.
6107 */
6108 public int getGravity() {
6109 return mGravity;
6110 }
6111
6112 /**
6113 * Set the custom size preset for the display of this notification out of the available
6114 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
6115 * {@link #SIZE_LARGE}.
6116 * <p>Some custom size presets are only applicable for custom display notifications created
6117 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the
6118 * documentation for the preset in question. See also
6119 * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}.
6120 */
6121 public WearableExtender setCustomSizePreset(int sizePreset) {
6122 mCustomSizePreset = sizePreset;
6123 return this;
6124 }
6125
6126 /**
6127 * Get the custom size preset for the display of this notification out of the available
6128 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
6129 * {@link #SIZE_LARGE}.
6130 * <p>Some custom size presets are only applicable for custom display notifications created
6131 * using {@link #setDisplayIntent}. Check the documentation for the preset in question.
6132 * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}.
6133 */
6134 public int getCustomSizePreset() {
6135 return mCustomSizePreset;
6136 }
6137
6138 /**
6139 * Set the custom height in pixels for the display of this notification's content.
6140 * <p>This option is only available for custom display notifications created
6141 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also
6142 * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and
6143 * {@link #getCustomContentHeight}.
6144 */
6145 public WearableExtender setCustomContentHeight(int height) {
6146 mCustomContentHeight = height;
6147 return this;
6148 }
6149
6150 /**
6151 * Get the custom height in pixels for the display of this notification's content.
6152 * <p>This option is only available for custom display notifications created
6153 * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and
6154 * {@link #setCustomContentHeight}.
6155 */
6156 public int getCustomContentHeight() {
6157 return mCustomContentHeight;
6158 }
6159
6160 /**
6161 * Set whether the scrolling position for the contents of this notification should start
6162 * at the bottom of the contents instead of the top when the contents are too long to
6163 * display within the screen. Default is false (start scroll at the top).
6164 */
6165 public WearableExtender setStartScrollBottom(boolean startScrollBottom) {
6166 setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom);
6167 return this;
6168 }
6169
6170 /**
6171 * Get whether the scrolling position for the contents of this notification should start
6172 * at the bottom of the contents instead of the top when the contents are too long to
6173 * display within the screen. Default is false (start scroll at the top).
6174 */
6175 public boolean getStartScrollBottom() {
6176 return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0;
6177 }
6178
6179 /**
6180 * Set whether the content intent is available when the wearable device is not connected
6181 * to a companion device. The user can still trigger this intent when the wearable device
6182 * is offline, but a visual hint will indicate that the content intent may not be available.
6183 * Defaults to true.
6184 */
6185 public WearableExtender setContentIntentAvailableOffline(
6186 boolean contentIntentAvailableOffline) {
6187 setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline);
6188 return this;
6189 }
6190
6191 /**
6192 * Get whether the content intent is available when the wearable device is not connected
6193 * to a companion device. The user can still trigger this intent when the wearable device
6194 * is offline, but a visual hint will indicate that the content intent may not be available.
6195 * Defaults to true.
6196 */
6197 public boolean getContentIntentAvailableOffline() {
6198 return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0;
6199 }
6200
6201 /**
6202 * Set a hint that this notification's icon should not be displayed.
6203 * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise.
6204 * @return this object for method chaining
6205 */
6206 public WearableExtender setHintHideIcon(boolean hintHideIcon) {
6207 setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon);
6208 return this;
6209 }
6210
6211 /**
6212 * Get a hint that this notification's icon should not be displayed.
6213 * @return {@code true} if this icon should not be displayed, false otherwise.
6214 * The default value is {@code false} if this was never set.
6215 */
6216 public boolean getHintHideIcon() {
6217 return (mFlags & FLAG_HINT_HIDE_ICON) != 0;
6218 }
6219
6220 /**
6221 * Set a visual hint that only the background image of this notification should be
6222 * displayed, and other semantic content should be hidden. This hint is only applicable
6223 * to sub-pages added using {@link #addPage}.
6224 */
6225 public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) {
6226 setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly);
6227 return this;
6228 }
6229
6230 /**
6231 * Get a visual hint that only the background image of this notification should be
6232 * displayed, and other semantic content should be hidden. This hint is only applicable
6233 * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}.
6234 */
6235 public boolean getHintShowBackgroundOnly() {
6236 return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0;
6237 }
6238
Griff Hazen5f2edfc2014-09-29 16:28:44 -07006239 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08006240 * Set a hint that this notification's background should not be clipped if possible,
6241 * and should instead be resized to fully display on the screen, retaining the aspect
6242 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07006243 * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
6244 * @return this object for method chaining
6245 */
6246 public WearableExtender setHintAvoidBackgroundClipping(
6247 boolean hintAvoidBackgroundClipping) {
6248 setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping);
6249 return this;
6250 }
6251
6252 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08006253 * Get a hint that this notification's background should not be clipped if possible,
6254 * and should instead be resized to fully display on the screen, retaining the aspect
6255 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07006256 * @return {@code true} if it's ok if the background is clipped on the screen, false
6257 * otherwise. The default value is {@code false} if this was never set.
6258 */
6259 public boolean getHintAvoidBackgroundClipping() {
6260 return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0;
6261 }
6262
6263 /**
6264 * Set a hint that the screen should remain on for at least this duration when
6265 * this notification is displayed on the screen.
6266 * @param timeout The requested screen timeout in milliseconds. Can also be either
6267 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
6268 * @return this object for method chaining
6269 */
6270 public WearableExtender setHintScreenTimeout(int timeout) {
6271 mHintScreenTimeout = timeout;
6272 return this;
6273 }
6274
6275 /**
6276 * Get the duration, in milliseconds, that the screen should remain on for
6277 * when this notification is displayed.
6278 * @return the duration in milliseconds if > 0, or either one of the sentinel values
6279 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
6280 */
6281 public int getHintScreenTimeout() {
6282 return mHintScreenTimeout;
6283 }
6284
Alex Hills9ab3a232016-04-05 14:54:56 -04006285 /**
Alex Hills4bcb06b2016-04-05 14:26:25 -04006286 * Set a hint that this notification's {@link BigPictureStyle} (if present) should be
6287 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
6288 * qr codes, as well as other simple black-and-white tickets.
6289 * @param hintAmbientBigPicture {@code true} to enable converstion and ambient.
6290 * @return this object for method chaining
6291 */
6292 public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) {
6293 setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture);
6294 return this;
6295 }
6296
6297 /**
6298 * Get a hint that this notification's {@link BigPictureStyle} (if present) should be
6299 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
6300 * qr codes, as well as other simple black-and-white tickets.
6301 * @return {@code true} if it should be displayed in ambient, false otherwise
6302 * otherwise. The default value is {@code false} if this was never set.
6303 */
6304 public boolean getHintAmbientBigPicture() {
6305 return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0;
6306 }
6307
6308 /**
Alex Hills9ab3a232016-04-05 14:54:56 -04006309 * Set a hint that this notification's content intent will launch an {@link Activity}
6310 * directly, telling the platform that it can generate the appropriate transitions.
6311 * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch
6312 * an activity and transitions should be generated, false otherwise.
6313 * @return this object for method chaining
6314 */
6315 public WearableExtender setHintContentIntentLaunchesActivity(
6316 boolean hintContentIntentLaunchesActivity) {
6317 setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity);
6318 return this;
6319 }
6320
6321 /**
6322 * Get a hint that this notification's content intent will launch an {@link Activity}
6323 * directly, telling the platform that it can generate the appropriate transitions
6324 * @return {@code true} if the content intent will launch an activity and transitions should
6325 * be generated, false otherwise. The default value is {@code false} if this was never set.
6326 */
6327 public boolean getHintContentIntentLaunchesActivity() {
6328 return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0;
6329 }
6330
Nadia Benbernou948627e2016-04-14 14:41:08 -04006331 /**
6332 * When you post a notification, if you set the dismissal id field, then when that
6333 * notification is canceled, notifications on other wearables and the paired Android phone
6334 * having that same dismissal id will also be canceled. Note that this only works if you
6335 * have notification bridge mode set to NO_BRIDGING in your Wear app manifest. See
6336 * <a href="{@docRoot}wear/notifications/index.html">Adding Wearable Features to
6337 * Notifications</a> for more information on how to use the bridge mode feature.
6338 * @param dismissalId the dismissal id of the notification.
6339 * @return this object for method chaining
6340 */
6341 public WearableExtender setDismissalId(String dismissalId) {
6342 mDismissalId = dismissalId;
6343 return this;
6344 }
6345
6346 /**
6347 * Returns the dismissal id of the notification.
6348 * @return the dismissal id of the notification or null if it has not been set.
6349 */
6350 public String getDismissalId() {
6351 return mDismissalId;
6352 }
6353
Griff Hazen61a9e862014-05-22 16:05:19 -07006354 private void setFlag(int mask, boolean value) {
6355 if (value) {
6356 mFlags |= mask;
6357 } else {
6358 mFlags &= ~mask;
6359 }
6360 }
6361 }
6362
6363 /**
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08006364 * <p>Helper class to add Android Auto extensions to notifications. To create a notification
6365 * with car extensions:
6366 *
6367 * <ol>
6368 * <li>Create an {@link Notification.Builder}, setting any desired
6369 * properties.
6370 * <li>Create a {@link CarExtender}.
6371 * <li>Set car-specific properties using the {@code add} and {@code set} methods of
6372 * {@link CarExtender}.
6373 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
6374 * to apply the extensions to a notification.
6375 * </ol>
6376 *
6377 * <pre class="prettyprint">
6378 * Notification notification = new Notification.Builder(context)
6379 * ...
6380 * .extend(new CarExtender()
6381 * .set*(...))
6382 * .build();
6383 * </pre>
6384 *
6385 * <p>Car extensions can be accessed on an existing notification by using the
6386 * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods
6387 * to access values.
6388 */
6389 public static final class CarExtender implements Extender {
6390 private static final String TAG = "CarExtender";
6391
6392 private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS";
6393 private static final String EXTRA_LARGE_ICON = "large_icon";
6394 private static final String EXTRA_CONVERSATION = "car_conversation";
6395 private static final String EXTRA_COLOR = "app_color";
6396
6397 private Bitmap mLargeIcon;
6398 private UnreadConversation mUnreadConversation;
6399 private int mColor = Notification.COLOR_DEFAULT;
6400
6401 /**
6402 * Create a {@link CarExtender} with default options.
6403 */
6404 public CarExtender() {
6405 }
6406
6407 /**
6408 * Create a {@link CarExtender} from the CarExtender options of an existing Notification.
6409 *
6410 * @param notif The notification from which to copy options.
6411 */
6412 public CarExtender(Notification notif) {
6413 Bundle carBundle = notif.extras == null ?
6414 null : notif.extras.getBundle(EXTRA_CAR_EXTENDER);
6415 if (carBundle != null) {
6416 mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON);
6417 mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT);
6418
6419 Bundle b = carBundle.getBundle(EXTRA_CONVERSATION);
6420 mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b);
6421 }
6422 }
6423
6424 /**
6425 * Apply car extensions to a notification that is being built. This is typically called by
6426 * the {@link Notification.Builder#extend(Notification.Extender)}
6427 * method of {@link Notification.Builder}.
6428 */
6429 @Override
6430 public Notification.Builder extend(Notification.Builder builder) {
6431 Bundle carExtensions = new Bundle();
6432
6433 if (mLargeIcon != null) {
6434 carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon);
6435 }
6436 if (mColor != Notification.COLOR_DEFAULT) {
6437 carExtensions.putInt(EXTRA_COLOR, mColor);
6438 }
6439
6440 if (mUnreadConversation != null) {
6441 Bundle b = mUnreadConversation.getBundleForUnreadConversation();
6442 carExtensions.putBundle(EXTRA_CONVERSATION, b);
6443 }
6444
6445 builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions);
6446 return builder;
6447 }
6448
6449 /**
6450 * Sets the accent color to use when Android Auto presents the notification.
6451 *
6452 * Android Auto uses the color set with {@link Notification.Builder#setColor(int)}
6453 * to accent the displayed notification. However, not all colors are acceptable in an
6454 * automotive setting. This method can be used to override the color provided in the
6455 * notification in such a situation.
6456 */
Tor Norbye80756e32015-03-02 09:39:27 -08006457 public CarExtender setColor(@ColorInt int color) {
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08006458 mColor = color;
6459 return this;
6460 }
6461
6462 /**
6463 * Gets the accent color.
6464 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006465 * @see #setColor
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08006466 */
Tor Norbye80756e32015-03-02 09:39:27 -08006467 @ColorInt
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08006468 public int getColor() {
6469 return mColor;
6470 }
6471
6472 /**
6473 * Sets the large icon of the car notification.
6474 *
6475 * If no large icon is set in the extender, Android Auto will display the icon
6476 * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)}
6477 *
6478 * @param largeIcon The large icon to use in the car notification.
6479 * @return This object for method chaining.
6480 */
6481 public CarExtender setLargeIcon(Bitmap largeIcon) {
6482 mLargeIcon = largeIcon;
6483 return this;
6484 }
6485
6486 /**
6487 * Gets the large icon used in this car notification, or null if no icon has been set.
6488 *
6489 * @return The large icon for the car notification.
6490 * @see CarExtender#setLargeIcon
6491 */
6492 public Bitmap getLargeIcon() {
6493 return mLargeIcon;
6494 }
6495
6496 /**
6497 * Sets the unread conversation in a message notification.
6498 *
6499 * @param unreadConversation The unread part of the conversation this notification conveys.
6500 * @return This object for method chaining.
6501 */
6502 public CarExtender setUnreadConversation(UnreadConversation unreadConversation) {
6503 mUnreadConversation = unreadConversation;
6504 return this;
6505 }
6506
6507 /**
6508 * Returns the unread conversation conveyed by this notification.
6509 * @see #setUnreadConversation(UnreadConversation)
6510 */
6511 public UnreadConversation getUnreadConversation() {
6512 return mUnreadConversation;
6513 }
6514
6515 /**
6516 * A class which holds the unread messages from a conversation.
6517 */
6518 public static class UnreadConversation {
6519 private static final String KEY_AUTHOR = "author";
6520 private static final String KEY_TEXT = "text";
6521 private static final String KEY_MESSAGES = "messages";
6522 private static final String KEY_REMOTE_INPUT = "remote_input";
6523 private static final String KEY_ON_REPLY = "on_reply";
6524 private static final String KEY_ON_READ = "on_read";
6525 private static final String KEY_PARTICIPANTS = "participants";
6526 private static final String KEY_TIMESTAMP = "timestamp";
6527
6528 private final String[] mMessages;
6529 private final RemoteInput mRemoteInput;
6530 private final PendingIntent mReplyPendingIntent;
6531 private final PendingIntent mReadPendingIntent;
6532 private final String[] mParticipants;
6533 private final long mLatestTimestamp;
6534
6535 UnreadConversation(String[] messages, RemoteInput remoteInput,
6536 PendingIntent replyPendingIntent, PendingIntent readPendingIntent,
6537 String[] participants, long latestTimestamp) {
6538 mMessages = messages;
6539 mRemoteInput = remoteInput;
6540 mReadPendingIntent = readPendingIntent;
6541 mReplyPendingIntent = replyPendingIntent;
6542 mParticipants = participants;
6543 mLatestTimestamp = latestTimestamp;
6544 }
6545
6546 /**
6547 * Gets the list of messages conveyed by this notification.
6548 */
6549 public String[] getMessages() {
6550 return mMessages;
6551 }
6552
6553 /**
6554 * Gets the remote input that will be used to convey the response to a message list, or
6555 * null if no such remote input exists.
6556 */
6557 public RemoteInput getRemoteInput() {
6558 return mRemoteInput;
6559 }
6560
6561 /**
6562 * Gets the pending intent that will be triggered when the user replies to this
6563 * notification.
6564 */
6565 public PendingIntent getReplyPendingIntent() {
6566 return mReplyPendingIntent;
6567 }
6568
6569 /**
6570 * Gets the pending intent that Android Auto will send after it reads aloud all messages
6571 * in this object's message list.
6572 */
6573 public PendingIntent getReadPendingIntent() {
6574 return mReadPendingIntent;
6575 }
6576
6577 /**
6578 * Gets the participants in the conversation.
6579 */
6580 public String[] getParticipants() {
6581 return mParticipants;
6582 }
6583
6584 /**
6585 * Gets the firs participant in the conversation.
6586 */
6587 public String getParticipant() {
6588 return mParticipants.length > 0 ? mParticipants[0] : null;
6589 }
6590
6591 /**
6592 * Gets the timestamp of the conversation.
6593 */
6594 public long getLatestTimestamp() {
6595 return mLatestTimestamp;
6596 }
6597
6598 Bundle getBundleForUnreadConversation() {
6599 Bundle b = new Bundle();
6600 String author = null;
6601 if (mParticipants != null && mParticipants.length > 1) {
6602 author = mParticipants[0];
6603 }
6604 Parcelable[] messages = new Parcelable[mMessages.length];
6605 for (int i = 0; i < messages.length; i++) {
6606 Bundle m = new Bundle();
6607 m.putString(KEY_TEXT, mMessages[i]);
6608 m.putString(KEY_AUTHOR, author);
6609 messages[i] = m;
6610 }
6611 b.putParcelableArray(KEY_MESSAGES, messages);
6612 if (mRemoteInput != null) {
6613 b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput);
6614 }
6615 b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent);
6616 b.putParcelable(KEY_ON_READ, mReadPendingIntent);
6617 b.putStringArray(KEY_PARTICIPANTS, mParticipants);
6618 b.putLong(KEY_TIMESTAMP, mLatestTimestamp);
6619 return b;
6620 }
6621
6622 static UnreadConversation getUnreadConversationFromBundle(Bundle b) {
6623 if (b == null) {
6624 return null;
6625 }
6626 Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES);
6627 String[] messages = null;
6628 if (parcelableMessages != null) {
6629 String[] tmp = new String[parcelableMessages.length];
6630 boolean success = true;
6631 for (int i = 0; i < tmp.length; i++) {
6632 if (!(parcelableMessages[i] instanceof Bundle)) {
6633 success = false;
6634 break;
6635 }
6636 tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT);
6637 if (tmp[i] == null) {
6638 success = false;
6639 break;
6640 }
6641 }
6642 if (success) {
6643 messages = tmp;
6644 } else {
6645 return null;
6646 }
6647 }
6648
6649 PendingIntent onRead = b.getParcelable(KEY_ON_READ);
6650 PendingIntent onReply = b.getParcelable(KEY_ON_REPLY);
6651
6652 RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT);
6653
6654 String[] participants = b.getStringArray(KEY_PARTICIPANTS);
6655 if (participants == null || participants.length != 1) {
6656 return null;
6657 }
6658
6659 return new UnreadConversation(messages,
6660 remoteInput,
6661 onReply,
6662 onRead,
6663 participants, b.getLong(KEY_TIMESTAMP));
6664 }
6665 };
6666
6667 /**
6668 * Builder class for {@link CarExtender.UnreadConversation} objects.
6669 */
6670 public static class Builder {
6671 private final List<String> mMessages = new ArrayList<String>();
6672 private final String mParticipant;
6673 private RemoteInput mRemoteInput;
6674 private PendingIntent mReadPendingIntent;
6675 private PendingIntent mReplyPendingIntent;
6676 private long mLatestTimestamp;
6677
6678 /**
6679 * Constructs a new builder for {@link CarExtender.UnreadConversation}.
6680 *
6681 * @param name The name of the other participant in the conversation.
6682 */
6683 public Builder(String name) {
6684 mParticipant = name;
6685 }
6686
6687 /**
6688 * Appends a new unread message to the list of messages for this conversation.
6689 *
6690 * The messages should be added from oldest to newest.
6691 *
6692 * @param message The text of the new unread message.
6693 * @return This object for method chaining.
6694 */
6695 public Builder addMessage(String message) {
6696 mMessages.add(message);
6697 return this;
6698 }
6699
6700 /**
6701 * Sets the pending intent and remote input which will convey the reply to this
6702 * notification.
6703 *
6704 * @param pendingIntent The pending intent which will be triggered on a reply.
6705 * @param remoteInput The remote input parcelable which will carry the reply.
6706 * @return This object for method chaining.
6707 *
6708 * @see CarExtender.UnreadConversation#getRemoteInput
6709 * @see CarExtender.UnreadConversation#getReplyPendingIntent
6710 */
6711 public Builder setReplyAction(
6712 PendingIntent pendingIntent, RemoteInput remoteInput) {
6713 mRemoteInput = remoteInput;
6714 mReplyPendingIntent = pendingIntent;
6715
6716 return this;
6717 }
6718
6719 /**
6720 * Sets the pending intent that will be sent once the messages in this notification
6721 * are read.
6722 *
6723 * @param pendingIntent The pending intent to use.
6724 * @return This object for method chaining.
6725 */
6726 public Builder setReadPendingIntent(PendingIntent pendingIntent) {
6727 mReadPendingIntent = pendingIntent;
6728 return this;
6729 }
6730
6731 /**
6732 * Sets the timestamp of the most recent message in an unread conversation.
6733 *
6734 * If a messaging notification has been posted by your application and has not
6735 * yet been cancelled, posting a later notification with the same id and tag
6736 * but without a newer timestamp may result in Android Auto not displaying a
6737 * heads up notification for the later notification.
6738 *
6739 * @param timestamp The timestamp of the most recent message in the conversation.
6740 * @return This object for method chaining.
6741 */
6742 public Builder setLatestTimestamp(long timestamp) {
6743 mLatestTimestamp = timestamp;
6744 return this;
6745 }
6746
6747 /**
6748 * Builds a new unread conversation object.
6749 *
6750 * @return The new unread conversation object.
6751 */
6752 public UnreadConversation build() {
6753 String[] messages = mMessages.toArray(new String[mMessages.size()]);
6754 String[] participants = { mParticipant };
6755 return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent,
6756 mReadPendingIntent, participants, mLatestTimestamp);
6757 }
6758 }
6759 }
6760
6761 /**
Griff Hazen61a9e862014-05-22 16:05:19 -07006762 * Get an array of Notification objects from a parcelable array bundle field.
6763 * Update the bundle to have a typed array so fetches in the future don't need
6764 * to do an array copy.
6765 */
6766 private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) {
6767 Parcelable[] array = bundle.getParcelableArray(key);
6768 if (array instanceof Notification[] || array == null) {
6769 return (Notification[]) array;
6770 }
6771 Notification[] typedArray = Arrays.copyOf(array, array.length,
6772 Notification[].class);
6773 bundle.putParcelableArray(key, typedArray);
6774 return typedArray;
6775 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02006776
6777 private static class BuilderRemoteViews extends RemoteViews {
6778 public BuilderRemoteViews(Parcel parcel) {
6779 super(parcel);
6780 }
6781
Kenny Guy77320062014-08-27 21:37:15 +01006782 public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) {
6783 super(appInfo, layoutId);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006784 }
6785
6786 @Override
6787 public BuilderRemoteViews clone() {
6788 Parcel p = Parcel.obtain();
6789 writeToParcel(p, 0);
6790 p.setDataPosition(0);
6791 BuilderRemoteViews brv = new BuilderRemoteViews(p);
6792 p.recycle();
6793 return brv;
6794 }
6795 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006796}