@piwikpro/tracking-base-library
Version:
Piwik PRO basic tracking library for the frontend.
31 lines (30 loc) • 1.55 kB
TypeScript
export type LinkDecorator = (url: string, value: string, name: string) => string | null;
export type VisitorIdGetter = (url: string, name: string) => string;
/**
* Enables cross domain linking. Visitors across domains configured with "setDomains" function will be linked by passing visitor ID parameter in links.
*/
export declare function enableCrossDomainLinking(): void;
/**
* Disables cross domain linking.
*/
export declare function disableCrossDomainLinking(): void;
/**
* Changes the time in which two visits across domains will be linked. The default timeout is 180 seconds (3 minutes).
*/
export declare function setCrossDomainLinkingTimeout(timeout: number): void;
/**
* Returns boolean telling whether cross domain linking is enabled.
*/
export declare function isCrossDomainLinkingEnabled(): Promise<boolean>;
/**
* Returns the name of a cross domain URL parameter (query parameter by default) holding visitor ID. This is "pk_vid" by default.
*/
export declare function getCrossDomainLinkingUrlParameter(): Promise<string>;
/**
* Sets custom cross domains URL decorator for injecting visitor ID into URLs. Used when cross domain linking is enabled.
*/
export declare function customCrossDomainLinkDecorator(decorator: LinkDecorator): void;
/**
* Sets custom cross domain URL parser for extracting visitor ID from URLs. Should extract data injected by URL decorator. The getter should return visitor ID extracted from page URL.
*/
export declare function customCrossDomainLinkVisitorIdGetter(getter: VisitorIdGetter): void;