(#) Specify foreground service type !!! ERROR: Specify foreground service type This is an error, and is also enforced at build time when supported by the build system. For Android this means it will run during release builds. Id : `SpecifyForegroundServiceType` Summary : Specify foreground service type Severity : Fatal 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.1 Affects : Kotlin and Java files and manifest files Editing : This check can *not* run live 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/SpecifyForegroundServiceTypeIssueDetector.kt) Tests : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/test/java/androidx/work/lint/SpecifyForegroundServiceTypeIssueDetectorTest.kt) Copyright Year : 2020 When using the setForegroundAsync() API, the application must override entry for `SystemForegroundService` to include the foreground service type in the `AndroidManifest.xml` file. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text com/example/App.kt:9:Error: Missing dataSync foregroundServiceType in the AndroidManifest.xml [SpecifyForegroundServiceType] val info = ForegroundInfo(0, notification, 1) ---------------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is the source file referenced above: `com/example/App.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package com.example import android.app.Notification import androidx.work.ForegroundInfo class App { fun onCreate() { val notification = Notification() val info = ForegroundInfo(0, notification, 1) } } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 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/SpecifyForegroundServiceTypeIssueDetectorTest.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, `SpecifyForegroundServiceTypeIssueDetector.failWhenServiceTypeIsNotSpecified`. 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("SpecifyForegroundServiceType") fun method() { ForegroundInfo(...) } ``` or ```java // Java @SuppressWarnings("SpecifyForegroundServiceType") void method() { new ForegroundInfo(...); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection SpecifyForegroundServiceType problematicStatement() ``` * Adding the suppression attribute `tools:ignore="SpecifyForegroundServiceType"` on the problematic XML element (or one of its enclosing elements). You may also need to add the following namespace declaration on the root element in the XML file if it's not already there: `xmlns:tools="http://schemas.android.com/tools"`. ```xml <?xml version="1.0" encoding="UTF-8"?> <manifest xmlns:tools="http://schemas.android.com/tools"> ... <service tools:ignore="SpecifyForegroundServiceType" .../> ... </manifest> ``` * 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="SpecifyForegroundServiceType" 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 'SpecifyForegroundServiceType' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore SpecifyForegroundServiceType ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).