-
public final class Configuration.Builder
-
-
Field Summary
Fields Modifier and Type Field Description private StringcollectDomainprivate Integersiteprivate Stringpathprivate PrivacyModedefaultPrivacyModeprivate VisitorIDTypevisitorIDTypeprivate OfflineStorageModeofflineStorageModeprivate VisitorStorageModevisitorStorageModeprivate IntegereventsOfflineStorageLifetimeprivate IntegerprivacyStorageLifetimeprivate IntegervisitorStorageLifetimeprivate IntegeruserStorageLifetimeprivate IntegersessionBackgroundDurationprivate BooleandetectCrashesprivate BooleanignoreLimitedAdTrackingprivate BooleansendEventWhenOptOutprivate ReportUrlProviderreportUrlProvider
-
Constructor Summary
Constructors Constructor Description Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration, Boolean detectCrashes, Boolean ignoreLimitedAdTracking, Boolean sendEventWhenOptOut, ReportUrlProvider reportUrlProvider)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration, Boolean detectCrashes, Boolean ignoreLimitedAdTracking, Boolean sendEventWhenOptOut)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration, Boolean detectCrashes, Boolean ignoreLimitedAdTracking)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration, Boolean detectCrashes)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType)Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode)Configuration.Builder(String collectDomain, Integer site, String path)Configuration.Builder(String collectDomain, Integer site)Configuration.Builder(String collectDomain)Configuration.Builder()
-
Method Summary
Modifier and Type Method Description final StringgetCollectDomain()final UnitsetCollectDomain(String collectDomain)final IntegergetSite()final UnitsetSite(Integer site)final StringgetPath()final UnitsetPath(String path)final PrivacyModegetDefaultPrivacyMode()final UnitsetDefaultPrivacyMode(PrivacyMode defaultPrivacyMode)final VisitorIDTypegetVisitorIDType()final UnitsetVisitorIDType(VisitorIDType visitorIDType)final OfflineStorageModegetOfflineStorageMode()final UnitsetOfflineStorageMode(OfflineStorageMode offlineStorageMode)final VisitorStorageModegetVisitorStorageMode()final UnitsetVisitorStorageMode(VisitorStorageMode visitorStorageMode)final IntegergetEventsOfflineStorageLifetime()final UnitsetEventsOfflineStorageLifetime(Integer eventsOfflineStorageLifetime)final IntegergetPrivacyStorageLifetime()final UnitsetPrivacyStorageLifetime(Integer privacyStorageLifetime)final IntegergetVisitorStorageLifetime()final UnitsetVisitorStorageLifetime(Integer visitorStorageLifetime)final IntegergetUserStorageLifetime()final UnitsetUserStorageLifetime(Integer userStorageLifetime)final IntegergetSessionBackgroundDuration()final UnitsetSessionBackgroundDuration(Integer sessionBackgroundDuration)final BooleangetDetectCrashes()final UnitsetDetectCrashes(Boolean detectCrashes)final BooleangetIgnoreLimitedAdTracking()final UnitsetIgnoreLimitedAdTracking(Boolean ignoreLimitedAdTracking)final BooleangetSendEventWhenOptOut()final UnitsetSendEventWhenOptOut(Boolean sendEventWhenOptOut)final ReportUrlProvidergetReportUrlProvider()final UnitsetReportUrlProvider(ReportUrlProvider reportUrlProvider)final <ERROR CLASS>collectDomain(String collectDomain)Set a new collect endpoint to send your tagging data final <ERROR CLASS>site(Integer site)Set a new site ID final <ERROR CLASS>path(String path)Set a new pixel path, to prevent potential tracking blockers by resource final <ERROR CLASS>defaultPrivacyMode(PrivacyMode defaultPrivacyMode)Set a default privacy mode, that will be used on sent event(s) if privacy mode is empty final <ERROR CLASS>visitorIDType(VisitorIDType visitorIDType)Set a type of visitorID final <ERROR CLASS>offlineStorageMode(OfflineStorageMode offlineStorageMode)Set an offline mode final <ERROR CLASS>visitorStorageMode(VisitorStorageMode visitorStorageMode)Set a new expiration mode (UUID visitor ID only) final <ERROR CLASS>eventsOfflineStorageLifetime(Integer eventsOfflineStorageLifetime)Set a new duration before events will be removed from offline storage final <ERROR CLASS>privacyStorageLifetime(Integer privacyStorageLifetime)Set a new expiration privacy mode final <ERROR CLASS>visitorStorageLifetime(Integer visitorStorageLifetime)Set a new duration before visitor expiring (visitor ID only) final <ERROR CLASS>userStorageLifetime(Integer userStorageLifetime)Set a new duration before user expiring (visitor ID only) final <ERROR CLASS>sessionBackgroundDuration(Integer sessionBackgroundDuration)Set a new session background duration before a new session will be created final <ERROR CLASS>detectCrashes(Boolean detectCrashes)Enable/disable crash detection final <ERROR CLASS>ignoreLimitedAdTracking(Boolean ignoreLimitedAdTracking)Enable/disable ignorance advertising tracking limitation final <ERROR CLASS>sendEventWhenOptOut(Boolean sendEventWhenOptOut)Enable/disable hit sending when user is opt-out final <ERROR CLASS>reportUrlProvider(ReportUrlProvider reportUrlProvider)Sets a custom ReportUrlProvider, which overrides collectDomain, site and path for Configuration final Configurationbuild()Get a new Configuration instance from Builder data set -
-
Constructor Detail
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration, Boolean detectCrashes, Boolean ignoreLimitedAdTracking, Boolean sendEventWhenOptOut, ReportUrlProvider reportUrlProvider)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration, Boolean detectCrashes, Boolean ignoreLimitedAdTracking, Boolean sendEventWhenOptOut)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration, Boolean detectCrashes, Boolean ignoreLimitedAdTracking)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration, Boolean detectCrashes)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime, Integer sessionBackgroundDuration)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime, Integer userStorageLifetime)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime, Integer visitorStorageLifetime)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime, Integer privacyStorageLifetime)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode, Integer eventsOfflineStorageLifetime)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode, VisitorStorageMode visitorStorageMode)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType, OfflineStorageMode offlineStorageMode)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode, VisitorIDType visitorIDType)
-
Configuration.Builder
Configuration.Builder(String collectDomain, Integer site, String path, PrivacyMode defaultPrivacyMode)
-
Configuration.Builder
Configuration.Builder(String collectDomain)
-
Configuration.Builder
Configuration.Builder()
-
-
Method Detail
-
getCollectDomain
final String getCollectDomain()
-
setCollectDomain
final Unit setCollectDomain(String collectDomain)
-
getDefaultPrivacyMode
final PrivacyMode getDefaultPrivacyMode()
-
setDefaultPrivacyMode
final Unit setDefaultPrivacyMode(PrivacyMode defaultPrivacyMode)
-
getVisitorIDType
final VisitorIDType getVisitorIDType()
-
setVisitorIDType
final Unit setVisitorIDType(VisitorIDType visitorIDType)
-
getOfflineStorageMode
final OfflineStorageMode getOfflineStorageMode()
-
setOfflineStorageMode
final Unit setOfflineStorageMode(OfflineStorageMode offlineStorageMode)
-
getVisitorStorageMode
final VisitorStorageMode getVisitorStorageMode()
-
setVisitorStorageMode
final Unit setVisitorStorageMode(VisitorStorageMode visitorStorageMode)
-
getEventsOfflineStorageLifetime
final Integer getEventsOfflineStorageLifetime()
-
setEventsOfflineStorageLifetime
final Unit setEventsOfflineStorageLifetime(Integer eventsOfflineStorageLifetime)
-
getPrivacyStorageLifetime
final Integer getPrivacyStorageLifetime()
-
setPrivacyStorageLifetime
final Unit setPrivacyStorageLifetime(Integer privacyStorageLifetime)
-
getVisitorStorageLifetime
final Integer getVisitorStorageLifetime()
-
setVisitorStorageLifetime
final Unit setVisitorStorageLifetime(Integer visitorStorageLifetime)
-
getUserStorageLifetime
final Integer getUserStorageLifetime()
-
setUserStorageLifetime
final Unit setUserStorageLifetime(Integer userStorageLifetime)
-
getSessionBackgroundDuration
final Integer getSessionBackgroundDuration()
-
setSessionBackgroundDuration
final Unit setSessionBackgroundDuration(Integer sessionBackgroundDuration)
-
getDetectCrashes
final Boolean getDetectCrashes()
-
setDetectCrashes
final Unit setDetectCrashes(Boolean detectCrashes)
-
getIgnoreLimitedAdTracking
final Boolean getIgnoreLimitedAdTracking()
-
setIgnoreLimitedAdTracking
final Unit setIgnoreLimitedAdTracking(Boolean ignoreLimitedAdTracking)
-
getSendEventWhenOptOut
final Boolean getSendEventWhenOptOut()
-
setSendEventWhenOptOut
final Unit setSendEventWhenOptOut(Boolean sendEventWhenOptOut)
-
getReportUrlProvider
final ReportUrlProvider getReportUrlProvider()
-
setReportUrlProvider
final Unit setReportUrlProvider(ReportUrlProvider reportUrlProvider)
-
collectDomain
final <ERROR CLASS> collectDomain(String collectDomain)
Set a new collect endpoint to send your tagging data
- Parameters:
collectDomain- fully qualified domain name (FQDN) collect
-
path
final <ERROR CLASS> path(String path)
Set a new pixel path, to prevent potential tracking blockers by resource
- Parameters:
path- a resource name string prefixed by '/'
-
defaultPrivacyMode
final <ERROR CLASS> defaultPrivacyMode(PrivacyMode defaultPrivacyMode)
Set a default privacy mode, that will be used on sent event(s) if privacy mode is empty
-
visitorIDType
final <ERROR CLASS> visitorIDType(VisitorIDType visitorIDType)
Set a type of visitorID
- Parameters:
visitorIDType- a visitorID type
-
offlineStorageMode
final <ERROR CLASS> offlineStorageMode(OfflineStorageMode offlineStorageMode)
Set an offline mode
- Parameters:
offlineStorageMode- an offline mode
-
visitorStorageMode
final <ERROR CLASS> visitorStorageMode(VisitorStorageMode visitorStorageMode)
Set a new expiration mode (UUID visitor ID only)
- Parameters:
visitorStorageMode- a uuid expiration mode defined in enum
-
eventsOfflineStorageLifetime
final <ERROR CLASS> eventsOfflineStorageLifetime(Integer eventsOfflineStorageLifetime)
Set a new duration before events will be removed from offline storage
- Parameters:
eventsOfflineStorageLifetime- an int in days
-
privacyStorageLifetime
final <ERROR CLASS> privacyStorageLifetime(Integer privacyStorageLifetime)
Set a new expiration privacy mode
- Parameters:
privacyStorageLifetime- an int in days
-
visitorStorageLifetime
final <ERROR CLASS> visitorStorageLifetime(Integer visitorStorageLifetime)
Set a new duration before visitor expiring (visitor ID only)
- Parameters:
visitorStorageLifetime- a visitor expiration duration (in days)
-
userStorageLifetime
final <ERROR CLASS> userStorageLifetime(Integer userStorageLifetime)
Set a new duration before user expiring (visitor ID only)
- Parameters:
userStorageLifetime- a user expiration duration (in days)
-
sessionBackgroundDuration
final <ERROR CLASS> sessionBackgroundDuration(Integer sessionBackgroundDuration)
Set a new session background duration before a new session will be created
- Parameters:
sessionBackgroundDuration- a session background duration (in seconds)
-
detectCrashes
final <ERROR CLASS> detectCrashes(Boolean detectCrashes)
Enable/disable crash detection
-
ignoreLimitedAdTracking
final <ERROR CLASS> ignoreLimitedAdTracking(Boolean ignoreLimitedAdTracking)
Enable/disable ignorance advertising tracking limitation
-
sendEventWhenOptOut
final <ERROR CLASS> sendEventWhenOptOut(Boolean sendEventWhenOptOut)
Enable/disable hit sending when user is opt-out
- Parameters:
sendEventWhenOptOut- allow hit sending
-
reportUrlProvider
final <ERROR CLASS> reportUrlProvider(ReportUrlProvider reportUrlProvider)
Sets a custom ReportUrlProvider, which overrides collectDomain, site and path for Configuration
- Parameters:
reportUrlProvider- ReportUrlProvider instance
-
build
final Configuration build()
Get a new Configuration instance from Builder data set
-
-
-
-