Javascript-API

Klaro bietet eine kleine, aber leistungsstarke Javascript-API, mit der Sie die Zustimmung aus Ihren eigenen Anwendungen heraus steuern und überwachen können. Wenn die API als normales Skript geladen wird, kann sie über das globale Projekt klaro aufgerufen werden. Sie können Klaro auch als Modul importieren, um es innerhalb Ihres Node.js-Projekts zu verwenden. Um mehr darüber zu erfahren, werfen Sie einen Blick auf unser Beispiel auf Github.

klaro

Wenn Sie Klaro als reguläres Skript auf einer Website laden, wird eine globale Variable klaro erstellt, die die öffentliche Klaro API offenlegt. In den folgenden Abschnitten wird jede Funktion dieser API beschrieben.

klaro.show(config, modal)

Zeigt den Zustimmungshinweis für die angegebene Konfiguration an. Wenn config undefined ist, lädt Klaro die Konfigurationsvariable, die durch das Attribut data-config des Klaro-Tags script definiert ist. Wenn auch diese nicht definiert ist, wird auf klaroConfig zurückgegriffen.

klaro.version()

Gibt die Klaro-Version zurück. Meistens nützlich für Debugging-Zwecke.

klaro.getManager(config)

Liefert die ConsentManager Instanz für die angegebene Konfiguration zurück. Der Parameter config wird genauso behandelt wie bei der show Funktion. Wenn kein Zustimmungsmanager für die angegebene Konfiguration existiert, wird er erstellt. Wenn einer existiert, gibt die Funktion immer dieselbe Instanz zurück, so dass es sicher ist, die Funktion mehrfach oder aus verschiedenen Kontexten aufzurufen.

klaro.resetManagers()

Löscht alle Zustimmungsbeauftragte.

klaro.initialize()

Initialisiert Klaro: Wenn der Benutzer noch keine Einverständniserklärung abgegeben hat, wird die Einverständniserklärung (oder ein modales Fenster, je nach Ihrer Konfiguration) angezeigt. Die Funktion hat keine Wirkung, wenn das Attribut data-no-auto-load im Klaro-Skript-Tag auf true gesetzt ist.

klaro.render(config, opts)

Rendert die Klaro-Benutzeroberfläche. Wenn keine config angegeben wird, hat die Funktion keine Wirkung. Optionen ist eine Karte mit Optionen: Wenn opts.show gleich true ist, wird der Hinweis auf die Einwilligung (wenn der Benutzer keine Einwilligungseinstellungen vorgenommen hat und das Modal nicht durch die Konfiguration erzwungen wird) oder das Einwilligungsmodal (wenn der Benutzer bereits Einwilligungseinstellungen vorgenommen hat) angezeigt. Wenn opts.modal auf true steht, wird das Modal immer anstelle des Hinweises angezeigt, auch wenn der Benutzer keine Einwilligungspräferenzen angegeben hat.

klaro.getConfigTranslations(config)

Gibt ein Javascript Map zurück, das die Übersetzungen für die angegebene config enthält.

klaro.language()

Ermittelt die Sprache der Benutzeroberfläche für Klaro. Verwendet entweder den Wert der globalen Variable lang oder die im Fenster oder HTML-Dokument definierte Sprache.

ConsentManager

Die Klasse ConsentManager verwaltet die Einwilligungsinformationen für Klaro. Sie können sie verwenden, um die Einwilligungseinstellungen anzuzeigen oder zu aktualisieren. Sie speichert die aktuellen Einwilligungsentscheidungen, die ein Benutzer in der Benutzeroberfläche getroffen hat, synchronisiert sie mit dem Speicher und wendet sie an, indem sie HTML-Elemente aktiviert oder deaktiviert und Cookies löscht.

get storageMethod()

Gibt die Speichermethode zurück, die für die Speicherung der Einwilligungsinformationen verwendet wird. Derzeit ist dies entweder cookie oder localStorage.

get storageName()

Gibt den Namen des Speichers zurück, der für die Speicherung der Einwilligungsinformationen verwendet wird. Für den Speicher cookie ist dies der Name des Cookies. Für den Speicher localStorage ist dies der Schlüssel des Speichers.

get cookieDomain()

Gibt die Domäne des Zustimmungs-Cookies für die Speicherung von cookie zurück.

get cookieExpiresAfterDays()

Gibt die Anzahl der Tage zurück, nach denen das Zustimmungs-Cookie abläuft.

get defaultConsents()

Gibt die Standardeinwilligungen für alle konfigurierten Anwendungen als Javascript-Objekt zurück.

watch(watcher)

Registrieren Sie einen neuen Beobachter. Ein Watcher muss eine Funktion update(obj, name, data) implementieren, die Informationen über Statusaktualisierungen vom Zustimmungsmanager erhält. Derzeit veröffentlicht der Zustimmungsmanager nur Ereignisse mit dem Namen consents, die den aktuellen Zustimmungsstatus für alle Anwendungen enthalten.

unwatch(watcher)

Heben Sie die Registrierung eines Beobachters auf, der zuvor registriert war.

notify(name, data)

Benachrichtigen Sie alle Beobachter über ein Ereignis mit einer bestimmten name und zusätzlichen Informationen data.

getApp(name)

Liefert die Konfiguration einer App anhand ihrer name oder undefined, wenn keine solche App existiert.

getDefaultConsent(app)

Gibt den Standard-Einwilligungswert für die angegebene app zurück, entweder true oder false.

changeAll(value)

Ändert alle Einwilligungen auf den angegebenen Wert (true oder false). Bitte beachten Sie, dass Apps, die als erforderlich markiert sind, weiterhin aktiviert sind.

updateConsent(name, value)

Ändern Sie die Zustimmung der App name in value.

restoreSavedConsents()

Wiederherstellen von Zustimmungen, die gespeichert wurden, als der Benutzer sie akzeptiert hat. Dadurch können Sie den Zustand des Zustimmungs-Managers auf die letzte Zustimmungs-Wahl des Benutzers zurücksetzen.

resetConsents()

Setzt alle Zustimmungen auf ihre konfigurierten Standardwerte zurück, wendet die Zustimmungsoptionen an und löscht alle gespeicherten Zustimmungsinformationen.

getConsent(name)

Gibt den Zustimmungsstatus für die App mit dem angegebenen name zurück.

loadConsents()

Lädt die Zustimmungsoptionen aus dem Laden.

saveAndApplyConsents()

Speichert die aktuellen Zustimmungsentscheidungen für den Laden und wendet sie an. Ruft an. saveConsents() und applyConsents().

saveConsents()

Speichern Sie die aktuellen Zustimmungsentscheidungen im Speicher (ohne sie anzuwenden).

applyConsents()

Wenden Sie die aktuellen Zustimmungsentscheidungen an.

updateAppElements(app, consent)

Aktualisiert alle HTML-Elemente für das angegebene app, um die Auswahl von consent zu berücksichtigen. Dadurch werden entweder Elemente für aktivierte Anwendungen initialisiert und aktive Elemente für deaktivierte Anwendungen entfernt.

updateAppCookies(app, consent)

Aktualisieren Sie alle Cookies für die angegebene app, um die Zustimmungsentscheidung zu berücksichtigen. Damit wird versucht, Cookies für deaktivierte Anwendungen zu entfernen.