(#) Do not call onBackPressed() within OnBackPressedDisptacher !!! WARNING: Do not call onBackPressed() within OnBackPressedDisptacher This is a warning. Id : `InvalidUseOfOnBackPressed` Summary : Do not call onBackPressed() within OnBackPressedDisptacher Severity : Warning Category : Correctness Platform : Any Vendor : Android Open Source Project Identifier : androidx.activity Feedback : https://issuetracker.google.com/issues/new?component=527362 Min : Lint 8.0 and 8.1 Compiled : Lint 8.0 and 8.1 Artifact : [androidx.activity:activity](androidx_activity_activity.md.html) Since : 1.9.0 Affects : Kotlin and Java files Editing : This check runs on the fly in the IDE editor See : https://developer.android.com/guide/navigation/custom-back/predictive-back-gesture#ui-logic Implementation : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/activity/activity-lint/src/main/java/androidx/activity/lint/OnBackPressedDetector.kt) Tests : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/activity/activity-lint/src/test/java/androidx/activity/lint/OnBackPressedDispatcherTest.kt) Copyright Year : 2024 You should not used OnBackPressedCallback for non-UI cases. If you |add a callback, you have to handle back completely in the callback. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text src/com/example/test.kt:12:Warning: Should not call onBackPressed inside of OnBackPressedCallback.handledOnBackPressed [InvalidUseOfOnBackPressed] activity.onBackPressed() ------------------------ src/com/example/test.kt:14:Warning: Should not call onBackPressed inside of OnBackPressedCallback.handledOnBackPressed [InvalidUseOfOnBackPressed] dispatcher.onBackPressed() -------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is the source file referenced above: `src/com/example/test.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package com.example import androidx.activity.ComponentActivity import androidx.activity.OnBackPressedCallback import androidx.activity.OnBackPressedDispatcher fun test() { object: OnBackPressedCallback { override fun handledOnBackPressed() { val activity = ComponentActivity() activity.onBackPressed() val dispatcher = OnBackPressedDispatcher() dispatcher.onBackPressed() } } } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/activity/activity-lint/src/test/java/androidx/activity/lint/OnBackPressedDispatcherTest.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, `OnBackPressedDetector.expectFailOnBackPressed`. To report a problem with this extracted sample, visit https://issuetracker.google.com/issues/new?component=527362. (##) Including !!! This is not a built-in check. To include it, add the below dependency to your project. ``` // build.gradle.kts implementation("androidx.activity:activity:1.10.0-rc01") // build.gradle implementation 'androidx.activity:activity:1.10.0-rc01' // build.gradle.kts with version catalogs: implementation(libs.activity) # libs.versions.toml [versions] activity = "1.10.0-rc01" [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: activity = { module = "androidx.activity:activity", version.ref = "activity" } ``` 1.10.0-rc01 is the version this documentation was generated from; there may be newer versions available. [Additional details about androidx.activity:activity](androidx_activity_activity.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("InvalidUseOfOnBackPressed") fun method() { onBackPressed(...) } ``` or ```java // Java @SuppressWarnings("InvalidUseOfOnBackPressed") void method() { onBackPressed(...); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection InvalidUseOfOnBackPressed 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="InvalidUseOfOnBackPressed" 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 'InvalidUseOfOnBackPressed' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore InvalidUseOfOnBackPressed ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).