appconsent-ui-v3/com.sfbx.appconsentv3.ui/AppConsentSDK

AppConsentSDK

public final class AppConsentSDK extends AbstractAppConsent

CMP entry point. This allows you to initiate the CMP when you need it, and to check that it has been properly initialized and started.

Once this has been done, all you need to do is retrieve the com.sfbx.appconsentv3.AppConsent object from the onReady Callback into AppConsentSDK.initialize method and display the CMP to your users.

Functions

allConsentablesAllowed

public Boolean allConsentablesAllowed()

Finds out whether all consent items have been accepted by the user

allStacksAllowed

public Boolean allStacksAllowed()

Finds out whether all stack items have been accepted by the user

allVendorsAllowed

public Boolean allVendorsAllowed()

Finds out whether all vendor items have been accepted by the user

checkForUpdate

public Unit checkForUpdate(Function1<Boolean, Unit> onResult, Function1<Throwable, Unit> error)

Check if update is needed. For example, if your Notice has been updated If called prior to user giving a consent returns false

clearCache

public Unit clearCache()

Clear all applications SharedPreferences

clearConsent

public Unit clearConsent()

Clear user consent stored locally in applications SharedPreferences

consentableAllowed

public Boolean consentableAllowed(Integer iabId, ACConsentableType consentableType)

Checks whether a consent has been authorized

consentGiven

public Boolean consentGiven()

Check if user gave consent

extraConsentableAllowed

public Boolean extraConsentableAllowed(String extraId)

Checks whether an extra consent has been authorized

extraFloatingAllowed

public Boolean extraFloatingAllowed(String extraId)

Shows whether or not floating purpose has been authorized for a given extraId.

extraVendorAllowed

public Boolean extraVendorAllowed(String extraId)

Checks whether a Extra Vendor has been authorized

geolocationConsentGiven

public Boolean geolocationConsentGiven()

Check if user gave consent for Geolocation purpose

getAllConsentables

public List<ACExportConsentable> getAllConsentables(ACConsentStatus consentStatus)

Returns a list of consentables

getAllExtraVendors

public Map<String, Boolean> getAllExtraVendors(ACConsentStatus consentStatus)

Return a list of all Extra Vendors

getExternalIds

public Map<String, String> getExternalIds()

Retrieves the list of your external id's, previously stored

getInstance

public final static AppConsent getInstance()

Retrieves the CMP if it has been initialized

getUserId

public String getUserId()

Get the advertising id used by Appconsent. if isLimitedTrackingEnabled() == false, it will be Provider (Google, Amazon, etc.) ADID otherwise a random UUID

initialize

@JvmOverloads()

public final static Unit initialize(String appKey, Function1<AppConsent, Unit> onReady)

@JvmOverloads()

public final static Unit initialize(String appKey, ACConfiguration configuration, Function1<AppConsent, Unit> onReady)

The main method, which allows you to initialize AppConsent with a default configuration or a custom configuration ACConfiguration like theme AppConsentTheme or force the application of GRPD whatever the region for example or display CMP in full screen. By default, you will only need the appKey provided by the SFBX platform AND the callback onReady.

isFloatingNeedUpdate

public Boolean isFloatingNeedUpdate()

Find out if your Floating Purpose needs updating or not

isLimitedTrackingEnabled

public Boolean isLimitedTrackingEnabled()

Finds out whether or not the user has explicitly limited his or her advertising tracking

isSdkInitialized

public final static Boolean isSdkInitialized()

Find out whether the CMP has already been initialized, and if so, enable you to retrieve it and start/continue using it.

isSubjectToGDPR

public Boolean isSubjectToGDPR()

Return true if user is subject to GDPR. It depends on forceApplyGDPR into com.sfbx.appconsentv3.ui.model.ACConfiguration and phone's locale.

loadContext

@Deprecated(message = "Don't use this method! With the exception of a problem during sdk initialization if an error message indicates that the context is not loaded in the SDK.", level = DeprecationLevel.WARNING, replaceWith = @ReplaceWith(imports = {}, expression = "Automatic injection from the AppConsent provider."))

public final static Unit ~~loadContext~~(Context context)

Used by AppConsentContentProvider to inject Context automatically when the application is run.

save

public Unit save(Function1<Boolean, Unit> onResult, Function1<Throwable, Unit> onError)

Saves the current state of user selections made on the CMP to the server

saveExternalIds

@Deprecated(message = "Don't use it !", replaceWith = @ReplaceWith(imports = {}, expression = "externalIds"), level = DeprecationLevel.WARNING)

public Unit ~~saveExternalIds~~(Function0<Unit> success, Function1<Throwable, Unit> failed)

Send the external ids you have stored to the server. setExternalIds

saveFloatingPurposes

public Unit saveFloatingPurposes(Map<String, Boolean> floatingPurposes, Function0<Unit> success, Function1<Throwable, Unit> failed)

Send and save your floatingpurposes on the server.

setConsentableConsents

public Unit setConsentableConsents(Map<Integer, ACConsentStatus> consents, Function0<Unit> success, Function1<Throwable, Unit> error)

Defines the new status of consentables passed in parameter.

setExternalIds

public Unit setExternalIds(Map<String, String> externalIds)

Store a set of external id's to allow you to send them to the server later with the saveExternalIds method.

setExtraConsentableConsents

public Unit setExtraConsentableConsents(Map<String, ACConsentStatus> consents, Function0<Unit> success, Function1<Throwable, Unit> error)

Defines the new status of extra consentables passed in parameter.

setOnPresentGeolocationNoticeListener

public Unit setOnPresentGeolocationNoticeListener(OnPresentGeolocationNoticeListener onPresentGeolocationNoticeListener)

Set a listener to be notified when user has given his geolocation consent

setOnPresentNoticeListener

public Unit setOnPresentNoticeListener(OnPresentNoticeListener onPresentNoticeListener)

Set a listener to be notified when user has given his consent

stackAllowed

public Boolean stackAllowed(Integer stackId)

Checks whether a stack has been authorized

tryToDisplayGeolocationNotice

public Boolean tryToDisplayGeolocationNotice(Boolean force)

Try to display the Geolocation CMP; display is controlled by functional rules

tryToDisplayNotice

public Boolean tryToDisplayNotice(Boolean force)

Try to display the CMP; display is controlled by functional rules

userAcceptAll

public Boolean userAcceptAll()

Finds out whether all consent, stack, vendor items have been accepted by the user

vendorAllowed

public Boolean vendorAllowed(Integer vendorIabId)

Checks whether a IAB Vendor has been authorized