commit 50ced0500177c29c228ce88fb9d08f1fd0829560
author Treehugger Robot <treehugger-gerrit@google.com> Tue Oct 09 21:07:39 2018 +0000
committer Gerrit Code Review <noreply-gerritcodereview@google.com> Tue Oct 09 21:07:39 2018 +0000
tree 45b76d7097eaea1703b6394773f2a7a102b1359a
parent 4ada9db0732fcf320e607502bfb7ffcc8da29892
parent 328453cb26ce32bc715ee3a59c5c36f594bae6ab

Merge "Updated onStartWork Javadoc to reflect user cancellation of future." into androidx-master-dev

work/workmanager/src/main/java/androidx/work/ListenableWorker.java

diff --git a/work/workmanager/src/main/java/androidx/work/ListenableWorker.java b/work/workmanager/src/main/java/androidx/work/ListenableWorker.java
index e8ef01b..b96c596 100644
--- a/work/workmanager/src/main/java/androidx/work/ListenableWorker.java
+++ b/work/workmanager/src/main/java/androidx/work/ListenableWorker.java
@@ -177,7 +177,8 @@
      * Override this method to start your actual background processing. This method is called on
      * the main thread.
      *
-     * @return A {@link ListenableFuture} with the {@link Payload} of the computation
+     * @return A {@link ListenableFuture} with the {@link Payload} of the computation.  If you
+     *         cancel this Future, WorkManager will treat this unit of work as failed.
      */
     @MainThread
     public abstract @NonNull ListenableFuture<Payload> onStartWork();