com.facebook.react.bridge

Interface NativeModule

All Known Implementing Classes:

AndroidInfoModule, AnimationsDebugModule, AppStateModule, AsyncStorageModule, BaseJavaModule, CameraRollManager, ClipboardModule, DatePickerDialogModule, DebugComponentOwnershipModule, DeviceEventManagerModule, DialogModule, ExceptionsManagerModule, FrescoModule, ImageEditingManager, ImageStoreManager, IntentModule, LocationModule, NetInfoModule, NetworkingModule, ReactContextBaseJavaModule, SourceCodeModule, StatusBarModule, TimePickerDialogModule, Timing, ToastModule, UIManagerModule, WebSocketModule

public interface NativeModule

A native module whose API can be provided to JS catalyst instances. NativeModules whose implementation is written in Java should extend BaseJavaModule or ReactContextBaseJavaModule. NativeModules whose implementation is written in C++ must not provide any Java code (so they can be reused on other platforms), and instead should register themselves using CxxModuleWrapper.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NativeModule.NativeMethod

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canOverrideExistingModule() Return true if you intend to override some other native module that was registered e.g.
java.util.Map<java.lang.String,NativeModule.NativeMethod>	getMethods()
java.lang.String	getName()
void	initialize() This is called at the end of CatalystApplicationFragment#createCatalystInstance() after the CatalystInstance has been created, in order to initialize NativeModules that require the CatalystInstance or JS modules.
void	onCatalystInstanceDestroy() Called before {CatalystInstance#onHostDestroy}
void	writeConstantsField(com.fasterxml.jackson.core.JsonGenerator jg, java.lang.String fieldName) Append a field which represents the constants this module exports to JS.

Method Detail

getName

java.lang.String getName()

Returns:

the name of this module. This will be the name used to require() this module from javascript.

getMethods

java.util.Map<java.lang.String,NativeModule.NativeMethod> getMethods()

Returns:

methods callable from JS on this module

writeConstantsField

void writeConstantsField(com.fasterxml.jackson.core.JsonGenerator jg,
                       java.lang.String fieldName)
                         throws java.io.IOException

Append a field which represents the constants this module exports to JS. If no constants are exported this should do nothing.

Throws:

java.io.IOException

initialize

void initialize()

This is called at the end of CatalystApplicationFragment#createCatalystInstance() after the CatalystInstance has been created, in order to initialize NativeModules that require the CatalystInstance or JS modules.

canOverrideExistingModule

boolean canOverrideExistingModule()

Return true if you intend to override some other native module that was registered e.g. as part of a different package (such as the core one). Trying to override without returning true from this method is considered an error and will throw an exception during initialization. By default all modules return false.

onCatalystInstanceDestroy

void onCatalystInstanceDestroy()

Called before {CatalystInstance#onHostDestroy}