Expertenfunktion - Callback

Mit den Codeausschnitten, wie du sie im Folgenden findest, kannst du deinen Clickskeks auf Quellcode-Ebene zusätzlich anpassen und Änderungen vornehmen.

Allgemein

Alle Funktionen können direkt von der Clickskeks Variable aufgerufen werden. Die Clickskeks Variable ist allgemein unter window.Clickskeks verfügbar, sobald das Clickskeks-Script geladen wurde. Zum Testen kann

console.log('Clickskeks Version', window.Clickskeks.getInfo());

aufgerufen werden.

Roboter mit Checkliste und Mousecursor in den Händen

Callback für Änderungen der Userzustimmung

Es können Callbacks gesetzt werden, um Änderungen der Userzustimmung zu bekommen.

Callbacks können entweder hinzugefügt und bei allen Änderungen des Users sofort mit den aktuellen Einstellungen ausgeführt werden oder nur hinzugefügt und bei allen Änderungen des Users aufgerufen werden.

Dem Callback wird ein Object (Record<string, Boolean|Record<string,Record<string,boolean>>>) als Parameter übergeben, wobei der Key immer der Name der Kategorie ist.

Wenn in einer Kategorie einzelne Cookies angenommen worden sind, werden diese in einem Object (Record<string,true>) dargestellt. Der Key ist dabei immer die Identifikation des Cookies. In diesem Object landen nur Cookies, die der User akzeptiert hat. Wenn eine ganze Kategorie angenommen wurde, ist es ein Boolean.

Beispiel:

{
    "necessary": true,
    "statistics": {
        "YSC|/|.youtube.com": true,
    },
    "preference": false,
    "marketing": true,
    "unclassified": true
}

Funktionen für Callbacks

Zum hinzufügen wird addAllowedConfigChangedCallback (allowedConfigChangedCallback, callbackWithCurrentData) verwendet

allowedConfigChangedCallback ist der Callback.

callbackWithCurrentData bestimmt, ob der Callback initial einmal aufgerufen wird mit den aktuellen Einstellungen.

Folgender Code dient als Beispiel:

 

const clickskeksAllowedConfigCallback = function( allowedConfig ) {
         console.log('allowedConfig', allowedConfig );
     };
window.Clickskeks.addAllowedConfigChangedCallback(clickskeksAllowedConfigCallback , true);

Falls es nur einen Callback geben soll, kann man auch einen einzelnen setzen. Damit werden durch setAllowedConfigChangedCallback(allowedConfigChangedCallback, callbackWithCurrentData) alle anderen Callbacks ersetzt.
allowedConfigChangedCallback ist der Callback.
callbackWithCurrentData bestimmt, ob der Callback initial einmal aufgerufen wird mit den aktuellen Einstellungen.

Als Beispiel:

window.Clickskeks.setAllowedConfigChangedCallback(function(allowedConfig) {
   console.log('allowedConfig', allowedConfig);
}, true)

Mit der Funktion callbackWithCurrentData(allowedConfigChangedCallback) können Callbacks wieder entfernt werden.

Als Beispiel wir der Callback von Callback hinzufügen, entfernt:

window.Clickskeks.removeAllowedConfigChangedCallback(clickskeksAllowedConfigCallback);

Mit der Funktion removeAllAllowedConfigChangedCallbacks() kannst du alle Callbacks entfernen.

Als Beispiel:

window.Clickskeks.removeAllAllowedConfigChangedCallbacks();

Aktuelle Userzustimmung

Mit der Funktion getCurrentAllowedConfig() können die aktuellen Userzustimmungen abgerufen werden. Es wird dasselbe Objekt zurückgegeben, wie dem Callback für Änderungen der Userzustimmung übergeben wird.

Aufruf Beispiel:

window.Clickskeks.getCurrentAllowedConfig();

Return Beispiel:

{
    "necessary": true,
    "statistics": {
        "YSC|/|.youtube.com": true,
    },
    "preference": false,
    "marketing": true,
    "unclassified": true
}

Popup aufrufen

Das Clickskeks Popup kann auch mit der Funktion showConsent() aufgerufen werden.

Als Beispiel:

window.Clickskeks.showConsent();

Kategorien

Es können bestimmte Kategorien über die Funktion acceptCategories(categories) akzeptiert werden. categories ist ein string[] und es werden die Kategorien erwartet, die akzeptiert werden sollen. Diese wird z. B. bei dem iFrame Pop-up eingesetzt, um direkt zustimmen zu können.

Als Beispiel:

window.Clickskeks.acceptCategories(['preference', 'statistics']);

Mit der Funktion optOut() kann man alle Kategorien zurücksetzen, es gilt dann nur noch necessary als akzeptiert.

Als Beispiel:

window.Clickskeks.optOut();

Disclaimer

Es kann der Disclaimer Text mit der Funktion buildDisclaimer(elementID) in das Element mit der übergebenen ID hinein gerendert werden.

Als Beispiel:

<div id='clickskeks-disclaimer'></div>

 

window.Clickskeks.buildDisclaimer('clickskeks-disclaimer');

Es kann der Disclaimer Text mit der Funktion buildDisclaimer(elementClass) in das Element mit der übergebenen Klasse hinein gerendert werden.

Als Beispiel:

<div class='clickskeks-disclaimer-class'></div>

 

window.Clickskeks.buildDisclaimer('clickskeks-disclaimer-class');