| /* |
| * 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 com.android.internal.R; |
| |
| import android.content.Context; |
| import android.content.Intent; |
| import android.graphics.Bitmap; |
| import android.net.Uri; |
| import android.os.Parcel; |
| import android.os.Parcelable; |
| import android.text.TextUtils; |
| import android.view.View; |
| import android.widget.RemoteViews; |
| |
| import java.text.NumberFormat; |
| |
| /** |
| * 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> |
| * |
| * <p>For a guide to creating notifications, see the |
| * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Creating Status |
| * Bar Notifications</a> document in the Dev Guide.</p> |
| */ |
| public class Notification implements Parcelable |
| { |
| /** |
| * 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}. |
| * |
| * @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. |
| * |
| * @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; |
| |
| /** |
| * The timestamp for the notification. The icons and expanded views |
| * are sorted by this key. |
| */ |
| public long when; |
| |
| /** |
| * The resource id of a drawable to use as the icon in the status bar. |
| * This is required; notifications with an invalid icon resource will not be shown. |
| */ |
| 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#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. This number is superimposed over |
| * the icon in the status bar. If the number is 0 or negative, it is not shown in the status |
| * bar. |
| */ |
| 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. |
| */ |
| public PendingIntent contentIntent; |
| |
| /** |
| * The intent to execute when the status entry is deleted by the user |
| * with the "Clear All Notifications" button. 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. |
| * |
| * @see Notification.Builder#setFullScreenIntent |
| */ |
| public PendingIntent fullScreenIntent; |
| |
| /** |
| * Text to scroll across the screen when this item is added to |
| * the status bar on large and smaller devices. |
| * |
| * <p>This field is provided separately from the other ticker fields |
| * both for compatibility and to allow an application to choose different |
| * text for when the text scrolls in and when it is displayed all at once |
| * in conjunction with one or more icons. |
| * |
| * @see #tickerView |
| */ |
| public CharSequence tickerText; |
| |
| /** |
| * The view to show as the ticker in the status bar when the notification |
| * is posted. |
| */ |
| public RemoteViews tickerView; |
| |
| /** |
| * The view that will represent this notification in the expanded status bar. |
| */ |
| public RemoteViews contentView; |
| |
| /** |
| * The bitmap that may escape the bounds of the panel and bar. |
| */ |
| public Bitmap largeIcon; |
| |
| /** |
| * The sound to play. |
| * |
| * <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 STREAM_RING. |
| */ |
| 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}. |
| */ |
| public int audioStreamType = STREAM_DEFAULT; |
| |
| |
| /** |
| * The pattern with which to vibrate. |
| * |
| * <p> |
| * To vibrate the default pattern, see {@link #defaults}. |
| * </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 |
| */ |
| 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 want the sound and/or vibration play each time the |
| * notification is sent, even if it has not been canceled before that. |
| */ |
| 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. On tablets, the |
| */ |
| 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; |
| |
| /** |
| * Bit to be bitwise-ored into the {@link #flags} field that should be set if this notification |
| * represents a high-priority event that may be shown to the user even if notifications are |
| * otherwise unavailable (that is, when the status bar is hidden). This flag is ideally used |
| * in conjunction with {@link #fullScreenIntent}. |
| */ |
| public static final int FLAG_HIGH_PRIORITY = 0x00000080; |
| |
| public int flags; |
| |
| /** |
| * Constructs a Notification object with everything set to 0. |
| * You might want to consider using {@link Builder} instead. |
| */ |
| public Notification() |
| { |
| this.when = System.currentTimeMillis(); |
| } |
| |
| /** |
| * @hide |
| */ |
| public Notification(Context context, int icon, CharSequence tickerText, long when, |
| CharSequence contentTitle, CharSequence contentText, Intent contentIntent) |
| { |
| this.when = when; |
| this.icon = icon; |
| this.tickerText = tickerText; |
| setLatestEventInfo(context, contentTitle, contentText, |
| PendingIntent.getActivity(context, 0, contentIntent, 0)); |
| } |
| |
| /** |
| * 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; |
| } |
| |
| /** |
| * Unflatten the notification from a parcel. |
| */ |
| public Notification(Parcel parcel) |
| { |
| int version = parcel.readInt(); |
| |
| when = parcel.readLong(); |
| icon = parcel.readInt(); |
| 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) { |
| largeIcon = Bitmap.CREATOR.createFromParcel(parcel); |
| } |
| defaults = parcel.readInt(); |
| flags = parcel.readInt(); |
| if (parcel.readInt() != 0) { |
| sound = Uri.CREATOR.createFromParcel(parcel); |
| } |
| |
| audioStreamType = parcel.readInt(); |
| vibrate = parcel.createLongArray(); |
| ledARGB = parcel.readInt(); |
| ledOnMS = parcel.readInt(); |
| ledOffMS = parcel.readInt(); |
| iconLevel = parcel.readInt(); |
| |
| if (parcel.readInt() != 0) { |
| fullScreenIntent = PendingIntent.CREATOR.createFromParcel(parcel); |
| } |
| } |
| |
| @Override |
| public Notification clone() { |
| Notification that = new Notification(); |
| |
| that.when = this.when; |
| that.icon = this.icon; |
| 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 (this.tickerView != null) { |
| that.tickerView = this.tickerView.clone(); |
| } |
| if (this.contentView != null) { |
| that.contentView = this.contentView.clone(); |
| } |
| if (this.largeIcon != null) { |
| that.largeIcon = Bitmap.createBitmap(this.largeIcon); |
| } |
| that.iconLevel = this.iconLevel; |
| that.sound = this.sound; // android.net.Uri is immutable |
| that.audioStreamType = this.audioStreamType; |
| |
| 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; |
| |
| return that; |
| } |
| |
| public int describeContents() { |
| return 0; |
| } |
| |
| /** |
| * Flatten this notification from a parcel. |
| */ |
| public void writeToParcel(Parcel parcel, int flags) |
| { |
| parcel.writeInt(1); |
| |
| parcel.writeLong(when); |
| parcel.writeInt(icon); |
| 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 (largeIcon != null) { |
| parcel.writeInt(1); |
| largeIcon.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); |
| 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); |
| } |
| } |
| |
| /** |
| * 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. |
| */ |
| @Deprecated |
| public void setLatestEventInfo(Context context, |
| CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) { |
| RemoteViews contentView = new RemoteViews(context.getPackageName(), |
| R.layout.status_bar_latest_event_content); |
| if (this.icon != 0) { |
| contentView.setImageViewResource(R.id.icon, this.icon); |
| } |
| if (contentTitle != null) { |
| contentView.setTextViewText(R.id.title, contentTitle); |
| } |
| if (contentText != null) { |
| contentView.setTextViewText(R.id.text, contentText); |
| } |
| if (this.when != 0) { |
| contentView.setLong(R.id.time, "setTime", when); |
| } |
| |
| this.contentView = contentView; |
| this.contentIntent = contentIntent; |
| } |
| |
| @Override |
| public String toString() { |
| StringBuilder sb = new StringBuilder(); |
| sb.append("Notification(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.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 if ((this.defaults & DEFAULT_VIBRATE) != 0) { |
| sb.append("default"); |
| } else { |
| sb.append("null"); |
| } |
| sb.append(",sound="); |
| if (this.sound != null) { |
| sb.append(this.sound.toString()); |
| } else if ((this.defaults & DEFAULT_SOUND) != 0) { |
| sb.append("default"); |
| } else { |
| sb.append("null"); |
| } |
| sb.append(",defaults=0x"); |
| sb.append(Integer.toHexString(this.defaults)); |
| sb.append(",flags=0x"); |
| sb.append(Integer.toHexString(this.flags)); |
| if ((this.flags & FLAG_HIGH_PRIORITY) != 0) { |
| sb.append("!!!1!one!"); |
| } |
| sb.append(")"); |
| return sb.toString(); |
| } |
| |
| /** |
| * Builder class for {@link Notification} objects. Allows easier control over |
| * all the flags, as well as help constructing the typical notification layouts. |
| */ |
| public static class Builder { |
| private Context mContext; |
| |
| private long mWhen; |
| private int mSmallIcon; |
| private int mSmallIconLevel; |
| private int mNumber; |
| private CharSequence mContentTitle; |
| private CharSequence mContentText; |
| private CharSequence mContentInfo; |
| private PendingIntent mContentIntent; |
| private RemoteViews mContentView; |
| private PendingIntent mDeleteIntent; |
| private PendingIntent mFullScreenIntent; |
| private CharSequence mTickerText; |
| private RemoteViews mTickerView; |
| private Bitmap mLargeIcon; |
| private Uri mSound; |
| private int mAudioStreamType; |
| private long[] mVibrate; |
| private int mLedArgb; |
| private int mLedOnMs; |
| private int mLedOffMs; |
| private int mDefaults; |
| private int mFlags; |
| |
| /** |
| * Constructor. |
| * |
| * Automatically sets the when field to {@link System#currentTimeMillis() |
| * System.currentTimeMllis()} and the audio stream to the {@link #STREAM_DEFAULT}. |
| * |
| * @param context A {@link Context} that will be used to construct the |
| * RemoteViews. The Context will not be held past the lifetime of this |
| * Builder object. |
| */ |
| public Builder(Context context) { |
| mContext = context; |
| |
| // Set defaults to match the defaults of a Notification |
| mWhen = System.currentTimeMillis(); |
| mAudioStreamType = STREAM_DEFAULT; |
| } |
| |
| /** |
| * Set the time that the event occurred. Notifications in the panel are |
| * sorted by this time. |
| */ |
| public Builder setWhen(long when) { |
| mWhen = when; |
| return this; |
| } |
| |
| /** |
| * Set the small icon to use in the notification layouts. Different classes of devices |
| * may return different sizes. See the UX guidelines for more information on how to |
| * design these icons. |
| * |
| * @param icon A resource ID in the application's package of the drawble to use. |
| */ |
| public Builder setSmallIcon(int icon) { |
| mSmallIcon = icon; |
| return this; |
| } |
| |
| /** |
| * 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 drawble to use. |
| * @param level The level to use for the icon. |
| * |
| * @see android.graphics.drawable.LevelListDrawable |
| */ |
| public Builder setSmallIcon(int icon, int level) { |
| mSmallIcon = icon; |
| mSmallIconLevel = level; |
| return this; |
| } |
| |
| /** |
| * Set the title (first row) of the notification, in a standard notification. |
| */ |
| public Builder setContentTitle(CharSequence title) { |
| mContentTitle = title; |
| return this; |
| } |
| |
| /** |
| * Set the text (second row) of the notification, in a standard notification. |
| */ |
| public Builder setContentText(CharSequence text) { |
| mContentText = text; |
| 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. |
| */ |
| public Builder setNumber(int number) { |
| mNumber = number; |
| return this; |
| } |
| |
| /** |
| * Set the large text at the right-hand side of the notification. |
| */ |
| public Builder setContentInfo(CharSequence info) { |
| mContentInfo = info; |
| return this; |
| } |
| |
| /** |
| * Supply a custom RemoteViews to use instead of the standard one. |
| */ |
| public Builder setContent(RemoteViews views) { |
| mContentView = views; |
| return this; |
| } |
| |
| /** |
| * Supply a {@link PendingIntent} to send when the notification is clicked. |
| * If you do not supply an intent, you can now add PendingIntents to individual |
| * views to be launched when clicked by calling {@link RemoteViews#setOnClickPendingIntent |
| * RemoteViews.setOnClickPendingIntent(int,PendingIntent)}. |
| */ |
| public Builder setContentIntent(PendingIntent intent) { |
| mContentIntent = intent; |
| return this; |
| } |
| |
| /** |
| * Supply a {@link PendingIntent} to send when the notification is cleared by the user |
| * directly from the notification panel. For example, this intent is sent when the user |
| * clicks the "Clear all" button, or the individual "X" buttons on notifications. This |
| * intent is not sent when the application calls {@link NotificationManager#cancel |
| * NotificationManager.cancel(int)}. |
| */ |
| public Builder setDeleteIntent(PendingIntent intent) { |
| mDeleteIntent = 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. |
| * |
| * @param intent The pending intent to launch. |
| * @param highPriority Passing true will cause this notification to be sent |
| * even if other notifications are suppressed. |
| */ |
| public Builder setFullScreenIntent(PendingIntent intent, boolean highPriority) { |
| mFullScreenIntent = intent; |
| setFlag(FLAG_HIGH_PRIORITY, highPriority); |
| return this; |
| } |
| |
| /** |
| * Set the text that is displayed in the status bar when the notification first |
| * arrives. |
| */ |
| public Builder setTicker(CharSequence tickerText) { |
| mTickerText = tickerText; |
| return this; |
| } |
| |
| /** |
| * Set the text that is displayed in the status bar when the notification first |
| * arrives, and also a RemoteViews object that may be displayed instead on some |
| * devices. |
| */ |
| public Builder setTicker(CharSequence tickerText, RemoteViews views) { |
| mTickerText = tickerText; |
| mTickerView = views; |
| return this; |
| } |
| |
| /** |
| * Set the large icon that is shown in the ticker and notification. |
| */ |
| public Builder setLargeIcon(Bitmap icon) { |
| mLargeIcon = icon; |
| return this; |
| } |
| |
| /** |
| * Set the sound to play. It will play on the default stream. |
| */ |
| public Builder setSound(Uri sound) { |
| mSound = sound; |
| mAudioStreamType = STREAM_DEFAULT; |
| return this; |
| } |
| |
| /** |
| * Set the sound to play. It will play on the stream you supply. |
| * |
| * @see #STREAM_DEFAULT |
| * @see AudioManager for the <code>STREAM_</code> constants. |
| */ |
| public Builder setSound(Uri sound, int streamType) { |
| mSound = sound; |
| mAudioStreamType = streamType; |
| return this; |
| } |
| |
| /** |
| * Set the vibration pattern to use. |
| * |
| * @see android.os.Vibrator for a discussion of the <code>pattern</code> |
| * parameter. |
| */ |
| public Builder setVibrate(long[] pattern) { |
| mVibrate = pattern; |
| return this; |
| } |
| |
| /** |
| * Set the argb value that you would like the LED on the device to blnk, as well as the |
| * rate. The rate is specified in terms of the number of milliseconds to be on |
| * and then the number of milliseconds to be off. |
| */ |
| public Builder setLights(int argb, int onMs, int offMs) { |
| mLedArgb = argb; |
| mLedOnMs = onMs; |
| mLedOffMs = offMs; |
| return this; |
| } |
| |
| /** |
| * Set whether this is an ongoing notification. |
| * |
| * <p>Ongoing notifications differ from regular notifications in the following ways: |
| * <ul> |
| * <li>Ongoing notifications are sorted above the regular notifications in the |
| * notification panel.</li> |
| * <li>Ongoing notifications do not have an 'X' close button, and are not affected |
| * by the "Clear all" button. |
| * </ul> |
| */ |
| 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. |
| */ |
| public Builder setOnlyAlertOnce(boolean onlyAlertOnce) { |
| setFlag(FLAG_ONLY_ALERT_ONCE, onlyAlertOnce); |
| return this; |
| } |
| |
| /** |
| * Setting this flag will make it so the notification is automatically |
| * canceled when the user clicks it in the panel. The PendingIntent |
| * set with {@link #setDeleteIntent} will be broadcast when the notification |
| * is canceled. |
| */ |
| public Builder setAutoCancel(boolean autoCancel) { |
| setFlag(FLAG_AUTO_CANCEL, autoCancel); |
| return this; |
| } |
| |
| /** |
| * Set the default notification options that will be used. |
| * <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) { |
| mDefaults = defaults; |
| return this; |
| } |
| |
| private void setFlag(int mask, boolean value) { |
| if (value) { |
| mFlags |= mask; |
| } else { |
| mFlags &= ~mask; |
| } |
| } |
| |
| private RemoteViews makeRemoteViews(int resId) { |
| RemoteViews contentView = new RemoteViews(mContext.getPackageName(), resId); |
| if (mSmallIcon != 0) { |
| contentView.setImageViewResource(R.id.icon, mSmallIcon); |
| } |
| if (mContentTitle != null) { |
| contentView.setTextViewText(R.id.title, mContentTitle); |
| } |
| if (mContentText != null) { |
| contentView.setTextViewText(R.id.text, mContentText); |
| } |
| if (mContentInfo != null) { |
| contentView.setTextViewText(R.id.info, mContentInfo); |
| } else if (mNumber > 0) { |
| if (mNumber > 999) { |
| contentView.setTextViewText(R.id.info, "999+"); |
| } else { |
| NumberFormat f = NumberFormat.getIntegerInstance(); |
| contentView.setTextViewText(R.id.info, f.format(mNumber)); |
| } |
| contentView.setFloat(R.id.info, "setTextSize", |
| mContext.getResources().getDimensionPixelSize( |
| R.dimen.status_bar_content_number_size)); |
| } else { |
| contentView.setViewVisibility(R.id.info, View.GONE); |
| } |
| if (mWhen != 0) { |
| contentView.setLong(R.id.time, "setTime", mWhen); |
| } |
| return contentView; |
| } |
| |
| private RemoteViews makeContentView() { |
| if (mContentView != null) { |
| return mContentView; |
| } else { |
| return makeRemoteViews(mLargeIcon == null |
| ? R.layout.status_bar_latest_event_content |
| : R.layout.status_bar_latest_event_content_large_icon); |
| } |
| } |
| |
| private RemoteViews makeTickerView() { |
| if (mTickerView != null) { |
| return mTickerView; |
| } else { |
| if (mContentView == null) { |
| return makeRemoteViews(mLargeIcon == null |
| ? R.layout.status_bar_latest_event_ticker |
| : R.layout.status_bar_latest_event_ticker_large_icon); |
| } else { |
| return null; |
| } |
| } |
| } |
| |
| /** |
| * Combine all of the options that have been set and return a new {@link Notification} |
| * object. |
| */ |
| public Notification getNotification() { |
| Notification n = new Notification(); |
| n.when = mWhen; |
| n.icon = mSmallIcon; |
| n.iconLevel = mSmallIconLevel; |
| n.number = mNumber; |
| n.contentView = makeContentView(); |
| n.contentIntent = mContentIntent; |
| n.deleteIntent = mDeleteIntent; |
| n.fullScreenIntent = mFullScreenIntent; |
| n.tickerText = mTickerText; |
| n.tickerView = makeTickerView(); |
| n.largeIcon = mLargeIcon; |
| n.sound = mSound; |
| n.audioStreamType = mAudioStreamType; |
| n.vibrate = mVibrate; |
| n.ledARGB = mLedArgb; |
| n.ledOnMS = mLedOnMs; |
| n.ledOffMS = mLedOffMs; |
| n.defaults = mDefaults; |
| n.flags = mFlags; |
| if (mLedOnMs != 0 && mLedOffMs != 0) { |
| n.flags |= FLAG_SHOW_LIGHTS; |
| } |
| if ((mDefaults & DEFAULT_LIGHTS) != 0) { |
| n.flags |= FLAG_SHOW_LIGHTS; |
| } |
| return n; |
| } |
| } |
| } |