Migrate from Old SDK

Deleting the old repository

Formerly we had:

maven { 
  url = uri("https://artifactory.datalf.chat/artifactory/app-consent-v2-release")
}

From now on, it is necessary to:

maven { 
  url = uri("https://artifactory.datalf.chat/artifactory/appconsent")
}

Implementation change

Previously, we had:

dependencies { 
    implementation("com.sfbx.appconsent:appconsent-ui-v3:X.Y.Z")
}

From now on, you must:

dependencies { 
    implementation("io.sfbx.appconsent:unifiedsdk:$currentVersion")
}

Change in integration

Imports

Before we had:

import com.sfbx.appconsentv3.*

Now the imports are as follows:

import io.sfbx.appconsent.unifiedsdk.*

Initializing the SDK

This is very similar to the old SDK (like many other libraries).

Before, we had:

1. Initialization of the SDK

2. Registration of callbacks to intercept the user's response

3. Attempt to display the CMP

4. Deletion of callbacks regardless of the result

AppConsentSDK.initialize(
  appKey = "YOUR_APP_KEY"
) { appConsentInitialized ->
  appConsentInitialized.setOnPresentNoticeListener(object : OnPresentNoticeListener {
    override fun presentConsentError(error: Throwable?) {
      appConsentInitialized.setOnPresentNoticeListener(null)
    }

     override fun presentConsentGiven() {
       appConsentInitialized.setOnPresentNoticeListener(null)
     }
  })
  
  if(false == appConsentInitialized.tryToDisplayNoticeFromUiContext(uiContext = this@MainActivity, force = false)) {
    appConsentInitialized.setOnPresentNoticeListener(null)
  }
}

Now :

1. Initializing the SDK

2. Display request (the display & consent response is returned directly in the method callbacks)

SFBX.initialize(
  context = [email protected],
  configuration = Configuration(appkey = "YOUR-APP-KEY"),
  onCmpReady = { appconsent ->
    appconsent.presentNotice(
      context = context,
      onCmpDisplayed = { },
      onCmpNotDisplayed = { },
      onCmpClosed = { },
    )},
  onCmpOnError = { },
)

Displaying the consent screen to your users

This allows your users to view their consent and modify it if necessary.

Before, we had:

AppConsentSDK.getInstance()
  ?.setOnPresentNoticeListener(object : OnPresentNoticeListener {
    override fun presentConsentError(error: Throwable?) {
      AppConsentSDK.getInstance()?.setOnPresentNoticeListener(null)
    }

    override fun presentConsentGiven() {
      AppConsentSDK.getInstance()?.setOnPresentNoticeListener(null)
    }
  })

  val isCmpDisplayed =
    AppConsentSDK.getInstance()?.tryToDisplayNotice(force = true) ?: false
  if (false == isCmpDisplayed) {
    AppConsentSDK.getInstance()?.setOnPresentNoticeListener(null)
  }

Now :

SFBX.getInstance()?.displayLayer2(context,
  onCmpDisplayed = { },
  onCmpNotDisplayed = { },
  onCmpClosed = { },
)