Add documentation to ActivityTracker initialisation

Summary: ^

Reviewed By: LukeDefeo

Differential Revision: D39652590

fbshipit-source-id: e97a365f56dbecaaebf3a54a1325ad6b65839660
This commit is contained in:
Lorenzo Blasa
2022-09-21 13:28:17 -07:00
committed by Facebook GitHub Bot
parent cae15276f5
commit 060f8911b1

View File

@@ -101,6 +101,14 @@ object ActivityTracker : Application.ActivityLifecycleCallbacks {
return stack return stack
} }
/**
* Activity tracker is used to track activities. However, it cannot track via life-cycle events
* all those activities that were created prior to initialisation via the `start(application:
* Application)` method.
*
* As such, the method below makes a 'best effort' to find these untracked activities and add them
* to the tracked list.
*/
@SuppressLint("PrivateApi", "DiscouragedPrivateApi") @SuppressLint("PrivateApi", "DiscouragedPrivateApi")
fun initialiseActivities() { fun initialiseActivities() {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.KITKAT) { if (Build.VERSION.SDK_INT < Build.VERSION_CODES.KITKAT) {