am 751b4731: Merge "A few additions to the download manager public API documentation" into gingerbread

Merge commit '751b47313886264e1229ab67184c9771424be402' into gingerbread-plus-aosp

* commit '751b47313886264e1229ab67184c9771424be402':
  A few additions to the download manager public API documentation
This commit is contained in:
Steve Howard
2010-10-01 13:16:17 -07:00
committed by Android Git Automerger

View File

@@ -47,6 +47,10 @@ import java.util.Set;
* Instances of this class should be obtained through * Instances of this class should be obtained through
* {@link android.content.Context#getSystemService(String)} by passing * {@link android.content.Context#getSystemService(String)} by passing
* {@link android.content.Context#DOWNLOAD_SERVICE}. * {@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 { public class DownloadManager {
/** /**
@@ -239,8 +243,8 @@ public class DownloadManager {
public final static String ACTION_DOWNLOAD_COMPLETE = "android.intent.action.DOWNLOAD_COMPLETE"; 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 * Broadcast intent action sent by the download manager when the user clicks on a running
* clicked. * download, either from a system notification or from the downloads UI.
*/ */
public final static String ACTION_NOTIFICATION_CLICKED = public final static String ACTION_NOTIFICATION_CLICKED =
"android.intent.action.DOWNLOAD_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 * @return this object
*/ */
public Request setTitle(CharSequence title) { public Request setTitle(CharSequence title) {