io.didomi.sdk.apiEvents

Class ApiEventsRepository

java.lang.Object

io.didomi.sdk.apiEvents.ApiEventsRepository

All Implemented Interfaces:

ConnectivityListener, HttpResponseJSONListener, HttpResponseListener

public class ApiEventsRepository
extends java.lang.Object
implements HttpResponseJSONListener, ConnectivityListener

Class created to handle app events of the SDK.

Constructor Summary

Constructors

Constructor and Description
ApiEventsRepository(ContextHelper contextHelper, CountryHelper countryHelper, ConnectivityHelper connectivityHelper, HttpRequestHelper httpRequestHelper, ConfigurationRepository configurationRepository, ConsentRepository consentRepository, io.didomi.sdk.user.OrganizationUserRepository organizationUserRepository, io.didomi.sdk.user.UserRepository userRepository)

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<ApiEvent>	getEventsArray() Getter method used to return APIEvents returns ArrayList of ApiEvent.
java.util.Set<ApiEventType>	getTriggeredEvents() Getter method used to return triggered APIEvent types returns Set of ApiEventType.
void	onBackOnline() Method called once the device is back online.
void	onFailure(org.json.JSONObject jsonObject)
void	onSuccess(org.json.JSONObject jsonObject)
void	sendEvent(ApiEvent apiEvent) Method used to send a single apiEvent.
static boolean	shouldEventBeSent(java.lang.String userUUID, double samplingRate) Method used to determine if the current event should be sent to API.
boolean	shouldSkipEvent(ApiEvent apiEvent) Method used to determine if the current event should be skipped or not.
void	triggerConsentAskedEvent(java.util.Set<java.lang.String> purposeIds, java.util.Set<java.lang.String> legIntPurposeIds, java.util.Set<java.lang.String> vendorIds, java.util.Set<java.lang.String> vendorLegIntIds, java.lang.String position) Method used to trigger the Consent Asked event.
void	triggerConsentGivenEvent(java.util.Set<java.lang.String> enabledPurposeIds, java.util.Set<java.lang.String> disabledPurposeIds, java.util.Set<java.lang.String> enabledLegitimatePurposeIds, java.util.Set<java.lang.String> disabledLegitimatePurposeIds, java.util.Set<java.lang.String> enabledVendorIds, java.util.Set<java.lang.String> disabledVendorIds, java.util.Set<java.lang.String> enabledLegIntVendorIds, java.util.Set<java.lang.String> disabledLegIntVendorIds, java.util.Set<java.lang.String> previousEnabledPurposeIds, java.util.Set<java.lang.String> previousDisabledPurposeIds, java.util.Set<java.lang.String> previousEnabledLegitimatePurposeIds, java.util.Set<java.lang.String> previousDisabledLegitimatePurposeIds, java.util.Set<java.lang.String> previousEnabledVendorIds, java.util.Set<java.lang.String> previousDisabledVendorIds, java.util.Set<java.lang.String> previousEnabledLegIntVendorIds, java.util.Set<java.lang.String> previousDisabledLegIntVendorIds) Method used to trigger the Consent Given event.
void	triggerPageViewEvent() Method used to trigger a pageview event.
void	triggerUIActionPurposeChangedEvent() Method used to trigger a purpose changed event.
void	triggerUIActionShownPurposesEvent() Method used to trigger a purposes shown event.
void	triggerUIActionShownVendorsEvent() Method used to trigger a vendors shown event.
void	triggerUIActionVendorChangedEvent() Method used to trigger a vendor changed event.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiEventsRepository

public ApiEventsRepository(ContextHelper contextHelper,
                           CountryHelper countryHelper,
                           ConnectivityHelper connectivityHelper,
                           HttpRequestHelper httpRequestHelper,
                           ConfigurationRepository configurationRepository,
                           ConsentRepository consentRepository,
                           io.didomi.sdk.user.OrganizationUserRepository organizationUserRepository,
                           io.didomi.sdk.user.UserRepository userRepository)

Method Detail

getEventsArray

public java.util.ArrayList<ApiEvent> getEventsArray()

Getter method used to return APIEvents returns ArrayList of ApiEvent.

getTriggeredEvents

public java.util.Set<ApiEventType> getTriggeredEvents()

Getter method used to return triggered APIEvent types returns Set of ApiEventType.

triggerPageViewEvent

public void triggerPageViewEvent()

Method used to trigger a pageview event.

triggerConsentAskedEvent

public void triggerConsentAskedEvent(java.util.Set<java.lang.String> purposeIds,
                                     java.util.Set<java.lang.String> legIntPurposeIds,
                                     java.util.Set<java.lang.String> vendorIds,
                                     java.util.Set<java.lang.String> vendorLegIntIds,
                                     java.lang.String position)

Method used to trigger the Consent Asked event.

triggerConsentGivenEvent

public void triggerConsentGivenEvent(java.util.Set<java.lang.String> enabledPurposeIds,
                                     java.util.Set<java.lang.String> disabledPurposeIds,
                                     java.util.Set<java.lang.String> enabledLegitimatePurposeIds,
                                     java.util.Set<java.lang.String> disabledLegitimatePurposeIds,
                                     java.util.Set<java.lang.String> enabledVendorIds,
                                     java.util.Set<java.lang.String> disabledVendorIds,
                                     java.util.Set<java.lang.String> enabledLegIntVendorIds,
                                     java.util.Set<java.lang.String> disabledLegIntVendorIds,
                                     java.util.Set<java.lang.String> previousEnabledPurposeIds,
                                     java.util.Set<java.lang.String> previousDisabledPurposeIds,
                                     java.util.Set<java.lang.String> previousEnabledLegitimatePurposeIds,
                                     java.util.Set<java.lang.String> previousDisabledLegitimatePurposeIds,
                                     java.util.Set<java.lang.String> previousEnabledVendorIds,
                                     java.util.Set<java.lang.String> previousDisabledVendorIds,
                                     java.util.Set<java.lang.String> previousEnabledLegIntVendorIds,
                                     java.util.Set<java.lang.String> previousDisabledLegIntVendorIds)

Method used to trigger the Consent Given event.

triggerUIActionShownPurposesEvent

public void triggerUIActionShownPurposesEvent()

Method used to trigger a purposes shown event.

triggerUIActionShownVendorsEvent

public void triggerUIActionShownVendorsEvent()

Method used to trigger a vendors shown event.

triggerUIActionPurposeChangedEvent

public void triggerUIActionPurposeChangedEvent()

Method used to trigger a purpose changed event.

triggerUIActionVendorChangedEvent

public void triggerUIActionVendorChangedEvent()

Method used to trigger a vendor changed event.

sendEvent

public void sendEvent(ApiEvent apiEvent)

Method used to send a single apiEvent.

Parameters:

apiEvent - apiEvent to be sent.

shouldSkipEvent

public boolean shouldSkipEvent(ApiEvent apiEvent)

Method used to determine if the current event should be skipped or not.

Parameters:

apiEvent - to be sent to API

Returns:

true if event will be skipped, false otherwise.

shouldEventBeSent

public static boolean shouldEventBeSent(java.lang.String userUUID,
                                        double samplingRate)

Method used to determine if the current event should be sent to API. To determine whether we should send API events for a given user ID, we will use the following rule: If the number represented in hexadecimal by the last two characters of the user ID, divided by 255, is lower than or equal to (<=) the sampling rate, then the user is a member of our sample and we should send the events to the API.

Parameters:

userUUID - - UUID of user

samplingRate - - sampling rate

Returns:

true if event will be sent, false otherwise.

onSuccess

public void onSuccess(org.json.JSONObject jsonObject)

Specified by:

onSuccess in interface HttpResponseJSONListener

onFailure

public void onFailure(org.json.JSONObject jsonObject)

Specified by:

onFailure in interface HttpResponseJSONListener

onBackOnline

public void onBackOnline()

Description copied from interface: ConnectivityListener

Method called once the device is back online.

Specified by:

onBackOnline in interface ConnectivityListener