Onze SDK verzendt gebeurtenissen wanneer een gebruiker met onze banners of onze API interageert.

Om aangepaste acties uit te voeren op basis van de levenscyclus van onze banner op uw site, kunt u naar de verschillende gebeurtenissen die deze verzendt luisteren.

Verzonden gebeurtenissen

ready

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

consent:saved

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

cookies:complete

Gebeurtenis verzonden door de Cookie-service wanneer Axeptio op de hoogte is 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 verzonden zelfs als de cookiebanner niet wordt weergegeven. Als Axeptio voorkeuren vindt in de browsercookies, verzendt de SDK de gebeurtenis en blokkeert de weergave van de banner.

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

cookies:step:change

Wanneer de cookiebanner open is, wordt deze gebeurtenis verzonden 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 stappenarray (steps) vertegenwoordigt. Het bevat ook de definitie van de stap (identifier, titel, beschrijving, lijst met providers, enz.).

cookies:step.startTimeout

Verzonden wanneer een stap van het type "Informatievenster" zijn aftelling start voordat deze naar de volgende stap gaat.

cookies:step.stopTimeout

Verzonden wanneer een stap van het type "Informatievenster" het einde van zijn aftelling bereikt 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 van een AJAX-aanroep. Deze gebeurtenis wordt verzonden wanneer het token in de SDK wordt bijgewerkt.

overlayOpenWidget

Maakt het mogelijk om het Axeptio-knopcje te laten verschijnen.

overlayOpenCookies

Maakt het mogelijk om de Axeptio-cookiebanner te laten verschijnen.

showProcessingDetails

Verzonden wanneer het overlay wordt geopend met details van een gegevensverwerking. Kan imperatiëf worden gebruikt om het Axeptio-overlay weer te geven.

close

Geactiveerd wanneer het overlay wordt gesloten. Kan imperatief worden gebruikt om het te laten verschijnen.

Onder de motorkap

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

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 cookiebanner-gerelateerde gebeurtenissen te ontvangen.
De parameter handler is een functie die wordt aangeroepen wanneer de gebeurtenisemitter een gebeurtenis verzendt 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 verzonden gebeurtenis
De parameter options, optioneel, is een object dat uit de volgende vlaggen bestaat:
- Als replay de waarde true heeft, zullen voorbije gebeurtenissen die zijn verzonden voordat de handler is gedefinieerd, ertoe leiden dat de handler onmiddellijk wordt aangeroepen. Als deze false heeft, activeren alleen toekomstige gebeurtenissen een aanroep van de handler.
- Als once de waarde true heeft, wordt de handler slechts eenmaal aangeroepen. Nadat deze is aangeroepen, zal geen ander gebeurtenis die aan het patroon voldoet deze opnieuw activeren.

EventEmitter.off

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

De methode off meldt de opgegeven handler af 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, uit de handlerarray verwijderd.

EventEmitter.trigger

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

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

SDK-gebeurtenissen beluisteren