Naar de hoofdinhoud

SDK-gebeurtenissen beluisteren

Geschreven door Alexandre Dias Da Silva

Onze SDK zendt gebeurtenissen uit wanneer een gebruiker interactie heeft met onze banners of onze API.

Voor het uitvoeren van aangepaste acties op basis van de levenscyclus van onze banner op uw website, kunt u naar de verschillende gebeurtenissen die deze uitzendt, luisteren.

Uitgezonden gebeurtenissen

ready

Uitgezonden wanneer de Axeptio SDK is geladen en geïnitialiseerd.

consent:saved

Deze gebeurtenis wordt uitgezonden wanneer een toestemming is verzonden en succesvol verwerkt door de Axeptio API. De payload bevat de voorkeuren van de gebruiker en metagegevens die de toestemming beschrijven.

cookies:complete

Gebeurtenis uitgezonden door de Cookies-service wanneer Axeptio kennis heeft van providers die zijn geaccepteerd of geweigerd. Omdat deze gebeurtenis wordt gebruikt om de uitvoering van geselecteerde providers en scripts te activeren, wordt cookies:complete uitgezonden, zelfs als de cookiebanner niet wordt weergegeven. Als Axeptio voorkeuren in de browsercookies vindt, zendt de SDK de gebeurtenis uit en blokkeert de weergave van de banner.

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

cookies:step:change

Wanneer de cookiebanner is geopend, wordt deze gebeurtenis uitgezonden wanneer een gebruiker van stap verandert. De payload is een object dat een eigenschap bevat met de naam index die de index (als geheel getal) van de stap (step) in de reeks stappen (steps) aangeeft. Het bevat ook de definitie van de stap (identificatie, titel, beschrijving, lijst met providers, enz.).

cookies:step.startTimeout

Uitgezonden wanneer een stap van het type "Informatievenster" zijn aftelling start voordat naar de volgende stap wordt gegaan.

cookies:step.stopTimeout

Uitgezonden wanneer een stap van het type "Informatievenster" aan het eind van zijn aftelling arriveert of door de gebruiker wordt gestopt.

token:update

Het gebruikerstoken kan tijdens de sessie worden bijgewerkt, bijvoorbeeld wanneer het is gebaseerd op een invoerveld of afgeleid is van een AJAX-aanroep. Deze gebeurtenis wordt uitgezonden wanneer het token in de SDK wordt bijgewerkt.

overlayOpenWidget

Stelt u in staat om de Axeptio-knop expliciet te laten verschijnen.

overlayOpenCookies

Stelt u in staat om de Axeptio-cookiebanner expliciet te laten verschijnen.

showProcessingDetails

Uitgezonden wanneer de overlay is geopend met details van een gegevensverwerking. Kan expliciet worden gebruikt om de Axeptio-overlay weer te geven.

close

Geactiveerd wanneer de overlay is gesloten. Kan expliciet worden gebruikt om de weergave ervan te activeren.

Onder de motorkap

Onze SDK implementeert een aangepaste EventEmitter-klasse die drie methoden beschikbaar stelt:

EventEmitter.on

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

  • De parameter event accepteert wildcards * om naar meerdere gebeurtenissen tegelijk te luisteren. U kunt bijvoorbeeld cookies:* doorgeven om alle ereignissen met betrekking tot de cookiebanner te ontvangen.

  • De parameter handler is een functie die wordt aangeroepen wanneer de ereignisemitter een gebeurtenis uitzendt die overeenkomt met het patroon van de parameter event. De handler ontvangt twee argumenten :

    1. De payload die aan de gebeurtenis is gekoppeld

    2. De exacte naam van de uitgestraalde événement

  • De parameter options, optioneel, is een object samengesteld uit de volgende vlaggen :

    • Als replay de waarde true heeft, zullen voorbij ereignisse die zijn uitgezonden voordat de handler werd bepaald, ertoe leiden dat de handler onmiddellijk wordt aangeroepen. Als deze de waarde false heeft, zullen alleen toekomstige ereignisse een aanroep van de handler activeren.

    • Als once de waarde true heeft, wordt de handler slechts eenmaal aangeroepen. Nadat deze is aangeroepen, zal geen ander ereignis dat overeenkomt met het patroon dit opnieuw activeren.

EventEmitter.off

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

De methode off zegt de opgegeven handler op voor de opgegeven event, als deze als tweede parameter van de functie is gedefinieerd. Als handler niet is gedefinieerd, wordt elke handler die naar het exacte patroon event luistert, verwijderd uit de handlers-array.

EventEmitter.trigger

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

Deze methode wordt gebruikt om een ereignis te activeren en gegevens van elk type via de parameter payload door te geven.

Was dit een antwoord op uw vraag?