Javascript API

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

I samtliga dessa hanteras de samtyckeskategoriser som vi stöjder:

• undefined = Okända cookies som ännu inte har definerats 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, allt användande som utöver detta är stöds inte officielt och dess funktionalitet kommer inte att garanteras. Detta inkluderar saker som att läsa vår cookie direkt eller att utvinna annan information från egenskaper som inte anges nedan. Om ni har behov som inte täcks av vår nuvarande API-yta så kontakta oss gärna så ska vi göra vårt bästa för att hitta ett officiellt sätt att stöjda det.

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

cookieTractor.openConsentSettings()

Denna funktion returnerar true/false baserat på om ett samtyckte för aktuell kategori hittas: 

cookieTractor.consent.contains(categoryAlias)

Funktion för att lägga till ett samtycke för aktuell kategori. 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 unika samtyckes-nyckel/id: 

cookieTractor.consent.key

En lista av strängar med categoryAlias för de samtycken som just nu givits av besökaren:

cookieTractor.consent.current

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

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 att radera en cookie med namnet från metod-parametern cookieName:

cookieTractor.cookie.remove(cookieName)

Relaterad information