com.facebook.react.modules.fresco

Class FrescoModule

java.lang.Object

com.facebook.react.bridge.BaseJavaModule

com.facebook.react.bridge.ReactContextBaseJavaModule

com.facebook.react.modules.fresco.FrescoModule

All Implemented Interfaces:

NativeModule, ModuleDataCleaner.Cleanable

public class FrescoModule
extends ReactContextBaseJavaModule
implements ModuleDataCleaner.Cleanable

Module to initialize the Fresco library.

Does not expose any methods to JavaScript code. For initialization and cleanup only.

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 inherited from class com.facebook.react.bridge.BaseJavaModule

METHOD_TYPE_ASYNC, METHOD_TYPE_PROMISE, METHOD_TYPE_SYNC

Constructor Summary

Constructors

Constructor and Description
FrescoModule(ReactApplicationContext reactContext) Create a new Fresco module with a default configuration (or the previously given configuration via FrescoModule(ReactApplicationContext, ImagePipelineConfig).
FrescoModule(ReactApplicationContext reactContext, ImagePipelineConfig config) Create a new Fresco module with a given ImagePipelineConfig.

Method Summary

Modifier and Type	Method and Description
void	clearSensitiveData()
static ImagePipelineConfig.Builder	getDefaultConfigBuilder(android.content.Context context) Get the default Fresco configuration builder.
java.lang.String	getName()
static boolean	hasBeenInitialized() Check whether the FrescoModule has already been initialized.
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.

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

getCurrentActivity, getReactApplicationContext

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

canOverrideExistingModule, getConstants, getMethods, onCatalystInstanceDestroy, supportsWebWorkers

Methods inherited from class java.lang.Object

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

Constructor Detail

FrescoModule

public FrescoModule(ReactApplicationContext reactContext)

Create a new Fresco module with a default configuration (or the previously given configuration via FrescoModule(ReactApplicationContext, ImagePipelineConfig).

Parameters:

reactContext - the context to use

FrescoModule

public FrescoModule(ReactApplicationContext reactContext,
                    @Nullable
                    ImagePipelineConfig config)

Create a new Fresco module with a given ImagePipelineConfig. This should only be called when the module has not been initialized yet. You can use hasBeenInitialized() to check this and call FrescoModule(ReactApplicationContext) if it is already initialized. Otherwise, the given Fresco configuration will be ignored.

Parameters:

reactContext - the context to use

config - the Fresco configuration, which will only be used for the first initialization

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

Specified by:

getName in interface NativeModule

Returns:

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

clearSensitiveData

public void clearSensitiveData()

Specified by:

clearSensitiveData in interface ModuleDataCleaner.Cleanable

hasBeenInitialized

public static boolean hasBeenInitialized()

Check whether the FrescoModule has already been initialized. If this is the case, Calls to FrescoModule(ReactApplicationContext, ImagePipelineConfig) will ignore the given configuration.

Returns:

true if this module has already been initialized

getDefaultConfigBuilder

public static ImagePipelineConfig.Builder getDefaultConfigBuilder(android.content.Context context)

Get the default Fresco configuration builder. Allows adding of configuration options in addition to the default values.

Returns:

ImagePipelineConfig.Builder that has been initialized with default values