From 7cdacd3c3078457f3f32da1581ea7086f7591929 Mon Sep 17 00:00:00 2001 From: Hall Liu Date: Wed, 30 May 2018 16:11:11 -0700 Subject: [PATCH] Fix MbmsDownloadSession documentation Fix the TODO from forever ago and update the docs for the listener registration methods. Change-Id: I1276d0afe430e1b50c0af1fdfacb12a89ea5aa38 Fixes: 80493663 Test: None, comments only --- .../android/telephony/MbmsDownloadSession.java | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/telephony/java/android/telephony/MbmsDownloadSession.java b/telephony/java/android/telephony/MbmsDownloadSession.java index d9fdd97e0889b..af4d8d7637166 100644 --- a/telephony/java/android/telephony/MbmsDownloadSession.java +++ b/telephony/java/android/telephony/MbmsDownloadSession.java @@ -207,23 +207,25 @@ public class MbmsDownloadSession implements AutoCloseable { public static final int STATUS_UNKNOWN = 0; /** - * Indicates that the file is actively downloading. + * Indicates that the file is actively being downloaded. */ public static final int STATUS_ACTIVELY_DOWNLOADING = 1; /** - * TODO: I don't know... + * Indicates that the file is awaiting the next download or repair operations. When a more + * precise status is known, the status will change to either {@link #STATUS_PENDING_REPAIR} or + * {@link #STATUS_PENDING_DOWNLOAD_WINDOW}. */ public static final int STATUS_PENDING_DOWNLOAD = 2; /** - * Indicates that the file is being repaired after the download being interrupted. + * Indicates that the file is awaiting file repair after the download has ended. */ public static final int STATUS_PENDING_REPAIR = 3; /** * Indicates that the file is waiting to download because its download window has not yet - * started. + * started and is scheduled for a future time. */ public static final int STATUS_PENDING_DOWNLOAD_WINDOW = 4; @@ -609,6 +611,9 @@ public class MbmsDownloadSession implements AutoCloseable { * If the operation encountered an error, the error code will be delivered via * {@link MbmsDownloadSessionCallback#onError}. * + * Repeated calls to this method for the same {@link DownloadRequest} will replace the + * previously registered listener. + * * @param request The {@link DownloadRequest} that you want updates on. * @param executor The {@link Executor} on which calls to {@code listener } should be executed. * @param listener The listener that should be called when the middleware has information to @@ -659,6 +664,9 @@ public class MbmsDownloadSession implements AutoCloseable { * If the operation encountered an error, the error code will be delivered via * {@link MbmsDownloadSessionCallback#onError}. * + * Repeated calls to this method for the same {@link DownloadRequest} will replace the + * previously registered listener. + * * @param request The {@link DownloadRequest} provided during registration * @param listener The listener provided during registration. */