com.facebook.react.modules.network

Class NetworkingModule

java.lang.Object

com.facebook.react.bridge.BaseJavaModule

com.facebook.react.bridge.ReactContextBaseJavaModule

com.facebook.react.modules.network.NetworkingModule

All Implemented Interfaces:

NativeModule

public final class NetworkingModule
extends ReactContextBaseJavaModule

Implements the XMLHttpRequest JavaScript interface.

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.react.bridge.BaseJavaModule

BaseJavaModule.JavaMethod

Nested classes/interfaces inherited from interface com.facebook.react.bridge.NativeModule

NativeModule.NativeMethod

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	NAME

Fields inherited from class com.facebook.react.bridge.BaseJavaModule

METHOD_TYPE_ASYNC, METHOD_TYPE_PROMISE, METHOD_TYPE_SYNC

Constructor Summary

Constructors

Constructor and Description
NetworkingModule(ReactApplicationContext context)
NetworkingModule(ReactApplicationContext context, java.util.List<NetworkInterceptorCreator> networkInterceptorCreators)
NetworkingModule(ReactApplicationContext context, java.lang.String defaultUserAgent)

Method Summary

Modifier and Type	Method and Description
void	abortRequest(ExecutorToken executorToken, int requestId)
void	clearCookies(ExecutorToken executorToken, Callback callback)
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	sendRequest(ExecutorToken executorToken, java.lang.String method, java.lang.String url, int requestId, ReadableArray headers, ReadableMap data, java.lang.String responseType, boolean useIncrementalUpdates, int timeout)
boolean	supportsWebWorkers() In order to support web workers, a module must be aware that it can be invoked from multiple different JS VMs.

Methods inherited from class com.facebook.react.bridge.ReactContextBaseJavaModule

getCurrentActivity, getReactApplicationContext

Methods inherited from class com.facebook.react.bridge.BaseJavaModule

canOverrideExistingModule, getConstants, getMethods

Methods inherited from class java.lang.Object

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

Field Detail

NAME

protected static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

NetworkingModule

public NetworkingModule(ReactApplicationContext context)

Parameters:

context - the ReactContext of the application

NetworkingModule

public NetworkingModule(ReactApplicationContext context,
                        java.util.List<NetworkInterceptorCreator> networkInterceptorCreators)

Parameters:

context - the ReactContext of the application

networkInterceptorCreators - list of NetworkInterceptorCreator's whose create() methods would be called to attach the interceptors to the client.

NetworkingModule

public NetworkingModule(ReactApplicationContext context,
                        java.lang.String defaultUserAgent)

Parameters:

context - the ReactContext of the application

defaultUserAgent - the User-Agent header that will be set for all requests where the caller does not provide one explicitly

Method Detail

initialize

public void initialize()

Description copied from interface: NativeModule

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.

Specified by:

initialize in interface NativeModule

Overrides:

initialize in class BaseJavaModule

getName

public java.lang.String getName()

Returns:

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

onCatalystInstanceDestroy

public void onCatalystInstanceDestroy()

Description copied from interface: NativeModule

Called before {CatalystInstance#onHostDestroy}

Specified by:

onCatalystInstanceDestroy in interface NativeModule

Overrides:

onCatalystInstanceDestroy in class BaseJavaModule

sendRequest

public void sendRequest(ExecutorToken executorToken,
                        java.lang.String method,
                        java.lang.String url,
                        int requestId,
                        ReadableArray headers,
                        ReadableMap data,
                        java.lang.String responseType,
                        boolean useIncrementalUpdates,
                        int timeout)

abortRequest

public void abortRequest(ExecutorToken executorToken,
                         int requestId)

clearCookies

public void clearCookies(ExecutorToken executorToken,
                         Callback callback)

supportsWebWorkers

public boolean supportsWebWorkers()

Description copied from interface: NativeModule

In order to support web workers, a module must be aware that it can be invoked from multiple different JS VMs. Supporting web workers means recognizing things like: 1) ids (e.g. timer ids, request ids, etc.) may only unique on a per-VM basis 2) the module needs to make sure to enqueue callbacks and JS module calls to the correct VM In order to facilitate this, modules that support web workers will have all their @ReactMethod- annotated methods passed a ExecutorToken as the first parameter before any arguments from JS. This ExecutorToken internally maps to a specific JS VM and can be used by the framework to route calls appropriately. In order to make JS module calls correctly, start using the version of ReactContext.getJSModule(ExecutorToken, Class) that takes an ExecutorToken. It will ensure that any calls you dispatch to the returned object will go to the right VM. For Callbacks, you don't have to do anything special -- the framework automatically tags them with the correct ExecutorToken when the are created. Note: even though calls can come from multiple JS VMs on multiple threads, calls to this module will still only occur on a single thread.

Specified by:

supportsWebWorkers in interface NativeModule

Overrides:

supportsWebWorkers in class BaseJavaModule

Returns:

whether this module supports web workers.