commit a5184cab7f11480d2528b0d0ea7e1186629f7f31
author Kweku Adams <kwekua@google.com> Thu Nov 12 10:20:19 2020 -0800
committer Kweku Adams <kwekua@google.com> Thu Nov 12 10:23:40 2020 -0800
tree a43090c562ea2d9c855c44ea3957745a449e1a58
parent 4cfdb5cce5f583ca34534f8aa1840b02322048c2

Update JobParameters documentation.

Explicitly call out a situation in which the app could specify a network
constraint but get a null value in JobParameters.getNetwork().
Also add link to JobInfo.Builder.setRequiredNetwork().

Bug: 19536175
Test: N/A
Change-Id: I556e53188c60e61a96f76733c3de0ee541b83503

apex/jobscheduler/framework/java/android/app/job/JobParameters.java

diff --git a/apex/jobscheduler/framework/java/android/app/job/JobParameters.java b/apex/jobscheduler/framework/java/android/app/job/JobParameters.java
index 62c90dfa..e251ff0 100644
--- a/apex/jobscheduler/framework/java/android/app/job/JobParameters.java
+++ b/apex/jobscheduler/framework/java/android/app/job/JobParameters.java
@@ -21,6 +21,7 @@
 import android.compat.annotation.UnsupportedAppUsage;
 import android.content.ClipData;
 import android.net.Network;
+import android.net.NetworkRequest;
 import android.net.Uri;
 import android.os.Bundle;
 import android.os.IBinder;
@@ -242,8 +243,9 @@
      *
      * @return the network that should be used to perform any network requests
      *         for this job, or {@code null} if this job didn't set any required
-     *         network type.
+     *         network type or if the job executed when there was no available network to use.
      * @see JobInfo.Builder#setRequiredNetworkType(int)
+     * @see JobInfo.Builder#setRequiredNetwork(NetworkRequest)
      */
     public @Nullable Network getNetwork() {
         return network;