| /* |
| * Copyright (C) 2007 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.app; |
| |
| import android.annotation.ColorInt; |
| import android.annotation.DrawableRes; |
| import android.annotation.IntDef; |
| import android.annotation.SdkConstant; |
| import android.annotation.SdkConstant.SdkConstantType; |
| import android.annotation.SystemApi; |
| import android.content.Context; |
| import android.content.Intent; |
| import android.content.pm.ApplicationInfo; |
| import android.content.pm.PackageManager; |
| import android.content.pm.PackageManager.NameNotFoundException; |
| import android.content.res.ColorStateList; |
| import android.graphics.Bitmap; |
| import android.graphics.Canvas; |
| import android.graphics.Color; |
| import android.graphics.PorterDuff; |
| import android.graphics.drawable.Drawable; |
| import android.graphics.drawable.Icon; |
| import android.media.AudioAttributes; |
| import android.media.AudioManager; |
| import android.media.session.MediaSession; |
| import android.net.Uri; |
| import android.os.BadParcelableException; |
| import android.os.BaseBundle; |
| import android.os.Build; |
| import android.os.Bundle; |
| import android.os.Parcel; |
| import android.os.Parcelable; |
| import android.os.SystemClock; |
| import android.os.UserHandle; |
| import android.text.BidiFormatter; |
| import android.text.SpannableStringBuilder; |
| import android.text.Spanned; |
| import android.text.TextUtils; |
| import android.text.style.AbsoluteSizeSpan; |
| import android.text.style.CharacterStyle; |
| import android.text.style.RelativeSizeSpan; |
| import android.text.style.TextAppearanceSpan; |
| import android.util.ArraySet; |
| import android.util.Log; |
| import android.util.SparseArray; |
| import android.view.Gravity; |
| import android.view.NotificationHeaderView; |
| import android.view.View; |
| import android.view.ViewGroup; |
| import android.widget.ProgressBar; |
| import android.widget.RemoteViews; |
| |
| import com.android.internal.R; |
| import com.android.internal.util.ArrayUtils; |
| import com.android.internal.util.NotificationColorUtil; |
| |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.lang.reflect.Constructor; |
| import java.util.ArrayList; |
| import java.util.Arrays; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.List; |
| import java.util.Set; |
| |
| /** |
| * A class that represents how a persistent notification is to be presented to |
| * the user using the {@link android.app.NotificationManager}. |
| * |
| * <p>The {@link Notification.Builder Notification.Builder} has been added to make it |
| * easier to construct Notifications.</p> |
| * |
| * <div class="special reference"> |
| * <h3>Developer Guides</h3> |
| * <p>For a guide to creating notifications, read the |
| * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Status Bar Notifications</a> |
| * developer guide.</p> |
| * </div> |
| */ |
| public class Notification implements Parcelable |
| { |
| private static final String TAG = "Notification"; |
| |
| /** |
| * An activity that provides a user interface for adjusting notification preferences for its |
| * containing application. Optional but recommended for apps that post |
| * {@link android.app.Notification Notifications}. |
| */ |
| @SdkConstant(SdkConstantType.INTENT_CATEGORY) |
| public static final String INTENT_CATEGORY_NOTIFICATION_PREFERENCES |
| = "android.intent.category.NOTIFICATION_PREFERENCES"; |
| |
| /** |
| * Use all default values (where applicable). |
| */ |
| public static final int DEFAULT_ALL = ~0; |
| |
| /** |
| * Use the default notification sound. This will ignore any given |
| * {@link #sound}. |
| * |
| * <p> |
| * A notification that is noisy is more likely to be presented as a heads-up notification. |
| * </p> |
| * |
| * @see #defaults |
| */ |
| |
| public static final int DEFAULT_SOUND = 1; |
| |
| /** |
| * Use the default notification vibrate. This will ignore any given |
| * {@link #vibrate}. Using phone vibration requires the |
| * {@link android.Manifest.permission#VIBRATE VIBRATE} permission. |
| * |
| * <p> |
| * A notification that vibrates is more likely to be presented as a heads-up notification. |
| * </p> |
| * |
| * @see #defaults |
| */ |
| |
| public static final int DEFAULT_VIBRATE = 2; |
| |
| /** |
| * Use the default notification lights. This will ignore the |
| * {@link #FLAG_SHOW_LIGHTS} bit, and {@link #ledARGB}, {@link #ledOffMS}, or |
| * {@link #ledOnMS}. |
| * |
| * @see #defaults |
| */ |
| |
| public static final int DEFAULT_LIGHTS = 4; |
| |
| /** |
| * Maximum length of CharSequences accepted by Builder and friends. |
| * |
| * <p> |
| * Avoids spamming the system with overly large strings such as full e-mails. |
| */ |
| private static final int MAX_CHARSEQUENCE_LENGTH = 5 * 1024; |
| |
| /** |
| * Maximum entries of reply text that are accepted by Builder and friends. |
| */ |
| private static final int MAX_REPLY_HISTORY = 5; |
| |
| /** |
| * A timestamp related to this notification, in milliseconds since the epoch. |
| * |
| * Default value: {@link System#currentTimeMillis() Now}. |
| * |
| * Choose a timestamp that will be most relevant to the user. For most finite events, this |
| * corresponds to the time the event happened (or will happen, in the case of events that have |
| * yet to occur but about which the user is being informed). Indefinite events should be |
| * timestamped according to when the activity began. |
| * |
| * Some examples: |
| * |
| * <ul> |
| * <li>Notification of a new chat message should be stamped when the message was received.</li> |
| * <li>Notification of an ongoing file download (with a progress bar, for example) should be stamped when the download started.</li> |
| * <li>Notification of a completed file download should be stamped when the download finished.</li> |
| * <li>Notification of an upcoming meeting should be stamped with the time the meeting will begin (that is, in the future).</li> |
| * <li>Notification of an ongoing stopwatch (increasing timer) should be stamped with the watch's start time. |
| * <li>Notification of an ongoing countdown timer should be stamped with the timer's end time. |
| * </ul> |
| * |
| * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not shown |
| * anymore by default and must be opted into by using |
| * {@link android.app.Notification.Builder#setShowWhen(boolean)} |
| */ |
| public long when; |
| |
| /** |
| * The creation time of the notification |
| */ |
| private long creationTime; |
| |
| /** |
| * The resource id of a drawable to use as the icon in the status bar. |
| * |
| * @deprecated Use {@link Builder#setSmallIcon(Icon)} instead. |
| */ |
| @Deprecated |
| @DrawableRes |
| public int icon; |
| |
| /** |
| * If the icon in the status bar is to have more than one level, you can set this. Otherwise, |
| * leave it at its default value of 0. |
| * |
| * @see android.widget.ImageView#setImageLevel |
| * @see android.graphics.drawable.Drawable#setLevel |
| */ |
| public int iconLevel; |
| |
| /** |
| * The number of events that this notification represents. For example, in a new mail |
| * notification, this could be the number of unread messages. |
| * |
| * The system may or may not use this field to modify the appearance of the notification. For |
| * example, before {@link android.os.Build.VERSION_CODES#HONEYCOMB}, this number was |
| * superimposed over the icon in the status bar. Starting with |
| * {@link android.os.Build.VERSION_CODES#HONEYCOMB}, the template used by |
| * {@link Notification.Builder} has displayed the number in the expanded notification view. |
| * |
| * If the number is 0 or negative, it is never shown. |
| * |
| * @deprecated this number is not shown anymore |
| */ |
| public int number; |
| |
| /** |
| * The intent to execute when the expanded status entry is clicked. If |
| * this is an activity, it must include the |
| * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires |
| * that you take care of task management as described in the |
| * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back |
| * Stack</a> document. In particular, make sure to read the notification section |
| * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html#HandlingNotifications">Handling |
| * Notifications</a> for the correct ways to launch an application from a |
| * notification. |
| */ |
| public PendingIntent contentIntent; |
| |
| /** |
| * The intent to execute when the notification is explicitly dismissed by the user, either with |
| * the "Clear All" button or by swiping it away individually. |
| * |
| * This probably shouldn't be launching an activity since several of those will be sent |
| * at the same time. |
| */ |
| public PendingIntent deleteIntent; |
| |
| /** |
| * An intent to launch instead of posting the notification to the status bar. |
| * |
| * <p> |
| * The system UI may choose to display a heads-up notification, instead of |
| * launching this intent, while the user is using the device. |
| * </p> |
| * |
| * @see Notification.Builder#setFullScreenIntent |
| */ |
| public PendingIntent fullScreenIntent; |
| |
| /** |
| * Text that summarizes this notification for accessibility services. |
| * |
| * As of the L release, this text is no longer shown on screen, but it is still useful to |
| * accessibility services (where it serves as an audible announcement of the notification's |
| * appearance). |
| * |
| * @see #tickerView |
| */ |
| public CharSequence tickerText; |
| |
| /** |
| * Formerly, a view showing the {@link #tickerText}. |
| * |
| * No longer displayed in the status bar as of API 21. |
| */ |
| @Deprecated |
| public RemoteViews tickerView; |
| |
| /** |
| * The view that will represent this notification in the notification list (which is pulled |
| * down from the status bar). |
| * |
| * As of N, this field may be null. The notification view is determined by the inputs |
| * to {@link Notification.Builder}; a custom RemoteViews can optionally be |
| * supplied with {@link Notification.Builder#setCustomContentView(RemoteViews)}. |
| */ |
| @Deprecated |
| public RemoteViews contentView; |
| |
| /** |
| * A large-format version of {@link #contentView}, giving the Notification an |
| * opportunity to show more detail. The system UI may choose to show this |
| * instead of the normal content view at its discretion. |
| * |
| * As of N, this field may be null. The expanded notification view is determined by the |
| * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be |
| * supplied with {@link Notification.Builder#setCustomBigContentView(RemoteViews)}. |
| */ |
| @Deprecated |
| public RemoteViews bigContentView; |
| |
| |
| /** |
| * A medium-format version of {@link #contentView}, providing the Notification an |
| * opportunity to add action buttons to contentView. At its discretion, the system UI may |
| * choose to show this as a heads-up notification, which will pop up so the user can see |
| * it without leaving their current activity. |
| * |
| * As of N, this field may be null. The heads-up notification view is determined by the |
| * inputs to {@link Notification.Builder}; a custom RemoteViews can optionally be |
| * supplied with {@link Notification.Builder#setCustomHeadsUpContentView(RemoteViews)}. |
| */ |
| @Deprecated |
| public RemoteViews headsUpContentView; |
| |
| /** |
| * A large bitmap to be shown in the notification content area. |
| * |
| * @deprecated Use {@link Builder#setLargeIcon(Icon)} instead. |
| */ |
| @Deprecated |
| public Bitmap largeIcon; |
| |
| /** |
| * The sound to play. |
| * |
| * <p> |
| * A notification that is noisy is more likely to be presented as a heads-up notification. |
| * </p> |
| * |
| * <p> |
| * To play the default notification sound, see {@link #defaults}. |
| * </p> |
| */ |
| public Uri sound; |
| |
| /** |
| * Use this constant as the value for audioStreamType to request that |
| * the default stream type for notifications be used. Currently the |
| * default stream type is {@link AudioManager#STREAM_NOTIFICATION}. |
| * |
| * @deprecated Use {@link #audioAttributes} instead. |
| */ |
| @Deprecated |
| public static final int STREAM_DEFAULT = -1; |
| |
| /** |
| * The audio stream type to use when playing the sound. |
| * Should be one of the STREAM_ constants from |
| * {@link android.media.AudioManager}. |
| * |
| * @deprecated Use {@link #audioAttributes} instead. |
| */ |
| @Deprecated |
| public int audioStreamType = STREAM_DEFAULT; |
| |
| /** |
| * The default value of {@link #audioAttributes}. |
| */ |
| public static final AudioAttributes AUDIO_ATTRIBUTES_DEFAULT = new AudioAttributes.Builder() |
| .setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION) |
| .setUsage(AudioAttributes.USAGE_NOTIFICATION) |
| .build(); |
| |
| /** |
| * The {@link AudioAttributes audio attributes} to use when playing the sound. |
| */ |
| public AudioAttributes audioAttributes = AUDIO_ATTRIBUTES_DEFAULT; |
| |
| /** |
| * The pattern with which to vibrate. |
| * |
| * <p> |
| * To vibrate the default pattern, see {@link #defaults}. |
| * </p> |
| * |
| * <p> |
| * A notification that vibrates is more likely to be presented as a heads-up notification. |
| * </p> |
| * |
| * @see android.os.Vibrator#vibrate(long[],int) |
| */ |
| public long[] vibrate; |
| |
| /** |
| * The color of the led. The hardware will do its best approximation. |
| * |
| * @see #FLAG_SHOW_LIGHTS |
| * @see #flags |
| */ |
| @ColorInt |
| public int ledARGB; |
| |
| /** |
| * The number of milliseconds for the LED to be on while it's flashing. |
| * The hardware will do its best approximation. |
| * |
| * @see #FLAG_SHOW_LIGHTS |
| * @see #flags |
| */ |
| public int ledOnMS; |
| |
| /** |
| * The number of milliseconds for the LED to be off while it's flashing. |
| * The hardware will do its best approximation. |
| * |
| * @see #FLAG_SHOW_LIGHTS |
| * @see #flags |
| */ |
| public int ledOffMS; |
| |
| /** |
| * Specifies which values should be taken from the defaults. |
| * <p> |
| * To set, OR the desired from {@link #DEFAULT_SOUND}, |
| * {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}. For all default |
| * values, use {@link #DEFAULT_ALL}. |
| * </p> |
| */ |
| public int defaults; |
| |
| /** |
| * Bit to be bitwise-ored into the {@link #flags} field that should be |
| * set if you want the LED on for this notification. |
| * <ul> |
| * <li>To turn the LED off, pass 0 in the alpha channel for colorARGB |
| * or 0 for both ledOnMS and ledOffMS.</li> |
| * <li>To turn the LED on, pass 1 for ledOnMS and 0 for ledOffMS.</li> |
| * <li>To flash the LED, pass the number of milliseconds that it should |
| * be on and off to ledOnMS and ledOffMS.</li> |
| * </ul> |
| * <p> |
| * Since hardware varies, you are not guaranteed that any of the values |
| * you pass are honored exactly. Use the system defaults (TODO) if possible |
| * because they will be set to values that work on any given hardware. |
| * <p> |
| * The alpha channel must be set for forward compatibility. |
| * |
| */ |
| public static final int FLAG_SHOW_LIGHTS = 0x00000001; |
| |
| /** |
| * Bit to be bitwise-ored into the {@link #flags} field that should be |
| * set if this notification is in reference to something that is ongoing, |
| * like a phone call. It should not be set if this notification is in |
| * reference to something that happened at a particular point in time, |
| * like a missed phone call. |
| */ |
| public static final int FLAG_ONGOING_EVENT = 0x00000002; |
| |
| /** |
| * Bit to be bitwise-ored into the {@link #flags} field that if set, |
| * the audio will be repeated until the notification is |
| * cancelled or the notification window is opened. |
| */ |
| public static final int FLAG_INSISTENT = 0x00000004; |
| |
| /** |
| * Bit to be bitwise-ored into the {@link #flags} field that should be |
| * set if you would only like the sound, vibrate and ticker to be played |
| * if the notification was not already showing. |
| */ |
| public static final int FLAG_ONLY_ALERT_ONCE = 0x00000008; |
| |
| /** |
| * Bit to be bitwise-ored into the {@link #flags} field that should be |
| * set if the notification should be canceled when it is clicked by the |
| * user. |
| */ |
| public static final int FLAG_AUTO_CANCEL = 0x00000010; |
| |
| /** |
| * Bit to be bitwise-ored into the {@link #flags} field that should be |
| * set if the notification should not be canceled when the user clicks |
| * the Clear all button. |
| */ |
| public static final int FLAG_NO_CLEAR = 0x00000020; |
| |
| /** |
| * Bit to be bitwise-ored into the {@link #flags} field that should be |
| * set if this notification represents a currently running service. This |
| * will normally be set for you by {@link Service#startForeground}. |
| */ |
| public static final int FLAG_FOREGROUND_SERVICE = 0x00000040; |
| |
| /** |
| * Obsolete flag indicating high-priority notifications; use the priority field instead. |
| * |
| * @deprecated Use {@link #priority} with a positive value. |
| */ |
| public static final int FLAG_HIGH_PRIORITY = 0x00000080; |
| |
| /** |
| * Bit to be bitswise-ored into the {@link #flags} field that should be |
| * set if this notification is relevant to the current device only |
| * and it is not recommended that it bridge to other devices. |
| */ |
| public static final int FLAG_LOCAL_ONLY = 0x00000100; |
| |
| /** |
| * Bit to be bitswise-ored into the {@link #flags} field that should be |
| * set if this notification is the group summary for a group of notifications. |
| * Grouped notifications may display in a cluster or stack on devices which |
| * support such rendering. Requires a group key also be set using {@link Builder#setGroup}. |
| */ |
| public static final int FLAG_GROUP_SUMMARY = 0x00000200; |
| |
| /** |
| * Bit to be bitswise-ored into the {@link #flags} field that should be |
| * set if this notification is the group summary for an auto-group of notifications. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public static final int FLAG_AUTOGROUP_SUMMARY = 0x00000400; |
| |
| public int flags; |
| |
| /** @hide */ |
| @IntDef({PRIORITY_DEFAULT,PRIORITY_LOW,PRIORITY_MIN,PRIORITY_HIGH,PRIORITY_MAX}) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface Priority {} |
| |
| /** |
| * Default notification {@link #priority}. If your application does not prioritize its own |
| * notifications, use this value for all notifications. |
| */ |
| public static final int PRIORITY_DEFAULT = 0; |
| |
| /** |
| * Lower {@link #priority}, for items that are less important. The UI may choose to show these |
| * items smaller, or at a different position in the list, compared with your app's |
| * {@link #PRIORITY_DEFAULT} items. |
| */ |
| public static final int PRIORITY_LOW = -1; |
| |
| /** |
| * Lowest {@link #priority}; these items might not be shown to the user except under special |
| * circumstances, such as detailed notification logs. |
| */ |
| public static final int PRIORITY_MIN = -2; |
| |
| /** |
| * Higher {@link #priority}, for more important notifications or alerts. The UI may choose to |
| * show these items larger, or at a different position in notification lists, compared with |
| * your app's {@link #PRIORITY_DEFAULT} items. |
| */ |
| public static final int PRIORITY_HIGH = 1; |
| |
| /** |
| * Highest {@link #priority}, for your application's most important items that require the |
| * user's prompt attention or input. |
| */ |
| public static final int PRIORITY_MAX = 2; |
| |
| /** |
| * Relative priority for this notification. |
| * |
| * Priority is an indication of how much of the user's valuable attention should be consumed by |
| * this notification. Low-priority notifications may be hidden from the user in certain |
| * situations, while the user might be interrupted for a higher-priority notification. The |
| * system will make a determination about how to interpret this priority when presenting |
| * the notification. |
| * |
| * <p> |
| * A notification that is at least {@link #PRIORITY_HIGH} is more likely to be presented |
| * as a heads-up notification. |
| * </p> |
| * |
| */ |
| @Priority |
| public int priority; |
| |
| /** |
| * Accent color (an ARGB integer like the constants in {@link android.graphics.Color}) |
| * to be applied by the standard Style templates when presenting this notification. |
| * |
| * The current template design constructs a colorful header image by overlaying the |
| * {@link #icon} image (stenciled in white) atop a field of this color. Alpha components are |
| * ignored. |
| */ |
| @ColorInt |
| public int color = COLOR_DEFAULT; |
| |
| /** |
| * Special value of {@link #color} telling the system not to decorate this notification with |
| * any special color but instead use default colors when presenting this notification. |
| */ |
| @ColorInt |
| public static final int COLOR_DEFAULT = 0; // AKA Color.TRANSPARENT |
| |
| /** |
| * Special value of {@link #color} used as a place holder for an invalid color. |
| */ |
| @ColorInt |
| private static final int COLOR_INVALID = 1; |
| |
| /** |
| * Sphere of visibility of this notification, which affects how and when the SystemUI reveals |
| * the notification's presence and contents in untrusted situations (namely, on the secure |
| * lockscreen). |
| * |
| * The default level, {@link #VISIBILITY_PRIVATE}, behaves exactly as notifications have always |
| * done on Android: The notification's {@link #icon} and {@link #tickerText} (if available) are |
| * shown in all situations, but the contents are only available if the device is unlocked for |
| * the appropriate user. |
| * |
| * A more permissive policy can be expressed by {@link #VISIBILITY_PUBLIC}; such a notification |
| * can be read even in an "insecure" context (that is, above a secure lockscreen). |
| * To modify the public version of this notification—for example, to redact some portions—see |
| * {@link Builder#setPublicVersion(Notification)}. |
| * |
| * Finally, a notification can be made {@link #VISIBILITY_SECRET}, which will suppress its icon |
| * and ticker until the user has bypassed the lockscreen. |
| */ |
| public int visibility; |
| |
| /** |
| * Notification visibility: Show this notification in its entirety on all lockscreens. |
| * |
| * {@see #visibility} |
| */ |
| public static final int VISIBILITY_PUBLIC = 1; |
| |
| /** |
| * Notification visibility: Show this notification on all lockscreens, but conceal sensitive or |
| * private information on secure lockscreens. |
| * |
| * {@see #visibility} |
| */ |
| public static final int VISIBILITY_PRIVATE = 0; |
| |
| /** |
| * Notification visibility: Do not reveal any part of this notification on a secure lockscreen. |
| * |
| * {@see #visibility} |
| */ |
| public static final int VISIBILITY_SECRET = -1; |
| |
| /** |
| * Notification category: incoming call (voice or video) or similar synchronous communication request. |
| */ |
| public static final String CATEGORY_CALL = "call"; |
| |
| /** |
| * Notification category: incoming direct message (SMS, instant message, etc.). |
| */ |
| public static final String CATEGORY_MESSAGE = "msg"; |
| |
| /** |
| * Notification category: asynchronous bulk message (email). |
| */ |
| public static final String CATEGORY_EMAIL = "email"; |
| |
| /** |
| * Notification category: calendar event. |
| */ |
| public static final String CATEGORY_EVENT = "event"; |
| |
| /** |
| * Notification category: promotion or advertisement. |
| */ |
| public static final String CATEGORY_PROMO = "promo"; |
| |
| /** |
| * Notification category: alarm or timer. |
| */ |
| public static final String CATEGORY_ALARM = "alarm"; |
| |
| /** |
| * Notification category: progress of a long-running background operation. |
| */ |
| public static final String CATEGORY_PROGRESS = "progress"; |
| |
| /** |
| * Notification category: social network or sharing update. |
| */ |
| public static final String CATEGORY_SOCIAL = "social"; |
| |
| /** |
| * Notification category: error in background operation or authentication status. |
| */ |
| public static final String CATEGORY_ERROR = "err"; |
| |
| /** |
| * Notification category: media transport control for playback. |
| */ |
| public static final String CATEGORY_TRANSPORT = "transport"; |
| |
| /** |
| * Notification category: system or device status update. Reserved for system use. |
| */ |
| public static final String CATEGORY_SYSTEM = "sys"; |
| |
| /** |
| * Notification category: indication of running background service. |
| */ |
| public static final String CATEGORY_SERVICE = "service"; |
| |
| /** |
| * Notification category: a specific, timely recommendation for a single thing. |
| * For example, a news app might want to recommend a news story it believes the user will |
| * want to read next. |
| */ |
| public static final String CATEGORY_RECOMMENDATION = "recommendation"; |
| |
| /** |
| * Notification category: ongoing information about device or contextual status. |
| */ |
| public static final String CATEGORY_STATUS = "status"; |
| |
| /** |
| * Notification category: user-scheduled reminder. |
| */ |
| public static final String CATEGORY_REMINDER = "reminder"; |
| |
| /** |
| * One of the predefined notification categories (see the <code>CATEGORY_*</code> constants) |
| * that best describes this Notification. May be used by the system for ranking and filtering. |
| */ |
| public String category; |
| |
| private String mGroupKey; |
| |
| /** |
| * Get the key used to group this notification into a cluster or stack |
| * with other notifications on devices which support such rendering. |
| */ |
| public String getGroup() { |
| return mGroupKey; |
| } |
| |
| private String mSortKey; |
| |
| /** |
| * Get a sort key that orders this notification among other notifications from the |
| * same package. This can be useful if an external sort was already applied and an app |
| * would like to preserve this. Notifications will be sorted lexicographically using this |
| * value, although providing different priorities in addition to providing sort key may |
| * cause this value to be ignored. |
| * |
| * <p>This sort key can also be used to order members of a notification group. See |
| * {@link Builder#setGroup}. |
| * |
| * @see String#compareTo(String) |
| */ |
| public String getSortKey() { |
| return mSortKey; |
| } |
| |
| /** |
| * Additional semantic data to be carried around with this Notification. |
| * <p> |
| * The extras keys defined here are intended to capture the original inputs to {@link Builder} |
| * APIs, and are intended to be used by |
| * {@link android.service.notification.NotificationListenerService} implementations to extract |
| * detailed information from notification objects. |
| */ |
| public Bundle extras = new Bundle(); |
| |
| /** |
| * All pending intents in the notification extras (notification extras, actions extras, |
| * and remote input extras) as the system needs to be able to access them but touching |
| * the extras bundle in the system process is not safe because the bundle may contain |
| * custom parcelable objects. |
| * |
| * @hide |
| */ |
| public ArraySet<PendingIntent> extrasPendingIntents; |
| |
| /** |
| * {@link #extras} key: this is the title of the notification, |
| * as supplied to {@link Builder#setContentTitle(CharSequence)}. |
| */ |
| public static final String EXTRA_TITLE = "android.title"; |
| |
| /** |
| * {@link #extras} key: this is the title of the notification when shown in expanded form, |
| * e.g. as supplied to {@link BigTextStyle#setBigContentTitle(CharSequence)}. |
| */ |
| public static final String EXTRA_TITLE_BIG = EXTRA_TITLE + ".big"; |
| |
| /** |
| * {@link #extras} key: this is the main text payload, as supplied to |
| * {@link Builder#setContentText(CharSequence)}. |
| */ |
| public static final String EXTRA_TEXT = "android.text"; |
| |
| /** |
| * {@link #extras} key: this is a third line of text, as supplied to |
| * {@link Builder#setSubText(CharSequence)}. |
| */ |
| public static final String EXTRA_SUB_TEXT = "android.subText"; |
| |
| /** |
| * {@link #extras} key: this is the remote input history, as supplied to |
| * {@link Builder#setRemoteInputHistory(CharSequence[])}. |
| * |
| * Apps can fill this through {@link Builder#setRemoteInputHistory(CharSequence[])} |
| * with the most recent inputs that have been sent through a {@link RemoteInput} of this |
| * Notification and are expected to clear it once the it is no longer relevant (e.g. for chat |
| * notifications once the other party has responded). |
| * |
| * The extra with this key is of type CharSequence[] and contains the most recent entry at |
| * the 0 index, the second most recent at the 1 index, etc. |
| * |
| * @see Builder#setRemoteInputHistory(CharSequence[]) |
| */ |
| public static final String EXTRA_REMOTE_INPUT_HISTORY = "android.remoteInputHistory"; |
| |
| /** |
| * {@link #extras} key: this is a small piece of additional text as supplied to |
| * {@link Builder#setContentInfo(CharSequence)}. |
| */ |
| public static final String EXTRA_INFO_TEXT = "android.infoText"; |
| |
| /** |
| * {@link #extras} key: this is a line of summary information intended to be shown |
| * alongside expanded notifications, as supplied to (e.g.) |
| * {@link BigTextStyle#setSummaryText(CharSequence)}. |
| */ |
| public static final String EXTRA_SUMMARY_TEXT = "android.summaryText"; |
| |
| /** |
| * {@link #extras} key: this is the longer text shown in the big form of a |
| * {@link BigTextStyle} notification, as supplied to |
| * {@link BigTextStyle#bigText(CharSequence)}. |
| */ |
| public static final String EXTRA_BIG_TEXT = "android.bigText"; |
| |
| /** |
| * {@link #extras} key: this is the resource ID of the notification's main small icon, as |
| * supplied to {@link Builder#setSmallIcon(int)}. |
| */ |
| public static final String EXTRA_SMALL_ICON = "android.icon"; |
| |
| /** |
| * {@link #extras} key: this is a bitmap to be used instead of the small icon when showing the |
| * notification payload, as |
| * supplied to {@link Builder#setLargeIcon(android.graphics.Bitmap)}. |
| */ |
| public static final String EXTRA_LARGE_ICON = "android.largeIcon"; |
| |
| /** |
| * {@link #extras} key: this is a bitmap to be used instead of the one from |
| * {@link Builder#setLargeIcon(android.graphics.Bitmap)} when the notification is |
| * shown in its expanded form, as supplied to |
| * {@link BigPictureStyle#bigLargeIcon(android.graphics.Bitmap)}. |
| */ |
| public static final String EXTRA_LARGE_ICON_BIG = EXTRA_LARGE_ICON + ".big"; |
| |
| /** |
| * {@link #extras} key: this is the progress value supplied to |
| * {@link Builder#setProgress(int, int, boolean)}. |
| */ |
| public static final String EXTRA_PROGRESS = "android.progress"; |
| |
| /** |
| * {@link #extras} key: this is the maximum value supplied to |
| * {@link Builder#setProgress(int, int, boolean)}. |
| */ |
| public static final String EXTRA_PROGRESS_MAX = "android.progressMax"; |
| |
| /** |
| * {@link #extras} key: whether the progress bar is indeterminate, supplied to |
| * {@link Builder#setProgress(int, int, boolean)}. |
| */ |
| public static final String EXTRA_PROGRESS_INDETERMINATE = "android.progressIndeterminate"; |
| |
| /** |
| * {@link #extras} key: whether {@link #when} should be shown as a count-up timer (specifically |
| * a {@link android.widget.Chronometer}) instead of a timestamp, as supplied to |
| * {@link Builder#setUsesChronometer(boolean)}. |
| */ |
| public static final String EXTRA_SHOW_CHRONOMETER = "android.showChronometer"; |
| |
| /** |
| * {@link #extras} key: whether the chronometer set on the notification should count down |
| * instead of counting up. Is only relevant if key {@link #EXTRA_SHOW_CHRONOMETER} is present. |
| * This extra is a boolean. The default is false. |
| */ |
| public static final String EXTRA_CHRONOMETER_COUNT_DOWN = "android.chronometerCountDown"; |
| |
| /** |
| * {@link #extras} key: whether {@link #when} should be shown, |
| * as supplied to {@link Builder#setShowWhen(boolean)}. |
| */ |
| public static final String EXTRA_SHOW_WHEN = "android.showWhen"; |
| |
| /** |
| * {@link #extras} key: this is a bitmap to be shown in {@link BigPictureStyle} expanded |
| * notifications, supplied to {@link BigPictureStyle#bigPicture(android.graphics.Bitmap)}. |
| */ |
| public static final String EXTRA_PICTURE = "android.picture"; |
| |
| /** |
| * {@link #extras} key: An array of CharSequences to show in {@link InboxStyle} expanded |
| * notifications, each of which was supplied to {@link InboxStyle#addLine(CharSequence)}. |
| */ |
| public static final String EXTRA_TEXT_LINES = "android.textLines"; |
| |
| /** |
| * {@link #extras} key: A string representing the name of the specific |
| * {@link android.app.Notification.Style} used to create this notification. |
| */ |
| public static final String EXTRA_TEMPLATE = "android.template"; |
| |
| /** |
| * {@link #extras} key: A String array containing the people that this notification relates to, |
| * each of which was supplied to {@link Builder#addPerson(String)}. |
| */ |
| public static final String EXTRA_PEOPLE = "android.people"; |
| |
| /** |
| * Allow certain system-generated notifications to appear before the device is provisioned. |
| * Only available to notifications coming from the android package. |
| * @hide |
| */ |
| public static final String EXTRA_ALLOW_DURING_SETUP = "android.allowDuringSetup"; |
| |
| /** |
| * {@link #extras} key: A |
| * {@link android.content.ContentUris content URI} pointing to an image that can be displayed |
| * in the background when the notification is selected. The URI must point to an image stream |
| * suitable for passing into |
| * {@link android.graphics.BitmapFactory#decodeStream(java.io.InputStream) |
| * BitmapFactory.decodeStream}; all other content types will be ignored. The content provider |
| * URI used for this purpose must require no permissions to read the image data. |
| */ |
| public static final String EXTRA_BACKGROUND_IMAGE_URI = "android.backgroundImageUri"; |
| |
| /** |
| * {@link #extras} key: A |
| * {@link android.media.session.MediaSession.Token} associated with a |
| * {@link android.app.Notification.MediaStyle} notification. |
| */ |
| public static final String EXTRA_MEDIA_SESSION = "android.mediaSession"; |
| |
| /** |
| * {@link #extras} key: the indices of actions to be shown in the compact view, |
| * as supplied to (e.g.) {@link MediaStyle#setShowActionsInCompactView(int...)}. |
| */ |
| public static final String EXTRA_COMPACT_ACTIONS = "android.compactActions"; |
| |
| /** |
| * {@link #extras} key: the username to be displayed for all messages sent by the user including |
| * direct replies |
| * {@link android.app.Notification.MessagingStyle} notification. This extra is a |
| * {@link CharSequence} |
| */ |
| public static final String EXTRA_SELF_DISPLAY_NAME = "android.selfDisplayName"; |
| |
| /** |
| * {@link #extras} key: a {@link CharSequence} to be displayed as the title to a conversation |
| * represented by a {@link android.app.Notification.MessagingStyle} |
| */ |
| public static final String EXTRA_CONVERSATION_TITLE = "android.conversationTitle"; |
| |
| /** |
| * {@link #extras} key: an array of {@link android.app.Notification.MessagingStyle.Message} |
| * bundles provided by a |
| * {@link android.app.Notification.MessagingStyle} notification. This extra is a parcelable |
| * array of bundles. |
| */ |
| public static final String EXTRA_MESSAGES = "android.messages"; |
| |
| /** |
| * {@link #extras} key: the user that built the notification. |
| * |
| * @hide |
| */ |
| public static final String EXTRA_ORIGINATING_USERID = "android.originatingUserId"; |
| |
| /** |
| * @hide |
| */ |
| public static final String EXTRA_BUILDER_APPLICATION_INFO = "android.appInfo"; |
| |
| /** |
| * @hide |
| */ |
| public static final String EXTRA_CONTAINS_CUSTOM_VIEW = "android.contains.customView"; |
| |
| /** @hide */ |
| @SystemApi |
| public static final String EXTRA_SUBSTITUTE_APP_NAME = "android.substName"; |
| |
| private Icon mSmallIcon; |
| private Icon mLargeIcon; |
| |
| /** |
| * Structure to encapsulate a named action that can be shown as part of this notification. |
| * It must include an icon, a label, and a {@link PendingIntent} to be fired when the action is |
| * selected by the user. |
| * <p> |
| * Apps should use {@link Notification.Builder#addAction(int, CharSequence, PendingIntent)} |
| * or {@link Notification.Builder#addAction(Notification.Action)} |
| * to attach actions. |
| */ |
| public static class Action implements Parcelable { |
| private final Bundle mExtras; |
| private Icon mIcon; |
| private final RemoteInput[] mRemoteInputs; |
| private boolean mAllowGeneratedReplies = false; |
| |
| /** |
| * Small icon representing the action. |
| * |
| * @deprecated Use {@link Action#getIcon()} instead. |
| */ |
| @Deprecated |
| public int icon; |
| |
| /** |
| * Title of the action. |
| */ |
| public CharSequence title; |
| |
| /** |
| * Intent to send when the user invokes this action. May be null, in which case the action |
| * may be rendered in a disabled presentation by the system UI. |
| */ |
| public PendingIntent actionIntent; |
| |
| private Action(Parcel in) { |
| if (in.readInt() != 0) { |
| mIcon = Icon.CREATOR.createFromParcel(in); |
| if (mIcon.getType() == Icon.TYPE_RESOURCE) { |
| icon = mIcon.getResId(); |
| } |
| } |
| title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in); |
| if (in.readInt() == 1) { |
| actionIntent = PendingIntent.CREATOR.createFromParcel(in); |
| } |
| mExtras = Bundle.setDefusable(in.readBundle(), true); |
| mRemoteInputs = in.createTypedArray(RemoteInput.CREATOR); |
| mAllowGeneratedReplies = in.readInt() == 1; |
| } |
| |
| /** |
| * @deprecated Use {@link android.app.Notification.Action.Builder}. |
| */ |
| @Deprecated |
| public Action(int icon, CharSequence title, PendingIntent intent) { |
| this(Icon.createWithResource("", icon), title, intent, new Bundle(), null, false); |
| } |
| |
| private Action(Icon icon, CharSequence title, PendingIntent intent, Bundle extras, |
| RemoteInput[] remoteInputs, boolean allowGeneratedReplies) { |
| this.mIcon = icon; |
| if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) { |
| this.icon = icon.getResId(); |
| } |
| this.title = title; |
| this.actionIntent = intent; |
| this.mExtras = extras != null ? extras : new Bundle(); |
| this.mRemoteInputs = remoteInputs; |
| this.mAllowGeneratedReplies = allowGeneratedReplies; |
| } |
| |
| /** |
| * Return an icon representing the action. |
| */ |
| public Icon getIcon() { |
| if (mIcon == null && icon != 0) { |
| // you snuck an icon in here without using the builder; let's try to keep it |
| mIcon = Icon.createWithResource("", icon); |
| } |
| return mIcon; |
| } |
| |
| /** |
| * Get additional metadata carried around with this Action. |
| */ |
| public Bundle getExtras() { |
| return mExtras; |
| } |
| |
| /** |
| * Return whether the platform should automatically generate possible replies for this |
| * {@link Action} |
| */ |
| public boolean getAllowGeneratedReplies() { |
| return mAllowGeneratedReplies; |
| } |
| |
| /** |
| * Get the list of inputs to be collected from the user when this action is sent. |
| * May return null if no remote inputs were added. |
| */ |
| public RemoteInput[] getRemoteInputs() { |
| return mRemoteInputs; |
| } |
| |
| /** |
| * Builder class for {@link Action} objects. |
| */ |
| public static final class Builder { |
| private final Icon mIcon; |
| private final CharSequence mTitle; |
| private final PendingIntent mIntent; |
| private boolean mAllowGeneratedReplies; |
| private final Bundle mExtras; |
| private ArrayList<RemoteInput> mRemoteInputs; |
| |
| /** |
| * Construct a new builder for {@link Action} object. |
| * @param icon icon to show for this action |
| * @param title the title of the action |
| * @param intent the {@link PendingIntent} to fire when users trigger this action |
| */ |
| @Deprecated |
| public Builder(int icon, CharSequence title, PendingIntent intent) { |
| this(Icon.createWithResource("", icon), title, intent, new Bundle(), null); |
| } |
| |
| /** |
| * Construct a new builder for {@link Action} object. |
| * @param icon icon to show for this action |
| * @param title the title of the action |
| * @param intent the {@link PendingIntent} to fire when users trigger this action |
| */ |
| public Builder(Icon icon, CharSequence title, PendingIntent intent) { |
| this(icon, title, intent, new Bundle(), null); |
| } |
| |
| /** |
| * Construct a new builder for {@link Action} object using the fields from an |
| * {@link Action}. |
| * @param action the action to read fields from. |
| */ |
| public Builder(Action action) { |
| this(action.getIcon(), action.title, action.actionIntent, new Bundle(action.mExtras), |
| action.getRemoteInputs()); |
| } |
| |
| private Builder(Icon icon, CharSequence title, PendingIntent intent, Bundle extras, |
| RemoteInput[] remoteInputs) { |
| mIcon = icon; |
| mTitle = title; |
| mIntent = intent; |
| mExtras = extras; |
| if (remoteInputs != null) { |
| mRemoteInputs = new ArrayList<RemoteInput>(remoteInputs.length); |
| Collections.addAll(mRemoteInputs, remoteInputs); |
| } |
| } |
| |
| /** |
| * Merge additional metadata into this builder. |
| * |
| * <p>Values within the Bundle will replace existing extras values in this Builder. |
| * |
| * @see Notification.Action#extras |
| */ |
| public Builder addExtras(Bundle extras) { |
| if (extras != null) { |
| mExtras.putAll(extras); |
| } |
| return this; |
| } |
| |
| /** |
| * Get the metadata Bundle used by this Builder. |
| * |
| * <p>The returned Bundle is shared with this Builder. |
| */ |
| public Bundle getExtras() { |
| return mExtras; |
| } |
| |
| /** |
| * Add an input to be collected from the user when this action is sent. |
| * Response values can be retrieved from the fired intent by using the |
| * {@link RemoteInput#getResultsFromIntent} function. |
| * @param remoteInput a {@link RemoteInput} to add to the action |
| * @return this object for method chaining |
| */ |
| public Builder addRemoteInput(RemoteInput remoteInput) { |
| if (mRemoteInputs == null) { |
| mRemoteInputs = new ArrayList<RemoteInput>(); |
| } |
| mRemoteInputs.add(remoteInput); |
| return this; |
| } |
| |
| /** |
| * Set whether the platform should automatically generate possible replies to add to |
| * {@link RemoteInput#getChoices()}. If the {@link Action} doesn't have a |
| * {@link RemoteInput}, this has no effect. |
| * @param allowGeneratedReplies {@code true} to allow generated replies, {@code false} |
| * otherwise |
| * @return this object for method chaining |
| * The default value is {@code false} |
| */ |
| public Builder setAllowGeneratedReplies(boolean allowGeneratedReplies) { |
| mAllowGeneratedReplies = allowGeneratedReplies; |
| return this; |
| } |
| |
| /** |
| * Apply an extender to this action builder. Extenders may be used to add |
| * metadata or change options on this builder. |
| */ |
| public Builder extend(Extender extender) { |
| extender.extend(this); |
| return this; |
| } |
| |
| /** |
| * Combine all of the options that have been set and return a new {@link Action} |
| * object. |
| * @return the built action |
| */ |
| public Action build() { |
| RemoteInput[] remoteInputs = mRemoteInputs != null |
| ? mRemoteInputs.toArray(new RemoteInput[mRemoteInputs.size()]) : null; |
| return new Action(mIcon, mTitle, mIntent, mExtras, remoteInputs, |
| mAllowGeneratedReplies); |
| } |
| } |
| |
| @Override |
| public Action clone() { |
| return new Action( |
| getIcon(), |
| title, |
| actionIntent, // safe to alias |
| new Bundle(mExtras), |
| getRemoteInputs(), |
| getAllowGeneratedReplies()); |
| } |
| @Override |
| public int describeContents() { |
| return 0; |
| } |
| @Override |
| public void writeToParcel(Parcel out, int flags) { |
| final Icon ic = getIcon(); |
| if (ic != null) { |
| out.writeInt(1); |
| ic.writeToParcel(out, 0); |
| } else { |
| out.writeInt(0); |
| } |
| TextUtils.writeToParcel(title, out, flags); |
| if (actionIntent != null) { |
| out.writeInt(1); |
| actionIntent.writeToParcel(out, flags); |
| } else { |
| out.writeInt(0); |
| } |
| out.writeBundle(mExtras); |
| out.writeTypedArray(mRemoteInputs, flags); |
| out.writeInt(mAllowGeneratedReplies ? 1 : 0); |
| } |
| public static final Parcelable.Creator<Action> CREATOR = |
| new Parcelable.Creator<Action>() { |
| public Action createFromParcel(Parcel in) { |
| return new Action(in); |
| } |
| public Action[] newArray(int size) { |
| return new Action[size]; |
| } |
| }; |
| |
| /** |
| * Extender interface for use with {@link Builder#extend}. Extenders may be used to add |
| * metadata or change options on an action builder. |
| */ |
| public interface Extender { |
| /** |
| * Apply this extender to a notification action builder. |
| * @param builder the builder to be modified. |
| * @return the build object for chaining. |
| */ |
| public Builder extend(Builder builder); |
| } |
| |
| /** |
| * Wearable extender for notification actions. To add extensions to an action, |
| * create a new {@link android.app.Notification.Action.WearableExtender} object using |
| * the {@code WearableExtender()} constructor and apply it to a |
| * {@link android.app.Notification.Action.Builder} using |
| * {@link android.app.Notification.Action.Builder#extend}. |
| * |
| * <pre class="prettyprint"> |
| * Notification.Action action = new Notification.Action.Builder( |
| * R.drawable.archive_all, "Archive all", actionIntent) |
| * .extend(new Notification.Action.WearableExtender() |
| * .setAvailableOffline(false)) |
| * .build();</pre> |
| */ |
| public static final class WearableExtender implements Extender { |
| /** Notification action extra which contains wearable extensions */ |
| private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS"; |
| |
| // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options. |
| private static final String KEY_FLAGS = "flags"; |
| private static final String KEY_IN_PROGRESS_LABEL = "inProgressLabel"; |
| private static final String KEY_CONFIRM_LABEL = "confirmLabel"; |
| private static final String KEY_CANCEL_LABEL = "cancelLabel"; |
| |
| // Flags bitwise-ored to mFlags |
| private static final int FLAG_AVAILABLE_OFFLINE = 0x1; |
| private static final int FLAG_HINT_LAUNCHES_ACTIVITY = 1 << 1; |
| |
| // Default value for flags integer |
| private static final int DEFAULT_FLAGS = FLAG_AVAILABLE_OFFLINE; |
| |
| private int mFlags = DEFAULT_FLAGS; |
| |
| private CharSequence mInProgressLabel; |
| private CharSequence mConfirmLabel; |
| private CharSequence mCancelLabel; |
| |
| /** |
| * Create a {@link android.app.Notification.Action.WearableExtender} with default |
| * options. |
| */ |
| public WearableExtender() { |
| } |
| |
| /** |
| * Create a {@link android.app.Notification.Action.WearableExtender} by reading |
| * wearable options present in an existing notification action. |
| * @param action the notification action to inspect. |
| */ |
| public WearableExtender(Action action) { |
| Bundle wearableBundle = action.getExtras().getBundle(EXTRA_WEARABLE_EXTENSIONS); |
| if (wearableBundle != null) { |
| mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS); |
| mInProgressLabel = wearableBundle.getCharSequence(KEY_IN_PROGRESS_LABEL); |
| mConfirmLabel = wearableBundle.getCharSequence(KEY_CONFIRM_LABEL); |
| mCancelLabel = wearableBundle.getCharSequence(KEY_CANCEL_LABEL); |
| } |
| } |
| |
| /** |
| * Apply wearable extensions to a notification action that is being built. This is |
| * typically called by the {@link android.app.Notification.Action.Builder#extend} |
| * method of {@link android.app.Notification.Action.Builder}. |
| */ |
| @Override |
| public Action.Builder extend(Action.Builder builder) { |
| Bundle wearableBundle = new Bundle(); |
| |
| if (mFlags != DEFAULT_FLAGS) { |
| wearableBundle.putInt(KEY_FLAGS, mFlags); |
| } |
| if (mInProgressLabel != null) { |
| wearableBundle.putCharSequence(KEY_IN_PROGRESS_LABEL, mInProgressLabel); |
| } |
| if (mConfirmLabel != null) { |
| wearableBundle.putCharSequence(KEY_CONFIRM_LABEL, mConfirmLabel); |
| } |
| if (mCancelLabel != null) { |
| wearableBundle.putCharSequence(KEY_CANCEL_LABEL, mCancelLabel); |
| } |
| |
| builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle); |
| return builder; |
| } |
| |
| @Override |
| public WearableExtender clone() { |
| WearableExtender that = new WearableExtender(); |
| that.mFlags = this.mFlags; |
| that.mInProgressLabel = this.mInProgressLabel; |
| that.mConfirmLabel = this.mConfirmLabel; |
| that.mCancelLabel = this.mCancelLabel; |
| return that; |
| } |
| |
| /** |
| * Set whether this action is available when the wearable device is not connected to |
| * a companion device. The user can still trigger this action when the wearable device is |
| * offline, but a visual hint will indicate that the action may not be available. |
| * Defaults to true. |
| */ |
| public WearableExtender setAvailableOffline(boolean availableOffline) { |
| setFlag(FLAG_AVAILABLE_OFFLINE, availableOffline); |
| return this; |
| } |
| |
| /** |
| * Get whether this action is available when the wearable device is not connected to |
| * a companion device. The user can still trigger this action when the wearable device is |
| * offline, but a visual hint will indicate that the action may not be available. |
| * Defaults to true. |
| */ |
| public boolean isAvailableOffline() { |
| return (mFlags & FLAG_AVAILABLE_OFFLINE) != 0; |
| } |
| |
| private void setFlag(int mask, boolean value) { |
| if (value) { |
| mFlags |= mask; |
| } else { |
| mFlags &= ~mask; |
| } |
| } |
| |
| /** |
| * Set a label to display while the wearable is preparing to automatically execute the |
| * action. This is usually a 'ing' verb ending in ellipsis like "Sending..." |
| * |
| * @param label the label to display while the action is being prepared to execute |
| * @return this object for method chaining |
| */ |
| public WearableExtender setInProgressLabel(CharSequence label) { |
| mInProgressLabel = label; |
| return this; |
| } |
| |
| /** |
| * Get the label to display while the wearable is preparing to automatically execute |
| * the action. This is usually a 'ing' verb ending in ellipsis like "Sending..." |
| * |
| * @return the label to display while the action is being prepared to execute |
| */ |
| public CharSequence getInProgressLabel() { |
| return mInProgressLabel; |
| } |
| |
| /** |
| * Set a label to display to confirm that the action should be executed. |
| * This is usually an imperative verb like "Send". |
| * |
| * @param label the label to confirm the action should be executed |
| * @return this object for method chaining |
| */ |
| public WearableExtender setConfirmLabel(CharSequence label) { |
| mConfirmLabel = label; |
| return this; |
| } |
| |
| /** |
| * Get the label to display to confirm that the action should be executed. |
| * This is usually an imperative verb like "Send". |
| * |
| * @return the label to confirm the action should be executed |
| */ |
| public CharSequence getConfirmLabel() { |
| return mConfirmLabel; |
| } |
| |
| /** |
| * Set a label to display to cancel the action. |
| * This is usually an imperative verb, like "Cancel". |
| * |
| * @param label the label to display to cancel the action |
| * @return this object for method chaining |
| */ |
| public WearableExtender setCancelLabel(CharSequence label) { |
| mCancelLabel = label; |
| return this; |
| } |
| |
| /** |
| * Get the label to display to cancel the action. |
| * This is usually an imperative verb like "Cancel". |
| * |
| * @return the label to display to cancel the action |
| */ |
| public CharSequence getCancelLabel() { |
| return mCancelLabel; |
| } |
| |
| /** |
| * Set a hint that this Action will launch an {@link Activity} directly, telling the |
| * platform that it can generate the appropriate transitions. |
| * @param hintLaunchesActivity {@code true} if the content intent will launch |
| * an activity and transitions should be generated, false otherwise. |
| * @return this object for method chaining |
| */ |
| public WearableExtender setHintLaunchesActivity( |
| boolean hintLaunchesActivity) { |
| setFlag(FLAG_HINT_LAUNCHES_ACTIVITY, hintLaunchesActivity); |
| return this; |
| } |
| |
| /** |
| * Get a hint that this Action will launch an {@link Activity} directly, telling the |
| * platform that it can generate the appropriate transitions |
| * @return {@code true} if the content intent will launch an activity and transitions |
| * should be generated, false otherwise. The default value is {@code false} if this was |
| * never set. |
| */ |
| public boolean getHintLaunchesActivity() { |
| return (mFlags & FLAG_HINT_LAUNCHES_ACTIVITY) != 0; |
| } |
| } |
| } |
| |
| /** |
| * Array of all {@link Action} structures attached to this notification by |
| * {@link Builder#addAction(int, CharSequence, PendingIntent)}. Mostly useful for instances of |
| * {@link android.service.notification.NotificationListenerService} that provide an alternative |
| * interface for invoking actions. |
| */ |
| public Action[] actions; |
| |
| /** |
| * Replacement version of this notification whose content will be shown |
| * in an insecure context such as atop a secure keyguard. See {@link #visibility} |
| * and {@link #VISIBILITY_PUBLIC}. |
| */ |
| public Notification publicVersion; |
| |
| /** |
| * Constructs a Notification object with default values. |
| * You might want to consider using {@link Builder} instead. |
| */ |
| public Notification() |
| { |
| this.when = System.currentTimeMillis(); |
| this.creationTime = System.currentTimeMillis(); |
| this.priority = PRIORITY_DEFAULT; |
| } |
| |
| /** |
| * @hide |
| */ |
| public Notification(Context context, int icon, CharSequence tickerText, long when, |
| CharSequence contentTitle, CharSequence contentText, Intent contentIntent) |
| { |
| new Builder(context) |
| .setWhen(when) |
| .setSmallIcon(icon) |
| .setTicker(tickerText) |
| .setContentTitle(contentTitle) |
| .setContentText(contentText) |
| .setContentIntent(PendingIntent.getActivity(context, 0, contentIntent, 0)) |
| .buildInto(this); |
| } |
| |
| /** |
| * Constructs a Notification object with the information needed to |
| * have a status bar icon without the standard expanded view. |
| * |
| * @param icon The resource id of the icon to put in the status bar. |
| * @param tickerText The text that flows by in the status bar when the notification first |
| * activates. |
| * @param when The time to show in the time field. In the System.currentTimeMillis |
| * timebase. |
| * |
| * @deprecated Use {@link Builder} instead. |
| */ |
| @Deprecated |
| public Notification(int icon, CharSequence tickerText, long when) |
| { |
| this.icon = icon; |
| this.tickerText = tickerText; |
| this.when = when; |
| this.creationTime = System.currentTimeMillis(); |
| } |
| |
| /** |
| * Unflatten the notification from a parcel. |
| */ |
| @SuppressWarnings("unchecked") |
| public Notification(Parcel parcel) { |
| // IMPORTANT: Add unmarshaling code in readFromParcel as the pending |
| // intents in extras are always written as the last entry. |
| readFromParcelImpl(parcel); |
| // Must be read last! |
| extrasPendingIntents = (ArraySet<PendingIntent>) parcel.readArraySet(null); |
| } |
| |
| private void readFromParcelImpl(Parcel parcel) |
| { |
| int version = parcel.readInt(); |
| |
| when = parcel.readLong(); |
| creationTime = parcel.readLong(); |
| if (parcel.readInt() != 0) { |
| mSmallIcon = Icon.CREATOR.createFromParcel(parcel); |
| if (mSmallIcon.getType() == Icon.TYPE_RESOURCE) { |
| icon = mSmallIcon.getResId(); |
| } |
| } |
| number = parcel.readInt(); |
| if (parcel.readInt() != 0) { |
| contentIntent = PendingIntent.CREATOR.createFromParcel(parcel); |
| } |
| if (parcel.readInt() != 0) { |
| deleteIntent = PendingIntent.CREATOR.createFromParcel(parcel); |
| } |
| if (parcel.readInt() != 0) { |
| tickerText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(parcel); |
| } |
| if (parcel.readInt() != 0) { |
| tickerView = RemoteViews.CREATOR.createFromParcel(parcel); |
| } |
| if (parcel.readInt() != 0) { |
| contentView = RemoteViews.CREATOR.createFromParcel(parcel); |
| } |
| if (parcel.readInt() != 0) { |
| mLargeIcon = Icon.CREATOR.createFromParcel(parcel); |
| } |
| defaults = parcel.readInt(); |
| flags = parcel.readInt(); |
| if (parcel.readInt() != 0) { |
| sound = Uri.CREATOR.createFromParcel(parcel); |
| } |
| |
| audioStreamType = parcel.readInt(); |
| if (parcel.readInt() != 0) { |
| audioAttributes = AudioAttributes.CREATOR.createFromParcel(parcel); |
| } |
| vibrate = parcel.createLongArray(); |
| ledARGB = parcel.readInt(); |
| ledOnMS = parcel.readInt(); |
| ledOffMS = parcel.readInt(); |
| iconLevel = parcel.readInt(); |
| |
| if (parcel.readInt() != 0) { |
| fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel); |
| } |
| |
| priority = parcel.readInt(); |
| |
| category = parcel.readString(); |
| |
| mGroupKey = parcel.readString(); |
| |
| mSortKey = parcel.readString(); |
| |
| extras = Bundle.setDefusable(parcel.readBundle(), true); // may be null |
| |
| actions = parcel.createTypedArray(Action.CREATOR); // may be null |
| |
| if (parcel.readInt() != 0) { |
| bigContentView = RemoteViews.CREATOR.createFromParcel(parcel); |
| } |
| |
| if (parcel.readInt() != 0) { |
| headsUpContentView = RemoteViews.CREATOR.createFromParcel(parcel); |
| } |
| |
| visibility = parcel.readInt(); |
| |
| if (parcel.readInt() != 0) { |
| publicVersion = Notification.CREATOR.createFromParcel(parcel); |
| } |
| |
| color = parcel.readInt(); |
| } |
| |
| @Override |
| public Notification clone() { |
| Notification that = new Notification(); |
| cloneInto(that, true); |
| return that; |
| } |
| |
| /** |
| * Copy all (or if heavy is false, all except Bitmaps and RemoteViews) members |
| * of this into that. |
| * @hide |
| */ |
| public void cloneInto(Notification that, boolean heavy) { |
| that.when = this.when; |
| that.creationTime = this.creationTime; |
| that.mSmallIcon = this.mSmallIcon; |
| that.number = this.number; |
| |
| // PendingIntents are global, so there's no reason (or way) to clone them. |
| that.contentIntent = this.contentIntent; |
| that.deleteIntent = this.deleteIntent; |
| that.fullScreenIntent = this.fullScreenIntent; |
| |
| if (this.tickerText != null) { |
| that.tickerText = this.tickerText.toString(); |
| } |
| if (heavy && this.tickerView != null) { |
| that.tickerView = this.tickerView.clone(); |
| } |
| if (heavy && this.contentView != null) { |
| that.contentView = this.contentView.clone(); |
| } |
| if (heavy && this.mLargeIcon != null) { |
| that.mLargeIcon = this.mLargeIcon; |
| } |
| that.iconLevel = this.iconLevel; |
| that.sound = this.sound; // android.net.Uri is immutable |
| that.audioStreamType = this.audioStreamType; |
| if (this.audioAttributes != null) { |
| that.audioAttributes = new AudioAttributes.Builder(this.audioAttributes).build(); |
| } |
| |
| final long[] vibrate = this.vibrate; |
| if (vibrate != null) { |
| final int N = vibrate.length; |
| final long[] vib = that.vibrate = new long[N]; |
| System.arraycopy(vibrate, 0, vib, 0, N); |
| } |
| |
| that.ledARGB = this.ledARGB; |
| that.ledOnMS = this.ledOnMS; |
| that.ledOffMS = this.ledOffMS; |
| that.defaults = this.defaults; |
| |
| that.flags = this.flags; |
| |
| that.priority = this.priority; |
| |
| that.category = this.category; |
| |
| that.mGroupKey = this.mGroupKey; |
| |
| that.mSortKey = this.mSortKey; |
| |
| if (this.extras != null) { |
| try { |
| that.extras = new Bundle(this.extras); |
| // will unparcel |
| that.extras.size(); |
| } catch (BadParcelableException e) { |
| Log.e(TAG, "could not unparcel extras from notification: " + this, e); |
| that.extras = null; |
| } |
| } |
| |
| if (!ArrayUtils.isEmpty(extrasPendingIntents)) { |
| that.extrasPendingIntents = new ArraySet<>(extrasPendingIntents); |
| } |
| |
| if (this.actions != null) { |
| that.actions = new Action[this.actions.length]; |
| for(int i=0; i<this.actions.length; i++) { |
| that.actions[i] = this.actions[i].clone(); |
| } |
| } |
| |
| if (heavy && this.bigContentView != null) { |
| that.bigContentView = this.bigContentView.clone(); |
| } |
| |
| if (heavy && this.headsUpContentView != null) { |
| that.headsUpContentView = this.headsUpContentView.clone(); |
| } |
| |
| that.visibility = this.visibility; |
| |
| if (this.publicVersion != null) { |
| that.publicVersion = new Notification(); |
| this.publicVersion.cloneInto(that.publicVersion, heavy); |
| } |
| |
| that.color = this.color; |
| |
| if (!heavy) { |
| that.lightenPayload(); // will clean out extras |
| } |
| } |
| |
| /** |
| * Removes heavyweight parts of the Notification object for archival or for sending to |
| * listeners when the full contents are not necessary. |
| * @hide |
| */ |
| public final void lightenPayload() { |
| tickerView = null; |
| contentView = null; |
| bigContentView = null; |
| headsUpContentView = null; |
| mLargeIcon = null; |
| if (extras != null && !extras.isEmpty()) { |
| final Set<String> keyset = extras.keySet(); |
| final int N = keyset.size(); |
| final String[] keys = keyset.toArray(new String[N]); |
| for (int i=0; i<N; i++) { |
| final String key = keys[i]; |
| final Object obj = extras.get(key); |
| if (obj != null && |
| ( obj instanceof Parcelable |
| || obj instanceof Parcelable[] |
| || obj instanceof SparseArray |
| || obj instanceof ArrayList)) { |
| extras.remove(key); |
| } |
| } |
| } |
| } |
| |
| /** |
| * Make sure this CharSequence is safe to put into a bundle, which basically |
| * means it had better not be some custom Parcelable implementation. |
| * @hide |
| */ |
| public static CharSequence safeCharSequence(CharSequence cs) { |
| if (cs == null) return cs; |
| if (cs.length() > MAX_CHARSEQUENCE_LENGTH) { |
| cs = cs.subSequence(0, MAX_CHARSEQUENCE_LENGTH); |
| } |
| if (cs instanceof Parcelable) { |
| Log.e(TAG, "warning: " + cs.getClass().getCanonicalName() |
| + " instance is a custom Parcelable and not allowed in Notification"); |
| return cs.toString(); |
| } |
| return removeTextSizeSpans(cs); |
| } |
| |
| private static CharSequence removeTextSizeSpans(CharSequence charSequence) { |
| if (charSequence instanceof Spanned) { |
| Spanned ss = (Spanned) charSequence; |
| Object[] spans = ss.getSpans(0, ss.length(), Object.class); |
| SpannableStringBuilder builder = new SpannableStringBuilder(ss.toString()); |
| for (Object span : spans) { |
| Object resultSpan = span; |
| if (resultSpan instanceof CharacterStyle) { |
| resultSpan = ((CharacterStyle) span).getUnderlying(); |
| } |
| if (resultSpan instanceof TextAppearanceSpan) { |
| TextAppearanceSpan originalSpan = (TextAppearanceSpan) resultSpan; |
| resultSpan = new TextAppearanceSpan( |
| originalSpan.getFamily(), |
| originalSpan.getTextStyle(), |
| -1, |
| originalSpan.getTextColor(), |
| originalSpan.getLinkTextColor()); |
| } else if (resultSpan instanceof RelativeSizeSpan |
| || resultSpan instanceof AbsoluteSizeSpan) { |
| continue; |
| } else { |
| resultSpan = span; |
| } |
| builder.setSpan(resultSpan, ss.getSpanStart(span), ss.getSpanEnd(span), |
| ss.getSpanFlags(span)); |
| } |
| return builder; |
| } |
| return charSequence; |
| } |
| |
| public int describeContents() { |
| return 0; |
| } |
| |
| /** |
| * Flatten this notification into a parcel. |
| */ |
| public void writeToParcel(Parcel parcel, int flags) { |
| // We need to mark all pending intents getting into the notification |
| // system as being put there to later allow the notification ranker |
| // to launch them and by doing so add the app to the battery saver white |
| // list for a short period of time. The problem is that the system |
| // cannot look into the extras as there may be parcelables there that |
| // the platform does not know how to handle. To go around that we have |
| // an explicit list of the pending intents in the extras bundle. |
| final boolean collectPendingIntents = (extrasPendingIntents == null); |
| if (collectPendingIntents) { |
| PendingIntent.setOnMarshaledListener( |
| (PendingIntent intent, Parcel out, int outFlags) -> { |
| if (parcel == out) { |
| if (extrasPendingIntents == null) { |
| extrasPendingIntents = new ArraySet<>(); |
| } |
| extrasPendingIntents.add(intent); |
| } |
| }); |
| } |
| try { |
| // IMPORTANT: Add marshaling code in writeToParcelImpl as we |
| // want to intercept all pending events written to the pacel. |
| writeToParcelImpl(parcel, flags); |
| // Must be written last! |
| parcel.writeArraySet(extrasPendingIntents); |
| } finally { |
| if (collectPendingIntents) { |
| PendingIntent.setOnMarshaledListener(null); |
| } |
| } |
| } |
| |
| private void writeToParcelImpl(Parcel parcel, int flags) { |
| parcel.writeInt(1); |
| |
| parcel.writeLong(when); |
| parcel.writeLong(creationTime); |
| if (mSmallIcon == null && icon != 0) { |
| // you snuck an icon in here without using the builder; let's try to keep it |
| mSmallIcon = Icon.createWithResource("", icon); |
| } |
| if (mSmallIcon != null) { |
| parcel.writeInt(1); |
| mSmallIcon.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| parcel.writeInt(number); |
| if (contentIntent != null) { |
| parcel.writeInt(1); |
| contentIntent.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| if (deleteIntent != null) { |
| parcel.writeInt(1); |
| deleteIntent.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| if (tickerText != null) { |
| parcel.writeInt(1); |
| TextUtils.writeToParcel(tickerText, parcel, flags); |
| } else { |
| parcel.writeInt(0); |
| } |
| if (tickerView != null) { |
| parcel.writeInt(1); |
| tickerView.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| if (contentView != null) { |
| parcel.writeInt(1); |
| contentView.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| if (mLargeIcon == null && largeIcon != null) { |
| // you snuck an icon in here without using the builder; let's try to keep it |
| mLargeIcon = Icon.createWithBitmap(largeIcon); |
| } |
| if (mLargeIcon != null) { |
| parcel.writeInt(1); |
| mLargeIcon.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| |
| parcel.writeInt(defaults); |
| parcel.writeInt(this.flags); |
| |
| if (sound != null) { |
| parcel.writeInt(1); |
| sound.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| parcel.writeInt(audioStreamType); |
| |
| if (audioAttributes != null) { |
| parcel.writeInt(1); |
| audioAttributes.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| |
| parcel.writeLongArray(vibrate); |
| parcel.writeInt(ledARGB); |
| parcel.writeInt(ledOnMS); |
| parcel.writeInt(ledOffMS); |
| parcel.writeInt(iconLevel); |
| |
| if (fullScreenIntent != null) { |
| parcel.writeInt(1); |
| fullScreenIntent.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| |
| parcel.writeInt(priority); |
| |
| parcel.writeString(category); |
| |
| parcel.writeString(mGroupKey); |
| |
| parcel.writeString(mSortKey); |
| |
| parcel.writeBundle(extras); // null ok |
| |
| parcel.writeTypedArray(actions, 0); // null ok |
| |
| if (bigContentView != null) { |
| parcel.writeInt(1); |
| bigContentView.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| |
| if (headsUpContentView != null) { |
| parcel.writeInt(1); |
| headsUpContentView.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| |
| parcel.writeInt(visibility); |
| |
| if (publicVersion != null) { |
| parcel.writeInt(1); |
| publicVersion.writeToParcel(parcel, 0); |
| } else { |
| parcel.writeInt(0); |
| } |
| |
| parcel.writeInt(color); |
| } |
| |
| /** |
| * Parcelable.Creator that instantiates Notification objects |
| */ |
| public static final Parcelable.Creator<Notification> CREATOR |
| = new Parcelable.Creator<Notification>() |
| { |
| public Notification createFromParcel(Parcel parcel) |
| { |
| return new Notification(parcel); |
| } |
| |
| public Notification[] newArray(int size) |
| { |
| return new Notification[size]; |
| } |
| }; |
| |
| /** |
| * Sets the {@link #contentView} field to be a view with the standard "Latest Event" |
| * layout. |
| * |
| * <p>Uses the {@link #icon} and {@link #when} fields to set the icon and time fields |
| * in the view.</p> |
| * @param context The context for your application / activity. |
| * @param contentTitle The title that goes in the expanded entry. |
| * @param contentText The text that goes in the expanded entry. |
| * @param contentIntent The intent to launch when the user clicks the expanded notification. |
| * If this is an activity, it must include the |
| * {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK} flag, which requires |
| * that you take care of task management as described in the |
| * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back |
| * Stack</a> document. |
| * |
| * @deprecated Use {@link Builder} instead. |
| * @removed |
| */ |
| @Deprecated |
| public void setLatestEventInfo(Context context, |
| CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) { |
| if (context.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.LOLLIPOP_MR1){ |
| Log.e(TAG, "setLatestEventInfo() is deprecated and you should feel deprecated.", |
| new Throwable()); |
| } |
| |
| if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) { |
| extras.putBoolean(EXTRA_SHOW_WHEN, true); |
| } |
| |
| // ensure that any information already set directly is preserved |
| final Notification.Builder builder = new Notification.Builder(context, this); |
| |
| // now apply the latestEventInfo fields |
| if (contentTitle != null) { |
| builder.setContentTitle(contentTitle); |
| } |
| if (contentText != null) { |
| builder.setContentText(contentText); |
| } |
| builder.setContentIntent(contentIntent); |
| |
| builder.build(); // callers expect this notification to be ready to use |
| } |
| |
| /** |
| * @hide |
| */ |
| public static void addFieldsFromContext(Context context, Notification notification) { |
| addFieldsFromContext(context.getApplicationInfo(), context.getUserId(), notification); |
| } |
| |
| /** |
| * @hide |
| */ |
| public static void addFieldsFromContext(ApplicationInfo ai, int userId, |
| Notification notification) { |
| notification.extras.putParcelable(EXTRA_BUILDER_APPLICATION_INFO, ai); |
| notification.extras.putInt(EXTRA_ORIGINATING_USERID, userId); |
| } |
| |
| @Override |
| public String toString() { |
| StringBuilder sb = new StringBuilder(); |
| sb.append("Notification(pri="); |
| sb.append(priority); |
| sb.append(" contentView="); |
| if (contentView != null) { |
| sb.append(contentView.getPackage()); |
| sb.append("/0x"); |
| sb.append(Integer.toHexString(contentView.getLayoutId())); |
| } else { |
| sb.append("null"); |
| } |
| sb.append(" vibrate="); |
| if ((this.defaults & DEFAULT_VIBRATE) != 0) { |
| sb.append("default"); |
| } else if (this.vibrate != null) { |
| int N = this.vibrate.length-1; |
| sb.append("["); |
| for (int i=0; i<N; i++) { |
| sb.append(this.vibrate[i]); |
| sb.append(','); |
| } |
| if (N != -1) { |
| sb.append(this.vibrate[N]); |
| } |
| sb.append("]"); |
| } else { |
| sb.append("null"); |
| } |
| sb.append(" sound="); |
| if ((this.defaults & DEFAULT_SOUND) != 0) { |
| sb.append("default"); |
| } else if (this.sound != null) { |
| sb.append(this.sound.toString()); |
| } else { |
| sb.append("null"); |
| } |
| if (this.tickerText != null) { |
| sb.append(" tick"); |
| } |
| sb.append(" defaults=0x"); |
| sb.append(Integer.toHexString(this.defaults)); |
| sb.append(" flags=0x"); |
| sb.append(Integer.toHexString(this.flags)); |
| sb.append(String.format(" color=0x%08x", this.color)); |
| if (this.category != null) { |
| sb.append(" category="); |
| sb.append(this.category); |
| } |
| if (this.mGroupKey != null) { |
| sb.append(" groupKey="); |
| sb.append(this.mGroupKey); |
| } |
| if (this.mSortKey != null) { |
| sb.append(" sortKey="); |
| sb.append(this.mSortKey); |
| } |
| if (actions != null) { |
| sb.append(" actions="); |
| sb.append(actions.length); |
| } |
| sb.append(" vis="); |
| sb.append(visibilityToString(this.visibility)); |
| if (this.publicVersion != null) { |
| sb.append(" publicVersion="); |
| sb.append(publicVersion.toString()); |
| } |
| sb.append(")"); |
| return sb.toString(); |
| } |
| |
| /** |
| * {@hide} |
| */ |
| public static String visibilityToString(int vis) { |
| switch (vis) { |
| case VISIBILITY_PRIVATE: |
| return "PRIVATE"; |
| case VISIBILITY_PUBLIC: |
| return "PUBLIC"; |
| case VISIBILITY_SECRET: |
| return "SECRET"; |
| default: |
| return "UNKNOWN(" + String.valueOf(vis) + ")"; |
| } |
| } |
| |
| /** |
| * {@hide} |
| */ |
| public static String priorityToString(@Priority int pri) { |
| switch (pri) { |
| case PRIORITY_MIN: |
| return "MIN"; |
| case PRIORITY_LOW: |
| return "LOW"; |
| case PRIORITY_DEFAULT: |
| return "DEFAULT"; |
| case PRIORITY_HIGH: |
| return "HIGH"; |
| case PRIORITY_MAX: |
| return "MAX"; |
| default: |
| return "UNKNOWN(" + String.valueOf(pri) + ")"; |
| } |
| } |
| |
| /** |
| * The small icon representing this notification in the status bar and content view. |
| * |
| * @return the small icon representing this notification. |
| * |
| * @see Builder#getSmallIcon() |
| * @see Builder#setSmallIcon(Icon) |
| */ |
| public Icon getSmallIcon() { |
| return mSmallIcon; |
| } |
| |
| /** |
| * Used when notifying to clean up legacy small icons. |
| * @hide |
| */ |
| public void setSmallIcon(Icon icon) { |
| mSmallIcon = icon; |
| } |
| |
| /** |
| * The large icon shown in this notification's content view. |
| * @see Builder#getLargeIcon() |
| * @see Builder#setLargeIcon(Icon) |
| */ |
| public Icon getLargeIcon() { |
| return mLargeIcon; |
| } |
| |
| /** |
| * @hide |
| */ |
| public boolean isGroupSummary() { |
| return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) != 0; |
| } |
| |
| /** |
| * @hide |
| */ |
| public boolean isGroupChild() { |
| return mGroupKey != null && (flags & FLAG_GROUP_SUMMARY) == 0; |
| } |
| |
| /** |
| * Builder class for {@link Notification} objects. |
| * |
| * Provides a convenient way to set the various fields of a {@link Notification} and generate |
| * content views using the platform's notification layout template. If your app supports |
| * versions of Android as old as API level 4, you can instead use |
| * {@link android.support.v4.app.NotificationCompat.Builder NotificationCompat.Builder}, |
| * available in the <a href="{@docRoot}tools/extras/support-library.html">Android Support |
| * library</a>. |
| * |
| * <p>Example: |
| * |
| * <pre class="prettyprint"> |
| * Notification noti = new Notification.Builder(mContext) |
| * .setContentTitle("New mail from " + sender.toString()) |
| * .setContentText(subject) |
| * .setSmallIcon(R.drawable.new_mail) |
| * .setLargeIcon(aBitmap) |
| * .build(); |
| * </pre> |
| */ |
| public static class Builder { |
| /** |
| * @hide |
| */ |
| public static final String EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT = |
| "android.rebuild.contentViewActionCount"; |
| /** |
| * @hide |
| */ |
| public static final String EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT |
| = "android.rebuild.bigViewActionCount"; |
| /** |
| * @hide |
| */ |
| public static final String EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT |
| = "android.rebuild.hudViewActionCount"; |
| |
| private static final int MAX_ACTION_BUTTONS = 3; |
| |
| private Context mContext; |
| private Notification mN; |
| private Bundle mUserExtras = new Bundle(); |
| private Style mStyle; |
| private ArrayList<Action> mActions = new ArrayList<Action>(MAX_ACTION_BUTTONS); |
| private ArrayList<String> mPersonList = new ArrayList<String>(); |
| private NotificationColorUtil mColorUtil; |
| private boolean mColorUtilInited = false; |
| |
| /** |
| * Caches a contrast-enhanced version of {@link #mCachedContrastColorIsFor}. |
| */ |
| private int mCachedContrastColor = COLOR_INVALID; |
| private int mCachedContrastColorIsFor = COLOR_INVALID; |
| |
| /** |
| * Constructs a new Builder with the defaults: |
| * |
| |
| * <table> |
| * <tr><th align=right>priority</th> |
| * <td>{@link #PRIORITY_DEFAULT}</td></tr> |
| * <tr><th align=right>when</th> |
| * <td>now ({@link System#currentTimeMillis()})</td></tr> |
| * <tr><th align=right>audio stream</th> |
| * <td>{@link #STREAM_DEFAULT}</td></tr> |
| * </table> |
| * |
| |
| * @param context |
| * A {@link Context} that will be used by the Builder to construct the |
| * RemoteViews. The Context will not be held past the lifetime of this Builder |
| * object. |
| */ |
| public Builder(Context context) { |
| this(context, null); |
| } |
| |
| /** |
| * @hide |
| */ |
| public Builder(Context context, Notification toAdopt) { |
| mContext = context; |
| |
| if (toAdopt == null) { |
| mN = new Notification(); |
| if (context.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N) { |
| mN.extras.putBoolean(EXTRA_SHOW_WHEN, true); |
| } |
| mN.priority = PRIORITY_DEFAULT; |
| mN.visibility = VISIBILITY_PRIVATE; |
| } else { |
| mN = toAdopt; |
| if (mN.actions != null) { |
| Collections.addAll(mActions, mN.actions); |
| } |
| |
| if (mN.extras.containsKey(EXTRA_PEOPLE)) { |
| Collections.addAll(mPersonList, mN.extras.getStringArray(EXTRA_PEOPLE)); |
| } |
| |
| if (mN.getSmallIcon() == null && mN.icon != 0) { |
| setSmallIcon(mN.icon); |
| } |
| |
| if (mN.getLargeIcon() == null && mN.largeIcon != null) { |
| setLargeIcon(mN.largeIcon); |
| } |
| |
| String templateClass = mN.extras.getString(EXTRA_TEMPLATE); |
| if (!TextUtils.isEmpty(templateClass)) { |
| final Class<? extends Style> styleClass |
| = getNotificationStyleClass(templateClass); |
| if (styleClass == null) { |
| Log.d(TAG, "Unknown style class: " + templateClass); |
| } else { |
| try { |
| final Constructor<? extends Style> ctor = |
| styleClass.getDeclaredConstructor(); |
| ctor.setAccessible(true); |
| final Style style = ctor.newInstance(); |
| style.restoreFromExtras(mN.extras); |
| |
| if (style != null) { |
| setStyle(style); |
| } |
| } catch (Throwable t) { |
| Log.e(TAG, "Could not create Style", t); |
| } |
| } |
| } |
| |
| } |
| } |
| |
| private NotificationColorUtil getColorUtil() { |
| if (!mColorUtilInited) { |
| mColorUtilInited = true; |
| if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.LOLLIPOP) { |
| mColorUtil = NotificationColorUtil.getInstance(mContext); |
| } |
| } |
| return mColorUtil; |
| } |
| |
| /** |
| * Add a timestamp pertaining to the notification (usually the time the event occurred). |
| * |
| * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this time is not |
| * shown anymore by default and must be opted into by using |
| * {@link android.app.Notification.Builder#setShowWhen(boolean)} |
| * |
| * @see Notification#when |
| */ |
| public Builder setWhen(long when) { |
| mN.when = when; |
| return this; |
| } |
| |
| /** |
| * Control whether the timestamp set with {@link #setWhen(long) setWhen} is shown |
| * in the content view. |
| * For apps targeting {@link android.os.Build.VERSION_CODES#N} and above, this defaults to |
| * {@code false}. For earlier apps, the default is {@code true}. |
| */ |
| public Builder setShowWhen(boolean show) { |
| mN.extras.putBoolean(EXTRA_SHOW_WHEN, show); |
| return this; |
| } |
| |
| /** |
| * Show the {@link Notification#when} field as a stopwatch. |
| * |
| * Instead of presenting <code>when</code> as a timestamp, the notification will show an |
| * automatically updating display of the minutes and seconds since <code>when</code>. |
| * |
| * Useful when showing an elapsed time (like an ongoing phone call). |
| * |
| * The counter can also be set to count down to <code>when</code> when using |
| * {@link #setChronometerCountDown(boolean)}. |
| * |
| * @see android.widget.Chronometer |
| * @see Notification#when |
| * @see #setChronometerCountDown(boolean) |
| */ |
| public Builder setUsesChronometer(boolean b) { |
| mN.extras.putBoolean(EXTRA_SHOW_CHRONOMETER, b); |
| return this; |
| } |
| |
| /** |
| * Sets the Chronometer to count down instead of counting up. |
| * |
| * <p>This is only relevant if {@link #setUsesChronometer(boolean)} has been set to true. |
| * If it isn't set the chronometer will count up. |
| * |
| * @see #setUsesChronometer(boolean) |
| */ |
| public Builder setChronometerCountDown(boolean countDown) { |
| mN.extras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, countDown); |
| return this; |
| } |
| |
| /** |
| * Set the small icon resource, which will be used to represent the notification in the |
| * status bar. |
| * |
| |
| * The platform template for the expanded view will draw this icon in the left, unless a |
| * {@link #setLargeIcon(Bitmap) large icon} has also been specified, in which case the small |
| * icon will be moved to the right-hand side. |
| * |
| |
| * @param icon |
| * A resource ID in the application's package of the drawable to use. |
| * @see Notification#icon |
| */ |
| public Builder setSmallIcon(@DrawableRes int icon) { |
| return setSmallIcon(icon != 0 |
| ? Icon.createWithResource(mContext, icon) |
| : null); |
| } |
| |
| /** |
| * A variant of {@link #setSmallIcon(int) setSmallIcon(int)} that takes an additional |
| * level parameter for when the icon is a {@link android.graphics.drawable.LevelListDrawable |
| * LevelListDrawable}. |
| * |
| * @param icon A resource ID in the application's package of the drawable to use. |
| * @param level The level to use for the icon. |
| * |
| * @see Notification#icon |
| * @see Notification#iconLevel |
| */ |
| public Builder setSmallIcon(@DrawableRes int icon, int level) { |
| mN.iconLevel = level; |
| return setSmallIcon(icon); |
| } |
| |
| /** |
| * Set the small icon, which will be used to represent the notification in the |
| * status bar and content view (unless overriden there by a |
| * {@link #setLargeIcon(Bitmap) large icon}). |
| * |
| * @param icon An Icon object to use. |
| * @see Notification#icon |
| */ |
| public Builder setSmallIcon(Icon icon) { |
| mN.setSmallIcon(icon); |
| if (icon != null && icon.getType() == Icon.TYPE_RESOURCE) { |
| mN.icon = icon.getResId(); |
| } |
| return this; |
| } |
| |
| /** |
| * Set the first line of text in the platform notification template. |
| */ |
| public Builder setContentTitle(CharSequence title) { |
| mN.extras.putCharSequence(EXTRA_TITLE, safeCharSequence(title)); |
| return this; |
| } |
| |
| /** |
| * Set the second line of text in the platform notification template. |
| */ |
| public Builder setContentText(CharSequence text) { |
| mN.extras.putCharSequence(EXTRA_TEXT, safeCharSequence(text)); |
| return this; |
| } |
| |
| /** |
| * This provides some additional information that is displayed in the notification. No |
| * guarantees are given where exactly it is displayed. |
| * |
| * <p>This information should only be provided if it provides an essential |
| * benefit to the understanding of the notification. The more text you provide the |
| * less readable it becomes. For example, an email client should only provide the account |
| * name here if more than one email account has been added.</p> |
| * |
| * <p>As of {@link android.os.Build.VERSION_CODES#N} this information is displayed in the |
| * notification header area. |
| * |
| * On Android versions before {@link android.os.Build.VERSION_CODES#N} |
| * this will be shown in the third line of text in the platform notification template. |
| * You should not be using {@link #setProgress(int, int, boolean)} at the |
| * same time on those versions; they occupy the same place. |
| * </p> |
| */ |
| public Builder setSubText(CharSequence text) { |
| mN.extras.putCharSequence(EXTRA_SUB_TEXT, safeCharSequence(text)); |
| return this; |
| } |
| |
| /** |
| * Set the remote input history. |
| * |
| * This should be set to the most recent inputs that have been sent |
| * through a {@link RemoteInput} of this Notification and cleared once the it is no |
| * longer relevant (e.g. for chat notifications once the other party has responded). |
| * |
| * The most recent input must be stored at the 0 index, the second most recent at the |
| * 1 index, etc. Note that the system will limit both how far back the inputs will be shown |
| * and how much of each individual input is shown. |
| * |
| * <p>Note: The reply text will only be shown on notifications that have least one action |
| * with a {@code RemoteInput}.</p> |
| */ |
| public Builder setRemoteInputHistory(CharSequence[] text) { |
| if (text == null) { |
| mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, null); |
| } else { |
| final int N = Math.min(MAX_REPLY_HISTORY, text.length); |
| CharSequence[] safe = new CharSequence[N]; |
| for (int i = 0; i < N; i++) { |
| safe[i] = safeCharSequence(text[i]); |
| } |
| mN.extras.putCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY, safe); |
| } |
| return this; |
| } |
| |
| /** |
| * Set the large number at the right-hand side of the notification. This is |
| * equivalent to setContentInfo, although it might show the number in a different |
| * font size for readability. |
| * |
| * @deprecated this number is not shown anywhere anymore |
| */ |
| public Builder setNumber(int number) { |
| mN.number = number; |
| return this; |
| } |
| |
| /** |
| * A small piece of additional information pertaining to this notification. |
| * |
| * The platform template will draw this on the last line of the notification, at the far |
| * right (to the right of a smallIcon if it has been placed there). |
| * |
| * @deprecated use {@link #setSubText(CharSequence)} instead to set a text in the header. |
| * For legacy apps targeting a version below {@link android.os.Build.VERSION_CODES#N} this |
| * field will still show up, but the subtext will take precedence. |
| */ |
| public Builder setContentInfo(CharSequence info) { |
| mN.extras.putCharSequence(EXTRA_INFO_TEXT, safeCharSequence(info)); |
| return this; |
| } |
| |
| /** |
| * Set the progress this notification represents. |
| * |
| * The platform template will represent this using a {@link ProgressBar}. |
| */ |
| public Builder setProgress(int max, int progress, boolean indeterminate) { |
| mN.extras.putInt(EXTRA_PROGRESS, progress); |
| mN.extras.putInt(EXTRA_PROGRESS_MAX, max); |
| mN.extras.putBoolean(EXTRA_PROGRESS_INDETERMINATE, indeterminate); |
| return this; |
| } |
| |
| /** |
| * Supply a custom RemoteViews to use instead of the platform template. |
| * |
| * Use {@link #setCustomContentView(RemoteViews)} instead. |
| */ |
| @Deprecated |
| public Builder setContent(RemoteViews views) { |
| return setCustomContentView(views); |
| } |
| |
| /** |
| * Supply custom RemoteViews to use instead of the platform template. |
| * |
| * This will override the layout that would otherwise be constructed by this Builder |
| * object. |
| */ |
| public Builder setCustomContentView(RemoteViews contentView) { |
| mN.contentView = contentView; |
| return this; |
| } |
| |
| /** |
| * Supply custom RemoteViews to use instead of the platform template in the expanded form. |
| * |
| * This will override the expanded layout that would otherwise be constructed by this |
| * Builder object. |
| */ |
| public Builder setCustomBigContentView(RemoteViews contentView) { |
| mN.bigContentView = contentView; |
| return this; |
| } |
| |
| /** |
| * Supply custom RemoteViews to use instead of the platform template in the heads up dialog. |
| * |
| * This will override the heads-up layout that would otherwise be constructed by this |
| * Builder object. |
| */ |
| public Builder setCustomHeadsUpContentView(RemoteViews contentView) { |
| mN.headsUpContentView = contentView; |
| return this; |
| } |
| |
| /** |
| * Supply a {@link PendingIntent} to be sent when the notification is clicked. |
| * |
| * As of {@link android.os.Build.VERSION_CODES#HONEYCOMB}, if this field is unset and you |
| * have specified a custom RemoteViews with {@link #setContent(RemoteViews)}, you can use |
| * {@link RemoteViews#setOnClickPendingIntent RemoteViews.setOnClickPendingIntent(int,PendingIntent)} |
| * to assign PendingIntents to individual views in that custom layout (i.e., to create |
| * clickable buttons inside the notification view). |
| * |
| * @see Notification#contentIntent Notification.contentIntent |
| */ |
| public Builder setContentIntent(PendingIntent intent) { |
| mN.contentIntent = intent; |
| return this; |
| } |
| |
| /** |
| * Supply a {@link PendingIntent} to send when the notification is cleared explicitly by the user. |
| * |
| * @see Notification#deleteIntent |
| */ |
| public Builder setDeleteIntent(PendingIntent intent) { |
| mN.deleteIntent = intent; |
| return this; |
| } |
| |
| /** |
| * An intent to launch instead of posting the notification to the status bar. |
| * Only for use with extremely high-priority notifications demanding the user's |
| * <strong>immediate</strong> attention, such as an incoming phone call or |
| * alarm clock that the user has explicitly set to a particular time. |
| * If this facility is used for something else, please give the user an option |
| * to turn it off and use a normal notification, as this can be extremely |
| * disruptive. |
| * |
| * <p> |
| * The system UI may choose to display a heads-up notification, instead of |
| * launching this intent, while the user is using the device. |
| * </p> |
| * |
| * @param intent The pending intent to launch. |
| * @param highPriority Passing true will cause this notification to be sent |
| * even if other notifications are suppressed. |
| * |
| * @see Notification#fullScreenIntent |
| */ |
| public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) { |
| mN.fullScreenIntent = intent; |
| setFlag(FLAG_HIGH_PRIORITY, highPriority); |
| return this; |
| } |
| |
| /** |
| * Set the "ticker" text which is sent to accessibility services. |
| * |
| * @see Notification#tickerText |
| */ |
| public Builder setTicker(CharSequence tickerText) { |
| mN.tickerText = safeCharSequence(tickerText); |
| return this; |
| } |
| |
| /** |
| * Obsolete version of {@link #setTicker(CharSequence)}. |
| * |
| */ |
| @Deprecated |
| public Builder setTicker(CharSequence tickerText, RemoteViews views) { |
| setTicker(tickerText); |
| // views is ignored |
| return this; |
| } |
| |
| /** |
| * Add a large icon to the notification content view. |
| * |
| * In the platform template, this image will be shown on the left of the notification view |
| * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small |
| * badge atop the large icon). |
| */ |
| public Builder setLargeIcon(Bitmap b) { |
| return setLargeIcon(b != null ? Icon.createWithBitmap(b) : null); |
| } |
| |
| /** |
| * Add a large icon to the notification content view. |
| * |
| * In the platform template, this image will be shown on the left of the notification view |
| * in place of the {@link #setSmallIcon(Icon) small icon} (which will be placed in a small |
| * badge atop the large icon). |
| */ |
| public Builder setLargeIcon(Icon icon) { |
| mN.mLargeIcon = icon; |
| mN.extras.putParcelable(EXTRA_LARGE_ICON, icon); |
| return this; |
| } |
| |
| /** |
| * Set the sound to play. |
| * |
| * It will be played using the {@link #AUDIO_ATTRIBUTES_DEFAULT default audio attributes} |
| * for notifications. |
| * |
| * <p> |
| * A notification that is noisy is more likely to be presented as a heads-up notification. |
| * </p> |
| * |
| * @see Notification#sound |
| */ |
| public Builder setSound(Uri sound) { |
| mN.sound = sound; |
| mN.audioAttributes = AUDIO_ATTRIBUTES_DEFAULT; |
| return this; |
| } |
| |
| /** |
| * Set the sound to play, along with a specific stream on which to play it. |
| * |
| * See {@link android.media.AudioManager} for the <code>STREAM_</code> constants. |
| * |
| * <p> |
| * A notification that is noisy is more likely to be presented as a heads-up notification. |
| * </p> |
| * @deprecated use {@link #setSound(Uri, AudioAttributes)} instead. |
| * @see Notification#sound |
| */ |
| @Deprecated |
| public Builder setSound(Uri sound, int streamType) { |
| mN.sound = sound; |
| mN.audioStreamType = streamType; |
| return this; |
| } |
| |
| /** |
| * Set the sound to play, along with specific {@link AudioAttributes audio attributes} to |
| * use during playback. |
| * |
| * <p> |
| * A notification that is noisy is more likely to be presented as a heads-up notification. |
| * </p> |
| * |
| * @see Notification#sound |
| */ |
| public Builder setSound(Uri sound, AudioAttributes audioAttributes) { |
| mN.sound = sound; |
| mN.audioAttributes = audioAttributes; |
| return this; |
| } |
| |
| /** |
| * Set the vibration pattern to use. |
| * |
| * See {@link android.os.Vibrator#vibrate(long[], int)} for a discussion of the |
| * <code>pattern</code> parameter. |
| * |
| * <p> |
| * A notification that vibrates is more likely to be presented as a heads-up notification. |
| * </p> |
| * |
| * @see Notification#vibrate |
| */ |
| public Builder setVibrate(long[] pattern) { |
| mN.vibrate = pattern; |
| return this; |
| } |
| |
| /** |
| * Set the desired color for the indicator LED on the device, as well as the |
| * blink duty cycle (specified in milliseconds). |
| * |
| |
| * Not all devices will honor all (or even any) of these values. |
| * |
| |
| * @see Notification#ledARGB |
| * @see Notification#ledOnMS |
| * @see Notification#ledOffMS |
| */ |
| public Builder setLights(@ColorInt int argb, int onMs, int offMs) { |
| mN.ledARGB = argb; |
| mN.ledOnMS = onMs; |
| mN.ledOffMS = offMs; |
| if (onMs != 0 || offMs != 0) { |
| mN.flags |= FLAG_SHOW_LIGHTS; |
| } |
| return this; |
| } |
| |
| /** |
| * Set whether this is an "ongoing" notification. |
| * |
| |
| * Ongoing notifications cannot be dismissed by the user, so your application or service |
| * must take care of canceling them. |
| * |
| |
| * They are typically used to indicate a background task that the user is actively engaged |
| * with (e.g., playing music) or is pending in some way and therefore occupying the device |
| * (e.g., a file download, sync operation, active network connection). |
| * |
| |
| * @see Notification#FLAG_ONGOING_EVENT |
| * @see Service#setForeground(boolean) |
| */ |
| public Builder setOngoing(boolean ongoing) { |
| setFlag(FLAG_ONGOING_EVENT, ongoing); |
| return this; |
| } |
| |
| /** |
| * Set this flag if you would only like the sound, vibrate |
| * and ticker to be played if the notification is not already showing. |
| * |
| * @see Notification#FLAG_ONLY_ALERT_ONCE |
| */ |
| public Builder setOnlyAlertOnce(boolean onlyAlertOnce) { |
| setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce); |
| return this; |
| } |
| |
| /** |
| * Make this notification automatically dismissed when the user touches it. The |
| * PendingIntent set with {@link #setDeleteIntent} will be sent when this happens. |
| * |
| * @see Notification#FLAG_AUTO_CANCEL |
| */ |
| public Builder setAutoCancel(boolean autoCancel) { |
| setFlag(FLAG_AUTO_CANCEL, autoCancel); |
| return this; |
| } |
| |
| /** |
| * Set whether or not this notification should not bridge to other devices. |
| * |
| * <p>Some notifications can be bridged to other devices for remote display. |
| * This hint can be set to recommend this notification not be bridged. |
| */ |
| public Builder setLocalOnly(boolean localOnly) { |
| setFlag(FLAG_LOCAL_ONLY, localOnly); |
| return this; |
| } |
| |
| /** |
| * Set which notification properties will be inherited from system defaults. |
| * <p> |
| * The value should be one or more of the following fields combined with |
| * bitwise-or: |
| * {@link #DEFAULT_SOUND}, {@link #DEFAULT_VIBRATE}, {@link #DEFAULT_LIGHTS}. |
| * <p> |
| * For all default values, use {@link #DEFAULT_ALL}. |
| */ |
| public Builder setDefaults(int defaults) { |
| mN.defaults = defaults; |
| return this; |
| } |
| |
| /** |
| * Set the priority of this notification. |
| * |
| * @see Notification#priority |
| */ |
| public Builder setPriority(@Priority int pri) { |
| mN.priority = pri; |
| return this; |
| } |
| |
| /** |
| * Set the notification category. |
| * |
| * @see Notification#category |
| */ |
| public Builder setCategory(String category) { |
| mN.category = category; |
| return this; |
| } |
| |
| /** |
| * Add a person that is relevant to this notification. |
| * |
| * <P> |
| * Depending on user preferences, this annotation may allow the notification to pass |
| * through interruption filters, and to appear more prominently in the user interface. |
| * </P> |
| * |
| * <P> |
| * The person should be specified by the {@code String} representation of a |
| * {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}. |
| * </P> |
| * |
| * <P>The system will also attempt to resolve {@code mailto:} and {@code tel:} schema |
| * URIs. The path part of these URIs must exist in the contacts database, in the |
| * appropriate column, or the reference will be discarded as invalid. Telephone schema |
| * URIs will be resolved by {@link android.provider.ContactsContract.PhoneLookup}. |
| * </P> |
| * |
| * @param uri A URI for the person. |
| * @see Notification#EXTRA_PEOPLE |
| */ |
| public Builder addPerson(String uri) { |
| mPersonList.add(uri); |
| return this; |
| } |
| |
| /** |
| * Set this notification to be part of a group of notifications sharing the same key. |
| * Grouped notifications may display in a cluster or stack on devices which |
| * support such rendering. |
| * |
| * <p>To make this notification the summary for its group, also call |
| * {@link #setGroupSummary}. A sort order can be specified for group members by using |
| * {@link #setSortKey}. |
| * @param groupKey The group key of the group. |
| * @return this object for method chaining |
| */ |
| public Builder setGroup(String groupKey) { |
| mN.mGroupKey = groupKey; |
| return this; |
| } |
| |
| /** |
| * Set this notification to be the group summary for a group of notifications. |
| * Grouped notifications may display in a cluster or stack on devices which |
| * support such rendering. Requires a group key also be set using {@link #setGroup}. |
| * @param isGroupSummary Whether this notification should be a group summary. |
| * @return this object for method chaining |
| */ |
| public Builder setGroupSummary(boolean isGroupSummary) { |
| setFlag(FLAG_GROUP_SUMMARY, isGroupSummary); |
| return this; |
| } |
| |
| /** |
| * Set a sort key that orders this notification among other notifications from the |
| * same package. This can be useful if an external sort was already applied and an app |
| * would like to preserve this. Notifications will be sorted lexicographically using this |
| * value, although providing different priorities in addition to providing sort key may |
| * cause this value to be ignored. |
| * |
| * <p>This sort key can also be used to order members of a notification group. See |
| * {@link #setGroup}. |
| * |
| * @see String#compareTo(String) |
| */ |
| public Builder setSortKey(String sortKey) { |
| mN.mSortKey = sortKey; |
| return this; |
| } |
| |
| /** |
| * Merge additional metadata into this notification. |
| * |
| * <p>Values within the Bundle will replace existing extras values in this Builder. |
| * |
| * @see Notification#extras |
| */ |
| public Builder addExtras(Bundle extras) { |
| if (extras != null) { |
| mUserExtras.putAll(extras); |
| } |
| return this; |
| } |
| |
| /** |
| * Set metadata for this notification. |
| * |
| * <p>A reference to the Bundle is held for the lifetime of this Builder, and the Bundle's |
| * current contents are copied into the Notification each time {@link #build()} is |
| * called. |
| * |
| * <p>Replaces any existing extras values with those from the provided Bundle. |
| * Use {@link #addExtras} to merge in metadata instead. |
| * |
| * @see Notification#extras |
| */ |
| public Builder setExtras(Bundle extras) { |
| if (extras != null) { |
| mUserExtras = extras; |
| } |
| return this; |
| } |
| |
| /** |
| * Get the current metadata Bundle used by this notification Builder. |
| * |
| * <p>The returned Bundle is shared with this Builder. |
| * |
| * <p>The current contents of this Bundle are copied into the Notification each time |
| * {@link #build()} is called. |
| * |
| * @see Notification#extras |
| */ |
| public Bundle getExtras() { |
| return mUserExtras; |
| } |
| |
| private Bundle getAllExtras() { |
| final Bundle saveExtras = (Bundle) mUserExtras.clone(); |
| saveExtras.putAll(mN.extras); |
| return saveExtras; |
| } |
| |
| /** |
| * Add an action to this notification. Actions are typically displayed by |
| * the system as a button adjacent to the notification content. |
| * <p> |
| * Every action must have an icon (32dp square and matching the |
| * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo |
| * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}. |
| * <p> |
| * A notification in its expanded form can display up to 3 actions, from left to right in |
| * the order they were added. Actions will not be displayed when the notification is |
| * collapsed, however, so be sure that any essential functions may be accessed by the user |
| * in some other way (for example, in the Activity pointed to by {@link #contentIntent}). |
| * |
| * @param icon Resource ID of a drawable that represents the action. |
| * @param title Text describing the action. |
| * @param intent PendingIntent to be fired when the action is invoked. |
| * |
| * @deprecated Use {@link #addAction(Action)} instead. |
| */ |
| @Deprecated |
| public Builder addAction(int icon, CharSequence title, PendingIntent intent) { |
| mActions.add(new Action(icon, safeCharSequence(title), intent)); |
| return this; |
| } |
| |
| /** |
| * Add an action to this notification. Actions are typically displayed by |
| * the system as a button adjacent to the notification content. |
| * <p> |
| * Every action must have an icon (32dp square and matching the |
| * <a href="{@docRoot}design/style/iconography.html#action-bar">Holo |
| * Dark action bar</a> visual style), a textual label, and a {@link PendingIntent}. |
| * <p> |
| * A notification in its expanded form can display up to 3 actions, from left to right in |
| * the order they were added. Actions will not be displayed when the notification is |
| * collapsed, however, so be sure that any essential functions may be accessed by the user |
| * in some other way (for example, in the Activity pointed to by {@link #contentIntent}). |
| * |
| * @param action The action to add. |
| */ |
| public Builder addAction(Action action) { |
| mActions.add(action); |
| return this; |
| } |
| |
| /** |
| * Alter the complete list of actions attached to this notification. |
| * @see #addAction(Action). |
| * |
| * @param actions |
| * @return |
| */ |
| public Builder setActions(Action... actions) { |
| mActions.clear(); |
| for (int i = 0; i < actions.length; i++) { |
| mActions.add(actions[i]); |
| } |
| return this; |
| } |
| |
| /** |
| * Add a rich notification style to be applied at build time. |
| * |
| * @param style Object responsible for modifying the notification style. |
| */ |
| public Builder setStyle(Style style) { |
| if (mStyle != style) { |
| mStyle = style; |
| if (mStyle != null) { |
| mStyle.setBuilder(this); |
| mN.extras.putString(EXTRA_TEMPLATE, style.getClass().getName()); |
| } else { |
| mN.extras.remove(EXTRA_TEMPLATE); |
| } |
| } |
| return this; |
| } |
| |
| /** |
| * Specify the value of {@link #visibility}. |
| * |
| * @param visibility One of {@link #VISIBILITY_PRIVATE} (the default), |
| * {@link #VISIBILITY_SECRET}, or {@link #VISIBILITY_PUBLIC}. |
| * |
| * @return The same Builder. |
| */ |
| public Builder setVisibility(int visibility) { |
| mN.visibility = visibility; |
| return this; |
| } |
| |
| /** |
| * Supply a replacement Notification whose contents should be shown in insecure contexts |
| * (i.e. atop the secure lockscreen). See {@link #visibility} and {@link #VISIBILITY_PUBLIC}. |
| * @param n A replacement notification, presumably with some or all info redacted. |
| * @return The same Builder. |
| */ |
| public Builder setPublicVersion(Notification n) { |
| if (n != null) { |
| mN.publicVersion = new Notification(); |
| n.cloneInto(mN.publicVersion, /*heavy=*/ true); |
| } else { |
| mN.publicVersion = null; |
| } |
| return this; |
| } |
| |
| /** |
| * Apply an extender to this notification builder. Extenders may be used to add |
| * metadata or change options on this builder. |
| */ |
| public Builder extend(Extender extender) { |
| extender.extend(this); |
| return this; |
| } |
| |
| /** |
| * @hide |
| */ |
| public Builder setFlag(int mask, boolean value) { |
| if (value) { |
| mN.flags |= mask; |
| } else { |
| mN.flags &= ~mask; |
| } |
| return this; |
| } |
| |
| /** |
| * Sets {@link Notification#color}. |
| * |
| * @param argb The accent color to use |
| * |
| * @return The same Builder. |
| */ |
| public Builder setColor(@ColorInt int argb) { |
| mN.color = argb; |
| sanitizeColor(); |
| return this; |
| } |
| |
| private Drawable getProfileBadgeDrawable() { |
| if (mContext.getUserId() == UserHandle.USER_SYSTEM) { |
| // This user can never be a badged profile, |
| // and also includes USER_ALL system notifications. |
| return null; |
| } |
| // Note: This assumes that the current user can read the profile badge of the |
| // originating user. |
| return mContext.getPackageManager().getUserBadgeForDensityNoBackground( |
| new UserHandle(mContext.getUserId()), 0); |
| } |
| |
| private Bitmap getProfileBadge() { |
| Drawable badge = getProfileBadgeDrawable(); |
| if (badge == null) { |
| return null; |
| } |
| final int size = mContext.getResources().getDimensionPixelSize( |
| R.dimen.notification_badge_size); |
| Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888); |
| Canvas canvas = new Canvas(bitmap); |
| badge.setBounds(0, 0, size, size); |
| badge.draw(canvas); |
| return bitmap; |
| } |
| |
| private void bindProfileBadge(RemoteViews contentView) { |
| Bitmap profileBadge = getProfileBadge(); |
| |
| if (profileBadge != null) { |
| contentView.setImageViewBitmap(R.id.profile_badge, profileBadge); |
| contentView.setViewVisibility(R.id.profile_badge, View.VISIBLE); |
| } |
| } |
| |
| private void resetStandardTemplate(RemoteViews contentView) { |
| resetNotificationHeader(contentView); |
| resetContentMargins(contentView); |
| contentView.setViewVisibility(R.id.right_icon, View.GONE); |
| contentView.setViewVisibility(R.id.title, View.GONE); |
| contentView.setTextViewText(R.id.title, null); |
| contentView.setViewVisibility(R.id.text, View.GONE); |
| contentView.setTextViewText(R.id.text, null); |
| contentView.setViewVisibility(R.id.text_line_1, View.GONE); |
| contentView.setTextViewText(R.id.text_line_1, null); |
| contentView.setViewVisibility(R.id.progress, View.GONE); |
| } |
| |
| /** |
| * Resets the notification header to its original state |
| */ |
| private void resetNotificationHeader(RemoteViews contentView) { |
| contentView.setImageViewResource(R.id.icon, 0); |
| contentView.setBoolean(R.id.notification_header, "setExpanded", false); |
| contentView.setTextViewText(R.id.app_name_text, null); |
| contentView.setViewVisibility(R.id.chronometer, View.GONE); |
| contentView.setViewVisibility(R.id.header_text, View.GONE); |
| contentView.setViewVisibility(R.id.header_text_divider, View.GONE); |
| contentView.setViewVisibility(R.id.time_divider, View.GONE); |
| contentView.setViewVisibility(R.id.time, View.GONE); |
| contentView.setImageViewIcon(R.id.profile_badge, null); |
| contentView.setViewVisibility(R.id.profile_badge, View.GONE); |
| } |
| |
| private void resetContentMargins(RemoteViews contentView) { |
| contentView.setViewLayoutMarginEndDimen(R.id.line1, 0); |
| contentView.setViewLayoutMarginEndDimen(R.id.text, 0); |
| } |
| |
| private RemoteViews applyStandardTemplate(int resId) { |
| return applyStandardTemplate(resId, true /* hasProgress */); |
| } |
| |
| /** |
| * @param hasProgress whether the progress bar should be shown and set |
| */ |
| private RemoteViews applyStandardTemplate(int resId, boolean hasProgress) { |
| final Bundle ex = mN.extras; |
| |
| CharSequence title = processLegacyText(ex.getCharSequence(EXTRA_TITLE)); |
| CharSequence text = processLegacyText(ex.getCharSequence(EXTRA_TEXT)); |
| return applyStandardTemplate(resId, hasProgress, title, text); |
| } |
| |
| /** |
| * @param hasProgress whether the progress bar should be shown and set |
| */ |
| private RemoteViews applyStandardTemplate(int resId, boolean hasProgress, |
| CharSequence title, CharSequence text) { |
| RemoteViews contentView = new BuilderRemoteViews(mContext.getApplicationInfo(), resId); |
| |
| resetStandardTemplate(contentView); |
| |
| final Bundle ex = mN.extras; |
| |
| bindNotificationHeader(contentView); |
| bindLargeIcon(contentView); |
| boolean showProgress = handleProgressBar(hasProgress, contentView, ex); |
| if (title != null) { |
| contentView.setViewVisibility(R.id.title, View.VISIBLE); |
| contentView.setTextViewText(R.id.title, title); |
| contentView.setViewLayoutWidth(R.id.title, showProgress |
| ? ViewGroup.LayoutParams.WRAP_CONTENT |
| : ViewGroup.LayoutParams.MATCH_PARENT); |
| } |
| if (text != null) { |
| int textId = showProgress ? com.android.internal.R.id.text_line_1 |
| : com.android.internal.R.id.text; |
| contentView.setTextViewText(textId, text); |
| contentView.setViewVisibility(textId, View.VISIBLE); |
| } |
| |
| setContentMinHeight(contentView, showProgress || mN.hasLargeIcon()); |
| |
| return contentView; |
| } |
| |
| /** |
| * @param remoteView the remote view to update the minheight in |
| * @param hasMinHeight does it have a mimHeight |
| * @hide |
| */ |
| void setContentMinHeight(RemoteViews remoteView, boolean hasMinHeight) { |
| int minHeight = 0; |
| if (hasMinHeight) { |
| // we need to set the minHeight of the notification |
| minHeight = mContext.getResources().getDimensionPixelSize( |
| com.android.internal.R.dimen.notification_min_content_height); |
| } |
| remoteView.setInt(R.id.notification_main_column, "setMinimumHeight", minHeight); |
| } |
| |
| private boolean handleProgressBar(boolean hasProgress, RemoteViews contentView, Bundle ex) { |
| final int max = ex.getInt(EXTRA_PROGRESS_MAX, 0); |
| final int progress = ex.getInt(EXTRA_PROGRESS, 0); |
| final boolean ind = ex.getBoolean(EXTRA_PROGRESS_INDETERMINATE); |
| if (hasProgress && (max != 0 || ind)) { |
| contentView.setViewVisibility(com.android.internal.R.id.progress, View.VISIBLE); |
| contentView.setProgressBar( |
| R.id.progress, max, progress, ind); |
| contentView.setProgressBackgroundTintList( |
| R.id.progress, ColorStateList.valueOf(mContext.getColor( |
| R.color.notification_progress_background_color))); |
| if (mN.color != COLOR_DEFAULT) { |
| ColorStateList colorStateList = ColorStateList.valueOf(resolveContrastColor()); |
| contentView.setProgressTintList(R.id.progress, colorStateList); |
| contentView.setProgressIndeterminateTintList(R.id.progress, colorStateList); |
| } |
| return true; |
| } else { |
| contentView.setViewVisibility(R.id.progress, View.GONE); |
| return false; |
| } |
| } |
| |
| private void bindLargeIcon(RemoteViews contentView) { |
| if (mN.mLargeIcon == null && mN.largeIcon != null) { |
| mN.mLargeIcon = Icon.createWithBitmap(mN.largeIcon); |
| } |
| if (mN.mLargeIcon != null) { |
| contentView.setViewVisibility(R.id.right_icon, View.VISIBLE); |
| contentView.setImageViewIcon(R.id.right_icon, mN.mLargeIcon); |
| processLargeLegacyIcon(mN.mLargeIcon, contentView); |
| int endMargin = R.dimen.notification_content_picture_margin; |
| contentView.setViewLayoutMarginEndDimen(R.id.line1, endMargin); |
| contentView.setViewLayoutMarginEndDimen(R.id.text, endMargin); |
| contentView.setViewLayoutMarginEndDimen(R.id.progress, endMargin); |
| } |
| } |
| |
| private void bindNotificationHeader(RemoteViews contentView) { |
| bindSmallIcon(contentView); |
| bindHeaderAppName(contentView); |
| bindHeaderText(contentView); |
| bindHeaderChronometerAndTime(contentView); |
| bindExpandButton(contentView); |
| bindProfileBadge(contentView); |
| } |
| |
| private void bindExpandButton(RemoteViews contentView) { |
| contentView.setDrawableParameters(R.id.expand_button, false, -1, resolveContrastColor(), |
| PorterDuff.Mode.SRC_ATOP, -1); |
| contentView.setInt(R.id.notification_header, "setOriginalNotificationColor", |
| resolveContrastColor()); |
| } |
| |
| private void bindHeaderChronometerAndTime(RemoteViews contentView) { |
| if (showsTimeOrChronometer()) { |
| contentView.setViewVisibility(R.id.time_divider, View.VISIBLE); |
| if (mN.extras.getBoolean(EXTRA_SHOW_CHRONOMETER)) { |
| contentView.setViewVisibility(R.id.chronometer, View.VISIBLE); |
| contentView.setLong(R.id.chronometer, "setBase", |
| mN.when + (SystemClock.elapsedRealtime() - System.currentTimeMillis())); |
| contentView.setBoolean(R.id.chronometer, "setStarted", true); |
| boolean countsDown = mN.extras.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN); |
| contentView.setChronometerCountDown(R.id.chronometer, countsDown); |
| } else { |
| contentView.setViewVisibility(R.id.time, View.VISIBLE); |
| contentView.setLong(R.id.time, "setTime", mN.when); |
| } |
| } else { |
| // We still want a time to be set but gone, such that we can show and hide it |
| // on demand in case it's a child notification without anything in the header |
| contentView.setLong(R.id.time, "setTime", mN.when != 0 ? mN.when : mN.creationTime); |
| } |
| } |
| |
| private void bindHeaderText(RemoteViews contentView) { |
| CharSequence headerText = mN.extras.getCharSequence(EXTRA_SUB_TEXT); |
| if (headerText == null && mStyle != null && mStyle.mSummaryTextSet |
| && mStyle.hasSummaryInHeader()) { |
| headerText = mStyle.mSummaryText; |
| } |
| if (headerText == null |
| && mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N |
| && mN.extras.getCharSequence(EXTRA_INFO_TEXT) != null) { |
| headerText = mN.extras.getCharSequence(EXTRA_INFO_TEXT); |
| } |
| if (headerText != null) { |
| // TODO: Remove the span entirely to only have the string with propper formating. |
| contentView.setTextViewText(R.id.header_text, processLegacyText(headerText)); |
| contentView.setViewVisibility(R.id.header_text, View.VISIBLE); |
| contentView.setViewVisibility(R.id.header_text_divider, View.VISIBLE); |
| } |
| } |
| |
| /** |
| * @hide |
| */ |
| public String loadHeaderAppName() { |
| CharSequence name = null; |
| final PackageManager pm = mContext.getPackageManager(); |
| if (mN.extras.containsKey(EXTRA_SUBSTITUTE_APP_NAME)) { |
| // only system packages which lump together a bunch of unrelated stuff |
| // may substitute a different name to make the purpose of the |
| // notification more clear. the correct package label should always |
| // be accessible via SystemUI. |
| final String pkg = mContext.getPackageName(); |
| final String subName = mN.extras.getString(EXTRA_SUBSTITUTE_APP_NAME); |
| if (PackageManager.PERMISSION_GRANTED == pm.checkPermission( |
| android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME, pkg)) { |
| name = subName; |
| } else { |
| Log.w(TAG, "warning: pkg " |
| + pkg + " attempting to substitute app name '" + subName |
| + "' without holding perm " |
| + android.Manifest.permission.SUBSTITUTE_NOTIFICATION_APP_NAME); |
| } |
| } |
| if (TextUtils.isEmpty(name)) { |
| name = pm.getApplicationLabel(mContext.getApplicationInfo()); |
| } |
| if (TextUtils.isEmpty(name)) { |
| // still nothing? |
| return null; |
| } |
| |
| return String.valueOf(name); |
| } |
| private void bindHeaderAppName(RemoteViews contentView) { |
| contentView.setTextViewText(R.id.app_name_text, loadHeaderAppName()); |
| contentView.setTextColor(R.id.app_name_text, resolveContrastColor()); |
| } |
| |
| private void bindSmallIcon(RemoteViews contentView) { |
| if (mN.mSmallIcon == null && mN.icon != 0) { |
| mN.mSmallIcon = Icon.createWithResource(mContext, mN.icon); |
| } |
| contentView.setImageViewIcon(R.id.icon, mN.mSmallIcon); |
| processSmallIconColor(mN.mSmallIcon, contentView); |
| } |
| |
| /** |
| * @return true if the built notification will show the time or the chronometer; false |
| * otherwise |
| */ |
| private boolean showsTimeOrChronometer() { |
| return mN.showsTime() || mN.showsChronometer(); |
| } |
| |
| private void resetStandardTemplateWithActions(RemoteViews big) { |
| // actions_container is only reset when there are no actions to avoid focus issues with |
| // remote inputs. |
| big.setViewVisibility(R.id.actions, View.GONE); |
| big.removeAllViews(R.id.actions); |
| |
| big.setViewVisibility(R.id.notification_material_reply_container, View.GONE); |
| big.setTextViewText(R.id.notification_material_reply_text_1, null); |
| |
| big.setViewVisibility(R.id.notification_material_reply_text_2, View.GONE); |
| big.setTextViewText(R.id.notification_material_reply_text_2, null); |
| big.setViewVisibility(R.id.notification_material_reply_text_3, View.GONE); |
| big.setTextViewText(R.id.notification_material_reply_text_3, null); |
| |
| big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, 0); |
| } |
| |
| private RemoteViews applyStandardTemplateWithActions(int layoutId) { |
| final Bundle ex = mN.extras; |
| |
| CharSequence title = processLegacyText(ex.getCharSequence(EXTRA_TITLE)); |
| CharSequence text = processLegacyText(ex.getCharSequence(EXTRA_TEXT)); |
| return applyStandardTemplateWithActions(layoutId, true /* hasProgress */, title, text); |
| } |
| |
| private RemoteViews applyStandardTemplateWithActions(int layoutId, boolean hasProgress, |
| CharSequence title, CharSequence text) { |
| RemoteViews big = applyStandardTemplate(layoutId, hasProgress, title, text); |
| |
| resetStandardTemplateWithActions(big); |
| |
| boolean validRemoteInput = false; |
| |
| int N = mActions.size(); |
| if (N > 0) { |
| big.setViewVisibility(R.id.actions_container, View.VISIBLE); |
| big.setViewVisibility(R.id.actions, View.VISIBLE); |
| big.setViewLayoutMarginBottomDimen(R.id.notification_action_list_margin_target, |
| R.dimen.notification_action_list_height); |
| if (N>MAX_ACTION_BUTTONS) N=MAX_ACTION_BUTTONS; |
| for (int i=0; i<N; i++) { |
| Action action = mActions.get(i); |
| validRemoteInput |= hasValidRemoteInput(action); |
| |
| final RemoteViews button = generateActionButton(action); |
| big.addView(R.id.actions, button); |
| } |
| } else { |
| big.setViewVisibility(R.id.actions_container, View.GONE); |
| } |
| |
| CharSequence[] replyText = mN.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY); |
| if (validRemoteInput && replyText != null |
| && replyText.length > 0 && !TextUtils.isEmpty(replyText[0])) { |
| big.setViewVisibility(R.id.notification_material_reply_container, View.VISIBLE); |
| big.setTextViewText(R.id.notification_material_reply_text_1, replyText[0]); |
| |
| if (replyText.length > 1 && !TextUtils.isEmpty(replyText[1])) { |
| big.setViewVisibility(R.id.notification_material_reply_text_2, View.VISIBLE); |
| big.setTextViewText(R.id.notification_material_reply_text_2, replyText[1]); |
| |
| if (replyText.length > 2 && !TextUtils.isEmpty(replyText[2])) { |
| big.setViewVisibility( |
| R.id.notification_material_reply_text_3, View.VISIBLE); |
| big.setTextViewText(R.id.notification_material_reply_text_3, replyText[2]); |
| } |
| } |
| } |
| |
| return big; |
| } |
| |
| private boolean hasValidRemoteInput(Action action) { |
| if (TextUtils.isEmpty(action.title) || action.actionIntent == null) { |
| // Weird actions |
| return false; |
| } |
| |
| RemoteInput[] remoteInputs = action.getRemoteInputs(); |
| if (remoteInputs == null) { |
| return false; |
| } |
| |
| for (RemoteInput r : remoteInputs) { |
| CharSequence[] choices = r.getChoices(); |
| if (r.getAllowFreeFormInput() || (choices != null && choices.length != 0)) { |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * Construct a RemoteViews for the final 1U notification layout. In order: |
| * 1. Custom contentView from the caller |
| * 2. Style's proposed content view |
| * 3. Standard template view |
| */ |
| public RemoteViews createContentView() { |
| if (mN.contentView != null && (mStyle == null || !mStyle.displayCustomViewInline())) { |
| return mN.contentView; |
| } else if (mStyle != null) { |
| final RemoteViews styleView = mStyle.makeContentView(); |
| if (styleView != null) { |
| return styleView; |
| } |
| } |
| return applyStandardTemplate(getBaseLayoutResource()); |
| } |
| |
| /** |
| * Construct a RemoteViews for the final big notification layout. |
| */ |
| public RemoteViews createBigContentView() { |
| RemoteViews result = null; |
| if (mN.bigContentView != null |
| && (mStyle == null || !mStyle.displayCustomViewInline())) { |
| return mN.bigContentView; |
| } else if (mStyle != null) { |
| result = mStyle.makeBigContentView(); |
| hideLine1Text(result); |
| } else if (mActions.size() != 0) { |
| result = applyStandardTemplateWithActions(getBigBaseLayoutResource()); |
| } |
| adaptNotificationHeaderForBigContentView(result); |
| return result; |
| } |
| |
| /** |
| * Construct a RemoteViews for the final notification header only |
| * |
| * @hide |
| */ |
| public RemoteViews makeNotificationHeader() { |
| RemoteViews header = new BuilderRemoteViews(mContext.getApplicationInfo(), |
| R.layout.notification_template_header); |
| resetNotificationHeader(header); |
| bindNotificationHeader(header); |
| return header; |
| } |
| |
| private void hideLine1Text(RemoteViews result) { |
| if (result != null) { |
| result.setViewVisibility(R.id.text_line_1, View.GONE); |
| } |
| } |
| |
| private void adaptNotificationHeaderForBigContentView(RemoteViews result) { |
| if (result != null) { |
| result.setBoolean(R.id.notification_header, "setExpanded", true); |
| } |
| } |
| |
| /** |
| * Construct a RemoteViews for the final heads-up notification layout. |
| */ |
| public RemoteViews createHeadsUpContentView() { |
| if (mN.headsUpContentView != null |
| && (mStyle == null || !mStyle.displayCustomViewInline())) { |
| return mN.headsUpContentView; |
| } else if (mStyle != null) { |
| final RemoteViews styleView = mStyle.makeHeadsUpContentView(); |
| if (styleView != null) { |
| return styleView; |
| } |
| } else if (mActions.size() == 0) { |
| return null; |
| } |
| |
| return applyStandardTemplateWithActions(getBigBaseLayoutResource()); |
| } |
| |
| /** |
| * Construct a RemoteViews for the display in public contexts like on the lockscreen. |
| * |
| * @hide |
| */ |
| public RemoteViews makePublicContentView() { |
| if (mN.publicVersion != null) { |
| final Builder builder = recoverBuilder(mContext, mN.publicVersion); |
| return builder.createContentView(); |
| } |
| Bundle savedBundle = mN.extras; |
| Style style = mStyle; |
| mStyle = null; |
| Icon largeIcon = mN.mLargeIcon; |
| mN.mLargeIcon = null; |
| Bitmap largeIconLegacy = mN.largeIcon; |
| mN.largeIcon = null; |
| Bundle publicExtras = new Bundle(); |
| publicExtras.putBoolean(EXTRA_SHOW_WHEN, |
| savedBundle.getBoolean(EXTRA_SHOW_WHEN)); |
| publicExtras.putBoolean(EXTRA_SHOW_CHRONOMETER, |
| savedBundle.getBoolean(EXTRA_SHOW_CHRONOMETER)); |
| publicExtras.putBoolean(EXTRA_CHRONOMETER_COUNT_DOWN, |
| savedBundle.getBoolean(EXTRA_CHRONOMETER_COUNT_DOWN)); |
| publicExtras.putCharSequence(EXTRA_TITLE, |
| mContext.getString(R.string.notification_hidden_text)); |
| mN.extras = publicExtras; |
| final RemoteViews publicView = applyStandardTemplate(getBaseLayoutResource()); |
| mN.extras = savedBundle; |
| mN.mLargeIcon = largeIcon; |
| mN.largeIcon = largeIconLegacy; |
| mStyle = style; |
| return publicView; |
| } |
| |
| |
| |
| private RemoteViews generateActionButton(Action action) { |
| final boolean tombstone = (action.actionIntent == null); |
| RemoteViews button = new BuilderRemoteViews(mContext.getApplicationInfo(), |
| tombstone ? getActionTombstoneLayoutResource() |
| : getActionLayoutResource()); |
| final Icon ai = action.getIcon(); |
| button.setTextViewText(R.id.action0, processLegacyText(action.title)); |
| if (!tombstone) { |
| button.setOnClickPendingIntent(R.id.action0, action.actionIntent); |
| } |
| button.setContentDescription(R.id.action0, action.title); |
| if (action.mRemoteInputs != null) { |
| button.setRemoteInputs(R.id.action0, action.mRemoteInputs); |
| } |
| if (mN.color != COLOR_DEFAULT) { |
| button.setTextColor(R.id.action0, resolveContrastColor()); |
| } |
| return button; |
| } |
| |
| /** |
| * @return Whether we are currently building a notification from a legacy (an app that |
| * doesn't create material notifications by itself) app. |
| */ |
| private boolean isLegacy() { |
| return getColorUtil() != null; |
| } |
| |
| private CharSequence processLegacyText(CharSequence charSequence) { |
| if (isLegacy()) { |
| return getColorUtil().invertCharSequenceColors(charSequence); |
| } else { |
| return charSequence; |
| } |
| } |
| |
| /** |
| * Apply any necessariy colors to the small icon |
| */ |
| private void processSmallIconColor(Icon smallIcon, RemoteViews contentView) { |
| boolean colorable = !isLegacy() || getColorUtil().isGrayscaleIcon(mContext, smallIcon); |
| if (colorable) { |
| contentView.setDrawableParameters(R.id.icon, false, -1, resolveContrastColor(), |
| PorterDuff.Mode.SRC_ATOP, -1); |
| |
| } |
| contentView.setInt(R.id.notification_header, "setOriginalIconColor", |
| colorable ? resolveContrastColor() : NotificationHeaderView.NO_COLOR); |
| } |
| |
| /** |
| * Make the largeIcon dark if it's a fake smallIcon (that is, |
| * if it's grayscale). |
| */ |
| // TODO: also check bounds, transparency, that sort of thing. |
| private void processLargeLegacyIcon(Icon largeIcon, RemoteViews contentView) { |
| if (largeIcon != null && isLegacy() |
| && getColorUtil().isGrayscaleIcon(mContext, largeIcon)) { |
| // resolve color will fall back to the default when legacy |
| contentView.setDrawableParameters(R.id.icon, false, -1, resolveContrastColor(), |
| PorterDuff.Mode.SRC_ATOP, -1); |
| } |
| } |
| |
| private void sanitizeColor() { |
| if (mN.color != COLOR_DEFAULT) { |
| mN.color |= 0xFF000000; // no alpha for custom colors |
| } |
| } |
| |
| int resolveContrastColor() { |
| if (mCachedContrastColorIsFor == mN.color && mCachedContrastColor != COLOR_INVALID) { |
| return mCachedContrastColor; |
| } |
| final int contrasted = NotificationColorUtil.resolveContrastColor(mContext, mN.color); |
| |
| mCachedContrastColorIsFor = mN.color; |
| return mCachedContrastColor = contrasted; |
| } |
| |
| /** |
| * Apply the unstyled operations and return a new {@link Notification} object. |
| * @hide |
| */ |
| public Notification buildUnstyled() { |
| if (mActions.size() > 0) { |
| mN.actions = new Action[mActions.size()]; |
| mActions.toArray(mN.actions); |
| } |
| if (!mPersonList.isEmpty()) { |
| mN.extras.putStringArray(EXTRA_PEOPLE, |
| mPersonList.toArray(new String[mPersonList.size()])); |
| } |
| if (mN.bigContentView != null || mN.contentView != null |
| || mN.headsUpContentView != null) { |
| mN.extras.putBoolean(EXTRA_CONTAINS_CUSTOM_VIEW, true); |
| } |
| return mN; |
| } |
| |
| /** |
| * Creates a Builder from an existing notification so further changes can be made. |
| * @param context The context for your application / activity. |
| * @param n The notification to create a Builder from. |
| */ |
| public static Notification.Builder recoverBuilder(Context context, Notification n) { |
| // Re-create notification context so we can access app resources. |
| ApplicationInfo applicationInfo = n.extras.getParcelable( |
| EXTRA_BUILDER_APPLICATION_INFO); |
| Context builderContext; |
| if (applicationInfo != null) { |
| try { |
| builderContext = context.createApplicationContext(applicationInfo, |
| Context.CONTEXT_RESTRICTED); |
| } catch (NameNotFoundException e) { |
| Log.e(TAG, "ApplicationInfo " + applicationInfo + " not found"); |
| builderContext = context; // try with our context |
| } |
| } else { |
| builderContext = context; // try with given context |
| } |
| |
| return new Builder(builderContext, n); |
| } |
| |
| private static Class<? extends Style> getNotificationStyleClass(String templateClass) { |
| Class<? extends Style>[] classes = new Class[] { |
| BigTextStyle.class, BigPictureStyle.class, InboxStyle.class, MediaStyle.class, |
| DecoratedCustomViewStyle.class, DecoratedMediaCustomViewStyle.class, |
| MessagingStyle.class }; |
| for (Class<? extends Style> innerClass : classes) { |
| if (templateClass.equals(innerClass.getName())) { |
| return innerClass; |
| } |
| } |
| return null; |
| } |
| |
| /** |
| * @deprecated Use {@link #build()} instead. |
| */ |
| @Deprecated |
| public Notification getNotification() { |
| return build(); |
| } |
| |
| /** |
| * Combine all of the options that have been set and return a new {@link Notification} |
| * object. |
| */ |
| public Notification build() { |
| // first, add any extras from the calling code |
| if (mUserExtras != null) { |
| mN.extras = getAllExtras(); |
| } |
| |
| mN.creationTime = System.currentTimeMillis(); |
| |
| // lazy stuff from mContext; see comment in Builder(Context, Notification) |
| Notification.addFieldsFromContext(mContext, mN); |
| |
| buildUnstyled(); |
| |
| if (mStyle != null) { |
| mStyle.buildStyled(mN); |
| } |
| |
| if (mContext.getApplicationInfo().targetSdkVersion < Build.VERSION_CODES.N |
| && (mStyle == null || !mStyle.displayCustomViewInline())) { |
| if (mN.contentView == null) { |
| mN.contentView = createContentView(); |
| mN.extras.putInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, |
| mN.contentView.getSequenceNumber()); |
| } |
| if (mN.bigContentView == null) { |
| mN.bigContentView = createBigContentView(); |
| if (mN.bigContentView != null) { |
| mN.extras.putInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, |
| mN.bigContentView.getSequenceNumber()); |
| } |
| } |
| if (mN.headsUpContentView == null) { |
| mN.headsUpContentView = createHeadsUpContentView(); |
| if (mN.headsUpContentView != null) { |
| mN.extras.putInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, |
| mN.headsUpContentView.getSequenceNumber()); |
| } |
| } |
| } |
| |
| if ((mN.defaults & DEFAULT_LIGHTS) != 0) { |
| mN.flags |= FLAG_SHOW_LIGHTS; |
| } |
| |
| return mN; |
| } |
| |
| /** |
| * Apply this Builder to an existing {@link Notification} object. |
| * |
| * @hide |
| */ |
| public Notification buildInto(Notification n) { |
| build().cloneInto(n, true); |
| return n; |
| } |
| |
| /** |
| * Removes RemoteViews that were created for compatibility from {@param n}, if they did not |
| * change. |
| * |
| * @return {@param n}, if no stripping is needed, otherwise a stripped clone of {@param n}. |
| * |
| * @hide |
| */ |
| public static Notification maybeCloneStrippedForDelivery(Notification n) { |
| String templateClass = n.extras.getString(EXTRA_TEMPLATE); |
| |
| // Only strip views for known Styles because we won't know how to |
| // re-create them otherwise. |
| if (!TextUtils.isEmpty(templateClass) |
| && getNotificationStyleClass(templateClass) == null) { |
| return n; |
| } |
| |
| // Only strip unmodified BuilderRemoteViews. |
| boolean stripContentView = n.contentView instanceof BuilderRemoteViews && |
| n.extras.getInt(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT, -1) == |
| n.contentView.getSequenceNumber(); |
| boolean stripBigContentView = n.bigContentView instanceof BuilderRemoteViews && |
| n.extras.getInt(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT, -1) == |
| n.bigContentView.getSequenceNumber(); |
| boolean stripHeadsUpContentView = n.headsUpContentView instanceof BuilderRemoteViews && |
| n.extras.getInt(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT, -1) == |
| n.headsUpContentView.getSequenceNumber(); |
| |
| // Nothing to do here, no need to clone. |
| if (!stripContentView && !stripBigContentView && !stripHeadsUpContentView) { |
| return n; |
| } |
| |
| Notification clone = n.clone(); |
| if (stripContentView) { |
| clone.contentView = null; |
| clone.extras.remove(EXTRA_REBUILD_CONTENT_VIEW_ACTION_COUNT); |
| } |
| if (stripBigContentView) { |
| clone.bigContentView = null; |
| clone.extras.remove(EXTRA_REBUILD_BIG_CONTENT_VIEW_ACTION_COUNT); |
| } |
| if (stripHeadsUpContentView) { |
| clone.headsUpContentView = null; |
| clone.extras.remove(EXTRA_REBUILD_HEADS_UP_CONTENT_VIEW_ACTION_COUNT); |
| } |
| return clone; |
| } |
| |
| private int getBaseLayoutResource() { |
| return R.layout.notification_template_material_base; |
| } |
| |
| private int getBigBaseLayoutResource() { |
| return R.layout.notification_template_material_big_base; |
| } |
| |
| private int getBigPictureLayoutResource() { |
| return R.layout.notification_template_material_big_picture; |
| } |
| |
| private int getBigTextLayoutResource() { |
| return R.layout.notification_template_material_big_text; |
| } |
| |
| private int getInboxLayoutResource() { |
| return R.layout.notification_template_material_inbox; |
| } |
| |
| private int getMessagingLayoutResource() { |
| return R.layout.notification_template_material_messaging; |
| } |
| |
| private int getActionLayoutResource() { |
| return R.layout.notification_material_action; |
| } |
| |
| private int getActionTombstoneLayoutResource() { |
| return R.layout.notification_material_action_tombstone; |
| } |
| } |
| |
| private boolean hasLargeIcon() { |
| return mLargeIcon != null || largeIcon != null; |
| } |
| |
| /** |
| * @return true if the notification will show the time; false otherwise |
| * @hide |
| */ |
| public boolean showsTime() { |
| return when != 0 && extras.getBoolean(EXTRA_SHOW_WHEN); |
| } |
| |
| /** |
| * @return true if the notification will show a chronometer; false otherwise |
| * @hide |
| */ |
| public boolean showsChronometer() { |
| return when != 0 && extras.getBoolean(EXTRA_SHOW_CHRONOMETER); |
| } |
| |
| /** |
| * An object that can apply a rich notification style to a {@link Notification.Builder} |
| * object. |
| */ |
| public static abstract class Style { |
| private CharSequence mBigContentTitle; |
| |
| /** |
| * @hide |
| */ |
| protected CharSequence mSummaryText = null; |
| |
| /** |
| * @hide |
| */ |
| protected boolean mSummaryTextSet = false; |
| |
| protected Builder mBuilder; |
| |
| /** |
| * Overrides ContentTitle in the big form of the template. |
| * This defaults to the value passed to setContentTitle(). |
| */ |
| protected void internalSetBigContentTitle(CharSequence title) { |
| mBigContentTitle = title; |
| } |
| |
| /** |
| * Set the first line of text after the detail section in the big form of the template. |
| */ |
| protected void internalSetSummaryText(CharSequence cs) { |
| mSummaryText = cs; |
| mSummaryTextSet = true; |
| } |
| |
| public void setBuilder(Builder builder) { |
| if (mBuilder != builder) { |
| mBuilder = builder; |
| if (mBuilder != null) { |
| mBuilder.setStyle(this); |
| } |
| } |
| } |
| |
| protected void checkBuilder() { |
| if (mBuilder == null) { |
| throw new IllegalArgumentException("Style requires a valid Builder object"); |
| } |
| } |
| |
| protected RemoteViews getStandardView(int layoutId) { |
| checkBuilder(); |
| |
| // Nasty. |
| CharSequence oldBuilderContentTitle = |
| mBuilder.getAllExtras().getCharSequence(EXTRA_TITLE); |
| if (mBigContentTitle != null) { |
| mBuilder.setContentTitle(mBigContentTitle); |
| } |
| |
| RemoteViews contentView = mBuilder.applyStandardTemplateWithActions(layoutId); |
| |
| mBuilder.getAllExtras().putCharSequence(EXTRA_TITLE, oldBuilderContentTitle); |
| |
| if (mBigContentTitle != null && mBigContentTitle.equals("")) { |
| contentView.setViewVisibility(R.id.line1, View.GONE); |
| } else { |
| contentView.setViewVisibility(R.id.line1, View.VISIBLE); |
| } |
| |
| return contentView; |
| } |
| |
| /** |
| * Construct a Style-specific RemoteViews for the final 1U notification layout. |
| * The default implementation has nothing additional to add. |
| * @hide |
| */ |
| public RemoteViews makeContentView() { |
| return null; |
| } |
| |
| /** |
| * Construct a Style-specific RemoteViews for the final big notification layout. |
| * @hide |
| */ |
| public RemoteViews makeBigContentView() { |
| return null; |
| } |
| |
| /** |
| * Construct a Style-specific RemoteViews for the final HUN layout. |
| * @hide |
| */ |
| public RemoteViews makeHeadsUpContentView() { |
| return null; |
| } |
| |
| /** |
| * Apply any style-specific extras to this notification before shipping it out. |
| * @hide |
| */ |
| public void addExtras(Bundle extras) { |
| if (mSummaryTextSet) { |
| extras.putCharSequence(EXTRA_SUMMARY_TEXT, mSummaryText); |
| } |
| if (mBigContentTitle != null) { |
| extras.putCharSequence(EXTRA_TITLE_BIG, mBigContentTitle); |
| } |
| extras.putString(EXTRA_TEMPLATE, this.getClass().getName()); |
| } |
| |
| /** |
| * Reconstruct the internal state of this Style object from extras. |
| * @hide |
| */ |
| protected void restoreFromExtras(Bundle extras) { |
| if (extras.containsKey(EXTRA_SUMMARY_TEXT)) { |
| mSummaryText = extras.getCharSequence(EXTRA_SUMMARY_TEXT); |
| mSummaryTextSet = true; |
| } |
| if (extras.containsKey(EXTRA_TITLE_BIG)) { |
| mBigContentTitle = extras.getCharSequence(EXTRA_TITLE_BIG); |
| } |
| } |
| |
| |
| /** |
| * @hide |
| */ |
| public Notification buildStyled(Notification wip) { |
| addExtras(wip.extras); |
| return wip; |
| } |
| |
| /** |
| * @hide |
| */ |
| public void purgeResources() {} |
| |
| /** |
| * Calls {@link android.app.Notification.Builder#build()} on the Builder this Style is |
| * attached to. |
| * |
| * @return the fully constructed Notification. |
| */ |
| public Notification build() { |
| checkBuilder(); |
| return mBuilder.build(); |
| } |
| |
| /** |
| * @hide |
| * @return true if the style positions the progress bar on the second line; false if the |
| * style hides the progress bar |
| */ |
| protected boolean hasProgress() { |
| return true; |
| } |
| |
| /** |
| * @hide |
| * @return Whether we should put the summary be put into the notification header |
| */ |
| public boolean hasSummaryInHeader() { |
| return true; |
| } |
| |
| /** |
| * @hide |
| * @return Whether custom content views are displayed inline in the style |
| */ |
| public boolean displayCustomViewInline() { |
| return false; |
| } |
| } |
| |
| /** |
| * Helper class for generating large-format notifications that include a large image attachment. |
| * |
| * Here's how you'd set the <code>BigPictureStyle</code> on a notification: |
| * <pre class="prettyprint"> |
| * Notification notif = new Notification.Builder(mContext) |
| * .setContentTitle("New photo from " + sender.toString()) |
| * .setContentText(subject) |
| * .setSmallIcon(R.drawable.new_post) |
| * .setLargeIcon(aBitmap) |
| * .setStyle(new Notification.BigPictureStyle() |
| * .bigPicture(aBigBitmap)) |
| * .build(); |
| * </pre> |
| * |
| * @see Notification#bigContentView |
| */ |
| public static class BigPictureStyle extends Style { |
| private Bitmap mPicture; |
| private Icon mBigLargeIcon; |
| private boolean mBigLargeIconSet = false; |
| |
| public BigPictureStyle() { |
| } |
| |
| /** |
| * @deprecated use {@code BigPictureStyle()}. |
| */ |
| @Deprecated |
| public BigPictureStyle(Builder builder) { |
| setBuilder(builder); |
| } |
| |
| /** |
| * Overrides ContentTitle in the big form of the template. |
| * This defaults to the value passed to setContentTitle(). |
| */ |
| public BigPictureStyle setBigContentTitle(CharSequence title) { |
| internalSetBigContentTitle(safeCharSequence(title)); |
| return this; |
| } |
| |
| /** |
| * Set the first line of text after the detail section in the big form of the template. |
| */ |
| public BigPictureStyle setSummaryText(CharSequence cs) { |
| internalSetSummaryText(safeCharSequence(cs)); |
| return this; |
| } |
| |
| /** |
| * Provide the bitmap to be used as the payload for the BigPicture notification. |
| */ |
| public BigPictureStyle bigPicture(Bitmap b) { |
| mPicture = b; |
| return this; |
| } |
| |
| /** |
| * Override the large icon when the big notification is shown. |
| */ |
| public BigPictureStyle bigLargeIcon(Bitmap b) { |
| return bigLargeIcon(b != null ? Icon.createWithBitmap(b) : null); |
| } |
| |
| /** |
| * Override the large icon when the big notification is shown. |
| */ |
| public BigPictureStyle bigLargeIcon(Icon icon) { |
| mBigLargeIconSet = true; |
| mBigLargeIcon = icon; |
| return this; |
| } |
| |
| /** @hide */ |
| public static final int MIN_ASHMEM_BITMAP_SIZE = 128 * (1 << 10); |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public void purgeResources() { |
| super.purgeResources(); |
| if (mPicture != null && |
| mPicture.isMutable() && |
| mPicture.getAllocationByteCount() >= MIN_ASHMEM_BITMAP_SIZE) { |
| mPicture = mPicture.createAshmemBitmap(); |
| } |
| if (mBigLargeIcon != null) { |
| mBigLargeIcon.convertToAshmem(); |
| } |
| } |
| |
| /** |
| * @hide |
| */ |
| public RemoteViews makeBigContentView() { |
| // Replace mN.mLargeIcon with mBigLargeIcon if mBigLargeIconSet |
| // This covers the following cases: |
| // 1. mBigLargeIconSet -> mBigLargeIcon (null or non-null) applies, overrides |
| // mN.mLargeIcon |
| // 2. !mBigLargeIconSet -> mN.mLargeIcon applies |
| Icon oldLargeIcon = null; |
| if (mBigLargeIconSet) { |
| oldLargeIcon = mBuilder.mN.mLargeIcon; |
| mBuilder.mN.mLargeIcon = mBigLargeIcon; |
| } |
| |
| RemoteViews contentView = getStandardView(mBuilder.getBigPictureLayoutResource()); |
| if (mSummaryTextSet) { |
| contentView.setTextViewText(R.id.text, mBuilder.processLegacyText(mSummaryText)); |
| contentView.setViewVisibility(R.id.text, View.VISIBLE); |
| } |
| mBuilder.setContentMinHeight(contentView, mBuilder.mN.hasLargeIcon()); |
| |
| if (mBigLargeIconSet) { |
| mBuilder.mN.mLargeIcon = oldLargeIcon; |
| } |
| |
| contentView.setImageViewBitmap(R.id.big_picture, mPicture); |
| return contentView; |
| } |
| |
| /** |
| * @hide |
| */ |
| public void addExtras(Bundle extras) { |
| super.addExtras(extras); |
| |
| if (mBigLargeIconSet) { |
| extras.putParcelable(EXTRA_LARGE_ICON_BIG, mBigLargeIcon); |
| } |
| extras.putParcelable(EXTRA_PICTURE, mPicture); |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| protected void restoreFromExtras(Bundle extras) { |
| super.restoreFromExtras(extras); |
| |
| if (extras.containsKey(EXTRA_LARGE_ICON_BIG)) { |
| mBigLargeIconSet = true; |
| mBigLargeIcon = extras.getParcelable(EXTRA_LARGE_ICON_BIG); |
| } |
| mPicture = extras.getParcelable(EXTRA_PICTURE); |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public boolean hasSummaryInHeader() { |
| return false; |
| } |
| } |
| |
| /** |
| * Helper class for generating large-format notifications that include a lot of text. |
| * |
| * Here's how you'd set the <code>BigTextStyle</code> on a notification: |
| * <pre class="prettyprint"> |
| * Notification notif = new Notification.Builder(mContext) |
| * .setContentTitle("New mail from " + sender.toString()) |
| * .setContentText(subject) |
| * .setSmallIcon(R.drawable.new_mail) |
| * .setLargeIcon(aBitmap) |
| * .setStyle(new Notification.BigTextStyle() |
| * .bigText(aVeryLongString)) |
| * .build(); |
| * </pre> |
| * |
| * @see Notification#bigContentView |
| */ |
| public static class BigTextStyle extends Style { |
| |
| private static final int MAX_LINES = 13; |
| private static final int LINES_CONSUMED_BY_ACTIONS = 4; |
| |
| private CharSequence mBigText; |
| |
| public BigTextStyle() { |
| } |
| |
| /** |
| * @deprecated use {@code BigTextStyle()}. |
| */ |
| @Deprecated |
| public BigTextStyle(Builder builder) { |
| setBuilder(builder); |
| } |
| |
| /** |
| * Overrides ContentTitle in the big form of the template. |
| * This defaults to the value passed to setContentTitle(). |
| */ |
| public BigTextStyle setBigContentTitle(CharSequence title) { |
| internalSetBigContentTitle(safeCharSequence(title)); |
| return this; |
| } |
| |
| /** |
| * Set the first line of text after the detail section in the big form of the template. |
| */ |
| public BigTextStyle setSummaryText(CharSequence cs) { |
| internalSetSummaryText(safeCharSequence(cs)); |
| return this; |
| } |
| |
| /** |
| * Provide the longer text to be displayed in the big form of the |
| * template in place of the content text. |
| */ |
| public BigTextStyle bigText(CharSequence cs) { |
| mBigText = safeCharSequence(cs); |
| return this; |
| } |
| |
| /** |
| * @hide |
| */ |
| public void addExtras(Bundle extras) { |
| super.addExtras(extras); |
| |
| extras.putCharSequence(EXTRA_BIG_TEXT, mBigText); |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| protected void restoreFromExtras(Bundle extras) { |
| super.restoreFromExtras(extras); |
| |
| mBigText = extras.getCharSequence(EXTRA_BIG_TEXT); |
| } |
| |
| /** |
| * @hide |
| */ |
| public RemoteViews makeBigContentView() { |
| |
| // Nasty |
| CharSequence text = mBuilder.getAllExtras().getCharSequence(EXTRA_TEXT); |
| mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null); |
| |
| RemoteViews contentView = getStandardView(mBuilder.getBigTextLayoutResource()); |
| |
| mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, text); |
| |
| CharSequence bigTextText = mBuilder.processLegacyText(mBigText); |
| if (TextUtils.isEmpty(bigTextText)) { |
| // In case the bigtext is null / empty fall back to the normal text to avoid a weird |
| // experience |
| bigTextText = mBuilder.processLegacyText(text); |
| } |
| applyBigTextContentView(mBuilder, contentView, bigTextText); |
| |
| return contentView; |
| } |
| |
| static void applyBigTextContentView(Builder builder, |
| RemoteViews contentView, CharSequence bigTextText) { |
| contentView.setTextViewText(R.id.big_text, bigTextText); |
| contentView.setViewVisibility(R.id.big_text, |
| TextUtils.isEmpty(bigTextText) ? View.GONE : View.VISIBLE); |
| contentView.setInt(R.id.big_text, "setMaxLines", calculateMaxLines(builder)); |
| contentView.setBoolean(R.id.big_text, "setHasImage", builder.mN.hasLargeIcon()); |
| } |
| |
| private static int calculateMaxLines(Builder builder) { |
| int lineCount = MAX_LINES; |
| boolean hasActions = builder.mActions.size() > 0; |
| if (hasActions) { |
| lineCount -= LINES_CONSUMED_BY_ACTIONS; |
| } |
| return lineCount; |
| } |
| } |
| |
| /** |
| * Helper class for generating large-format notifications that include multiple back-and-forth |
| * messages of varying types between any number of people. |
| * |
| * <br> |
| * If the platform does not provide large-format notifications, this method has no effect. The |
| * user will always see the normal notification view. |
| * <br> |
| * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like |
| * so: |
| * <pre class="prettyprint"> |
| * |
| * Notification noti = new Notification.Builder() |
| * .setContentTitle("2 new messages wtih " + sender.toString()) |
| * .setContentText(subject) |
| * .setSmallIcon(R.drawable.new_message) |
| * .setLargeIcon(aBitmap) |
| * .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name)) |
| * .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender()) |
| * .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender())) |
| * .build(); |
| * </pre> |
| */ |
| public static class MessagingStyle extends Style { |
| |
| /** |
| * The maximum number of messages that will be retained in the Notification itself (the |
| * number displayed is up to the platform). |
| */ |
| public static final int MAXIMUM_RETAINED_MESSAGES = 25; |
| |
| CharSequence mUserDisplayName; |
| CharSequence mConversationTitle; |
| List<Message> mMessages = new ArrayList<>(); |
| |
| MessagingStyle() { |
| } |
| |
| /** |
| * @param userDisplayName the name to be displayed for any replies sent by the user before the |
| * posting app reposts the notification with those messages after they've been actually |
| * sent and in previous messages sent by the user added in |
| * {@link #addMessage(Notification.MessagingStyle.Message)} |
| */ |
| public MessagingStyle(CharSequence userDisplayName) { |
| mUserDisplayName = userDisplayName; |
| } |
| |
| /** |
| * Returns the name to be displayed for any replies sent by the user |
| */ |
| public CharSequence getUserDisplayName() { |
| return mUserDisplayName; |
| } |
| |
| /** |
| * Sets the title to be displayed on this conversation. This should only be used for |
| * group messaging and left unset for one-on-one conversations. |
| * @param conversationTitle |
| * @return this object for method chaining. |
| */ |
| public MessagingStyle setConversationTitle(CharSequence conversationTitle) { |
| mConversationTitle = conversationTitle; |
| return this; |
| } |
| |
| /** |
| * Return the title to be displayed on this conversation. Can be <code>null</code> and |
| * should be for one-on-one conversations |
| */ |
| public CharSequence getConversationTitle() { |
| return mConversationTitle; |
| } |
| |
| /** |
| * Adds a message for display by this notification. Convenience call for a simple |
| * {@link Message} in {@link #addMessage(Notification.MessagingStyle.Message)}. |
| * @param text A {@link CharSequence} to be displayed as the message content |
| * @param timestamp Time at which the message arrived |
| * @param sender A {@link CharSequence} to be used for displaying the name of the |
| * sender. Should be <code>null</code> for messages by the current user, in which case |
| * the platform will insert {@link #getUserDisplayName()}. |
| * Should be unique amongst all individuals in the conversation, and should be |
| * consistent during re-posts of the notification. |
| * |
| * @see Message#Message(CharSequence, long, CharSequence) |
| * |
| * @return this object for method chaining |
| */ |
| public MessagingStyle addMessage(CharSequence text, long timestamp, CharSequence sender) { |
| mMessages.add(new Message(text, timestamp, sender)); |
| if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) { |
| mMessages.remove(0); |
| } |
| return this; |
| } |
| |
| /** |
| * Adds a {@link Message} for display in this notification. |
| * @param message The {@link Message} to be displayed |
| * @return this object for method chaining |
| */ |
| public MessagingStyle addMessage(Message message) { |
| mMessages.add(message); |
| if (mMessages.size() > MAXIMUM_RETAINED_MESSAGES) { |
| mMessages.remove(0); |
| } |
| return this; |
| } |
| |
| /** |
| * Gets the list of {@code Message} objects that represent the notification |
| */ |
| public List<Message> getMessages() { |
| return mMessages; |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public void addExtras(Bundle extras) { |
| super.addExtras(extras); |
| if (mUserDisplayName != null) { |
| extras.putCharSequence(EXTRA_SELF_DISPLAY_NAME, mUserDisplayName); |
| } |
| if (mConversationTitle != null) { |
| extras.putCharSequence(EXTRA_CONVERSATION_TITLE, mConversationTitle); |
| } |
| if (!mMessages.isEmpty()) { extras.putParcelableArray(EXTRA_MESSAGES, |
| Message.getBundleArrayForMessages(mMessages)); |
| } |
| |
| fixTitleAndTextExtras(extras); |
| } |
| |
| private void fixTitleAndTextExtras(Bundle extras) { |
| Message m = findLatestIncomingMessage(); |
| CharSequence text = (m == null) ? null : m.mText; |
| CharSequence sender = m == null ? null |
| : TextUtils.isEmpty(m.mSender) ? mUserDisplayName : m.mSender; |
| CharSequence title; |
| if (!TextUtils.isEmpty(mConversationTitle)) { |
| if (!TextUtils.isEmpty(sender)) { |
| BidiFormatter bidi = BidiFormatter.getInstance(); |
| title = mBuilder.mContext.getString( |
| com.android.internal.R.string.notification_messaging_title_template, |
| bidi.unicodeWrap(mConversationTitle), bidi.unicodeWrap(m.mSender)); |
| } else { |
| title = mConversationTitle; |
| } |
| } else { |
| title = sender; |
| } |
| |
| if (title != null) { |
| extras.putCharSequence(EXTRA_TITLE, title); |
| } |
| if (text != null) { |
| extras.putCharSequence(EXTRA_TEXT, text); |
| } |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| protected void restoreFromExtras(Bundle extras) { |
| super.restoreFromExtras(extras); |
| |
| mMessages.clear(); |
| mUserDisplayName = extras.getCharSequence(EXTRA_SELF_DISPLAY_NAME); |
| mConversationTitle = extras.getCharSequence(EXTRA_CONVERSATION_TITLE); |
| Parcelable[] parcelables = extras.getParcelableArray(EXTRA_MESSAGES); |
| if (parcelables != null && parcelables instanceof Parcelable[]) { |
| mMessages = Message.getMessagesFromBundleArray(parcelables); |
| } |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeContentView() { |
| Message m = findLatestIncomingMessage(); |
| CharSequence title = mConversationTitle != null |
| ? mConversationTitle |
| : (m == null) ? null : m.mSender; |
| CharSequence text = (m == null) |
| ? null |
| : mConversationTitle != null ? makeMessageLine(m) : m.mText; |
| |
| return mBuilder.applyStandardTemplate(mBuilder.getBaseLayoutResource(), |
| false /* hasProgress */, |
| title, |
| text); |
| } |
| |
| private Message findLatestIncomingMessage() { |
| for (int i = mMessages.size() - 1; i >= 0; i--) { |
| Message m = mMessages.get(i); |
| // Incoming messages have a non-empty sender. |
| if (!TextUtils.isEmpty(m.mSender)) { |
| return m; |
| } |
| } |
| if (!mMessages.isEmpty()) { |
| // No incoming messages, fall back to outgoing message |
| return mMessages.get(mMessages.size() - 1); |
| } |
| return null; |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeBigContentView() { |
| CharSequence title = !TextUtils.isEmpty(super.mBigContentTitle) |
| ? super.mBigContentTitle |
| : mConversationTitle; |
| boolean hasTitle = !TextUtils.isEmpty(title); |
| |
| if (mMessages.size() == 1) { |
| // Special case for a single message: Use the big text style |
| // so the collapsed and expanded versions match nicely. |
| CharSequence bigTitle; |
| CharSequence text; |
| if (hasTitle) { |
| bigTitle = title; |
| text = makeMessageLine(mMessages.get(0)); |
| } else { |
| bigTitle = mMessages.get(0).mSender; |
| text = mMessages.get(0).mText; |
| } |
| RemoteViews contentView = mBuilder.applyStandardTemplateWithActions( |
| mBuilder.getBigTextLayoutResource(), |
| false /* progress */, bigTitle, null /* text */); |
| BigTextStyle.applyBigTextContentView(mBuilder, contentView, text); |
| return contentView; |
| } |
| |
| RemoteViews contentView = mBuilder.applyStandardTemplateWithActions( |
| mBuilder.getMessagingLayoutResource(), |
| false /* hasProgress */, |
| title, |
| null /* text */); |
| |
| int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3, |
| R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6}; |
| |
| // Make sure all rows are gone in case we reuse a view. |
| for (int rowId : rowIds) { |
| contentView.setViewVisibility(rowId, View.GONE); |
| } |
| |
| int i=0; |
| contentView.setViewLayoutMarginBottomDimen(R.id.line1, |
| hasTitle ? R.dimen.notification_messaging_spacing : 0); |
| contentView.setInt(R.id.notification_messaging, "setNumIndentLines", |
| !mBuilder.mN.hasLargeIcon() ? 0 : (hasTitle ? 1 : 2)); |
| |
| int contractedChildId = View.NO_ID; |
| Message contractedMessage = findLatestIncomingMessage(); |
| int firstMessage = Math.max(0, mMessages.size() - rowIds.length); |
| while (firstMessage + i < mMessages.size() && i < rowIds.length) { |
| Message m = mMessages.get(firstMessage + i); |
| int rowId = rowIds[i]; |
| |
| contentView.setViewVisibility(rowId, View.VISIBLE); |
| contentView.setTextViewText(rowId, makeMessageLine(m)); |
| |
| if (contractedMessage == m) { |
| contractedChildId = rowId; |
| } |
| |
| i++; |
| } |
| // Record this here to allow transformation between the contracted and expanded views. |
| contentView.setInt(R.id.notification_messaging, "setContractedChildId", |
| contractedChildId); |
| return contentView; |
| } |
| |
| private CharSequence makeMessageLine(Message m) { |
| BidiFormatter bidi = BidiFormatter.getInstance(); |
| SpannableStringBuilder sb = new SpannableStringBuilder(); |
| if (TextUtils.isEmpty(m.mSender)) { |
| CharSequence replyName = mUserDisplayName == null ? "" : mUserDisplayName; |
| sb.append(bidi.unicodeWrap(replyName), |
| makeFontColorSpan(mBuilder.resolveContrastColor()), |
| 0 /* flags */); |
| } else { |
| sb.append(bidi.unicodeWrap(m.mSender), |
| makeFontColorSpan(Color.BLACK), |
| 0 /* flags */); |
| } |
| CharSequence text = m.mText == null ? "" : m.mText; |
| sb.append(" ").append(bidi.unicodeWrap(text)); |
| return sb; |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeHeadsUpContentView() { |
| Message m = findLatestIncomingMessage(); |
| CharSequence title = mConversationTitle != null |
| ? mConversationTitle |
| : (m == null) ? null : m.mSender; |
| CharSequence text = (m == null) |
| ? null |
| : mConversationTitle != null ? makeMessageLine(m) : m.mText; |
| |
| return mBuilder.applyStandardTemplateWithActions(mBuilder.getBigBaseLayoutResource(), |
| false /* hasProgress */, |
| title, |
| text); |
| } |
| |
| private static TextAppearanceSpan makeFontColorSpan(int color) { |
| return new TextAppearanceSpan(null, 0, 0, |
| ColorStateList.valueOf(color), null); |
| } |
| |
| public static final class Message { |
| |
| static final String KEY_TEXT = "text"; |
| static final String KEY_TIMESTAMP = "time"; |
| static final String KEY_SENDER = "sender"; |
| static final String KEY_DATA_MIME_TYPE = "type"; |
| static final String KEY_DATA_URI= "uri"; |
| |
| private final CharSequence mText; |
| private final long mTimestamp; |
| private final CharSequence mSender; |
| |
| private String mDataMimeType; |
| private Uri mDataUri; |
| |
| /** |
| * Constructor |
| * @param text A {@link CharSequence} to be displayed as the message content |
| * @param timestamp Time at which the message arrived |
| * @param sender A {@link CharSequence} to be used for displaying the name of the |
| * sender. Should be <code>null</code> for messages by the current user, in which case |
| * the platform will insert {@link MessagingStyle#getUserDisplayName()}. |
| * Should be unique amongst all individuals in the conversation, and should be |
| * consistent during re-posts of the notification. |
| */ |
| public Message(CharSequence text, long timestamp, CharSequence sender){ |
| mText = text; |
| mTimestamp = timestamp; |
| mSender = sender; |
| } |
| |
| /** |
| * Sets a binary blob of data and an associated MIME type for a message. In the case |
| * where the platform doesn't support the MIME type, the original text provided in the |
| * constructor will be used. |
| * @param dataMimeType The MIME type of the content. See |
| * <a href="{@docRoot}notifications/messaging.html"> for the list of supported MIME |
| * types on Android and Android Wear. |
| * @param dataUri The uri containing the content whose type is given by the MIME type. |
| * <p class="note"> |
| * <ol> |
| * <li>Notification Listeners including the System UI need permission to access the |
| * data the Uri points to. The recommended ways to do this are:</li> |
| * <li>Store the data in your own ContentProvider, making sure that other apps have |
| * the correct permission to access your provider. The preferred mechanism for |
| * providing access is to use per-URI permissions which are temporary and only |
| * grant access to the receiving application. An easy way to create a |
| * ContentProvider like this is to use the FileProvider helper class.</li> |
| * <li>Use the system MediaStore. The MediaStore is primarily aimed at video, audio |
| * and image MIME types, however beginning with Android 3.0 (API level 11) it can |
| * also store non-media types (see MediaStore.Files for more info). Files can be |
| * inserted into the MediaStore using scanFile() after which a content:// style |
| * Uri suitable for sharing is passed to the provided onScanCompleted() callback. |
| * Note that once added to the system MediaStore the content is accessible to any |
| * app on the device.</li> |
| * </ol> |
| * @return this object for method chaining |
| */ |
| public Message setData(String dataMimeType, Uri dataUri) { |
| mDataMimeType = dataMimeType; |
| mDataUri = dataUri; |
| return this; |
| } |
| |
| /** |
| * Get the text to be used for this message, or the fallback text if a type and content |
| * Uri have been set |
| */ |
| public CharSequence getText() { |
| return mText; |
| } |
| |
| /** |
| * Get the time at which this message arrived |
| */ |
| public long getTimestamp() { |
| return mTimestamp; |
| } |
| |
| /** |
| * Get the text used to display the contact's name in the messaging experience |
| */ |
| public CharSequence getSender() { |
| return mSender; |
| } |
| |
| /** |
| * Get the MIME type of the data pointed to by the Uri |
| */ |
| public String getDataMimeType() { |
| return mDataMimeType; |
| } |
| |
| /** |
| * Get the the Uri pointing to the content of the message. Can be null, in which case |
| * {@see #getText()} is used. |
| */ |
| public Uri getDataUri() { |
| return mDataUri; |
| } |
| |
| private Bundle toBundle() { |
| Bundle bundle = new Bundle(); |
| if (mText != null) { |
| bundle.putCharSequence(KEY_TEXT, mText); |
| } |
| bundle.putLong(KEY_TIMESTAMP, mTimestamp); |
| if (mSender != null) { |
| bundle.putCharSequence(KEY_SENDER, mSender); |
| } |
| if (mDataMimeType != null) { |
| bundle.putString(KEY_DATA_MIME_TYPE, mDataMimeType); |
| } |
| if (mDataUri != null) { |
| bundle.putParcelable(KEY_DATA_URI, mDataUri); |
| } |
| return bundle; |
| } |
| |
| static Bundle[] getBundleArrayForMessages(List<Message> messages) { |
| Bundle[] bundles = new Bundle[messages.size()]; |
| final int N = messages.size(); |
| for (int i = 0; i < N; i++) { |
| bundles[i] = messages.get(i).toBundle(); |
| } |
| return bundles; |
| } |
| |
| static List<Message> getMessagesFromBundleArray(Parcelable[] bundles) { |
| List<Message> messages = new ArrayList<>(bundles.length); |
| for (int i = 0; i < bundles.length; i++) { |
| if (bundles[i] instanceof Bundle) { |
| Message message = getMessageFromBundle((Bundle)bundles[i]); |
| if (message != null) { |
| messages.add(message); |
| } |
| } |
| } |
| return messages; |
| } |
| |
| static Message getMessageFromBundle(Bundle bundle) { |
| try { |
| if (!bundle.containsKey(KEY_TEXT) || !bundle.containsKey(KEY_TIMESTAMP)) { |
| return null; |
| } else { |
| Message message = new Message(bundle.getCharSequence(KEY_TEXT), |
| bundle.getLong(KEY_TIMESTAMP), bundle.getCharSequence(KEY_SENDER)); |
| if (bundle.containsKey(KEY_DATA_MIME_TYPE) && |
| bundle.containsKey(KEY_DATA_URI)) { |
| |
| message.setData(bundle.getString(KEY_DATA_MIME_TYPE), |
| (Uri) bundle.getParcelable(KEY_DATA_URI)); |
| } |
| return message; |
| } |
| } catch (ClassCastException e) { |
| return null; |
| } |
| } |
| } |
| } |
| |
| /** |
| * Helper class for generating large-format notifications that include a list of (up to 5) strings. |
| * |
| * Here's how you'd set the <code>InboxStyle</code> on a notification: |
| * <pre class="prettyprint"> |
| * Notification notif = new Notification.Builder(mContext) |
| * .setContentTitle("5 New mails from " + sender.toString()) |
| * .setContentText(subject) |
| * .setSmallIcon(R.drawable.new_mail) |
| * .setLargeIcon(aBitmap) |
| * .setStyle(new Notification.InboxStyle() |
| * .addLine(str1) |
| * .addLine(str2) |
| * .setContentTitle("") |
| * .setSummaryText("+3 more")) |
| * .build(); |
| * </pre> |
| * |
| * @see Notification#bigContentView |
| */ |
| public static class InboxStyle extends Style { |
| private ArrayList<CharSequence> mTexts = new ArrayList<CharSequence>(5); |
| |
| public InboxStyle() { |
| } |
| |
| /** |
| * @deprecated use {@code InboxStyle()}. |
| */ |
| @Deprecated |
| public InboxStyle(Builder builder) { |
| setBuilder(builder); |
| } |
| |
| /** |
| * Overrides ContentTitle in the big form of the template. |
| * This defaults to the value passed to setContentTitle(). |
| */ |
| public InboxStyle setBigContentTitle(CharSequence title) { |
| internalSetBigContentTitle(safeCharSequence(title)); |
| return this; |
| } |
| |
| /** |
| * Set the first line of text after the detail section in the big form of the template. |
| */ |
| public InboxStyle setSummaryText(CharSequence cs) { |
| internalSetSummaryText(safeCharSequence(cs)); |
| return this; |
| } |
| |
| /** |
| * Append a line to the digest section of the Inbox notification. |
| */ |
| public InboxStyle addLine(CharSequence cs) { |
| mTexts.add(safeCharSequence(cs)); |
| return this; |
| } |
| |
| /** |
| * @hide |
| */ |
| public void addExtras(Bundle extras) { |
| super.addExtras(extras); |
| |
| CharSequence[] a = new CharSequence[mTexts.size()]; |
| extras.putCharSequenceArray(EXTRA_TEXT_LINES, mTexts.toArray(a)); |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| protected void restoreFromExtras(Bundle extras) { |
| super.restoreFromExtras(extras); |
| |
| mTexts.clear(); |
| if (extras.containsKey(EXTRA_TEXT_LINES)) { |
| Collections.addAll(mTexts, extras.getCharSequenceArray(EXTRA_TEXT_LINES)); |
| } |
| } |
| |
| /** |
| * @hide |
| */ |
| public RemoteViews makeBigContentView() { |
| // Remove the content text so it disappears unless you have a summary |
| // Nasty |
| CharSequence oldBuilderContentText = mBuilder.mN.extras.getCharSequence(EXTRA_TEXT); |
| mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, null); |
| |
| RemoteViews contentView = getStandardView(mBuilder.getInboxLayoutResource()); |
| |
| mBuilder.getAllExtras().putCharSequence(EXTRA_TEXT, oldBuilderContentText); |
| |
| int[] rowIds = {R.id.inbox_text0, R.id.inbox_text1, R.id.inbox_text2, R.id.inbox_text3, |
| R.id.inbox_text4, R.id.inbox_text5, R.id.inbox_text6}; |
| |
| // Make sure all rows are gone in case we reuse a view. |
| for (int rowId : rowIds) { |
| contentView.setViewVisibility(rowId, View.GONE); |
| } |
| |
| int i=0; |
| int topPadding = mBuilder.mContext.getResources().getDimensionPixelSize( |
| R.dimen.notification_inbox_item_top_padding); |
| boolean first = true; |
| int onlyViewId = 0; |
| int maxRows = rowIds.length; |
| if (mBuilder.mActions.size() > 0) { |
| maxRows--; |
| } |
| while (i < mTexts.size() && i < maxRows) { |
| CharSequence str = mTexts.get(i); |
| if (!TextUtils.isEmpty(str)) { |
| contentView.setViewVisibility(rowIds[i], View.VISIBLE); |
| contentView.setTextViewText(rowIds[i], mBuilder.processLegacyText(str)); |
| contentView.setViewPadding(rowIds[i], 0, topPadding, 0, 0); |
| handleInboxImageMargin(contentView, rowIds[i], first); |
| if (first) { |
| onlyViewId = rowIds[i]; |
| } else { |
| onlyViewId = 0; |
| } |
| first = false; |
| } |
| i++; |
| } |
| if (onlyViewId != 0) { |
| // We only have 1 entry, lets make it look like the normal Text of a Bigtext |
| topPadding = mBuilder.mContext.getResources().getDimensionPixelSize( |
| R.dimen.notification_text_margin_top); |
| contentView.setViewPadding(onlyViewId, 0, topPadding, 0, 0); |
| } |
| |
| return contentView; |
| } |
| |
| private void handleInboxImageMargin(RemoteViews contentView, int id, boolean first) { |
| int endMargin = 0; |
| if (first) { |
| final int max = mBuilder.mN.extras.getInt(EXTRA_PROGRESS_MAX, 0); |
| final boolean ind = mBuilder.mN.extras.getBoolean(EXTRA_PROGRESS_INDETERMINATE); |
| boolean hasProgress = max != 0 || ind; |
| if (mBuilder.mN.hasLargeIcon() && !hasProgress) { |
| endMargin = R.dimen.notification_content_picture_margin; |
| } |
| } |
| contentView.setViewLayoutMarginEndDimen(id, endMargin); |
| } |
| } |
| |
| /** |
| * Notification style for media playback notifications. |
| * |
| * In the expanded form, {@link Notification#bigContentView}, up to 5 |
| * {@link Notification.Action}s specified with |
| * {@link Notification.Builder#addAction(Action) addAction} will be |
| * shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to |
| * {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon()} will be |
| * treated as album artwork. |
| * |
| * Unlike the other styles provided here, MediaStyle can also modify the standard-size |
| * {@link Notification#contentView}; by providing action indices to |
| * {@link #setShowActionsInCompactView(int...)} you can promote up to 3 actions to be displayed |
| * in the standard view alongside the usual content. |
| * |
| * Notifications created with MediaStyle will have their category set to |
| * {@link Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT} unless you set a different |
| * category using {@link Notification.Builder#setCategory(String) setCategory()}. |
| * |
| * Finally, if you attach a {@link android.media.session.MediaSession.Token} using |
| * {@link android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token)}, |
| * the System UI can identify this as a notification representing an active media session |
| * and respond accordingly (by showing album artwork in the lockscreen, for example). |
| * |
| * To use this style with your Notification, feed it to |
| * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so: |
| * <pre class="prettyprint"> |
| * Notification noti = new Notification.Builder() |
| * .setSmallIcon(R.drawable.ic_stat_player) |
| * .setContentTitle("Track title") |
| * .setContentText("Artist - Album") |
| * .setLargeIcon(albumArtBitmap)) |
| * .setStyle(<b>new Notification.MediaStyle()</b> |
| * .setMediaSession(mySession)) |
| * .build(); |
| * </pre> |
| * |
| * @see Notification#bigContentView |
| */ |
| public static class MediaStyle extends Style { |
| static final int MAX_MEDIA_BUTTONS_IN_COMPACT = 3; |
| static final int MAX_MEDIA_BUTTONS = 5; |
| |
| private int[] mActionsToShowInCompact = null; |
| private MediaSession.Token mToken; |
| |
| public MediaStyle() { |
| } |
| |
| /** |
| * @deprecated use {@code MediaStyle()}. |
| */ |
| @Deprecated |
| public MediaStyle(Builder builder) { |
| setBuilder(builder); |
| } |
| |
| /** |
| * Request up to 3 actions (by index in the order of addition) to be shown in the compact |
| * notification view. |
| * |
| * @param actions the indices of the actions to show in the compact notification view |
| */ |
| public MediaStyle setShowActionsInCompactView(int...actions) { |
| mActionsToShowInCompact = actions; |
| return this; |
| } |
| |
| /** |
| * Attach a {@link android.media.session.MediaSession.Token} to this Notification |
| * to provide additional playback information and control to the SystemUI. |
| */ |
| public MediaStyle setMediaSession(MediaSession.Token token) { |
| mToken = token; |
| return this; |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public Notification buildStyled(Notification wip) { |
| super.buildStyled(wip); |
| if (wip.category == null) { |
| wip.category = Notification.CATEGORY_TRANSPORT; |
| } |
| return wip; |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeContentView() { |
| return makeMediaContentView(); |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeBigContentView() { |
| return makeMediaBigContentView(); |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeHeadsUpContentView() { |
| RemoteViews expanded = makeMediaBigContentView(); |
| return expanded != null ? expanded : makeMediaContentView(); |
| } |
| |
| /** @hide */ |
| @Override |
| public void addExtras(Bundle extras) { |
| super.addExtras(extras); |
| |
| if (mToken != null) { |
| extras.putParcelable(EXTRA_MEDIA_SESSION, mToken); |
| } |
| if (mActionsToShowInCompact != null) { |
| extras.putIntArray(EXTRA_COMPACT_ACTIONS, mActionsToShowInCompact); |
| } |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| protected void restoreFromExtras(Bundle extras) { |
| super.restoreFromExtras(extras); |
| |
| if (extras.containsKey(EXTRA_MEDIA_SESSION)) { |
| mToken = extras.getParcelable(EXTRA_MEDIA_SESSION); |
| } |
| if (extras.containsKey(EXTRA_COMPACT_ACTIONS)) { |
| mActionsToShowInCompact = extras.getIntArray(EXTRA_COMPACT_ACTIONS); |
| } |
| } |
| |
| private RemoteViews generateMediaActionButton(Action action, int color) { |
| final boolean tombstone = (action.actionIntent == null); |
| RemoteViews button = new BuilderRemoteViews(mBuilder.mContext.getApplicationInfo(), |
| R.layout.notification_material_media_action); |
| button.setImageViewIcon(R.id.action0, action.getIcon()); |
| button.setDrawableParameters(R.id.action0, false, -1, color, PorterDuff.Mode.SRC_ATOP, |
| -1); |
| if (!tombstone) { |
| button.setOnClickPendingIntent(R.id.action0, action.actionIntent); |
| } |
| button.setContentDescription(R.id.action0, action.title); |
| return button; |
| } |
| |
| private RemoteViews makeMediaContentView() { |
| RemoteViews view = mBuilder.applyStandardTemplate( |
| R.layout.notification_template_material_media, false /* hasProgress */); |
| |
| final int numActions = mBuilder.mActions.size(); |
| final int N = mActionsToShowInCompact == null |
| ? 0 |
| : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT); |
| if (N > 0) { |
| view.removeAllViews(com.android.internal.R.id.media_actions); |
| for (int i = 0; i < N; i++) { |
| if (i >= numActions) { |
| throw new IllegalArgumentException(String.format( |
| "setShowActionsInCompactView: action %d out of bounds (max %d)", |
| i, numActions - 1)); |
| } |
| |
| final Action action = mBuilder.mActions.get(mActionsToShowInCompact[i]); |
| final RemoteViews button = generateMediaActionButton(action, |
| mBuilder.resolveContrastColor()); |
| view.addView(com.android.internal.R.id.media_actions, button); |
| } |
| } |
| handleImage(view); |
| // handle the content margin |
| int endMargin = R.dimen.notification_content_margin_end; |
| if (mBuilder.mN.hasLargeIcon()) { |
| endMargin = R.dimen.notification_content_plus_picture_margin_end; |
| } |
| view.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin); |
| return view; |
| } |
| |
| private RemoteViews makeMediaBigContentView() { |
| final int actionCount = Math.min(mBuilder.mActions.size(), MAX_MEDIA_BUTTONS); |
| // Dont add an expanded view if there is no more content to be revealed |
| int actionsInCompact = mActionsToShowInCompact == null |
| ? 0 |
| : Math.min(mActionsToShowInCompact.length, MAX_MEDIA_BUTTONS_IN_COMPACT); |
| if (!mBuilder.mN.hasLargeIcon() && actionCount <= actionsInCompact) { |
| return null; |
| } |
| RemoteViews big = mBuilder.applyStandardTemplate( |
| R.layout.notification_template_material_big_media, |
| false); |
| |
| if (actionCount > 0) { |
| big.removeAllViews(com.android.internal.R.id.media_actions); |
| for (int i = 0; i < actionCount; i++) { |
| final RemoteViews button = generateMediaActionButton(mBuilder.mActions.get(i), |
| mBuilder.resolveContrastColor()); |
| big.addView(com.android.internal.R.id.media_actions, button); |
| } |
| } |
| handleImage(big); |
| return big; |
| } |
| |
| private void handleImage(RemoteViews contentView) { |
| if (mBuilder.mN.hasLargeIcon()) { |
| contentView.setViewLayoutMarginEndDimen(R.id.line1, 0); |
| contentView.setViewLayoutMarginEndDimen(R.id.text, 0); |
| } |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| protected boolean hasProgress() { |
| return false; |
| } |
| } |
| |
| /** |
| * Notification style for custom views that are decorated by the system |
| * |
| * <p>Instead of providing a notification that is completely custom, a developer can set this |
| * style and still obtain system decorations like the notification header with the expand |
| * affordance and actions. |
| * |
| * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)}, |
| * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and |
| * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the |
| * corresponding custom views to display. |
| * |
| * To use this style with your Notification, feed it to |
| * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so: |
| * <pre class="prettyprint"> |
| * Notification noti = new Notification.Builder() |
| * .setSmallIcon(R.drawable.ic_stat_player) |
| * .setLargeIcon(albumArtBitmap)) |
| * .setCustomContentView(contentView); |
| * .setStyle(<b>new Notification.DecoratedCustomViewStyle()</b>) |
| * .build(); |
| * </pre> |
| */ |
| public static class DecoratedCustomViewStyle extends Style { |
| |
| public DecoratedCustomViewStyle() { |
| } |
| |
| /** |
| * @hide |
| */ |
| public boolean displayCustomViewInline() { |
| return true; |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeContentView() { |
| return makeStandardTemplateWithCustomContent(mBuilder.mN.contentView); |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeBigContentView() { |
| return makeDecoratedBigContentView(); |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeHeadsUpContentView() { |
| return makeDecoratedHeadsUpContentView(); |
| } |
| |
| private RemoteViews makeDecoratedHeadsUpContentView() { |
| RemoteViews headsUpContentView = mBuilder.mN.headsUpContentView == null |
| ? mBuilder.mN.contentView |
| : mBuilder.mN.headsUpContentView; |
| if (mBuilder.mActions.size() == 0) { |
| return makeStandardTemplateWithCustomContent(headsUpContentView); |
| } |
| RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions( |
| mBuilder.getBigBaseLayoutResource()); |
| buildIntoRemoteViewContent(remoteViews, headsUpContentView); |
| return remoteViews; |
| } |
| |
| private RemoteViews makeStandardTemplateWithCustomContent(RemoteViews customContent) { |
| RemoteViews remoteViews = mBuilder.applyStandardTemplate( |
| mBuilder.getBaseLayoutResource()); |
| buildIntoRemoteViewContent(remoteViews, customContent); |
| return remoteViews; |
| } |
| |
| private RemoteViews makeDecoratedBigContentView() { |
| RemoteViews bigContentView = mBuilder.mN.bigContentView == null |
| ? mBuilder.mN.contentView |
| : mBuilder.mN.bigContentView; |
| if (mBuilder.mActions.size() == 0) { |
| return makeStandardTemplateWithCustomContent(bigContentView); |
| } |
| RemoteViews remoteViews = mBuilder.applyStandardTemplateWithActions( |
| mBuilder.getBigBaseLayoutResource()); |
| buildIntoRemoteViewContent(remoteViews, bigContentView); |
| return remoteViews; |
| } |
| |
| private void buildIntoRemoteViewContent(RemoteViews remoteViews, |
| RemoteViews customContent) { |
| if (customContent != null) { |
| // Need to clone customContent before adding, because otherwise it can no longer be |
| // parceled independently of remoteViews. |
| customContent = customContent.clone(); |
| remoteViews.removeAllViews(R.id.notification_main_column); |
| remoteViews.addView(R.id.notification_main_column, customContent); |
| } |
| // also update the end margin if there is an image |
| int endMargin = R.dimen.notification_content_margin_end; |
| if (mBuilder.mN.hasLargeIcon()) { |
| endMargin = R.dimen.notification_content_plus_picture_margin_end; |
| } |
| remoteViews.setViewLayoutMarginEndDimen(R.id.notification_main_column, endMargin); |
| } |
| } |
| |
| /** |
| * Notification style for media custom views that are decorated by the system |
| * |
| * <p>Instead of providing a media notification that is completely custom, a developer can set |
| * this style and still obtain system decorations like the notification header with the expand |
| * affordance and actions. |
| * |
| * <p>Use {@link android.app.Notification.Builder#setCustomContentView(RemoteViews)}, |
| * {@link android.app.Notification.Builder#setCustomBigContentView(RemoteViews)} and |
| * {@link android.app.Notification.Builder#setCustomHeadsUpContentView(RemoteViews)} to set the |
| * corresponding custom views to display. |
| * |
| * To use this style with your Notification, feed it to |
| * {@link Notification.Builder#setStyle(android.app.Notification.Style)} like so: |
| * <pre class="prettyprint"> |
| * Notification noti = new Notification.Builder() |
| * .setSmallIcon(R.drawable.ic_stat_player) |
| * .setLargeIcon(albumArtBitmap)) |
| * .setCustomContentView(contentView); |
| * .setStyle(<b>new Notification.DecoratedMediaCustomViewStyle()</b> |
| * .setMediaSession(mySession)) |
| * .build(); |
| * </pre> |
| * |
| * @see android.app.Notification.DecoratedCustomViewStyle |
| * @see android.app.Notification.MediaStyle |
| */ |
| public static class DecoratedMediaCustomViewStyle extends MediaStyle { |
| |
| public DecoratedMediaCustomViewStyle() { |
| } |
| |
| /** |
| * @hide |
| */ |
| public boolean displayCustomViewInline() { |
| return true; |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeContentView() { |
| RemoteViews remoteViews = super.makeContentView(); |
| return buildIntoRemoteView(remoteViews, R.id.notification_content_container, |
| mBuilder.mN.contentView); |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeBigContentView() { |
| RemoteViews customRemoteView = mBuilder.mN.bigContentView != null |
| ? mBuilder.mN.bigContentView |
| : mBuilder.mN.contentView; |
| return makeBigContentViewWithCustomContent(customRemoteView); |
| } |
| |
| private RemoteViews makeBigContentViewWithCustomContent(RemoteViews customRemoteView) { |
| RemoteViews remoteViews = super.makeBigContentView(); |
| if (remoteViews != null) { |
| return buildIntoRemoteView(remoteViews, R.id.notification_main_column, |
| customRemoteView); |
| } else if (customRemoteView != mBuilder.mN.contentView){ |
| remoteViews = super.makeContentView(); |
| return buildIntoRemoteView(remoteViews, R.id.notification_content_container, |
| customRemoteView); |
| } else { |
| return null; |
| } |
| } |
| |
| /** |
| * @hide |
| */ |
| @Override |
| public RemoteViews makeHeadsUpContentView() { |
| RemoteViews customRemoteView = mBuilder.mN.headsUpContentView != null |
| ? mBuilder.mN.headsUpContentView |
| : mBuilder.mN.contentView; |
| return makeBigContentViewWithCustomContent(customRemoteView); |
| } |
| |
| private RemoteViews buildIntoRemoteView(RemoteViews remoteViews, int id, |
| RemoteViews customContent) { |
| if (customContent != null) { |
| // Need to clone customContent before adding, because otherwise it can no longer be |
| // parceled independently of remoteViews. |
| customContent = customContent.clone(); |
| remoteViews.removeAllViews(id); |
| remoteViews.addView(id, customContent); |
| } |
| return remoteViews; |
| } |
| } |
| |
| // When adding a new Style subclass here, don't forget to update |
| // Builder.getNotificationStyleClass. |
| |
| /** |
| * Extender interface for use with {@link Builder#extend}. Extenders may be used to add |
| * metadata or change options on a notification builder. |
| */ |
| public interface Extender { |
| /** |
| * Apply this extender to a notification builder. |
| * @param builder the builder to be modified. |
| * @return the build object for chaining. |
| */ |
| public Builder extend(Builder builder); |
| } |
| |
| /** |
| * Helper class to add wearable extensions to notifications. |
| * <p class="note"> See |
| * <a href="{@docRoot}wear/notifications/creating.html">Creating Notifications |
| * for Android Wear</a> for more information on how to use this class. |
| * <p> |
| * To create a notification with wearable extensions: |
| * <ol> |
| * <li>Create a {@link android.app.Notification.Builder}, setting any desired |
| * properties. |
| * <li>Create a {@link android.app.Notification.WearableExtender}. |
| * <li>Set wearable-specific properties using the |
| * {@code add} and {@code set} methods of {@link android.app.Notification.WearableExtender}. |
| * <li>Call {@link android.app.Notification.Builder#extend} to apply the extensions to a |
| * notification. |
| * <li>Post the notification to the notification system with the |
| * {@code NotificationManager.notify(...)} methods. |
| * </ol> |
| * |
| * <pre class="prettyprint"> |
| * Notification notif = new Notification.Builder(mContext) |
| * .setContentTitle("New mail from " + sender.toString()) |
| * .setContentText(subject) |
| * .setSmallIcon(R.drawable.new_mail) |
| * .extend(new Notification.WearableExtender() |
| * .setContentIcon(R.drawable.new_mail)) |
| * .build(); |
| * NotificationManager notificationManger = |
| * (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE); |
| * notificationManger.notify(0, notif);</pre> |
| * |
| * <p>Wearable extensions can be accessed on an existing notification by using the |
| * {@code WearableExtender(Notification)} constructor, |
| * and then using the {@code get} methods to access values. |
| * |
| * <pre class="prettyprint"> |
| * Notification.WearableExtender wearableExtender = new Notification.WearableExtender( |
| * notification); |
| * List<Notification> pages = wearableExtender.getPages();</pre> |
| */ |
| public static final class WearableExtender implements Extender { |
| /** |
| * Sentinel value for an action index that is unset. |
| */ |
| public static final int UNSET_ACTION_INDEX = -1; |
| |
| /** |
| * Size value for use with {@link #setCustomSizePreset} to show this notification with |
| * default sizing. |
| * <p>For custom display notifications created using {@link #setDisplayIntent}, |
| * the default is {@link #SIZE_MEDIUM}. All other notifications size automatically based |
| * on their content. |
| */ |
| public static final int SIZE_DEFAULT = 0; |
| |
| /** |
| * Size value for use with {@link #setCustomSizePreset} to show this notification |
| * with an extra small size. |
| * <p>This value is only applicable for custom display notifications created using |
| * {@link #setDisplayIntent}. |
| */ |
| public static final int SIZE_XSMALL = 1; |
| |
| /** |
| * Size value for use with {@link #setCustomSizePreset} to show this notification |
| * with a small size. |
| * <p>This value is only applicable for custom display notifications created using |
| * {@link #setDisplayIntent}. |
| */ |
| public static final int SIZE_SMALL = 2; |
| |
| /** |
| * Size value for use with {@link #setCustomSizePreset} to show this notification |
| * with a medium size. |
| * <p>This value is only applicable for custom display notifications created using |
| * {@link #setDisplayIntent}. |
| */ |
| public static final int SIZE_MEDIUM = 3; |
| |
| /** |
| * Size value for use with {@link #setCustomSizePreset} to show this notification |
| * with a large size. |
| * <p>This value is only applicable for custom display notifications created using |
| * {@link #setDisplayIntent}. |
| */ |
| public static final int SIZE_LARGE = 4; |
| |
| /** |
| * Size value for use with {@link #setCustomSizePreset} to show this notification |
| * full screen. |
| * <p>This value is only applicable for custom display notifications created using |
| * {@link #setDisplayIntent}. |
| */ |
| public static final int SIZE_FULL_SCREEN = 5; |
| |
| /** |
| * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on for a |
| * short amount of time when this notification is displayed on the screen. This |
| * is the default value. |
| */ |
| public static final int SCREEN_TIMEOUT_SHORT = 0; |
| |
| /** |
| * Sentinel value for use with {@link #setHintScreenTimeout} to keep the screen on |
| * for a longer amount of time when this notification is displayed on the screen. |
| */ |
| public static final int SCREEN_TIMEOUT_LONG = -1; |
| |
| /** Notification extra which contains wearable extensions */ |
| private static final String EXTRA_WEARABLE_EXTENSIONS = "android.wearable.EXTENSIONS"; |
| |
| // Keys within EXTRA_WEARABLE_EXTENSIONS for wearable options. |
| private static final String KEY_ACTIONS = "actions"; |
| private static final String KEY_FLAGS = "flags"; |
| private static final String KEY_DISPLAY_INTENT = "displayIntent"; |
| private static final String KEY_PAGES = "pages"; |
| private static final String KEY_BACKGROUND = "background"; |
| private static final String KEY_CONTENT_ICON = "contentIcon"; |
| private static final String KEY_CONTENT_ICON_GRAVITY = "contentIconGravity"; |
| private static final String KEY_CONTENT_ACTION_INDEX = "contentActionIndex"; |
| private static final String KEY_CUSTOM_SIZE_PRESET = "customSizePreset"; |
| private static final String KEY_CUSTOM_CONTENT_HEIGHT = "customContentHeight"; |
| private static final String KEY_GRAVITY = "gravity"; |
| private static final String KEY_HINT_SCREEN_TIMEOUT = "hintScreenTimeout"; |
| private static final String KEY_DISMISSAL_ID = "dismissalId"; |
| |
| // Flags bitwise-ored to mFlags |
| private static final int FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE = 0x1; |
| private static final int FLAG_HINT_HIDE_ICON = 1 << 1; |
| private static final int FLAG_HINT_SHOW_BACKGROUND_ONLY = 1 << 2; |
| private static final int FLAG_START_SCROLL_BOTTOM = 1 << 3; |
| private static final int FLAG_HINT_AVOID_BACKGROUND_CLIPPING = 1 << 4; |
| private static final int FLAG_BIG_PICTURE_AMBIENT = 1 << 5; |
| private static final int FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY = 1 << 6; |
| |
| // Default value for flags integer |
| private static final int DEFAULT_FLAGS = FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE; |
| |
| private static final int DEFAULT_CONTENT_ICON_GRAVITY = Gravity.END; |
| private static final int DEFAULT_GRAVITY = Gravity.BOTTOM; |
| |
| private ArrayList<Action> mActions = new ArrayList<Action>(); |
| private int mFlags = DEFAULT_FLAGS; |
| private PendingIntent mDisplayIntent; |
| private ArrayList<Notification> mPages = new ArrayList<Notification>(); |
| private Bitmap mBackground; |
| private int mContentIcon; |
| private int mContentIconGravity = DEFAULT_CONTENT_ICON_GRAVITY; |
| private int mContentActionIndex = UNSET_ACTION_INDEX; |
| private int mCustomSizePreset = SIZE_DEFAULT; |
| private int mCustomContentHeight; |
| private int mGravity = DEFAULT_GRAVITY; |
| private int mHintScreenTimeout; |
| private String mDismissalId; |
| |
| /** |
| * Create a {@link android.app.Notification.WearableExtender} with default |
| * options. |
| */ |
| public WearableExtender() { |
| } |
| |
| public WearableExtender(Notification notif) { |
| Bundle wearableBundle = notif.extras.getBundle(EXTRA_WEARABLE_EXTENSIONS); |
| if (wearableBundle != null) { |
| List<Action> actions = wearableBundle.getParcelableArrayList(KEY_ACTIONS); |
| if (actions != null) { |
| mActions.addAll(actions); |
| } |
| |
| mFlags = wearableBundle.getInt(KEY_FLAGS, DEFAULT_FLAGS); |
| mDisplayIntent = wearableBundle.getParcelable(KEY_DISPLAY_INTENT); |
| |
| Notification[] pages = getNotificationArrayFromBundle( |
| wearableBundle, KEY_PAGES); |
| if (pages != null) { |
| Collections.addAll(mPages, pages); |
| } |
| |
| mBackground = wearableBundle.getParcelable(KEY_BACKGROUND); |
| mContentIcon = wearableBundle.getInt(KEY_CONTENT_ICON); |
| mContentIconGravity = wearableBundle.getInt(KEY_CONTENT_ICON_GRAVITY, |
| DEFAULT_CONTENT_ICON_GRAVITY); |
| mContentActionIndex = wearableBundle.getInt(KEY_CONTENT_ACTION_INDEX, |
| UNSET_ACTION_INDEX); |
| mCustomSizePreset = wearableBundle.getInt(KEY_CUSTOM_SIZE_PRESET, |
| SIZE_DEFAULT); |
| mCustomContentHeight = wearableBundle.getInt(KEY_CUSTOM_CONTENT_HEIGHT); |
| mGravity = wearableBundle.getInt(KEY_GRAVITY, DEFAULT_GRAVITY); |
| mHintScreenTimeout = wearableBundle.getInt(KEY_HINT_SCREEN_TIMEOUT); |
| mDismissalId = wearableBundle.getString(KEY_DISMISSAL_ID); |
| } |
| } |
| |
| /** |
| * Apply wearable extensions to a notification that is being built. This is typically |
| * called by the {@link android.app.Notification.Builder#extend} method of |
| * {@link android.app.Notification.Builder}. |
| */ |
| @Override |
| public Notification.Builder extend(Notification.Builder builder) { |
| Bundle wearableBundle = new Bundle(); |
| |
| if (!mActions.isEmpty()) { |
| wearableBundle.putParcelableArrayList(KEY_ACTIONS, mActions); |
| } |
| if (mFlags != DEFAULT_FLAGS) { |
| wearableBundle.putInt(KEY_FLAGS, mFlags); |
| } |
| if (mDisplayIntent != null) { |
| wearableBundle.putParcelable(KEY_DISPLAY_INTENT, mDisplayIntent); |
| } |
| if (!mPages.isEmpty()) { |
| wearableBundle.putParcelableArray(KEY_PAGES, mPages.toArray( |
| new Notification[mPages.size()])); |
| } |
| if (mBackground != null) { |
| wearableBundle.putParcelable(KEY_BACKGROUND, mBackground); |
| } |
| if (mContentIcon != 0) { |
| wearableBundle.putInt(KEY_CONTENT_ICON, mContentIcon); |
| } |
| if (mContentIconGravity != DEFAULT_CONTENT_ICON_GRAVITY) { |
| wearableBundle.putInt(KEY_CONTENT_ICON_GRAVITY, mContentIconGravity); |
| } |
| if (mContentActionIndex != UNSET_ACTION_INDEX) { |
| wearableBundle.putInt(KEY_CONTENT_ACTION_INDEX, |
| mContentActionIndex); |
| } |
| if (mCustomSizePreset != SIZE_DEFAULT) { |
| wearableBundle.putInt(KEY_CUSTOM_SIZE_PRESET, mCustomSizePreset); |
| } |
| if (mCustomContentHeight != 0) { |
| wearableBundle.putInt(KEY_CUSTOM_CONTENT_HEIGHT, mCustomContentHeight); |
| } |
| if (mGravity != DEFAULT_GRAVITY) { |
| wearableBundle.putInt(KEY_GRAVITY, mGravity); |
| } |
| if (mHintScreenTimeout != 0) { |
| wearableBundle.putInt(KEY_HINT_SCREEN_TIMEOUT, mHintScreenTimeout); |
| } |
| if (mDismissalId != null) { |
| wearableBundle.putString(KEY_DISMISSAL_ID, mDismissalId); |
| } |
| |
| builder.getExtras().putBundle(EXTRA_WEARABLE_EXTENSIONS, wearableBundle); |
| return builder; |
| } |
| |
| @Override |
| public WearableExtender clone() { |
| WearableExtender that = new WearableExtender(); |
| that.mActions = new ArrayList<Action>(this.mActions); |
| that.mFlags = this.mFlags; |
| that.mDisplayIntent = this.mDisplayIntent; |
| that.mPages = new ArrayList<Notification>(this.mPages); |
| that.mBackground = this.mBackground; |
| that.mContentIcon = this.mContentIcon; |
| that.mContentIconGravity = this.mContentIconGravity; |
| that.mContentActionIndex = this.mContentActionIndex; |
| that.mCustomSizePreset = this.mCustomSizePreset; |
| that.mCustomContentHeight = this.mCustomContentHeight; |
| that.mGravity = this.mGravity; |
| that.mHintScreenTimeout = this.mHintScreenTimeout; |
| that.mDismissalId = this.mDismissalId; |
| return that; |
| } |
| |
| /** |
| * Add a wearable action to this notification. |
| * |
| * <p>When wearable actions are added using this method, the set of actions that |
| * show on a wearable device splits from devices that only show actions added |
| * using {@link android.app.Notification.Builder#addAction}. This allows for customization |
| * of which actions display on different devices. |
| * |
| * @param action the action to add to this notification |
| * @return this object for method chaining |
| * @see android.app.Notification.Action |
| */ |
| public WearableExtender addAction(Action action) { |
| mActions.add(action); |
| return this; |
| } |
| |
| /** |
| * Adds wearable actions to this notification. |
| * |
| * <p>When wearable actions are added using this method, the set of actions that |
| * show on a wearable device splits from devices that only show actions added |
| * using {@link android.app.Notification.Builder#addAction}. This allows for customization |
| * of which actions display on different devices. |
| * |
| * @param actions the actions to add to this notification |
| * @return this object for method chaining |
| * @see android.app.Notification.Action |
| */ |
| public WearableExtender addActions(List<Action> actions) { |
| mActions.addAll(actions); |
| return this; |
| } |
| |
| /** |
| * Clear all wearable actions present on this builder. |
| * @return this object for method chaining. |
| * @see #addAction |
| */ |
| public WearableExtender clearActions() { |
| mActions.clear(); |
| return this; |
| } |
| |
| /** |
| * Get the wearable actions present on this notification. |
| */ |
| public List<Action> getActions() { |
| return mActions; |
| } |
| |
| /** |
| * Set an intent to launch inside of an activity view when displaying |
| * this notification. The {@link PendingIntent} provided should be for an activity. |
| * |
| * <pre class="prettyprint"> |
| * Intent displayIntent = new Intent(context, MyDisplayActivity.class); |
| * PendingIntent displayPendingIntent = PendingIntent.getActivity(context, |
| * 0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT); |
| * Notification notif = new Notification.Builder(context) |
| * .extend(new Notification.WearableExtender() |
| * .setDisplayIntent(displayPendingIntent) |
| * .setCustomSizePreset(Notification.WearableExtender.SIZE_MEDIUM)) |
| * .build();</pre> |
| * |
| * <p>The activity to launch needs to allow embedding, must be exported, and |
| * should have an empty task affinity. It is also recommended to use the device |
| * default light theme. |
| * |
| * <p>Example AndroidManifest.xml entry: |
| * <pre class="prettyprint"> |
| * <activity android:name="com.example.MyDisplayActivity" |
| * android:exported="true" |
| * android:allowEmbedded="true" |
| * android:taskAffinity="" |
| * android:theme="@android:style/Theme.DeviceDefault.Light" /></pre> |
| * |
| * @param intent the {@link PendingIntent} for an activity |
| * @return this object for method chaining |
| * @see android.app.Notification.WearableExtender#getDisplayIntent |
| */ |
| public WearableExtender setDisplayIntent(PendingIntent intent) { |
| mDisplayIntent = intent; |
| return this; |
| } |
| |
| /** |
| * Get the intent to launch inside of an activity view when displaying this |
| * notification. This {@code PendingIntent} should be for an activity. |
| */ |
| public PendingIntent getDisplayIntent() { |
| return mDisplayIntent; |
| } |
| |
| /** |
| * Add an additional page of content to display with this notification. The current |
| * notification forms the first page, and pages added using this function form |
| * subsequent pages. This field can be used to separate a notification into multiple |
| * sections. |
| * |
| * @param page the notification to add as another page |
| * @return this object for method chaining |
| * @see android.app.Notification.WearableExtender#getPages |
| */ |
| public WearableExtender addPage(Notification page) { |
| mPages.add(page); |
| return this; |
| } |
| |
| /** |
| * Add additional pages of content to display with this notification. The current |
| * notification forms the first page, and pages added using this function form |
| * subsequent pages. This field can be used to separate a notification into multiple |
| * sections. |
| * |
| * @param pages a list of notifications |
| * @return this object for method chaining |
| * @see android.app.Notification.WearableExtender#getPages |
| */ |
| public WearableExtender addPages(List<Notification> pages) { |
| mPages.addAll(pages); |
| return this; |
| } |
| |
| /** |
| * Clear all additional pages present on this builder. |
| * @return this object for method chaining. |
| * @see #addPage |
| */ |
| public WearableExtender clearPages() { |
| mPages.clear(); |
| return this; |
| } |
| |
| /** |
| * Get the array of additional pages of content for displaying this notification. The |
| * current notification forms the first page, and elements within this array form |
| * subsequent pages. This field can be used to separate a notification into multiple |
| * sections. |
| * @return the pages for this notification |
| */ |
| public List<Notification> getPages() { |
| return mPages; |
| } |
| |
| /** |
| * Set a background image to be displayed behind the notification content. |
| * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background |
| * will work with any notification style. |
| * |
| * @param background the background bitmap |
| * @return this object for method chaining |
| * @see android.app.Notification.WearableExtender#getBackground |
| */ |
| public WearableExtender setBackground(Bitmap background) { |
| mBackground = background; |
| return this; |
| } |
| |
| /** |
| * Get a background image to be displayed behind the notification content. |
| * Contrary to the {@link android.app.Notification.BigPictureStyle}, this background |
| * will work with any notification style. |
| * |
| * @return the background image |
| * @see android.app.Notification.WearableExtender#setBackground |
| */ |
| public Bitmap getBackground() { |
| return mBackground; |
| } |
| |
| /** |
| * Set an icon that goes with the content of this notification. |
| */ |
| public WearableExtender setContentIcon(int icon) { |
| mContentIcon = icon; |
| return this; |
| } |
| |
| /** |
| * Get an icon that goes with the content of this notification. |
| */ |
| public int getContentIcon() { |
| return mContentIcon; |
| } |
| |
| /** |
| * Set the gravity that the content icon should have within the notification display. |
| * Supported values include {@link android.view.Gravity#START} and |
| * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}. |
| * @see #setContentIcon |
| */ |
| public WearableExtender setContentIconGravity(int contentIconGravity) { |
| mContentIconGravity = contentIconGravity; |
| return this; |
| } |
| |
| /** |
| * Get the gravity that the content icon should have within the notification display. |
| * Supported values include {@link android.view.Gravity#START} and |
| * {@link android.view.Gravity#END}. The default value is {@link android.view.Gravity#END}. |
| * @see #getContentIcon |
| */ |
| public int getContentIconGravity() { |
| return mContentIconGravity; |
| } |
| |
| /** |
| * Set an action from this notification's actions to be clickable with the content of |
| * this notification. This action will no longer display separately from the |
| * notification's content. |
| * |
| * <p>For notifications with multiple pages, child pages can also have content actions |
| * set, although the list of available actions comes from the main notification and not |
| * from the child page's notification. |
| * |
| * @param actionIndex The index of the action to hoist onto the current notification page. |
| * If wearable actions were added to the main notification, this index |
| * will apply to that list, otherwise it will apply to the regular |
| * actions list. |
| */ |
| public WearableExtender setContentAction(int actionIndex) { |
| mContentActionIndex = actionIndex; |
| return this; |
| } |
| |
| /** |
| * Get the index of the notification action, if any, that was specified as being clickable |
| * with the content of this notification. This action will no longer display separately |
| * from the notification's content. |
| * |
| * <p>For notifications with multiple pages, child pages can also have content actions |
| * set, although the list of available actions comes from the main notification and not |
| * from the child page's notification. |
| * |
| * <p>If wearable specific actions were added to the main notification, this index will |
| * apply to that list, otherwise it will apply to the regular actions list. |
| * |
| * @return the action index or {@link #UNSET_ACTION_INDEX} if no action was selected. |
| */ |
| public int getContentAction() { |
| return mContentActionIndex; |
| } |
| |
| /** |
| * Set the gravity that this notification should have within the available viewport space. |
| * Supported values include {@link android.view.Gravity#TOP}, |
| * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}. |
| * The default value is {@link android.view.Gravity#BOTTOM}. |
| */ |
| public WearableExtender setGravity(int gravity) { |
| mGravity = gravity; |
| return this; |
| } |
| |
| /** |
| * Get the gravity that this notification should have within the available viewport space. |
| * Supported values include {@link android.view.Gravity#TOP}, |
| * {@link android.view.Gravity#CENTER_VERTICAL} and {@link android.view.Gravity#BOTTOM}. |
| * The default value is {@link android.view.Gravity#BOTTOM}. |
| */ |
| public int getGravity() { |
| return mGravity; |
| } |
| |
| /** |
| * Set the custom size preset for the display of this notification out of the available |
| * presets found in {@link android.app.Notification.WearableExtender}, e.g. |
| * {@link #SIZE_LARGE}. |
| * <p>Some custom size presets are only applicable for custom display notifications created |
| * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. Check the |
| * documentation for the preset in question. See also |
| * {@link #setCustomContentHeight} and {@link #getCustomSizePreset}. |
| */ |
| public WearableExtender setCustomSizePreset(int sizePreset) { |
| mCustomSizePreset = sizePreset; |
| return this; |
| } |
| |
| /** |
| * Get the custom size preset for the display of this notification out of the available |
| * presets found in {@link android.app.Notification.WearableExtender}, e.g. |
| * {@link #SIZE_LARGE}. |
| * <p>Some custom size presets are only applicable for custom display notifications created |
| * using {@link #setDisplayIntent}. Check the documentation for the preset in question. |
| * See also {@link #setCustomContentHeight} and {@link #setCustomSizePreset}. |
| */ |
| public int getCustomSizePreset() { |
| return mCustomSizePreset; |
| } |
| |
| /** |
| * Set the custom height in pixels for the display of this notification's content. |
| * <p>This option is only available for custom display notifications created |
| * using {@link android.app.Notification.WearableExtender#setDisplayIntent}. See also |
| * {@link android.app.Notification.WearableExtender#setCustomSizePreset} and |
| * {@link #getCustomContentHeight}. |
| */ |
| public WearableExtender setCustomContentHeight(int height) { |
| mCustomContentHeight = height; |
| return this; |
| } |
| |
| /** |
| * Get the custom height in pixels for the display of this notification's content. |
| * <p>This option is only available for custom display notifications created |
| * using {@link #setDisplayIntent}. See also {@link #setCustomSizePreset} and |
| * {@link #setCustomContentHeight}. |
| */ |
| public int getCustomContentHeight() { |
| return mCustomContentHeight; |
| } |
| |
| /** |
| * Set whether the scrolling position for the contents of this notification should start |
| * at the bottom of the contents instead of the top when the contents are too long to |
| * display within the screen. Default is false (start scroll at the top). |
| */ |
| public WearableExtender setStartScrollBottom(boolean startScrollBottom) { |
| setFlag(FLAG_START_SCROLL_BOTTOM, startScrollBottom); |
| return this; |
| } |
| |
| /** |
| * Get whether the scrolling position for the contents of this notification should start |
| * at the bottom of the contents instead of the top when the contents are too long to |
| * display within the screen. Default is false (start scroll at the top). |
| */ |
| public boolean getStartScrollBottom() { |
| return (mFlags & FLAG_START_SCROLL_BOTTOM) != 0; |
| } |
| |
| /** |
| * Set whether the content intent is available when the wearable device is not connected |
| * to a companion device. The user can still trigger this intent when the wearable device |
| * is offline, but a visual hint will indicate that the content intent may not be available. |
| * Defaults to true. |
| */ |
| public WearableExtender setContentIntentAvailableOffline( |
| boolean contentIntentAvailableOffline) { |
| setFlag(FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE, contentIntentAvailableOffline); |
| return this; |
| } |
| |
| /** |
| * Get whether the content intent is available when the wearable device is not connected |
| * to a companion device. The user can still trigger this intent when the wearable device |
| * is offline, but a visual hint will indicate that the content intent may not be available. |
| * Defaults to true. |
| */ |
| public boolean getContentIntentAvailableOffline() { |
| return (mFlags & FLAG_CONTENT_INTENT_AVAILABLE_OFFLINE) != 0; |
| } |
| |
| /** |
| * Set a hint that this notification's icon should not be displayed. |
| * @param hintHideIcon {@code true} to hide the icon, {@code false} otherwise. |
| * @return this object for method chaining |
| */ |
| public WearableExtender setHintHideIcon(boolean hintHideIcon) { |
| setFlag(FLAG_HINT_HIDE_ICON, hintHideIcon); |
| return this; |
| } |
| |
| /** |
| * Get a hint that this notification's icon should not be displayed. |
| * @return {@code true} if this icon should not be displayed, false otherwise. |
| * The default value is {@code false} if this was never set. |
| */ |
| public boolean getHintHideIcon() { |
| return (mFlags & FLAG_HINT_HIDE_ICON) != 0; |
| } |
| |
| /** |
| * Set a visual hint that only the background image of this notification should be |
| * displayed, and other semantic content should be hidden. This hint is only applicable |
| * to sub-pages added using {@link #addPage}. |
| */ |
| public WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly) { |
| setFlag(FLAG_HINT_SHOW_BACKGROUND_ONLY, hintShowBackgroundOnly); |
| return this; |
| } |
| |
| /** |
| * Get a visual hint that only the background image of this notification should be |
| * displayed, and other semantic content should be hidden. This hint is only applicable |
| * to sub-pages added using {@link android.app.Notification.WearableExtender#addPage}. |
| */ |
| public boolean getHintShowBackgroundOnly() { |
| return (mFlags & FLAG_HINT_SHOW_BACKGROUND_ONLY) != 0; |
| } |
| |
| /** |
| * Set a hint that this notification's background should not be clipped if possible, |
| * and should instead be resized to fully display on the screen, retaining the aspect |
| * ratio of the image. This can be useful for images like barcodes or qr codes. |
| * @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible. |
| * @return this object for method chaining |
| */ |
| public WearableExtender setHintAvoidBackgroundClipping( |
| boolean hintAvoidBackgroundClipping) { |
| setFlag(FLAG_HINT_AVOID_BACKGROUND_CLIPPING, hintAvoidBackgroundClipping); |
| return this; |
| } |
| |
| /** |
| * Get a hint that this notification's background should not be clipped if possible, |
| * and should instead be resized to fully display on the screen, retaining the aspect |
| * ratio of the image. This can be useful for images like barcodes or qr codes. |
| * @return {@code true} if it's ok if the background is clipped on the screen, false |
| * otherwise. The default value is {@code false} if this was never set. |
| */ |
| public boolean getHintAvoidBackgroundClipping() { |
| return (mFlags & FLAG_HINT_AVOID_BACKGROUND_CLIPPING) != 0; |
| } |
| |
| /** |
| * Set a hint that the screen should remain on for at least this duration when |
| * this notification is displayed on the screen. |
| * @param timeout The requested screen timeout in milliseconds. Can also be either |
| * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}. |
| * @return this object for method chaining |
| */ |
| public WearableExtender setHintScreenTimeout(int timeout) { |
| mHintScreenTimeout = timeout; |
| return this; |
| } |
| |
| /** |
| * Get the duration, in milliseconds, that the screen should remain on for |
| * when this notification is displayed. |
| * @return the duration in milliseconds if > 0, or either one of the sentinel values |
| * {@link #SCREEN_TIMEOUT_SHORT} or {@link #SCREEN_TIMEOUT_LONG}. |
| */ |
| public int getHintScreenTimeout() { |
| return mHintScreenTimeout; |
| } |
| |
| /** |
| * Set a hint that this notification's {@link BigPictureStyle} (if present) should be |
| * converted to low-bit and displayed in ambient mode, especially useful for barcodes and |
| * qr codes, as well as other simple black-and-white tickets. |
| * @param hintAmbientBigPicture {@code true} to enable converstion and ambient. |
| * @return this object for method chaining |
| */ |
| public WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture) { |
| setFlag(FLAG_BIG_PICTURE_AMBIENT, hintAmbientBigPicture); |
| return this; |
| } |
| |
| /** |
| * Get a hint that this notification's {@link BigPictureStyle} (if present) should be |
| * converted to low-bit and displayed in ambient mode, especially useful for barcodes and |
| * qr codes, as well as other simple black-and-white tickets. |
| * @return {@code true} if it should be displayed in ambient, false otherwise |
| * otherwise. The default value is {@code false} if this was never set. |
| */ |
| public boolean getHintAmbientBigPicture() { |
| return (mFlags & FLAG_BIG_PICTURE_AMBIENT) != 0; |
| } |
| |
| /** |
| * Set a hint that this notification's content intent will launch an {@link Activity} |
| * directly, telling the platform that it can generate the appropriate transitions. |
| * @param hintContentIntentLaunchesActivity {@code true} if the content intent will launch |
| * an activity and transitions should be generated, false otherwise. |
| * @return this object for method chaining |
| */ |
| public WearableExtender setHintContentIntentLaunchesActivity( |
| boolean hintContentIntentLaunchesActivity) { |
| setFlag(FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY, hintContentIntentLaunchesActivity); |
| return this; |
| } |
| |
| /** |
| * Get a hint that this notification's content intent will launch an {@link Activity} |
| * directly, telling the platform that it can generate the appropriate transitions |
| * @return {@code true} if the content intent will launch an activity and transitions should |
| * be generated, false otherwise. The default value is {@code false} if this was never set. |
| */ |
| public boolean getHintContentIntentLaunchesActivity() { |
| return (mFlags & FLAG_HINT_CONTENT_INTENT_LAUNCHES_ACTIVITY) != 0; |
| } |
| |
| /** |
| * When you post a notification, if you set the dismissal id field, then when that |
| * notification is canceled, notifications on other wearables and the paired Android phone |
| * having that same dismissal id will also be canceled. Note that this only works if you |
| * have notification bridge mode set to NO_BRIDGING in your Wear app manifest. See |
| * <a href="{@docRoot}wear/notifications/index.html">Adding Wearable Features to |
| * Notifications</a> for more information on how to use the bridge mode feature. |
| * @param dismissalId the dismissal id of the notification. |
| * @return this object for method chaining |
| */ |
| public WearableExtender setDismissalId(String dismissalId) { |
| mDismissalId = dismissalId; |
| return this; |
| } |
| |
| /** |
| * Returns the dismissal id of the notification. |
| * @return the dismissal id of the notification or null if it has not been set. |
| */ |
| public String getDismissalId() { |
| return mDismissalId; |
| } |
| |
| private void setFlag(int mask, boolean value) { |
| if (value) { |
| mFlags |= mask; |
| } else { |
| mFlags &= ~mask; |
| } |
| } |
| } |
| |
| /** |
| * <p>Helper class to add Android Auto extensions to notifications. To create a notification |
| * with car extensions: |
| * |
| * <ol> |
| * <li>Create an {@link Notification.Builder}, setting any desired |
| * properties. |
| * <li>Create a {@link CarExtender}. |
| * <li>Set car-specific properties using the {@code add} and {@code set} methods of |
| * {@link CarExtender}. |
| * <li>Call {@link Notification.Builder#extend(Notification.Extender)} |
| * to apply the extensions to a notification. |
| * </ol> |
| * |
| * <pre class="prettyprint"> |
| * Notification notification = new Notification.Builder(context) |
| * ... |
| * .extend(new CarExtender() |
| * .set*(...)) |
| * .build(); |
| * </pre> |
| * |
| * <p>Car extensions can be accessed on an existing notification by using the |
| * {@code CarExtender(Notification)} constructor, and then using the {@code get} methods |
| * to access values. |
| */ |
| public static final class CarExtender implements Extender { |
| private static final String TAG = "CarExtender"; |
| |
| private static final String EXTRA_CAR_EXTENDER = "android.car.EXTENSIONS"; |
| private static final String EXTRA_LARGE_ICON = "large_icon"; |
| private static final String EXTRA_CONVERSATION = "car_conversation"; |
| private static final String EXTRA_COLOR = "app_color"; |
| |
| private Bitmap mLargeIcon; |
| private UnreadConversation mUnreadConversation; |
| private int mColor = Notification.COLOR_DEFAULT; |
| |
| /** |
| * Create a {@link CarExtender} with default options. |
| */ |
| public CarExtender() { |
| } |
| |
| /** |
| * Create a {@link CarExtender} from the CarExtender options of an existing Notification. |
| * |
| * @param notif The notification from which to copy options. |
| */ |
| public CarExtender(Notification notif) { |
| Bundle carBundle = notif.extras == null ? |
| null : notif.extras.getBundle(EXTRA_CAR_EXTENDER); |
| if (carBundle != null) { |
| mLargeIcon = carBundle.getParcelable(EXTRA_LARGE_ICON); |
| mColor = carBundle.getInt(EXTRA_COLOR, Notification.COLOR_DEFAULT); |
| |
| Bundle b = carBundle.getBundle(EXTRA_CONVERSATION); |
| mUnreadConversation = UnreadConversation.getUnreadConversationFromBundle(b); |
| } |
| } |
| |
| /** |
| * Apply car extensions to a notification that is being built. This is typically called by |
| * the {@link Notification.Builder#extend(Notification.Extender)} |
| * method of {@link Notification.Builder}. |
| */ |
| @Override |
| public Notification.Builder extend(Notification.Builder builder) { |
| Bundle carExtensions = new Bundle(); |
| |
| if (mLargeIcon != null) { |
| carExtensions.putParcelable(EXTRA_LARGE_ICON, mLargeIcon); |
| } |
| if (mColor != Notification.COLOR_DEFAULT) { |
| carExtensions.putInt(EXTRA_COLOR, mColor); |
| } |
| |
| if (mUnreadConversation != null) { |
| Bundle b = mUnreadConversation.getBundleForUnreadConversation(); |
| carExtensions.putBundle(EXTRA_CONVERSATION, b); |
| } |
| |
| builder.getExtras().putBundle(EXTRA_CAR_EXTENDER, carExtensions); |
| return builder; |
| } |
| |
| /** |
| * Sets the accent color to use when Android Auto presents the notification. |
| * |
| * Android Auto uses the color set with {@link Notification.Builder#setColor(int)} |
| * to accent the displayed notification. However, not all colors are acceptable in an |
| * automotive setting. This method can be used to override the color provided in the |
| * notification in such a situation. |
| */ |
| public CarExtender setColor(@ColorInt int color) { |
| mColor = color; |
| return this; |
| } |
| |
| /** |
| * Gets the accent color. |
| * |
| * @see #setColor |
| */ |
| @ColorInt |
| public int getColor() { |
| return mColor; |
| } |
| |
| /** |
| * Sets the large icon of the car notification. |
| * |
| * If no large icon is set in the extender, Android Auto will display the icon |
| * specified by {@link Notification.Builder#setLargeIcon(android.graphics.Bitmap)} |
| * |
| * @param largeIcon The large icon to use in the car notification. |
| * @return This object for method chaining. |
| */ |
| public CarExtender setLargeIcon(Bitmap largeIcon) { |
| mLargeIcon = largeIcon; |
| return this; |
| } |
| |
| /** |
| * Gets the large icon used in this car notification, or null if no icon has been set. |
| * |
| * @return The large icon for the car notification. |
| * @see CarExtender#setLargeIcon |
| */ |
| public Bitmap getLargeIcon() { |
| return mLargeIcon; |
| } |
| |
| /** |
| * Sets the unread conversation in a message notification. |
| * |
| * @param unreadConversation The unread part of the conversation this notification conveys. |
| * @return This object for method chaining. |
| */ |
| public CarExtender setUnreadConversation(UnreadConversation unreadConversation) { |
| mUnreadConversation = unreadConversation; |
| return this; |
| } |
| |
| /** |
| * Returns the unread conversation conveyed by this notification. |
| * @see #setUnreadConversation(UnreadConversation) |
| */ |
| public UnreadConversation getUnreadConversation() { |
| return mUnreadConversation; |
| } |
| |
| /** |
| * A class which holds the unread messages from a conversation. |
| */ |
| public static class UnreadConversation { |
| private static final String KEY_AUTHOR = "author"; |
| private static final String KEY_TEXT = "text"; |
| private static final String KEY_MESSAGES = "messages"; |
| private static final String KEY_REMOTE_INPUT = "remote_input"; |
| private static final String KEY_ON_REPLY = "on_reply"; |
| private static final String KEY_ON_READ = "on_read"; |
| private static final String KEY_PARTICIPANTS = "participants"; |
| private static final String KEY_TIMESTAMP = "timestamp"; |
| |
| private final String[] mMessages; |
| private final RemoteInput mRemoteInput; |
| private final PendingIntent mReplyPendingIntent; |
| private final PendingIntent mReadPendingIntent; |
| private final String[] mParticipants; |
| private final long mLatestTimestamp; |
| |
| UnreadConversation(String[] messages, RemoteInput remoteInput, |
| PendingIntent replyPendingIntent, PendingIntent readPendingIntent, |
| String[] participants, long latestTimestamp) { |
| mMessages = messages; |
| mRemoteInput = remoteInput; |
| mReadPendingIntent = readPendingIntent; |
| mReplyPendingIntent = replyPendingIntent; |
| mParticipants = participants; |
| mLatestTimestamp = latestTimestamp; |
| } |
| |
| /** |
| * Gets the list of messages conveyed by this notification. |
| */ |
| public String[] getMessages() { |
| return mMessages; |
| } |
| |
| /** |
| * Gets the remote input that will be used to convey the response to a message list, or |
| * null if no such remote input exists. |
| */ |
| public RemoteInput getRemoteInput() { |
| return mRemoteInput; |
| } |
| |
| /** |
| * Gets the pending intent that will be triggered when the user replies to this |
| * notification. |
| */ |
| public PendingIntent getReplyPendingIntent() { |
| return mReplyPendingIntent; |
| } |
| |
| /** |
| * Gets the pending intent that Android Auto will send after it reads aloud all messages |
| * in this object's message list. |
| */ |
| public PendingIntent getReadPendingIntent() { |
| return mReadPendingIntent; |
| } |
| |
| /** |
| * Gets the participants in the conversation. |
| */ |
| public String[] getParticipants() { |
| return mParticipants; |
| } |
| |
| /** |
| * Gets the firs participant in the conversation. |
| */ |
| public String getParticipant() { |
| return mParticipants.length > 0 ? mParticipants[0] : null; |
| } |
| |
| /** |
| * Gets the timestamp of the conversation. |
| */ |
| public long getLatestTimestamp() { |
| return mLatestTimestamp; |
| } |
| |
| Bundle getBundleForUnreadConversation() { |
| Bundle b = new Bundle(); |
| String author = null; |
| if (mParticipants != null && mParticipants.length > 1) { |
| author = mParticipants[0]; |
| } |
| Parcelable[] messages = new Parcelable[mMessages.length]; |
| for (int i = 0; i < messages.length; i++) { |
| Bundle m = new Bundle(); |
| m.putString(KEY_TEXT, mMessages[i]); |
| m.putString(KEY_AUTHOR, author); |
| messages[i] = m; |
| } |
| b.putParcelableArray(KEY_MESSAGES, messages); |
| if (mRemoteInput != null) { |
| b.putParcelable(KEY_REMOTE_INPUT, mRemoteInput); |
| } |
| b.putParcelable(KEY_ON_REPLY, mReplyPendingIntent); |
| b.putParcelable(KEY_ON_READ, mReadPendingIntent); |
| b.putStringArray(KEY_PARTICIPANTS, mParticipants); |
| b.putLong(KEY_TIMESTAMP, mLatestTimestamp); |
| return b; |
| } |
| |
| static UnreadConversation getUnreadConversationFromBundle(Bundle b) { |
| if (b == null) { |
| return null; |
| } |
| Parcelable[] parcelableMessages = b.getParcelableArray(KEY_MESSAGES); |
| String[] messages = null; |
| if (parcelableMessages != null) { |
| String[] tmp = new String[parcelableMessages.length]; |
| boolean success = true; |
| for (int i = 0; i < tmp.length; i++) { |
| if (!(parcelableMessages[i] instanceof Bundle)) { |
| success = false; |
| break; |
| } |
| tmp[i] = ((Bundle) parcelableMessages[i]).getString(KEY_TEXT); |
| if (tmp[i] == null) { |
| success = false; |
| break; |
| } |
| } |
| if (success) { |
| messages = tmp; |
| } else { |
| return null; |
| } |
| } |
| |
| PendingIntent onRead = b.getParcelable(KEY_ON_READ); |
| PendingIntent onReply = b.getParcelable(KEY_ON_REPLY); |
| |
| RemoteInput remoteInput = b.getParcelable(KEY_REMOTE_INPUT); |
| |
| String[] participants = b.getStringArray(KEY_PARTICIPANTS); |
| if (participants == null || participants.length != 1) { |
| return null; |
| } |
| |
| return new UnreadConversation(messages, |
| remoteInput, |
| onReply, |
| onRead, |
| participants, b.getLong(KEY_TIMESTAMP)); |
| } |
| }; |
| |
| /** |
| * Builder class for {@link CarExtender.UnreadConversation} objects. |
| */ |
| public static class Builder { |
| private final List<String> mMessages = new ArrayList<String>(); |
| private final String mParticipant; |
| private RemoteInput mRemoteInput; |
| private PendingIntent mReadPendingIntent; |
| private PendingIntent mReplyPendingIntent; |
| private long mLatestTimestamp; |
| |
| /** |
| * Constructs a new builder for {@link CarExtender.UnreadConversation}. |
| * |
| * @param name The name of the other participant in the conversation. |
| */ |
| public Builder(String name) { |
| mParticipant = name; |
| } |
| |
| /** |
| * Appends a new unread message to the list of messages for this conversation. |
| * |
| * The messages should be added from oldest to newest. |
| * |
| * @param message The text of the new unread message. |
| * @return This object for method chaining. |
| */ |
| public Builder addMessage(String message) { |
| mMessages.add(message); |
| return this; |
| } |
| |
| /** |
| * Sets the pending intent and remote input which will convey the reply to this |
| * notification. |
| * |
| * @param pendingIntent The pending intent which will be triggered on a reply. |
| * @param remoteInput The remote input parcelable which will carry the reply. |
| * @return This object for method chaining. |
| * |
| * @see CarExtender.UnreadConversation#getRemoteInput |
| * @see CarExtender.UnreadConversation#getReplyPendingIntent |
| */ |
| public Builder setReplyAction( |
| PendingIntent pendingIntent, RemoteInput remoteInput) { |
| mRemoteInput = remoteInput; |
| mReplyPendingIntent = pendingIntent; |
| |
| return this; |
| } |
| |
| /** |
| * Sets the pending intent that will be sent once the messages in this notification |
| * are read. |
| * |
| * @param pendingIntent The pending intent to use. |
| * @return This object for method chaining. |
| */ |
| public Builder setReadPendingIntent(PendingIntent pendingIntent) { |
| mReadPendingIntent = pendingIntent; |
| return this; |
| } |
| |
| /** |
| * Sets the timestamp of the most recent message in an unread conversation. |
| * |
| * If a messaging notification has been posted by your application and has not |
| * yet been cancelled, posting a later notification with the same id and tag |
| * but without a newer timestamp may result in Android Auto not displaying a |
| * heads up notification for the later notification. |
| * |
| * @param timestamp The timestamp of the most recent message in the conversation. |
| * @return This object for method chaining. |
| */ |
| public Builder setLatestTimestamp(long timestamp) { |
| mLatestTimestamp = timestamp; |
| return this; |
| } |
| |
| /** |
| * Builds a new unread conversation object. |
| * |
| * @return The new unread conversation object. |
| */ |
| public UnreadConversation build() { |
| String[] messages = mMessages.toArray(new String[mMessages.size()]); |
| String[] participants = { mParticipant }; |
| return new UnreadConversation(messages, mRemoteInput, mReplyPendingIntent, |
| mReadPendingIntent, participants, mLatestTimestamp); |
| } |
| } |
| } |
| |
| /** |
| * Get an array of Notification objects from a parcelable array bundle field. |
| * Update the bundle to have a typed array so fetches in the future don't need |
| * to do an array copy. |
| */ |
| private static Notification[] getNotificationArrayFromBundle(Bundle bundle, String key) { |
| Parcelable[] array = bundle.getParcelableArray(key); |
| if (array instanceof Notification[] || array == null) { |
| return (Notification[]) array; |
| } |
| Notification[] typedArray = Arrays.copyOf(array, array.length, |
| Notification[].class); |
| bundle.putParcelableArray(key, typedArray); |
| return typedArray; |
| } |
| |
| private static class BuilderRemoteViews extends RemoteViews { |
| public BuilderRemoteViews(Parcel parcel) { |
| super(parcel); |
| } |
| |
| public BuilderRemoteViews(ApplicationInfo appInfo, int layoutId) { |
| super(appInfo, layoutId); |
| } |
| |
| @Override |
| public BuilderRemoteViews clone() { |
| Parcel p = Parcel.obtain(); |
| writeToParcel(p, 0); |
| p.setDataPosition(0); |
| BuilderRemoteViews brv = new BuilderRemoteViews(p); |
| p.recycle(); |
| return brv; |
| } |
| } |
| } |