com.snowplowanalytics.snowplow.configuration

Class SubjectConfiguration

java.lang.Object

com.snowplowanalytics.snowplow.configuration.SubjectConfiguration

All Implemented Interfaces:

Configuration, com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface, Serializable

public class SubjectConfiguration
extends Object
implements Configuration, com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Integer	colorDepth
String	domainUserId
String	ipAddress
String	language
String	networkUserId
Size	screenResolution
Size	screenViewPort
String	timezone
String	useragent
String	userId

Constructor Summary

Constructors

Constructor and Description
SubjectConfiguration()
SubjectConfiguration(JSONObject jsonObject)

Method Summary

Modifier and Type	Method and Description
SubjectConfiguration	colorDepth(Integer colorDepth) The color depth.
SubjectConfiguration	copy()
SubjectConfiguration	domainUserId(String domainUserId) The domain UserID.
Integer	getColorDepth()
String	getDomainUserId()
String	getIpAddress()
String	getLanguage()
String	getNetworkUserId()
Size	getScreenResolution()
Size	getScreenViewPort()
String	getTimezone()
String	getUseragent()
String	getUserId()
SubjectConfiguration	ipAddress(String ipAddress) The IP address.
SubjectConfiguration	language(String language) The language set in the device.
SubjectConfiguration	networkUserId(String networkUserId) The network UserID.
SubjectConfiguration	screenResolution(Size screenResolution) The screen resolution.
SubjectConfiguration	screenViewPort(Size screenViewPort) The screen viewport.
void	setColorDepth(Integer colorDepth)
void	setDomainUserId(String domainUserId)
void	setIpAddress(String ipAddress)
void	setLanguage(String language)
void	setNetworkUserId(String networkUserId)
void	setScreenResolution(Size screenResolution)
void	setScreenViewPort(Size screenViewPort)
void	setTimezone(String timezone)
void	setUseragent(String useragent)
void	setUserId(String userId)
SubjectConfiguration	timezone(String timezone) The current timezone.
SubjectConfiguration	useragent(String useragent) The user-agent.
SubjectConfiguration	userId(String userId) The custom UserID.

Methods inherited from class java.lang.Object

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

Field Detail

userId

@Nullable
public String userId

See Also:

userId(String)

networkUserId

@Nullable
public String networkUserId

See Also:

networkUserId(String)

domainUserId

@Nullable
public String domainUserId

See Also:

domainUserId(String)

useragent

@Nullable
public String useragent

See Also:

useragent(String)

ipAddress

@Nullable
public String ipAddress

See Also:

ipAddress(String)

timezone

@Nullable
public String timezone

See Also:

timezone(String)

language

@Nullable
public String language

See Also:

language(String)

screenResolution

@Nullable
public Size screenResolution

See Also:

screenResolution(Size)

screenViewPort

@Nullable
public Size screenViewPort

See Also:

screenViewPort(Size)

colorDepth

@Nullable
public Integer colorDepth

See Also:

colorDepth(Integer)

Constructor Detail

SubjectConfiguration

public SubjectConfiguration()

SubjectConfiguration

public SubjectConfiguration(@NonNull
                            JSONObject jsonObject)

Method Detail

userId

@NonNull
public SubjectConfiguration userId(@Nullable
                                            String userId)

The custom UserID.

networkUserId

@NonNull
public SubjectConfiguration networkUserId(@Nullable
                                                   String networkUserId)

The network UserID.

domainUserId

@NonNull
public SubjectConfiguration domainUserId(@Nullable
                                                  String domainUserId)

The domain UserID.

useragent

@NonNull
public SubjectConfiguration useragent(@Nullable
                                               String useragent)

The user-agent.

ipAddress

@NonNull
public SubjectConfiguration ipAddress(@Nullable
                                               String ipAddress)

The IP address.

timezone

@NonNull
public SubjectConfiguration timezone(@Nullable
                                              String timezone)

The current timezone.

language

@NonNull
public SubjectConfiguration language(@Nullable
                                              String language)

The language set in the device.

screenResolution

@NonNull
public SubjectConfiguration screenResolution(@Nullable
                                                      Size screenResolution)

The screen resolution.

screenViewPort

@NonNull
public SubjectConfiguration screenViewPort(@Nullable
                                                    Size screenViewPort)

The screen viewport.

colorDepth

@NonNull
public SubjectConfiguration colorDepth(@Nullable
                                                Integer colorDepth)

The color depth.

getUserId

@Nullable
public String getUserId()

Specified by:

getUserId in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setUserId

public void setUserId(@Nullable
                      String userId)

Specified by:

setUserId in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

getNetworkUserId

@Nullable
public String getNetworkUserId()

Specified by:

getNetworkUserId in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setNetworkUserId

public void setNetworkUserId(@Nullable
                             String networkUserId)

Specified by:

setNetworkUserId in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

getDomainUserId

@Nullable
public String getDomainUserId()

Specified by:

getDomainUserId in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setDomainUserId

public void setDomainUserId(@Nullable
                            String domainUserId)

Specified by:

setDomainUserId in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

getUseragent

@Nullable
public String getUseragent()

Specified by:

getUseragent in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setUseragent

public void setUseragent(@Nullable
                         String useragent)

Specified by:

setUseragent in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

getIpAddress

@Nullable
public String getIpAddress()

Specified by:

getIpAddress in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setIpAddress

public void setIpAddress(@Nullable
                         String ipAddress)

Specified by:

setIpAddress in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

getTimezone

@Nullable
public String getTimezone()

Specified by:

getTimezone in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setTimezone

public void setTimezone(@Nullable
                        String timezone)

Specified by:

setTimezone in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

getLanguage

@Nullable
public String getLanguage()

Specified by:

getLanguage in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setLanguage

public void setLanguage(@Nullable
                        String language)

Specified by:

setLanguage in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

getScreenResolution

@Nullable
public Size getScreenResolution()

Specified by:

getScreenResolution in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setScreenResolution

public void setScreenResolution(@Nullable
                                Size screenResolution)

Specified by:

setScreenResolution in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

getScreenViewPort

@Nullable
public Size getScreenViewPort()

Specified by:

getScreenViewPort in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setScreenViewPort

public void setScreenViewPort(@Nullable
                              Size screenViewPort)

Specified by:

setScreenViewPort in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

getColorDepth

@Nullable
public Integer getColorDepth()

Specified by:

getColorDepth in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

setColorDepth

public void setColorDepth(@Nullable
                          Integer colorDepth)

Specified by:

setColorDepth in interface com.snowplowanalytics.snowplow.internal.tracker.SubjectConfigurationInterface

copy

@NonNull
public SubjectConfiguration copy()

Specified by:

copy in interface Configuration