Diese Dokumentation wurde automatisch aus der englischen Version übersetzt, wir
entschuldigen uns für eventuelle Übersetzungsfehler.
x
Javascript-API
Klaro bietet eine kleine, aber leistungsstarke Javascript-API,
mit der Sie die Zustimmung Ihrer eigenen Anwendungen kontrollieren
und überwachen können. Wenn sie als normales Skript geladen wird,
kann auf die API über das globale klaro Projekt
zugegriffen werden. Sie können Klaro auch als Modul importieren, um
es innerhalb Ihres Node.js-Projekts zu verwenden. Um mehr darüber
zu erfahren, sehen Sie sich unser
Beispiel auf Github an.
klaro
Wenn Klaro als reguläres Skript auf einer Website geladen wird,
erstellt es eine globale klaro Variable, die die
öffentliche Klaro-API offen legt. Die folgenden Abschnitte
beschreiben jede Funktion dieser API.
klaro.show(config, modal)
Zeigt die Einverständniserklärung für die gegebene Konfiguration
an. Wenn dies der Fall config ist
undefined, wird Klaro die durch das
data-config Attribut des Klaro-Tags
script definierte Konfigurationsvariable laden. Wenn
auch diese nicht definiert ist, fällt sie auf
klaroConfig.
klaro.version()
Gibt die Klaro-Version zurück. Meistens nützlich für
Debugging-Zwecke.
klaro.getManager(config)
Geben Sie die ConsentManager Instanz für die
gegebene Konfiguration. Der config Parameter wird
genauso behandelt wie bei der show
Funktion. Wenn für die gegebene Konfiguration kein
Zustimmungsmanager existiert, wird dieser erstellt. Wenn einer
existiert, gibt die Funktion immer dieselbe Instanz zurück, so dass
es sicher ist, die Funktion mehrmals oder aus verschiedenen
Kontexten aufzurufen.
klaro.resetManagers()
Löscht alle Zustimmungsbeauftragte.
klaro.initialize()
Initialisiert Klaro: Wenn der Benutzer noch keine
Einverständniserklärung eingereicht hat, wird die
Einverständniserklärung (oder modal, je nach Ihrer Konfiguration)
angezeigt. Die Funktion hat keine Auswirkung, wenn das
data-no-auto-load Attribut auf dem Klaro-Skript-Tag
auf true.
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 die Einverständniserklärung
(wenn der Benutzer keine Einverständniserklärung abgegeben hat und
wenn die Modalität nicht durch die Konfiguration erzwungen wird)
oder die Einverständniserklärung (wenn der Benutzer bereits
Einverständniserklärungen abgegeben hat) angezeigt. Wenn
opts.modaltrue ist, wird immer die
Modalversion anstelle der Einverständniserklärung angezeigt, auch
wenn der Benutzer keine Einverständniserklärung eingereicht
hat.
klaro.getConfigTranslations(config)
Gibt ein Javascript Map zurück, das die
Übersetzungen für die angegebene config enthält.
klaro.language()
Beeinflusst die UI-Sprache für Klaro. Verwendet entweder den
durch die globale lang Variable angegebenen Wert oder
die im Fenster oder HTML-Dokument definierte Sprache.
ConsentManager
Die ConsentManager Klasse verwaltet
Einverständnisinformationen für Klaro. Sie können sie verwenden, um
Einverständniserklärungen einzusehen oder zu aktualisieren. Sie
speichert die aktuellen Zustimmungsentscheidungen, die ein Benutzer
in der Benutzeroberfläche getroffen hat, synchronisiert sie mit dem
Speicher und wendet sie durch Aktivieren oder Deaktivieren von
HTML-Elementen und Löschen von Cookies an.
get storageMethod()
Gibt die für die Speicherung von Einwilligungsinformationen
verwendete Speichermethode zurück. Derzeit ist dies entweder
cookie oder localStorage.
get storageName()
Gibt den Namen des Speichers zurück, der zur Speicherung der
Zustimmungsinformationen verwendet wird. Für den
cookie Speicher ist es der Name des Cookies. Für den
localStorage Speicher ist es der Schlüssel des
Speichers.
get cookieDomain()
Gibt die Domäne des Zustimmungs-Cookies für die
cookie Speicherung 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 Wächter muss eine
update(obj, name, data) Funktion implementieren, die
Informationen über Zustandsaktualisierungen vom
Zustimmungsverwalter erhält. Derzeit veröffentlicht der
Zustimmungsvorsitzende nur Ereignisse mit einem Namen
consents, der den aktuellen Zustimmungsstatus für alle
Anwendungen enthält.
unwatch(watcher)
Heben Sie die Registrierung eines Beobachters auf, der zuvor
registriert war.
notify(name, data)
Informieren Sie alle Beobachter über ein Ereignis mit einer
vorgegebenen name und zusätzlichen Information
data.
getApp(name)
Gibt die Konfiguration einer Anwendung nach ihrer
name, oder undefined falls keine solche
Anwendung existiert, zurück.
getDefaultConsent(app)
Gibt den Standardwert der Zustimmung für den angegebenen
app, entweder true oder zurück
false.
changeAll(value)
Ändert alle Zustimmungen auf den angegebenen
Wert (true oder false). Bitte beachten
Sie, dass Anwendungen, die als erforderlich markiert sind,
weiterhin aktiviert werden.
updateConsent(name, value)
Ändern Sie die Zustimmung von app name zu
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 Anwendung mit dem angegebenen
name.
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)
Aktualisieren Sie alle HTML-Elemente für das Gegebene,
app um die consent Auswahl
widerzuspiegeln. Dadurch werden entweder Elemente für Anwendungen,
die aktiviert wurden, initialisiert oder aktive Elemente für
Anwendungen, die deaktiviert wurden, entfernt.
updateAppCookies(app, consent)
Aktualisieren Sie alle Cookies für die gegebenen
app, um die Wahl der Zustimmung widerzuspiegeln.
Dadurch wird versucht, Cookies für Anwendungen zu entfernen, die
deaktiviert wurden.
Javascript-API
Klaro bietet eine kleine, aber leistungsstarke Javascript-API, mit der Sie die Zustimmung Ihrer eigenen Anwendungen kontrollieren und überwachen können. Wenn sie als normales Skript geladen wird, kann auf die API über das globale
klaro
Projekt zugegriffen werden. Sie können Klaro auch als Modul importieren, um es innerhalb Ihres Node.js-Projekts zu verwenden. Um mehr darüber zu erfahren, sehen Sie sich unser Beispiel auf Github an.klaro
Wenn Klaro als reguläres Skript auf einer Website geladen wird, erstellt es eine globale
klaro
Variable, die die öffentliche Klaro-API offen legt. Die folgenden Abschnitte beschreiben jede Funktion dieser API.klaro.show(config, modal)
Zeigt die Einverständniserklärung für die gegebene Konfiguration an. Wenn dies der Fall
config
istundefined
, wird Klaro die durch dasdata-config
Attribut des Klaro-Tagsscript
definierte Konfigurationsvariable laden. Wenn auch diese nicht definiert ist, fällt sie aufklaroConfig
.klaro.version()
Gibt die Klaro-Version zurück. Meistens nützlich für Debugging-Zwecke.
klaro.getManager(config)
Geben Sie die
ConsentManager
Instanz für die gegebene Konfiguration. Derconfig
Parameter wird genauso behandelt wie bei dershow
Funktion. Wenn für die gegebene Konfiguration kein Zustimmungsmanager existiert, wird dieser erstellt. Wenn einer existiert, gibt die Funktion immer dieselbe Instanz zurück, so dass es sicher ist, die Funktion mehrmals oder aus verschiedenen Kontexten aufzurufen.klaro.resetManagers()
Löscht alle Zustimmungsbeauftragte.
klaro.initialize()
Initialisiert Klaro: Wenn der Benutzer noch keine Einverständniserklärung eingereicht hat, wird die Einverständniserklärung (oder modal, je nach Ihrer Konfiguration) angezeigt. Die Funktion hat keine Auswirkung, wenn das
data-no-auto-load
Attribut auf dem Klaro-Skript-Tag auftrue
.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: Wennopts.show
gleichtrue
ist, wird die Einverständniserklärung (wenn der Benutzer keine Einverständniserklärung abgegeben hat und wenn die Modalität nicht durch die Konfiguration erzwungen wird) oder die Einverständniserklärung (wenn der Benutzer bereits Einverständniserklärungen abgegeben hat) angezeigt. Wennopts.modal
true
ist, wird immer die Modalversion anstelle der Einverständniserklärung angezeigt, auch wenn der Benutzer keine Einverständniserklärung eingereicht hat.klaro.getConfigTranslations(config)
Gibt ein Javascript
Map
zurück, das die Übersetzungen für die angegebeneconfig
enthält.klaro.language()
Beeinflusst die UI-Sprache für Klaro. Verwendet entweder den durch die globale
lang
Variable angegebenen Wert oder die im Fenster oder HTML-Dokument definierte Sprache.ConsentManager
Die
ConsentManager
Klasse verwaltet Einverständnisinformationen für Klaro. Sie können sie verwenden, um Einverständniserklärungen einzusehen oder zu aktualisieren. Sie speichert die aktuellen Zustimmungsentscheidungen, die ein Benutzer in der Benutzeroberfläche getroffen hat, synchronisiert sie mit dem Speicher und wendet sie durch Aktivieren oder Deaktivieren von HTML-Elementen und Löschen von Cookies an.get storageMethod()
Gibt die für die Speicherung von Einwilligungsinformationen verwendete Speichermethode zurück. Derzeit ist dies entweder
cookie
oderlocalStorage
.get storageName()
Gibt den Namen des Speichers zurück, der zur Speicherung der Zustimmungsinformationen verwendet wird. Für den
cookie
Speicher ist es der Name des Cookies. Für denlocalStorage
Speicher ist es der Schlüssel des Speichers.get cookieDomain()
Gibt die Domäne des Zustimmungs-Cookies für die
cookie
Speicherung 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 Wächter muss eine
update(obj, name, data)
Funktion implementieren, die Informationen über Zustandsaktualisierungen vom Zustimmungsverwalter erhält. Derzeit veröffentlicht der Zustimmungsvorsitzende nur Ereignisse mit einem Namenconsents
, der den aktuellen Zustimmungsstatus für alle Anwendungen enthält.unwatch(watcher)
Heben Sie die Registrierung eines Beobachters auf, der zuvor registriert war.
notify(name, data)
Informieren Sie alle Beobachter über ein Ereignis mit einer vorgegebenen
name
und zusätzlichen Informationdata
.getApp(name)
Gibt die Konfiguration einer Anwendung nach ihrer
name
, oderundefined
falls keine solche Anwendung existiert, zurück.getDefaultConsent(app)
Gibt den Standardwert der Zustimmung für den angegebenen
app
, entwedertrue
oder zurückfalse
.changeAll(value)
Ändert alle Zustimmungen auf den angegebenen Wert (
true
oderfalse
). Bitte beachten Sie, dass Anwendungen, die als erforderlich markiert sind, weiterhin aktiviert werden.updateConsent(name, value)
Ändern Sie die Zustimmung von app
name
zuvalue
.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 Anwendung mit dem angegebenen
name
.loadConsents()
Lädt die Zustimmungsoptionen aus dem Laden.
saveAndApplyConsents()
Speichert die aktuellen Zustimmungsentscheidungen für den Laden und wendet sie an. Ruft an.
saveConsents()
undapplyConsents()
.saveConsents()
Speichern Sie die aktuellen Zustimmungsentscheidungen im Speicher (ohne sie anzuwenden).
applyConsents()
Wenden Sie die aktuellen Zustimmungsentscheidungen an.
updateAppElements(app, consent)
Aktualisieren Sie alle HTML-Elemente für das Gegebene,
app
um dieconsent
Auswahl widerzuspiegeln. Dadurch werden entweder Elemente für Anwendungen, die aktiviert wurden, initialisiert oder aktive Elemente für Anwendungen, die deaktiviert wurden, entfernt.updateAppCookies(app, consent)
Aktualisieren Sie alle Cookies für die gegebenen
app
, um die Wahl der Zustimmung widerzuspiegeln. Dadurch wird versucht, Cookies für Anwendungen zu entfernen, die deaktiviert wurden.