ReactAndroid/com.facebook.react.bridge/CatalystInstance

CatalystInstance

interface ~~CatalystInstance~~ : MemoryPressureListener, JSInstance, JSBundleLoaderDelegate

Deprecated

This class is deprecated, please to migrate to new architecture using [com.facebook.react.defaults.DefaultReactHost] instead.

A higher level API on top of the asynchronous JSC bridge. This provides an environment allowing the invocation of JavaScript methods and lets a set of Java APIs be invocable from JavaScript as well.

Inheritors

CatalystInstanceImpl

BridgelessCatalystInstance

Properties

isDestroyed

abstract val isDestroyed: Boolean

javaScriptContextHolder

abstract val javaScriptContextHolder: JavaScriptContextHolder

Do not use this anymore. Use getRuntimeExecutor instead. Get the C pointer (as a long) to the JavaScriptCore context associated with this instance.

jsCallInvokerHolder

@get:JvmName(name = "getJSCallInvokerHolder")

abstract val jsCallInvokerHolder: CallInvokerHolder

Returns a hybrid object that contains a pointer to a JS CallInvoker, which is used to schedule work on the JS Thread. Required for TurboModuleManager initialization.

nativeMethodCallInvokerHolder

abstract val nativeMethodCallInvokerHolder: NativeMethodCallInvokerHolder

Returns a hybrid object that contains a pointer to a NativeMethodCallInvoker, which is used to schedule work on the NativeModules thread. Required for TurboModuleManager initialization.

nativeModules

abstract val nativeModules: Collection<NativeModule>

reactQueueConfiguration

abstract val reactQueueConfiguration: ReactQueueConfiguration

runtimeExecutor

abstract val runtimeExecutor: RuntimeExecutor?

runtimeScheduler

abstract val runtimeScheduler: RuntimeScheduler?

sourceURL

abstract val sourceURL: String?

Return the source URL of the JS Bundle that was run, or null if no JS bundle has been run yet.

Functions

addBridgeIdleDebugListener

abstract fun addBridgeIdleDebugListener(listener: NotThreadSafeBridgeIdleDebugListener)

Adds a idle listener for this Catalyst instance. The listener will receive notifications whenever the bridge transitions from idle to busy and vice-versa, where the busy state is defined as there being some non-zero number of calls to JS that haven't resolved via a onBatchCompleted call. The listener should be purely passive and not affect application logic.

callFunction

abstract fun callFunction(module: String, method: String, arguments: NativeArray?)

destroy

abstract fun destroy()

Destroys this catalyst instance, waiting for any other threads in ReactQueueConfiguration (besides the UI thread) to finish running. Must be called from the UI thread so that we can fully shut down other threads.

extendNativeModules

abstract fun extendNativeModules(modules: NativeModuleRegistry)

This method permits a CatalystInstance to extend the known Native modules. This provided registry contains only the new modules to load.

getFabricUIManager

abstract fun ~~getFabricUIManager~~(): UIManager?

getJSModule

abstract fun <T : JavaScriptModule> getJSModule(jsInterface: Class<T>): T?

getNativeModule

abstract fun <T : NativeModule> getNativeModule(nativeModuleInterface: Class<T>): T?

abstract fun getNativeModule(moduleName: String): NativeModule?

handleMemoryPressure

abstract fun handleMemoryPressure(level: Int)

Called when the system generates a memory warning.

hasNativeModule

abstract fun <T : NativeModule> hasNativeModule(nativeModuleInterface: Class<T>): Boolean

hasRunJSBundle

abstract fun hasRunJSBundle(): Boolean

initialize

abstract fun initialize()

Initialize all the native modules

invokeCallback

abstract override fun invokeCallback(callbackID: Int, arguments: NativeArrayInterface)

loadScriptFromAssets

abstract fun loadScriptFromAssets(assetManager: AssetManager, assetURL: String, loadSynchronously: Boolean)

Load a JS bundle from Android assets. See JSBundleLoader.createAssetLoader

loadScriptFromFile

abstract fun loadScriptFromFile(fileName: String, sourceURL: String, loadSynchronously: Boolean)

Load a JS bundle from the filesystem. See JSBundleLoader.createFileLoader and JSBundleLoader.createCachedBundleFromNetworkLoader

loadSplitBundleFromFile

abstract fun loadSplitBundleFromFile(fileName: String, sourceURL: String)

Load a split JS bundle from the filesystem. See JSBundleLoader.createCachedSplitBundleFromNetworkLoader.

registerSegment

abstract fun registerSegment(segmentId: Int, path: String)

This method registers the file path of an additional JS segment by its ID.

removeBridgeIdleDebugListener

abstract fun removeBridgeIdleDebugListener(listener: NotThreadSafeBridgeIdleDebugListener)

Removes a NotThreadSafeBridgeIdleDebugListener previously added with .addBridgeIdleDebugListener

runJSBundle

abstract fun runJSBundle()

setFabricUIManager

abstract fun ~~setFabricUIManager~~(fabricUIManager: UIManager)

setGlobalVariable

abstract fun setGlobalVariable(propName: String, jsonValue: String)

setSourceURLs

abstract fun setSourceURLs(deviceURL: String, remoteURL: String)

This API is used in situations where the JS bundle is being executed not on the device, but on a host machine. In that case, we must provide two source URLs for the JS bundle: One to be used on the device, and one to be used on the remote debugging machine.

setTurboModuleRegistry

abstract fun ~~setTurboModuleRegistry~~(turboModuleRegistry: TurboModuleRegistry)