blob: 25c098cd09f85fa1c725e825994e4602812751a4 [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;
Christoph Studer4600f9b2014-07-22 22:44:43 +020028import android.content.pm.PackageManager.NameNotFoundException;
Jorim Jaggief72a192014-08-26 21:57:46 +020029import android.content.res.ColorStateList;
Joe Onoratoef1e7762010-09-17 18:38:38 -040030import android.graphics.Bitmap;
Kenny Guy8a0101b2014-05-08 23:34:12 +010031import android.graphics.Canvas;
Adrian Roosc1a80b02016-04-05 14:54:55 -070032import android.graphics.Color;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +010033import android.graphics.PorterDuff;
Kenny Guy8a0101b2014-05-08 23:34:12 +010034import android.graphics.drawable.Drawable;
Dan Sandlerd63f9322015-05-06 15:18:49 -040035import android.graphics.drawable.Icon;
John Spurlockc0650f022014-07-19 13:22:39 -040036import android.media.AudioAttributes;
Jeff Sharkey098d5802012-04-26 17:30:34 -070037import android.media.AudioManager;
Jeff Browndba34ba2014-06-24 20:46:03 -070038import android.media.session.MediaSession;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080039import android.net.Uri;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -040040import android.os.BadParcelableException;
Christoph Studer239f8352014-08-25 15:13:18 +020041import android.os.Build;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050042import android.os.Bundle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043import android.os.Parcel;
44import android.os.Parcelable;
Daniel Sandlera2985ed2012-04-03 16:42:00 -040045import android.os.SystemClock;
Jeff Sharkey6d515712012-09-20 16:06:08 -070046import android.os.UserHandle;
Adrian Roosc1a80b02016-04-05 14:54:55 -070047import android.text.BidiFormatter;
Selim Cinek60a54252016-02-26 17:03:25 -080048import android.text.SpannableStringBuilder;
49import android.text.Spanned;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080050import android.text.TextUtils;
Selim Cinek60a54252016-02-26 17:03:25 -080051import android.text.style.AbsoluteSizeSpan;
Selim Cinek89991a22016-03-07 19:51:54 -080052import android.text.style.CharacterStyle;
Selim Cinek60a54252016-02-26 17:03:25 -080053import android.text.style.RelativeSizeSpan;
54import android.text.style.TextAppearanceSpan;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -040055import android.util.Log;
Dan Sandler50128532015-12-08 15:42:41 -050056import android.util.SparseArray;
Daniel Sandler9f7936a2012-05-21 16:14:28 -040057import android.util.TypedValue;
Griff Hazen61a9e862014-05-22 16:05:19 -070058import android.view.Gravity;
Selim Cinekea4bef72015-12-02 15:51:10 -080059import android.view.NotificationHeaderView;
Joe Onorato8595a3d2010-11-19 18:12:07 -080060import android.view.View;
Adrian Roos9b123cf2016-02-04 14:55:57 -080061import android.view.ViewGroup;
Jeff Sharkey1c400132011-08-05 14:50:13 -070062import android.widget.ProgressBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080063import android.widget.RemoteViews;
64
Griff Hazen959591e2014-05-15 22:26:18 -070065import com.android.internal.R;
Griff Hazenc091ba82014-05-16 10:13:26 -070066import com.android.internal.util.NotificationColorUtil;
Griff Hazen959591e2014-05-15 22:26:18 -070067
Tor Norbyed9273d62013-05-30 15:59:53 -070068import java.lang.annotation.Retention;
69import java.lang.annotation.RetentionPolicy;
Christoph Studer4600f9b2014-07-22 22:44:43 +020070import java.lang.reflect.Constructor;
Daniel Sandler2561b0b2012-02-13 21:04:12 -050071import java.util.ArrayList;
Griff Hazen61a9e862014-05-22 16:05:19 -070072import java.util.Arrays;
Griff Hazen5cadc3b2014-05-20 09:55:39 -070073import java.util.Collections;
Griff Hazen61a9e862014-05-22 16:05:19 -070074import java.util.List;
Dan Sandler50128532015-12-08 15:42:41 -050075import java.util.Set;
Joe Onorato561d3852010-11-20 18:09:34 -080076
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080077/**
78 * A class that represents how a persistent notification is to be presented to
79 * the user using the {@link android.app.NotificationManager}.
80 *
Joe Onoratocb109a02011-01-18 17:57:41 -080081 * <p>The {@link Notification.Builder Notification.Builder} has been added to make it
82 * easier to construct Notifications.</p>
83 *
Joe Fernandez558459f2011-10-13 16:47:36 -070084 * <div class="special reference">
85 * <h3>Developer Guides</h3>
86 * <p>For a guide to creating notifications, read the
87 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Status Bar Notifications</a>
88 * developer guide.</p>
89 * </div>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080090 */
91public class Notification implements Parcelable
92{
Daniel Sandlerdcbaf662013-04-26 16:23:09 -040093 private static final String TAG = "Notification";
94
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080095 /**
Daniel Sandler01df1c62014-06-09 10:54:01 -040096 * An activity that provides a user interface for adjusting notification preferences for its
97 * containing application. Optional but recommended for apps that post
98 * {@link android.app.Notification Notifications}.
99 */
100 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
101 public static final String INTENT_CATEGORY_NOTIFICATION_PREFERENCES
102 = "android.intent.category.NOTIFICATION_PREFERENCES";
103
104 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800105 * Use all default values (where applicable).
106 */
107 public static final int DEFAULT_ALL = ~0;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500108
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800109 /**
110 * Use the default notification sound. This will ignore any given
111 * {@link #sound}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500112 *
Chris Wren47c20a12014-06-18 17:27:29 -0400113 * <p>
114 * A notification that is noisy is more likely to be presented as a heads-up notification.
115 * </p>
116 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800117 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500118 */
119
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800120 public static final int DEFAULT_SOUND = 1;
121
122 /**
123 * Use the default notification vibrate. This will ignore any given
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500124 * {@link #vibrate}. Using phone vibration requires the
Scott Mainb8b36452009-04-26 15:50:49 -0700125 * {@link android.Manifest.permission#VIBRATE VIBRATE} permission.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500126 *
Chris Wren47c20a12014-06-18 17:27:29 -0400127 * <p>
128 * A notification that vibrates is more likely to be presented as a heads-up notification.
129 * </p>
130 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800131 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500132 */
133
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800134 public static final int DEFAULT_VIBRATE = 2;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500135
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800136 /**
137 * Use the default notification lights. This will ignore the
138 * {@link #FLAG_SHOW_LIGHTS} bit, and {@link #ledARGB}, {@link #ledOffMS}, or
139 * {@link #ledOnMS}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500140 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800141 * @see #defaults
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500142 */
143
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800144 public static final int DEFAULT_LIGHTS = 4;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500145
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800146 /**
Christoph Studer535ec612014-09-03 15:47:47 +0200147 * Maximum length of CharSequences accepted by Builder and friends.
148 *
149 * <p>
150 * Avoids spamming the system with overly large strings such as full e-mails.
151 */
152 private static final int MAX_CHARSEQUENCE_LENGTH = 5 * 1024;
153
154 /**
Adrian Roose458aa82015-12-08 16:17:19 -0800155 * Maximum entries of reply text that are accepted by Builder and friends.
156 */
157 private static final int MAX_REPLY_HISTORY = 5;
158
159 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500160 * A timestamp related to this notification, in milliseconds since the epoch.
Joe Malin8d40d042012-11-05 11:36:40 -0800161 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500162 * Default value: {@link System#currentTimeMillis() Now}.
163 *
164 * Choose a timestamp that will be most relevant to the user. For most finite events, this
165 * corresponds to the time the event happened (or will happen, in the case of events that have
166 * yet to occur but about which the user is being informed). Indefinite events should be
Joe Malin8d40d042012-11-05 11:36:40 -0800167 * timestamped according to when the activity began.
168 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500169 * Some examples:
Joe Malin8d40d042012-11-05 11:36:40 -0800170 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500171 * <ul>
172 * <li>Notification of a new chat message should be stamped when the message was received.</li>
173 * <li>Notification of an ongoing file download (with a progress bar, for example) should be stamped when the download started.</li>
174 * <li>Notification of a completed file download should be stamped when the download finished.</li>
175 * <li>Notification of an upcoming meeting should be stamped with the time the meeting will begin (that is, in the future).</li>
176 * <li>Notification of an ongoing stopwatch (increasing timer) should be stamped with the watch's start time.
177 * <li>Notification of an ongoing countdown timer should be stamped with the timer's end time.
Joe Malin8d40d042012-11-05 11:36:40 -0800178 * </ul>
179 *
Selim Cinek0ff1ce602016-04-05 18:27:16 -0700180 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not shown
181 * anymore by default and must be opted into by using
182 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800183 */
184 public long when;
185
186 /**
187 * The resource id of a drawable to use as the icon in the status bar.
Dan Sandler86647982015-05-13 23:41:13 -0400188 *
189 * @deprecated Use {@link Builder#setSmallIcon(Icon)} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800190 */
Dan Sandler86647982015-05-13 23:41:13 -0400191 @Deprecated
Tor Norbye7b9c9122013-05-30 16:48:33 -0700192 @DrawableRes
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800193 public int icon;
194
195 /**
Joe Onorato46439ce2010-11-19 13:56:21 -0800196 * If the icon in the status bar is to have more than one level, you can set this. Otherwise,
197 * leave it at its default value of 0.
198 *
199 * @see android.widget.ImageView#setImageLevel
Griff Hazen959591e2014-05-15 22:26:18 -0700200 * @see android.graphics.drawable.Drawable#setLevel
Joe Onorato46439ce2010-11-19 13:56:21 -0800201 */
202 public int iconLevel;
203
204 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500205 * The number of events that this notification represents. For example, in a new mail
206 * notification, this could be the number of unread messages.
Joe Malin8d40d042012-11-05 11:36:40 -0800207 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500208 * The system may or may not use this field to modify the appearance of the notification. For
209 * example, before {@link android.os.Build.VERSION_CODES#HONEYCOMB}, this number was
210 * superimposed over the icon in the status bar. Starting with
211 * {@link android.os.Build.VERSION_CODES#HONEYCOMB}, the template used by
212 * {@link Notification.Builder} has displayed the number in the expanded notification view.
Joe Malin8d40d042012-11-05 11:36:40 -0800213 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500214 * If the number is 0 or negative, it is never shown.
Selim Cinek0f9dd1e2016-04-05 17:03:40 -0700215 *
216 * @deprecated this number is not shown anymore
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800217 */
218 public int number;
219
220 /**
221 * The intent to execute when the expanded status entry is clicked. If
222 * this is an activity, it must include the
223 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -0800224 * that you take care of task management as described in the
225 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
Dianne Hackborn6ceca582012-01-10 15:24:26 -0800226 * Stack</a> document. In particular, make sure to read the notification section
227 * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html#HandlingNotifications">Handling
228 * Notifications</a> for the correct ways to launch an application from a
229 * notification.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800230 */
231 public PendingIntent contentIntent;
232
233 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500234 * The intent to execute when the notification is explicitly dismissed by the user, either with
235 * the "Clear All" button or by swiping it away individually.
236 *
237 * This probably shouldn't be launching an activity since several of those will be sent
238 * at the same time.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800239 */
240 public PendingIntent deleteIntent;
241
242 /**
Dianne Hackborn170bae72010-09-03 15:14:28 -0700243 * An intent to launch instead of posting the notification to the status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -0800244 *
Chris Wren47c20a12014-06-18 17:27:29 -0400245 * <p>
246 * The system UI may choose to display a heads-up notification, instead of
247 * launching this intent, while the user is using the device.
248 * </p>
249 *
Joe Onoratocb109a02011-01-18 17:57:41 -0800250 * @see Notification.Builder#setFullScreenIntent
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400251 */
252 public PendingIntent fullScreenIntent;
253
254 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400255 * Text that summarizes this notification for accessibility services.
256 *
257 * As of the L release, this text is no longer shown on screen, but it is still useful to
258 * accessibility services (where it serves as an audible announcement of the notification's
259 * appearance).
Joe Onoratoef1e7762010-09-17 18:38:38 -0400260 *
Joe Onorato46439ce2010-11-19 13:56:21 -0800261 * @see #tickerView
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800262 */
263 public CharSequence tickerText;
264
265 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400266 * Formerly, a view showing the {@link #tickerText}.
267 *
268 * No longer displayed in the status bar as of API 21.
Joe Onoratoef1e7762010-09-17 18:38:38 -0400269 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -0400270 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -0800271 public RemoteViews tickerView;
Joe Onoratoef1e7762010-09-17 18:38:38 -0400272
273 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400274 * The view that will represent this notification in the notification list (which is pulled
275 * down from the status bar).
276 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500277 * As of N, this field may be null. The notification view is determined by the inputs
278 * to {@link Notification.Builder}; a custom RemoteViews can optionally be
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400279 * supplied with {@link Notification.Builder#setCustomContentView(RemoteViews)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800280 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400281 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800282 public RemoteViews contentView;
283
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400284 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -0400285 * A large-format version of {@link #contentView}, giving the Notification an
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400286 * opportunity to show more detail. The system UI may choose to show this
287 * instead of the normal content view at its discretion.
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400288 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500289 * As of N, this field may be null. The expanded notification view is determined by the
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400290 * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
291 * supplied with {@link Notification.Builder#setCustomBigContentView(RemoteViews)}.
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400292 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400293 @Deprecated
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400294 public RemoteViews bigContentView;
295
Chris Wren8fd39ec2014-02-27 17:43:26 -0500296
297 /**
Chris Wren47c20a12014-06-18 17:27:29 -0400298 * A medium-format version of {@link #contentView}, providing the Notification an
299 * opportunity to add action buttons to contentView. At its discretion, the system UI may
300 * choose to show this as a heads-up notification, which will pop up so the user can see
301 * it without leaving their current activity.
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400302 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -0500303 * As of N, this field may be null. The heads-up notification view is determined by the
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400304 * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be
305 * supplied with {@link Notification.Builder#setCustomHeadsUpContentView(RemoteViews)}.
Chris Wren8fd39ec2014-02-27 17:43:26 -0500306 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400307 @Deprecated
Chris Wren8fd39ec2014-02-27 17:43:26 -0500308 public RemoteViews headsUpContentView;
309
Daniel Sandlerf3b73432012-03-27 15:01:25 -0400310 /**
Dan Sandler86647982015-05-13 23:41:13 -0400311 * A large bitmap to be shown in the notification content area.
312 *
313 * @deprecated Use {@link Builder#setLargeIcon(Icon)} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800314 */
Dan Sandler86647982015-05-13 23:41:13 -0400315 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -0800316 public Bitmap largeIcon;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800317
318 /**
319 * The sound to play.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500320 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800321 * <p>
Chris Wren47c20a12014-06-18 17:27:29 -0400322 * A notification that is noisy is more likely to be presented as a heads-up notification.
323 * </p>
324 *
325 * <p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500326 * To play the default notification sound, see {@link #defaults}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800327 * </p>
328 */
329 public Uri sound;
330
331 /**
332 * Use this constant as the value for audioStreamType to request that
333 * the default stream type for notifications be used. Currently the
Jeff Sharkey098d5802012-04-26 17:30:34 -0700334 * default stream type is {@link AudioManager#STREAM_NOTIFICATION}.
John Spurlockc0650f022014-07-19 13:22:39 -0400335 *
336 * @deprecated Use {@link #audioAttributes} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800337 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -0700338 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800339 public static final int STREAM_DEFAULT = -1;
340
341 /**
342 * The audio stream type to use when playing the sound.
343 * Should be one of the STREAM_ constants from
344 * {@link android.media.AudioManager}.
John Spurlockc0650f022014-07-19 13:22:39 -0400345 *
346 * @deprecated Use {@link #audioAttributes} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800347 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -0700348 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800349 public int audioStreamType = STREAM_DEFAULT;
350
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800351 /**
John Spurlockc0650f022014-07-19 13:22:39 -0400352 * The default value of {@link #audioAttributes}.
353 */
354 public static final AudioAttributes AUDIO_ATTRIBUTES_DEFAULT = new AudioAttributes.Builder()
355 .setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION)
356 .setUsage(AudioAttributes.USAGE_NOTIFICATION)
357 .build();
358
359 /**
360 * The {@link AudioAttributes audio attributes} to use when playing the sound.
361 */
362 public AudioAttributes audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
363
364 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500365 * The pattern with which to vibrate.
366 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800367 * <p>
368 * To vibrate the default pattern, see {@link #defaults}.
369 * </p>
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500370 *
Chris Wren47c20a12014-06-18 17:27:29 -0400371 * <p>
372 * A notification that vibrates is more likely to be presented as a heads-up notification.
373 * </p>
374 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800375 * @see android.os.Vibrator#vibrate(long[],int)
376 */
377 public long[] vibrate;
378
379 /**
380 * The color of the led. The hardware will do its best approximation.
381 *
382 * @see #FLAG_SHOW_LIGHTS
383 * @see #flags
384 */
Tor Norbye80756e32015-03-02 09:39:27 -0800385 @ColorInt
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800386 public int ledARGB;
387
388 /**
389 * The number of milliseconds for the LED to be on while it's flashing.
390 * The hardware will do its best approximation.
391 *
392 * @see #FLAG_SHOW_LIGHTS
393 * @see #flags
394 */
395 public int ledOnMS;
396
397 /**
398 * The number of milliseconds for the LED to be off 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 ledOffMS;
405
406 /**
407 * Specifies which values should be taken from the defaults.
408 * <p>
409 * To set, OR the desired from {@link #DEFAULT_SOUND},
410 * {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}. For all default
411 * values, use {@link #DEFAULT_ALL}.
412 * </p>
413 */
414 public int defaults;
415
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800416 /**
417 * Bit to be bitwise-ored into the {@link #flags} field that should be
418 * set if you want the LED on for this notification.
419 * <ul>
420 * <li>To turn the LED off, pass 0 in the alpha channel for colorARGB
421 * or 0 for both ledOnMS and ledOffMS.</li>
422 * <li>To turn the LED on, pass 1 for ledOnMS and 0 for ledOffMS.</li>
423 * <li>To flash the LED, pass the number of milliseconds that it should
424 * be on and off to ledOnMS and ledOffMS.</li>
425 * </ul>
426 * <p>
427 * Since hardware varies, you are not guaranteed that any of the values
428 * you pass are honored exactly. Use the system defaults (TODO) if possible
429 * because they will be set to values that work on any given hardware.
430 * <p>
431 * The alpha channel must be set for forward compatibility.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500432 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800433 */
434 public static final int FLAG_SHOW_LIGHTS = 0x00000001;
435
436 /**
437 * Bit to be bitwise-ored into the {@link #flags} field that should be
438 * set if this notification is in reference to something that is ongoing,
439 * like a phone call. It should not be set if this notification is in
440 * reference to something that happened at a particular point in time,
441 * like a missed phone call.
442 */
443 public static final int FLAG_ONGOING_EVENT = 0x00000002;
444
445 /**
446 * Bit to be bitwise-ored into the {@link #flags} field that if set,
Scott Mainb8b36452009-04-26 15:50:49 -0700447 * the audio will be repeated until the notification is
448 * cancelled or the notification window is opened.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800449 */
450 public static final int FLAG_INSISTENT = 0x00000004;
451
452 /**
453 * Bit to be bitwise-ored into the {@link #flags} field that should be
Griff Hazen293977b2014-04-28 08:37:20 -0700454 * set if you would only like the sound, vibrate and ticker to be played
455 * if the notification was not already showing.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800456 */
457 public static final int FLAG_ONLY_ALERT_ONCE = 0x00000008;
458
459 /**
460 * Bit to be bitwise-ored into the {@link #flags} field that should be
461 * set if the notification should be canceled when it is clicked by the
Daniel Sandler8aa9ae62012-12-04 23:31:47 -0500462 * user.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800463 */
464 public static final int FLAG_AUTO_CANCEL = 0x00000010;
465
466 /**
467 * Bit to be bitwise-ored into the {@link #flags} field that should be
468 * set if the notification should not be canceled when the user clicks
469 * the Clear all button.
470 */
471 public static final int FLAG_NO_CLEAR = 0x00000020;
472
Dianne Hackbornd8a43f62009-08-17 23:33:56 -0700473 /**
474 * Bit to be bitwise-ored into the {@link #flags} field that should be
475 * set if this notification represents a currently running service. This
476 * will normally be set for you by {@link Service#startForeground}.
477 */
478 public static final int FLAG_FOREGROUND_SERVICE = 0x00000040;
479
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400480 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500481 * Obsolete flag indicating high-priority notifications; use the priority field instead.
Joe Malin8d40d042012-11-05 11:36:40 -0800482 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500483 * @deprecated Use {@link #priority} with a positive value.
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400484 */
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500485 public static final int FLAG_HIGH_PRIORITY = 0x00000080;
Daniel Sandlere46cbd32010-06-17 10:35:26 -0400486
Griff Hazendfcb0802014-02-11 12:00:00 -0800487 /**
488 * Bit to be bitswise-ored into the {@link #flags} field that should be
489 * set if this notification is relevant to the current device only
490 * and it is not recommended that it bridge to other devices.
491 */
492 public static final int FLAG_LOCAL_ONLY = 0x00000100;
493
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700494 /**
495 * Bit to be bitswise-ored into the {@link #flags} field that should be
496 * set if this notification is the group summary for a group of notifications.
497 * Grouped notifications may display in a cluster or stack on devices which
498 * support such rendering. Requires a group key also be set using {@link Builder#setGroup}.
499 */
500 public static final int FLAG_GROUP_SUMMARY = 0x00000200;
501
Julia Reynoldse46bb372016-03-17 11:05:58 -0400502 /**
503 * Bit to be bitswise-ored into the {@link #flags} field that should be
504 * set if this notification is the group summary for an auto-group of notifications.
505 *
506 * @hide
507 */
508 @SystemApi
509 public static final int FLAG_AUTOGROUP_SUMMARY = 0x00000400;
510
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800511 public int flags;
512
Tor Norbyed9273d62013-05-30 15:59:53 -0700513 /** @hide */
514 @IntDef({PRIORITY_DEFAULT,PRIORITY_LOW,PRIORITY_MIN,PRIORITY_HIGH,PRIORITY_MAX})
515 @Retention(RetentionPolicy.SOURCE)
516 public @interface Priority {}
517
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500519 * Default notification {@link #priority}. If your application does not prioritize its own
520 * notifications, use this value for all notifications.
521 */
522 public static final int PRIORITY_DEFAULT = 0;
523
524 /**
525 * Lower {@link #priority}, for items that are less important. The UI may choose to show these
526 * items smaller, or at a different position in the list, compared with your app's
527 * {@link #PRIORITY_DEFAULT} items.
528 */
529 public static final int PRIORITY_LOW = -1;
530
531 /**
532 * Lowest {@link #priority}; these items might not be shown to the user except under special
533 * circumstances, such as detailed notification logs.
534 */
535 public static final int PRIORITY_MIN = -2;
536
537 /**
538 * Higher {@link #priority}, for more important notifications or alerts. The UI may choose to
539 * show these items larger, or at a different position in notification lists, compared with
540 * your app's {@link #PRIORITY_DEFAULT} items.
541 */
542 public static final int PRIORITY_HIGH = 1;
543
544 /**
545 * Highest {@link #priority}, for your application's most important items that require the
546 * user's prompt attention or input.
547 */
548 public static final int PRIORITY_MAX = 2;
549
550 /**
551 * Relative priority for this notification.
Joe Malin8d40d042012-11-05 11:36:40 -0800552 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500553 * Priority is an indication of how much of the user's valuable attention should be consumed by
554 * this notification. Low-priority notifications may be hidden from the user in certain
555 * situations, while the user might be interrupted for a higher-priority notification. The
Daniel Sandler6738eee2012-11-16 12:03:32 -0500556 * system will make a determination about how to interpret this priority when presenting
557 * the notification.
Chris Wren47c20a12014-06-18 17:27:29 -0400558 *
559 * <p>
560 * A notification that is at least {@link #PRIORITY_HIGH} is more likely to be presented
561 * as a heads-up notification.
562 * </p>
563 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500564 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700565 @Priority
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500566 public int priority;
Joe Malin8d40d042012-11-05 11:36:40 -0800567
Dan Sandler26e81cf2014-05-06 10:01:27 -0400568 /**
569 * Accent color (an ARGB integer like the constants in {@link android.graphics.Color})
570 * to be applied by the standard Style templates when presenting this notification.
571 *
572 * The current template design constructs a colorful header image by overlaying the
573 * {@link #icon} image (stenciled in white) atop a field of this color. Alpha components are
574 * ignored.
575 */
Tor Norbye80756e32015-03-02 09:39:27 -0800576 @ColorInt
Dan Sandler26e81cf2014-05-06 10:01:27 -0400577 public int color = COLOR_DEFAULT;
578
579 /**
580 * Special value of {@link #color} telling the system not to decorate this notification with
581 * any special color but instead use default colors when presenting this notification.
582 */
Tor Norbye80756e32015-03-02 09:39:27 -0800583 @ColorInt
Dan Sandler26e81cf2014-05-06 10:01:27 -0400584 public static final int COLOR_DEFAULT = 0; // AKA Color.TRANSPARENT
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600585
586 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -0800587 * Special value of {@link #color} used as a place holder for an invalid color.
588 */
589 @ColorInt
590 private static final int COLOR_INVALID = 1;
591
592 /**
Adrian Roosc1a80b02016-04-05 14:54:55 -0700593 * Sphere of visibility of this notification, which affects how and when the SystemUI reveals
594 * the notification's presence and contents in untrusted situations (namely, on the secure
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600595 * lockscreen).
596 *
597 * The default level, {@link #VISIBILITY_PRIVATE}, behaves exactly as notifications have always
598 * done on Android: The notification's {@link #icon} and {@link #tickerText} (if available) are
599 * shown in all situations, but the contents are only available if the device is unlocked for
600 * the appropriate user.
601 *
602 * A more permissive policy can be expressed by {@link #VISIBILITY_PUBLIC}; such a notification
603 * can be read even in an "insecure" context (that is, above a secure lockscreen).
604 * To modify the public version of this notification—for example, to redact some portions—see
605 * {@link Builder#setPublicVersion(Notification)}.
606 *
607 * Finally, a notification can be made {@link #VISIBILITY_SECRET}, which will suppress its icon
608 * and ticker until the user has bypassed the lockscreen.
609 */
610 public int visibility;
611
Griff Hazenfc3922d2014-08-20 11:56:44 -0700612 /**
613 * Notification visibility: Show this notification in its entirety on all lockscreens.
614 *
615 * {@see #visibility}
616 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600617 public static final int VISIBILITY_PUBLIC = 1;
Griff Hazenfc3922d2014-08-20 11:56:44 -0700618
619 /**
620 * Notification visibility: Show this notification on all lockscreens, but conceal sensitive or
621 * private information on secure lockscreens.
622 *
623 * {@see #visibility}
624 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600625 public static final int VISIBILITY_PRIVATE = 0;
Griff Hazenfc3922d2014-08-20 11:56:44 -0700626
627 /**
628 * Notification visibility: Do not reveal any part of this notification on a secure lockscreen.
629 *
630 * {@see #visibility}
631 */
Dan Sandler0bf2ed82013-12-21 23:33:41 -0600632 public static final int VISIBILITY_SECRET = -1;
633
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500634 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400635 * Notification category: incoming call (voice or video) or similar synchronous communication request.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500636 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400637 public static final String CATEGORY_CALL = "call";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500638
639 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400640 * Notification category: incoming direct message (SMS, instant message, etc.).
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500641 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400642 public static final String CATEGORY_MESSAGE = "msg";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500643
644 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400645 * Notification category: asynchronous bulk message (email).
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500646 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400647 public static final String CATEGORY_EMAIL = "email";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500648
649 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400650 * Notification category: calendar event.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500651 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400652 public static final String CATEGORY_EVENT = "event";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500653
654 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400655 * Notification category: promotion or advertisement.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500656 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400657 public static final String CATEGORY_PROMO = "promo";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500658
659 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400660 * Notification category: alarm or timer.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500661 */
John Spurlockfd7f1e02014-03-18 16:41:57 -0400662 public static final String CATEGORY_ALARM = "alarm";
663
664 /**
665 * Notification category: progress of a long-running background operation.
666 */
667 public static final String CATEGORY_PROGRESS = "progress";
668
669 /**
670 * Notification category: social network or sharing update.
671 */
672 public static final String CATEGORY_SOCIAL = "social";
673
674 /**
675 * Notification category: error in background operation or authentication status.
676 */
677 public static final String CATEGORY_ERROR = "err";
678
679 /**
680 * Notification category: media transport control for playback.
681 */
682 public static final String CATEGORY_TRANSPORT = "transport";
683
684 /**
685 * Notification category: system or device status update. Reserved for system use.
686 */
687 public static final String CATEGORY_SYSTEM = "sys";
688
689 /**
690 * Notification category: indication of running background service.
691 */
692 public static final String CATEGORY_SERVICE = "service";
693
694 /**
John Spurlock0a69c8c2014-03-21 13:30:57 -0400695 * Notification category: a specific, timely recommendation for a single thing.
696 * For example, a news app might want to recommend a news story it believes the user will
697 * want to read next.
698 */
699 public static final String CATEGORY_RECOMMENDATION = "recommendation";
700
701 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400702 * Notification category: ongoing information about device or contextual status.
703 */
704 public static final String CATEGORY_STATUS = "status";
705
706 /**
John Spurlock24d3dad2015-04-02 12:24:02 -0400707 * Notification category: user-scheduled reminder.
708 */
709 public static final String CATEGORY_REMINDER = "reminder";
710
711 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400712 * One of the predefined notification categories (see the <code>CATEGORY_*</code> constants)
713 * that best describes this Notification. May be used by the system for ranking and filtering.
714 */
715 public String category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500716
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700717 private String mGroupKey;
718
719 /**
720 * Get the key used to group this notification into a cluster or stack
721 * with other notifications on devices which support such rendering.
722 */
723 public String getGroup() {
724 return mGroupKey;
725 }
726
727 private String mSortKey;
728
729 /**
730 * Get a sort key that orders this notification among other notifications from the
731 * same package. This can be useful if an external sort was already applied and an app
732 * would like to preserve this. Notifications will be sorted lexicographically using this
733 * value, although providing different priorities in addition to providing sort key may
734 * cause this value to be ignored.
735 *
736 * <p>This sort key can also be used to order members of a notification group. See
737 * {@link Builder#setGroup}.
738 *
739 * @see String#compareTo(String)
740 */
741 public String getSortKey() {
742 return mSortKey;
743 }
744
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500745 /**
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400746 * Additional semantic data to be carried around with this Notification.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400747 * <p>
748 * The extras keys defined here are intended to capture the original inputs to {@link Builder}
749 * APIs, and are intended to be used by
750 * {@link android.service.notification.NotificationListenerService} implementations to extract
751 * detailed information from notification objects.
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500752 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400753 public Bundle extras = new Bundle();
754
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400755 /**
756 * {@link #extras} key: this is the title of the notification,
757 * as supplied to {@link Builder#setContentTitle(CharSequence)}.
758 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500759 public static final String EXTRA_TITLE = "android.title";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400760
761 /**
762 * {@link #extras} key: this is the title of the notification when shown in expanded form,
763 * e.g. as supplied to {@link BigTextStyle#setBigContentTitle(CharSequence)}.
764 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400765 public static final String EXTRA_TITLE_BIG = EXTRA_TITLE + ".big";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400766
767 /**
768 * {@link #extras} key: this is the main text payload, as supplied to
769 * {@link Builder#setContentText(CharSequence)}.
770 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500771 public static final String EXTRA_TEXT = "android.text";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400772
773 /**
774 * {@link #extras} key: this is a third line of text, as supplied to
775 * {@link Builder#setSubText(CharSequence)}.
776 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400777 public static final String EXTRA_SUB_TEXT = "android.subText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400778
779 /**
Adrian Roose458aa82015-12-08 16:17:19 -0800780 * {@link #extras} key: this is the remote input history, as supplied to
781 * {@link Builder#setRemoteInputHistory(CharSequence[])}.
782 */
783 public static final String EXTRA_REMOTE_INPUT_HISTORY = "android.remoteInputHistory";
784
785 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400786 * {@link #extras} key: this is a small piece of additional text as supplied to
787 * {@link Builder#setContentInfo(CharSequence)}.
788 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400789 public static final String EXTRA_INFO_TEXT = "android.infoText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400790
791 /**
792 * {@link #extras} key: this is a line of summary information intended to be shown
793 * alongside expanded notifications, as supplied to (e.g.)
794 * {@link BigTextStyle#setSummaryText(CharSequence)}.
795 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400796 public static final String EXTRA_SUMMARY_TEXT = "android.summaryText";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400797
798 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +0200799 * {@link #extras} key: this is the longer text shown in the big form of a
800 * {@link BigTextStyle} notification, as supplied to
801 * {@link BigTextStyle#bigText(CharSequence)}.
802 */
803 public static final String EXTRA_BIG_TEXT = "android.bigText";
804
805 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400806 * {@link #extras} key: this is the resource ID of the notification's main small icon, as
807 * supplied to {@link Builder#setSmallIcon(int)}.
808 */
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -0500809 public static final String EXTRA_SMALL_ICON = "android.icon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400810
811 /**
812 * {@link #extras} key: this is a bitmap to be used instead of the small icon when showing the
813 * notification payload, as
814 * supplied to {@link Builder#setLargeIcon(android.graphics.Bitmap)}.
815 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400816 public static final String EXTRA_LARGE_ICON = "android.largeIcon";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400817
818 /**
819 * {@link #extras} key: this is a bitmap to be used instead of the one from
820 * {@link Builder#setLargeIcon(android.graphics.Bitmap)} when the notification is
821 * shown in its expanded form, as supplied to
822 * {@link BigPictureStyle#bigLargeIcon(android.graphics.Bitmap)}.
823 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400824 public static final String EXTRA_LARGE_ICON_BIG = EXTRA_LARGE_ICON + ".big";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400825
826 /**
827 * {@link #extras} key: this is the progress value supplied to
828 * {@link Builder#setProgress(int, int, boolean)}.
829 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400830 public static final String EXTRA_PROGRESS = "android.progress";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400831
832 /**
833 * {@link #extras} key: this is the maximum value supplied to
834 * {@link Builder#setProgress(int, int, boolean)}.
835 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400836 public static final String EXTRA_PROGRESS_MAX = "android.progressMax";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400837
838 /**
839 * {@link #extras} key: whether the progress bar is indeterminate, supplied to
840 * {@link Builder#setProgress(int, int, boolean)}.
841 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400842 public static final String EXTRA_PROGRESS_INDETERMINATE = "android.progressIndeterminate";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400843
844 /**
845 * {@link #extras} key: whether {@link #when} should be shown as a count-up timer (specifically
846 * a {@link android.widget.Chronometer}) instead of a timestamp, as supplied to
847 * {@link Builder#setUsesChronometer(boolean)}.
848 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400849 public static final String EXTRA_SHOW_CHRONOMETER = "android.showChronometer";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400850
851 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -0800852 * {@link #extras} key: whether the chronometer set on the notification should count down
853 * instead of counting up. Is only relevant if key {@link #EXTRA_SHOW_CHRONOMETER} is present.
854 */
855 public static final String EXTRA_CHRONOMETER_COUNTS_DOWN = "android.chronometerCountsDown";
856
857 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400858 * {@link #extras} key: whether {@link #when} should be shown,
859 * as supplied to {@link Builder#setShowWhen(boolean)}.
860 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400861 public static final String EXTRA_SHOW_WHEN = "android.showWhen";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400862
863 /**
864 * {@link #extras} key: this is a bitmap to be shown in {@link BigPictureStyle} expanded
865 * notifications, supplied to {@link BigPictureStyle#bigPicture(android.graphics.Bitmap)}.
866 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400867 public static final String EXTRA_PICTURE = "android.picture";
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400868
869 /**
870 * {@link #extras} key: An array of CharSequences to show in {@link InboxStyle} expanded
871 * notifications, each of which was supplied to {@link InboxStyle#addLine(CharSequence)}.
872 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400873 public static final String EXTRA_TEXT_LINES = "android.textLines";
Dan Sandler842dd772014-05-15 09:36:47 -0400874
875 /**
876 * {@link #extras} key: A string representing the name of the specific
877 * {@link android.app.Notification.Style} used to create this notification.
878 */
Chris Wren91ad5632013-06-05 15:05:57 -0400879 public static final String EXTRA_TEMPLATE = "android.template";
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400880
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400881 /**
Chris Wrene6c48932014-09-29 17:19:27 -0400882 * {@link #extras} key: A String array containing the people that this notification relates to,
883 * each of which was supplied to {@link Builder#addPerson(String)}.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400884 */
Daniel Sandlerf45564e2013-04-15 15:05:08 -0400885 public static final String EXTRA_PEOPLE = "android.people";
Daniel Sandler2561b0b2012-02-13 21:04:12 -0500886
887 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -0400888 * Allow certain system-generated notifications to appear before the device is provisioned.
889 * Only available to notifications coming from the android package.
890 * @hide
891 */
892 public static final String EXTRA_ALLOW_DURING_SETUP = "android.allowDuringSetup";
893
894 /**
Jose Limae9e3b3b2014-05-18 23:44:50 -0700895 * {@link #extras} key: A
896 * {@link android.content.ContentUris content URI} pointing to an image that can be displayed
897 * in the background when the notification is selected. The URI must point to an image stream
898 * suitable for passing into
899 * {@link android.graphics.BitmapFactory#decodeStream(java.io.InputStream)
900 * BitmapFactory.decodeStream}; all other content types will be ignored. The content provider
901 * URI used for this purpose must require no permissions to read the image data.
902 */
903 public static final String EXTRA_BACKGROUND_IMAGE_URI = "android.backgroundImageUri";
904
905 /**
Dan Sandler842dd772014-05-15 09:36:47 -0400906 * {@link #extras} key: A
Jeff Browndba34ba2014-06-24 20:46:03 -0700907 * {@link android.media.session.MediaSession.Token} associated with a
Dan Sandler842dd772014-05-15 09:36:47 -0400908 * {@link android.app.Notification.MediaStyle} notification.
909 */
910 public static final String EXTRA_MEDIA_SESSION = "android.mediaSession";
911
912 /**
Bryan Mawhinneye191f902014-07-22 12:50:09 +0100913 * {@link #extras} key: the indices of actions to be shown in the compact view,
914 * as supplied to (e.g.) {@link MediaStyle#setShowActionsInCompactView(int...)}.
915 */
916 public static final String EXTRA_COMPACT_ACTIONS = "android.compactActions";
917
Christoph Studer943aa672014-08-03 20:31:16 +0200918 /**
Alex Hillsfc737de2016-03-23 17:33:02 -0400919 * {@link #extras} key: the username to be displayed for all messages sent by the user including
920 * direct replies
921 * {@link android.app.Notification.MessagingStyle} notification.
922 */
923 public static final String EXTRA_SELF_DISPLAY_NAME = "android.selfDisplayName";
924
925 /**
926 * {@link #extras} key: a boolean describing whether the platform should automatically
927 * generate possible replies to
928 * {@link android.app.Notification.MessagingStyle.Message} objects provided by a
929 * {@link android.app.Notification.MessagingStyle} notification.
930 */
931 public static final String EXTRA_ALLOW_GENERATED_REPLIES = "android.allowGeneratedReplies";
932
933 /**
934 * {@link #extras} key: a {@link String} to be displayed as the title to a thread represented by
935 * a {@link android.app.Notification.MessagingStyle}
936 */
937 public static final String EXTRA_THREAD_TITLE = "android.threadTitle";
938
939 /**
940 * {@link #extras} key: an array of {@link android.app.Notification.MessagingStyle.Message}
941 * bundles provided by a
942 * {@link android.app.Notification.MessagingStyle} notification.
943 */
944 public static final String EXTRA_MESSAGES = "android.messages";
945
946 /**
Kenny Guy8942bcd2014-09-08 21:09:47 +0100947 * {@link #extras} key: the user that built the notification.
948 *
949 * @hide
950 */
951 public static final String EXTRA_ORIGINATING_USERID = "android.originatingUserId";
952
953 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -0400954 * @hide
955 */
956 public static final String EXTRA_BUILDER_APPLICATION_INFO = "android.appInfo";
957
Selim Cinek247fa012016-02-18 09:50:48 -0800958 /**
959 * @hide
960 */
961 public static final String EXTRA_CONTAINS_CUSTOM_VIEW = "android.contains.customView";
962
Dan Sandlerd63f9322015-05-06 15:18:49 -0400963 private Icon mSmallIcon;
964 private Icon mLargeIcon;
965
Chris Wren51c75102013-07-16 20:49:17 -0400966 /**
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400967 * Structure to encapsulate a named action that can be shown as part of this notification.
968 * It must include an icon, a label, and a {@link PendingIntent} to be fired when the action is
969 * selected by the user.
970 * <p>
Griff Hazen959591e2014-05-15 22:26:18 -0700971 * Apps should use {@link Notification.Builder#addAction(int, CharSequence, PendingIntent)}
972 * or {@link Notification.Builder#addAction(Notification.Action)}
973 * to attach actions.
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400974 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -0500975 public static class Action implements Parcelable {
Griff Hazen959591e2014-05-15 22:26:18 -0700976 private final Bundle mExtras;
Dan Sandler86647982015-05-13 23:41:13 -0400977 private Icon mIcon;
Griff Hazen61a9e862014-05-22 16:05:19 -0700978 private final RemoteInput[] mRemoteInputs;
Griff Hazen959591e2014-05-15 22:26:18 -0700979
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400980 /**
981 * Small icon representing the action.
Dan Sandler86647982015-05-13 23:41:13 -0400982 *
983 * @deprecated Use {@link Action#getIcon()} instead.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400984 */
Dan Sandler86647982015-05-13 23:41:13 -0400985 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400986 public int icon;
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700987
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400988 /**
989 * Title of the action.
990 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400991 public CharSequence title;
Griff Hazen5cadc3b2014-05-20 09:55:39 -0700992
Daniel Sandlercf1d39b2013-09-23 13:35:35 -0400993 /**
994 * Intent to send when the user invokes this action. May be null, in which case the action
995 * may be rendered in a disabled presentation by the system UI.
996 */
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400997 public PendingIntent actionIntent;
Griff Hazen959591e2014-05-15 22:26:18 -0700998
Daniel Sandlera0a938c2012-03-15 08:42:37 -0400999 private Action(Parcel in) {
Dan Sandler86647982015-05-13 23:41:13 -04001000 if (in.readInt() != 0) {
1001 mIcon = Icon.CREATOR.createFromParcel(in);
Dan Sandler68079d52015-07-22 10:45:30 -04001002 if (mIcon.getType() == Icon.TYPE_RESOURCE) {
1003 icon = mIcon.getResId();
1004 }
Dan Sandler86647982015-05-13 23:41:13 -04001005 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001006 title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
1007 if (in.readInt() == 1) {
1008 actionIntent = PendingIntent.CREATOR.createFromParcel(in);
1009 }
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06001010 mExtras = Bundle.setDefusable(in.readBundle(), true);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001011 mRemoteInputs = in.createTypedArray(RemoteInput.CREATOR);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001012 }
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001013
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001014 /**
Dan Sandler86647982015-05-13 23:41:13 -04001015 * @deprecated Use {@link android.app.Notification.Action.Builder}.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001016 */
Dan Sandler86647982015-05-13 23:41:13 -04001017 @Deprecated
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001018 public Action(int icon, CharSequence title, PendingIntent intent) {
Dan Sandler86647982015-05-13 23:41:13 -04001019 this(Icon.createWithResource("", icon), title, intent, new Bundle(), null);
Griff Hazen959591e2014-05-15 22:26:18 -07001020 }
1021
Dan Sandler86647982015-05-13 23:41:13 -04001022 private Action(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001023 RemoteInput[] remoteInputs) {
Dan Sandler86647982015-05-13 23:41:13 -04001024 this.mIcon = icon;
Gus Prevasf5bff46f2015-08-24 10:34:28 -04001025 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
1026 this.icon = icon.getResId();
1027 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001028 this.title = title;
1029 this.actionIntent = intent;
Griff Hazen959591e2014-05-15 22:26:18 -07001030 this.mExtras = extras != null ? extras : new Bundle();
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001031 this.mRemoteInputs = remoteInputs;
Griff Hazen959591e2014-05-15 22:26:18 -07001032 }
1033
1034 /**
Dan Sandler86647982015-05-13 23:41:13 -04001035 * Return an icon representing the action.
1036 */
1037 public Icon getIcon() {
1038 if (mIcon == null && icon != 0) {
1039 // you snuck an icon in here without using the builder; let's try to keep it
1040 mIcon = Icon.createWithResource("", icon);
1041 }
1042 return mIcon;
1043 }
1044
1045 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001046 * Get additional metadata carried around with this Action.
1047 */
1048 public Bundle getExtras() {
1049 return mExtras;
1050 }
1051
1052 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001053 * Get the list of inputs to be collected from the user when this action is sent.
1054 * May return null if no remote inputs were added.
1055 */
1056 public RemoteInput[] getRemoteInputs() {
1057 return mRemoteInputs;
1058 }
1059
1060 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001061 * Builder class for {@link Action} objects.
1062 */
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001063 public static final class Builder {
Dan Sandler86647982015-05-13 23:41:13 -04001064 private final Icon mIcon;
Griff Hazen959591e2014-05-15 22:26:18 -07001065 private final CharSequence mTitle;
1066 private final PendingIntent mIntent;
1067 private final Bundle mExtras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001068 private ArrayList<RemoteInput> mRemoteInputs;
Griff Hazen959591e2014-05-15 22:26:18 -07001069
1070 /**
1071 * Construct a new builder for {@link Action} object.
1072 * @param icon icon to show for this action
1073 * @param title the title of the action
1074 * @param intent the {@link PendingIntent} to fire when users trigger this action
1075 */
Dan Sandler86647982015-05-13 23:41:13 -04001076 @Deprecated
Griff Hazen959591e2014-05-15 22:26:18 -07001077 public Builder(int icon, CharSequence title, PendingIntent intent) {
Dan Sandler86647982015-05-13 23:41:13 -04001078 this(Icon.createWithResource("", icon), title, intent, new Bundle(), null);
1079 }
1080
1081 /**
1082 * Construct a new builder for {@link Action} object.
1083 * @param icon icon to show for this action
1084 * @param title the title of the action
1085 * @param intent the {@link PendingIntent} to fire when users trigger this action
1086 */
1087 public Builder(Icon icon, CharSequence title, PendingIntent intent) {
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001088 this(icon, title, intent, new Bundle(), null);
Griff Hazen959591e2014-05-15 22:26:18 -07001089 }
1090
1091 /**
1092 * Construct a new builder for {@link Action} object using the fields from an
1093 * {@link Action}.
1094 * @param action the action to read fields from.
1095 */
1096 public Builder(Action action) {
Dan Sandler86647982015-05-13 23:41:13 -04001097 this(action.getIcon(), action.title, action.actionIntent, new Bundle(action.mExtras),
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001098 action.getRemoteInputs());
Griff Hazen959591e2014-05-15 22:26:18 -07001099 }
1100
Dan Sandler86647982015-05-13 23:41:13 -04001101 private Builder(Icon icon, CharSequence title, PendingIntent intent, Bundle extras,
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001102 RemoteInput[] remoteInputs) {
Griff Hazen959591e2014-05-15 22:26:18 -07001103 mIcon = icon;
1104 mTitle = title;
1105 mIntent = intent;
1106 mExtras = extras;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001107 if (remoteInputs != null) {
1108 mRemoteInputs = new ArrayList<RemoteInput>(remoteInputs.length);
1109 Collections.addAll(mRemoteInputs, remoteInputs);
1110 }
Griff Hazen959591e2014-05-15 22:26:18 -07001111 }
1112
1113 /**
1114 * Merge additional metadata into this builder.
1115 *
1116 * <p>Values within the Bundle will replace existing extras values in this Builder.
1117 *
1118 * @see Notification.Action#extras
1119 */
1120 public Builder addExtras(Bundle extras) {
1121 if (extras != null) {
1122 mExtras.putAll(extras);
1123 }
1124 return this;
1125 }
1126
1127 /**
1128 * Get the metadata Bundle used by this Builder.
1129 *
1130 * <p>The returned Bundle is shared with this Builder.
1131 */
1132 public Bundle getExtras() {
1133 return mExtras;
1134 }
1135
1136 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001137 * Add an input to be collected from the user when this action is sent.
1138 * Response values can be retrieved from the fired intent by using the
1139 * {@link RemoteInput#getResultsFromIntent} function.
1140 * @param remoteInput a {@link RemoteInput} to add to the action
1141 * @return this object for method chaining
1142 */
1143 public Builder addRemoteInput(RemoteInput remoteInput) {
1144 if (mRemoteInputs == null) {
1145 mRemoteInputs = new ArrayList<RemoteInput>();
1146 }
1147 mRemoteInputs.add(remoteInput);
1148 return this;
1149 }
1150
1151 /**
1152 * Apply an extender to this action builder. Extenders may be used to add
1153 * metadata or change options on this builder.
1154 */
Griff Hazen61a9e862014-05-22 16:05:19 -07001155 public Builder extend(Extender extender) {
1156 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001157 return this;
1158 }
1159
1160 /**
Griff Hazen959591e2014-05-15 22:26:18 -07001161 * Combine all of the options that have been set and return a new {@link Action}
1162 * object.
1163 * @return the built action
1164 */
1165 public Action build() {
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001166 RemoteInput[] remoteInputs = mRemoteInputs != null
1167 ? mRemoteInputs.toArray(new RemoteInput[mRemoteInputs.size()]) : null;
1168 return new Action(mIcon, mTitle, mIntent, mExtras, remoteInputs);
Griff Hazen959591e2014-05-15 22:26:18 -07001169 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001170 }
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001171
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001172 @Override
1173 public Action clone() {
1174 return new Action(
Dan Sandler86647982015-05-13 23:41:13 -04001175 getIcon(),
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001176 title,
1177 actionIntent, // safe to alias
1178 new Bundle(mExtras),
1179 getRemoteInputs());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001180 }
1181 @Override
1182 public int describeContents() {
1183 return 0;
1184 }
1185 @Override
1186 public void writeToParcel(Parcel out, int flags) {
Dan Sandler86647982015-05-13 23:41:13 -04001187 final Icon ic = getIcon();
1188 if (ic != null) {
1189 out.writeInt(1);
1190 ic.writeToParcel(out, 0);
1191 } else {
1192 out.writeInt(0);
1193 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001194 TextUtils.writeToParcel(title, out, flags);
1195 if (actionIntent != null) {
1196 out.writeInt(1);
1197 actionIntent.writeToParcel(out, flags);
1198 } else {
1199 out.writeInt(0);
1200 }
Griff Hazen959591e2014-05-15 22:26:18 -07001201 out.writeBundle(mExtras);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001202 out.writeTypedArray(mRemoteInputs, flags);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001203 }
Griff Hazen959591e2014-05-15 22:26:18 -07001204 public static final Parcelable.Creator<Action> CREATOR =
1205 new Parcelable.Creator<Action>() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001206 public Action createFromParcel(Parcel in) {
1207 return new Action(in);
1208 }
1209 public Action[] newArray(int size) {
1210 return new Action[size];
1211 }
1212 };
Griff Hazen61a9e862014-05-22 16:05:19 -07001213
1214 /**
1215 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
1216 * metadata or change options on an action builder.
1217 */
1218 public interface Extender {
1219 /**
1220 * Apply this extender to a notification action builder.
1221 * @param builder the builder to be modified.
1222 * @return the build object for chaining.
1223 */
1224 public Builder extend(Builder builder);
1225 }
1226
1227 /**
1228 * Wearable extender for notification actions. To add extensions to an action,
1229 * create a new {@link android.app.Notification.Action.WearableExtender} object using
1230 * the {@code WearableExtender()} constructor and apply it to a
1231 * {@link android.app.Notification.Action.Builder} using
1232 * {@link android.app.Notification.Action.Builder#extend}.
1233 *
1234 * <pre class="prettyprint">
1235 * Notification.Action action = new Notification.Action.Builder(
1236 * R.drawable.archive_all, "Archive all", actionIntent)
Griff Hazen14f57992014-05-26 09:07:14 -07001237 * .extend(new Notification.Action.WearableExtender()
Griff Hazen61a9e862014-05-22 16:05:19 -07001238 * .setAvailableOffline(false))
Griff Hazen14f57992014-05-26 09:07:14 -07001239 * .build();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07001240 */
1241 public static final class WearableExtender implements Extender {
1242 /** Notification action extra which contains wearable extensions */
1243 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
1244
Pete Gastaf6781d2014-10-07 15:17:05 -04001245 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07001246 private static final String KEY_FLAGS = "flags";
Pete Gastaf6781d2014-10-07 15:17:05 -04001247 private static final String KEY_IN_PROGRESS_LABEL = "inProgressLabel";
1248 private static final String KEY_CONFIRM_LABEL = "confirmLabel";
1249 private static final String KEY_CANCEL_LABEL = "cancelLabel";
Griff Hazen61a9e862014-05-22 16:05:19 -07001250
1251 // Flags bitwise-ored to mFlags
1252 private static final int FLAG_AVAILABLE_OFFLINE = 0x1;
Alex Hills9ab3a232016-04-05 14:54:56 -04001253 private static final int FLAG_HINT_LAUNCHES_ACTIVITY = 1 << 1;
Griff Hazen61a9e862014-05-22 16:05:19 -07001254
1255 // Default value for flags integer
1256 private static final int DEFAULT_FLAGS = FLAG_AVAILABLE_OFFLINE;
1257
1258 private int mFlags = DEFAULT_FLAGS;
1259
Pete Gastaf6781d2014-10-07 15:17:05 -04001260 private CharSequence mInProgressLabel;
1261 private CharSequence mConfirmLabel;
1262 private CharSequence mCancelLabel;
1263
Griff Hazen61a9e862014-05-22 16:05:19 -07001264 /**
1265 * Create a {@link android.app.Notification.Action.WearableExtender} with default
1266 * options.
1267 */
1268 public WearableExtender() {
1269 }
1270
1271 /**
1272 * Create a {@link android.app.Notification.Action.WearableExtender} by reading
1273 * wearable options present in an existing notification action.
1274 * @param action the notification action to inspect.
1275 */
1276 public WearableExtender(Action action) {
1277 Bundle wearableBundle = action.getExtras().getBundle(EXTRA_WEARABLE_EXTENSIONS);
1278 if (wearableBundle != null) {
1279 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
Pete Gastaf6781d2014-10-07 15:17:05 -04001280 mInProgressLabel = wearableBundle.getCharSequence(KEY_IN_PROGRESS_LABEL);
1281 mConfirmLabel = wearableBundle.getCharSequence(KEY_CONFIRM_LABEL);
1282 mCancelLabel = wearableBundle.getCharSequence(KEY_CANCEL_LABEL);
Griff Hazen61a9e862014-05-22 16:05:19 -07001283 }
1284 }
1285
1286 /**
1287 * Apply wearable extensions to a notification action that is being built. This is
1288 * typically called by the {@link android.app.Notification.Action.Builder#extend}
1289 * method of {@link android.app.Notification.Action.Builder}.
1290 */
1291 @Override
1292 public Action.Builder extend(Action.Builder builder) {
1293 Bundle wearableBundle = new Bundle();
1294
1295 if (mFlags != DEFAULT_FLAGS) {
1296 wearableBundle.putInt(KEY_FLAGS, mFlags);
1297 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001298 if (mInProgressLabel != null) {
1299 wearableBundle.putCharSequence(KEY_IN_PROGRESS_LABEL, mInProgressLabel);
1300 }
1301 if (mConfirmLabel != null) {
1302 wearableBundle.putCharSequence(KEY_CONFIRM_LABEL, mConfirmLabel);
1303 }
1304 if (mCancelLabel != null) {
1305 wearableBundle.putCharSequence(KEY_CANCEL_LABEL, mCancelLabel);
1306 }
Griff Hazen61a9e862014-05-22 16:05:19 -07001307
1308 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
1309 return builder;
1310 }
1311
1312 @Override
1313 public WearableExtender clone() {
1314 WearableExtender that = new WearableExtender();
1315 that.mFlags = this.mFlags;
Pete Gastaf6781d2014-10-07 15:17:05 -04001316 that.mInProgressLabel = this.mInProgressLabel;
1317 that.mConfirmLabel = this.mConfirmLabel;
1318 that.mCancelLabel = this.mCancelLabel;
Griff Hazen61a9e862014-05-22 16:05:19 -07001319 return that;
1320 }
1321
1322 /**
1323 * Set whether this action is available when the wearable device is not connected to
1324 * a companion device. The user can still trigger this action when the wearable device is
1325 * offline, but a visual hint will indicate that the action may not be available.
1326 * Defaults to true.
1327 */
1328 public WearableExtender setAvailableOffline(boolean availableOffline) {
1329 setFlag(FLAG_AVAILABLE_OFFLINE, availableOffline);
1330 return this;
1331 }
1332
1333 /**
1334 * Get whether this action is available when the wearable device is not connected to
1335 * a companion device. The user can still trigger this action when the wearable device is
1336 * offline, but a visual hint will indicate that the action may not be available.
1337 * Defaults to true.
1338 */
1339 public boolean isAvailableOffline() {
1340 return (mFlags & FLAG_AVAILABLE_OFFLINE) != 0;
1341 }
1342
1343 private void setFlag(int mask, boolean value) {
1344 if (value) {
1345 mFlags |= mask;
1346 } else {
1347 mFlags &= ~mask;
1348 }
1349 }
Pete Gastaf6781d2014-10-07 15:17:05 -04001350
1351 /**
1352 * Set a label to display while the wearable is preparing to automatically execute the
1353 * action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1354 *
1355 * @param label the label to display while the action is being prepared to execute
1356 * @return this object for method chaining
1357 */
1358 public WearableExtender setInProgressLabel(CharSequence label) {
1359 mInProgressLabel = label;
1360 return this;
1361 }
1362
1363 /**
1364 * Get the label to display while the wearable is preparing to automatically execute
1365 * the action. This is usually a 'ing' verb ending in ellipsis like "Sending..."
1366 *
1367 * @return the label to display while the action is being prepared to execute
1368 */
1369 public CharSequence getInProgressLabel() {
1370 return mInProgressLabel;
1371 }
1372
1373 /**
1374 * Set a label to display to confirm that the action should be executed.
1375 * This is usually an imperative verb like "Send".
1376 *
1377 * @param label the label to confirm the action should be executed
1378 * @return this object for method chaining
1379 */
1380 public WearableExtender setConfirmLabel(CharSequence label) {
1381 mConfirmLabel = label;
1382 return this;
1383 }
1384
1385 /**
1386 * Get the label to display to confirm that the action should be executed.
1387 * This is usually an imperative verb like "Send".
1388 *
1389 * @return the label to confirm the action should be executed
1390 */
1391 public CharSequence getConfirmLabel() {
1392 return mConfirmLabel;
1393 }
1394
1395 /**
1396 * Set a label to display to cancel the action.
1397 * This is usually an imperative verb, like "Cancel".
1398 *
1399 * @param label the label to display to cancel the action
1400 * @return this object for method chaining
1401 */
1402 public WearableExtender setCancelLabel(CharSequence label) {
1403 mCancelLabel = label;
1404 return this;
1405 }
1406
1407 /**
1408 * Get the label to display to cancel the action.
1409 * This is usually an imperative verb like "Cancel".
1410 *
1411 * @return the label to display to cancel the action
1412 */
1413 public CharSequence getCancelLabel() {
1414 return mCancelLabel;
1415 }
Alex Hills9ab3a232016-04-05 14:54:56 -04001416
1417 /**
1418 * Set a hint that this Action will launch an {@link Activity} directly, telling the
1419 * platform that it can generate the appropriate transitions.
1420 * @param hintLaunchesActivity {@code true} if the content intent will launch
1421 * an activity and transitions should be generated, false otherwise.
1422 * @return this object for method chaining
1423 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001424 public WearableExtender setHintLaunchesActivity(
Alex Hills9ab3a232016-04-05 14:54:56 -04001425 boolean hintLaunchesActivity) {
1426 setFlag(FLAG_HINT_LAUNCHES_ACTIVITY, hintLaunchesActivity);
1427 return this;
1428 }
1429
1430 /**
1431 * Get a hint that this Action will launch an {@link Activity} directly, telling the
1432 * platform that it can generate the appropriate transitions
1433 * @return {@code true} if the content intent will launch an activity and transitions
1434 * should be generated, false otherwise. The default value is {@code false} if this was
1435 * never set.
1436 */
Alex Hills4ec3ff42016-04-12 11:36:18 -04001437 public boolean getHintLaunchesActivity() {
Alex Hills9ab3a232016-04-05 14:54:56 -04001438 return (mFlags & FLAG_HINT_LAUNCHES_ACTIVITY) != 0;
1439 }
Griff Hazen61a9e862014-05-22 16:05:19 -07001440 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001441 }
1442
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04001443 /**
1444 * Array of all {@link Action} structures attached to this notification by
1445 * {@link Builder#addAction(int, CharSequence, PendingIntent)}. Mostly useful for instances of
1446 * {@link android.service.notification.NotificationListenerService} that provide an alternative
1447 * interface for invoking actions.
1448 */
Daniel Sandlerea2a3172013-02-20 22:24:20 -05001449 public Action[] actions;
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001450
1451 /**
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001452 * Replacement version of this notification whose content will be shown
1453 * in an insecure context such as atop a secure keyguard. See {@link #visibility}
1454 * and {@link #VISIBILITY_PUBLIC}.
1455 */
1456 public Notification publicVersion;
1457
1458 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001459 * Constructs a Notification object with default values.
Joe Onorato46439ce2010-11-19 13:56:21 -08001460 * You might want to consider using {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001461 */
1462 public Notification()
1463 {
1464 this.when = System.currentTimeMillis();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001465 this.priority = PRIORITY_DEFAULT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001466 }
1467
1468 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001469 * @hide
1470 */
1471 public Notification(Context context, int icon, CharSequence tickerText, long when,
1472 CharSequence contentTitle, CharSequence contentText, Intent contentIntent)
1473 {
Chris Wren1ce4b6d2015-06-11 10:19:43 -04001474 new Builder(context)
1475 .setWhen(when)
1476 .setSmallIcon(icon)
1477 .setTicker(tickerText)
1478 .setContentTitle(contentTitle)
1479 .setContentText(contentText)
1480 .setContentIntent(PendingIntent.getActivity(context, 0, contentIntent, 0))
1481 .buildInto(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001482 }
1483
1484 /**
1485 * Constructs a Notification object with the information needed to
1486 * have a status bar icon without the standard expanded view.
1487 *
1488 * @param icon The resource id of the icon to put in the status bar.
1489 * @param tickerText The text that flows by in the status bar when the notification first
1490 * activates.
1491 * @param when The time to show in the time field. In the System.currentTimeMillis
1492 * timebase.
Joe Onorato46439ce2010-11-19 13:56:21 -08001493 *
1494 * @deprecated Use {@link Builder} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001495 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001496 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001497 public Notification(int icon, CharSequence tickerText, long when)
1498 {
1499 this.icon = icon;
1500 this.tickerText = tickerText;
1501 this.when = when;
1502 }
1503
1504 /**
1505 * Unflatten the notification from a parcel.
1506 */
1507 public Notification(Parcel parcel)
1508 {
1509 int version = parcel.readInt();
1510
1511 when = parcel.readLong();
Dan Sandler3936e7a2015-05-19 20:59:12 -04001512 if (parcel.readInt() != 0) {
1513 mSmallIcon = Icon.CREATOR.createFromParcel(parcel);
Dan Sandler4e787062015-06-17 15:09:48 -04001514 if (mSmallIcon.getType() == Icon.TYPE_RESOURCE) {
1515 icon = mSmallIcon.getResId();
1516 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04001517 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001518 number = parcel.readInt();
1519 if (parcel.readInt() != 0) {
1520 contentIntent = PendingIntent.CREATOR.createFromParcel(parcel);
1521 }
1522 if (parcel.readInt() != 0) {
1523 deleteIntent = PendingIntent.CREATOR.createFromParcel(parcel);
1524 }
1525 if (parcel.readInt() != 0) {
1526 tickerText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel);
1527 }
1528 if (parcel.readInt() != 0) {
Joe Onorato46439ce2010-11-19 13:56:21 -08001529 tickerView = RemoteViews.CREATOR.createFromParcel(parcel);
Joe Onoratoef1e7762010-09-17 18:38:38 -04001530 }
1531 if (parcel.readInt() != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001532 contentView = RemoteViews.CREATOR.createFromParcel(parcel);
1533 }
Joe Onorato561d3852010-11-20 18:09:34 -08001534 if (parcel.readInt() != 0) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04001535 mLargeIcon = Icon.CREATOR.createFromParcel(parcel);
Joe Onorato561d3852010-11-20 18:09:34 -08001536 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001537 defaults = parcel.readInt();
1538 flags = parcel.readInt();
1539 if (parcel.readInt() != 0) {
1540 sound = Uri.CREATOR.createFromParcel(parcel);
1541 }
1542
1543 audioStreamType = parcel.readInt();
John Spurlockc0650f022014-07-19 13:22:39 -04001544 if (parcel.readInt() != 0) {
1545 audioAttributes = AudioAttributes.CREATOR.createFromParcel(parcel);
1546 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001547 vibrate = parcel.createLongArray();
1548 ledARGB = parcel.readInt();
1549 ledOnMS = parcel.readInt();
1550 ledOffMS = parcel.readInt();
1551 iconLevel = parcel.readInt();
Daniel Sandlere46cbd32010-06-17 10:35:26 -04001552
1553 if (parcel.readInt() != 0) {
1554 fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel);
1555 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001556
1557 priority = parcel.readInt();
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001558
John Spurlockfd7f1e02014-03-18 16:41:57 -04001559 category = parcel.readString();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001560
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001561 mGroupKey = parcel.readString();
1562
1563 mSortKey = parcel.readString();
1564
Jeff Sharkeya04c7a72016-03-18 12:20:36 -06001565 extras = Bundle.setDefusable(parcel.readBundle(), true); // may be null
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001566
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001567 actions = parcel.createTypedArray(Action.CREATOR); // may be null
1568
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001569 if (parcel.readInt() != 0) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001570 bigContentView = RemoteViews.CREATOR.createFromParcel(parcel);
1571 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001572
Chris Wren8fd39ec2014-02-27 17:43:26 -05001573 if (parcel.readInt() != 0) {
1574 headsUpContentView = RemoteViews.CREATOR.createFromParcel(parcel);
1575 }
1576
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001577 visibility = parcel.readInt();
1578
1579 if (parcel.readInt() != 0) {
1580 publicVersion = Notification.CREATOR.createFromParcel(parcel);
1581 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04001582
1583 color = parcel.readInt();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001584 }
1585
Andy Stadler110988c2010-12-03 14:29:16 -08001586 @Override
Joe Onorato18e69df2010-05-17 22:26:12 -07001587 public Notification clone() {
1588 Notification that = new Notification();
Daniel Sandler1a497d32013-04-18 14:52:45 -04001589 cloneInto(that, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001590 return that;
1591 }
Joe Onorato18e69df2010-05-17 22:26:12 -07001592
Daniel Sandler1a497d32013-04-18 14:52:45 -04001593 /**
1594 * Copy all (or if heavy is false, all except Bitmaps and RemoteViews) members
1595 * of this into that.
1596 * @hide
1597 */
1598 public void cloneInto(Notification that, boolean heavy) {
Joe Onorato18e69df2010-05-17 22:26:12 -07001599 that.when = this.when;
Dan Sandlerd63f9322015-05-06 15:18:49 -04001600 that.mSmallIcon = this.mSmallIcon;
Joe Onorato18e69df2010-05-17 22:26:12 -07001601 that.number = this.number;
1602
1603 // PendingIntents are global, so there's no reason (or way) to clone them.
1604 that.contentIntent = this.contentIntent;
1605 that.deleteIntent = this.deleteIntent;
Daniel Sandlere46cbd32010-06-17 10:35:26 -04001606 that.fullScreenIntent = this.fullScreenIntent;
Joe Onorato18e69df2010-05-17 22:26:12 -07001607
1608 if (this.tickerText != null) {
1609 that.tickerText = this.tickerText.toString();
1610 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04001611 if (heavy && this.tickerView != null) {
Joe Onorato46439ce2010-11-19 13:56:21 -08001612 that.tickerView = this.tickerView.clone();
Joe Onoratoef1e7762010-09-17 18:38:38 -04001613 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04001614 if (heavy && this.contentView != null) {
Joe Onorato18e69df2010-05-17 22:26:12 -07001615 that.contentView = this.contentView.clone();
1616 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04001617 if (heavy && this.mLargeIcon != null) {
1618 that.mLargeIcon = this.mLargeIcon;
Joe Onorato561d3852010-11-20 18:09:34 -08001619 }
Jozef BABJAKa8b91832011-02-22 08:05:08 +01001620 that.iconLevel = this.iconLevel;
Joe Onorato18e69df2010-05-17 22:26:12 -07001621 that.sound = this.sound; // android.net.Uri is immutable
1622 that.audioStreamType = this.audioStreamType;
John Spurlockc0650f022014-07-19 13:22:39 -04001623 if (this.audioAttributes != null) {
1624 that.audioAttributes = new AudioAttributes.Builder(this.audioAttributes).build();
1625 }
Joe Onorato18e69df2010-05-17 22:26:12 -07001626
1627 final long[] vibrate = this.vibrate;
1628 if (vibrate != null) {
1629 final int N = vibrate.length;
1630 final long[] vib = that.vibrate = new long[N];
1631 System.arraycopy(vibrate, 0, vib, 0, N);
1632 }
1633
1634 that.ledARGB = this.ledARGB;
1635 that.ledOnMS = this.ledOnMS;
1636 that.ledOffMS = this.ledOffMS;
1637 that.defaults = this.defaults;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001638
Joe Onorato18e69df2010-05-17 22:26:12 -07001639 that.flags = this.flags;
1640
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001641 that.priority = this.priority;
Joe Malin8d40d042012-11-05 11:36:40 -08001642
John Spurlockfd7f1e02014-03-18 16:41:57 -04001643 that.category = this.category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001644
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001645 that.mGroupKey = this.mGroupKey;
1646
1647 that.mSortKey = this.mSortKey;
1648
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001649 if (this.extras != null) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001650 try {
1651 that.extras = new Bundle(this.extras);
1652 // will unparcel
1653 that.extras.size();
1654 } catch (BadParcelableException e) {
1655 Log.e(TAG, "could not unparcel extras from notification: " + this, e);
1656 that.extras = null;
1657 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001658 }
1659
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001660 if (this.actions != null) {
1661 that.actions = new Action[this.actions.length];
1662 for(int i=0; i<this.actions.length; i++) {
1663 that.actions[i] = this.actions[i].clone();
1664 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001665 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001666
Daniel Sandler1a497d32013-04-18 14:52:45 -04001667 if (heavy && this.bigContentView != null) {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001668 that.bigContentView = this.bigContentView.clone();
1669 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04001670
Chris Wren8fd39ec2014-02-27 17:43:26 -05001671 if (heavy && this.headsUpContentView != null) {
1672 that.headsUpContentView = this.headsUpContentView.clone();
1673 }
1674
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001675 that.visibility = this.visibility;
1676
1677 if (this.publicVersion != null) {
1678 that.publicVersion = new Notification();
1679 this.publicVersion.cloneInto(that.publicVersion, heavy);
1680 }
1681
Dan Sandler26e81cf2014-05-06 10:01:27 -04001682 that.color = this.color;
1683
Daniel Sandler1a497d32013-04-18 14:52:45 -04001684 if (!heavy) {
1685 that.lightenPayload(); // will clean out extras
1686 }
1687 }
1688
1689 /**
1690 * Removes heavyweight parts of the Notification object for archival or for sending to
1691 * listeners when the full contents are not necessary.
1692 * @hide
1693 */
1694 public final void lightenPayload() {
1695 tickerView = null;
1696 contentView = null;
1697 bigContentView = null;
Chris Wren8fd39ec2014-02-27 17:43:26 -05001698 headsUpContentView = null;
Dan Sandlerd63f9322015-05-06 15:18:49 -04001699 mLargeIcon = null;
Dan Sandler50128532015-12-08 15:42:41 -05001700 if (extras != null && !extras.isEmpty()) {
1701 final Set<String> keyset = extras.keySet();
1702 final int N = keyset.size();
1703 final String[] keys = keyset.toArray(new String[N]);
1704 for (int i=0; i<N; i++) {
1705 final String key = keys[i];
1706 final Object obj = extras.get(key);
1707 if (obj != null &&
1708 ( obj instanceof Parcelable
1709 || obj instanceof Parcelable[]
1710 || obj instanceof SparseArray
1711 || obj instanceof ArrayList)) {
1712 extras.remove(key);
1713 }
1714 }
Daniel Sandler1a497d32013-04-18 14:52:45 -04001715 }
Joe Onorato18e69df2010-05-17 22:26:12 -07001716 }
1717
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001718 /**
1719 * Make sure this CharSequence is safe to put into a bundle, which basically
1720 * means it had better not be some custom Parcelable implementation.
1721 * @hide
1722 */
1723 public static CharSequence safeCharSequence(CharSequence cs) {
Christoph Studer535ec612014-09-03 15:47:47 +02001724 if (cs == null) return cs;
1725 if (cs.length() > MAX_CHARSEQUENCE_LENGTH) {
1726 cs = cs.subSequence(0, MAX_CHARSEQUENCE_LENGTH);
1727 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001728 if (cs instanceof Parcelable) {
1729 Log.e(TAG, "warning: " + cs.getClass().getCanonicalName()
1730 + " instance is a custom Parcelable and not allowed in Notification");
1731 return cs.toString();
1732 }
Selim Cinek60a54252016-02-26 17:03:25 -08001733 return removeTextSizeSpans(cs);
1734 }
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001735
Selim Cinek60a54252016-02-26 17:03:25 -08001736 private static CharSequence removeTextSizeSpans(CharSequence charSequence) {
1737 if (charSequence instanceof Spanned) {
1738 Spanned ss = (Spanned) charSequence;
1739 Object[] spans = ss.getSpans(0, ss.length(), Object.class);
1740 SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString());
1741 for (Object span : spans) {
1742 Object resultSpan = span;
Selim Cinek89991a22016-03-07 19:51:54 -08001743 if (resultSpan instanceof CharacterStyle) {
1744 resultSpan = ((CharacterStyle) span).getUnderlying();
1745 }
1746 if (resultSpan instanceof TextAppearanceSpan) {
1747 TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan;
Selim Cinek60a54252016-02-26 17:03:25 -08001748 resultSpan = new TextAppearanceSpan(
1749 originalSpan.getFamily(),
1750 originalSpan.getTextStyle(),
1751 -1,
1752 originalSpan.getTextColor(),
1753 originalSpan.getLinkTextColor());
Selim Cinek89991a22016-03-07 19:51:54 -08001754 } else if (resultSpan instanceof RelativeSizeSpan
1755 || resultSpan instanceof AbsoluteSizeSpan) {
Selim Cinek60a54252016-02-26 17:03:25 -08001756 continue;
Selim Cinek89991a22016-03-07 19:51:54 -08001757 } else {
1758 resultSpan = span;
Selim Cinek60a54252016-02-26 17:03:25 -08001759 }
1760 builder.setSpan(resultSpan, ss.getSpanStart(span), ss.getSpanEnd(span),
1761 ss.getSpanFlags(span));
1762 }
1763 return builder;
1764 }
1765 return charSequence;
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04001766 }
1767
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001768 public int describeContents() {
1769 return 0;
1770 }
1771
1772 /**
Dan Sandler4e787062015-06-17 15:09:48 -04001773 * Flatten this notification into a parcel.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001774 */
1775 public void writeToParcel(Parcel parcel, int flags)
1776 {
1777 parcel.writeInt(1);
1778
1779 parcel.writeLong(when);
Dan Sandler4e787062015-06-17 15:09:48 -04001780 if (mSmallIcon == null && icon != 0) {
1781 // you snuck an icon in here without using the builder; let's try to keep it
1782 mSmallIcon = Icon.createWithResource("", icon);
1783 }
Dan Sandler3936e7a2015-05-19 20:59:12 -04001784 if (mSmallIcon != null) {
1785 parcel.writeInt(1);
1786 mSmallIcon.writeToParcel(parcel, 0);
1787 } else {
1788 parcel.writeInt(0);
1789 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001790 parcel.writeInt(number);
1791 if (contentIntent != null) {
1792 parcel.writeInt(1);
1793 contentIntent.writeToParcel(parcel, 0);
1794 } else {
1795 parcel.writeInt(0);
1796 }
1797 if (deleteIntent != null) {
1798 parcel.writeInt(1);
1799 deleteIntent.writeToParcel(parcel, 0);
1800 } else {
1801 parcel.writeInt(0);
1802 }
1803 if (tickerText != null) {
1804 parcel.writeInt(1);
1805 TextUtils.writeToParcel(tickerText, parcel, flags);
1806 } else {
1807 parcel.writeInt(0);
1808 }
Joe Onorato46439ce2010-11-19 13:56:21 -08001809 if (tickerView != null) {
Joe Onoratoef1e7762010-09-17 18:38:38 -04001810 parcel.writeInt(1);
Joe Onorato46439ce2010-11-19 13:56:21 -08001811 tickerView.writeToParcel(parcel, 0);
Joe Onoratoef1e7762010-09-17 18:38:38 -04001812 } else {
1813 parcel.writeInt(0);
1814 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001815 if (contentView != null) {
1816 parcel.writeInt(1);
1817 contentView.writeToParcel(parcel, 0);
1818 } else {
1819 parcel.writeInt(0);
1820 }
Dan Sandlerd63f9322015-05-06 15:18:49 -04001821 if (mLargeIcon != null) {
Joe Onorato561d3852010-11-20 18:09:34 -08001822 parcel.writeInt(1);
Dan Sandlerd63f9322015-05-06 15:18:49 -04001823 mLargeIcon.writeToParcel(parcel, 0);
Joe Onorato561d3852010-11-20 18:09:34 -08001824 } else {
1825 parcel.writeInt(0);
1826 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001827
1828 parcel.writeInt(defaults);
1829 parcel.writeInt(this.flags);
1830
1831 if (sound != null) {
1832 parcel.writeInt(1);
1833 sound.writeToParcel(parcel, 0);
1834 } else {
1835 parcel.writeInt(0);
1836 }
1837 parcel.writeInt(audioStreamType);
John Spurlockc0650f022014-07-19 13:22:39 -04001838
1839 if (audioAttributes != null) {
1840 parcel.writeInt(1);
1841 audioAttributes.writeToParcel(parcel, 0);
1842 } else {
1843 parcel.writeInt(0);
1844 }
1845
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001846 parcel.writeLongArray(vibrate);
1847 parcel.writeInt(ledARGB);
1848 parcel.writeInt(ledOnMS);
1849 parcel.writeInt(ledOffMS);
1850 parcel.writeInt(iconLevel);
Daniel Sandlere46cbd32010-06-17 10:35:26 -04001851
1852 if (fullScreenIntent != null) {
1853 parcel.writeInt(1);
1854 fullScreenIntent.writeToParcel(parcel, 0);
1855 } else {
1856 parcel.writeInt(0);
1857 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001858
1859 parcel.writeInt(priority);
Joe Malin8d40d042012-11-05 11:36:40 -08001860
John Spurlockfd7f1e02014-03-18 16:41:57 -04001861 parcel.writeString(category);
Joe Malin8d40d042012-11-05 11:36:40 -08001862
Griff Hazen5cadc3b2014-05-20 09:55:39 -07001863 parcel.writeString(mGroupKey);
1864
1865 parcel.writeString(mSortKey);
1866
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001867 parcel.writeBundle(extras); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001868
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001869 parcel.writeTypedArray(actions, 0); // null ok
Daniel Sandlera0a938c2012-03-15 08:42:37 -04001870
Daniel Sandlerf3b73432012-03-27 15:01:25 -04001871 if (bigContentView != null) {
1872 parcel.writeInt(1);
1873 bigContentView.writeToParcel(parcel, 0);
1874 } else {
1875 parcel.writeInt(0);
1876 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001877
Chris Wren8fd39ec2014-02-27 17:43:26 -05001878 if (headsUpContentView != null) {
1879 parcel.writeInt(1);
1880 headsUpContentView.writeToParcel(parcel, 0);
1881 } else {
1882 parcel.writeInt(0);
1883 }
1884
Dan Sandler0bf2ed82013-12-21 23:33:41 -06001885 parcel.writeInt(visibility);
1886
1887 if (publicVersion != null) {
1888 parcel.writeInt(1);
1889 publicVersion.writeToParcel(parcel, 0);
1890 } else {
1891 parcel.writeInt(0);
1892 }
Dan Sandler26e81cf2014-05-06 10:01:27 -04001893
1894 parcel.writeInt(color);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001895 }
1896
1897 /**
1898 * Parcelable.Creator that instantiates Notification objects
1899 */
1900 public static final Parcelable.Creator<Notification> CREATOR
1901 = new Parcelable.Creator<Notification>()
1902 {
1903 public Notification createFromParcel(Parcel parcel)
1904 {
1905 return new Notification(parcel);
1906 }
1907
1908 public Notification[] newArray(int size)
1909 {
1910 return new Notification[size];
1911 }
1912 };
1913
1914 /**
1915 * Sets the {@link #contentView} field to be a view with the standard "Latest Event"
1916 * layout.
1917 *
1918 * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields
1919 * in the view.</p>
1920 * @param context The context for your application / activity.
1921 * @param contentTitle The title that goes in the expanded entry.
1922 * @param contentText The text that goes in the expanded entry.
1923 * @param contentIntent The intent to launch when the user clicks the expanded notification.
1924 * If this is an activity, it must include the
1925 * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires
Scott Main7aee61f2011-02-08 11:25:01 -08001926 * that you take care of task management as described in the
1927 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
1928 * Stack</a> document.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001929 *
Joe Onorato46439ce2010-11-19 13:56:21 -08001930 * @deprecated Use {@link Builder} instead.
Chris Wrena05db382015-06-24 15:18:34 -04001931 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001932 */
Joe Onorato46439ce2010-11-19 13:56:21 -08001933 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001934 public void setLatestEventInfo(Context context,
1935 CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04001936 if (context.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.LOLLIPOP_MR1){
1937 Log.e(TAG, "setLatestEventInfo() is deprecated and you should feel deprecated.",
1938 new Throwable());
1939 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001940
Julia Reynoldsd9228f12015-10-20 10:37:27 -04001941 // ensure that any information already set directly is preserved
1942 final Notification.Builder builder = new Notification.Builder(context, this);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001943
1944 // now apply the latestEventInfo fields
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001945 if (contentTitle != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001946 builder.setContentTitle(contentTitle);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001947 }
1948 if (contentText != null) {
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001949 builder.setContentText(contentText);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001950 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05001951 builder.setContentIntent(contentIntent);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04001952
1953 builder.build(); // callers expect this notification to be ready to use
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001954 }
1955
Julia Reynoldsda303542015-11-23 14:00:20 -05001956 /**
1957 * @hide
1958 */
1959 public static void addFieldsFromContext(Context context, Notification notification) {
Jeff Sharkey012bc7b2016-04-11 16:30:27 -06001960 addFieldsFromContext(context.getApplicationInfo(), context.getUserId(), notification);
1961 }
1962
1963 /**
1964 * @hide
1965 */
1966 public static void addFieldsFromContext(ApplicationInfo ai, int userId,
1967 Notification notification) {
1968 notification.extras.putParcelable(EXTRA_BUILDER_APPLICATION_INFO, ai);
1969 notification.extras.putInt(EXTRA_ORIGINATING_USERID, userId);
Julia Reynoldsda303542015-11-23 14:00:20 -05001970 }
1971
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001972 @Override
1973 public String toString() {
1974 StringBuilder sb = new StringBuilder();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05001975 sb.append("Notification(pri=");
1976 sb.append(priority);
1977 sb.append(" contentView=");
Joe Onoratoc9596d62011-01-12 17:03:11 -08001978 if (contentView != null) {
1979 sb.append(contentView.getPackage());
1980 sb.append("/0x");
1981 sb.append(Integer.toHexString(contentView.getLayoutId()));
1982 } else {
1983 sb.append("null");
1984 }
1985 sb.append(" vibrate=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05001986 if ((this.defaults & DEFAULT_VIBRATE) != 0) {
1987 sb.append("default");
1988 } else if (this.vibrate != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001989 int N = this.vibrate.length-1;
1990 sb.append("[");
1991 for (int i=0; i<N; i++) {
1992 sb.append(this.vibrate[i]);
1993 sb.append(',');
1994 }
Simon Schoar8cf97d92009-06-10 22:08:37 +02001995 if (N != -1) {
1996 sb.append(this.vibrate[N]);
1997 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001998 sb.append("]");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001999 } else {
2000 sb.append("null");
2001 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002002 sb.append(" sound=");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002003 if ((this.defaults & DEFAULT_SOUND) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002004 sb.append("default");
Daniel Sandler6738eee2012-11-16 12:03:32 -05002005 } else if (this.sound != null) {
2006 sb.append(this.sound.toString());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002007 } else {
2008 sb.append("null");
2009 }
Chris Wren365b6d32015-07-16 10:39:26 -04002010 if (this.tickerText != null) {
2011 sb.append(" tick");
2012 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002013 sb.append(" defaults=0x");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002014 sb.append(Integer.toHexString(this.defaults));
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002015 sb.append(" flags=0x");
Daniel Sandlere46cbd32010-06-17 10:35:26 -04002016 sb.append(Integer.toHexString(this.flags));
Dan Sandler26e81cf2014-05-06 10:01:27 -04002017 sb.append(String.format(" color=0x%08x", this.color));
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002018 if (this.category != null) {
2019 sb.append(" category=");
2020 sb.append(this.category);
2021 }
2022 if (this.mGroupKey != null) {
2023 sb.append(" groupKey=");
2024 sb.append(this.mGroupKey);
2025 }
2026 if (this.mSortKey != null) {
2027 sb.append(" sortKey=");
2028 sb.append(this.mSortKey);
2029 }
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002030 if (actions != null) {
Dan Sandler1b718782014-07-18 12:43:45 -04002031 sb.append(" actions=");
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002032 sb.append(actions.length);
Dan Sandler1b718782014-07-18 12:43:45 -04002033 }
2034 sb.append(" vis=");
2035 sb.append(visibilityToString(this.visibility));
2036 if (this.publicVersion != null) {
2037 sb.append(" publicVersion=");
2038 sb.append(publicVersion.toString());
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002039 }
2040 sb.append(")");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002041 return sb.toString();
2042 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002043
Dan Sandler1b718782014-07-18 12:43:45 -04002044 /**
2045 * {@hide}
2046 */
2047 public static String visibilityToString(int vis) {
2048 switch (vis) {
2049 case VISIBILITY_PRIVATE:
2050 return "PRIVATE";
2051 case VISIBILITY_PUBLIC:
2052 return "PUBLIC";
2053 case VISIBILITY_SECRET:
2054 return "SECRET";
2055 default:
2056 return "UNKNOWN(" + String.valueOf(vis) + ")";
2057 }
2058 }
2059
Joe Onoratocb109a02011-01-18 17:57:41 -08002060 /**
John Spurlock1d881a12015-03-18 19:21:54 -04002061 * {@hide}
2062 */
2063 public static String priorityToString(@Priority int pri) {
2064 switch (pri) {
2065 case PRIORITY_MIN:
2066 return "MIN";
2067 case PRIORITY_LOW:
2068 return "LOW";
2069 case PRIORITY_DEFAULT:
2070 return "DEFAULT";
2071 case PRIORITY_HIGH:
2072 return "HIGH";
2073 case PRIORITY_MAX:
2074 return "MAX";
2075 default:
2076 return "UNKNOWN(" + String.valueOf(pri) + ")";
2077 }
2078 }
2079
2080 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04002081 * The small icon representing this notification in the status bar and content view.
2082 *
2083 * @return the small icon representing this notification.
2084 *
2085 * @see Builder#getSmallIcon()
2086 * @see Builder#setSmallIcon(Icon)
2087 */
2088 public Icon getSmallIcon() {
2089 return mSmallIcon;
2090 }
2091
2092 /**
2093 * Used when notifying to clean up legacy small icons.
2094 * @hide
2095 */
2096 public void setSmallIcon(Icon icon) {
2097 mSmallIcon = icon;
2098 }
2099
2100 /**
2101 * The large icon shown in this notification's content view.
2102 * @see Builder#getLargeIcon()
2103 * @see Builder#setLargeIcon(Icon)
2104 */
2105 public Icon getLargeIcon() {
2106 return mLargeIcon;
2107 }
2108
2109 /**
Christoph Studer4600f9b2014-07-22 22:44:43 +02002110 * @hide
2111 */
Christoph Studerc8db24b2014-07-25 17:50:30 +02002112 public boolean isGroupSummary() {
2113 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) != 0;
2114 }
2115
2116 /**
2117 * @hide
2118 */
2119 public boolean isGroupChild() {
2120 return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) == 0;
2121 }
2122
2123 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002124 * Builder class for {@link Notification} objects.
Joe Malin8d40d042012-11-05 11:36:40 -08002125 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002126 * Provides a convenient way to set the various fields of a {@link Notification} and generate
Scott Main183bf112012-08-13 19:12:13 -07002127 * content views using the platform's notification layout template. If your app supports
2128 * versions of Android as old as API level 4, you can instead use
2129 * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder},
2130 * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support
2131 * library</a>.
Joe Malin8d40d042012-11-05 11:36:40 -08002132 *
Scott Main183bf112012-08-13 19:12:13 -07002133 * <p>Example:
Joe Malin8d40d042012-11-05 11:36:40 -08002134 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002135 * <pre class="prettyprint">
Scott Main183bf112012-08-13 19:12:13 -07002136 * Notification noti = new Notification.Builder(mContext)
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002137 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
2138 * .setContentText(subject)
2139 * .setSmallIcon(R.drawable.new_mail)
2140 * .setLargeIcon(aBitmap)
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002141 * .build();
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002142 * </pre>
Joe Onoratocb109a02011-01-18 17:57:41 -08002143 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002144 public static class Builder {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05002145 /**
2146 * @hide
2147 */
2148 public static final String EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT =
2149 "android.rebuild.contentViewActionCount";
2150 /**
2151 * @hide
2152 */
2153 public static final String EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT
2154 = "android.rebuild.bigViewActionCount";
2155 /**
2156 * @hide
2157 */
2158 public static final String EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT
2159 = "android.rebuild.hudViewActionCount";
2160
Daniel Sandler602ad1c2012-06-12 16:06:27 -04002161 private static final int MAX_ACTION_BUTTONS = 3;
Daniel Sandler8680bf82012-05-15 16:52:52 -04002162
Joe Onorato46439ce2010-11-19 13:56:21 -08002163 private Context mContext;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002164 private Notification mN;
2165 private Bundle mUserExtras = new Bundle();
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002166 private Style mStyle;
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002167 private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS);
2168 private ArrayList<String> mPersonList = new ArrayList<String>();
2169 private NotificationColorUtil mColorUtil;
2170 private boolean mColorUtilInited = false;
Christoph Studer7ac80e62014-08-04 16:01:57 +02002171
2172 /**
Adrian Roos4ff3b122016-02-01 12:26:13 -08002173 * Caches a contrast-enhanced version of {@link #mCachedContrastColorIsFor}.
2174 */
2175 private int mCachedContrastColor = COLOR_INVALID;
2176 private int mCachedContrastColorIsFor = COLOR_INVALID;
2177
2178 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002179 * Constructs a new Builder with the defaults:
Joe Onoratocb109a02011-01-18 17:57:41 -08002180 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002181
2182 * <table>
2183 * <tr><th align=right>priority</th>
2184 * <td>{@link #PRIORITY_DEFAULT}</td></tr>
2185 * <tr><th align=right>when</th>
2186 * <td>now ({@link System#currentTimeMillis()})</td></tr>
2187 * <tr><th align=right>audio stream</th>
2188 * <td>{@link #STREAM_DEFAULT}</td></tr>
2189 * </table>
Joe Onoratocb109a02011-01-18 17:57:41 -08002190 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002191
2192 * @param context
2193 * A {@link Context} that will be used by the Builder to construct the
2194 * RemoteViews. The Context will not be held past the lifetime of this Builder
2195 * object.
Joe Onoratocb109a02011-01-18 17:57:41 -08002196 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002197 public Builder(Context context) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002198 this(context, null);
Joe Onorato46439ce2010-11-19 13:56:21 -08002199 }
2200
Joe Onoratocb109a02011-01-18 17:57:41 -08002201 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002202 * @hide
Christoph Studer4600f9b2014-07-22 22:44:43 +02002203 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002204 public Builder(Context context, Notification toAdopt) {
2205 mContext = context;
Christoph Studer4600f9b2014-07-22 22:44:43 +02002206
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002207 if (toAdopt == null) {
2208 mN = new Notification();
Selim Cinek0ff1ce602016-04-05 18:27:16 -07002209 if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) {
2210 mN.extras.putBoolean(EXTRA_SHOW_WHEN, true);
2211 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002212 mN.priority = PRIORITY_DEFAULT;
2213 mN.visibility = VISIBILITY_PRIVATE;
2214 } else {
2215 mN = toAdopt;
2216 if (mN.actions != null) {
2217 Collections.addAll(mActions, mN.actions);
Christoph Studer4600f9b2014-07-22 22:44:43 +02002218 }
2219
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002220 if (mN.extras.containsKey(EXTRA_PEOPLE)) {
2221 Collections.addAll(mPersonList, mN.extras.getStringArray(EXTRA_PEOPLE));
2222 }
2223
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002224 String templateClass = mN.extras.getString(EXTRA_TEMPLATE);
2225 if (!TextUtils.isEmpty(templateClass)) {
2226 final Class<? extends Style> styleClass
2227 = getNotificationStyleClass(templateClass);
2228 if (styleClass == null) {
2229 Log.d(TAG, "Unknown style class: " + templateClass);
2230 } else {
2231 try {
Adrian Roosc1a80b02016-04-05 14:54:55 -07002232 final Constructor<? extends Style> ctor =
2233 styleClass.getDeclaredConstructor();
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002234 ctor.setAccessible(true);
2235 final Style style = ctor.newInstance();
2236 style.restoreFromExtras(mN.extras);
2237
2238 if (style != null) {
2239 setStyle(style);
2240 }
2241 } catch (Throwable t) {
2242 Log.e(TAG, "Could not create Style", t);
2243 }
2244 }
2245 }
2246
2247 }
2248 }
2249
2250 private NotificationColorUtil getColorUtil() {
2251 if (!mColorUtilInited) {
2252 mColorUtilInited = true;
2253 if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.LOLLIPOP) {
2254 mColorUtil = NotificationColorUtil.getInstance(mContext);
Christoph Studer4600f9b2014-07-22 22:44:43 +02002255 }
2256 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002257 return mColorUtil;
Christoph Studer4600f9b2014-07-22 22:44:43 +02002258 }
2259
2260 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002261 * Add a timestamp pertaining to the notification (usually the time the event occurred).
Selim Cinek0ff1ce602016-04-05 18:27:16 -07002262 *
2263 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not
2264 * shown anymore by default and must be opted into by using
2265 * {@link android.app.Notification.Builder#setShowWhen(boolean)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002266 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002267 * @see Notification#when
Joe Onoratocb109a02011-01-18 17:57:41 -08002268 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002269 public Builder setWhen(long when) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002270 mN.when = when;
Joe Onorato46439ce2010-11-19 13:56:21 -08002271 return this;
2272 }
2273
Joe Onoratocb109a02011-01-18 17:57:41 -08002274 /**
Griff Hazen50c11652014-05-16 09:46:31 -07002275 * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown
Daniel Sandler0c890492012-09-12 17:23:10 -07002276 * in the content view.
Selim Cinek0ff1ce602016-04-05 18:27:16 -07002277 * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to
2278 * {@code false}. For earlier apps, the default is {@code true}.
Daniel Sandler0c890492012-09-12 17:23:10 -07002279 */
2280 public Builder setShowWhen(boolean show) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002281 mN.extras.putBoolean(EXTRA_SHOW_WHEN, show);
Daniel Sandler0c890492012-09-12 17:23:10 -07002282 return this;
2283 }
2284
2285 /**
Daniel Sandlerd33b8032012-05-10 11:41:48 -04002286 * Show the {@link Notification#when} field as a stopwatch.
Joe Malin8d40d042012-11-05 11:36:40 -08002287 *
2288 * Instead of presenting <code>when</code> as a timestamp, the notification will show an
Daniel Sandlerd33b8032012-05-10 11:41:48 -04002289 * automatically updating display of the minutes and seconds since <code>when</code>.
Daniel Sandlera2985ed2012-04-03 16:42:00 -04002290 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04002291 * Useful when showing an elapsed time (like an ongoing phone call).
2292 *
Selim Cinek81c23aa2016-02-25 16:23:13 -08002293 * The counter can also be set to count down to <code>when</code> when using
2294 * {@link #setChronometerCountsDown(boolean)}.
2295 *
Daniel Sandlerd33b8032012-05-10 11:41:48 -04002296 * @see android.widget.Chronometer
Daniel Sandlera2985ed2012-04-03 16:42:00 -04002297 * @see Notification#when
Selim Cinek81c23aa2016-02-25 16:23:13 -08002298 * @see #setChronometerCountsDown(boolean)
Daniel Sandlera2985ed2012-04-03 16:42:00 -04002299 */
2300 public Builder setUsesChronometer(boolean b) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002301 mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b);
Daniel Sandlera2985ed2012-04-03 16:42:00 -04002302 return this;
2303 }
2304
2305 /**
Selim Cinek81c23aa2016-02-25 16:23:13 -08002306 * Sets the Chronometer to count down instead of counting up.
2307 *
2308 * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true.
2309 * If it isn't set the chronometer will count up.
2310 *
2311 * @see #setUsesChronometer(boolean)
2312 */
2313 public Builder setChronometerCountsDown(boolean countsDown) {
2314 mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNTS_DOWN, countsDown);
2315 return this;
2316 }
2317
2318 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002319 * Set the small icon resource, which will be used to represent the notification in the
2320 * status bar.
Joe Onoratocb109a02011-01-18 17:57:41 -08002321 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002322
2323 * The platform template for the expanded view will draw this icon in the left, unless a
2324 * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small
2325 * icon will be moved to the right-hand side.
2326 *
2327
2328 * @param icon
2329 * A resource ID in the application's package of the drawable to use.
2330 * @see Notification#icon
Joe Onoratocb109a02011-01-18 17:57:41 -08002331 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07002332 public Builder setSmallIcon(@DrawableRes int icon) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04002333 return setSmallIcon(icon != 0
2334 ? Icon.createWithResource(mContext, icon)
2335 : null);
Joe Onorato46439ce2010-11-19 13:56:21 -08002336 }
2337
Joe Onoratocb109a02011-01-18 17:57:41 -08002338 /**
2339 * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional
2340 * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable
2341 * LevelListDrawable}.
2342 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002343 * @param icon A resource ID in the application's package of the drawable to use.
Joe Onoratocb109a02011-01-18 17:57:41 -08002344 * @param level The level to use for the icon.
2345 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002346 * @see Notification#icon
2347 * @see Notification#iconLevel
Joe Onoratocb109a02011-01-18 17:57:41 -08002348 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07002349 public Builder setSmallIcon(@DrawableRes int icon, int level) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002350 mN.iconLevel = level;
Dan Sandlerd63f9322015-05-06 15:18:49 -04002351 return setSmallIcon(icon);
2352 }
2353
2354 /**
2355 * Set the small icon, which will be used to represent the notification in the
2356 * status bar and content view (unless overriden there by a
2357 * {@link #setLargeIcon(Bitmap) large icon}).
2358 *
2359 * @param icon An Icon object to use.
2360 * @see Notification#icon
2361 */
2362 public Builder setSmallIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002363 mN.setSmallIcon(icon);
2364 if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) {
2365 mN.icon = icon.getResId();
2366 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002367 return this;
2368 }
2369
Joe Onoratocb109a02011-01-18 17:57:41 -08002370 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002371 * Set the first line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08002372 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002373 public Builder setContentTitle(CharSequence title) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002374 mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title));
Joe Onorato46439ce2010-11-19 13:56:21 -08002375 return this;
2376 }
2377
Joe Onoratocb109a02011-01-18 17:57:41 -08002378 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002379 * Set the second line of text in the platform notification template.
Joe Onoratocb109a02011-01-18 17:57:41 -08002380 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002381 public Builder setContentText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002382 mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text));
Joe Onorato46439ce2010-11-19 13:56:21 -08002383 return this;
2384 }
2385
Joe Onoratocb109a02011-01-18 17:57:41 -08002386 /**
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07002387 * This provides some additional information that is displayed in the notification. No
2388 * guarantees are given where exactly it is displayed.
2389 *
2390 * <p>This information should only be provided if it provides an essential
2391 * benefit to the understanding of the notification. The more text you provide the
2392 * less readable it becomes. For example, an email client should only provide the account
2393 * name here if more than one email account has been added.</p>
2394 *
2395 * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the
2396 * notification header area.
2397 *
2398 * On Android versions before {@link android.os.Build.VERSION_CODES#N}
2399 * this will be shown in the third line of text in the platform notification template.
2400 * You should not be using {@link #setProgress(int, int, boolean)} at the
2401 * same time on those versions; they occupy the same place.
2402 * </p>
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002403 */
2404 public Builder setSubText(CharSequence text) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002405 mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text));
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002406 return this;
2407 }
2408
2409 /**
Adrian Roose458aa82015-12-08 16:17:19 -08002410 * Set the remote input history.
2411 *
2412 * This should be set to the most recent inputs that have been sent
2413 * through a {@link RemoteInput} of this Notification and cleared once the it is no
2414 * longer relevant (e.g. for chat notifications once the other party has responded).
2415 *
2416 * The most recent input must be stored at the 0 index, the second most recent at the
2417 * 1 index, etc. Note that the system will limit both how far back the inputs will be shown
2418 * and how much of each individual input is shown.
2419 *
2420 * <p>Note: The reply text will only be shown on notifications that have least one action
2421 * with a {@code RemoteInput}.</p>
2422 */
2423 public Builder setRemoteInputHistory(CharSequence[] text) {
2424 if (text == null) {
2425 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null);
2426 } else {
2427 final int N = Math.min(MAX_REPLY_HISTORY, text.length);
2428 CharSequence[] safe = new CharSequence[N];
2429 for (int i = 0; i < N; i++) {
2430 safe[i] = safeCharSequence(text[i]);
2431 }
2432 mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe);
2433 }
2434 return this;
2435 }
2436
2437 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08002438 * Set the large number at the right-hand side of the notification. This is
2439 * equivalent to setContentInfo, although it might show the number in a different
2440 * font size for readability.
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07002441 *
2442 * @deprecated this number is not shown anywhere anymore
Joe Onoratocb109a02011-01-18 17:57:41 -08002443 */
Joe Onorato8595a3d2010-11-19 18:12:07 -08002444 public Builder setNumber(int number) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002445 mN.number = number;
Joe Onorato8595a3d2010-11-19 18:12:07 -08002446 return this;
2447 }
2448
Joe Onoratocb109a02011-01-18 17:57:41 -08002449 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002450 * A small piece of additional information pertaining to this notification.
2451 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002452 * The platform template will draw this on the last line of the notification, at the far
2453 * right (to the right of a smallIcon if it has been placed there).
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07002454 *
2455 * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header.
2456 * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this
2457 * field will still show up, but the subtext will take precedence.
Joe Onoratocb109a02011-01-18 17:57:41 -08002458 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002459 public Builder setContentInfo(CharSequence info) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002460 mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info));
Joe Onorato46439ce2010-11-19 13:56:21 -08002461 return this;
2462 }
2463
Joe Onoratocb109a02011-01-18 17:57:41 -08002464 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002465 * Set the progress this notification represents.
2466 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002467 * The platform template will represent this using a {@link ProgressBar}.
Jeff Sharkey1c400132011-08-05 14:50:13 -07002468 */
2469 public Builder setProgress(int max, int progress, boolean indeterminate) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002470 mN.extras.putInt(EXTRA_PROGRESS, progress);
2471 mN.extras.putInt(EXTRA_PROGRESS_MAX, max);
2472 mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate);
Jeff Sharkey1c400132011-08-05 14:50:13 -07002473 return this;
2474 }
2475
2476 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002477 * Supply a custom RemoteViews to use instead of the platform template.
2478 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002479 * Use {@link #setCustomContentView(RemoteViews)} instead.
Joe Onoratocb109a02011-01-18 17:57:41 -08002480 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002481 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08002482 public Builder setContent(RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002483 return setCustomContentView(views);
2484 }
2485
2486 /**
2487 * Supply custom RemoteViews to use instead of the platform template.
2488 *
2489 * This will override the layout that would otherwise be constructed by this Builder
2490 * object.
2491 */
2492 public Builder setCustomContentView(RemoteViews contentView) {
2493 mN.contentView = contentView;
2494 return this;
2495 }
2496
2497 /**
2498 * Supply custom RemoteViews to use instead of the platform template in the expanded form.
2499 *
2500 * This will override the expanded layout that would otherwise be constructed by this
2501 * Builder object.
2502 */
2503 public Builder setCustomBigContentView(RemoteViews contentView) {
2504 mN.bigContentView = contentView;
2505 return this;
2506 }
2507
2508 /**
2509 * Supply custom RemoteViews to use instead of the platform template in the heads up dialog.
2510 *
2511 * This will override the heads-up layout that would otherwise be constructed by this
2512 * Builder object.
2513 */
2514 public Builder setCustomHeadsUpContentView(RemoteViews contentView) {
2515 mN.headsUpContentView = contentView;
Joe Onorato46439ce2010-11-19 13:56:21 -08002516 return this;
2517 }
2518
Joe Onoratocb109a02011-01-18 17:57:41 -08002519 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002520 * Supply a {@link PendingIntent} to be sent when the notification is clicked.
2521 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002522 * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you
2523 * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use
2524 * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)}
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002525 * to assign PendingIntents to individual views in that custom layout (i.e., to create
Daniel Sandlerf3b73432012-03-27 15:01:25 -04002526 * clickable buttons inside the notification view).
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002527 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002528 * @see Notification#contentIntent Notification.contentIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08002529 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002530 public Builder setContentIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002531 mN.contentIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08002532 return this;
2533 }
2534
Joe Onoratocb109a02011-01-18 17:57:41 -08002535 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002536 * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user.
2537 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002538 * @see Notification#deleteIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08002539 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002540 public Builder setDeleteIntent(PendingIntent intent) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002541 mN.deleteIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08002542 return this;
2543 }
2544
Joe Onoratocb109a02011-01-18 17:57:41 -08002545 /**
2546 * An intent to launch instead of posting the notification to the status bar.
2547 * Only for use with extremely high-priority notifications demanding the user's
2548 * <strong>immediate</strong> attention, such as an incoming phone call or
2549 * alarm clock that the user has explicitly set to a particular time.
2550 * If this facility is used for something else, please give the user an option
2551 * to turn it off and use a normal notification, as this can be extremely
2552 * disruptive.
2553 *
Chris Wren47c20a12014-06-18 17:27:29 -04002554 * <p>
2555 * The system UI may choose to display a heads-up notification, instead of
2556 * launching this intent, while the user is using the device.
2557 * </p>
2558 *
Joe Onoratocb109a02011-01-18 17:57:41 -08002559 * @param intent The pending intent to launch.
2560 * @param highPriority Passing true will cause this notification to be sent
2561 * even if other notifications are suppressed.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002562 *
2563 * @see Notification#fullScreenIntent
Joe Onoratocb109a02011-01-18 17:57:41 -08002564 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002565 public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002566 mN.fullScreenIntent = intent;
Joe Onorato46439ce2010-11-19 13:56:21 -08002567 setFlag(FLAG_HIGH_PRIORITY, highPriority);
2568 return this;
2569 }
2570
Joe Onoratocb109a02011-01-18 17:57:41 -08002571 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04002572 * Set the "ticker" text which is sent to accessibility services.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002573 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002574 * @see Notification#tickerText
Joe Onoratocb109a02011-01-18 17:57:41 -08002575 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002576 public Builder setTicker(CharSequence tickerText) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002577 mN.tickerText = safeCharSequence(tickerText);
Joe Onorato46439ce2010-11-19 13:56:21 -08002578 return this;
2579 }
2580
Joe Onoratocb109a02011-01-18 17:57:41 -08002581 /**
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04002582 * Obsolete version of {@link #setTicker(CharSequence)}.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002583 *
Joe Onoratocb109a02011-01-18 17:57:41 -08002584 */
Dan Sandler5fcdf6e2014-07-18 11:31:15 -04002585 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08002586 public Builder setTicker(CharSequence tickerText, RemoteViews views) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002587 setTicker(tickerText);
2588 // views is ignored
Joe Onorato46439ce2010-11-19 13:56:21 -08002589 return this;
2590 }
2591
Joe Onoratocb109a02011-01-18 17:57:41 -08002592 /**
Dan Sandlerd63f9322015-05-06 15:18:49 -04002593 * Add a large icon to the notification content view.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002594 *
2595 * In the platform template, this image will be shown on the left of the notification view
Dan Sandlerd63f9322015-05-06 15:18:49 -04002596 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
2597 * badge atop the large icon).
Dan Sandler08a04c12015-05-06 15:18:49 -04002598 */
Dan Sandlerd63f9322015-05-06 15:18:49 -04002599 public Builder setLargeIcon(Bitmap b) {
2600 return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
2601 }
2602
2603 /**
2604 * Add a large icon to the notification content view.
2605 *
2606 * In the platform template, this image will be shown on the left of the notification view
2607 * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small
2608 * badge atop the large icon).
2609 */
2610 public Builder setLargeIcon(Icon icon) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002611 mN.mLargeIcon = icon;
2612 mN.extras.putParcelable(EXTRA_LARGE_ICON, icon);
Joe Onorato46439ce2010-11-19 13:56:21 -08002613 return this;
2614 }
2615
Joe Onoratocb109a02011-01-18 17:57:41 -08002616 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002617 * Set the sound to play.
2618 *
John Spurlockc0650f022014-07-19 13:22:39 -04002619 * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes}
2620 * for notifications.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002621 *
Chris Wren47c20a12014-06-18 17:27:29 -04002622 * <p>
2623 * A notification that is noisy is more likely to be presented as a heads-up notification.
2624 * </p>
2625 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002626 * @see Notification#sound
Joe Onoratocb109a02011-01-18 17:57:41 -08002627 */
Joe Onorato52f80cd2010-11-21 15:34:48 -08002628 public Builder setSound(Uri sound) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002629 mN.sound = sound;
2630 mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT;
Joe Onorato52f80cd2010-11-21 15:34:48 -08002631 return this;
2632 }
2633
Joe Onoratocb109a02011-01-18 17:57:41 -08002634 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002635 * Set the sound to play, along with a specific stream on which to play it.
Joe Onoratocb109a02011-01-18 17:57:41 -08002636 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002637 * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants.
2638 *
Chris Wren47c20a12014-06-18 17:27:29 -04002639 * <p>
2640 * A notification that is noisy is more likely to be presented as a heads-up notification.
2641 * </p>
John Spurlockc0650f022014-07-19 13:22:39 -04002642 * @deprecated use {@link #setSound(Uri, AudioAttributes)} instead.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002643 * @see Notification#sound
Joe Onoratocb109a02011-01-18 17:57:41 -08002644 */
Jean-Michel Trivi81f871e2014-08-06 16:32:38 -07002645 @Deprecated
Joe Onorato46439ce2010-11-19 13:56:21 -08002646 public Builder setSound(Uri sound, int streamType) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002647 mN.sound = sound;
2648 mN.audioStreamType = streamType;
Joe Onorato46439ce2010-11-19 13:56:21 -08002649 return this;
2650 }
2651
Joe Onoratocb109a02011-01-18 17:57:41 -08002652 /**
John Spurlockc0650f022014-07-19 13:22:39 -04002653 * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to
2654 * use during playback.
2655 *
2656 * <p>
2657 * A notification that is noisy is more likely to be presented as a heads-up notification.
2658 * </p>
2659 *
2660 * @see Notification#sound
2661 */
2662 public Builder setSound(Uri sound, AudioAttributes audioAttributes) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002663 mN.sound = sound;
2664 mN.audioAttributes = audioAttributes;
John Spurlockc0650f022014-07-19 13:22:39 -04002665 return this;
2666 }
2667
2668 /**
Joe Onoratocb109a02011-01-18 17:57:41 -08002669 * Set the vibration pattern to use.
2670 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002671 * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the
2672 * <code>pattern</code> parameter.
2673 *
Chris Wren47c20a12014-06-18 17:27:29 -04002674 * <p>
2675 * A notification that vibrates is more likely to be presented as a heads-up notification.
2676 * </p>
2677 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002678 * @see Notification#vibrate
Joe Onoratocb109a02011-01-18 17:57:41 -08002679 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002680 public Builder setVibrate(long[] pattern) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002681 mN.vibrate = pattern;
Joe Onorato46439ce2010-11-19 13:56:21 -08002682 return this;
2683 }
2684
Joe Onoratocb109a02011-01-18 17:57:41 -08002685 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002686 * Set the desired color for the indicator LED on the device, as well as the
2687 * blink duty cycle (specified in milliseconds).
2688 *
2689
2690 * Not all devices will honor all (or even any) of these values.
2691 *
2692
2693 * @see Notification#ledARGB
2694 * @see Notification#ledOnMS
2695 * @see Notification#ledOffMS
Joe Onoratocb109a02011-01-18 17:57:41 -08002696 */
Tor Norbye80756e32015-03-02 09:39:27 -08002697 public Builder setLights(@ColorInt int argb, int onMs, int offMs) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002698 mN.ledARGB = argb;
2699 mN.ledOnMS = onMs;
2700 mN.ledOffMS = offMs;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05002701 if (onMs != 0 || offMs != 0) {
2702 mN.flags |= FLAG_SHOW_LIGHTS;
2703 }
Joe Onorato46439ce2010-11-19 13:56:21 -08002704 return this;
2705 }
2706
Joe Onoratocb109a02011-01-18 17:57:41 -08002707 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002708 * Set whether this is an "ongoing" notification.
Joe Onoratocb109a02011-01-18 17:57:41 -08002709 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002710
2711 * Ongoing notifications cannot be dismissed by the user, so your application or service
2712 * must take care of canceling them.
2713 *
2714
2715 * They are typically used to indicate a background task that the user is actively engaged
2716 * with (e.g., playing music) or is pending in some way and therefore occupying the device
2717 * (e.g., a file download, sync operation, active network connection).
2718 *
2719
2720 * @see Notification#FLAG_ONGOING_EVENT
2721 * @see Service#setForeground(boolean)
Joe Onoratocb109a02011-01-18 17:57:41 -08002722 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002723 public Builder setOngoing(boolean ongoing) {
2724 setFlag(FLAG_ONGOING_EVENT, ongoing);
2725 return this;
2726 }
2727
Joe Onoratocb109a02011-01-18 17:57:41 -08002728 /**
2729 * Set this flag if you would only like the sound, vibrate
2730 * and ticker to be played if the notification is not already showing.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002731 *
2732 * @see Notification#FLAG_ONLY_ALERT_ONCE
Joe Onoratocb109a02011-01-18 17:57:41 -08002733 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002734 public Builder setOnlyAlertOnce(boolean onlyAlertOnce) {
2735 setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce);
2736 return this;
2737 }
2738
Joe Onoratocb109a02011-01-18 17:57:41 -08002739 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002740 * Make this notification automatically dismissed when the user touches it. The
2741 * PendingIntent set with {@link #setDeleteIntent} will be sent when this happens.
2742 *
2743 * @see Notification#FLAG_AUTO_CANCEL
Joe Onoratocb109a02011-01-18 17:57:41 -08002744 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002745 public Builder setAutoCancel(boolean autoCancel) {
Joe Onorato281d83f2011-01-04 17:13:10 -08002746 setFlag(FLAG_AUTO_CANCEL, autoCancel);
Joe Onorato46439ce2010-11-19 13:56:21 -08002747 return this;
2748 }
2749
Joe Onoratocb109a02011-01-18 17:57:41 -08002750 /**
Griff Hazendfcb0802014-02-11 12:00:00 -08002751 * Set whether or not this notification should not bridge to other devices.
2752 *
2753 * <p>Some notifications can be bridged to other devices for remote display.
2754 * This hint can be set to recommend this notification not be bridged.
2755 */
2756 public Builder setLocalOnly(boolean localOnly) {
2757 setFlag(FLAG_LOCAL_ONLY, localOnly);
2758 return this;
2759 }
2760
2761 /**
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002762 * Set which notification properties will be inherited from system defaults.
Joe Onoratocb109a02011-01-18 17:57:41 -08002763 * <p>
2764 * The value should be one or more of the following fields combined with
2765 * bitwise-or:
2766 * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}.
2767 * <p>
2768 * For all default values, use {@link #DEFAULT_ALL}.
2769 */
Joe Onorato46439ce2010-11-19 13:56:21 -08002770 public Builder setDefaults(int defaults) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002771 mN.defaults = defaults;
Joe Onorato46439ce2010-11-19 13:56:21 -08002772 return this;
2773 }
2774
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002775 /**
2776 * Set the priority of this notification.
2777 *
2778 * @see Notification#priority
2779 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002780 public Builder setPriority(@Priority int pri) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002781 mN.priority = pri;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002782 return this;
2783 }
Joe Malin8d40d042012-11-05 11:36:40 -08002784
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002785 /**
John Spurlockfd7f1e02014-03-18 16:41:57 -04002786 * Set the notification category.
Joe Malin8d40d042012-11-05 11:36:40 -08002787 *
John Spurlockfd7f1e02014-03-18 16:41:57 -04002788 * @see Notification#category
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002789 */
John Spurlockfd7f1e02014-03-18 16:41:57 -04002790 public Builder setCategory(String category) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002791 mN.category = category;
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002792 return this;
2793 }
2794
2795 /**
Chris Wrendde75302014-03-26 17:24:15 -04002796 * Add a person that is relevant to this notification.
2797 *
Chris Wrene6c48932014-09-29 17:19:27 -04002798 * <P>
2799 * Depending on user preferences, this annotation may allow the notification to pass
2800 * through interruption filters, and to appear more prominently in the user interface.
2801 * </P>
2802 *
2803 * <P>
2804 * The person should be specified by the {@code String} representation of a
2805 * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
2806 * </P>
2807 *
2808 * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema
2809 * URIs. The path part of these URIs must exist in the contacts database, in the
2810 * appropriate column, or the reference will be discarded as invalid. Telephone schema
2811 * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}.
2812 * </P>
2813 *
2814 * @param uri A URI for the person.
Chris Wrendde75302014-03-26 17:24:15 -04002815 * @see Notification#EXTRA_PEOPLE
2816 */
Chris Wrene6c48932014-09-29 17:19:27 -04002817 public Builder addPerson(String uri) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002818 mPersonList.add(uri);
Chris Wrendde75302014-03-26 17:24:15 -04002819 return this;
2820 }
2821
2822 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002823 * Set this notification to be part of a group of notifications sharing the same key.
2824 * Grouped notifications may display in a cluster or stack on devices which
2825 * support such rendering.
2826 *
2827 * <p>To make this notification the summary for its group, also call
2828 * {@link #setGroupSummary}. A sort order can be specified for group members by using
2829 * {@link #setSortKey}.
2830 * @param groupKey The group key of the group.
2831 * @return this object for method chaining
2832 */
2833 public Builder setGroup(String groupKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002834 mN.mGroupKey = groupKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002835 return this;
2836 }
2837
2838 /**
2839 * Set this notification to be the group summary for a group of notifications.
2840 * Grouped notifications may display in a cluster or stack on devices which
2841 * support such rendering. Requires a group key also be set using {@link #setGroup}.
2842 * @param isGroupSummary Whether this notification should be a group summary.
2843 * @return this object for method chaining
2844 */
2845 public Builder setGroupSummary(boolean isGroupSummary) {
2846 setFlag(FLAG_GROUP_SUMMARY, isGroupSummary);
2847 return this;
2848 }
2849
2850 /**
2851 * Set a sort key that orders this notification among other notifications from the
2852 * same package. This can be useful if an external sort was already applied and an app
2853 * would like to preserve this. Notifications will be sorted lexicographically using this
2854 * value, although providing different priorities in addition to providing sort key may
2855 * cause this value to be ignored.
2856 *
2857 * <p>This sort key can also be used to order members of a notification group. See
Griff Hazen9e1379f2014-05-20 12:50:51 -07002858 * {@link #setGroup}.
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002859 *
2860 * @see String#compareTo(String)
2861 */
2862 public Builder setSortKey(String sortKey) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002863 mN.mSortKey = sortKey;
Griff Hazen5cadc3b2014-05-20 09:55:39 -07002864 return this;
2865 }
2866
2867 /**
Griff Hazen720042b2014-02-24 15:46:56 -08002868 * Merge additional metadata into this notification.
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002869 *
Griff Hazen720042b2014-02-24 15:46:56 -08002870 * <p>Values within the Bundle will replace existing extras values in this Builder.
2871 *
2872 * @see Notification#extras
2873 */
Griff Hazen959591e2014-05-15 22:26:18 -07002874 public Builder addExtras(Bundle extras) {
2875 if (extras != null) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002876 mUserExtras.putAll(extras);
Griff Hazen720042b2014-02-24 15:46:56 -08002877 }
2878 return this;
2879 }
2880
2881 /**
2882 * Set metadata for this notification.
2883 *
2884 * <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 -04002885 * current contents are copied into the Notification each time {@link #build()} is
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002886 * called.
2887 *
Griff Hazen720042b2014-02-24 15:46:56 -08002888 * <p>Replaces any existing extras values with those from the provided Bundle.
2889 * Use {@link #addExtras} to merge in metadata instead.
2890 *
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002891 * @see Notification#extras
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002892 */
Griff Hazen959591e2014-05-15 22:26:18 -07002893 public Builder setExtras(Bundle extras) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002894 if (extras != null) {
2895 mUserExtras = extras;
2896 }
Daniel Sandler2561b0b2012-02-13 21:04:12 -05002897 return this;
2898 }
2899
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002900 /**
Griff Hazen720042b2014-02-24 15:46:56 -08002901 * Get the current metadata Bundle used by this notification Builder.
2902 *
2903 * <p>The returned Bundle is shared with this Builder.
2904 *
2905 * <p>The current contents of this Bundle are copied into the Notification each time
2906 * {@link #build()} is called.
2907 *
2908 * @see Notification#extras
2909 */
2910 public Bundle getExtras() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002911 return mUserExtras;
2912 }
2913
2914 private Bundle getAllExtras() {
2915 final Bundle saveExtras = (Bundle) mUserExtras.clone();
2916 saveExtras.putAll(mN.extras);
2917 return saveExtras;
Griff Hazen720042b2014-02-24 15:46:56 -08002918 }
2919
2920 /**
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002921 * Add an action to this notification. Actions are typically displayed by
2922 * the system as a button adjacent to the notification content.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04002923 * <p>
2924 * Every action must have an icon (32dp square and matching the
2925 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
2926 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
2927 * <p>
2928 * A notification in its expanded form can display up to 3 actions, from left to right in
2929 * the order they were added. Actions will not be displayed when the notification is
2930 * collapsed, however, so be sure that any essential functions may be accessed by the user
2931 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002932 *
2933 * @param icon Resource ID of a drawable that represents the action.
2934 * @param title Text describing the action.
2935 * @param intent PendingIntent to be fired when the action is invoked.
Dan Sandler86647982015-05-13 23:41:13 -04002936 *
2937 * @deprecated Use {@link #addAction(Action)} instead.
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002938 */
Dan Sandler86647982015-05-13 23:41:13 -04002939 @Deprecated
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002940 public Builder addAction(int icon, CharSequence title, PendingIntent intent) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002941 mActions.add(new Action(icon, safeCharSequence(title), intent));
Daniel Sandlera0a938c2012-03-15 08:42:37 -04002942 return this;
2943 }
2944
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002945 /**
Griff Hazen959591e2014-05-15 22:26:18 -07002946 * Add an action to this notification. Actions are typically displayed by
2947 * the system as a button adjacent to the notification content.
2948 * <p>
2949 * Every action must have an icon (32dp square and matching the
2950 * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo
2951 * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}.
2952 * <p>
2953 * A notification in its expanded form can display up to 3 actions, from left to right in
2954 * the order they were added. Actions will not be displayed when the notification is
2955 * collapsed, however, so be sure that any essential functions may be accessed by the user
2956 * in some other way (for example, in the Activity pointed to by {@link #contentIntent}).
2957 *
2958 * @param action The action to add.
2959 */
2960 public Builder addAction(Action action) {
2961 mActions.add(action);
2962 return this;
2963 }
2964
2965 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002966 * Alter the complete list of actions attached to this notification.
2967 * @see #addAction(Action).
2968 *
2969 * @param actions
2970 * @return
2971 */
2972 public Builder setActions(Action... actions) {
2973 mActions.clear();
2974 for (int i = 0; i < actions.length; i++) {
2975 mActions.add(actions[i]);
2976 }
2977 return this;
2978 }
2979
2980 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002981 * Add a rich notification style to be applied at build time.
2982 *
2983 * @param style Object responsible for modifying the notification style.
2984 */
2985 public Builder setStyle(Style style) {
2986 if (mStyle != style) {
2987 mStyle = style;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07002988 if (mStyle != null) {
2989 mStyle.setBuilder(this);
Julia Reynoldsd9228f12015-10-20 10:37:27 -04002990 mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName());
2991 } else {
2992 mN.extras.remove(EXTRA_TEMPLATE);
Daniel Sandlerc08dea22012-06-28 08:35:24 -07002993 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04002994 }
2995 return this;
2996 }
2997
Dan Sandler0bf2ed82013-12-21 23:33:41 -06002998 /**
2999 * Specify the value of {@link #visibility}.
Griff Hazenb720abe2014-05-20 13:15:30 -07003000 *
Dan Sandler0bf2ed82013-12-21 23:33:41 -06003001 * @param visibility One of {@link #VISIBILITY_PRIVATE} (the default),
3002 * {@link #VISIBILITY_SECRET}, or {@link #VISIBILITY_PUBLIC}.
3003 *
3004 * @return The same Builder.
3005 */
3006 public Builder setVisibility(int visibility) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003007 mN.visibility = visibility;
Dan Sandler0bf2ed82013-12-21 23:33:41 -06003008 return this;
3009 }
3010
3011 /**
3012 * Supply a replacement Notification whose contents should be shown in insecure contexts
3013 * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}.
3014 * @param n A replacement notification, presumably with some or all info redacted.
3015 * @return The same Builder.
3016 */
3017 public Builder setPublicVersion(Notification n) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003018 if (n != null) {
3019 mN.publicVersion = new Notification();
3020 n.cloneInto(mN.publicVersion, /*heavy=*/ true);
3021 } else {
3022 mN.publicVersion = null;
3023 }
Dan Sandler0bf2ed82013-12-21 23:33:41 -06003024 return this;
3025 }
3026
Griff Hazenb720abe2014-05-20 13:15:30 -07003027 /**
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003028 * Apply an extender to this notification builder. Extenders may be used to add
3029 * metadata or change options on this builder.
3030 */
Griff Hazen61a9e862014-05-22 16:05:19 -07003031 public Builder extend(Extender extender) {
3032 extender.extend(this);
Griff Hazen5cadc3b2014-05-20 09:55:39 -07003033 return this;
3034 }
3035
Dan Sandler4e787062015-06-17 15:09:48 -04003036 /**
3037 * @hide
3038 */
Julia Reynoldse46bb372016-03-17 11:05:58 -04003039 public Builder setFlag(int mask, boolean value) {
Joe Onorato46439ce2010-11-19 13:56:21 -08003040 if (value) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003041 mN.flags |= mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08003042 } else {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003043 mN.flags &= ~mask;
Joe Onorato46439ce2010-11-19 13:56:21 -08003044 }
Julia Reynoldse46bb372016-03-17 11:05:58 -04003045 return this;
Joe Onorato46439ce2010-11-19 13:56:21 -08003046 }
3047
Dan Sandler26e81cf2014-05-06 10:01:27 -04003048 /**
3049 * Sets {@link Notification#color}.
3050 *
3051 * @param argb The accent color to use
3052 *
3053 * @return The same Builder.
3054 */
Tor Norbye80756e32015-03-02 09:39:27 -08003055 public Builder setColor(@ColorInt int argb) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003056 mN.color = argb;
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05003057 sanitizeColor();
Dan Sandler26e81cf2014-05-06 10:01:27 -04003058 return this;
3059 }
3060
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02003061 private Drawable getProfileBadgeDrawable() {
Christoph Studer7ac80e62014-08-04 16:01:57 +02003062 // Note: This assumes that the current user can read the profile badge of the
3063 // originating user.
Selim Cineke6ff9462016-01-15 15:07:06 -08003064 return mContext.getPackageManager().getUserBadgeForDensityNoBackground(
Julia Reynoldsda303542015-11-23 14:00:20 -05003065 new UserHandle(mContext.getUserId()), 0);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02003066 }
3067
3068 private Bitmap getProfileBadge() {
3069 Drawable badge = getProfileBadgeDrawable();
Kenny Guy8a0101b2014-05-08 23:34:12 +01003070 if (badge == null) {
3071 return null;
3072 }
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02003073 final int size = mContext.getResources().getDimensionPixelSize(
3074 R.dimen.notification_badge_size);
3075 Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
Kenny Guy8a0101b2014-05-08 23:34:12 +01003076 Canvas canvas = new Canvas(bitmap);
Jorim Jaggid05aa3e2014-08-28 17:52:27 +02003077 badge.setBounds(0, 0, size, size);
Kenny Guy8a0101b2014-05-08 23:34:12 +01003078 badge.draw(canvas);
3079 return bitmap;
3080 }
3081
Selim Cinekc848c3a2016-01-13 15:27:30 -08003082 private void bindProfileBadge(RemoteViews contentView) {
Kenny Guy98193ea2014-07-24 19:54:37 +01003083 Bitmap profileBadge = getProfileBadge();
3084
Kenny Guy98193ea2014-07-24 19:54:37 +01003085 if (profileBadge != null) {
Selim Cinekc848c3a2016-01-13 15:27:30 -08003086 contentView.setImageViewBitmap(R.id.profile_badge, profileBadge);
3087 contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE);
Kenny Guy98193ea2014-07-24 19:54:37 +01003088 }
Kenny Guy98193ea2014-07-24 19:54:37 +01003089 }
3090
Christoph Studerfe718432014-09-01 18:21:18 +02003091 private void resetStandardTemplate(RemoteViews contentView) {
Selim Cinekeaa29ca2015-11-23 13:51:13 -08003092 resetNotificationHeader(contentView);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003093 resetContentMargins(contentView);
Christoph Studerfe718432014-09-01 18:21:18 +02003094 contentView.setViewVisibility(R.id.right_icon, View.GONE);
Selim Cinek860b6da2015-12-16 19:02:19 -08003095 contentView.setViewVisibility(R.id.title, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02003096 contentView.setTextViewText(R.id.title, null);
Selim Cinek41598732016-01-11 16:58:37 -08003097 contentView.setViewVisibility(R.id.text, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02003098 contentView.setTextViewText(R.id.text, null);
Selim Cinek29603462015-11-17 19:04:39 -08003099 contentView.setViewVisibility(R.id.text_line_1, View.GONE);
Selim Cinek41598732016-01-11 16:58:37 -08003100 contentView.setTextViewText(R.id.text_line_1, null);
Christoph Studerfe718432014-09-01 18:21:18 +02003101 contentView.setViewVisibility(R.id.progress, View.GONE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003102 }
3103
Selim Cinekeaa29ca2015-11-23 13:51:13 -08003104 /**
3105 * Resets the notification header to its original state
3106 */
3107 private void resetNotificationHeader(RemoteViews contentView) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003108 contentView.setImageViewResource(R.id.icon, 0);
Selim Cinek7b836392015-12-04 20:02:59 -08003109 contentView.setBoolean(R.id.notification_header, "setExpanded", false);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003110 contentView.setTextViewText(R.id.app_name_text, null);
Christoph Studerca1db712014-09-10 17:31:33 +02003111 contentView.setViewVisibility(R.id.chronometer, View.GONE);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003112 contentView.setViewVisibility(R.id.header_text, View.GONE);
3113 contentView.setViewVisibility(R.id.header_text_divider, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08003114 contentView.setViewVisibility(R.id.time_divider, View.GONE);
Selim Cinekc848c3a2016-01-13 15:27:30 -08003115 contentView.setImageViewIcon(R.id.profile_badge, null);
3116 contentView.setViewVisibility(R.id.profile_badge, View.GONE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003117 }
3118
3119 private void resetContentMargins(RemoteViews contentView) {
3120 contentView.setViewLayoutMarginEnd(R.id.line1, 0);
Selim Cinekc848c3a2016-01-13 15:27:30 -08003121 contentView.setViewLayoutMarginEnd(R.id.text, 0);
Christoph Studerfe718432014-09-01 18:21:18 +02003122 }
3123
Jorim Jaggi445d3c02014-08-19 22:33:42 +02003124 private RemoteViews applyStandardTemplate(int resId) {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02003125 return applyStandardTemplate(resId, true /* hasProgress */);
3126 }
3127
3128 /**
3129 * @param hasProgress whether the progress bar should be shown and set
3130 */
3131 private RemoteViews applyStandardTemplate(int resId, boolean hasProgress) {
Adrian Roosc1a80b02016-04-05 14:54:55 -07003132 final Bundle ex = mN.extras;
3133
3134 CharSequence title = processLegacyText(ex.getCharSequence(EXTRA_TITLE));
3135 CharSequence text = processLegacyText(ex.getCharSequence(EXTRA_TEXT));
3136 return applyStandardTemplate(resId, hasProgress, title, text);
3137 }
3138
3139 /**
3140 * @param hasProgress whether the progress bar should be shown and set
3141 */
3142 private RemoteViews applyStandardTemplate(int resId, boolean hasProgress,
3143 CharSequence title, CharSequence text) {
Kenny Guy77320062014-08-27 21:37:15 +01003144 RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId);
Dan Sandler539aad42014-08-04 00:43:39 -04003145
Christoph Studerfe718432014-09-01 18:21:18 +02003146 resetStandardTemplate(contentView);
3147
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003148 final Bundle ex = mN.extras;
Dan Sandler190d58d2014-05-15 09:33:39 -04003149
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003150 bindNotificationHeader(contentView);
3151 bindLargeIcon(contentView);
Adrian Roosc1a80b02016-04-05 14:54:55 -07003152 if (title != null) {
Selim Cinek860b6da2015-12-16 19:02:19 -08003153 contentView.setViewVisibility(R.id.title, View.VISIBLE);
Adrian Roosc1a80b02016-04-05 14:54:55 -07003154 contentView.setTextViewText(R.id.title, title);
Joe Onorato561d3852010-11-20 18:09:34 -08003155 }
Selim Cinek29603462015-11-17 19:04:39 -08003156 boolean showProgress = handleProgressBar(hasProgress, contentView, ex);
Adrian Roosc1a80b02016-04-05 14:54:55 -07003157 if (text != null) {
Selim Cinek41598732016-01-11 16:58:37 -08003158 int textId = showProgress ? com.android.internal.R.id.text_line_1
3159 : com.android.internal.R.id.text;
Adrian Roosc1a80b02016-04-05 14:54:55 -07003160 contentView.setTextViewText(textId, text);
Selim Cinek41598732016-01-11 16:58:37 -08003161 contentView.setViewVisibility(textId, View.VISIBLE);
Joe Onorato561d3852010-11-20 18:09:34 -08003162 }
Selim Cinekc848c3a2016-01-13 15:27:30 -08003163
Selim Cinek860b6da2015-12-16 19:02:19 -08003164 setContentMinHeight(contentView, showProgress || mN.mLargeIcon != null);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003165
Selim Cinek29603462015-11-17 19:04:39 -08003166 return contentView;
3167 }
3168
Selim Cinek860b6da2015-12-16 19:02:19 -08003169 /**
3170 * @param remoteView the remote view to update the minheight in
3171 * @param hasMinHeight does it have a mimHeight
3172 * @hide
3173 */
3174 void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) {
3175 int minHeight = 0;
3176 if (hasMinHeight) {
3177 // we need to set the minHeight of the notification
3178 minHeight = mContext.getResources().getDimensionPixelSize(
3179 com.android.internal.R.dimen.notification_min_content_height);
3180 }
3181 remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight);
3182 }
3183
Selim Cinek29603462015-11-17 19:04:39 -08003184 private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003185 final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0);
3186 final int progress = ex.getInt(EXTRA_PROGRESS, 0);
3187 final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
3188 if (hasProgress && (max != 0 || ind)) {
Selim Cinek29603462015-11-17 19:04:39 -08003189 contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003190 contentView.setProgressBar(
Selim Cinek29603462015-11-17 19:04:39 -08003191 R.id.progress, max, progress, ind);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003192 contentView.setProgressBackgroundTintList(
3193 R.id.progress, ColorStateList.valueOf(mContext.getColor(
3194 R.color.notification_progress_background_color)));
Selim Cinek29603462015-11-17 19:04:39 -08003195 if (mN.color != COLOR_DEFAULT) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08003196 ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003197 contentView.setProgressTintList(R.id.progress, colorStateList);
3198 contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003199 }
Selim Cinek29603462015-11-17 19:04:39 -08003200 return true;
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003201 } else {
3202 contentView.setViewVisibility(R.id.progress, View.GONE);
Selim Cinek29603462015-11-17 19:04:39 -08003203 return false;
Jeff Sharkey1c400132011-08-05 14:50:13 -07003204 }
Joe Onorato561d3852010-11-20 18:09:34 -08003205 }
3206
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003207 private void bindLargeIcon(RemoteViews contentView) {
3208 if (mN.mLargeIcon != null) {
3209 contentView.setViewVisibility(R.id.right_icon, View.VISIBLE);
3210 contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon);
3211 processLargeLegacyIcon(mN.mLargeIcon, contentView);
3212 int endMargin = mContext.getResources().getDimensionPixelSize(
3213 R.dimen.notification_content_picture_margin);
3214 contentView.setViewLayoutMarginEnd(R.id.line1, endMargin);
Selim Cinekc848c3a2016-01-13 15:27:30 -08003215 contentView.setViewLayoutMarginEnd(R.id.text, endMargin);
Selim Cinek29603462015-11-17 19:04:39 -08003216 contentView.setViewLayoutMarginEnd(R.id.progress, endMargin);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003217 }
3218 }
3219
3220 private void bindNotificationHeader(RemoteViews contentView) {
3221 bindSmallIcon(contentView);
3222 bindHeaderAppName(contentView);
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003223 bindHeaderText(contentView);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003224 bindHeaderChronometerAndTime(contentView);
3225 bindExpandButton(contentView);
Selim Cinekc848c3a2016-01-13 15:27:30 -08003226 bindProfileBadge(contentView);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003227 }
3228
3229 private void bindExpandButton(RemoteViews contentView) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08003230 contentView.setDrawableParameters(R.id.expand_button, false, -1, resolveContrastColor(),
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003231 PorterDuff.Mode.SRC_ATOP, -1);
Selim Cinekea4bef72015-12-02 15:51:10 -08003232 contentView.setInt(R.id.notification_header, "setOriginalNotificationColor",
Adrian Roos4ff3b122016-02-01 12:26:13 -08003233 resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003234 }
3235
3236 private void bindHeaderChronometerAndTime(RemoteViews contentView) {
3237 if (showsTimeOrChronometer()) {
Selim Cinek29603462015-11-17 19:04:39 -08003238 contentView.setViewVisibility(R.id.time_divider, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003239 if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) {
3240 contentView.setViewVisibility(R.id.chronometer, View.VISIBLE);
3241 contentView.setLong(R.id.chronometer, "setBase",
3242 mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis()));
3243 contentView.setBoolean(R.id.chronometer, "setStarted", true);
Selim Cinek81c23aa2016-02-25 16:23:13 -08003244 boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNTS_DOWN);
3245 contentView.setChronometerCountsDown(R.id.chronometer, countsDown);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003246 } else {
3247 contentView.setViewVisibility(R.id.time, View.VISIBLE);
3248 contentView.setLong(R.id.time, "setTime", mN.when);
3249 }
3250 }
3251 }
3252
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003253 private void bindHeaderText(RemoteViews contentView) {
3254 CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT);
3255 if (headerText == null && mStyle != null && mStyle.mSummaryTextSet
Selim Cinek03d0d652015-11-13 13:18:09 -05003256 && mStyle.hasSummaryInHeader()) {
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003257 headerText = mStyle.mSummaryText;
Selim Cinek03d0d652015-11-13 13:18:09 -05003258 }
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003259 if (headerText == null
3260 && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
3261 && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) {
3262 headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT);
3263 }
3264 if (headerText != null) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003265 // TODO: Remove the span entirely to only have the string with propper formating.
Selim Cinek0f9dd1e2016-04-05 17:03:40 -07003266 contentView.setTextViewText(R.id.header_text, processLegacyText(headerText));
3267 contentView.setViewVisibility(R.id.header_text, View.VISIBLE);
3268 contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE);
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003269 }
3270 }
3271
3272 private void bindHeaderAppName(RemoteViews contentView) {
Tony Mak4dc008c2016-03-16 10:46:49 +00003273 CharSequence appName = mContext.getPackageManager()
3274 .getApplicationLabel(mContext.getApplicationInfo());
3275
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003276 if (TextUtils.isEmpty(appName)) {
3277 return;
3278 }
3279 contentView.setTextViewText(R.id.app_name_text, appName);
Adrian Roos4ff3b122016-02-01 12:26:13 -08003280 contentView.setTextColor(R.id.app_name_text, resolveContrastColor());
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003281 }
3282
3283 private void bindSmallIcon(RemoteViews contentView) {
3284 contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon);
3285 processSmallIconColor(mN.mSmallIcon, contentView);
3286 }
3287
Jorim Jaggi445d3c02014-08-19 22:33:42 +02003288 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02003289 * @return true if the built notification will show the time or the chronometer; false
3290 * otherwise
3291 */
3292 private boolean showsTimeOrChronometer() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003293 return mN.when != 0 && mN.extras.getBoolean(EXTRA_SHOW_WHEN);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02003294 }
3295
Christoph Studerfe718432014-09-01 18:21:18 +02003296 private void resetStandardTemplateWithActions(RemoteViews big) {
Adrian Roos7052de52016-03-03 15:53:34 -08003297 big.setViewVisibility(R.id.actions_container, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02003298 big.setViewVisibility(R.id.actions, View.GONE);
Christoph Studerfe718432014-09-01 18:21:18 +02003299 big.removeAllViews(R.id.actions);
Adrian Roose458aa82015-12-08 16:17:19 -08003300
3301 big.setViewVisibility(R.id.notification_material_reply_container, View.GONE);
3302 big.setTextViewText(R.id.notification_material_reply_text_1, null);
3303
3304 big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE);
3305 big.setTextViewText(R.id.notification_material_reply_text_2, null);
3306 big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE);
3307 big.setTextViewText(R.id.notification_material_reply_text_3, null);
Christoph Studerfe718432014-09-01 18:21:18 +02003308 }
3309
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003310 private RemoteViews applyStandardTemplateWithActions(int layoutId) {
Adrian Roos48d746a2016-04-12 14:57:28 -07003311 final Bundle ex = mN.extras;
3312
3313 CharSequence title = processLegacyText(ex.getCharSequence(EXTRA_TITLE));
3314 CharSequence text = processLegacyText(ex.getCharSequence(EXTRA_TEXT));
3315 return applyStandardTemplateWithActions(layoutId, true /* hasProgress */, title, text);
3316 }
3317
3318 private RemoteViews applyStandardTemplateWithActions(int layoutId, boolean hasProgress,
3319 CharSequence title, CharSequence text) {
3320 RemoteViews big = applyStandardTemplate(layoutId, hasProgress, title, text);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003321
Christoph Studerfe718432014-09-01 18:21:18 +02003322 resetStandardTemplateWithActions(big);
3323
Adrian Roose458aa82015-12-08 16:17:19 -08003324 boolean validRemoteInput = false;
3325
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003326 int N = mActions.size();
3327 if (N > 0) {
Adrian Roos7052de52016-03-03 15:53:34 -08003328 big.setViewVisibility(R.id.actions_container, View.VISIBLE);
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003329 big.setViewVisibility(R.id.actions, View.VISIBLE);
Daniel Sandler8680bf82012-05-15 16:52:52 -04003330 if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS;
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003331 for (int i=0; i<N; i++) {
Adrian Roose458aa82015-12-08 16:17:19 -08003332 Action action = mActions.get(i);
3333 validRemoteInput |= hasValidRemoteInput(action);
3334
3335 final RemoteViews button = generateActionButton(action);
Adrian Roos9b123cf2016-02-04 14:55:57 -08003336 if (i == N - 1) {
3337 button.setViewLayoutWidth(com.android.internal.R.id.action0,
3338 ViewGroup.LayoutParams.MATCH_PARENT);
3339 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003340 big.addView(R.id.actions, button);
3341 }
3342 }
Adrian Roose458aa82015-12-08 16:17:19 -08003343
3344 CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
3345 if (validRemoteInput && replyText != null
3346 && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])) {
3347 big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE);
3348 big.setTextViewText(R.id.notification_material_reply_text_1, replyText[0]);
3349
3350 if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])) {
3351 big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE);
3352 big.setTextViewText(R.id.notification_material_reply_text_2, replyText[1]);
3353
3354 if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])) {
3355 big.setViewVisibility(
3356 R.id.notification_material_reply_text_3, View.VISIBLE);
3357 big.setTextViewText(R.id.notification_material_reply_text_3, replyText[2]);
3358 }
3359 }
3360 }
3361
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003362 return big;
3363 }
3364
Adrian Roose458aa82015-12-08 16:17:19 -08003365 private boolean hasValidRemoteInput(Action action) {
3366 if (TextUtils.isEmpty(action.title) || action.actionIntent == null) {
3367 // Weird actions
3368 return false;
3369 }
3370
3371 RemoteInput[] remoteInputs = action.getRemoteInputs();
3372 if (remoteInputs == null) {
3373 return false;
3374 }
3375
3376 for (RemoteInput r : remoteInputs) {
3377 CharSequence[] choices = r.getChoices();
3378 if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) {
3379 return true;
3380 }
3381 }
3382 return false;
3383 }
3384
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003385 /**
3386 * Construct a RemoteViews for the final 1U notification layout. In order:
3387 * 1. Custom contentView from the caller
3388 * 2. Style's proposed content view
3389 * 3. Standard template view
3390 */
Julia Reynolds3b848122016-02-26 10:45:32 -05003391 public RemoteViews createContentView() {
Selim Cinek593610c2016-02-16 18:42:57 -08003392 if (mN.contentView != null && (mStyle == null || !mStyle.displayCustomViewInline())) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003393 return mN.contentView;
3394 } else if (mStyle != null) {
3395 final RemoteViews styleView = mStyle.makeContentView();
3396 if (styleView != null) {
3397 return styleView;
3398 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003399 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003400 return applyStandardTemplate(getBaseLayoutResource());
Joe Onorato46439ce2010-11-19 13:56:21 -08003401 }
3402
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003403 /**
3404 * Construct a RemoteViews for the final big notification layout.
3405 */
Julia Reynolds3b848122016-02-26 10:45:32 -05003406 public RemoteViews createBigContentView() {
Selim Cinek850a8542015-11-11 11:48:36 -05003407 RemoteViews result = null;
Selim Cinek593610c2016-02-16 18:42:57 -08003408 if (mN.bigContentView != null
3409 && (mStyle == null || !mStyle.displayCustomViewInline())) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05003410 return mN.bigContentView;
3411 } else if (mStyle != null) {
Selim Cinek850a8542015-11-11 11:48:36 -05003412 result = mStyle.makeBigContentView();
Selim Cinek90dcf6d2015-11-18 20:24:13 -08003413 hideLine1Text(result);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08003414 } else if (mActions.size() != 0) {
3415 result = applyStandardTemplateWithActions(getBigBaseLayoutResource());
Selim Cinek850a8542015-11-11 11:48:36 -05003416 }
3417 adaptNotificationHeaderForBigContentView(result);
3418 return result;
3419 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003420
Selim Cinekeaa29ca2015-11-23 13:51:13 -08003421 /**
3422 * Construct a RemoteViews for the final notification header only
3423 *
3424 * @hide
3425 */
3426 public RemoteViews makeNotificationHeader() {
3427 RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(),
3428 R.layout.notification_template_header);
3429 resetNotificationHeader(header);
3430 bindNotificationHeader(header);
3431 return header;
3432 }
3433
Selim Cinek29603462015-11-17 19:04:39 -08003434 private void hideLine1Text(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08003435 if (result != null) {
3436 result.setViewVisibility(R.id.text_line_1, View.GONE);
3437 }
Selim Cinek29603462015-11-17 19:04:39 -08003438 }
3439
Selim Cinek850a8542015-11-11 11:48:36 -05003440 private void adaptNotificationHeaderForBigContentView(RemoteViews result) {
Selim Cinekcc10bfb2016-02-10 16:24:21 -08003441 if (result != null) {
3442 result.setBoolean(R.id.notification_header, "setExpanded", true);
3443 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003444 }
3445
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003446 /**
3447 * Construct a RemoteViews for the final heads-up notification layout.
3448 */
Julia Reynolds3b848122016-02-26 10:45:32 -05003449 public RemoteViews createHeadsUpContentView() {
Selim Cinek593610c2016-02-16 18:42:57 -08003450 if (mN.headsUpContentView != null
3451 && (mStyle == null || !mStyle.displayCustomViewInline())) {
Julia Reynolds089e3e42015-11-18 09:59:57 -05003452 return mN.headsUpContentView;
3453 } else if (mStyle != null) {
3454 final RemoteViews styleView = mStyle.makeHeadsUpContentView();
3455 if (styleView != null) {
3456 return styleView;
3457 }
3458 } else if (mActions.size() == 0) {
3459 return null;
3460 }
3461
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003462 return applyStandardTemplateWithActions(getBigBaseLayoutResource());
Chris Wren8fd39ec2014-02-27 17:43:26 -05003463 }
3464
Selim Cinek624c02db2015-12-14 21:00:02 -08003465 /**
3466 * Construct a RemoteViews for the display in public contexts like on the lockscreen.
3467 *
3468 * @hide
3469 */
3470 public RemoteViews makePublicContentView() {
3471 if (mN.publicVersion != null) {
3472 final Builder builder = recoverBuilder(mContext, mN.publicVersion);
Julia Reynolds3b848122016-02-26 10:45:32 -05003473 return builder.createContentView();
Selim Cinek624c02db2015-12-14 21:00:02 -08003474 }
3475 Bundle savedBundle = mN.extras;
3476 Style style = mStyle;
3477 mStyle = null;
3478 Icon largeIcon = mN.mLargeIcon;
3479 mN.mLargeIcon = null;
3480 Bundle publicExtras = new Bundle();
3481 publicExtras.putBoolean(EXTRA_SHOW_WHEN,
3482 savedBundle.getBoolean(EXTRA_SHOW_WHEN));
3483 publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER,
3484 savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER));
Selim Cinek81c23aa2016-02-25 16:23:13 -08003485 publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNTS_DOWN,
3486 savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNTS_DOWN));
Selim Cinek624c02db2015-12-14 21:00:02 -08003487 publicExtras.putCharSequence(EXTRA_TITLE,
3488 mContext.getString(R.string.notification_hidden_text));
3489 mN.extras = publicExtras;
3490 final RemoteViews publicView = applyStandardTemplate(getBaseLayoutResource());
3491 mN.extras = savedBundle;
3492 mN.mLargeIcon = largeIcon;
3493 mStyle = style;
3494 return publicView;
3495 }
3496
3497
Chris Wren8fd39ec2014-02-27 17:43:26 -05003498
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003499 private RemoteViews generateActionButton(Action action) {
Daniel Sandler8680bf82012-05-15 16:52:52 -04003500 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07003501 RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(),
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003502 tombstone ? getActionTombstoneLayoutResource()
3503 : getActionLayoutResource());
Dan Sandler68079d52015-07-22 10:45:30 -04003504 final Icon ai = action.getIcon();
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003505 button.setTextViewText(R.id.action0, processLegacyText(action.title));
Daniel Sandler8680bf82012-05-15 16:52:52 -04003506 if (!tombstone) {
Daniel Sandlere5518842012-05-10 16:20:40 -04003507 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
Daniel Sandlere5518842012-05-10 16:20:40 -04003508 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003509 button.setContentDescription(R.id.action0, action.title);
Adrian Roosfe84e1f2015-11-04 15:55:39 -08003510 if (action.mRemoteInputs != null) {
3511 button.setRemoteInputs(R.id.action0, action.mRemoteInputs);
3512 }
3513 if (mN.color != COLOR_DEFAULT) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08003514 button.setTextColor(R.id.action0, resolveContrastColor());
Adrian Roosfe84e1f2015-11-04 15:55:39 -08003515 }
Daniel Sandler96fd7c12012-03-30 16:37:36 -04003516 return button;
3517 }
3518
Joe Onoratocb109a02011-01-18 17:57:41 -08003519 /**
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003520 * @return Whether we are currently building a notification from a legacy (an app that
Alan Viverette3cb07a462014-06-06 14:19:53 -07003521 * doesn't create material notifications by itself) app.
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003522 */
3523 private boolean isLegacy() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003524 return getColorUtil() != null;
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003525 }
3526
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003527 private CharSequence processLegacyText(CharSequence charSequence) {
3528 if (isLegacy()) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003529 return getColorUtil().invertCharSequenceColors(charSequence);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003530 } else {
3531 return charSequence;
3532 }
3533 }
3534
Dan Sandler26e81cf2014-05-06 10:01:27 -04003535 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003536 * Apply any necessariy colors to the small icon
Dan Sandler26e81cf2014-05-06 10:01:27 -04003537 */
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003538 private void processSmallIconColor(Icon smallIcon, RemoteViews contentView) {
Selim Cinekea4bef72015-12-02 15:51:10 -08003539 boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon);
3540 if (colorable) {
Adrian Roos4ff3b122016-02-01 12:26:13 -08003541 contentView.setDrawableParameters(R.id.icon, false, -1, resolveContrastColor(),
Jorim Jaggi92df1f22014-12-16 19:44:41 +01003542 PorterDuff.Mode.SRC_ATOP, -1);
Selim Cinekea4bef72015-12-02 15:51:10 -08003543
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003544 }
Selim Cinekea4bef72015-12-02 15:51:10 -08003545 contentView.setInt(R.id.notification_header, "setOriginalIconColor",
Adrian Roos4ff3b122016-02-01 12:26:13 -08003546 colorable ? resolveContrastColor() : NotificationHeaderView.NO_COLOR);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003547 }
3548
Dan Sandler26e81cf2014-05-06 10:01:27 -04003549 /**
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003550 * Make the largeIcon dark if it's a fake smallIcon (that is,
Dan Sandler26e81cf2014-05-06 10:01:27 -04003551 * if it's grayscale).
3552 */
3553 // TODO: also check bounds, transparency, that sort of thing.
Dan Sandlerd63f9322015-05-06 15:18:49 -04003554 private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) {
3555 if (largeIcon != null && isLegacy()
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003556 && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) {
Selim Cinek65b2e7c2015-10-26 14:11:31 -07003557 // resolve color will fall back to the default when legacy
Adrian Roos4ff3b122016-02-01 12:26:13 -08003558 contentView.setDrawableParameters(R.id.icon, false, -1, resolveContrastColor(),
Dan Sandler190d58d2014-05-15 09:33:39 -04003559 PorterDuff.Mode.SRC_ATOP, -1);
Jorim Jaggi92df1f22014-12-16 19:44:41 +01003560 }
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003561 }
3562
Julia Reynolds10ee1fc2015-11-09 11:04:55 -05003563 private void sanitizeColor() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003564 if (mN.color != COLOR_DEFAULT) {
3565 mN.color |= 0xFF000000; // no alpha for custom colors
Jorim Jaggi74419312014-06-10 20:57:21 +02003566 }
Jorim Jaggi74419312014-06-10 20:57:21 +02003567 }
3568
Adrian Roos4ff3b122016-02-01 12:26:13 -08003569 int resolveContrastColor() {
3570 if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) {
3571 return mCachedContrastColor;
Dan Sandler26e81cf2014-05-06 10:01:27 -04003572 }
Adrian Roos4ff3b122016-02-01 12:26:13 -08003573 final int contrasted = NotificationColorUtil.resolveContrastColor(mContext, mN.color);
3574
3575 mCachedContrastColorIsFor = mN.color;
3576 return mCachedContrastColor = contrasted;
Dan Sandler26e81cf2014-05-06 10:01:27 -04003577 }
3578
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01003579 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003580 * Apply the unstyled operations and return a new {@link Notification} object.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04003581 * @hide
Joe Onoratocb109a02011-01-18 17:57:41 -08003582 */
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04003583 public Notification buildUnstyled() {
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003584 if (mActions.size() > 0) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003585 mN.actions = new Action[mActions.size()];
3586 mActions.toArray(mN.actions);
Daniel Sandlera0a938c2012-03-15 08:42:37 -04003587 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003588 if (!mPersonList.isEmpty()) {
3589 mN.extras.putStringArray(EXTRA_PEOPLE,
3590 mPersonList.toArray(new String[mPersonList.size()]));
Dan Sandler0bf2ed82013-12-21 23:33:41 -06003591 }
Selim Cinek247fa012016-02-18 09:50:48 -08003592 if (mN.bigContentView != null || mN.contentView != null
3593 || mN.headsUpContentView != null) {
3594 mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true);
3595 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003596 return mN;
Joe Onorato46439ce2010-11-19 13:56:21 -08003597 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003598
Julia Reynolds3b848122016-02-26 10:45:32 -05003599 /**
3600 * Creates a Builder from an existing notification so further changes can be made.
3601 * @param context The context for your application / activity.
3602 * @param n The notification to create a Builder from.
3603 */
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003604 public static Notification.Builder recoverBuilder(Context context, Notification n) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02003605 // Re-create notification context so we can access app resources.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003606 ApplicationInfo applicationInfo = n.extras.getParcelable(
3607 EXTRA_BUILDER_APPLICATION_INFO);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003608 Context builderContext;
Julia Reynoldsda303542015-11-23 14:00:20 -05003609 if (applicationInfo != null) {
3610 try {
3611 builderContext = context.createApplicationContext(applicationInfo,
3612 Context.CONTEXT_RESTRICTED);
3613 } catch (NameNotFoundException e) {
3614 Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found");
3615 builderContext = context; // try with our context
3616 }
3617 } else {
3618 builderContext = context; // try with given context
Christoph Studer4600f9b2014-07-22 22:44:43 +02003619 }
3620
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003621 return new Builder(builderContext, n);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003622 }
3623
3624 private static Class<? extends Style> getNotificationStyleClass(String templateClass) {
Selim Cinek593610c2016-02-16 18:42:57 -08003625 Class<? extends Style>[] classes = new Class[] {
3626 BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class,
Alex Hillsfc737de2016-03-23 17:33:02 -04003627 DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class,
3628 MessagingStyle.class };
Christoph Studer4600f9b2014-07-22 22:44:43 +02003629 for (Class<? extends Style> innerClass : classes) {
3630 if (templateClass.equals(innerClass.getName())) {
3631 return innerClass;
3632 }
3633 }
3634 return null;
3635 }
3636
Daniel Sandlerf45564e2013-04-15 15:05:08 -04003637 /**
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003638 * @deprecated Use {@link #build()} instead.
3639 */
3640 @Deprecated
3641 public Notification getNotification() {
3642 return build();
3643 }
3644
3645 /**
3646 * Combine all of the options that have been set and return a new {@link Notification}
3647 * object.
3648 */
3649 public Notification build() {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003650 // first, add any extras from the calling code
3651 if (mUserExtras != null) {
3652 mN.extras = getAllExtras();
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07003653 }
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003654
3655 // lazy stuff from mContext; see comment in Builder(Context, Notification)
Julia Reynoldsda303542015-11-23 14:00:20 -05003656 Notification.addFieldsFromContext(mContext, mN);
Christoph Studer943aa672014-08-03 20:31:16 +02003657
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003658 buildUnstyled();
Daniel Sandlerf45564e2013-04-15 15:05:08 -04003659
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003660 if (mStyle != null) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003661 mStyle.buildStyled(mN);
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003662 }
Daniel Sandlerf45564e2013-04-15 15:05:08 -04003663
Adrian Roos5081c0d2016-02-26 16:04:19 -08003664 if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N
3665 && (mStyle == null || !mStyle.displayCustomViewInline())) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003666 if (mN.contentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05003667 mN.contentView = createContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003668 mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT,
3669 mN.contentView.getSequenceNumber());
3670 }
3671 if (mN.bigContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05003672 mN.bigContentView = createBigContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003673 if (mN.bigContentView != null) {
3674 mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT,
3675 mN.bigContentView.getSequenceNumber());
3676 }
3677 }
3678 if (mN.headsUpContentView == null) {
Julia Reynolds3b848122016-02-26 10:45:32 -05003679 mN.headsUpContentView = createHeadsUpContentView();
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003680 if (mN.headsUpContentView != null) {
3681 mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT,
3682 mN.headsUpContentView.getSequenceNumber());
3683 }
3684 }
3685 }
3686
Julia Reynolds4c0c2022016-02-02 15:11:59 -05003687 if ((mN.defaults & DEFAULT_LIGHTS) != 0) {
3688 mN.flags |= FLAG_SHOW_LIGHTS;
3689 }
3690
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003691 return mN;
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003692 }
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05003693
3694 /**
3695 * Apply this Builder to an existing {@link Notification} object.
3696 *
3697 * @hide
3698 */
3699 public Notification buildInto(Notification n) {
Daniel Sandler1a497d32013-04-18 14:52:45 -04003700 build().cloneInto(n, true);
Daniel Sandlerbe6e7e02013-02-01 17:49:11 -05003701 return n;
3702 }
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003703
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003704 /**
Adrian Roos184bfe022016-03-03 13:41:44 -08003705 * Removes RemoteViews that were created for compatibility from {@param n}, if they did not
3706 * change.
3707 *
3708 * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}.
3709 *
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003710 * @hide
3711 */
Adrian Roos184bfe022016-03-03 13:41:44 -08003712 public static Notification maybeCloneStrippedForDelivery(Notification n) {
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003713 String templateClass = n.extras.getString(EXTRA_TEMPLATE);
Adrian Roos184bfe022016-03-03 13:41:44 -08003714
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003715 // Only strip views for known Styles because we won't know how to
3716 // re-create them otherwise.
Adrian Roos184bfe022016-03-03 13:41:44 -08003717 if (!TextUtils.isEmpty(templateClass)
3718 && getNotificationStyleClass(templateClass) == null) {
3719 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003720 }
Adrian Roos184bfe022016-03-03 13:41:44 -08003721
3722 // Only strip unmodified BuilderRemoteViews.
3723 boolean stripContentView = n.contentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003724 n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08003725 n.contentView.getSequenceNumber();
3726 boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003727 n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08003728 n.bigContentView.getSequenceNumber();
3729 boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews &&
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003730 n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) ==
Adrian Roos184bfe022016-03-03 13:41:44 -08003731 n.headsUpContentView.getSequenceNumber();
3732
3733 // Nothing to do here, no need to clone.
3734 if (!stripContentView && !stripBigContentView && !stripHeadsUpContentView) {
3735 return n;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003736 }
Adrian Roos184bfe022016-03-03 13:41:44 -08003737
3738 Notification clone = n.clone();
3739 if (stripContentView) {
3740 clone.contentView = null;
3741 clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT);
3742 }
3743 if (stripBigContentView) {
3744 clone.bigContentView = null;
3745 clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT);
3746 }
3747 if (stripHeadsUpContentView) {
3748 clone.headsUpContentView = null;
3749 clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT);
3750 }
3751 return clone;
Julia Reynoldsd4ea7412016-02-17 14:00:56 -05003752 }
3753
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003754 private int getBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003755 return R.layout.notification_template_material_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003756 }
3757
3758 private int getBigBaseLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003759 return R.layout.notification_template_material_big_base;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003760 }
3761
3762 private int getBigPictureLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003763 return R.layout.notification_template_material_big_picture;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003764 }
3765
3766 private int getBigTextLayoutResource() {
Jorim Jaggi445d3c02014-08-19 22:33:42 +02003767 return R.layout.notification_template_material_big_text;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003768 }
3769
3770 private int getInboxLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003771 return R.layout.notification_template_material_inbox;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003772 }
3773
Adrian Roosc1a80b02016-04-05 14:54:55 -07003774 private int getMessagingLayoutResource() {
3775 return R.layout.notification_template_material_messaging;
3776 }
3777
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003778 private int getActionLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003779 return R.layout.notification_material_action;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003780 }
3781
3782 private int getActionTombstoneLayoutResource() {
Alan Viverette3cb07a462014-06-06 14:19:53 -07003783 return R.layout.notification_material_action_tombstone;
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01003784 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003785 }
3786
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003787 /**
3788 * An object that can apply a rich notification style to a {@link Notification.Builder}
3789 * object.
3790 */
Griff Hazendfcb0802014-02-11 12:00:00 -08003791 public static abstract class Style {
Chris Wrend6297db2012-05-03 16:20:13 -04003792 private CharSequence mBigContentTitle;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02003793
3794 /**
3795 * @hide
3796 */
3797 protected CharSequence mSummaryText = null;
3798
3799 /**
3800 * @hide
3801 */
3802 protected boolean mSummaryTextSet = false;
Chris Wrend6297db2012-05-03 16:20:13 -04003803
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003804 protected Builder mBuilder;
3805
Chris Wrend6297db2012-05-03 16:20:13 -04003806 /**
3807 * Overrides ContentTitle in the big form of the template.
3808 * This defaults to the value passed to setContentTitle().
3809 */
3810 protected void internalSetBigContentTitle(CharSequence title) {
3811 mBigContentTitle = title;
3812 }
3813
3814 /**
3815 * Set the first line of text after the detail section in the big form of the template.
3816 */
3817 protected void internalSetSummaryText(CharSequence cs) {
3818 mSummaryText = cs;
Daniel Sandler619738c2012-06-07 16:33:08 -04003819 mSummaryTextSet = true;
Chris Wrend6297db2012-05-03 16:20:13 -04003820 }
3821
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003822 public void setBuilder(Builder builder) {
3823 if (mBuilder != builder) {
3824 mBuilder = builder;
Daniel Sandlerc08dea22012-06-28 08:35:24 -07003825 if (mBuilder != null) {
3826 mBuilder.setStyle(this);
3827 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003828 }
3829 }
3830
Chris Wrend6297db2012-05-03 16:20:13 -04003831 protected void checkBuilder() {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003832 if (mBuilder == null) {
3833 throw new IllegalArgumentException("Style requires a valid Builder object");
3834 }
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003835 }
Chris Wrend6297db2012-05-03 16:20:13 -04003836
3837 protected RemoteViews getStandardView(int layoutId) {
3838 checkBuilder();
3839
Christoph Studer4600f9b2014-07-22 22:44:43 +02003840 // Nasty.
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003841 CharSequence oldBuilderContentTitle =
3842 mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE);
Chris Wrend6297db2012-05-03 16:20:13 -04003843 if (mBigContentTitle != null) {
3844 mBuilder.setContentTitle(mBigContentTitle);
3845 }
3846
Chris Wrend6297db2012-05-03 16:20:13 -04003847 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId);
3848
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003849 mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003850
Chris Wrend6297db2012-05-03 16:20:13 -04003851 if (mBigContentTitle != null && mBigContentTitle.equals("")) {
3852 contentView.setViewVisibility(R.id.line1, View.GONE);
Chris Wren67dc9a02012-05-16 01:03:20 -04003853 } else {
3854 contentView.setViewVisibility(R.id.line1, View.VISIBLE);
Chris Wrend6297db2012-05-03 16:20:13 -04003855 }
3856
Chris Wrend6297db2012-05-03 16:20:13 -04003857 return contentView;
3858 }
3859
Daniel Sandlerf45564e2013-04-15 15:05:08 -04003860 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003861 * Construct a Style-specific RemoteViews for the final 1U notification layout.
3862 * The default implementation has nothing additional to add.
3863 * @hide
3864 */
3865 public RemoteViews makeContentView() {
3866 return null;
3867 }
3868
3869 /**
3870 * Construct a Style-specific RemoteViews for the final big notification layout.
3871 * @hide
3872 */
3873 public RemoteViews makeBigContentView() {
3874 return null;
3875 }
3876
3877 /**
3878 * Construct a Style-specific RemoteViews for the final HUN layout.
3879 * @hide
3880 */
3881 public RemoteViews makeHeadsUpContentView() {
3882 return null;
3883 }
3884
3885 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003886 * Apply any style-specific extras to this notification before shipping it out.
Daniel Sandlerf45564e2013-04-15 15:05:08 -04003887 * @hide
3888 */
3889 public void addExtras(Bundle extras) {
3890 if (mSummaryTextSet) {
3891 extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText);
3892 }
3893 if (mBigContentTitle != null) {
3894 extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle);
3895 }
Chris Wren91ad5632013-06-05 15:05:57 -04003896 extras.putString(EXTRA_TEMPLATE, this.getClass().getName());
Daniel Sandlerf45564e2013-04-15 15:05:08 -04003897 }
3898
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04003899 /**
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003900 * Reconstruct the internal state of this Style object from extras.
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04003901 * @hide
3902 */
Christoph Studer4600f9b2014-07-22 22:44:43 +02003903 protected void restoreFromExtras(Bundle extras) {
3904 if (extras.containsKey(EXTRA_SUMMARY_TEXT)) {
3905 mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT);
3906 mSummaryTextSet = true;
3907 }
3908 if (extras.containsKey(EXTRA_TITLE_BIG)) {
3909 mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG);
3910 }
3911 }
3912
3913
3914 /**
3915 * @hide
3916 */
3917 public Notification buildStyled(Notification wip) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04003918 addExtras(wip.extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02003919 return wip;
3920 }
3921
Daniel Sandler0ec46202015-06-24 01:27:05 -04003922 /**
3923 * @hide
3924 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07003925 public void purgeResources() {}
3926
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04003927 /**
3928 * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is
3929 * attached to.
3930 *
3931 * @return the fully constructed Notification.
3932 */
3933 public Notification build() {
3934 checkBuilder();
3935 return mBuilder.build();
3936 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02003937
3938 /**
3939 * @hide
3940 * @return true if the style positions the progress bar on the second line; false if the
3941 * style hides the progress bar
3942 */
3943 protected boolean hasProgress() {
3944 return true;
3945 }
Selim Cinek03d0d652015-11-13 13:18:09 -05003946
3947 /**
3948 * @hide
3949 * @return Whether we should put the summary be put into the notification header
3950 */
3951 public boolean hasSummaryInHeader() {
3952 return true;
3953 }
Selim Cinek593610c2016-02-16 18:42:57 -08003954
3955 /**
3956 * @hide
3957 * @return Whether custom content views are displayed inline in the style
3958 */
3959 public boolean displayCustomViewInline() {
3960 return false;
3961 }
Joe Onorato46439ce2010-11-19 13:56:21 -08003962 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003963
3964 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04003965 * Helper class for generating large-format notifications that include a large image attachment.
Joe Malin8d40d042012-11-05 11:36:40 -08003966 *
Robert Ly91c5ce32014-06-08 15:37:00 -07003967 * Here's how you'd set the <code>BigPictureStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003968 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07003969 * Notification notif = new Notification.Builder(mContext)
3970 * .setContentTitle(&quot;New photo from &quot; + sender.toString())
3971 * .setContentText(subject)
3972 * .setSmallIcon(R.drawable.new_post)
3973 * .setLargeIcon(aBitmap)
3974 * .setStyle(new Notification.BigPictureStyle()
3975 * .bigPicture(aBigBitmap))
3976 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003977 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08003978 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04003979 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003980 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003981 public static class BigPictureStyle extends Style {
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003982 private Bitmap mPicture;
Dan Sandlerd63f9322015-05-06 15:18:49 -04003983 private Icon mBigLargeIcon;
Chris Wren3745a3d2012-05-22 15:11:52 -04003984 private boolean mBigLargeIconSet = false;
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003985
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003986 public BigPictureStyle() {
3987 }
3988
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003989 public BigPictureStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04003990 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04003991 }
3992
Chris Wrend6297db2012-05-03 16:20:13 -04003993 /**
3994 * Overrides ContentTitle in the big form of the template.
3995 * This defaults to the value passed to setContentTitle().
3996 */
3997 public BigPictureStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04003998 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04003999 return this;
4000 }
4001
4002 /**
4003 * Set the first line of text after the detail section in the big form of the template.
4004 */
4005 public BigPictureStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004006 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04004007 return this;
4008 }
4009
Chris Wren0bd664d2012-08-01 13:56:56 -04004010 /**
4011 * Provide the bitmap to be used as the payload for the BigPicture notification.
4012 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004013 public BigPictureStyle bigPicture(Bitmap b) {
4014 mPicture = b;
4015 return this;
4016 }
4017
Chris Wren3745a3d2012-05-22 15:11:52 -04004018 /**
Chris Wren3745a3d2012-05-22 15:11:52 -04004019 * Override the large icon when the big notification is shown.
4020 */
4021 public BigPictureStyle bigLargeIcon(Bitmap b) {
Dan Sandlerd63f9322015-05-06 15:18:49 -04004022 return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null);
4023 }
4024
4025 /**
4026 * Override the large icon when the big notification is shown.
4027 */
4028 public BigPictureStyle bigLargeIcon(Icon icon) {
Chris Wren3745a3d2012-05-22 15:11:52 -04004029 mBigLargeIconSet = true;
Dan Sandlerd63f9322015-05-06 15:18:49 -04004030 mBigLargeIcon = icon;
Chris Wren3745a3d2012-05-22 15:11:52 -04004031 return this;
4032 }
4033
Riley Andrews0394a0c2015-11-03 23:36:52 -08004034 /** @hide */
4035 public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10);
4036
Daniel Sandler0ec46202015-06-24 01:27:05 -04004037 /**
4038 * @hide
4039 */
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07004040 @Override
4041 public void purgeResources() {
4042 super.purgeResources();
Riley Andrews8cee7c12015-11-01 23:36:04 -08004043 if (mPicture != null &&
4044 mPicture.isMutable() &&
Riley Andrews0394a0c2015-11-03 23:36:52 -08004045 mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) {
Jorim Jaggia0d58ae2015-06-03 11:48:13 -07004046 mPicture = mPicture.createAshmemBitmap();
4047 }
4048 if (mBigLargeIcon != null) {
4049 mBigLargeIcon.convertToAshmem();
4050 }
4051 }
Christoph Studer5c510ee2014-12-15 16:32:27 +01004052
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004053 /**
4054 * @hide
4055 */
4056 public RemoteViews makeBigContentView() {
4057 // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet
Christoph Studer5c510ee2014-12-15 16:32:27 +01004058 // This covers the following cases:
4059 // 1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004060 // mN.mLargeIcon
4061 // 2. !mBigLargeIconSet -> mN.mLargeIcon applies
Dan Sandlerd63f9322015-05-06 15:18:49 -04004062 Icon oldLargeIcon = null;
Christoph Studer5c510ee2014-12-15 16:32:27 +01004063 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004064 oldLargeIcon = mBuilder.mN.mLargeIcon;
4065 mBuilder.mN.mLargeIcon = mBigLargeIcon;
Christoph Studer5c510ee2014-12-15 16:32:27 +01004066 }
4067
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01004068 RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource());
Selim Cinek03d0d652015-11-13 13:18:09 -05004069 if (mSummaryTextSet) {
4070 contentView.setTextViewText(R.id.text, mBuilder.processLegacyText(mSummaryText));
Selim Cinekc848c3a2016-01-13 15:27:30 -08004071 contentView.setViewVisibility(R.id.text, View.VISIBLE);
Selim Cinek03d0d652015-11-13 13:18:09 -05004072 }
Selim Cinek860b6da2015-12-16 19:02:19 -08004073 mBuilder.setContentMinHeight(contentView, mBuilder.mN.mLargeIcon != null);
Selim Cinek53e64a42015-11-16 10:40:56 -08004074
Christoph Studer5c510ee2014-12-15 16:32:27 +01004075 if (mBigLargeIconSet) {
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004076 mBuilder.mN.mLargeIcon = oldLargeIcon;
Christoph Studer5c510ee2014-12-15 16:32:27 +01004077 }
4078
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004079 contentView.setImageViewBitmap(R.id.big_picture, mPicture);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004080 return contentView;
4081 }
4082
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004083 /**
4084 * @hide
4085 */
4086 public void addExtras(Bundle extras) {
4087 super.addExtras(extras);
4088
4089 if (mBigLargeIconSet) {
4090 extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon);
4091 }
4092 extras.putParcelable(EXTRA_PICTURE, mPicture);
4093 }
4094
Daniel Sandlercf1d39b2013-09-23 13:35:35 -04004095 /**
4096 * @hide
4097 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004098 @Override
Christoph Studer4600f9b2014-07-22 22:44:43 +02004099 protected void restoreFromExtras(Bundle extras) {
4100 super.restoreFromExtras(extras);
4101
4102 if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) {
Christoph Studer5c510ee2014-12-15 16:32:27 +01004103 mBigLargeIconSet = true;
Christoph Studer4600f9b2014-07-22 22:44:43 +02004104 mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG);
Chris Wren3745a3d2012-05-22 15:11:52 -04004105 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02004106 mPicture = extras.getParcelable(EXTRA_PICTURE);
4107 }
Selim Cinek03d0d652015-11-13 13:18:09 -05004108
4109 /**
4110 * @hide
4111 */
4112 @Override
4113 public boolean hasSummaryInHeader() {
4114 return false;
4115 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004116 }
4117
4118 /**
Daniel Sandler4dfbe832012-04-11 14:51:46 -04004119 * Helper class for generating large-format notifications that include a lot of text.
Joe Malin8d40d042012-11-05 11:36:40 -08004120 *
Robert Ly91c5ce32014-06-08 15:37:00 -07004121 * Here's how you'd set the <code>BigTextStyle</code> on a notification:
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004122 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07004123 * Notification notif = new Notification.Builder(mContext)
4124 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
4125 * .setContentText(subject)
4126 * .setSmallIcon(R.drawable.new_mail)
4127 * .setLargeIcon(aBitmap)
4128 * .setStyle(new Notification.BigTextStyle()
4129 * .bigText(aVeryLongString))
4130 * .build();
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004131 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08004132 *
Daniel Sandler4dfbe832012-04-11 14:51:46 -04004133 * @see Notification#bigContentView
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004134 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004135 public static class BigTextStyle extends Style {
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004136
4137 private static final int MAX_LINES = 13;
Selim Cinek3a2c4b92015-12-17 17:01:17 -08004138 private static final int LINES_CONSUMED_BY_ACTIONS = 4;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004139
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004140 private CharSequence mBigText;
4141
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004142 public BigTextStyle() {
4143 }
4144
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004145 public BigTextStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004146 setBuilder(builder);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004147 }
4148
Chris Wrend6297db2012-05-03 16:20:13 -04004149 /**
4150 * Overrides ContentTitle in the big form of the template.
4151 * This defaults to the value passed to setContentTitle().
4152 */
4153 public BigTextStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004154 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04004155 return this;
4156 }
4157
4158 /**
4159 * Set the first line of text after the detail section in the big form of the template.
4160 */
4161 public BigTextStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004162 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04004163 return this;
4164 }
4165
Chris Wren0bd664d2012-08-01 13:56:56 -04004166 /**
4167 * Provide the longer text to be displayed in the big form of the
4168 * template in place of the content text.
4169 */
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004170 public BigTextStyle bigText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004171 mBigText = safeCharSequence(cs);
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004172 return this;
4173 }
4174
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004175 /**
4176 * @hide
4177 */
4178 public void addExtras(Bundle extras) {
4179 super.addExtras(extras);
4180
Christoph Studer4600f9b2014-07-22 22:44:43 +02004181 extras.putCharSequence(EXTRA_BIG_TEXT, mBigText);
4182 }
4183
4184 /**
4185 * @hide
4186 */
4187 @Override
4188 protected void restoreFromExtras(Bundle extras) {
4189 super.restoreFromExtras(extras);
4190
4191 mBigText = extras.getCharSequence(EXTRA_BIG_TEXT);
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004192 }
4193
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004194 /**
4195 * @hide
4196 */
4197 public RemoteViews makeBigContentView() {
Christoph Studer4600f9b2014-07-22 22:44:43 +02004198
4199 // Nasty
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004200 CharSequence oldBuilderContentText =
4201 mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT);
4202 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Daniel Sandler916ad912012-06-13 12:17:07 -04004203
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01004204 RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource());
Joe Malin8d40d042012-11-05 11:36:40 -08004205
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004206 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
Christoph Studer4600f9b2014-07-22 22:44:43 +02004207
Selim Cinek3a2c4b92015-12-17 17:01:17 -08004208 CharSequence bigTextText = mBuilder.processLegacyText(mBigText);
4209 contentView.setTextViewText(R.id.big_text, bigTextText);
4210 contentView.setViewVisibility(R.id.big_text,
4211 TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE);
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004212 contentView.setInt(R.id.big_text, "setMaxLines", calculateMaxLines());
Selim Cinek4fb12d32015-11-19 18:10:48 -08004213 contentView.setBoolean(R.id.big_text, "setHasImage", mBuilder.mN.mLargeIcon != null);
4214
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004215 return contentView;
4216 }
4217
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004218 private int calculateMaxLines() {
4219 int lineCount = MAX_LINES;
4220 boolean hasActions = mBuilder.mActions.size() > 0;
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004221 if (hasActions) {
4222 lineCount -= LINES_CONSUMED_BY_ACTIONS;
4223 }
Jorim Jaggi457a10d2014-09-08 16:18:23 +02004224 return lineCount;
4225 }
Daniel Sandlerf3b73432012-03-27 15:01:25 -04004226 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04004227
4228 /**
Alex Hillsfc737de2016-03-23 17:33:02 -04004229 * Helper class for generating large-format notifications that include multiple back-and-forth
4230 * messages of varying types between any number of people.
4231 *
4232 * <br>
4233 * If the platform does not provide large-format notifications, this method has no effect. The
4234 * user will always see the normal notification view.
4235 * <br>
4236 * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like
4237 * so:
4238 * <pre class="prettyprint">
4239 *
4240 * Notification noti = new Notification.Builder()
4241 * .setContentTitle(&quot;2 new messages wtih &quot; + sender.toString())
4242 * .setContentText(subject)
4243 * .setSmallIcon(R.drawable.new_message)
4244 * .setLargeIcon(aBitmap)
4245 * .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name))
4246 * .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender())
4247 * .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender()))
4248 * .build();
4249 * </pre>
4250 */
4251 public static class MessagingStyle extends Style {
4252
4253 /**
4254 * The maximum number of messages that will be retained in the Notification itself (the
4255 * number displayed is up to the platform).
4256 */
4257 public static final int MAXIMUM_RETAINED_MESSAGES = 25;
4258
4259 CharSequence mUserDisplayName;
4260 CharSequence mConversationTitle;
4261 boolean mAllowGeneratedReplies = true;
4262 ArrayList<Message> mMessages = new ArrayList<>();
4263
4264 MessagingStyle() {
4265 }
4266
4267 /**
4268 * @param userDisplayName the name to be displayed for any replies sent by the user before the
4269 * posting app reposts the notification with those messages after they've been actually
4270 * sent and in previous messages sent by the user added in
4271 * {@link #addMessage(Notification.MessagingStyle.Message)}
4272 */
4273 public MessagingStyle(CharSequence userDisplayName) {
4274 mUserDisplayName = userDisplayName;
4275 }
4276
4277 /**
4278 * Returns the name to be displayed for any replies sent by the user
4279 */
4280 public CharSequence getUserDisplayName() {
4281 return mUserDisplayName;
4282 }
4283
4284 /**
4285 * Set whether the platform should automatically generate possible replies from messages.
4286 * @param allowGeneratedReplies {@code true} to allow generated replies, {@code false}
4287 * otherwise
4288 * @return this object for method chaining
4289 * The default value is {@code true}
4290 */
4291 public MessagingStyle setAllowGeneratedReplies(boolean allowGeneratedReplies) {
4292 mAllowGeneratedReplies = allowGeneratedReplies;
4293 return this;
4294 }
4295
4296 /**
4297 * Return whether the platform should automatically generate possible replies from messages.
4298 */
4299 public boolean getAllowGeneratedReplies() {
4300 return mAllowGeneratedReplies;
4301 }
4302
4303 /**
4304 * Sets the title to be displayed on this conversation. This should only be used for
4305 * group messaging and left unset for one-on-one conversations.
4306 * @param conversationTitle
4307 * @return this object for method chaining.
4308 */
4309 public MessagingStyle setConversationTitle(CharSequence conversationTitle) {
4310 mConversationTitle = conversationTitle;
4311 return this;
4312 }
4313
4314 /**
4315 * Return the title to be displayed on this conversation. Can be <code>null</code> and
4316 * should be for one-on-one conversations
4317 */
4318 public CharSequence getConversationTitle() {
4319 return mConversationTitle;
4320 }
4321
4322 /**
4323 * Adds a message for display by this notification. Convenience call for a simple
4324 * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}.
4325 * @param text A {@link CharSequence} to be displayed as the message content
4326 * @param timestamp Time at which the message arrived
4327 * @param sender A {@link CharSequence} to be used for displaying the name of the
4328 * sender. Should be <code>null</code> for messages by the current user, in which case
4329 * the platform will insert {@link #getUserDisplayName()}.
4330 * Should be unique amongst all individuals in the conversation, and should be
4331 * consistent during re-posts of the notification.
4332 *
4333 * @see Message#Message(CharSequence, long, CharSequence)
4334 *
4335 * @return this object for method chaining
4336 */
4337 public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) {
4338 mMessages.add(new Message(text, timestamp, sender));
4339 if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
4340 mMessages.remove(0);
4341 }
4342 return this;
4343 }
4344
4345 /**
4346 * Adds a {@link Message} for display in this notification.
4347 * @param message The {@link Message} to be displayed
4348 * @return this object for method chaining
4349 */
4350 public MessagingStyle addMessage(Message message) {
4351 mMessages.add(message);
4352 if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) {
4353 mMessages.remove(0);
4354 }
4355 return this;
4356 }
4357
4358 /**
4359 * Gets the list of {@code Message} objects that represent the notification
4360 */
4361 public List<Message> getMessages() {
4362 return mMessages;
4363 }
4364
4365 /**
4366 * @hide
4367 */
4368 @Override
4369 public void addExtras(Bundle extras) {
4370 super.addExtras(extras);
4371 if (mUserDisplayName != null) {
4372 extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUserDisplayName);
4373 }
4374 if (mConversationTitle != null) {
4375 extras.putCharSequence(EXTRA_THREAD_TITLE, mConversationTitle);
4376 }
4377 extras.putBoolean(EXTRA_ALLOW_GENERATED_REPLIES, mAllowGeneratedReplies);
4378 if (!mMessages.isEmpty()) {
4379 extras.putParcelableArrayList(EXTRA_MESSAGES, mMessages);
4380 }
4381 }
4382
4383 /**
4384 * @hide
4385 */
4386 @Override
4387 protected void restoreFromExtras(Bundle extras) {
4388 super.restoreFromExtras(extras);
4389
4390 mMessages.clear();
4391 mUserDisplayName = extras.getString(EXTRA_SELF_DISPLAY_NAME);
4392 mConversationTitle = extras.getString(EXTRA_THREAD_TITLE);
4393 mAllowGeneratedReplies = extras.getBoolean(EXTRA_ALLOW_GENERATED_REPLIES,
4394 mAllowGeneratedReplies);
4395 List<Message> messages = extras.getParcelableArrayList(EXTRA_MESSAGES);
4396 if (messages != null) {
4397 mMessages.addAll(messages);
4398 }
4399 }
4400
4401 /**
4402 * @hide
4403 */
Adrian Roosc1a80b02016-04-05 14:54:55 -07004404 @Override
4405 public RemoteViews makeContentView() {
4406 Message m = findLatestIncomingMessage();
4407 CharSequence title = mConversationTitle != null
4408 ? mConversationTitle
4409 : (m == null) ? null : m.mSender;
4410 CharSequence text = (m == null)
4411 ? null
4412 : mConversationTitle != null ? makeMessageLine(m) : m.mText;
Alex Hillsfc737de2016-03-23 17:33:02 -04004413
Adrian Roosc1a80b02016-04-05 14:54:55 -07004414 return mBuilder.applyStandardTemplate(mBuilder.getBaseLayoutResource(),
4415 false /* hasProgress */,
4416 title,
4417 text);
4418 }
4419
4420 private Message findLatestIncomingMessage() {
4421 for (int i = mMessages.size() - 1; i >= 0; i--) {
4422 Message m = mMessages.get(i);
4423 // Incoming messages have a non-empty sender.
4424 if (!TextUtils.isEmpty(m.mSender)) {
4425 return m;
4426 }
4427 }
4428 return null;
4429 }
4430
4431 /**
4432 * @hide
4433 */
4434 @Override
4435 public RemoteViews makeBigContentView() {
4436 CharSequence title = !TextUtils.isEmpty(super.mBigContentTitle)
4437 ? super.mBigContentTitle
4438 : mConversationTitle;
4439 boolean hasTitle = !TextUtils.isEmpty(title);
4440
Adrian Roos48d746a2016-04-12 14:57:28 -07004441 RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(
Adrian Roosc1a80b02016-04-05 14:54:55 -07004442 mBuilder.getMessagingLayoutResource(),
4443 false /* hasProgress */,
4444 title,
4445 null /* text */);
4446
4447 int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3,
4448 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
4449
4450 // Make sure all rows are gone in case we reuse a view.
4451 for (int rowId : rowIds) {
4452 contentView.setViewVisibility(rowId, View.GONE);
4453 }
4454
4455 int i=0;
4456 int titlePadding = mBuilder.mContext.getResources().getDimensionPixelSize(
4457 R.dimen.notification_messaging_spacing);
4458 contentView.setViewLayoutMarginBottom(R.id.line1, hasTitle ? titlePadding : 0);
4459 contentView.setInt(R.id.notification_messaging, "setNumIndentLines",
4460 mBuilder.mN.mLargeIcon == null ? 0 : (hasTitle ? 1 : 2));
4461
4462 int firstMessage = Math.max(0, mMessages.size() - rowIds.length);
4463 while (firstMessage + i < mMessages.size() && i < rowIds.length) {
4464 Message m = mMessages.get(firstMessage + i);
4465 int rowId = rowIds[i];
4466
4467 contentView.setViewVisibility(rowId, View.VISIBLE);
4468 contentView.setTextViewText(rowId, makeMessageLine(m));
4469
4470 i++;
4471 }
Alex Hillsfc737de2016-03-23 17:33:02 -04004472 return contentView;
4473 }
4474
Adrian Roosc1a80b02016-04-05 14:54:55 -07004475 private CharSequence makeMessageLine(Message m) {
4476 BidiFormatter bidi = BidiFormatter.getInstance();
4477 SpannableStringBuilder sb = new SpannableStringBuilder();
4478 if (TextUtils.isEmpty(m.mSender)) {
4479 CharSequence replyName = mUserDisplayName == null ? "" : mUserDisplayName;
4480 sb.append(bidi.unicodeWrap(replyName),
4481 makeFontColorSpan(mBuilder.resolveContrastColor()),
4482 0 /* flags */);
4483 } else {
4484 sb.append(bidi.unicodeWrap(m.mSender),
4485 makeFontColorSpan(Color.BLACK),
4486 0 /* flags */);
4487 }
4488 CharSequence text = m.mText == null ? "" : m.mText;
4489 sb.append(" ").append(bidi.unicodeWrap(text));
4490 return sb;
4491 }
4492
4493 private static TextAppearanceSpan makeFontColorSpan(int color) {
4494 return new TextAppearanceSpan(null, 0, 0,
4495 ColorStateList.valueOf(color), null);
4496 }
4497
Alex Hillsfc737de2016-03-23 17:33:02 -04004498 public static final class Message implements Parcelable {
4499
4500 private final CharSequence mText;
4501 private final long mTimestamp;
4502 private final CharSequence mSender;
4503
4504 private String mDataMimeType;
4505 private Uri mDataUri;
4506
4507 /**
4508 * Constructor
4509 * @param text A {@link CharSequence} to be displayed as the message content
4510 * @param timestamp Time at which the message arrived
4511 * @param sender A {@link CharSequence} to be used for displaying the name of the
4512 * sender. Should be <code>null</code> for messages by the current user, in which case
4513 * the platform will insert {@link MessagingStyle#getUserDisplayName()}.
4514 * Should be unique amongst all individuals in the conversation, and should be
4515 * consistent during re-posts of the notification.
4516 */
4517 public Message(CharSequence text, long timestamp, CharSequence sender){
4518 mText = text;
4519 mTimestamp = timestamp;
4520 mSender = sender;
4521 }
4522
4523 /**
4524 * Sets a binary blob of data and an associated MIME type for a message. In the case
4525 * where the platform doesn't support the MIME type, the original text provided in the
4526 * constructor will be used.
4527 * @param dataMimeType The MIME type of the content. See
4528 * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME
4529 * types on Android and Android Wear.
4530 * @param dataUri The uri containing the content whose type is given by the MIME type.
4531 * <p class="note">
4532 * <ol>
4533 * <li>Notification Listeners including the System UI need permission to access the
4534 * data the Uri points to. The recommended ways to do this are:</li>
4535 * <li>Store the data in your own ContentProvider, making sure that other apps have
4536 * the correct permission to access your provider. The preferred mechanism for
4537 * providing access is to use per-URI permissions which are temporary and only
4538 * grant access to the receiving application. An easy way to create a
4539 * ContentProvider like this is to use the FileProvider helper class.</li>
4540 * <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio
4541 * and image MIME types, however beginning with Android 3.0 (API level 11) it can
4542 * also store non-media types (see MediaStore.Files for more info). Files can be
4543 * inserted into the MediaStore using scanFile() after which a content:// style
4544 * Uri suitable for sharing is passed to the provided onScanCompleted() callback.
4545 * Note that once added to the system MediaStore the content is accessible to any
4546 * app on the device.</li>
4547 * </ol>
4548 * @return this object for method chaining
4549 */
4550 public Message setData(String dataMimeType, Uri dataUri) {
4551 mDataMimeType = dataMimeType;
4552 mDataUri = dataUri;
4553 return this;
4554 }
4555
4556 private Message(Parcel in) {
4557 if (in.readInt() != 0) {
4558 mText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
4559 } else {
4560 mText = null;
4561 }
4562 mTimestamp = in.readLong();
4563 if (in.readInt() != 0) {
4564 mSender = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in);
4565 } else {
4566 mSender = null;
4567 }
4568 if (in.readInt() != 0) {
4569 mDataMimeType = in.readString();
4570 }
4571 if (in.readInt() != 0) {
4572 mDataUri = in.readParcelable(Uri.class.getClassLoader());
4573 }
4574 }
4575
4576 /**
4577 * Get the text to be used for this message, or the fallback text if a type and content
4578 * Uri have been set
4579 */
4580 public CharSequence getText() {
4581 return mText;
4582 }
4583
4584 /**
4585 * Get the time at which this message arrived
4586 */
4587 public long getTimestamp() {
4588 return mTimestamp;
4589 }
4590
4591 /**
4592 * Get the text used to display the contact's name in the messaging experience
4593 */
4594 public CharSequence getSender() {
4595 return mSender;
4596 }
4597
4598 /**
4599 * Get the MIME type of the data pointed to by the Uri
4600 */
4601 public String getDataMimeType() {
4602 return mDataMimeType;
4603 }
4604
4605 /**
4606 * Get the the Uri pointing to the content of the message. Can be null, in which case
4607 * {@see #getText()} is used.
4608 */
4609 public Uri getDataUri() {
4610 return mDataUri;
4611 }
4612
4613 @Override
4614 public int describeContents() {
4615 return 0;
4616 }
4617
4618 @Override
4619 public void writeToParcel(Parcel out, int flags) {
4620 if (mText != null) {
4621 out.writeInt(1);
4622 TextUtils.writeToParcel(mText, out, flags);
4623 } else {
4624 out.writeInt(0);
4625 }
4626 out.writeLong(mTimestamp);
4627 if (mSender != null) {
4628 out.writeInt(1);
4629 TextUtils.writeToParcel(mSender, out, flags);
4630 } else {
4631 out.writeInt(0);
4632 }
4633 if (mDataMimeType != null) {
4634 out.writeInt(1);
4635 out.writeString(mDataMimeType);
4636 } else {
4637 out.writeInt(0);
4638 }
4639 if (mDataUri != null) {
4640 out.writeInt(1);
4641 out.writeParcelable(mDataUri, flags);
4642 } else {
4643 out.writeInt(0);
4644 }
4645 }
4646
4647 public static final Parcelable.Creator<Message> CREATOR =
4648 new Parcelable.Creator<Message>() {
4649 public Message createFromParcel(Parcel in) {
4650 return new Message(in);
4651 }
4652 public Message[] newArray(int size) {
4653 return new Message[size];
4654 }
4655 };
4656 }
4657 }
4658
4659 /**
Daniel Sandler879c5e02012-04-17 16:46:51 -04004660 * Helper class for generating large-format notifications that include a list of (up to 5) strings.
Joe Malin8d40d042012-11-05 11:36:40 -08004661 *
Robert Ly91c5ce32014-06-08 15:37:00 -07004662 * Here's how you'd set the <code>InboxStyle</code> on a notification:
Daniel Sandler879c5e02012-04-17 16:46:51 -04004663 * <pre class="prettyprint">
Robert Ly91c5ce32014-06-08 15:37:00 -07004664 * Notification notif = new Notification.Builder(mContext)
4665 * .setContentTitle(&quot;5 New mails from &quot; + sender.toString())
4666 * .setContentText(subject)
4667 * .setSmallIcon(R.drawable.new_mail)
4668 * .setLargeIcon(aBitmap)
4669 * .setStyle(new Notification.InboxStyle()
4670 * .addLine(str1)
4671 * .addLine(str2)
4672 * .setContentTitle(&quot;&quot;)
4673 * .setSummaryText(&quot;+3 more&quot;))
4674 * .build();
Daniel Sandler879c5e02012-04-17 16:46:51 -04004675 * </pre>
Joe Malin8d40d042012-11-05 11:36:40 -08004676 *
Daniel Sandler879c5e02012-04-17 16:46:51 -04004677 * @see Notification#bigContentView
4678 */
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004679 public static class InboxStyle extends Style {
Daniel Sandler879c5e02012-04-17 16:46:51 -04004680 private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5);
4681
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004682 public InboxStyle() {
4683 }
4684
Daniel Sandler879c5e02012-04-17 16:46:51 -04004685 public InboxStyle(Builder builder) {
Chris Wrenfbd96ba2012-05-01 12:03:58 -04004686 setBuilder(builder);
Daniel Sandler879c5e02012-04-17 16:46:51 -04004687 }
4688
Chris Wrend6297db2012-05-03 16:20:13 -04004689 /**
4690 * Overrides ContentTitle in the big form of the template.
4691 * This defaults to the value passed to setContentTitle().
4692 */
4693 public InboxStyle setBigContentTitle(CharSequence title) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004694 internalSetBigContentTitle(safeCharSequence(title));
Chris Wrend6297db2012-05-03 16:20:13 -04004695 return this;
4696 }
4697
4698 /**
4699 * Set the first line of text after the detail section in the big form of the template.
4700 */
4701 public InboxStyle setSummaryText(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004702 internalSetSummaryText(safeCharSequence(cs));
Chris Wrend6297db2012-05-03 16:20:13 -04004703 return this;
4704 }
4705
Chris Wren0bd664d2012-08-01 13:56:56 -04004706 /**
4707 * Append a line to the digest section of the Inbox notification.
4708 */
Daniel Sandler879c5e02012-04-17 16:46:51 -04004709 public InboxStyle addLine(CharSequence cs) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04004710 mTexts.add(safeCharSequence(cs));
Daniel Sandler879c5e02012-04-17 16:46:51 -04004711 return this;
4712 }
4713
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004714 /**
4715 * @hide
4716 */
4717 public void addExtras(Bundle extras) {
4718 super.addExtras(extras);
Christoph Studer4600f9b2014-07-22 22:44:43 +02004719
Daniel Sandlerf45564e2013-04-15 15:05:08 -04004720 CharSequence[] a = new CharSequence[mTexts.size()];
4721 extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a));
4722 }
4723
Christoph Studer4600f9b2014-07-22 22:44:43 +02004724 /**
4725 * @hide
4726 */
4727 @Override
4728 protected void restoreFromExtras(Bundle extras) {
4729 super.restoreFromExtras(extras);
4730
4731 mTexts.clear();
4732 if (extras.containsKey(EXTRA_TEXT_LINES)) {
4733 Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES));
4734 }
4735 }
4736
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004737 /**
4738 * @hide
4739 */
4740 public RemoteViews makeBigContentView() {
Selim Cinekc848c3a2016-01-13 15:27:30 -08004741 // Remove the content text so it disappears unless you have a summary
Christoph Studer4600f9b2014-07-22 22:44:43 +02004742 // Nasty
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004743 CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT);
4744 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null);
Christoph Studer4600f9b2014-07-22 22:44:43 +02004745
Jorim Jaggi39fa59f2014-02-25 15:38:45 +01004746 RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource());
Daniel Sandler619738c2012-06-07 16:33:08 -04004747
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004748 mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText);
Christoph Studer4600f9b2014-07-22 22:44:43 +02004749
Chris Wrend6297db2012-05-03 16:20:13 -04004750 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 -04004751 R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6};
Chris Wrend6297db2012-05-03 16:20:13 -04004752
Chris Wren4ed80d52012-05-17 09:30:03 -04004753 // Make sure all rows are gone in case we reuse a view.
4754 for (int rowId : rowIds) {
4755 contentView.setViewVisibility(rowId, View.GONE);
4756 }
4757
Jorim Jaggi445d3c02014-08-19 22:33:42 +02004758 final boolean largeText =
4759 mBuilder.mContext.getResources().getConfiguration().fontScale > 1f;
4760 final float subTextSize = mBuilder.mContext.getResources().getDimensionPixelSize(
4761 R.dimen.notification_subtext_size);
Daniel Sandler879c5e02012-04-17 16:46:51 -04004762 int i=0;
Selim Cinek9d9fc6e2015-11-12 15:49:14 -05004763 final float density = mBuilder.mContext.getResources().getDisplayMetrics().density;
4764 int topPadding = (int) (5 * density);
Selim Cinekc0fac722016-03-07 19:57:06 -08004765 int bottomPadding = mBuilder.mContext.getResources().getDimensionPixelSize(
4766 com.android.internal.R.dimen.notification_content_margin_bottom);
Selim Cinek247fa012016-02-18 09:50:48 -08004767 boolean first = true;
Daniel Sandler879c5e02012-04-17 16:46:51 -04004768 while (i < mTexts.size() && i < rowIds.length) {
4769 CharSequence str = mTexts.get(i);
4770 if (str != null && !str.equals("")) {
4771 contentView.setViewVisibility(rowIds[i], View.VISIBLE);
Jorim Jaggi5c2d8462014-03-21 17:37:00 +01004772 contentView.setTextViewText(rowIds[i], mBuilder.processLegacyText(str));
Jorim Jaggi445d3c02014-08-19 22:33:42 +02004773 if (largeText) {
4774 contentView.setTextViewTextSize(rowIds[i], TypedValue.COMPLEX_UNIT_PX,
4775 subTextSize);
4776 }
Selim Cinek9d9fc6e2015-11-12 15:49:14 -05004777 contentView.setViewPadding(rowIds[i], 0, topPadding, 0,
4778 i == rowIds.length - 1 || i == mTexts.size() - 1 ? bottomPadding : 0);
Selim Cinek247fa012016-02-18 09:50:48 -08004779 handleInboxImageMargin(contentView, rowIds[i], first);
4780 first = false;
Daniel Sandler879c5e02012-04-17 16:46:51 -04004781 }
4782 i++;
4783 }
Kenny Guy98193ea2014-07-24 19:54:37 +01004784
Selim Cinek1e0bf612015-11-20 15:57:26 -08004785
Daniel Sandler879c5e02012-04-17 16:46:51 -04004786 return contentView;
4787 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08004788
Selim Cinek247fa012016-02-18 09:50:48 -08004789 private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first) {
Selim Cinek1e0bf612015-11-20 15:57:26 -08004790 int endMargin = 0;
Selim Cinek247fa012016-02-18 09:50:48 -08004791 if (first) {
4792 final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0);
4793 final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE);
4794 boolean hasProgress = max != 0 || ind;
4795 if (mBuilder.mN.mLargeIcon != null && !hasProgress) {
4796 endMargin = mBuilder.mContext.getResources().getDimensionPixelSize(
4797 R.dimen.notification_content_picture_margin);
4798 }
Selim Cinek1e0bf612015-11-20 15:57:26 -08004799 }
4800 contentView.setViewLayoutMarginEnd(id, endMargin);
4801 }
Daniel Sandler879c5e02012-04-17 16:46:51 -04004802 }
Dan Sandler842dd772014-05-15 09:36:47 -04004803
4804 /**
4805 * Notification style for media playback notifications.
4806 *
4807 * In the expanded form, {@link Notification#bigContentView}, up to 5
4808 * {@link Notification.Action}s specified with
Dan Sandler86647982015-05-13 23:41:13 -04004809 * {@link Notification.Builder#addAction(Action) addAction} will be
Dan Sandler842dd772014-05-15 09:36:47 -04004810 * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
4811 * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be
4812 * treated as album artwork.
4813 *
4814 * Unlike the other styles provided here, MediaStyle can also modify the standard-size
4815 * {@link Notification#contentView}; by providing action indices to
Christoph Studerfde6f4d2014-12-12 13:23:26 +01004816 * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed
Dan Sandler842dd772014-05-15 09:36:47 -04004817 * in the standard view alongside the usual content.
4818 *
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01004819 * Notifications created with MediaStyle will have their category set to
4820 * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different
4821 * category using {@link Notification.Builder#setCategory(String) setCategory()}.
4822 *
Jeff Browndba34ba2014-06-24 20:46:03 -07004823 * Finally, if you attach a {@link android.media.session.MediaSession.Token} using
4824 * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)},
Dan Sandler842dd772014-05-15 09:36:47 -04004825 * the System UI can identify this as a notification representing an active media session
4826 * and respond accordingly (by showing album artwork in the lockscreen, for example).
4827 *
4828 * To use this style with your Notification, feed it to
4829 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
4830 * <pre class="prettyprint">
4831 * Notification noti = new Notification.Builder()
4832 * .setSmallIcon(R.drawable.ic_stat_player)
Christoph Studere935fe92014-11-24 14:18:06 +01004833 * .setContentTitle(&quot;Track title&quot;)
4834 * .setContentText(&quot;Artist - Album&quot;)
4835 * .setLargeIcon(albumArtBitmap))
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01004836 * .setStyle(<b>new Notification.MediaStyle()</b>
4837 * .setMediaSession(mySession))
Dan Sandler842dd772014-05-15 09:36:47 -04004838 * .build();
4839 * </pre>
4840 *
4841 * @see Notification#bigContentView
4842 */
4843 public static class MediaStyle extends Style {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004844 static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3;
Dan Sandler842dd772014-05-15 09:36:47 -04004845 static final int MAX_MEDIA_BUTTONS = 5;
4846
4847 private int[] mActionsToShowInCompact = null;
Jeff Browndba34ba2014-06-24 20:46:03 -07004848 private MediaSession.Token mToken;
Dan Sandler842dd772014-05-15 09:36:47 -04004849
4850 public MediaStyle() {
4851 }
4852
4853 public MediaStyle(Builder builder) {
4854 setBuilder(builder);
4855 }
4856
4857 /**
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004858 * 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 -04004859 * notification view.
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004860 *
4861 * @param actions the indices of the actions to show in the compact notification view
Dan Sandler842dd772014-05-15 09:36:47 -04004862 */
4863 public MediaStyle setShowActionsInCompactView(int...actions) {
4864 mActionsToShowInCompact = actions;
4865 return this;
4866 }
4867
4868 /**
Jeff Browndba34ba2014-06-24 20:46:03 -07004869 * Attach a {@link android.media.session.MediaSession.Token} to this Notification
4870 * to provide additional playback information and control to the SystemUI.
Dan Sandler842dd772014-05-15 09:36:47 -04004871 */
Jeff Browndba34ba2014-06-24 20:46:03 -07004872 public MediaStyle setMediaSession(MediaSession.Token token) {
Dan Sandler842dd772014-05-15 09:36:47 -04004873 mToken = token;
4874 return this;
4875 }
4876
Christoph Studer4600f9b2014-07-22 22:44:43 +02004877 /**
4878 * @hide
4879 */
Dan Sandler842dd772014-05-15 09:36:47 -04004880 @Override
4881 public Notification buildStyled(Notification wip) {
Christoph Studer4600f9b2014-07-22 22:44:43 +02004882 super.buildStyled(wip);
Bryan Mawhinney6be8de32014-07-18 10:35:12 +01004883 if (wip.category == null) {
4884 wip.category = Notification.CATEGORY_TRANSPORT;
4885 }
Dan Sandler842dd772014-05-15 09:36:47 -04004886 return wip;
4887 }
4888
Christoph Studer4600f9b2014-07-22 22:44:43 +02004889 /**
4890 * @hide
4891 */
4892 @Override
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004893 public RemoteViews makeContentView() {
4894 return makeMediaContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02004895 }
4896
4897 /**
4898 * @hide
4899 */
4900 @Override
Julia Reynoldsd9228f12015-10-20 10:37:27 -04004901 public RemoteViews makeBigContentView() {
4902 return makeMediaBigContentView();
Christoph Studer4600f9b2014-07-22 22:44:43 +02004903 }
4904
Selim Cinekcc10bfb2016-02-10 16:24:21 -08004905 /**
4906 * @hide
4907 */
4908 @Override
4909 public RemoteViews makeHeadsUpContentView() {
4910 RemoteViews expanded = makeMediaBigContentView();
4911 return expanded != null ? expanded : makeMediaContentView();
4912 }
4913
Dan Sandler842dd772014-05-15 09:36:47 -04004914 /** @hide */
4915 @Override
4916 public void addExtras(Bundle extras) {
4917 super.addExtras(extras);
4918
4919 if (mToken != null) {
4920 extras.putParcelable(EXTRA_MEDIA_SESSION, mToken);
4921 }
Bryan Mawhinneye191f902014-07-22 12:50:09 +01004922 if (mActionsToShowInCompact != null) {
4923 extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact);
4924 }
Dan Sandler842dd772014-05-15 09:36:47 -04004925 }
4926
Christoph Studer4600f9b2014-07-22 22:44:43 +02004927 /**
4928 * @hide
4929 */
4930 @Override
4931 protected void restoreFromExtras(Bundle extras) {
4932 super.restoreFromExtras(extras);
4933
4934 if (extras.containsKey(EXTRA_MEDIA_SESSION)) {
4935 mToken = extras.getParcelable(EXTRA_MEDIA_SESSION);
4936 }
4937 if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) {
4938 mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS);
4939 }
4940 }
4941
Selim Cinek5bf069a2015-11-10 19:14:27 -05004942 private RemoteViews generateMediaActionButton(Action action, int color) {
Dan Sandler842dd772014-05-15 09:36:47 -04004943 final boolean tombstone = (action.actionIntent == null);
Selim Cinekf33b1112015-07-15 17:45:11 -07004944 RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(),
Alan Viverette3cb07a462014-06-06 14:19:53 -07004945 R.layout.notification_material_media_action);
Dan Sandler68079d52015-07-22 10:45:30 -04004946 button.setImageViewIcon(R.id.action0, action.getIcon());
Selim Cinek5bf069a2015-11-10 19:14:27 -05004947 button.setDrawableParameters(R.id.action0, false, -1, color, PorterDuff.Mode.SRC_ATOP,
4948 -1);
Dan Sandler842dd772014-05-15 09:36:47 -04004949 if (!tombstone) {
4950 button.setOnClickPendingIntent(R.id.action0, action.actionIntent);
4951 }
4952 button.setContentDescription(R.id.action0, action.title);
4953 return button;
4954 }
4955
4956 private RemoteViews makeMediaContentView() {
4957 RemoteViews view = mBuilder.applyStandardTemplate(
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004958 R.layout.notification_template_material_media, false /* hasProgress */);
Dan Sandler842dd772014-05-15 09:36:47 -04004959
4960 final int numActions = mBuilder.mActions.size();
4961 final int N = mActionsToShowInCompact == null
4962 ? 0
4963 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
4964 if (N > 0) {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004965 view.removeAllViews(com.android.internal.R.id.media_actions);
Dan Sandler842dd772014-05-15 09:36:47 -04004966 for (int i = 0; i < N; i++) {
4967 if (i >= numActions) {
4968 throw new IllegalArgumentException(String.format(
4969 "setShowActionsInCompactView: action %d out of bounds (max %d)",
4970 i, numActions - 1));
4971 }
4972
4973 final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]);
Selim Cinek5bf069a2015-11-10 19:14:27 -05004974 final RemoteViews button = generateMediaActionButton(action,
Adrian Roos4ff3b122016-02-01 12:26:13 -08004975 mBuilder.resolveContrastColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004976 view.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04004977 }
4978 }
Selim Cinekfdc738f2016-01-27 20:04:27 -08004979 handleImage(view);
4980 // handle the content margin
Selim Cinek247fa012016-02-18 09:50:48 -08004981 int endMargin = mBuilder.mContext.getResources().getDimensionPixelSize(
4982 R.dimen.notification_content_margin_end);;
Selim Cinekfdc738f2016-01-27 20:04:27 -08004983 if (mBuilder.mN.mLargeIcon != null) {
Selim Cinek247fa012016-02-18 09:50:48 -08004984 endMargin += mBuilder.mContext.getResources().getDimensionPixelSize(
4985 R.dimen.notification_content_picture_margin);
Selim Cinekfdc738f2016-01-27 20:04:27 -08004986 }
4987 view.setViewLayoutMarginEnd(R.id.notification_main_column, endMargin);
Dan Sandler842dd772014-05-15 09:36:47 -04004988 return view;
4989 }
4990
4991 private RemoteViews makeMediaBigContentView() {
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02004992 final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS);
Selim Cinekcc10bfb2016-02-10 16:24:21 -08004993 // Dont add an expanded view if there is no more content to be revealed
4994 int actionsInCompact = mActionsToShowInCompact == null
4995 ? 0
4996 : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT);
4997 if (mBuilder.mN.mLargeIcon == null && actionCount <= actionsInCompact) {
4998 return null;
4999 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05005000 RemoteViews big = mBuilder.applyStandardTemplate(
5001 R.layout.notification_template_material_big_media,
5002 false);
Dan Sandler842dd772014-05-15 09:36:47 -04005003
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005004 if (actionCount > 0) {
5005 big.removeAllViews(com.android.internal.R.id.media_actions);
5006 for (int i = 0; i < actionCount; i++) {
Selim Cinek5bf069a2015-11-10 19:14:27 -05005007 final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i),
Adrian Roos4ff3b122016-02-01 12:26:13 -08005008 mBuilder.resolveContrastColor());
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005009 big.addView(com.android.internal.R.id.media_actions, button);
Dan Sandler842dd772014-05-15 09:36:47 -04005010 }
5011 }
Selim Cinek5bf069a2015-11-10 19:14:27 -05005012 handleImage(big);
Dan Sandler842dd772014-05-15 09:36:47 -04005013 return big;
5014 }
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005015
Selim Cinek5bf069a2015-11-10 19:14:27 -05005016 private void handleImage(RemoteViews contentView) {
5017 if (mBuilder.mN.mLargeIcon != null) {
5018 contentView.setViewLayoutMarginEnd(R.id.line1, 0);
Selim Cinekc848c3a2016-01-13 15:27:30 -08005019 contentView.setViewLayoutMarginEnd(R.id.text, 0);
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005020 }
5021 }
5022
Jorim Jaggi17ee3ec2014-08-29 03:47:31 +02005023 /**
5024 * @hide
5025 */
5026 @Override
5027 protected boolean hasProgress() {
5028 return false;
5029 }
Dan Sandler842dd772014-05-15 09:36:47 -04005030 }
Griff Hazen61a9e862014-05-22 16:05:19 -07005031
Selim Cinek593610c2016-02-16 18:42:57 -08005032 /**
5033 * Notification style for custom views that are decorated by the system
5034 *
5035 * <p>Instead of providing a notification that is completely custom, a developer can set this
5036 * style and still obtain system decorations like the notification header with the expand
5037 * affordance and actions.
5038 *
5039 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
5040 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
5041 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
5042 * corresponding custom views to display.
5043 *
5044 * To use this style with your Notification, feed it to
5045 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
5046 * <pre class="prettyprint">
5047 * Notification noti = new Notification.Builder()
5048 * .setSmallIcon(R.drawable.ic_stat_player)
5049 * .setLargeIcon(albumArtBitmap))
5050 * .setCustomContentView(contentView);
5051 * .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>)
5052 * .build();
5053 * </pre>
5054 */
5055 public static class DecoratedCustomViewStyle extends Style {
5056
5057 public DecoratedCustomViewStyle() {
5058 }
5059
5060 public DecoratedCustomViewStyle(Builder builder) {
5061 setBuilder(builder);
5062 }
5063
5064 /**
5065 * @hide
5066 */
5067 public boolean displayCustomViewInline() {
5068 return true;
5069 }
5070
5071 /**
5072 * @hide
5073 */
5074 @Override
5075 public RemoteViews makeContentView() {
5076 return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView);
5077 }
5078
5079 /**
5080 * @hide
5081 */
5082 @Override
5083 public RemoteViews makeBigContentView() {
5084 return makeDecoratedBigContentView();
5085 }
5086
5087 /**
5088 * @hide
5089 */
5090 @Override
5091 public RemoteViews makeHeadsUpContentView() {
5092 return makeDecoratedHeadsUpContentView();
5093 }
5094
Selim Cinek593610c2016-02-16 18:42:57 -08005095 private RemoteViews makeDecoratedHeadsUpContentView() {
5096 RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null
5097 ? mBuilder.mN.contentView
5098 : mBuilder.mN.headsUpContentView;
5099 if (mBuilder.mActions.size() == 0) {
5100 return makeStandardTemplateWithCustomContent(headsUpContentView);
5101 }
5102 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
5103 mBuilder.getBigBaseLayoutResource());
Selim Cinek247fa012016-02-18 09:50:48 -08005104 buildIntoRemoteViewContent(remoteViews, headsUpContentView);
Selim Cinek593610c2016-02-16 18:42:57 -08005105 return remoteViews;
5106 }
5107
Selim Cinek593610c2016-02-16 18:42:57 -08005108 private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) {
5109 RemoteViews remoteViews = mBuilder.applyStandardTemplate(
5110 mBuilder.getBaseLayoutResource());
Selim Cinek247fa012016-02-18 09:50:48 -08005111 buildIntoRemoteViewContent(remoteViews, customContent);
Selim Cinek593610c2016-02-16 18:42:57 -08005112 return remoteViews;
5113 }
5114
Selim Cinek593610c2016-02-16 18:42:57 -08005115 private RemoteViews makeDecoratedBigContentView() {
5116 RemoteViews bigContentView = mBuilder.mN.bigContentView == null
5117 ? mBuilder.mN.contentView
5118 : mBuilder.mN.bigContentView;
5119 if (mBuilder.mActions.size() == 0) {
5120 return makeStandardTemplateWithCustomContent(bigContentView);
5121 }
5122 RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions(
5123 mBuilder.getBigBaseLayoutResource());
Selim Cinek247fa012016-02-18 09:50:48 -08005124 buildIntoRemoteViewContent(remoteViews, bigContentView);
Selim Cinek593610c2016-02-16 18:42:57 -08005125 return remoteViews;
5126 }
Selim Cinek247fa012016-02-18 09:50:48 -08005127
5128 private void buildIntoRemoteViewContent(RemoteViews remoteViews,
5129 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08005130 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07005131 // Need to clone customContent before adding, because otherwise it can no longer be
5132 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08005133 customContent = customContent.clone();
Selim Cinekf91017e2016-03-14 12:25:09 -07005134 remoteViews.removeAllViews(R.id.notification_main_column);
5135 remoteViews.addView(R.id.notification_main_column, customContent);
Adrian Roos5081c0d2016-02-26 16:04:19 -08005136 }
Selim Cinek247fa012016-02-18 09:50:48 -08005137 // also update the end margin if there is an image
5138 int endMargin = mBuilder.mContext.getResources().getDimensionPixelSize(
5139 R.dimen.notification_content_margin_end);
5140 if (mBuilder.mN.mLargeIcon != null) {
5141 endMargin += mBuilder.mContext.getResources().getDimensionPixelSize(
5142 R.dimen.notification_content_picture_margin);
5143 }
5144 remoteViews.setViewLayoutMarginEnd(R.id.notification_main_column, endMargin);
5145 }
Selim Cinek593610c2016-02-16 18:42:57 -08005146 }
5147
Selim Cinek03eb3b72016-02-18 10:39:45 -08005148 /**
5149 * Notification style for media custom views that are decorated by the system
5150 *
5151 * <p>Instead of providing a media notification that is completely custom, a developer can set
5152 * this style and still obtain system decorations like the notification header with the expand
5153 * affordance and actions.
5154 *
5155 * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)},
5156 * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and
5157 * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the
5158 * corresponding custom views to display.
5159 *
5160 * To use this style with your Notification, feed it to
5161 * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so:
5162 * <pre class="prettyprint">
5163 * Notification noti = new Notification.Builder()
5164 * .setSmallIcon(R.drawable.ic_stat_player)
5165 * .setLargeIcon(albumArtBitmap))
5166 * .setCustomContentView(contentView);
5167 * .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b>
5168 * .setMediaSession(mySession))
5169 * .build();
5170 * </pre>
5171 *
5172 * @see android.app.Notification.DecoratedCustomViewStyle
5173 * @see android.app.Notification.MediaStyle
5174 */
5175 public static class DecoratedMediaCustomViewStyle extends MediaStyle {
5176
5177 public DecoratedMediaCustomViewStyle() {
5178 }
5179
5180 public DecoratedMediaCustomViewStyle(Builder builder) {
5181 setBuilder(builder);
5182 }
5183
5184 /**
5185 * @hide
5186 */
5187 public boolean displayCustomViewInline() {
5188 return true;
5189 }
5190
5191 /**
5192 * @hide
5193 */
5194 @Override
5195 public RemoteViews makeContentView() {
5196 RemoteViews remoteViews = super.makeContentView();
5197 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
5198 mBuilder.mN.contentView);
5199 }
5200
5201 /**
5202 * @hide
5203 */
5204 @Override
5205 public RemoteViews makeBigContentView() {
5206 RemoteViews customRemoteView = mBuilder.mN.bigContentView != null
5207 ? mBuilder.mN.bigContentView
5208 : mBuilder.mN.contentView;
5209 return makeBigContentViewWithCustomContent(customRemoteView);
5210 }
5211
5212 private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) {
5213 RemoteViews remoteViews = super.makeBigContentView();
5214 if (remoteViews != null) {
5215 return buildIntoRemoteView(remoteViews, R.id.notification_main_column,
5216 customRemoteView);
5217 } else if (customRemoteView != mBuilder.mN.contentView){
5218 remoteViews = super.makeContentView();
5219 return buildIntoRemoteView(remoteViews, R.id.notification_content_container,
5220 customRemoteView);
5221 } else {
5222 return null;
5223 }
5224 }
5225
5226 /**
5227 * @hide
5228 */
5229 @Override
5230 public RemoteViews makeHeadsUpContentView() {
5231 RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null
5232 ? mBuilder.mN.headsUpContentView
5233 : mBuilder.mN.contentView;
5234 return makeBigContentViewWithCustomContent(customRemoteView);
5235 }
5236
5237 private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id,
5238 RemoteViews customContent) {
Adrian Roos5081c0d2016-02-26 16:04:19 -08005239 if (customContent != null) {
Selim Cinekf91017e2016-03-14 12:25:09 -07005240 // Need to clone customContent before adding, because otherwise it can no longer be
5241 // parceled independently of remoteViews.
Adrian Roos5081c0d2016-02-26 16:04:19 -08005242 customContent = customContent.clone();
Selim Cinekf91017e2016-03-14 12:25:09 -07005243 remoteViews.removeAllViews(id);
5244 remoteViews.addView(id, customContent);
Adrian Roos5081c0d2016-02-26 16:04:19 -08005245 }
Selim Cinek03eb3b72016-02-18 10:39:45 -08005246 return remoteViews;
5247 }
5248 }
5249
Christoph Studer4600f9b2014-07-22 22:44:43 +02005250 // When adding a new Style subclass here, don't forget to update
5251 // Builder.getNotificationStyleClass.
5252
Griff Hazen61a9e862014-05-22 16:05:19 -07005253 /**
5254 * Extender interface for use with {@link Builder#extend}. Extenders may be used to add
5255 * metadata or change options on a notification builder.
5256 */
5257 public interface Extender {
5258 /**
5259 * Apply this extender to a notification builder.
5260 * @param builder the builder to be modified.
5261 * @return the build object for chaining.
5262 */
5263 public Builder extend(Builder builder);
5264 }
5265
5266 /**
5267 * Helper class to add wearable extensions to notifications.
5268 * <p class="note"> See
5269 * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications
5270 * for Android Wear</a> for more information on how to use this class.
5271 * <p>
5272 * To create a notification with wearable extensions:
5273 * <ol>
5274 * <li>Create a {@link android.app.Notification.Builder}, setting any desired
5275 * properties.
5276 * <li>Create a {@link android.app.Notification.WearableExtender}.
5277 * <li>Set wearable-specific properties using the
5278 * {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}.
5279 * <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a
5280 * notification.
5281 * <li>Post the notification to the notification system with the
5282 * {@code NotificationManager.notify(...)} methods.
5283 * </ol>
5284 *
5285 * <pre class="prettyprint">
5286 * Notification notif = new Notification.Builder(mContext)
5287 * .setContentTitle(&quot;New mail from &quot; + sender.toString())
5288 * .setContentText(subject)
5289 * .setSmallIcon(R.drawable.new_mail)
5290 * .extend(new Notification.WearableExtender()
5291 * .setContentIcon(R.drawable.new_mail))
5292 * .build();
5293 * NotificationManager notificationManger =
5294 * (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
5295 * notificationManger.notify(0, notif);</pre>
5296 *
5297 * <p>Wearable extensions can be accessed on an existing notification by using the
5298 * {@code WearableExtender(Notification)} constructor,
5299 * and then using the {@code get} methods to access values.
5300 *
5301 * <pre class="prettyprint">
5302 * Notification.WearableExtender wearableExtender = new Notification.WearableExtender(
5303 * notification);
Griff Hazen14f57992014-05-26 09:07:14 -07005304 * List&lt;Notification&gt; pages = wearableExtender.getPages();</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07005305 */
5306 public static final class WearableExtender implements Extender {
5307 /**
5308 * Sentinel value for an action index that is unset.
5309 */
5310 public static final int UNSET_ACTION_INDEX = -1;
5311
5312 /**
5313 * Size value for use with {@link #setCustomSizePreset} to show this notification with
5314 * default sizing.
5315 * <p>For custom display notifications created using {@link #setDisplayIntent},
Paul Soulosaa4f4bf2015-08-04 11:59:45 -07005316 * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based
Griff Hazen61a9e862014-05-22 16:05:19 -07005317 * on their content.
5318 */
5319 public static final int SIZE_DEFAULT = 0;
5320
5321 /**
5322 * Size value for use with {@link #setCustomSizePreset} to show this notification
5323 * with an extra small size.
5324 * <p>This value is only applicable for custom display notifications created using
5325 * {@link #setDisplayIntent}.
5326 */
5327 public static final int SIZE_XSMALL = 1;
5328
5329 /**
5330 * Size value for use with {@link #setCustomSizePreset} to show this notification
5331 * with a small size.
5332 * <p>This value is only applicable for custom display notifications created using
5333 * {@link #setDisplayIntent}.
5334 */
5335 public static final int SIZE_SMALL = 2;
5336
5337 /**
5338 * Size value for use with {@link #setCustomSizePreset} to show this notification
5339 * with a medium size.
5340 * <p>This value is only applicable for custom display notifications created using
5341 * {@link #setDisplayIntent}.
5342 */
5343 public static final int SIZE_MEDIUM = 3;
5344
5345 /**
5346 * Size value for use with {@link #setCustomSizePreset} to show this notification
5347 * with a large size.
5348 * <p>This value is only applicable for custom display notifications created using
5349 * {@link #setDisplayIntent}.
5350 */
5351 public static final int SIZE_LARGE = 4;
5352
Griff Hazend5f11f92014-05-27 15:40:09 -07005353 /**
5354 * Size value for use with {@link #setCustomSizePreset} to show this notification
5355 * full screen.
5356 * <p>This value is only applicable for custom display notifications created using
5357 * {@link #setDisplayIntent}.
5358 */
5359 public static final int SIZE_FULL_SCREEN = 5;
5360
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005361 /**
5362 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a
5363 * short amount of time when this notification is displayed on the screen. This
5364 * is the default value.
5365 */
5366 public static final int SCREEN_TIMEOUT_SHORT = 0;
5367
5368 /**
5369 * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on
5370 * for a longer amount of time when this notification is displayed on the screen.
5371 */
5372 public static final int SCREEN_TIMEOUT_LONG = -1;
5373
Griff Hazen61a9e862014-05-22 16:05:19 -07005374 /** Notification extra which contains wearable extensions */
5375 private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS";
5376
Pete Gastaf6781d2014-10-07 15:17:05 -04005377 // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options.
Griff Hazen61a9e862014-05-22 16:05:19 -07005378 private static final String KEY_ACTIONS = "actions";
5379 private static final String KEY_FLAGS = "flags";
5380 private static final String KEY_DISPLAY_INTENT = "displayIntent";
5381 private static final String KEY_PAGES = "pages";
5382 private static final String KEY_BACKGROUND = "background";
5383 private static final String KEY_CONTENT_ICON = "contentIcon";
5384 private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity";
5385 private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex";
5386 private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset";
5387 private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight";
5388 private static final String KEY_GRAVITY = "gravity";
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005389 private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout";
Griff Hazen61a9e862014-05-22 16:05:19 -07005390
5391 // Flags bitwise-ored to mFlags
5392 private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1;
5393 private static final int FLAG_HINT_HIDE_ICON = 1 << 1;
5394 private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2;
5395 private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005396 private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4;
Alex Hills4bcb06b2016-04-05 14:26:25 -04005397 private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5;
Alex Hills9ab3a232016-04-05 14:54:56 -04005398 private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6;
Griff Hazen61a9e862014-05-22 16:05:19 -07005399
5400 // Default value for flags integer
5401 private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE;
5402
5403 private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END;
5404 private static final int DEFAULT_GRAVITY = Gravity.BOTTOM;
5405
5406 private ArrayList<Action> mActions = new ArrayList<Action>();
5407 private int mFlags = DEFAULT_FLAGS;
5408 private PendingIntent mDisplayIntent;
5409 private ArrayList<Notification> mPages = new ArrayList<Notification>();
5410 private Bitmap mBackground;
5411 private int mContentIcon;
5412 private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY;
5413 private int mContentActionIndex = UNSET_ACTION_INDEX;
5414 private int mCustomSizePreset = SIZE_DEFAULT;
5415 private int mCustomContentHeight;
5416 private int mGravity = DEFAULT_GRAVITY;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005417 private int mHintScreenTimeout;
Griff Hazen61a9e862014-05-22 16:05:19 -07005418
5419 /**
5420 * Create a {@link android.app.Notification.WearableExtender} with default
5421 * options.
5422 */
5423 public WearableExtender() {
5424 }
5425
5426 public WearableExtender(Notification notif) {
5427 Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS);
5428 if (wearableBundle != null) {
5429 List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS);
5430 if (actions != null) {
5431 mActions.addAll(actions);
5432 }
5433
5434 mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS);
5435 mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT);
5436
5437 Notification[] pages = getNotificationArrayFromBundle(
5438 wearableBundle, KEY_PAGES);
5439 if (pages != null) {
5440 Collections.addAll(mPages, pages);
5441 }
5442
5443 mBackground = wearableBundle.getParcelable(KEY_BACKGROUND);
5444 mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON);
5445 mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY,
5446 DEFAULT_CONTENT_ICON_GRAVITY);
5447 mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX,
5448 UNSET_ACTION_INDEX);
5449 mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET,
5450 SIZE_DEFAULT);
5451 mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT);
5452 mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY);
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005453 mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT);
Griff Hazen61a9e862014-05-22 16:05:19 -07005454 }
5455 }
5456
5457 /**
5458 * Apply wearable extensions to a notification that is being built. This is typically
5459 * called by the {@link android.app.Notification.Builder#extend} method of
5460 * {@link android.app.Notification.Builder}.
5461 */
5462 @Override
5463 public Notification.Builder extend(Notification.Builder builder) {
5464 Bundle wearableBundle = new Bundle();
5465
5466 if (!mActions.isEmpty()) {
5467 wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions);
5468 }
5469 if (mFlags != DEFAULT_FLAGS) {
5470 wearableBundle.putInt(KEY_FLAGS, mFlags);
5471 }
5472 if (mDisplayIntent != null) {
5473 wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent);
5474 }
5475 if (!mPages.isEmpty()) {
5476 wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray(
5477 new Notification[mPages.size()]));
5478 }
5479 if (mBackground != null) {
5480 wearableBundle.putParcelable(KEY_BACKGROUND, mBackground);
5481 }
5482 if (mContentIcon != 0) {
5483 wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon);
5484 }
5485 if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) {
5486 wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity);
5487 }
5488 if (mContentActionIndex != UNSET_ACTION_INDEX) {
5489 wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX,
5490 mContentActionIndex);
5491 }
5492 if (mCustomSizePreset != SIZE_DEFAULT) {
5493 wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset);
5494 }
5495 if (mCustomContentHeight != 0) {
5496 wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight);
5497 }
5498 if (mGravity != DEFAULT_GRAVITY) {
5499 wearableBundle.putInt(KEY_GRAVITY, mGravity);
5500 }
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005501 if (mHintScreenTimeout != 0) {
5502 wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout);
5503 }
Griff Hazen61a9e862014-05-22 16:05:19 -07005504
5505 builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle);
5506 return builder;
5507 }
5508
5509 @Override
5510 public WearableExtender clone() {
5511 WearableExtender that = new WearableExtender();
5512 that.mActions = new ArrayList<Action>(this.mActions);
5513 that.mFlags = this.mFlags;
5514 that.mDisplayIntent = this.mDisplayIntent;
5515 that.mPages = new ArrayList<Notification>(this.mPages);
5516 that.mBackground = this.mBackground;
5517 that.mContentIcon = this.mContentIcon;
5518 that.mContentIconGravity = this.mContentIconGravity;
5519 that.mContentActionIndex = this.mContentActionIndex;
5520 that.mCustomSizePreset = this.mCustomSizePreset;
5521 that.mCustomContentHeight = this.mCustomContentHeight;
5522 that.mGravity = this.mGravity;
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005523 that.mHintScreenTimeout = this.mHintScreenTimeout;
Griff Hazen61a9e862014-05-22 16:05:19 -07005524 return that;
5525 }
5526
5527 /**
5528 * Add a wearable action to this notification.
5529 *
5530 * <p>When wearable actions are added using this method, the set of actions that
5531 * show on a wearable device splits from devices that only show actions added
5532 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
5533 * of which actions display on different devices.
5534 *
5535 * @param action the action to add to this notification
5536 * @return this object for method chaining
5537 * @see android.app.Notification.Action
5538 */
5539 public WearableExtender addAction(Action action) {
5540 mActions.add(action);
5541 return this;
5542 }
5543
5544 /**
5545 * Adds wearable actions to this notification.
5546 *
5547 * <p>When wearable actions are added using this method, the set of actions that
5548 * show on a wearable device splits from devices that only show actions added
5549 * using {@link android.app.Notification.Builder#addAction}. This allows for customization
5550 * of which actions display on different devices.
5551 *
5552 * @param actions the actions to add to this notification
5553 * @return this object for method chaining
5554 * @see android.app.Notification.Action
5555 */
5556 public WearableExtender addActions(List<Action> actions) {
5557 mActions.addAll(actions);
5558 return this;
5559 }
5560
5561 /**
5562 * Clear all wearable actions present on this builder.
5563 * @return this object for method chaining.
5564 * @see #addAction
5565 */
5566 public WearableExtender clearActions() {
5567 mActions.clear();
5568 return this;
5569 }
5570
5571 /**
5572 * Get the wearable actions present on this notification.
5573 */
5574 public List<Action> getActions() {
5575 return mActions;
5576 }
5577
5578 /**
5579 * Set an intent to launch inside of an activity view when displaying
Griff Hazen14f57992014-05-26 09:07:14 -07005580 * this notification. The {@link PendingIntent} provided should be for an activity.
5581 *
5582 * <pre class="prettyprint">
5583 * Intent displayIntent = new Intent(context, MyDisplayActivity.class);
5584 * PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
5585 * 0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
5586 * Notification notif = new Notification.Builder(context)
5587 * .extend(new Notification.WearableExtender()
5588 * .setDisplayIntent(displayPendingIntent)
5589 * .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM))
5590 * .build();</pre>
5591 *
5592 * <p>The activity to launch needs to allow embedding, must be exported, and
Griff Hazen831ca9d2014-06-17 00:38:38 -07005593 * should have an empty task affinity. It is also recommended to use the device
5594 * default light theme.
Griff Hazen14f57992014-05-26 09:07:14 -07005595 *
5596 * <p>Example AndroidManifest.xml entry:
5597 * <pre class="prettyprint">
5598 * &lt;activity android:name=&quot;com.example.MyDisplayActivity&quot;
5599 * android:exported=&quot;true&quot;
5600 * android:allowEmbedded=&quot;true&quot;
Griff Hazen831ca9d2014-06-17 00:38:38 -07005601 * android:taskAffinity=&quot;&quot;
5602 * android:theme=&quot;@android:style/Theme.DeviceDefault.Light&quot; /&gt;</pre>
Griff Hazen61a9e862014-05-22 16:05:19 -07005603 *
5604 * @param intent the {@link PendingIntent} for an activity
5605 * @return this object for method chaining
5606 * @see android.app.Notification.WearableExtender#getDisplayIntent
5607 */
5608 public WearableExtender setDisplayIntent(PendingIntent intent) {
5609 mDisplayIntent = intent;
5610 return this;
5611 }
5612
5613 /**
5614 * Get the intent to launch inside of an activity view when displaying this
5615 * notification. This {@code PendingIntent} should be for an activity.
5616 */
5617 public PendingIntent getDisplayIntent() {
5618 return mDisplayIntent;
5619 }
5620
5621 /**
5622 * Add an additional page of content to display with this notification. The current
5623 * notification forms the first page, and pages added using this function form
5624 * subsequent pages. This field can be used to separate a notification into multiple
5625 * sections.
5626 *
5627 * @param page the notification to add as another page
5628 * @return this object for method chaining
5629 * @see android.app.Notification.WearableExtender#getPages
5630 */
5631 public WearableExtender addPage(Notification page) {
5632 mPages.add(page);
5633 return this;
5634 }
5635
5636 /**
5637 * Add additional pages of content to display with this notification. The current
5638 * notification forms the first page, and pages added using this function form
5639 * subsequent pages. This field can be used to separate a notification into multiple
5640 * sections.
5641 *
5642 * @param pages a list of notifications
5643 * @return this object for method chaining
5644 * @see android.app.Notification.WearableExtender#getPages
5645 */
5646 public WearableExtender addPages(List<Notification> pages) {
5647 mPages.addAll(pages);
5648 return this;
5649 }
5650
5651 /**
5652 * Clear all additional pages present on this builder.
5653 * @return this object for method chaining.
5654 * @see #addPage
5655 */
5656 public WearableExtender clearPages() {
5657 mPages.clear();
5658 return this;
5659 }
5660
5661 /**
5662 * Get the array of additional pages of content for displaying this notification. The
5663 * current notification forms the first page, and elements within this array form
5664 * subsequent pages. This field can be used to separate a notification into multiple
5665 * sections.
5666 * @return the pages for this notification
5667 */
5668 public List<Notification> getPages() {
5669 return mPages;
5670 }
5671
5672 /**
5673 * Set a background image to be displayed behind the notification content.
5674 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
5675 * will work with any notification style.
5676 *
5677 * @param background the background bitmap
5678 * @return this object for method chaining
5679 * @see android.app.Notification.WearableExtender#getBackground
5680 */
5681 public WearableExtender setBackground(Bitmap background) {
5682 mBackground = background;
5683 return this;
5684 }
5685
5686 /**
5687 * Get a background image to be displayed behind the notification content.
5688 * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background
5689 * will work with any notification style.
5690 *
5691 * @return the background image
5692 * @see android.app.Notification.WearableExtender#setBackground
5693 */
5694 public Bitmap getBackground() {
5695 return mBackground;
5696 }
5697
5698 /**
5699 * Set an icon that goes with the content of this notification.
5700 */
5701 public WearableExtender setContentIcon(int icon) {
5702 mContentIcon = icon;
5703 return this;
5704 }
5705
5706 /**
5707 * Get an icon that goes with the content of this notification.
5708 */
5709 public int getContentIcon() {
5710 return mContentIcon;
5711 }
5712
5713 /**
5714 * Set the gravity that the content icon should have within the notification display.
5715 * Supported values include {@link android.view.Gravity#START} and
5716 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
5717 * @see #setContentIcon
5718 */
5719 public WearableExtender setContentIconGravity(int contentIconGravity) {
5720 mContentIconGravity = contentIconGravity;
5721 return this;
5722 }
5723
5724 /**
5725 * Get the gravity that the content icon should have within the notification display.
5726 * Supported values include {@link android.view.Gravity#START} and
5727 * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}.
5728 * @see #getContentIcon
5729 */
5730 public int getContentIconGravity() {
5731 return mContentIconGravity;
5732 }
5733
5734 /**
5735 * Set an action from this notification's actions to be clickable with the content of
Griff Hazen14f57992014-05-26 09:07:14 -07005736 * this notification. This action will no longer display separately from the
5737 * notification's content.
5738 *
Griff Hazenca48d352014-05-28 22:37:13 -07005739 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07005740 * set, although the list of available actions comes from the main notification and not
5741 * from the child page's notification.
5742 *
5743 * @param actionIndex The index of the action to hoist onto the current notification page.
5744 * If wearable actions were added to the main notification, this index
5745 * will apply to that list, otherwise it will apply to the regular
5746 * actions list.
Griff Hazen61a9e862014-05-22 16:05:19 -07005747 */
5748 public WearableExtender setContentAction(int actionIndex) {
5749 mContentActionIndex = actionIndex;
5750 return this;
5751 }
5752
5753 /**
Griff Hazenca48d352014-05-28 22:37:13 -07005754 * Get the index of the notification action, if any, that was specified as being clickable
5755 * with the content of this notification. This action will no longer display separately
Griff Hazen14f57992014-05-26 09:07:14 -07005756 * from the notification's content.
Griff Hazen61a9e862014-05-22 16:05:19 -07005757 *
Griff Hazenca48d352014-05-28 22:37:13 -07005758 * <p>For notifications with multiple pages, child pages can also have content actions
Griff Hazen14f57992014-05-26 09:07:14 -07005759 * set, although the list of available actions comes from the main notification and not
5760 * from the child page's notification.
5761 *
5762 * <p>If wearable specific actions were added to the main notification, this index will
5763 * apply to that list, otherwise it will apply to the regular actions list.
Griff Hazenca48d352014-05-28 22:37:13 -07005764 *
5765 * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected.
Griff Hazen61a9e862014-05-22 16:05:19 -07005766 */
5767 public int getContentAction() {
5768 return mContentActionIndex;
5769 }
5770
5771 /**
5772 * Set the gravity that this notification should have within the available viewport space.
5773 * Supported values include {@link android.view.Gravity#TOP},
5774 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
5775 * The default value is {@link android.view.Gravity#BOTTOM}.
5776 */
5777 public WearableExtender setGravity(int gravity) {
5778 mGravity = gravity;
5779 return this;
5780 }
5781
5782 /**
5783 * Get the gravity that this notification should have within the available viewport space.
5784 * Supported values include {@link android.view.Gravity#TOP},
5785 * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}.
5786 * The default value is {@link android.view.Gravity#BOTTOM}.
5787 */
5788 public int getGravity() {
5789 return mGravity;
5790 }
5791
5792 /**
5793 * Set the custom size preset for the display of this notification out of the available
5794 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
5795 * {@link #SIZE_LARGE}.
5796 * <p>Some custom size presets are only applicable for custom display notifications created
5797 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the
5798 * documentation for the preset in question. See also
5799 * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}.
5800 */
5801 public WearableExtender setCustomSizePreset(int sizePreset) {
5802 mCustomSizePreset = sizePreset;
5803 return this;
5804 }
5805
5806 /**
5807 * Get the custom size preset for the display of this notification out of the available
5808 * presets found in {@link android.app.Notification.WearableExtender}, e.g.
5809 * {@link #SIZE_LARGE}.
5810 * <p>Some custom size presets are only applicable for custom display notifications created
5811 * using {@link #setDisplayIntent}. Check the documentation for the preset in question.
5812 * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}.
5813 */
5814 public int getCustomSizePreset() {
5815 return mCustomSizePreset;
5816 }
5817
5818 /**
5819 * Set the custom height in pixels for the display of this notification's content.
5820 * <p>This option is only available for custom display notifications created
5821 * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also
5822 * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and
5823 * {@link #getCustomContentHeight}.
5824 */
5825 public WearableExtender setCustomContentHeight(int height) {
5826 mCustomContentHeight = height;
5827 return this;
5828 }
5829
5830 /**
5831 * Get the custom height in pixels for the display of this notification's content.
5832 * <p>This option is only available for custom display notifications created
5833 * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and
5834 * {@link #setCustomContentHeight}.
5835 */
5836 public int getCustomContentHeight() {
5837 return mCustomContentHeight;
5838 }
5839
5840 /**
5841 * Set whether the scrolling position for the contents of this notification should start
5842 * at the bottom of the contents instead of the top when the contents are too long to
5843 * display within the screen. Default is false (start scroll at the top).
5844 */
5845 public WearableExtender setStartScrollBottom(boolean startScrollBottom) {
5846 setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom);
5847 return this;
5848 }
5849
5850 /**
5851 * Get whether the scrolling position for the contents of this notification should start
5852 * at the bottom of the contents instead of the top when the contents are too long to
5853 * display within the screen. Default is false (start scroll at the top).
5854 */
5855 public boolean getStartScrollBottom() {
5856 return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0;
5857 }
5858
5859 /**
5860 * Set whether the content intent is available when the wearable device is not connected
5861 * to a companion device. The user can still trigger this intent when the wearable device
5862 * is offline, but a visual hint will indicate that the content intent may not be available.
5863 * Defaults to true.
5864 */
5865 public WearableExtender setContentIntentAvailableOffline(
5866 boolean contentIntentAvailableOffline) {
5867 setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline);
5868 return this;
5869 }
5870
5871 /**
5872 * Get whether the content intent is available when the wearable device is not connected
5873 * to a companion device. The user can still trigger this intent when the wearable device
5874 * is offline, but a visual hint will indicate that the content intent may not be available.
5875 * Defaults to true.
5876 */
5877 public boolean getContentIntentAvailableOffline() {
5878 return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0;
5879 }
5880
5881 /**
5882 * Set a hint that this notification's icon should not be displayed.
5883 * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise.
5884 * @return this object for method chaining
5885 */
5886 public WearableExtender setHintHideIcon(boolean hintHideIcon) {
5887 setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon);
5888 return this;
5889 }
5890
5891 /**
5892 * Get a hint that this notification's icon should not be displayed.
5893 * @return {@code true} if this icon should not be displayed, false otherwise.
5894 * The default value is {@code false} if this was never set.
5895 */
5896 public boolean getHintHideIcon() {
5897 return (mFlags & FLAG_HINT_HIDE_ICON) != 0;
5898 }
5899
5900 /**
5901 * Set a visual hint that only the background image of this notification should be
5902 * displayed, and other semantic content should be hidden. This hint is only applicable
5903 * to sub-pages added using {@link #addPage}.
5904 */
5905 public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) {
5906 setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly);
5907 return this;
5908 }
5909
5910 /**
5911 * Get a visual hint that only the background image of this notification should be
5912 * displayed, and other semantic content should be hidden. This hint is only applicable
5913 * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}.
5914 */
5915 public boolean getHintShowBackgroundOnly() {
5916 return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0;
5917 }
5918
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005919 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08005920 * Set a hint that this notification's background should not be clipped if possible,
5921 * and should instead be resized to fully display on the screen, retaining the aspect
5922 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005923 * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
5924 * @return this object for method chaining
5925 */
5926 public WearableExtender setHintAvoidBackgroundClipping(
5927 boolean hintAvoidBackgroundClipping) {
5928 setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping);
5929 return this;
5930 }
5931
5932 /**
Griff Hazen9c5be4e2014-11-17 17:47:50 -08005933 * Get a hint that this notification's background should not be clipped if possible,
5934 * and should instead be resized to fully display on the screen, retaining the aspect
5935 * ratio of the image. This can be useful for images like barcodes or qr codes.
Griff Hazen5f2edfc2014-09-29 16:28:44 -07005936 * @return {@code true} if it's ok if the background is clipped on the screen, false
5937 * otherwise. The default value is {@code false} if this was never set.
5938 */
5939 public boolean getHintAvoidBackgroundClipping() {
5940 return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0;
5941 }
5942
5943 /**
5944 * Set a hint that the screen should remain on for at least this duration when
5945 * this notification is displayed on the screen.
5946 * @param timeout The requested screen timeout in milliseconds. Can also be either
5947 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
5948 * @return this object for method chaining
5949 */
5950 public WearableExtender setHintScreenTimeout(int timeout) {
5951 mHintScreenTimeout = timeout;
5952 return this;
5953 }
5954
5955 /**
5956 * Get the duration, in milliseconds, that the screen should remain on for
5957 * when this notification is displayed.
5958 * @return the duration in milliseconds if > 0, or either one of the sentinel values
5959 * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}.
5960 */
5961 public int getHintScreenTimeout() {
5962 return mHintScreenTimeout;
5963 }
5964
Alex Hills9ab3a232016-04-05 14:54:56 -04005965 /**
Alex Hills4bcb06b2016-04-05 14:26:25 -04005966 * Set a hint that this notification's {@link BigPictureStyle} (if present) should be
5967 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
5968 * qr codes, as well as other simple black-and-white tickets.
5969 * @param hintAmbientBigPicture {@code true} to enable converstion and ambient.
5970 * @return this object for method chaining
5971 */
5972 public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) {
5973 setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture);
5974 return this;
5975 }
5976
5977 /**
5978 * Get a hint that this notification's {@link BigPictureStyle} (if present) should be
5979 * converted to low-bit and displayed in ambient mode, especially useful for barcodes and
5980 * qr codes, as well as other simple black-and-white tickets.
5981 * @return {@code true} if it should be displayed in ambient, false otherwise
5982 * otherwise. The default value is {@code false} if this was never set.
5983 */
5984 public boolean getHintAmbientBigPicture() {
5985 return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0;
5986 }
5987
5988 /**
Alex Hills9ab3a232016-04-05 14:54:56 -04005989 * Set a hint that this notification's content intent will launch an {@link Activity}
5990 * directly, telling the platform that it can generate the appropriate transitions.
5991 * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch
5992 * an activity and transitions should be generated, false otherwise.
5993 * @return this object for method chaining
5994 */
5995 public WearableExtender setHintContentIntentLaunchesActivity(
5996 boolean hintContentIntentLaunchesActivity) {
5997 setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity);
5998 return this;
5999 }
6000
6001 /**
6002 * Get a hint that this notification's content intent will launch an {@link Activity}
6003 * directly, telling the platform that it can generate the appropriate transitions
6004 * @return {@code true} if the content intent will launch an activity and transitions should
6005 * be generated, false otherwise. The default value is {@code false} if this was never set.
6006 */
6007 public boolean getHintContentIntentLaunchesActivity() {
6008 return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0;
6009 }
6010
Griff Hazen61a9e862014-05-22 16:05:19 -07006011 private void setFlag(int mask, boolean value) {
6012 if (value) {
6013 mFlags |= mask;
6014 } else {
6015 mFlags &= ~mask;
6016 }
6017 }
6018 }
6019
6020 /**
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08006021 * <p>Helper class to add Android Auto extensions to notifications. To create a notification
6022 * with car extensions:
6023 *
6024 * <ol>
6025 * <li>Create an {@link Notification.Builder}, setting any desired
6026 * properties.
6027 * <li>Create a {@link CarExtender}.
6028 * <li>Set car-specific properties using the {@code add} and {@code set} methods of
6029 * {@link CarExtender}.
6030 * <li>Call {@link Notification.Builder#extend(Notification.Extender)}
6031 * to apply the extensions to a notification.
6032 * </ol>
6033 *
6034 * <pre class="prettyprint">
6035 * Notification notification = new Notification.Builder(context)
6036 * ...
6037 * .extend(new CarExtender()
6038 * .set*(...))
6039 * .build();
6040 * </pre>
6041 *
6042 * <p>Car extensions can be accessed on an existing notification by using the
6043 * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods
6044 * to access values.
6045 */
6046 public static final class CarExtender implements Extender {
6047 private static final String TAG = "CarExtender";
6048
6049 private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS";
6050 private static final String EXTRA_LARGE_ICON = "large_icon";
6051 private static final String EXTRA_CONVERSATION = "car_conversation";
6052 private static final String EXTRA_COLOR = "app_color";
6053
6054 private Bitmap mLargeIcon;
6055 private UnreadConversation mUnreadConversation;
6056 private int mColor = Notification.COLOR_DEFAULT;
6057
6058 /**
6059 * Create a {@link CarExtender} with default options.
6060 */
6061 public CarExtender() {
6062 }
6063
6064 /**
6065 * Create a {@link CarExtender} from the CarExtender options of an existing Notification.
6066 *
6067 * @param notif The notification from which to copy options.
6068 */
6069 public CarExtender(Notification notif) {
6070 Bundle carBundle = notif.extras == null ?
6071 null : notif.extras.getBundle(EXTRA_CAR_EXTENDER);
6072 if (carBundle != null) {
6073 mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON);
6074 mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT);
6075
6076 Bundle b = carBundle.getBundle(EXTRA_CONVERSATION);
6077 mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b);
6078 }
6079 }
6080
6081 /**
6082 * Apply car extensions to a notification that is being built. This is typically called by
6083 * the {@link Notification.Builder#extend(Notification.Extender)}
6084 * method of {@link Notification.Builder}.
6085 */
6086 @Override
6087 public Notification.Builder extend(Notification.Builder builder) {
6088 Bundle carExtensions = new Bundle();
6089
6090 if (mLargeIcon != null) {
6091 carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon);
6092 }
6093 if (mColor != Notification.COLOR_DEFAULT) {
6094 carExtensions.putInt(EXTRA_COLOR, mColor);
6095 }
6096
6097 if (mUnreadConversation != null) {
6098 Bundle b = mUnreadConversation.getBundleForUnreadConversation();
6099 carExtensions.putBundle(EXTRA_CONVERSATION, b);
6100 }
6101
6102 builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions);
6103 return builder;
6104 }
6105
6106 /**
6107 * Sets the accent color to use when Android Auto presents the notification.
6108 *
6109 * Android Auto uses the color set with {@link Notification.Builder#setColor(int)}
6110 * to accent the displayed notification. However, not all colors are acceptable in an
6111 * automotive setting. This method can be used to override the color provided in the
6112 * notification in such a situation.
6113 */
Tor Norbye80756e32015-03-02 09:39:27 -08006114 public CarExtender setColor(@ColorInt int color) {
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08006115 mColor = color;
6116 return this;
6117 }
6118
6119 /**
6120 * Gets the accent color.
6121 *
Julia Reynoldsd9228f12015-10-20 10:37:27 -04006122 * @see #setColor
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08006123 */
Tor Norbye80756e32015-03-02 09:39:27 -08006124 @ColorInt
Zhen Yu Song9d5528b2014-11-14 15:34:39 -08006125 public int getColor() {
6126 return mColor;
6127 }
6128
6129 /**
6130 * Sets the large icon of the car notification.
6131 *
6132 * If no large icon is set in the extender, Android Auto will display the icon
6133 * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)}
6134 *
6135 * @param largeIcon The large icon to use in the car notification.
6136 * @return This object for method chaining.
6137 */
6138 public CarExtender setLargeIcon(Bitmap largeIcon) {
6139 mLargeIcon = largeIcon;
6140 return this;
6141 }
6142
6143 /**
6144 * Gets the large icon used in this car notification, or null if no icon has been set.
6145 *
6146 * @return The large icon for the car notification.
6147 * @see CarExtender#setLargeIcon
6148 */
6149 public Bitmap getLargeIcon() {
6150 return mLargeIcon;
6151 }
6152
6153 /**
6154 * Sets the unread conversation in a message notification.
6155 *
6156 * @param unreadConversation The unread part of the conversation this notification conveys.
6157 * @return This object for method chaining.
6158 */
6159 public CarExtender setUnreadConversation(UnreadConversation unreadConversation) {
6160 mUnreadConversation = unreadConversation;
6161 return this;
6162 }
6163
6164 /**
6165 * Returns the unread conversation conveyed by this notification.
6166 * @see #setUnreadConversation(UnreadConversation)
6167 */
6168 public UnreadConversation getUnreadConversation() {
6169 return mUnreadConversation;
6170 }
6171
6172 /**
6173 * A class which holds the unread messages from a conversation.
6174 */
6175 public static class UnreadConversation {
6176 private static final String KEY_AUTHOR = "author";
6177 private static final String KEY_TEXT = "text";
6178 private static final String KEY_MESSAGES = "messages";
6179 private static final String KEY_REMOTE_INPUT = "remote_input";
6180 private static final String KEY_ON_REPLY = "on_reply";
6181 private static final String KEY_ON_READ = "on_read";
6182 private static final String KEY_PARTICIPANTS = "participants";
6183 private static final String KEY_TIMESTAMP = "timestamp";
6184
6185 private final String[] mMessages;
6186 private final RemoteInput mRemoteInput;
6187 private final PendingIntent mReplyPendingIntent;
6188 private final PendingIntent mReadPendingIntent;
6189 private final String[] mParticipants;
6190 private final long mLatestTimestamp;
6191
6192 UnreadConversation(String[] messages, RemoteInput remoteInput,
6193 PendingIntent replyPendingIntent, PendingIntent readPendingIntent,
6194 String[] participants, long latestTimestamp) {
6195 mMessages = messages;
6196 mRemoteInput = remoteInput;
6197 mReadPendingIntent = readPendingIntent;
6198 mReplyPendingIntent = replyPendingIntent;
6199 mParticipants = participants;
6200 mLatestTimestamp = latestTimestamp;
6201 }
6202
6203 /**
6204 * Gets the list of messages conveyed by this notification.
6205 */
6206 public String[] getMessages() {
6207 return mMessages;
6208 }
6209
6210 /**
6211 * Gets the remote input that will be used to convey the response to a message list, or
6212 * null if no such remote input exists.
6213 */
6214 public RemoteInput getRemoteInput() {
6215 return mRemoteInput;
6216 }
6217
6218 /**
6219 * Gets the pending intent that will be triggered when the user replies to this
6220 * notification.
6221 */
6222 public PendingIntent getReplyPendingIntent() {
6223 return mReplyPendingIntent;
6224 }
6225
6226 /**
6227 * Gets the pending intent that Android Auto will send after it reads aloud all messages
6228 * in this object's message list.
6229 */
6230 public PendingIntent getReadPendingIntent() {
6231 return mReadPendingIntent;
6232 }
6233
6234 /**
6235 * Gets the participants in the conversation.
6236 */
6237 public String[] getParticipants() {
6238 return mParticipants;
6239 }
6240
6241 /**
6242 * Gets the firs participant in the conversation.
6243 */
6244 public String getParticipant() {
6245 return mParticipants.length > 0 ? mParticipants[0] : null;
6246 }
6247
6248 /**
6249 * Gets the timestamp of the conversation.
6250 */
6251 public long getLatestTimestamp() {
6252 return mLatestTimestamp;
6253 }
6254
6255 Bundle getBundleForUnreadConversation() {
6256 Bundle b = new Bundle();
6257 String author = null;
6258 if (mParticipants != null && mParticipants.length > 1) {
6259 author = mParticipants[0];
6260 }
6261 Parcelable[] messages = new Parcelable[mMessages.length];
6262 for (int i = 0; i < messages.length; i++) {
6263 Bundle m = new Bundle();
6264 m.putString(KEY_TEXT, mMessages[i]);
6265 m.putString(KEY_AUTHOR, author);
6266 messages[i] = m;
6267 }
6268 b.putParcelableArray(KEY_MESSAGES, messages);
6269 if (mRemoteInput != null) {
6270 b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput);
6271 }
6272 b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent);
6273 b.putParcelable(KEY_ON_READ, mReadPendingIntent);
6274 b.putStringArray(KEY_PARTICIPANTS, mParticipants);
6275 b.putLong(KEY_TIMESTAMP, mLatestTimestamp);
6276 return b;
6277 }
6278
6279 static UnreadConversation getUnreadConversationFromBundle(Bundle b) {
6280 if (b == null) {
6281 return null;
6282 }
6283 Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES);
6284 String[] messages = null;
6285 if (parcelableMessages != null) {
6286 String[] tmp = new String[parcelableMessages.length];
6287 boolean success = true;
6288 for (int i = 0; i < tmp.length; i++) {
6289 if (!(parcelableMessages[i] instanceof Bundle)) {
6290 success = false;
6291 break;
6292 }
6293 tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT);
6294 if (tmp[i] == null) {
6295 success = false;
6296 break;
6297 }
6298 }
6299 if (success) {
6300 messages = tmp;
6301 } else {
6302 return null;
6303 }
6304 }
6305
6306 PendingIntent onRead = b.getParcelable(KEY_ON_READ);
6307 PendingIntent onReply = b.getParcelable(KEY_ON_REPLY);
6308
6309 RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT);
6310
6311 String[] participants = b.getStringArray(KEY_PARTICIPANTS);
6312 if (participants == null || participants.length != 1) {
6313 return null;
6314 }
6315
6316 return new UnreadConversation(messages,
6317 remoteInput,
6318 onReply,
6319 onRead,
6320 participants, b.getLong(KEY_TIMESTAMP));
6321 }
6322 };
6323
6324 /**
6325 * Builder class for {@link CarExtender.UnreadConversation} objects.
6326 */
6327 public static class Builder {
6328 private final List<String> mMessages = new ArrayList<String>();
6329 private final String mParticipant;
6330 private RemoteInput mRemoteInput;
6331 private PendingIntent mReadPendingIntent;
6332 private PendingIntent mReplyPendingIntent;
6333 private long mLatestTimestamp;
6334
6335 /**
6336 * Constructs a new builder for {@link CarExtender.UnreadConversation}.
6337 *
6338 * @param name The name of the other participant in the conversation.
6339 */
6340 public Builder(String name) {
6341 mParticipant = name;
6342 }
6343
6344 /**
6345 * Appends a new unread message to the list of messages for this conversation.
6346 *
6347 * The messages should be added from oldest to newest.
6348 *
6349 * @param message The text of the new unread message.
6350 * @return This object for method chaining.
6351 */
6352 public Builder addMessage(String message) {
6353 mMessages.add(message);
6354 return this;
6355 }
6356
6357 /**
6358 * Sets the pending intent and remote input which will convey the reply to this
6359 * notification.
6360 *
6361 * @param pendingIntent The pending intent which will be triggered on a reply.
6362 * @param remoteInput The remote input parcelable which will carry the reply.
6363 * @return This object for method chaining.
6364 *
6365 * @see CarExtender.UnreadConversation#getRemoteInput
6366 * @see CarExtender.UnreadConversation#getReplyPendingIntent
6367 */
6368 public Builder setReplyAction(
6369 PendingIntent pendingIntent, RemoteInput remoteInput) {
6370 mRemoteInput = remoteInput;
6371 mReplyPendingIntent = pendingIntent;
6372
6373 return this;
6374 }
6375
6376 /**
6377 * Sets the pending intent that will be sent once the messages in this notification
6378 * are read.
6379 *
6380 * @param pendingIntent The pending intent to use.
6381 * @return This object for method chaining.
6382 */
6383 public Builder setReadPendingIntent(PendingIntent pendingIntent) {
6384 mReadPendingIntent = pendingIntent;
6385 return this;
6386 }
6387
6388 /**
6389 * Sets the timestamp of the most recent message in an unread conversation.
6390 *
6391 * If a messaging notification has been posted by your application and has not
6392 * yet been cancelled, posting a later notification with the same id and tag
6393 * but without a newer timestamp may result in Android Auto not displaying a
6394 * heads up notification for the later notification.
6395 *
6396 * @param timestamp The timestamp of the most recent message in the conversation.
6397 * @return This object for method chaining.
6398 */
6399 public Builder setLatestTimestamp(long timestamp) {
6400 mLatestTimestamp = timestamp;
6401 return this;
6402 }
6403
6404 /**
6405 * Builds a new unread conversation object.
6406 *
6407 * @return The new unread conversation object.
6408 */
6409 public UnreadConversation build() {
6410 String[] messages = mMessages.toArray(new String[mMessages.size()]);
6411 String[] participants = { mParticipant };
6412 return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent,
6413 mReadPendingIntent, participants, mLatestTimestamp);
6414 }
6415 }
6416 }
6417
6418 /**
Griff Hazen61a9e862014-05-22 16:05:19 -07006419 * Get an array of Notification objects from a parcelable array bundle field.
6420 * Update the bundle to have a typed array so fetches in the future don't need
6421 * to do an array copy.
6422 */
6423 private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) {
6424 Parcelable[] array = bundle.getParcelableArray(key);
6425 if (array instanceof Notification[] || array == null) {
6426 return (Notification[]) array;
6427 }
6428 Notification[] typedArray = Arrays.copyOf(array, array.length,
6429 Notification[].class);
6430 bundle.putParcelableArray(key, typedArray);
6431 return typedArray;
6432 }
Christoph Studer4600f9b2014-07-22 22:44:43 +02006433
6434 private static class BuilderRemoteViews extends RemoteViews {
6435 public BuilderRemoteViews(Parcel parcel) {
6436 super(parcel);
6437 }
6438
Kenny Guy77320062014-08-27 21:37:15 +01006439 public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) {
6440 super(appInfo, layoutId);
Christoph Studer4600f9b2014-07-22 22:44:43 +02006441 }
6442
6443 @Override
6444 public BuilderRemoteViews clone() {
6445 Parcel p = Parcel.obtain();
6446 writeToParcel(p, 0);
6447 p.setDataPosition(0);
6448 BuilderRemoteViews brv = new BuilderRemoteViews(p);
6449 p.recycle();
6450 return brv;
6451 }
6452 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006453}