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

@Deprecated(message = "The name of this method is not entirely clear on its execution.To avoid a breaking change, this one has been deprecated and another one has been implemented that executes the same functionality.This method will be removed in future releases", replaceWith = @ReplaceWith(imports = {}, expression = "this.isAllConsentablesAllowed"), level = DeprecationLevel.WARNING)

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

@Deprecated(message = "The name of this method is not entirely clear on its execution.To avoid a breaking change, this one has been deprecated and another one has been implemented that executes the same functionality.This method will be removed in future releases", replaceWith = @ReplaceWith(imports = {}, expression = "this.isAllVendorsAllowed"), level = DeprecationLevel.WARNING)

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

forceInit

@Deprecated(message = "This method will evolve over the next few releases, and is likely to be either discontinued or modified.")

public final static Unit ~~forceInit~~()

WARNING! Please do not use this method unless our CMP logs webview error during your development phase.

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

getGCMConsentStatus

public GCMStatus getGCMConsentStatus()

This method shows the current status of GCMv2 (Google Consent Mode V2).

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.

isAllConsentablesAllowed

public Boolean isAllConsentablesAllowed()

Finds out whether all consent items have been allowed by the user. If, on the other hand, consent items are present, then processing will be carried out and false will be returned if at least one of them is not allowed.

isAllConsentablesDisallowed

public Boolean isAllConsentablesDisallowed()

Finds out whether all consent items have been disallowed by the user. If, on the other hand, consent items are present, then processing will be carried out and false will be returned if at least one of them is not disallowed.

isAllStacksAllowed

public Boolean isAllStacksAllowed()

Finds out whether all stacks have been allowed by the user. If, on the other hand, stacks are present, then processing will be carried out and false will be returned if at least one of them is not allowed.

isAllStacksDisallowed

public Boolean isAllStacksDisallowed()

Finds out whether all stacks have been disallowed by the user. If, on the other hand, stacks are present, then processing will be carried out and false will be returned if at least one of them is not disallowed.

isAllVendorsAllowed

public Boolean isAllVendorsAllowed()

Finds out whether all vendors have been allowed by the user. If, on the other hand, vendors are present, then processing will be carried out and false will be returned if at least one of them is not allowed.

isAllVendorsDisallowed

public Boolean isAllVendorsDisallowed()

Finds out whether all vendors have been disallowed by the user. If, on the other hand, vendors are present, then processing will be carried out and false will be returned if at least one of them is not disallowed.

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.

isSdkInitializing

public final static Boolean isSdkInitializing()

Shows whether the CMP is being initialized

isSdkOnError

@Deprecated(message = "This method will evolve over the next few releases, and is likely to be either discontinued or modified")

public final static Boolean ~~isSdkOnError~~()

WARNING! Please do not use this method unless our CMP logs webview error during your development phase.

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.

isUserAcceptAll

public Boolean isUserAcceptAll()

This method lets you know the status of your users' consent.

isUserDenyAll

public Boolean isUserDenyAll()

This method lets you know the status of your users' consent.

loadContext

public final static Unit loadContext(Context context)

WARNING! Please do not use this method unless our CMP stipulates it in error logs during your development phase.

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

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

This method lets you know the status of your users' consent.

vendorAllowed

public Boolean vendorAllowed(Integer vendorIabId)

Checks whether a IAB Vendor has been authorized