Package-level declarations

Types

Link copied to clipboard

Listener for receiving activity events. Consider using BaseActivityEventListener if you're not interested in all the events sent to this interface.

Link copied to clipboard
open class Arguments
Link copied to clipboard

Like AssertionError but extends RuntimeException so that it may be caught by a JSExceptionHandler. See that class for more details. Used in conjunction with SoftAssertions.

Link copied to clipboard
Link copied to clipboard
abstract class BaseJavaModule : NativeModule
Base class for Catalyst native modules whose implementations are written in Java.
Link copied to clipboard
This is the bridge-specific concrete subclass of ReactContext.
Link copied to clipboard
fun interface Callback

Interface that represent javascript callback function which can be passed to the native module as a method parameter.

Link copied to clipboard
class CallbackImpl(jsInstance: JSInstance, callbackId: Int) : Callback

Implementation of javascript callback function that uses Bridge to schedule method execution.

Link copied to clipboard

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.

Link copied to clipboard
This provides an implementation of the public CatalystInstance instance.
Link copied to clipboard
Link copied to clipboard
class CxxCallbackImpl : HybridClassBase, Callback

Callback impl that calls directly into the cxx bridge. Created from C++.

Link copied to clipboard

This does nothing interesting, except avoid breaking existing code.

Link copied to clipboard

A Java Object which represents a cross-platform C++ module

Link copied to clipboard

Crashy crashy exception handler.

Link copied to clipboard
interface Dynamic

Type representing a piece of data with unknown runtime type. Useful for allowing javascript to pass one of multiple types down to the native layer.

Link copied to clipboard
Implementation of Dynamic wrapping a ReadableArray.
Link copied to clipboard

Abstract base for a AsyncTask that should have any RuntimeExceptions it throws handled by the JSExceptionHandler registered if the app is in dev mode.

Link copied to clipboard
abstract class GuardedRunnable(exceptionHandler: JSExceptionHandler) : Runnable

Abstract base for a Runnable that should have any RuntimeExceptions it throws handled by the JSExceptionHandler registered if the app is in dev mode.

Link copied to clipboard
open class Inspector
Link copied to clipboard

Exception thrown by ReadableMapKeySetIterator.nextKey when the iterator tries to iterate over elements after the end of the key set.

Link copied to clipboard

Java ArrayList backed implementation of ReadableArray and WritableArray Instances of this class SHOULD NOT be used for communication between java and JS, use instances of WritableNativeArray created via Arguments#createArray or just ReadableArray interface if you want your "native" module method to take an array from JS as an argument.

Link copied to clipboard

Java HashMap backed implementation of ReadableMap and WritableMap Instances of this class SHOULD NOT be used for communication between java and JS, use instances of WritableNativeMap created via Arguments#createMap or just ReadableMap interface if you want your "native" module method to take a map from JS as an argument.

Link copied to clipboard

Wrapper for JavaScriptContext native pointer. This object is creates on demand as part of the initialization of React native, and will call clear() before destroying the VM. People who need the raw JavaScriptContext pointer can synchronize on this wrapper object to guarantee that it will not be destroyed.

Link copied to clipboard
abstract class JavaScriptExecutor
Link copied to clipboard
Link copied to clipboard

Interface denoting that a class is the interface to a module with the same name in JS. Calling functions on this interface will result in corresponding methods in JS being called.

Link copied to clipboard
Class responsible for holding all the JavaScriptModules.
Link copied to clipboard

A special RuntimeException that should be thrown by native code if it has reached an exceptional state due to a, or a sequence of, bad commands.

Link copied to clipboard

An illegal argument Exception caused by an argument passed from JS.

Link copied to clipboard
abstract class JSBundleLoader
A class that stores JS bundle information and allows a JSBundleLoaderDelegate.
Link copied to clipboard

An interface for classes that initialize JavaScript using JSBundleLoader

Link copied to clipboard
fun interface JSExceptionHandler

Interface for a class that knows how to handle an Exception invoked from JS. Since these Exceptions are triggered by JS calls (and can be fixed in JS), a common way to handle one is to show a error dialog and allow the developer to change and reload JS.

Link copied to clipboard
interface JSInstance

This interface includes the methods needed to use a running JS instance, without specifying any of the bridge-specific initialization or lifecycle management.

Link copied to clipboard
open class JSONArguments
Link copied to clipboard
open class JsonWriterHelper
Helper for generating JSON for lists and maps.
Link copied to clipboard

Listener for receiving activity lifecycle events.

Link copied to clipboard
Link copied to clipboard

Listener interface for memory pressure events.

Link copied to clipboard
open class ModuleHolder
Holder to enable us to lazy create native modules.
Link copied to clipboard
open class ModuleSpec
A specification for a native module.
Link copied to clipboard
abstract class NativeArray : HybridClassBase, NativeArrayInterface

Base class for an array whose members are stored in native code (C++).

Link copied to clipboard
Link copied to clipboard
abstract class NativeMap : HybridClassBase

Base class for a Map whose keys and values are stored in native code (C++).

Link copied to clipboard
interface NativeModule
A native module whose API can be provided to JS catalyst instances.
Link copied to clipboard
A set of Java APIs to expose to a particular JavaScript instance.
Link copied to clipboard
class NoSuchKeyException constructor(msg: String) : RuntimeException

Exception thrown by ReadableNativeMap when a key that does not exist is requested.

Link copied to clipboard

Interface for receiving notification for bridge idle/busy events. Should not affect application logic and should only be used for debug/monitoring/testing purposes. Call to start monitoring.

Link copied to clipboard

Interface for a module that will be notified when a batch of JS->Java calls has finished.

Link copied to clipboard
Link copied to clipboard
interface Promise
Link copied to clipboard
open class PromiseImpl : Promise
Link copied to clipboard
A context wrapper that always wraps Android Application Context and by extending ReactContext
Link copied to clipboard
abstract class ReactContext : ContextWrapper
Abstract ContextWrapper for Android application or activity Context and
Link copied to clipboard
Base class for Catalyst native modules that require access to the ReactContext instance.
Link copied to clipboard
Link copied to clipboard

If thrown during a MountItem execution, FabricUIManager will print diagnostics and ignore the error. Use this carefully and sparingly!

Link copied to clipboard
open class ReactMarker
Static class that allows markers to be placed in React code and responded to in a configurable way
Link copied to clipboard

Constants used by ReactMarker.

Link copied to clipboard
annotation class ReactMethod(val isBlockingSynchronousMethod: Boolean = false)

Annotation which is used to mark methods that are exposed to React Native.

Link copied to clipboard
Link copied to clipboard

Extends RuntimeException so that it may be caught by a ReactSoftExceptionListener. Any ReactSoftExceptionListener that catches a ReactNoCrashSoftException should log it only and not crash, no matter what.

Link copied to clipboard
Link copied to clipboard
interface ReadableArray

Interface for an array that allows typed access to its members. Used to pass parameters from JS to Kotlin.

Link copied to clipboard
interface ReadableMap

Interface for a map that allows typed access to its members. Used to pass parameters from JS to Kotlin.

Link copied to clipboard

Interface of a iterator for a NativeMap's key set.

Link copied to clipboard

Implementation of a NativeArray that allows read-only access to its members. This will generally be constructed and filled in native code so you shouldn't construct one yourself.

Link copied to clipboard

Implementation of a read-only map in native memory. This will generally be constructed and filled in native code so you shouldn't construct one yourself.

Link copied to clipboard

Defines the type of an object stored in a ReadableArray or ReadableMap.

Link copied to clipboard

ViewCommands can throw this Exception. If this is caught during the execution of a ViewCommand mounting instruction, it indicates that the mount item can be safely retried.

Link copied to clipboard
class RuntimeExecutor : HybridClassBase

A Kotlin holder for a C++ RuntimeExecutor.

Link copied to clipboard
class RuntimeScheduler : HybridClassBase

A Kotlin holder for a C++ RuntimeScheduler.

Link copied to clipboard

Utility class to make assertions that should not hard-crash the app but instead be handled by the Catalyst app JSExceptionHandler. See the javadoc on that class for more information about our opinion on when these assertions should be used as opposed to assertions that might throw AssertionError Throwables that will cause the app to hard crash.

Link copied to clipboard

Interface to the JavaScript Systrace Module

Link copied to clipboard
Link copied to clipboard

Listener used to hook into the UIManager update process.

Link copied to clipboard
fun interface UIManagerProvider

UIManagerProvider is used to create UIManager objects during the initialization of React Native.

Link copied to clipboard
open class UiThreadUtil
Utility for interacting with the UI thread.
Link copied to clipboard

Exception thrown from native code when a type retrieved from a map or array (e.g. via NativeArrayParameter.getString(int)) does not match the expected type.

Link copied to clipboard
Link copied to clipboard

Interface for a mutable array. Used to pass arguments from Kotlin to JS.

Link copied to clipboard

Interface for a mutable map. Used to pass arguments from Kotlin to JS.

Link copied to clipboard

Implementation of a write-only array stored in native memory. Use Arguments#createArray() if you need to stub out creating this class in a test.

Link copied to clipboard

Implementation of a write-only map stored in native memory. Use Arguments.createMap if you need to stub out creating this class in a test. TODO(5815532): Check if consumed on read