ReactAndroid/com.facebook.react/ReactInstanceManager

ReactInstanceManager

open class ReactInstanceManager

This class is managing instances of CatalystInstance. It exposes a way to configure catalyst instance using ReactPackage and keeps track of the lifecycle of that instance. It also sets up connection between the instance and developers support functionality of the framework.

An instance of this manager is required to start JS application in ReactRootView (see startReactApplication for more info).

The lifecycle of the instance of ReactInstanceManager should be bound to the activity that owns the ReactRootView that is used to render react application using this instance manager (see startReactApplication). It's required to pass owning activity's lifecycle events to the instance manager (see onHostPause, onHostDestroy and onHostResume).

To instantiate an instance of this class use builder.

Types

ReactInstanceEventListener

interface ~~ReactInstanceEventListener~~ : ReactInstanceEventListener

Listener interface for react instance events.

Functions

addReactInstanceEventListener

open fun addReactInstanceEventListener(listener: ReactInstanceEventListener)

Add a listener to be notified of react instance events.

open fun ~~attachRootView~~(reactRoot: ReactRoot)

Attach given {@param reactRoot} to a catalyst instance manager and start JS application using JS module provided by getJSModuleName.

open fun builder(): ReactInstanceManagerBuilder

Creates a builder that is capable of creating an instance of ReactInstanceManager.

createReactContextInBackground

open fun createReactContextInBackground()

Trigger react context initialization asynchronously in a background async task.

createViewManager

open fun createViewManager(viewManagerName: String): ViewManager

open fun destroy()

Destroy this React instance and the attached JS context.

open fun ~~detachRootView~~(reactRoot: ReactRoot)

Detach given {@param reactRoot} from current catalyst instance.

getCurrentReactContext

open fun getCurrentReactContext(): ReactContext

getDevSupportManager

open fun getDevSupportManager(): DevSupportManager

getJsExecutorName

open fun getJsExecutorName(): String

getLifecycleState

open fun getLifecycleState(): LifecycleState

getMemoryPressureRouter

open fun getMemoryPressureRouter(): MemoryPressureRouter

getOrCreateViewManagers

open fun getOrCreateViewManagers(catalystApplicationContext: ReactApplicationContext): List<ViewManager>

Uses configured ReactPackage instances to create all view managers.

open fun getPackages(): List<ReactPackage>

getViewManagerNames

open fun getViewManagerNames(): Collection<String>

open fun handleCxxError(e: Exception)

hasStartedCreatingInitialContext

open fun hasStartedCreatingInitialContext(): Boolean

open fun invalidate()

Permanently destroys the ReactInstanceManager, including the CatalystInstance (if any).

onActivityResult

open fun onActivityResult(activity: Activity, requestCode: Int, resultCode: Int, @Nullable data: Intent)

open fun onBackPressed()

This method will give JS the opportunity to consume the back button event.

onConfigurationChanged

open fun onConfigurationChanged(updatedContext: Context, @Nullable newConfig: Configuration)

Call this from onConfigurationChanged.

open fun ~~onHostDestroy~~()

open fun onHostDestroy(@Nullable activity: Activity)

Call this from onDestroy.

open fun ~~onHostPause~~()

open fun onHostPause(@Nullable activity: Activity)

Call this from onPause.

open fun onHostResume(@Nullable activity: Activity)

Use this method when the activity resumes.

open fun onHostResume(@Nullable activity: Activity, defaultBackButtonImpl: DefaultHardwareBackBtnHandler)

Use this method when the activity resumes to enable invoking the back button directly from JS.

open fun onNewIntent(intent: Intent)

This method will give JS the opportunity to receive intents via Linking.

onUserLeaveHint

open fun onUserLeaveHint(@Nullable activity: Activity)

This method should be called from onUserLeaveHint.

onWindowFocusChange

open fun onWindowFocusChange(hasFocus: Boolean)

recreateReactContextInBackground

open fun recreateReactContextInBackground()

Recreate the react application and context.

removeReactInstanceEventListener

open fun removeReactInstanceEventListener(listener: ReactInstanceEventListener)

Remove a listener previously added with addReactInstanceEventListener.

setUseFallbackBundle

open fun setUseFallbackBundle(useFallbackBundle: Boolean)

showDevOptionsDialog

open fun showDevOptionsDialog()