@piwikpro/tracking-base-library/dist/services/cookie-management/cookieManagement.service.d.ts

Piwik PRO basic tracking library for the frontend.

/**
 * Disables all first party cookies. Existing cookies will be deleted in the next page view
 */
export declare function disableCookies(): void;
/**
 * Enables all first party cookies. Cookies will be created on the next tracking request
 */
export declare function enableCookies(): void;
/**
 * Deletes existing tracking cookies on the next page view
 */
export declare function deleteCookies(): void;
/**
 * Returns true if cookies are enabled in this browser
 */
export declare function hasCookies(): Promise<boolean>;
/**
 * Returns domain of the analytics tracking cookies (set with setCookieDomain()).
 */
export declare function getCookieDomain(): Promise<string>;
/**
 * Returns the analytics tracking cookies path
 */
export declare function getCookiePath(): Promise<string>;
/**
 * Returns expiration time of visitor cookies (in milliseconds)
 */
export declare function getConfigVisitorCookieTimeout(): Promise<number>;
/**
 * Sets the expiration time of referral cookies
 */
export declare function setReferralCookieTimeout(seconds: number): void;
/**
 * Returns expiration time of session cookies
 */
export declare function getSessionCookieTimeout(): Promise<number>;
/**
 * Sets the prefix for analytics tracking cookies. Default is "_pk_".
 */
export declare function setCookieNamePrefix(prefix: string): void;
/**
 * Sets the domain for the analytics tracking cookies
 */
export declare function setCookieDomain(domain: string): void;
/**
 * Sets the analytics tracking cookies path
 */
export declare function setCookiePath(path: string): void;
/**
 * Toggles the secure cookie flag on all first party cookies (if you are using HTTPS)
 */
export declare function setSecureCookie(secure: boolean): void;
/**
 * Sets the expiration time of visitor cookies
 */
export declare function setVisitorCookieTimeout(seconds: number): void;
/**
 * Sets the expiration time of session cookies
 */
export declare function setSessionCookieTimeout(seconds: number): void;
/**
 * Sets cookie containing {@link https://developers.piwik.pro/en/latest/glossary.html#term-analytics-id | analytics ID} in browser
 */
export declare function setVisitorIdCookie(): void;