To perform the version upgrade from 3.x.x to 5.6.6, follow this steps:

1. Remove the 'com.google.code.gson:gson' dependency if it's not used in your project
2. Replace the play-services-ads plugin with play-services-ads-identifier:18.0.1 plugin
3. Update play-services-location plugin version to 19.0.1

To perform the version upgrade from 3.x.x to 5.6.7+, follow this steps:

1. Remove the 'com.google.code.gson:gson' dependency if it's not used in your project
2. Replace the play-services-ads plugin with play-services-ads-identifier:18.0.1 plugin
3. Update play-services-location plugin version to 21.0.1

Project Configuration

You must use the following dependencies in your project: play-services-location, play-services-ads-identifier. To do this, add the following information to your project's Gradle file, in the dependencies section.

dependencies {
    // Other dependencies of your project.
    //...
    // Required dependencies:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior: 5.6.7'
    api 'com.google.android.gms:play-services-location:21.0.1'
 }

dependencies {
    // Other dependencies of your project.
    //...
    // Required dependencies:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior: 6.0.0'
    api 'com.google.android.gms:play-services-location:21.0.1'
 }

dependencies {
    // Other dependencies of your project.
    //...
    // Required dependencies:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior: 6.0.8'
    api 'com.google.android.gms:play-services-location:21.0.1'
 }

The dependency 'com.google.android.gms:play-services-ads-identifier:18.0.1' is used to obtain information about the device's advertising identifier.

On the other hand, the dependency 'com.google.android.gms:play-services-location:21.0.1' should be used whenever it is necessary to collect geolocation information from the device.

-keep class sale.clear.behavior.** { *; }

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Project Configuration

You must use the following dependencies in your project: play-services-location, play-services-ads-identifier. To do this, add the following information to your project's Gradle file, in the dependencies section.

dependencies {
    // Other dependencies of your project.
    //...
    // Required dependencies:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior:5.6.6'
    api 'com.google.android.gms:play-services-location:19.0.1'
 }

The dependency 'com.google.android.gms:play-services-ads-identifier:18.0.1' is used to obtain information about the device's advertising identifier.

On the other hand, the dependency 'com.google.android.gms:play-services-location:19.0.1' should be used whenever it is necessary to collect geolocation information from the device.

-keep class sale.clear.behavior.** { *; }

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Project Configuration

You must use the following dependencies in your project: play-services-location, play-services-ads-identifier. To do this, add the following information to your project's Gradle file, in the dependencies section.

dependencies {
    // Other dependencies of your project.
    //...
    // Required dependencies:
    implementation 'com.google.android.gms:play-services-ads:18.3.0'
    api 'com.google.code.gson:gson:2.8.6'
    implementation 'sale.clear.behavior:sdk-behavior:3.0.2'

    // Optative dependencies:
    api 'com.google.android.gms:play-services-location:17.0.0'
 }

The optative dependency 'com.google.android.gms:play-services-location:17.0.0' must be used everytime that is necessary to collect geolocation information.

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/> 

<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Play Store Privacy

If the user has consent with the geolocation and application list collection, the methods allowGeoLocation() and allowAppList() must be called, before the start() method, as in the example below:

@Override
public void onResume() {
    super.onResume();
    try {
        mBehavior.blockGeoLocation(); // Blocks the geolocation capture
        mBehavior.blockAppList(); //Blocks the capture of installed apps information on the device
        mBehavior.start(); //Information capture initialization
        
        String sessionId = mBehavior.generateSessionID()

        //Only in the screens that is desired to sent the collected data to ClearSale
        mBehavior.collectDeviceInformation(sessionId); //Prefereable after some time of user interaction.
    }
    catch (CaptureWasStartedException e) {
        //This error occurs when the method start() was called more than once without using stop() method.
        //Each capture (that starts with the start() method) needs to be closed (witch the stop() method call)
    }
}

Play Store Privacy

If the user has consent with the geolocation and application list collection, the methods allowGeoLocation() and allowAppList() must be called, before the start() method, as in the example below:

@Override
public void onResume() {
    super.onResume();
    try {
        mBehavior.allowGeoLocation(); //Enables geolocation capture
        mBehavior.allowAppList(); //Enables the capture of installed apps information on the device
        mBehavior.start(); //Information capture initialization
        
        String sessionId = mBehavior.generateSessionID()

        //Only in the screens that is desired to sent the collected data to ClearSale
        mBehavior.collectDeviceInformation(sessionId); //Prefereable after some time of user interaction.
    }
    catch (CaptureWasStartedException e) {
        //This error occurs when the method start() was called more than once without using stop() method.
        //Each capture (that starts with the start() method) needs to be closed (witch the stop() method call)
    }
}

Behavior Class

Description

Behavior is the class responsible to collect the informations.

Constructors

This class doesn't contains public constructors. The instance should be made through a static method.

Static Methods

Methods

Examples

There are two ways to initialize the SDK. This depends on the type of screen that will be used. If the screen is an Activity, initialization should be done in the onCreate() method. If it is a Fragment, initialization should be done in the onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

Note:In both cases (Activity or Fragment), if the stop() method is not called within the onStop() method of one of the screens, due to it being a singleton, the CaptureWasStartedException exception will be thrown when the start() method is called on the next screen.

In all examples, we assume the existence of the following variables:

• mBehavior represents the Behavior class instance. Can be replaced by Behavior.getInstance(context, CLEAR_SALE_APP).
• CLEAR_SALE_APP string type variable, this value should be provided by ClearSale.

To initialize the call when the screen is a Fragment.

@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
    // To obtain the Context in a Fragment.
    View rootView = inflater.inflate(R.layout.fragment_login, container, false);
    Context context = rootView.getContext();
    //CLEAR_SALE_APP é um valor de identificação único que deve ser fornecido pela ClearSale.
    mBehavior = Behavior.getInstance(context, CLEAR_SALE_APP);
    return rootView;
}

When the screen is an Activity

@Override
public void onCreate() {
    //CLEAR_SALE_APP é um valor de identificação único que deve ser fornecido pela ClearSale.
    mBehavior = Behavior.getInstance(this, CLEAR_SALE_APP);
}

To start the capture:

@Override
public void onResume() {
    super.onResume();
    try {
        mBehavior.start(); //Information capture initialization.
        String sessionId = mBehavior.generateSessionID()
        //Only on screens that is desired to sent the collected data to ClearSale
        mBehavior.collectDeviceInformation(sessionId); //Preferable after some time of user interaction.
    }
    catch (CaptureWasStartedException e) {
        //This indicates that the method mBehavior.start() was previously called but 
        //the collection wasn't properly terminated using the method mBehavior.stop().
    }catch (SessionIDAlreadyUsedException e) {
        //The same sessionID was used previously. The SessionID must be unique per collect.
    }
}

The start() and stop() methods should only be implemented on the screen where information capture will be performed. The collectDeviceInformation(SESSION_ID) method should be called when you want to send the collected information to ClearSale, on the same screen where the previous methods were implemented.

Note: The collectDeviceInformation method must be called after the start() method has already been executed.

We recommend that these methods be implemented on a 'completion' screen where there is user interaction for at least 3 seconds.

To close the capture:

@Override
public void onStop() {
    super.onStop();
    mBehavior.stop(); //Information capture termination.
}                         

Complete implementation example:

public class ImplementationExampleActivity extends AppCompatActivity {

    private Behavior mBehavior;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        //CLEAR_SALE_APP é um valor de identificação único que deve ser fornecido pela ClearSale.
        mBehavior = Behavior.getInstance(this, "CLEAR_SALE_APP");
    }

    @Override
    public void onResume() {
        super.onResume();
        try {
            mBehavior.start(); //Information capture initialization
            String sessionId = mBehavior.generateSessionID();

            //Only on screens that is desired to sent the collected data to ClearSale
            mBehavior.collectDeviceInformation(sessionId); //Preferable after some time of user interaction.
        }catch (CaptureWasStartedException e) {
            //This indicates that the method mBehavior.start() was previously called but 
            //the collection wasn't properly terminated using the method mBehavior.stop().
        }catch (SessionIDAlreadyUsedException e) {
            //The same sessionID was used previously. The SessionID must be unique per collect.
        }
    }

    @Override
    public void onStop() {
        super.onStop();
        mBehavior.stop(); //Information capture termination.
    }
}