@piwikpro/tracking-base-library
Version:
Piwik PRO basic tracking library for the frontend.
32 lines (31 loc) • 1.21 kB
TypeScript
import { VisitorInfo } from '../../interfaces/visitorInfo';
/**
* The function that will return user ID
*/
export declare function getUserId(): Promise<string>;
/**
* User ID is an additional parameter that allows you to aggregate data. When
* set up, you will be able to search through sessions by this parameter, filter
* reports through it or create Multi attribution reports using User ID
*/
export declare function setUserId(userId: string): void;
/**
* Clears previously set userID, e.g. when visitor logs out
*/
export declare function resetUserId(): void;
/**
* Returns 16-character hex ID of the visitor
*/
export declare function getVisitorId(): Promise<string>;
/**
* Returns visitor information in an array
*/
export declare function getVisitorInfo(): Promise<VisitorInfo>;
/**
* Enables or disables anonymous tracking (anonymous = without consent). The next emitted event will have anonymous mode set accordingly.
*/
export declare function setUserIsAnonymous(isAnonymous: boolean): void;
/**
* Disables anonymous tracking and sends deanonymization event to the Tracker. Recommended method for disabling anonymous tracking.
*/
export declare function deanonymizeUser(): void;