Javascript-APIs
CCM19 bietet mehrere Javascript-APIs, mit denen auf Funktionalitäten des Cookie-Managers zugegriffen und auf Benutzerinteraktionen reagiert werden kann.
Globales Objekt
Die direkten Steuerungsmöglichkeiten von Clickskeks sind im globalen Javascript-Objekt CCM gebündelt:
| Variable/Methode | Typ | Beschreibung |
|---|---|---|
| CCM.acceptedCookies | string[] | Liste der Namen aller akzeptierten Cookies. |
| CCM.acceptedEmbeddings | [ { id: string,name: string,} , … ] |
Liste aller akzeptierten Embeddings. (ab Version 2020.10.28) |
| CCM.availableLocales() | string[] | Liste aktiver Sprachen – z. B. ['de_DE', 'en_US'](ab Version 2022.03.24) |
| CCM.closeControlPanel() | Schließt den Dialog zur Auswahl der zu akzeptierenden Zwecke. | |
| CCM.closeWidget() | Schließt den Cookie-Dialog. | |
| CCM.consent | boolean | Gibt an, ob der Consent-Dialog geschlossen wurde. |
| CCM.crossDomainConsentString | string | Fragmentbezeichner zum manuellen Zusammensetzen einer URL für die Consent-Teilung. (ab Version 2020.10.14) |
| CCM.navigate(url[, replace[, navigateTop]]) | Navigiert zu einer anderen URL (wie location.href = url), berücksichtigt dabei aber die Consent-Teilung. replace steuert, ob location.replace verwendet wird und navigateTop steuert, ob bei Frames die vollständige Seite navigiert wird.(ab Version 2020.10.14) |
|
| CCM.openControlPanel() | Öffnet den Dialog zur Auswahl der zu akzeptierenden Zwecke. | |
| CCM.openWidget() | Öffnet den Cookie-Dialog erneut. | |
| CCM.switchLocale(localeName) | Wechselt die Sprache – siehe CCM.availableLocales()(ab Version 2022.03.24) |
|
| CCM.ucid | ?string | Die eindeutige Consent-ID, oder null, wenn noch kein Consent erteilt wurde. |
| CCM.version | string | Enthält die aktuelle Clickskeks-Version. (ab Version 2020.10.28) |
Die Dialoge können alternativ auch über Links mit den Zielen #CCM.openWidget, #CCM.closeWidget, #CCM.openControlPanel und #CCM.closeControlPanel gesteuert werden.
Javascript-Events
Einige Ereignisse in Clickskeks werden zu CustomEvents auf dem window-Objekt abgebildet und mit window.addEventListener(…) kann darauf reagiert werden.
| Event | detail-Eigenschaft | Beschreibung |
|---|---|---|
| ccm19CookieAccepted | { name: string,code: string,purpose: string,mandatory: boolean,} |
Ein Cookie wurde durch den Nutzer akzeptiert. Dieses Event wird für jedes Cookie ausgelöst, das in den akzeptierten Zwecken gelistet ist.Diese Events erfolgen beim Erteilen des Consents durch den Besucher und werden bei jeden folgenden Seitenbesuch beim Laden der Seite wiederholt. Veraltet: Bitte auf ccm19EmbeddingAccepted umsteigen. |
| ccm19EmbeddingAccepted | { name: string,code: string,purpose: string,mandatory: boolean,} |
Ein Embedding wurde durch den Nutzer akzeptiert. Diese Events erfolgen beim Erteilen des Consents durch den Besucher und werden für jeden Seitenaufruf wiederholt. (ab Version 2020.10.28) |
| ccm19WidgetClosed | null | Wird ausgelöst, sobald das letzte sichtbare Clickskeks-Widget-Element geschlossen wird. Dabei kann es sich um ein Resultat eines Klicks auf einen Speichern-Button handeln, der zum Schließen des Widgets führt. |
| ccm19WidgetLoaded | null | Wird ausgelöst, sobald Clickskeks fertig initialisiert wurde. |