Migration depuis l'ancien SDK

Suppression de l'ancien repository

Anciennement nous avions :

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

Dorénavant il faut :

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

Changement d'implémentation

Anciennement nous avions :

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

Dorénavant il faut :

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

Changement de l'intégration

Les imports

Avant nous avions:

import com.sfbx.appconsentv3.*

Maintenant les imports sont les suivants:

import io.sfbx.appconsent.unifiedsdk.*

L'initialisation du SDK

Celui-ci se rapproche fortement de l'ancien SDK (comme beaucoup d'autres librairies)

Avant nous avions :

1. Initialisation du SDK

2. Enregistrement des callbacks permettant d'intercepté la réponse de l'utilisateur

3. Tentative d'affichage de la CMP

4. Supression des callbacks quelque soit le résultat

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)
  }
}

Maintenant :

1. Initialisation du SDK

2. Demande d'affichage (la réponse d'affichage & de consentement est directement renvoyé dans les callbacks de la méthode)

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

Affichage de l'écran de consentement à vos utilisateurs

Cela permet à vos utilisateurs de voir leur consentement et de pouvoir le modifier au besoin

Avant nous avions :

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)
  }

Maintenant :

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