(#) Scheduling Exact Alarms Without Required Permission !!! ERROR: Scheduling Exact Alarms Without Required Permission This is an error. Id : `ScheduleExactAlarm` Summary : Scheduling Exact Alarms Without Required Permission Severity : Error Category : Correctness Platform : Android Vendor : Android Open Source Project Feedback : https://issuetracker.google.com/issues/new?component=192708 Since : 8.1.0 (July 2023) Affects : Kotlin and Java files and manifest files Editing : This check runs on the fly in the IDE editor See : https://developer.android.com/training/scheduling/alarms#exact Implementation : [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/AlarmDetector.kt) Tests : [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/AlarmDetectorTest.kt) Applications looking to schedule exact alarms should ensure that the `SCHEDULE_EXACT_ALARM` permission is granted by calling the `AlarmManager#canScheduleExactAlarms` API before attempting to set an exact alarm. If the permission is not granted to your application, please consider requesting it from the user by starting the `ACTION_REQUEST_SCHEDULE_EXACT_ALARM` intent or gracefully falling back to another option. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text src/test/pkg/AlarmTest.kt:7:Error: When scheduling exact alarms, apps should explicitly call AlarmManager#canScheduleExactAlarms or handle `SecurityException`s [ScheduleExactAlarm] alarmManager.setExact(AlarmManager.ELAPSED_REALTIME, 5000, null) ---------------------------------------------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here are the relevant source files: `src/AndroidManifest.xml`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers <manifest xmlns:android="http://schemas.android.com/apk/res/android"> <uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM" /> <uses-sdk android:targetSdkVersion="33" /> </manifest> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ `src/test/pkg/AlarmTest.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package test.pkg; import android.app.AlarmManager; @SuppressWarnings("ClassNameDiffersFromFileName") class AlarmTest { fun test(alarmManager: AlarmManager) { alarmManager.setExact(AlarmManager.ELAPSED_REALTIME, 5000, null) try { alarmManager.setExact(AlarmManager.ELAPSED_REALTIME, 5000, null) } catch (e: SecurityException) {} } } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/AlarmDetectorTest.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, `AlarmDetector.testScheduleExactAlarmBasic`. To report a problem with this extracted sample, visit https://issuetracker.google.com/issues/new?component=192708. (##) Suppressing You can suppress false positives using one of the following mechanisms: * Adding the suppression attribute `tools:ignore="ScheduleExactAlarm"` 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"> ... <uses-permission tools:ignore="ScheduleExactAlarm" .../> ... </manifest> ``` * Using a suppression annotation like this on the enclosing element: ```kt // Kotlin @Suppress("ScheduleExactAlarm") fun method() { setRepeating(...) } ``` or ```java // Java @SuppressWarnings("ScheduleExactAlarm") void method() { setRepeating(...); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection ScheduleExactAlarm 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="ScheduleExactAlarm" 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 'ScheduleExactAlarm' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore ScheduleExactAlarm ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).