Package io.piano.analytics

Class Configuration.Builder

java.lang.Object

io.piano.analytics.Configuration.Builder

Enclosing class:

Configuration

public static class Configuration.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Configuration	build()	Get a new Configuration instance from Builder data set
Configuration.Builder	enableCrashDetection(boolean enabled)	Enable/disable crash detection
Configuration.Builder	enableIgnoreLimitedAdTracking(boolean enabled)	Enable/disable ignorance advertising tracking limitation
Configuration.Builder	enableSendEventWhenOptOut(boolean sendEventWhenOptOut)	Enable/disable hit sending when user is opt-out
Configuration.Builder	withCollectDomain(String collectDomain)	Set a new collect endpoint to send your tagging data
Configuration.Builder	withCustomUserAgent(String customUserAgent)	Set a custom user agent
Configuration.Builder	withEncryptionMode(Configuration.EncryptionMode encryptionMode)	Set a new encryption mode
Configuration.Builder	withOfflineStorageMode(Configuration.OfflineStorageMode offlineStorageMode)	Set an offline mode
Configuration.Builder	withPath(String path)	Set a new pixel path, to prevent potential tracking blockers by resource
Configuration.Builder	withPrivacyDefaultMode(String mode)	Set a default privacy mode, that will be used on sent event(s) if privacy mode is empty
Configuration.Builder	withSessionBackgroundDuration(int sessionBackgroundDuration)	Set a new session background duration before a new session will be created
Configuration.Builder	withSite(int site)	Set a new site ID
Configuration.Builder	withStorageLifetimePrivacy(int storageLifetimePrivacy)	Set a new expiration privacy mode
Configuration.Builder	withStorageLifetimeUser(int storageLifetimeUser)	Set a new duration before user expiring (visitor ID only)
Configuration.Builder	withStorageLifetimeVisitor(int storageLifetimeVisitor)	Set a new duration before visitor expiring (visitor ID only)
Configuration.Builder	withVisitorID(String visitorID)	Set a custom visitorID
Configuration.Builder	withVisitorIDType(Configuration.VisitorIDType visitorIDType)	Set a type of visitorID
Configuration.Builder	withVisitorStorageMode(Configuration.VisitorStorageMode visitorStorageMode)	Set a new expiration mode (UUID visitor ID only)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withCollectDomain

public Configuration.Builder withCollectDomain(String collectDomain)

Set a new collect endpoint to send your tagging data

Parameters:

collectDomain - fully qualified domain name (FQDN) collect

Returns:

updated Builder instance

withSite

public Configuration.Builder withSite(int site)

Set a new site ID

Parameters:

site - site identifier

Returns:

updated Builder instance

withPath

public Configuration.Builder withPath(String path)

Set a new pixel path, to prevent potential tracking blockers by resource

Parameters:

path - a resource name string prefixed by '/'

Returns:

updated Builder instance

withPrivacyDefaultMode

public Configuration.Builder withPrivacyDefaultMode(String mode)

Set a default privacy mode, that will be used on sent event(s) if privacy mode is empty

Parameters:

mode - a privacy mode string

Returns:

updated Builder instance

withVisitorIDType

public Configuration.Builder withVisitorIDType(Configuration.VisitorIDType visitorIDType)

Set a type of visitorID

Parameters:

visitorIDType - a visitorID type

Returns:

updated Builder instance

withOfflineStorageMode

public Configuration.Builder withOfflineStorageMode(Configuration.OfflineStorageMode offlineStorageMode)

Set an offline mode

Parameters:

offlineStorageMode - an offline mode

Returns:

updated Builder instance

enableIgnoreLimitedAdTracking

public Configuration.Builder enableIgnoreLimitedAdTracking(boolean enabled)

Enable/disable ignorance advertising tracking limitation

Parameters:

enabled - enabling ignorance

Returns:

updated Builder instance

enableCrashDetection

public Configuration.Builder enableCrashDetection(boolean enabled)

Enable/disable crash detection

Parameters:

enabled - enabling detection

Returns:

updated Builder instance

withVisitorStorageMode

public Configuration.Builder withVisitorStorageMode(Configuration.VisitorStorageMode visitorStorageMode)

Set a new expiration mode (UUID visitor ID only)

Parameters:

visitorStorageMode - a uuid expiration mode defined in enum

Returns:

updated Builder instance

withStorageLifetimePrivacy

public Configuration.Builder withStorageLifetimePrivacy(int storageLifetimePrivacy)

Set a new expiration privacy mode

Parameters:

storageLifetimePrivacy - an int in days

Returns:

updated Builder instance

withStorageLifetimeVisitor

public Configuration.Builder withStorageLifetimeVisitor(int storageLifetimeVisitor)

Set a new duration before visitor expiring (visitor ID only)

Parameters:

storageLifetimeVisitor - a visitor expiration duration (in days)

Returns:

updated Builder instance

withStorageLifetimeUser

public Configuration.Builder withStorageLifetimeUser(int storageLifetimeUser)

Set a new duration before user expiring (visitor ID only)

Parameters:

storageLifetimeUser - a user expiration duration (in days)

Returns:

updated Builder instance

withEncryptionMode

public Configuration.Builder withEncryptionMode(Configuration.EncryptionMode encryptionMode)

Set a new encryption mode

Parameters:

encryptionMode - an encryption mode for at-rest data

Returns:

updated Builder instance

withSessionBackgroundDuration

public Configuration.Builder withSessionBackgroundDuration(int sessionBackgroundDuration)

Set a new session background duration before a new session will be created

Parameters:

sessionBackgroundDuration - a session background duration (in seconds)

Returns:

updated Builder instance

enableSendEventWhenOptOut

public Configuration.Builder enableSendEventWhenOptOut(boolean sendEventWhenOptOut)

Enable/disable hit sending when user is opt-out

Parameters:

sendEventWhenOptOut - allow hit sending

Returns:

updated Builder instance

withVisitorID

public Configuration.Builder withVisitorID(String visitorID)

Set a custom visitorID

Parameters:

visitorID - custom visitor ID

Returns:

updated Builder instance

withCustomUserAgent

public Configuration.Builder withCustomUserAgent(String customUserAgent)

Set a custom user agent

Parameters:

customUserAgent - custom user agent

Returns:

updated Builder instance

build

public Configuration build()

Get a new Configuration instance from Builder data set

Returns:

an Configuration instance