Écouter des événements du SDK

Notre SDK émet des événements quand un utilisateur interagit avec nos bandeaux ou notre API.

Pour exécuter des actions personnalisées basées sur le cycle de vie de notre bandeau sur votre site, vous pouvez écouter les différents événements qu’il émet.

Événements émis

ready

Émis quand le SDK Axeptio est chargé et initialisé.

consent:saved

Cet événement est émis lorsqu’un consentement a été envoyé avec succès et traité 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

Événement émis par le service Cookies quand Axeptio a connaissance des fournisseurs ayant été acceptés ou refusés. Cet événement étant utilisé pour déclencher l’exécution des fournisseurs sélectionnés et de scripts, cookies:complete est émis même si le bandeau cookies n’apparaît pas. Si Axeptio trouve des préférences dans les cookies du navigateur, le SDK émet l’événement et bloque l’affichage du bandeau.

axeptio.on("cookies:complete", function (choices) {
  if (choices.google_analytics) {
    startGoogleAnaytics();
  }
});

cookies:step:change

Quand le bandeau cookies est ouvert, cet événement est émis lorsqu’un utilisateur change d’étape. Le payload est un objet qui contient une propriété nommée index représentant l’index (sous forme d’entier) de l’étape (step) dans le tableau des étapes (steps). Il contient aussi la définition de l’étape (identifiant, titre, description, liste des fournisseurs, etc.).

cookies:step.startTimeout

Émis lorsqu’une étape de type “Écran d'information” démarre son compte à rebours avant de passer à l’étape suivante.

cookies:step.stopTimeout

Émis lorsqu’une étape de type “Écran d'information” atteint la fin de son compte à rebours ou est arrêtée par l’utilisateur.

token:update

Le token utilisateur peut être mis à jour pendant la session, par exemple lorsqu’il est basé sur un champ de saisie ou déduit d’un appel AJAX. Cet événement est émis quand le token contenu dans le SDK est mis à jour.

overlayOpenWidget

Permet de déclencher impérativement l’apparition du bouton Axeptio.

overlayOpenCookies

Permet de déclencher impérativement l’apparition du bandeau cookies Axeptio.

showProcessingDetails

Émis lorsque l’overlay est ouvert avec les détails d’un traitement de données. Peut être utilisé impérativement pour afficher l’overlay Axeptio.

close

Déclenché lorsque l’overlay est fermé. Peut être utilisé impérativement pour déclencher son apparition.

Sous le capot

Notre SDK implémente une classe personnalisée EventEmitter qui expose trois méthodes :

EventEmitter.on

on(event:String, handler:Function, options = {replay: true, once: false}) 

• La paramètre event accepte les wildcards * pour écouter plusieurs événements en même temps. Par exemple, vous pouvez passer cookies:* pour recevoir tous les événements liés au bandeau cookies.
• Le paramètre handler est une fonction qui est appelée quand l’émetteur de l’événement émet un événement correspondant au pattern du paramètre event. Le handler reçoit deux arguments :
  1. Le payload lié à l’événement
  2. Le nom exact de l’événement émis
• Le paramètre options, optionnel, est un object composé des flags suivants :
  • Si replay a pour valeur true, les événements passés qui ont été émis avant que le handler ne soit défini entraîneront l’appel du handler immédiatement. S’il a pour valeur false, seuls les événements futurs déclencheront un appel du handler.
  • Si once a pour valeur true, le handler sera appelé une seule fois. Une fois qu’il aura été appelé, aucun autre événement satisfaisant le pattern ne le déclenchera à nouveau.

EventEmitter.off

off(event:String, handler:Function = undefined)

La méthode off désabonne le handler spécifié pour l’event spécifié, s’il est défini en tant que deuxième paramètre de la fonction. Si handler n’est pas défini, chaque handler écoutant le pattern exact event sera supprimé du tableau de handlers.

EventEmitter.trigger

trigger(event:String, payload:Object = undefined)

Cette méthode est utilisée pour déclencher un événement et transmettre des données de tout type via le paramètre payload.