Hoppa till innehållet

JavaScript API

Vårt skript exponerar ett antal funktioner och egenskaper som kan användas för att programmatiskt styra samtyckeslösningen.

I API:t hanteras de samtyckeskategorier som vi stödjer:

  • undefined = okända cookies som ännu inte har definierats i vårt verktyg
  • necessary = strikt nödvändiga cookies
  • functional = funktionella cookies
  • statistical = cookies för statistik
  • marketing = marknadsföringscookies

Nedan följer en referens över de metoder som vi officiellt stödjer. Användning utöver detta stöds inte officiellt, och funktionalitet kan inte garanteras. Det gäller till exempel att läsa vår cookie direkt eller att hämta information från egenskaper som inte anges nedan.

Om ni har behov som inte täcks av vår nuvarande API-yta får ni gärna kontakta oss, så gör vi vårt bästa för att hitta ett officiellt sätt att stödja dem.

Lyssna på ändringar i samtycke

När ni bygger funktionalitet som är beroende av besökarens samtycke bör ni lyssna på eventet CookieConsent, så att er kod kan reagera när besökaren ändrar sina val.

cookieTractor.consent.contains() och cookieTractor.consent.current låter er kontrollera aktuella samtycken, men en engångskontroll meddelar inte er kod om senare förändringar. Er implementation bör hantera både när samtycke lämnas och när det återkallas.

Se JavaScript events och funktioner för en beskrivning av eventet och exempel på implementation.


Denna funktion öppnar cookie-dialogen i besökarens webbläsare: 

cookieTractor.openConsentSettings()

Returnerar true om besökaren för närvarande har lämnat samtycke för den angivna kategorin, annars false.

Kontrollen gäller samtycket vid anropstillfället. För att reagera på senare ändringar i samtycket bör ni lyssna på eventet CookieConsent.

cookieTractor.consent.contains(categoryAlias)

Funktion för att lägga till ett samtycke för den aktuella kategorin. Denna går att anropa med en sträng eller med en array av strängar om flera kategorier ska adderas:

cookieTractor.consent.add(categoryAlias)

Raderar samtycke för aktuell kategori:

cookieTractor.consent.remove(categoryAlias)

Innehåller besökarens samtyckesnyckel/id:

cookieTractor.consent.key

En array med kategori-alias som representerar besökarens aktuella samtycken.

Att läsa egenskapen innebär inte att er kod meddelas när samtycket ändras. Lyssna på eventet CookieConsent för att reagera på förändringar.

cookieTractor.consent.current

En lista med categoryAlias för alla samtyckeskategorier som finns tillgängliga på webbplatsen. Detta är inte besökarens val, utan en referenslista över de kategorier som används på den aktuella webbplatsen.

cookieTractor.consent.available

Egenskaper som innehåller strängrepresentationer av våra samtyckeskategorier:

cookieTractor.category.{categoryAlias}

// dvs:
cookieTractor.category.undefined
cookieTractor.category.necessary
cookieTractor.category.functional
cookieTractor.category.statistical
cookieTractor.category.marketing

Raderar vår samtyckescookie från besökarens webbläsare:

cookieTractor.cookie.remove()

Hjälpfunktion som försöker radera en cookie med namnet från metodparametern cookieName:

cookieTractor.cookie.remove(cookieName)

Support

Har ni frågor om installationen? Kontakta oss gärna på info@cookietractor.se