| java.lang.Object | |
| ↳ | android.app.Notification.Builder |
Builder class for Notification objects. Allows easier control over
all the flags, as well as help constructing the typical notification layouts.
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Combine all of the options that have been set and return a new
Notification
object. | |||||||||||
Setting this flag will make it so the notification is automatically
canceled when the user clicks it in the panel.
| |||||||||||
Supply a custom RemoteViews to use instead of the standard one.
| |||||||||||
Set the large text at the right-hand side of the notification.
| |||||||||||
Supply a
PendingIntent to send when the notification is clicked. | |||||||||||
Set the text (second row) of the notification, in a standard notification.
| |||||||||||
Set the title (first row) of the notification, in a standard notification.
| |||||||||||
Set the default notification options that will be used.
| |||||||||||
Supply a
PendingIntent to send when the notification is cleared by the user
directly from the notification panel. | |||||||||||
An intent to launch instead of posting the notification to the status bar.
| |||||||||||
Set the large icon that is shown in the ticker and notification.
| |||||||||||
Set the argb value that you would like the LED on the device to blnk, as well as the
rate.
| |||||||||||
Set the large number at the right-hand side of the notification.
| |||||||||||
Set whether this is an ongoing notification.
| |||||||||||
Set this flag if you would only like the sound, vibrate
and ticker to be played if the notification is not already showing.
| |||||||||||
Set the progress this notification represents, which may be
represented as a
ProgressBar. | |||||||||||
A variant of
setSmallIcon(int) that takes an additional
level parameter for when the icon is a LevelListDrawable. | |||||||||||
Set the small icon to use in the notification layouts.
| |||||||||||
Set the sound to play.
| |||||||||||
Set the sound to play.
| |||||||||||
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.
| |||||||||||
Set the text that is displayed in the status bar when the notification first
arrives.
| |||||||||||
Set the vibration pattern to use.
| |||||||||||
Set the time that the event occurred.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constructor.
Automatically sets the when field to System.currentTimeMllis() and the audio stream to the STREAM_DEFAULT.
| context | A Context that will be used to construct the
RemoteViews. The Context will not be held past the lifetime of this
Builder object.
|
|---|
Combine all of the options that have been set and return a new Notification
object.
Setting this flag will make it so the notification is automatically
canceled when the user clicks it in the panel. The PendingIntent
set with setDeleteIntent(PendingIntent) will be broadcast when the notification
is canceled.
Supply a custom RemoteViews to use instead of the standard one.
Set the large text at the right-hand side of the notification.
Supply a 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 RemoteViews.setOnClickPendingIntent(int,PendingIntent).
Set the text (second row) of the notification, in a standard notification.
Set the title (first row) of the notification, in a standard notification.
Set the default notification options that will be used.
The value should be one or more of the following fields combined with
bitwise-or:
DEFAULT_SOUND, DEFAULT_VIBRATE, DEFAULT_LIGHTS.
For all default values, use DEFAULT_ALL.
Supply a 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 NotificationManager.cancel(int).
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 immediate 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.
| intent | The pending intent to launch. |
|---|---|
| highPriority | Passing true will cause this notification to be sent even if other notifications are suppressed. |
Set the large icon that is shown in the ticker and notification.
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.
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.
Set whether this is an ongoing notification.
Ongoing notifications differ from regular notifications in the following ways:
Set this flag if you would only like the sound, vibrate and ticker to be played if the notification is not already showing.
Set the progress this notification represents, which may be
represented as a ProgressBar.
A variant of setSmallIcon(int) that takes an additional
level parameter for when the icon is a LevelListDrawable.
| icon | A resource ID in the application's package of the drawble to use. |
|---|---|
| level | The level to use for the icon. |
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.
| icon | A resource ID in the application's package of the drawble to use. |
|---|
Set the sound to play. It will play on the default stream.
Set the sound to play. It will play on the stream you supply.
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.
Set the text that is displayed in the status bar when the notification first arrives.
Set the vibration pattern to use.
Set the time that the event occurred. Notifications in the panel are sorted by this time.
