Class Overview
Class to notify the user of events that happen. This is how you tell
the user that something has happened in the background.
Notifications can take different forms:
- A persistent icon that goes in the status bar and is accessible
through the launcher, (when the user selects it, a designated Intent
can be launched),
- Turning on or flashing LEDs on the device, or
- Alerting the user by flashing the backlight, playing a sound,
or vibrating.
Each of the notify methods takes an int id parameter. This id identifies
this notification from your app to the system, so that id should be unique
within your app. If you call one of the notify methods with an id that is
currently active and a new set of notification parameters, it will be
updated. For example, if you pass a new status bar icon, the old icon in
the status bar will be replaced with the new one. This is also the same
id you pass to the cancel(int) method to clear this notification.
You do not instantiate this class directly; instead, retrieve it through
getSystemService(String).
Summary
Public Methods |
void
|
cancel(int id)
Cancel a previously shown notification.
|
void
|
cancelAll()
Cancel all previously shown notifications.
|
void
|
notify(int id, Notification notification)
Persistent notification on the status bar,
|
[Expand]
Inherited Methods |
From class java.lang.Object
Object
|
clone()
Creates and returns a copy of this Object .
|
boolean
|
equals(Object o)
Compares this instance with the specified object and indicates if they
are equal.
|
void
|
finalize()
Is called before the object's memory is being reclaimed by the VM.
|
final
Class<? extends Object>
|
getClass()
Returns the unique instance of Class which represents this
object's class.
|
int
|
hashCode()
Returns an integer hash code for this object.
|
final
void
|
notify()
Causes a thread which is waiting on this object's monitor (by means of
calling one of the wait() methods) to be woken up.
|
final
void
|
notifyAll()
Causes all threads which are waiting on this object's monitor (by means
of calling one of the wait() methods) to be woken up.
|
String
|
toString()
Returns a string containing a concise, human-readable description of this
object.
|
final
void
|
wait(long millis, int nanos)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
final
void
|
wait(long millis)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
final
void
|
wait()
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.
|
|
Public Methods
public
void
cancel
(int id)
Cancel a previously shown notification. If it's transient, the view
will be hidden. If it's persistent, it will be removed from the status
bar.
public
void
cancelAll
()
Cancel all previously shown notifications. See cancel(int) for the
detailed behavior.
public
void
notify
(int id, Notification notification)
Persistent notification on the status bar,
Parameters
id
| An identifier for this notification unique within your
application. |
notification
| A Notification object describing how to
notify the user, other than the view you're providing. Must not be null.
|