Tällä sivulla dokumentoidaan julkinen JavaScript API, jolla luetaan suostumustila, reagoidaan suostumuksen muutoksiin ja ohjataan dialogin kulkua sovelluskoodista.
Lataa PrivacyKit kerran globaalisti ennen kuin kutsut mitään API-metodeja.
<head>
<script type="module" src="https://cdn.privacykit.eu/v1/index.esm.js"></script>
...
</head>Kaikki julkinen käyttö kulkee globaalin window.PrivacyKit -olion kautta riippumatta siitä, miten skripti ladataan.
const api = window.PrivacyKit;
if (api?.hasConsent('analytics')) {
// analytiikkasuostumus annettu
}
const unsubscribe = api?.onConsentChanged(consent => {
console.log('Consent changed', consent);
});
PrivacyKit julkaisee koko API:n window.PrivacyKit -oliossa.
window.PrivacyKit = {
onReady,
readConsent,
hasConsent,
onConsentChanged,
openConsentDialog,
onConsentDialogClosed,
openPrivacyPolicyDialog,
toggleComplianceMonitor,
getSubscriptionStatus,
subscriptionStatus,
};Tilaa privacykit:ready-elinkaaritapahtuman, kun API on käytettävissä.
onReady(callback: () => void): () => voidwindow.PrivacyKit?.onReady(() => {
// PrivacyKitin API-metodeja on turvallista kutsua täällä
const consent = window.PrivacyKit.readConsent();
// ...
});Lukee nykyisen suostumusevästeen ja palauttaa normalisoidun suostumusolion.
readConsent(): {
analytics: boolean;
marketing: boolean;
preferences: boolean;
} | null
Arvioi suostumuksen yksittäiselle kategorialle tai lausekkeelle.
hasConsent(expression?: string): booleanTilaa suostumuspäivitykset ja palauttaa peruutusfunktion.
onConsentChanged(callback: (consent: {
analytics: boolean;
marketing: boolean;
preferences: boolean;
} | null) => void): () => void
Avaa PrivacyKit-dialogin ohjelmallisesti.
openConsentDialog(): voidTilaa dialogin sulkeutumistapahtumat.
onConsentDialogClosed(callback: () => void): () => voidAvaa Tietosuojakäytäntö-dialogin ohjelmallisesti erillisessä tilassa käyttäen ilmoitetun consent-dialogin tyylejä ja slot-sisältöä uudelleen.
openPrivacyPolicyDialog(): voidOttaa PrivacyKit Compliance Monitorin käyttöön tai poistaa sen käytöstä. Kun se on käytössä, sivun kulmaan ilmestyy kelluva toimintopainike, josta pääsee Monitor-valintaikkunaan.
toggleComplianceMonitor(): voidPalauttaa verkkotunnuksen nykyisen tilaustilan. Tämä on vain luku -apu — tilaus ja laskutus hoidetaan automaattisesti PrivacyKitin toimesta Paddlen kautta.
getSubscriptionStatus(): {
status: string | null;
billingInterval: string | null;
subscriptionEnd: string | null;
trailingEnd: string | null;
} | null