Snowplow Android Tracker 3.1.2
Public Member Functions | Public Attributes | List of all members
com.snowplowanalytics.snowplow.configuration.SubjectConfiguration Class Reference
Inheritance diagram for com.snowplowanalytics.snowplow.configuration.SubjectConfiguration:
com.snowplowanalytics.snowplow.configuration.Configuration com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationUpdate

Public Member Functions

 SubjectConfiguration ()
 
SubjectConfiguration userId (@Nullable String userId)
 
SubjectConfiguration networkUserId (@Nullable String networkUserId)
 
SubjectConfiguration domainUserId (@Nullable String domainUserId)
 
SubjectConfiguration useragent (@Nullable String useragent)
 
SubjectConfiguration ipAddress (@Nullable String ipAddress)
 
SubjectConfiguration timezone (@Nullable String timezone)
 
SubjectConfiguration language (@Nullable String language)
 
SubjectConfiguration screenResolution (@Nullable Size screenResolution)
 
SubjectConfiguration screenViewPort (@Nullable Size screenViewPort)
 
SubjectConfiguration colorDepth (@Nullable Integer colorDepth)
 
String getUserId ()
 
void setUserId (@Nullable String userId)
 
String getNetworkUserId ()
 
void setNetworkUserId (@Nullable String networkUserId)
 
String getDomainUserId ()
 
void setDomainUserId (@Nullable String domainUserId)
 
String getUseragent ()
 
void setUseragent (@Nullable String useragent)
 
String getIpAddress ()
 
void setIpAddress (@Nullable String ipAddress)
 
String getTimezone ()
 
void setTimezone (@Nullable String timezone)
 
String getLanguage ()
 
void setLanguage (@Nullable String language)
 
Size getScreenResolution ()
 
void setScreenResolution (@Nullable Size screenResolution)
 
Size getScreenViewPort ()
 
void setScreenViewPort (@Nullable Size screenViewPort)
 
Integer getColorDepth ()
 
void setColorDepth (@Nullable Integer colorDepth)
 
SubjectConfiguration copy ()
 
 SubjectConfiguration (@NonNull JSONObject jsonObject)
 

Public Attributes

String userId
 
String networkUserId
 
String domainUserId
 
String useragent
 
String ipAddress
 
String timezone
 
String language
 
Size screenResolution
 
Size screenViewPort
 
Integer colorDepth
 

Detailed Description

This class represents the configuration of the subject. The SubjectConfiguration can be used to setup the tracker with the basic information about the user and the app which will be attached on all the events as contexts. The contexts to track can be enabled in the TrackerConfiguration class.

Definition at line 17 of file SubjectConfiguration.java.

Constructor & Destructor Documentation

◆ SubjectConfiguration() [1/2]

com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.SubjectConfiguration ( )

Definition at line 19 of file SubjectConfiguration.java.

◆ SubjectConfiguration() [2/2]

com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.SubjectConfiguration ( @NonNull JSONObject  jsonObject)

Definition at line 307 of file SubjectConfiguration.java.

Member Function Documentation

◆ colorDepth()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.colorDepth ( @Nullable Integer  colorDepth)

The color depth. @apiNote It's not generated by the tracker, it needs to be filled by the developer when instrumenting the tracker.

Definition at line 169 of file SubjectConfiguration.java.

◆ copy()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.copy ( )

◆ domainUserId()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.domainUserId ( @Nullable String  domainUserId)

The domain UserID. @apiNote It's not generated by the tracker, it needs to be filled by the developer when instrumenting the tracker.

Definition at line 102 of file SubjectConfiguration.java.

◆ getColorDepth()

Integer com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getColorDepth ( )

◆ getDomainUserId()

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getDomainUserId ( )

◆ getIpAddress()

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getIpAddress ( )

◆ getLanguage()

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getLanguage ( )

◆ getNetworkUserId()

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getNetworkUserId ( )

◆ getScreenResolution()

Size com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getScreenResolution ( )

◆ getScreenViewPort()

Size com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getScreenViewPort ( )

◆ getTimezone()

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getTimezone ( )

◆ getUseragent()

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getUseragent ( )

◆ getUserId()

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.getUserId ( )

◆ ipAddress()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.ipAddress ( @Nullable String  ipAddress)

The IP address. @apiNote It's not generated by the tracker, it needs to be filled by the developer when instrumenting the tracker.

Definition at line 122 of file SubjectConfiguration.java.

◆ language()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.language ( @Nullable String  language)

The language set in the device.

Definition at line 140 of file SubjectConfiguration.java.

◆ networkUserId()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.networkUserId ( @Nullable String  networkUserId)

The network UserID. @apiNote It's not generated by the tracker, it needs to be filled by the developer when instrumenting the tracker.

Definition at line 92 of file SubjectConfiguration.java.

◆ screenResolution()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.screenResolution ( @Nullable Size  screenResolution)

The screen resolution.

Definition at line 149 of file SubjectConfiguration.java.

◆ screenViewPort()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.screenViewPort ( @Nullable Size  screenViewPort)

The screen viewport. @apiNote It's not generated by the tracker, it needs to be filled by the developer when instrumenting the tracker.

Definition at line 159 of file SubjectConfiguration.java.

◆ setColorDepth()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setColorDepth ( @Nullable Integer  colorDepth)

◆ setDomainUserId()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setDomainUserId ( @Nullable String  domainUserId)

◆ setIpAddress()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setIpAddress ( @Nullable String  ipAddress)

◆ setLanguage()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setLanguage ( @Nullable String  language)

◆ setNetworkUserId()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setNetworkUserId ( @Nullable String  networkUserId)

◆ setScreenResolution()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setScreenResolution ( @Nullable Size  screenResolution)

◆ setScreenViewPort()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setScreenViewPort ( @Nullable Size  screenViewPort)

◆ setTimezone()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setTimezone ( @Nullable String  timezone)

◆ setUseragent()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setUseragent ( @Nullable String  useragent)

◆ setUserId()

void com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.setUserId ( @Nullable String  userId)

◆ timezone()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.timezone ( @Nullable String  timezone)

The current timezone.

Definition at line 131 of file SubjectConfiguration.java.

◆ useragent()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.useragent ( @Nullable String  useragent)

The user-agent. @apiNote It's not generated by the tracker, it needs to be filled by the developer when instrumenting the tracker.

Definition at line 112 of file SubjectConfiguration.java.

◆ userId()

SubjectConfiguration com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.userId ( @Nullable String  userId)

The custom UserID.

Definition at line 82 of file SubjectConfiguration.java.

Member Data Documentation

◆ colorDepth

Integer com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.colorDepth
See also
#colorDepth(Integer)

Definition at line 74 of file SubjectConfiguration.java.

◆ domainUserId

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.domainUserId
See also
#domainUserId(String)

Definition at line 37 of file SubjectConfiguration.java.

◆ ipAddress

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.ipAddress
See also
#ipAddress(String)

Definition at line 47 of file SubjectConfiguration.java.

◆ language

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.language
See also
#language(String)

Definition at line 58 of file SubjectConfiguration.java.

◆ networkUserId

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.networkUserId
See also
#networkUserId(String)

Definition at line 32 of file SubjectConfiguration.java.

◆ screenResolution

Size com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.screenResolution
See also
#screenResolution(Size)

Definition at line 64 of file SubjectConfiguration.java.

◆ screenViewPort

Size com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.screenViewPort
See also
#screenViewPort(Size)

Definition at line 69 of file SubjectConfiguration.java.

◆ timezone

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.timezone
See also
#timezone(String)

Definition at line 53 of file SubjectConfiguration.java.

◆ useragent

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.useragent
See also
#useragent(String)

Definition at line 42 of file SubjectConfiguration.java.

◆ userId

String com.snowplowanalytics.snowplow.configuration.SubjectConfiguration.userId
See also
#userId(String)

Definition at line 27 of file SubjectConfiguration.java.


The documentation for this class was generated from the following file: