com.facebook.react.devsupport

Class DevSupportManager

java.lang.Object

com.facebook.react.devsupport.DevSupportManager

All Implemented Interfaces:

NativeModuleCallExceptionHandler

public class DevSupportManager
extends java.lang.Object
implements NativeModuleCallExceptionHandler

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. ReactInstanceDevCommandsHandler implementation is responsible for instantiating this instance and for populating with an instance of CatalystInstance whenever instance manager recreates it (through #onNewCatalystContextCreated). 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 setDevSupportEnabled(boolean) method). IMPORTANT: In order for developer support to work correctly it is required that the manifest of your application contain the following entries: <activity android:name="com.facebook.react.devsupport.DevSettingsActivity"/> <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>

Constructor Summary

Constructors

Constructor and Description
DevSupportManager(android.content.Context applicationContext, ReactInstanceDevCommandsHandler reactInstanceCommandsHandler, java.lang.String packagerPathForJSBundleName, boolean enableOnCreate)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCustomDevOption(java.lang.String optionName, DevOptionHandler optionHandler) Add option item to dev settings dialog displayed by this manager.
DeveloperSettings	getDevSettings()
boolean	getDevSupportEnabled()
java.lang.String	getDownloadedJSBundleFile()
java.lang.String	getJSBundleURLForRemoteDebugging()
java.lang.String	getSourceMapUrl()
java.lang.String	getSourceUrl()
void	handleException(java.lang.Exception e) Do something to display or log the exception.
void	handleReloadJS()
boolean	hasBundleInAssets(java.lang.String bundleAssetName)
boolean	hasUpToDateJSBundleInCache()
void	onNewReactContextCreated(ReactContext reactContext)
void	onReactInstanceDestroyed(ReactContext reactContext)
void	setDevSupportEnabled(boolean isDevSupportEnabled) ReactInstanceDevCommandsHandler is responsible for enabling/disabling dev support when a React view is attached/detached or when application state changes (e.g.
void	showDevOptionsDialog()
void	showNewJSError(java.lang.String message, ReadableArray details, int errorCookie)
void	updateJSError(java.lang.String message, ReadableArray details, int errorCookie)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DevSupportManager

public DevSupportManager(android.content.Context applicationContext,
                 ReactInstanceDevCommandsHandler reactInstanceCommandsHandler,
                 @Nullable
                 java.lang.String packagerPathForJSBundleName,
                 boolean enableOnCreate)

Method Detail

handleException

public void handleException(java.lang.Exception e)

Description copied from interface: NativeModuleCallExceptionHandler

Do something to display or log the exception.

Specified by:

handleException in interface NativeModuleCallExceptionHandler

addCustomDevOption

public void addCustomDevOption(java.lang.String optionName,
                      DevOptionHandler optionHandler)

Add option item to dev settings dialog displayed by this manager. In the case user select given option from that dialog, the appropriate handler passed as will be called.

showNewJSError

public void showNewJSError(java.lang.String message,
                  ReadableArray details,
                  int errorCookie)

updateJSError

public void updateJSError(java.lang.String message,
                 ReadableArray details,
                 int errorCookie)

showDevOptionsDialog

public void showDevOptionsDialog()

setDevSupportEnabled

public void setDevSupportEnabled(boolean isDevSupportEnabled)

ReactInstanceDevCommandsHandler is responsible for enabling/disabling dev support when a React view is attached/detached or when application state changes (e.g. the application is backgrounded).

getDevSupportEnabled

public boolean getDevSupportEnabled()

getDevSettings

public DeveloperSettings getDevSettings()

onNewReactContextCreated

public void onNewReactContextCreated(ReactContext reactContext)

onReactInstanceDestroyed

public void onReactInstanceDestroyed(ReactContext reactContext)

getSourceMapUrl

public java.lang.String getSourceMapUrl()

getSourceUrl

public java.lang.String getSourceUrl()

getJSBundleURLForRemoteDebugging

public java.lang.String getJSBundleURLForRemoteDebugging()

getDownloadedJSBundleFile

public java.lang.String getDownloadedJSBundleFile()

hasUpToDateJSBundleInCache

public boolean hasUpToDateJSBundleInCache()

Returns:

true if ReactInstanceManager should use downloaded JS bundle file instead of using JS file from assets. This may happen when app has not been updated since the last time we fetched the bundle.

hasBundleInAssets

public boolean hasBundleInAssets(java.lang.String bundleAssetName)

Returns:

true if JS bundle exists, in that case ReactInstanceManager should use that file from assets instead of downloading bundle from dev server

handleReloadJS

public void handleReloadJS()