The purpose of this manual is to provide all the necessary information for the installation and use of the tool in applications developed for the React Native platform.

This Plugin collects data (information and location) from the device and sends it to ClearSale. All collected information is related only to the device, without any relation to the integrated application.

The geolocation information depends on the permission granted by the user of the device, in this case is necessary that the application requests the access of the user location information (the SDK doesn't requests permission). If the application doesn't request the access or the user doesn't grant permission, for location, the GeoLocation information will not be captured.

The Plugin respects Apple and Google's privacy policies for capturing device data and the permission level assigned by the user (device user).

Checksum

Package	Digest
clear.sale/behavior-analytics-react-native-sdk	sha1-6VAoJWwE2O4R28Z30FtagJOu/jY=

To check the checksum of the artifact check the package.json.lock, after executing the command npm install in your project.

Checksum

Package	Digest
clear.sale/behavior-analytics-react-native-sdk	sha1-e3lWDWX5cE43JPQc/riruiX4sDg=

To check the checksum of the artifact check the package.json.lock, after executing the command npm install in your project.

Checksum

Package	Digest
clear.sale/behavior-analytics-react-native-sdk	sha1-NjDR2LR86fxl7Wg5tJyt3CSN0MA=

To check the checksum of the artifact check the package.json.lock, after executing the command npm install in your project.

Dependencies

- Node >= 10.19.0
- React Native >= 0.63.2

- Node >= 20.11.1
- React Native >= 0.73.4

React-Navigation (navigation between screens)

- react-navigation/native: 5.7.3
- react-navigation/stack: 5.9.0

- react-navigation/native: 6.1.9
- react-navigation/stack: 6.9.17

npm install @clear.sale/behavior-analytics-react-native-sdk@2.5.2

yarn add @clear.sale/behavior-analytics-react-native-sdk@2.5.2

@clear.sale:registry=https://pkgs.dev.azure.com/CS-PublicPackages/Behavior/_packaging/BehaviorAnalytics.SDK/npm/registry

    always-auth=true

    

"dependencies": {
        "@clear.sale/behavior-analytics-react-native-sdk": "1.0.1-rc.2",
        ...
    },
    

npm install @clear.sale/behavior-analytics-react-native-sdk@1.0.1-rc.2

yarn add @clear.sale/behavior-analytics-react-native-sdk@1.0.1-rc.2

Behavior Interface

Provides all methods that communicate with the SDK, all methods return a Promise.

Methods

Method name	Plataform	Description
Promise<String> generateSessionId(appKey)	Android / iOS	Generates and returns a session identifier. This method should only be used if the application does not generate unique identifiers for each collection.
Promise<void> collectDeviceInformation(appKey, sessionId)	Android / iOS	Collects device information by linking it to the Session value. It is necessary to pass the SessionId, session value, as a parameter. Notes: If you do not have your own value for SessionID, use the generateSessionId() method. The maximum SessionID length to be used is 128 characters. The minimum SessionID length to be used is 6 characters.
Promise<void> start(appKey, success, failure)	Android	Starts collecting device and screen information, Exception: CaptureWasStartedException - thrown when a previous capture was not stopped.
Promise<void> stop(appKey, sessionId, success, failure)	Android	Ends the data capture process.
Promise<void> allowAppList()	Android	Activates the collection of information about the applications installed on the device.
Promise<void> allowGeoLocation()	Android	Activates the collection of geolocation.

Example

Plugin usage example

Importing the plugin

import ClearSaleModule from 'behavior-analytics-react-native-sdk'
                            

Using the methods start and stop suring the component lifecycle (React Hooks):

useEffect(() => {
    if (Platform.OS === 'android') {
        ...
        ClearSaleModule.start(appKey)
        ClearSaleModule.allowAppList()
        ClearSaleModule.allowGeoLocation()

        return () => {
            ...
            ClearSaleModule.stop(appKey)
        }
    }
}, [])
                            

Android

To utilize the generateSessionId and collectDeviceInformation funcions is necessary that the method start() has been executed.

If the method start has been executed without the stop method execution, it will be thrown a CaptureWasStartedException exception.

Data collection method

Method generateSessionId returns the sessionId.

const loadPage = async () => {
    ...

    await verifyLocationPermissions()

    const sessionId = await ClearSaleModule.generateSessionId(state.token)
    setState({
        ...state,
        sessionId: sessionId
    })

    ...
}
                            

Method collectDeviceInformation starts the data collection with an existing sessionId.

useFocusEffect(
    React.useCallback(() => {
        loadPage()

    return () => {
        unloadPage()
        };
    }, [])
);

const loadPage = async () => {
    ClearSaleModule.collectDeviceInformation(state.token, state.sessionId).then(() => {
        console.log('id com sucesso', state.sessionId)
        setLoading(false)
        setSend(true)
    }).catch(() => {
        setLoading(false)
        setSend(false)
    })
}
                            

Capturing Promise response.

const getSessionId = () => {
    ClearSaleModule.generateSessionId(appKey).then(sessionId => {
        ...
        setSessionId(sessionId)
    }).catch(err => {
        ...
    })
}
                            

Example project

It's possible to visualize the SDK implementation in a example project clicking here.

Removal

Npm:

npm uninstall @clear.sale/behavior-analytics-react-native-sdk

npm uninstall @clear.sale/behavior-analytics-react-native-sdk

Yarn:

yarn remove @clear.sale/behavior-analytics-react-native-sdk

yarn remove @clear.sale/behavior-analytics-react-native-sdk

Click here to access our FAQ

All information collected by ClearSale's SDK are exclusively for the purpose of fraud prevention and user protection, adherent to the security and privacy policies of Google and Apple platfoms and the LGPD. Therefore, this information must be in the application privacy policy.

Data Type Collected

ClearSale's SDK collects the following device information:

• Precise location (when allowed by user);
• Device advertising identification (when allowed by user);
• Device physical/hardware characteristics (such as display, battery, keyboard, disk space, model, device name);
• Device software characteristics (such as version, language, build, parental control);
• Network information (such as connections, IP);
• SimCard carrier.

Google Privacy Policy
Apple Privacy Policy