summaryrefslogtreecommitdiffstats
path: root/core
diff options
context:
space:
mode:
authorSteve Howard <showard@google.com>2010-09-30 18:30:04 -0700
committerSteve Howard <showard@google.com>2010-09-30 18:30:04 -0700
commit610c4359e48a93f029376f5fa48d393ca8a50847 (patch)
tree4a2a8ffb6aa89da50e94b2e76962fb108a217ed2 /core
parent4ba2817c869d4ec6b518a57ea32cc3765b18b0db (diff)
downloadframeworks_base-610c4359e48a93f029376f5fa48d393ca8a50847.zip
frameworks_base-610c4359e48a93f029376f5fa48d393ca8a50847.tar.gz
frameworks_base-610c4359e48a93f029376f5fa48d393ca8a50847.tar.bz2
A few additions to the download manager public API documentation
Change-Id: Icf831843e281d8eee9c1457273662121bb5a8609
Diffstat (limited to 'core')
-rw-r--r--core/java/android/app/DownloadManager.java12
1 files changed, 9 insertions, 3 deletions
diff --git a/core/java/android/app/DownloadManager.java b/core/java/android/app/DownloadManager.java
index 9d559d4..c476b8f 100644
--- a/core/java/android/app/DownloadManager.java
+++ b/core/java/android/app/DownloadManager.java
@@ -47,6 +47,10 @@ import java.util.Set;
* Instances of this class should be obtained through
* {@link android.content.Context#getSystemService(String)} by passing
* {@link android.content.Context#DOWNLOAD_SERVICE}.
+ *
+ * Apps that request downloads through this API should register a broadcast receiver for
+ * {@link #ACTION_NOTIFICATION_CLICKED} to appropriately handle when the user clicks on a running
+ * download in a notification or from the downloads UI.
*/
public class DownloadManager {
/**
@@ -239,8 +243,8 @@ public class DownloadManager {
public final static String ACTION_DOWNLOAD_COMPLETE = "android.intent.action.DOWNLOAD_COMPLETE";
/**
- * Broadcast intent action sent by the download manager when a running download notification is
- * clicked.
+ * Broadcast intent action sent by the download manager when the user clicks on a running
+ * download, either from a system notification or from the downloads UI.
*/
public final static String ACTION_NOTIFICATION_CLICKED =
"android.intent.action.DOWNLOAD_NOTIFICATION_CLICKED";
@@ -413,7 +417,9 @@ public class DownloadManager {
}
/**
- * Set the title of this download, to be displayed in notifications (if enabled)
+ * Set the title of this download, to be displayed in notifications (if enabled). If no
+ * title is given, a default one will be assigned based on the download filename, once the
+ * download starts.
* @return this object
*/
public Request setTitle(CharSequence title) {