Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b770b86d authored by Kweku Adams's avatar Kweku Adams
Browse files

Update setNotification documentation. 

Clarify what the contents of the notification should be and fix an API
link.

Bug: 19536175
Test: Run `m offline-sdk-docs` and check page at out/target/common/docs/offline-sdk/reference/android/app/job/JobService.html
Change-Id: Ic1471eb28097aff99567b3b9425f173da569f614
parent 0b5e5e38

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

+6 −3
Original line number Diff line number Diff line
@@ -424,11 +424,14 @@ public abstract class JobService extends Service { 
     * 10 seconds after {@link #onStartJob(JobParameters)} is called,

     * the system will trigger an ANR and stop this job.

     *

     * The notification must provide an accurate description of the work that the job is doing

     * and, if possible, the state of the work.

     *

     * <p>

     * Note that certain types of jobs

     * (e.g. {@link JobInfo.Builder#setDataTransfer data transfer jobs}) may require the

     * notification to have certain characteristics and their documentation will state

     * any such requirements.

     * (e.g. {@link JobInfo.Builder#setEstimatedNetworkBytes(long, long) data transfer jobs})

     * may require the notification to have certain characteristics

     * and their documentation will state any such requirements.

     *

     * <p>

     * JobScheduler will not remember this notification after the job has finished running,