Added docs for isInBackground

TeamNewPipe · Dec 12, 2024 · 0f0d610 · 0f0d610
1 parent 9ebae13
commit 0f0d610
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/app/src/main/java/org/schabi/newpipe/error/AppLifecycleObserver.kt b/app/src/main/java/org/schabi/newpipe/error/AppLifecycleObserver.kt
@@ -31,6 +31,11 @@ object AppLifecycleObserver : DefaultLifecycleObserver {
         Log.d(TAG, "App moved to background: ")
     }
 
+
+    /**
+     * Returns if the app is currently in the background
+     * or in case of a crash the state when the crash happened
+     */
     fun isInBackground(): Boolean {
         return sharedPreferences.getBoolean(KEY_IS_IN_BACKGROUND, true)
     }