Javascript-APIs
cookiewatch 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 cookiewatch 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. |
| CCM.availableLocales() | string[] | Liste aktiver Sprachen – z. B. ['de_DE', 'en_US'] |
| 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. |
| 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. | |
| 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() | |
| CCM.ucid | ?string | Die eindeutige Consent-ID, oder null, wenn noch kein Consent erteilt wurde. |
| CCM.version | string | Enthält die aktuelle cookiewatch-Version. |
Die Dialoge können alternativ auch über Links mit den Zielen #CCM.openWidget, #CCM.closeWidget, #CCM.openControlPanel und #CCM.closeControlPanel gesteuert werden.