JavaScript API

addConsent

Über die Funktion kann die Einwilligung zu einer Cookie Gruppe und einem Cookie in das Cookie des Besuchers gespeichert werden.

Aufruf

window.BorlabsCookie.addConsent(cookieGroup, cookie);

Argumente

Argument	Type	Beschreibung
cookieGroup	String	ID der Cookie Gruppe, Pflichtangabe.
cookie	String	ID des Cookies, optional.

callWhenLoaded

Die Methode dient dazu, Code auszuführen, der abhängig von externen JavaScript ist, dass bei der Entsperrung verzögert geladen wird. Damit es nicht zu Fehlern kommt, da das notwendige JavaScript noch nicht verfügbar, gibt es diese Hilfsfunktion, die prüft, ob das gegeben obj vorhanden ist, bevor es den Code ausführt, der in Form einer Funktion übergeben wird.

Aufruf

window.BorlabsCookie.callWhenLoaded(obj, callback);

Beispiel für Facebook

window.BorlabsCookie.callWhenLoaded("fbq", function () {
fbq("track", "AddToCart");
});

Argumente

Argument	Type	Beschreibung
obj	String	Name des Objekts, das benötigt wird, z. B. fbq für das Facebook Framework.
callback	Funktion	Funktion die aufgerufen werden soll, wenn obj vorhanden ist.

checkCookieConsent

Prüft ob der Besucher für das übergebene Cookie seine Einwilligung erteilt hat.

Aufruf

window.BorlabsCookie.checkCookieConsent(cookie);

Argumente

Argument	Type	Beschreibung
cookie	String	ID des Cookies.

checkCookieGroupConsent

Prüft ob der Besucher für die übergebene Cookie Gruppe seine Einwilligung erteilt hat.

Aufruf

window.BorlabsCookie.checkCookieGroupConsent(cookieGroup);

Argumente

deleteCookie

Löscht ein Cookie anhand des Cookie Namens. Durch den Parameter imprecise (true oder false) können auch Cookies gelöscht werden, deren Name weitere individuelle Zeichen enthält z. B. meinCookie_x13cy14s.

Aufruf

window.BorlabsCookie.deleteCookie(cookieName, domain, imprecise);

Argumente

Argument	Type	Beschreibung
cookieName	String	ID des Cookies.
domain	String	Domain des Cookies. Es können keine Cookies von fremden Hosts gelöscht werden. Beim Wert null oder false, wird die Domain aus den Einstellungen genutzt.
imprecise	Bool	true: Löscht Cookies, in deren vollständigem Namen der unter cookieName eingegebene Wert vorkommt. Bsp: cookieName meinCookie + imprecise true = Cookie meinCookie_x13cy14s wird gelöscht.

getCookie

Gibt das Objekt des Borlabs Cookie Cookies zurück.

Aufruf

window.BorlabsCookie.getCookie();

hideCookieBox

Blendet die Cookie Box aus, falls sie gerade angezeigt wird.

Aufruf

window.BorlabsCookie.hideCookieBox();

initConsentHistoryTable

Durch den Aufruf der Funktion wird im Element, dass das Data-Attribut data-borlabs-cookie-consent-history enthält, die Tabelle der Cookie Einwilligungen geladen.

Aufruf

window.BorlabsCookie.initConsentHistoryTable();

initSwitchConsentButtonStatus

Durch den Aufruf kann der Status der Switch-Consent-Buttons aktualisiert werden. Ein Anwendungsfall ist z. B. wenn nachträglich via AJAX Elemente geladen wurden, die Switch-Consent-Buttons anzeigen.

Aufruf

window.BorlabsCookie.initSwitchConsentButtonStatus();

openCookiePreference

Öffnet die Cookie Einstellungen. Die Funktion kann direkt aufgerufen oder an ein Event gebunden werden.

Aufruf

window.BorlabsCookie.openCookiePreference();
jQuery(".myButton").on("click", window.BorlabsCookie.openCookiePreference);

optOutDone

Bei Verwendung des asynchronen Opt-outs muss nach erfolgter Ausführung Borlabs Cookie mitgeteilt werden, dass der Opt-out abgeschlossen ist.

Aufruf

window.BorlabsCookie.optOutDone(cookie);

Argumente

Argument	Type	Beschreibung
cookie	String	ID des Cookies.

removeConsent

Entfernt die Einwilligung zu einer Cookie Gruppe oder zu einem Cookie.

Aufruf

window.BorlabsCookie.removeConsent(cookieGroup, cookie);

Argumente

Argument	Type	Beschreibung
cookieGroup	String	ID der Cookie Gruppe, Pflichtangabe.
cookie	String	ID des Cookies, optional.

showCookieBox

Zeigt die Cookie Box an. Die Funktion kann direkt aufgerufen oder an ein Event gebunden werden.

Aufruf

window.BorlabsCookie.showCookieBox();
jQuery(".myButton").on("click", window.BorlabsCookie.showCookieBox);

Argumente

Argument	Type	Beschreibung
withDelay	Bool	true: der Aufruf wird um 1 Sekunde verzögert.

unblockContentId

Entsperrt alle Inhalte eines Content Blockers.

Aufruf

window.BorlabsCookie.unblockContentId(contentBlockerId);

Argumente

Argument	Type	Beschreibung
contentBlockerId	String	ID des Content Blockers.

unblockScriptBlockerId

Entsperrt alle Inhalte eines Script Blockers

Aufruf

window.BorlabsCookie.unblockScriptBlockerId(scriptBlockerId);

Argumente

Argument	Type	Beschreibung
scriptBlockerId	String	ID des Script Blockers.

unblockScriptBlockerJSHandle

Entsperrt das JavaScript anhand des Handles.

Aufruf

window.BorlabsCookie.unblockScriptBlockerJSHandle(jsHandle);

Argumente

Argument	Type	Beschreibung
jsHandle	String	Handle des JavaScripts.