ReactAndroid/com.facebook.react.devsupport/BridgeDevSupportManager

BridgeDevSupportManager

class BridgeDevSupportManager : DevSupportManagerBase

Interface for accessing and interacting with development features. Following features are supported through this manager class: 1) Displaying JS errors (aka RedBox) 2) Displaying developers menu (Reload JS, Debug JS) 3) Communication with developer server in order to download updated JS bundle 4) Starting/stopping broadcast receiver for js reload signals 5) Starting/stopping motion sensor listener that recognize shake gestures which in turn may trigger developers menu. 6) Launching developers settings view This class automatically monitors the state of registered views and activities to which they are bound to make sure that we don't display overlay or that we we don't listen for sensor events when app is backgrounded. com.facebook.react.ReactInstanceManager implementation is responsible for instantiating this class as well as for populating with a reference to CatalystInstance whenever instance manager recreates it (through ). Also, instance manager is responsible for enabling/disabling dev support in case when app is backgrounded or when all the views has been detached from the instance (through { } method).

Constructors

constructor(applicationContext: Context, reactInstanceManagerHelper: ReactInstanceDevHelper, @Nullable packagerPathForJSBundleName: String, enableOnCreate: Boolean, @Nullable redBoxHandler: RedBoxHandler, @Nullable devBundleDownloadListener: DevBundleDownloadListener, minNumShakes: Int, @Nullable customPackagerCommandHandlers: Map<String, RequestHandler>, @Nullable surfaceDelegateFactory: SurfaceDelegateFactory, @Nullable devLoadingViewManager: DevLoadingViewManager, @Nullable pausedInDebuggerOverlayManager: PausedInDebuggerOverlayManager)

Functions

addCustomDevOption

open fun addCustomDevOption(optionName: String, optionHandler: DevOptionHandler)

Add option item to dev settings dialog displayed by this manager.

abstract fun addCustomDevOption(optionName: String, optionHandler: DevOptionHandler)

createRootView

@Nullable

open fun createRootView(appKey: String): View

abstract fun createRootView(appKey: String): View

createSurfaceDelegate

@Nullable

open fun createSurfaceDelegate(moduleName: String): SurfaceDelegate

Create the surface delegate that the provided module should use to interact with

abstract fun createSurfaceDelegate(moduleName: String): SurfaceDelegate

Create the surface delegate that the provided module should use to interact with

destroyRootView

open fun destroyRootView(@Nullable rootView: View)

abstract fun destroyRootView(rootView: View)

downloadBundleResourceFromUrlSync

@Nullable

open fun downloadBundleResourceFromUrlSync(resourceURL: String, outputFile: File): File

abstract fun downloadBundleResourceFromUrlSync(resourceURL: String, outputFile: File): File

fetchSplitBundleAndCreateBundleLoader

open fun fetchSplitBundleAndCreateBundleLoader(bundlePath: String, callback: DevSupportManagerBase.CallbackWithBundleLoader)

getCurrentActivity

@Nullable

open fun getCurrentActivity(): Activity

abstract fun getCurrentActivity(): Activity

getCurrentReactContext

@Nullable

open fun getCurrentReactContext(): ReactContext

abstract fun getCurrentReactContext(): ReactContext

getDevLoadingViewManager

open fun getDevLoadingViewManager(): DevLoadingViewManager

getDevServerHelper

open fun getDevServerHelper(): DevServerHelper

getDevSettings

open fun getDevSettings(): DeveloperSettings

abstract fun getDevSettings(): DeveloperSettings

getDevSupportEnabled

open fun getDevSupportEnabled(): Boolean

abstract fun getDevSupportEnabled(): Boolean

getDownloadedJSBundleFile

open fun getDownloadedJSBundleFile(): String

abstract fun getDownloadedJSBundleFile(): String

getJSAppBundleName

@Nullable

open fun getJSAppBundleName(): String

getLastErrorCookie

open fun getLastErrorCookie(): Int

abstract fun getLastErrorCookie(): Int

getLastErrorStack

@Nullable

open fun getLastErrorStack(): Array<StackFrame>

abstract fun getLastErrorStack(): Array<StackFrame>

getLastErrorTitle

@Nullable

open fun getLastErrorTitle(): String

abstract fun getLastErrorTitle(): String

getLastErrorType

@Nullable

open fun getLastErrorType(): ErrorType

abstract fun getLastErrorType(): ErrorType

getReactInstanceDevHelper

open fun getReactInstanceDevHelper(): ReactInstanceDevHelper

getRedBoxHandler

@Nullable

open fun getRedBoxHandler(): RedBoxHandler

abstract fun getRedBoxHandler(): RedBoxHandler

getSourceMapUrl

open fun getSourceMapUrl(): String

abstract fun getSourceMapUrl(): String

getSourceUrl

open fun getSourceUrl(): String

abstract fun getSourceUrl(): String

handleException

abstract fun handleException(e: Exception)

Do something to display or log the exception.

open fun handleException(e: Exception)

Do something to display or log the exception.

handleReloadJS

open fun handleReloadJS()

hasUpToDateJSBundleInCache

open fun hasUpToDateJSBundleInCache(): Boolean

abstract fun hasUpToDateJSBundleInCache(): Boolean

hidePausedInDebuggerOverlay

open fun hidePausedInDebuggerOverlay()

Hides the "paused in debugger" overlay, if currently shown.

abstract fun hidePausedInDebuggerOverlay()

Hides the "paused in debugger" overlay, if currently shown.

hideRedboxDialog

open fun hideRedboxDialog()

abstract fun hideRedboxDialog()

isPackagerRunning

open fun isPackagerRunning(callback: PackagerStatusCallback)

abstract fun isPackagerRunning(callback: PackagerStatusCallback)

loadSplitBundleFromServer

open fun loadSplitBundleFromServer(bundlePath: String, callback: DevSplitBundleCallback)

onNewReactContextCreated

open fun onNewReactContextCreated(reactContext: ReactContext)

abstract fun onNewReactContextCreated(reactContext: ReactContext)

onReactInstanceDestroyed

open fun onReactInstanceDestroyed(reactContext: ReactContext)

abstract fun onReactInstanceDestroyed(reactContext: ReactContext)

openDebugger

open fun openDebugger()

Attempt to open the JS debugger on the host machine.

abstract fun openDebugger()

Attempt to open the JS debugger on the host machine.

processErrorCustomizers

open fun processErrorCustomizers(errorInfo: Pair<String, Array<StackFrame>>): Pair<String, Array<StackFrame>>

abstract fun processErrorCustomizers(errorInfo: Pair<String, Array<StackFrame>>): Pair<String, Array<StackFrame>>

registerErrorCustomizer

open fun registerErrorCustomizer(errorCustomizer: ErrorCustomizer)

abstract fun registerErrorCustomizer(errorCustomizer: ErrorCustomizer)

reloadJSFromServer

open fun reloadJSFromServer(bundleURL: String, callback: BundleLoadCallback)

abstract fun reloadJSFromServer(bundleURL: String, callback: BundleLoadCallback)

reloadSettings

open fun reloadSettings()

abstract fun reloadSettings()

setAdditionalOptionForPackager

open fun setAdditionalOptionForPackager(name: String, value: String)

Add an option to send to packager when requesting JS bundle.

abstract fun setAdditionalOptionForPackager(name: String, value: String)

Add an option to send to packager when requesting JS bundle.

setDevSupportEnabled

open fun setDevSupportEnabled(isDevSupportEnabled: Boolean)

com.facebook.react.ReactInstanceManager is responsible for enabling/disabling dev support when a React view is attached/detached or when application state changes (e.g.

abstract fun setDevSupportEnabled(<set-?>: Boolean)

setFpsDebugEnabled