(#) Specify a range of JobScheduler ids !!! WARNING: Specify a range of JobScheduler ids This is a warning. Id : `SpecifyJobSchedulerIdRange` Summary : Specify a range of JobScheduler ids Severity : Warning Category : Correctness Platform : Android Vendor : Android Open Source Project Identifier : androidx.work Feedback : https://issuetracker.google.com/issues/new?component=409906 Min : Lint 8.0 and 8.1 Compiled : Lint 8.7+ Artifact : [androidx.work:work-runtime](androidx_work_work-runtime.md.html) Since : 2.3.4 Affects : Kotlin and Java files Editing : This check runs on the fly in the IDE editor Implementation : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/main/java/androidx/work/lint/SpecifyJobSchedulerIdRangeIssueDetector.kt) Tests : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/test/java/androidx/work/lint/SpecifyJobSchedulerIdRangeIssueDetectorTest.kt) Copyright Year : 2020 When using `JobScheduler` APIs directly, `WorkManager` requires that developers specify a range of `JobScheduler` ids that are safe for `WorkManager` to use so the `id`s do not collide. For more information look at `androidx.work.Configuration.Builder.setJobSchedulerJobIdRange(int, int)`. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text com/example/TestJobService.kt:5:Warning: Specify a valid range of job id's for WorkManager to use. [SpecifyJobSchedulerIdRange] class TestJobService: JobService() -------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is the source file referenced above: `com/example/TestJobService.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package com.example import android.app.job.JobService class TestJobService: JobService() ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/test/java/androidx/work/lint/SpecifyJobSchedulerIdRangeIssueDetectorTest.kt) for the unit tests for this check to see additional scenarios. The above example was automatically extracted from the first unit test found for this lint check, `SpecifyJobSchedulerIdRangeIssueDetector.failWhenUsingCustomJobServiceAndIdsAreNotSpecified`. To report a problem with this extracted sample, visit https://issuetracker.google.com/issues/new?component=409906. (##) Including !!! This is not a built-in check. To include it, add the below dependency to your project. ``` // build.gradle.kts implementation("androidx.work:work-runtime:2.10.1") // build.gradle implementation 'androidx.work:work-runtime:2.10.1' // build.gradle.kts with version catalogs: implementation(libs.work.runtime) # libs.versions.toml [versions] work-runtime = "2.10.1" [libraries] # For clarity and text wrapping purposes the following declaration is # shown split up across lines, but in TOML it needs to be on a single # line (see https://github.com/toml-lang/toml/issues/516) so adjust # when pasting into libs.versions.toml: work-runtime = { module = "androidx.work:work-runtime", version.ref = "work-runtime" } ``` 2.10.1 is the version this documentation was generated from; there may be newer versions available. [Additional details about androidx.work:work-runtime](androidx_work_work-runtime.md.html). (##) Suppressing You can suppress false positives using one of the following mechanisms: * Using a suppression annotation like this on the enclosing element: ```kt // Kotlin @Suppress("SpecifyJobSchedulerIdRange") fun method() { setJobSchedulerJobIdRange(...) } ``` or ```java // Java @SuppressWarnings("SpecifyJobSchedulerIdRange") void method() { setJobSchedulerJobIdRange(...); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection SpecifyJobSchedulerIdRange problematicStatement() ``` * Using a special `lint.xml` file in the source tree which turns off the check in that folder and any sub folder. A simple file might look like this: ```xml <?xml version="1.0" encoding="UTF-8"?> <lint> <issue id="SpecifyJobSchedulerIdRange" severity="ignore" /> </lint> ``` Instead of `ignore` you can also change the severity here, for example from `error` to `warning`. You can find additional documentation on how to filter issues by path, regular expression and so on [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html). * In Gradle projects, using the DSL syntax to configure lint. For example, you can use something like ```gradle lintOptions { disable 'SpecifyJobSchedulerIdRange' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore SpecifyJobSchedulerIdRange ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).