com.atinternet.tracker

Class Privacy

java.lang.Object

com.atinternet.tracker.Privacy

public final class Privacy
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Privacy.StorageFeature
static class	Privacy.VisitorMode

Method Summary

Modifier and Type	Method and Description
static void	extendIncludeBuffer(Privacy.VisitorMode visitorMode, java.lang.String... keys) Extend include buffer for visitor mode set in parameter
static void	extendIncludeBuffer(java.lang.String... keys) Extend include buffer for current visitor mode
static void	extendIncludeBufferForVisitorMode(java.lang.String visitorMode, java.lang.String... keys) Extend include buffer for visitor mode set in parameter
static void	extendIncludeStorageForVisitorMode(java.lang.String visitorMode, Privacy.StorageFeature... storageFeatureKeys) Extend include buffer for visitor mode set in parameter (Only for exempt or custom)
static Privacy.VisitorMode	getVisitorMode() Deprecated. Since 2.21.0, use getVisitorModeString() instead
static java.lang.String	getVisitorModeString() Get current User Privacy mode
static void	setVisitorMode(Privacy.VisitorMode visitorMode) Set User Privacy mode
static void	setVisitorMode(Privacy.VisitorMode visitorMode, int duration) Set User Privacy mode
static void	setVisitorMode(java.lang.String visitorMode, boolean visitorConsent, java.lang.String customUserIdValue) Set User Privacy custom mode
static void	setVisitorMode(java.lang.String visitorMode, boolean visitorConsent, java.lang.String customUserIdValue, int duration) Set User Privacy custom mode
static void	setVisitorOptIn() Set user OptIn
static void	setVisitorOptOut() Set user OptOut

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setVisitorOptOut

public static void setVisitorOptOut()

Set user OptOut

setVisitorOptIn

public static void setVisitorOptIn()

Set user OptIn

setVisitorMode

public static void setVisitorMode(Privacy.VisitorMode visitorMode)

Set User Privacy mode

Parameters:

visitorMode - selected mode from user context

setVisitorMode

public static void setVisitorMode(Privacy.VisitorMode visitorMode,
                                  int duration)

Set User Privacy mode

Parameters:

visitorMode - selected mode from user context

duration - storage validity for privacy information (in days)

setVisitorMode

public static void setVisitorMode(java.lang.String visitorMode,
                                  boolean visitorConsent,
                                  java.lang.String customUserIdValue)

Set User Privacy custom mode

Parameters:

visitorMode - selected mode from user context

visitorConsent - visitor consent to tracking

customUserIdValue - optional custom user id

setVisitorMode

public static void setVisitorMode(java.lang.String visitorMode,
                                  boolean visitorConsent,
                                  java.lang.String customUserIdValue,
                                  int duration)

Set User Privacy custom mode

Parameters:

visitorMode - selected mode from user context

visitorConsent - visitor consent to tracking

customUserIdValue - optional custom user id

duration - storage validity for privacy information (in days)

getVisitorMode

@Deprecated
public static Privacy.VisitorMode getVisitorMode()

Deprecated. Since 2.21.0, use getVisitorModeString() instead

Get current User Privacy mode

Returns:

user privacy mode

getVisitorModeString

public static java.lang.String getVisitorModeString()

Get current User Privacy mode

Returns:

user privacy mode

extendIncludeBuffer

public static void extendIncludeBuffer(java.lang.String... keys)

Extend include buffer for current visitor mode

Parameters:

keys - keys to include in the hit

extendIncludeBuffer

public static void extendIncludeBuffer(Privacy.VisitorMode visitorMode,
                                       java.lang.String... keys)

Extend include buffer for visitor mode set in parameter

Parameters:

visitorMode - selected mode from user context

keys - keys to include in the hit

extendIncludeBufferForVisitorMode

public static void extendIncludeBufferForVisitorMode(java.lang.String visitorMode,
                                                     java.lang.String... keys)

Extend include buffer for visitor mode set in parameter

Parameters:

visitorMode - selected mode from user context

keys - keys to include in the hit

extendIncludeStorageForVisitorMode

public static void extendIncludeStorageForVisitorMode(java.lang.String visitorMode,
                                                      Privacy.StorageFeature... storageFeatureKeys)

Extend include buffer for visitor mode set in parameter (Only for exempt or custom)

Parameters:

visitorMode - selected mode from user context

storageFeatureKeys - data can be stored/kept