ReactAndroid/com.facebook.react.runtime/ReactHostImpl

ReactHostImpl

open class ReactHostImpl : ReactHost

A ReactHost is an object that manages a single ReactInstance. A ReactHost can be constructed without initializing the ReactInstance, and it will continue to exist after the instance is destroyed. This class ensures safe access to the ReactInstance and the JS runtime; methods that operate on the instance use Bolts Tasks to defer the operation until the instance has been initialized. They also return a Task so the caller can be notified of completion.

See also

<a href="https://github.com/BoltsFramework/Bolts-Android#tasks">Bolts Android</a>

Constructors

constructor(context: Context, delegate: ReactHostDelegate, componentFactory: ComponentFactory, allowPackagerServerAccess: Boolean, useDevSupport: Boolean)

constructor(context: Context, delegate: ReactHostDelegate, componentFactory: ComponentFactory, bgExecutor: Executor, uiExecutor: Executor, allowPackagerServerAccess: Boolean, useDevSupport: Boolean)

constructor(context: Context, delegate: ReactHostDelegate, componentFactory: ComponentFactory, bgExecutor: Executor, uiExecutor: Executor, allowPackagerServerAccess: Boolean, useDevSupport: Boolean, @Nullable devSupportManagerFactory: DevSupportManagerFactory)

Functions

addBeforeDestroyListener

open fun addBeforeDestroyListener(@NonNull onBeforeDestroy: () -> Unit)

addReactInstanceEventListener

open fun addReactInstanceEventListener(listener: ReactInstanceEventListener)

Add a listener to be notified of ReactInstance events.

open fun createSurface(context: Context, moduleName: String, @Nullable initialProps: Bundle): ReactSurface

To be called to create and setup an ReactSurface.

open fun destroy(reason: String, @Nullable ex: Exception): TaskInterface<Void>

open fun destroy(@NonNull reason: String, @Nullable ex: Exception, @NonNull onDestroyFinished: (out Any) -> Unit): TaskInterface<Void>

Entrypoint to destroy the ReactInstance.

getCurrentReactContext

open fun getCurrentReactContext(): ReactContext

Returns current ReactContext which could be nullable if ReactInstance hasn't been created.

getDevSupportManager

open fun getDevSupportManager(): DevSupportManager

DevSupportManager used by this ReactHost

getLifecycleState

open fun getLifecycleState(): LifecycleState

The current LifecycleState for React Host

getMemoryPressureRouter

open fun getMemoryPressureRouter(): MemoryPressureRouter

Routes memory pressure events to interested components

getReactQueueConfiguration

open fun getReactQueueConfiguration(): ReactQueueConfiguration

ReactQueueConfiguration for caller to post jobs in React Native threads

open fun invalidate()

Permanently destroys the ReactHost, including the ReactInstance (if any).

onActivityResult

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

To be called when the host activity receives an activity result.

open fun onBackPressed(): Boolean

To be called when back button is pressed

onConfigurationChanged

open fun onConfigurationChanged(updatedContext: Context)

open fun onHostDestroy()

open fun onHostDestroy(@Nullable activity: Activity)

To be called when the host activity is destroyed.

onHostLeaveHint

open fun onHostLeaveHint(@Nullable activity: Activity)

To be called when the host activity is about to go into the background as the result of user choice.

open fun onHostPause()

open fun onHostPause(@Nullable activity: Activity)

To be called when the host activity is paused.

open fun onHostResume(@Nullable activity: Activity)

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

To be called when the host activity is resumed.

open fun onNewIntent(intent: Intent)

onWindowFocusChange

open fun onWindowFocusChange(hasFocus: Boolean)

open fun reload(reason: String): TaskInterface<Void>

Entrypoint to reload the ReactInstance.

removeBeforeDestroyListener

open fun removeBeforeDestroyListener(@NonNull onBeforeDestroy: () -> Unit)

removeReactInstanceEventListener

open fun removeReactInstanceEventListener(listener: ReactInstanceEventListener)

Remove a listener previously added with addReactInstanceEventListener.

open fun start(): TaskInterface<Void>

This function can be used to initialize the ReactInstance in a background thread before a surface needs to be rendered.