com.facebook.react.devsupport

Class DevSupportManagerImpl

java.lang.Object

com.facebook.react.devsupport.DevSupportManagerImpl

All Implemented Interfaces:

NativeModuleCallExceptionHandler, DevInternalSettings.Listener, DevServerHelper.PackagerCommandListener, DevSupportManager

public class DevSupportManagerImpl
extends java.lang.Object
implements DevSupportManager, DevServerHelper.PackagerCommandListener, DevInternalSettings.Listener

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
DevSupportManagerImpl(android.content.Context applicationContext, ReactInstanceDevCommandsHandler reactInstanceCommandsHandler, java.lang.String packagerPathForJSBundleName, boolean enableOnCreate)
DevSupportManagerImpl(android.content.Context applicationContext, ReactInstanceDevCommandsHandler reactInstanceCommandsHandler, java.lang.String packagerPathForJSBundleName, boolean enableOnCreate, RedBoxHandler redBoxHandler)

Method Summary

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.
java.io.File	downloadBundleResourceFromUrlSync(java.lang.String resourceURL, java.io.File outputFile)
DeveloperSettings	getDevSettings()
boolean	getDevSupportEnabled()
java.lang.String	getDownloadedJSBundleFile()
java.lang.String	getHeapCaptureUploadUrl()
java.lang.String	getJSBundleURLForRemoteDebugging()
StackFrame[]	getLastErrorStack()
java.lang.String	getLastErrorTitle()
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	hideRedboxDialog()
void	isPackagerRunning(PackagerStatusCallback callback)
void	onCaptureHeapCommand(JSPackagerClient.Responder responder)
void	onInternalSettingsChanged()
void	onNewReactContextCreated(ReactContext reactContext)
void	onPackagerReloadCommand()
void	onPokeSamplingProfilerCommand(JSPackagerClient.Responder responder)
void	onReactInstanceDestroyed(ReactContext reactContext)
void	reloadJSFromServer(java.lang.String bundleURL)
void	reloadSettings()
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	showNewJavaError(java.lang.String message, java.lang.Throwable e)
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

DevSupportManagerImpl

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

DevSupportManagerImpl

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

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

showNewJavaError

public void showNewJavaError(java.lang.String message,
                             java.lang.Throwable e)

Specified by:

showNewJavaError in interface DevSupportManager

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.

Specified by:

addCustomDevOption in interface DevSupportManager

showNewJSError

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

Specified by:

showNewJSError in interface DevSupportManager

updateJSError

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

Specified by:

updateJSError in interface DevSupportManager

hideRedboxDialog

public void hideRedboxDialog()

Specified by:

hideRedboxDialog in interface DevSupportManager

showDevOptionsDialog

public void showDevOptionsDialog()

Specified by:

showDevOptionsDialog in interface DevSupportManager

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).

Specified by:

setDevSupportEnabled in interface DevSupportManager

getDevSupportEnabled

public boolean getDevSupportEnabled()

Specified by:

getDevSupportEnabled in interface DevSupportManager

getDevSettings

public DeveloperSettings getDevSettings()

Specified by:

getDevSettings in interface DevSupportManager

onNewReactContextCreated

public void onNewReactContextCreated(ReactContext reactContext)

Specified by:

onNewReactContextCreated in interface DevSupportManager

onReactInstanceDestroyed

public void onReactInstanceDestroyed(ReactContext reactContext)

Specified by:

onReactInstanceDestroyed in interface DevSupportManager

getSourceMapUrl

public java.lang.String getSourceMapUrl()

Specified by:

getSourceMapUrl in interface DevSupportManager

getSourceUrl

public java.lang.String getSourceUrl()

Specified by:

getSourceUrl in interface DevSupportManager

getJSBundleURLForRemoteDebugging

public java.lang.String getJSBundleURLForRemoteDebugging()

Specified by:

getJSBundleURLForRemoteDebugging in interface DevSupportManager

getDownloadedJSBundleFile

public java.lang.String getDownloadedJSBundleFile()

Specified by:

getDownloadedJSBundleFile in interface DevSupportManager

getHeapCaptureUploadUrl

public java.lang.String getHeapCaptureUploadUrl()

Specified by:

getHeapCaptureUploadUrl in interface DevSupportManager

hasUpToDateJSBundleInCache

public boolean hasUpToDateJSBundleInCache()

Specified by:

hasUpToDateJSBundleInCache in interface DevSupportManager

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

reloadSettings

public void reloadSettings()

Specified by:

reloadSettings in interface DevSupportManager

onInternalSettingsChanged

public void onInternalSettingsChanged()

Specified by:

onInternalSettingsChanged in interface DevInternalSettings.Listener

handleReloadJS

public void handleReloadJS()

Specified by:

handleReloadJS in interface DevSupportManager

isPackagerRunning

public void isPackagerRunning(PackagerStatusCallback callback)

Specified by:

isPackagerRunning in interface DevSupportManager

downloadBundleResourceFromUrlSync

@Nullable
public java.io.File downloadBundleResourceFromUrlSync(java.lang.String resourceURL,
                                                                java.io.File outputFile)

Specified by:

downloadBundleResourceFromUrlSync in interface DevSupportManager

getLastErrorTitle

@Nullable
public java.lang.String getLastErrorTitle()

Specified by:

getLastErrorTitle in interface DevSupportManager

getLastErrorStack

@Nullable
public StackFrame[] getLastErrorStack()

Specified by:

getLastErrorStack in interface DevSupportManager

onPackagerReloadCommand

public void onPackagerReloadCommand()

Specified by:

onPackagerReloadCommand in interface DevServerHelper.PackagerCommandListener

onCaptureHeapCommand

public void onCaptureHeapCommand(@Nullable
                                 JSPackagerClient.Responder responder)

Specified by:

onCaptureHeapCommand in interface DevServerHelper.PackagerCommandListener

onPokeSamplingProfilerCommand

public void onPokeSamplingProfilerCommand(@Nullable
                                          JSPackagerClient.Responder responder)

Specified by:

onPokeSamplingProfilerCommand in interface DevServerHelper.PackagerCommandListener

reloadJSFromServer

public void reloadJSFromServer(java.lang.String bundleURL)

Specified by:

reloadJSFromServer in interface DevSupportManager