AATKit/com.intentsoftware.addapptr/ManagedConsent

ManagedConsent

class ManagedConsent(cmp: CMP, context: Context, delegate: ManagedConsent.ManagedConsentDelegate, showIfNeededSetting: ManagedConsent.ShowIfNeededSetting) : ConsentImplementation, Consent, CMPDelegate

Will present a dialog for the users to grant or withhold their consent.

Parameters

cmp

Instance of CMP to be used.

context

The Context of your application.

delegate

The ManagedConsentDelegate instance. Must not be null.

showIfNeededSetting

ShowIfNeededSetting setting how the showIfNeeded method should behave. ShowIfNeededSetting.SERVER_SIDE_CONTROL by default.

Constructors

ManagedConsent

constructor(cmp: CMP, context: Context, delegate: ManagedConsent.ManagedConsentDelegate)

Will present a dialog for the users to grant or withhold their consent.

constructor(cmp: CMP, context: Context, delegate: ManagedConsent.ManagedConsentDelegate, showIfNeededSetting: ManagedConsent.ShowIfNeededSetting)

Types

ManagedConsentDelegate

interface ManagedConsentDelegate

Notifies about the need to show the consent dialog.

ManagedConsentState

enum ManagedConsentState : Enum<ManagedConsent.ManagedConsentState>

Possible states of consent given by the user.

ShowIfNeededSetting

enum ShowIfNeededSetting : Enum<ManagedConsent.ShowIfNeededSetting>

Inherited properties

ccpaConsentString

var ccpaConsentString: String?

consentStateForReporting

val consentStateForReporting: Boolean

consentStringVersion

var consentStringVersion: ConsentImplementation.ConsentStringVersion?

debugInfo

val debugInfo: String

gdprConsentString

var gdprConsentString: String?

Functions

CMPNeedsUI

open override fun CMPNeedsUI()

didShowCMP

open override fun didShowCMP()

editConsent

fun editConsent(activity: Activity)

Presents the consent screen, allowing the user to change consent settings.

onCMPFailedToLoad

open override fun onCMPFailedToLoad(error: String)

onCMPFailedToShow

open override fun onCMPFailedToShow(error: String)

onConsentUpdated

open override fun onConsentUpdated(state: ManagedConsent.ManagedConsentState)

reload

fun reload(activity: Activity)

Tells the CMP to reload. You can call this method for example after receiving ManagedConsentDelegate.managedConsentCMPFailedToLoad callback.

showIfNeeded

fun showIfNeeded(activity: Activity)

Presents the consent screen ONLY if it is required by the used CMP (i.e. no user consent has been set yet).

showIfNeededOrRejected

fun showIfNeededOrRejected(daysAgo: Int, activity: Activity)

Presents the consent screen if it is required by the used CMP (i.e. no user consent has been set yet) or the user has rejected the consent.

toString

open override fun toString(): String

Inherited functions

addApptrHasConsentForAdId

fun addApptrHasConsentForAdId(): Boolean

addApptrHasConsentForAppSetId

fun addApptrHasConsentForAppSetId(): Boolean

addApptrHasConsentForLocation

fun addApptrHasConsentForLocation(): Boolean

hasCCPAConsent

fun hasCCPAConsent(): Boolean

readConsentStringFromSharedPreferences

fun readConsentStringFromSharedPreferences(context: Context)

reconfigure

fun reconfigure(context: Context)

setNoConsentNetworkStopSet

abstract fun setNoConsentNetworkStopSet(stopSet: Set<AdNetwork>?)

Sets to set the networks that will not be requested if they do not have the TCF2 consent. Only works if TCF2 compliant CMP is used.