Ecouter les évènements du SDK

Notre SDK envoie des évènements quand l'utilisateur interagit avec notre widget ou notre API

Pour éxecuter des actions personnalisées en fonction du cycle de vie de notre widget sur votre site, vous pouvez écouter les différents évènements qu'il envoie.
Evènements envoyés
ready
Envoyé quand le SDK Axeptio est chargé et initialisé.
consent:saved
Cet évènement est envoyé quand un consentement a été correctement envoyé et géré par l'API d'Axeptio. Le payload contient les préférences de l'utilisateur et les métadonnées décrivant le consentement.
cookies:complete
Un évènement envoyé par le widget des cookies quand nous savons quels vendeurs ont étés acceptés ou non. Vu que cet évènement est utilisé pour déclencher le chargement des scripts sélectionnés, cet évènement cookies:complete est envoyé même sans l'apparition du widget. Si nous trouvons des préférences dans les cookies du navigateur, nous envoyons l'évènement et empêchont l'apparition du widget
L'évènement cookies:complete est envoyé avec un payload contenant les choix de l'utilisateur
axeptio.on('cookies:complete', function(choices){
    if(choices.google_analytics){
        startGoogleAnalytics();
    }
}
cookies:step:change
Quand le widget des cookies est ouvert, cet évènement sera envoyé quand l'utilisateur passe d'un écran du widget à l'autre. Le payload est un objet contenant une propriété nommée index qui est l'index entier de l'étape dans le tableau des étapes. Il contient aussi la définition de l'étape (identifiant, titre, description, liste des vendeurs, etc.)
cookies:step.startTimeout
Envoyé quand une étape "info" démarre son compte à rebours avant de de passer à l'étape suivante
cookies:step.stopTimeout
Envoyé quand une étape "info" finit son compte à rebours, ou que l'utilisateur change d'écran
token:update
Le token utilisateur peut être mis à jour durant la session, par example quand le token est basé sur champ de formulaire ou déduit d'une requête AJAX. Cet évènement est envoyé quand le token contenu par le SDK est modifié.
overlayOpenWidget
Est utilisé pour déclencher l'apparition du bouton Axeptio.
overlayOpenCookies
Est utilisé pour déclencher l'apparition du widget des cookies Axeptio.
showProcessingDetails
Envoyé quand l'overlay est ouvert avec les donnés d'un consentement contractuel ou marketing. Peut être utilisé pour déclencher l'apparition de l'overlay Axeptio
close
Envoyé quand l'overlay est fermé. Peut être utilisé pour déclencher l'apparition de l'overlay Axeptio
Derrière le masque
Notre SDK est une forme de classe EventEmitter qui possède trois méthodes:
EventEmitter.on
on(event:String, handler:Function, options = {replay: true, once: false})
Le paramètre event accepte des caractères génériques * pour écouter plus évènements à la fois. Par exemple, vous pouvez passer cookies:* et ainsi recevoir tous les évènements liés à notre widget de cookie.
Le paramètre handler est une fonction appelée quand l'émetteur d'évènement envoie un évènement correspondant au paramètre event . La fonction handler recevra deux arguments:
1. Le payload rattaché à l'évènement
2.Le nom exact de l'évènement envoyé
Le paramètre optionnel options est un objet composé de :
1.replay: Si replay est true, les évènements passés avant que le gestionnaire d'évènement ne soit en place appelleront la fonction handler directement. S'il est false, uniquement les évènements suivants déclencheront la fonction.
2.once: Si once est true , la fonction handler ne sera appelé qu'une fois. Une fois appelée, même un évènement correspondant au paramètre event ne rappellera pas la fonction.
EventEmitter.off
off(event:String, handler:Function = undefined)
La méthode off va retirer le handler spécifié pour l'event spécifié, s'il est spécifié comme second paramètre de la fonction.  Si handler n'est pas spécifié, chaque fonction handler écoutant le ou les event seront retirés du tableau des handler.
EventEmitter.trigger
trigger(event:String, payload:Object = undefined)
Cette méthode est utilisée pour déclencher un évènement, et permet aussi d'envoyer des des données mixtes en spécifiant un apramètre payload.

Intégration technique - Précédent

SDK Javascript d'Axeptio

Réutiliser un consentement

Dernière mise à jour 2yr ago