Skip navigation links
A B C D E F G H I L M N O P Q R S T U V 

A

AbstractEvent - Class in com.snowplowanalytics.snowplow.tracker.events
Base AbstractEvent class which contains elements that can be set in all events.
AbstractEvent(AbstractEvent.Builder<?>) - Constructor for class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
 
AbstractEvent.Builder<T extends AbstractEvent.Builder<T>> - Class in com.snowplowanalytics.snowplow.tracker.events
 
AbstractHttpClientAdapter - Class in com.snowplowanalytics.snowplow.tracker.http
Abstract HttpClient class.
AbstractHttpClientAdapter(String) - Constructor for class com.snowplowanalytics.snowplow.tracker.http.AbstractHttpClientAdapter
 
action(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.Structured.Builder
Required.
add(TrackerPayload) - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
Adds a TrackerPayload to the EventStore buffer.
add(TrackerPayload) - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.Emitter
Adds a payload to the buffer and checks whether we have reached the buffer limit yet.
add(String, String) - Method in interface com.snowplowanalytics.snowplow.tracker.payload.Payload
Add a key-value pair to the payload.
add(String, String) - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Deprecated.
add(String, String) - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
Add a key-value pair to the payload.
addEvent(TrackerPayload) - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.EventStore
Add TrackerPayload to buffer.
addEvent(TrackerPayload) - Method in class com.snowplowanalytics.snowplow.tracker.emitter.InMemoryEventStore
Add TrackerPayload to buffer.
addMap(Map<String, String>) - Method in interface com.snowplowanalytics.snowplow.tracker.payload.Payload
Add all the mappings from the specified map.
addMap(Map<String, ?>, boolean, String, String) - Method in interface com.snowplowanalytics.snowplow.tracker.payload.Payload
Add a map to the Payload with a key dependent on the base 64 encoding option you choose using the two keys provided.
addMap(Map<String, String>) - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Deprecated.
addMap(Map<String, ?>, boolean, String, String) - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Deprecated.
addMap(Map<String, String>) - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
Add all the mappings from the specified map.
addMap(Map<String, ?>, boolean, String, String) - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
Add a map to the Payload with a key dependent on the base 64 encoding option you choose using the two keys provided.
affiliation(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Optional.
ApacheHttpClientAdapter - Class in com.snowplowanalytics.snowplow.tracker.http
A HttpClient built using Apache to send events via GET or POST requests.
ApacheHttpClientAdapter(String, CloseableHttpClient) - Constructor for class com.snowplowanalytics.snowplow.tracker.http.ApacheHttpClientAdapter
 
APP_ID - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 

B

base64Encode(String, Charset) - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Encodes a string into Base64.
base64Encoded(boolean) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.TrackerConfiguration
Whether JSONs in the payload should be base-64 encoded (default is true)
BatchEmitter - Class in com.snowplowanalytics.snowplow.tracker.emitter
An emitter that emits a batch of events in a single HTTP request.
BatchEmitter(NetworkConfiguration, EmitterConfiguration) - Constructor for class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
Creates a BatchEmitter object from configuration objects.
BatchEmitter(NetworkConfiguration) - Constructor for class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
Creates a BatchEmitter instance using a NetworkConfiguration.
BatchPayload - Class in com.snowplowanalytics.snowplow.tracker.emitter
A wrapper for a number of TrackerPayloads.
BatchPayload(Long, List<TrackerPayload>) - Constructor for class com.snowplowanalytics.snowplow.tracker.emitter.BatchPayload
 
batchSize(int) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
The default batch size is 50.
bufferCapacity(int) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
The default buffer capacity is 10 000 events.
build() - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
 
build() - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem.Builder
 
build() - Method in class com.snowplowanalytics.snowplow.tracker.events.PageView.Builder
 
build() - Method in class com.snowplowanalytics.snowplow.tracker.events.ScreenView.Builder
 
build() - Method in class com.snowplowanalytics.snowplow.tracker.events.SelfDescribing.Builder
 
build() - Method in class com.snowplowanalytics.snowplow.tracker.events.Structured.Builder
 
build() - Method in class com.snowplowanalytics.snowplow.tracker.events.Timing.Builder
 
builder() - Static method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
 
Builder() - Constructor for class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent.Builder
 
builder() - Static method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction
 
Builder() - Constructor for class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
 
builder() - Static method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem
 
Builder() - Constructor for class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem.Builder
 
builder() - Static method in class com.snowplowanalytics.snowplow.tracker.events.PageView
 
Builder() - Constructor for class com.snowplowanalytics.snowplow.tracker.events.PageView.Builder
 
builder() - Static method in class com.snowplowanalytics.snowplow.tracker.events.ScreenView
 
Builder() - Constructor for class com.snowplowanalytics.snowplow.tracker.events.ScreenView.Builder
 
builder() - Static method in class com.snowplowanalytics.snowplow.tracker.events.SelfDescribing
 
Builder() - Constructor for class com.snowplowanalytics.snowplow.tracker.events.SelfDescribing.Builder
 
builder() - Static method in class com.snowplowanalytics.snowplow.tracker.events.Structured
 
Builder() - Constructor for class com.snowplowanalytics.snowplow.tracker.events.Structured.Builder
 
builder() - Static method in class com.snowplowanalytics.snowplow.tracker.events.Timing
 
Builder() - Constructor for class com.snowplowanalytics.snowplow.tracker.events.Timing.Builder
 

C

callback(EmitterCallback) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Provide a custom EmitterCallback to access successfully sent or failed event payloads.
category(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem.Builder
Optional.
category(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.Structured.Builder
Required.
category(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.Timing.Builder
Required.
city(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Optional.
cleanupAfterSendingAttempt(boolean, long) - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.EventStore
Finish processing events after a request has been made.
cleanupAfterSendingAttempt(boolean, long) - Method in class com.snowplowanalytics.snowplow.tracker.emitter.InMemoryEventStore
Finish processing events after a request has been made.
clear() - Method in class com.snowplowanalytics.snowplow.tracker.http.CollectorCookieJar
 
close() - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
Attempt to send all remaining events, then shut down the ExecutorService.
close() - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.Emitter
Safely shuts down the Emitter.
close() - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
Attempts to send all remaining events, then shuts down the Emitter so that no more events can be sent.
CollectorCookie - Class in com.snowplowanalytics.snowplow.tracker.http
 
CollectorCookieJar - Class in com.snowplowanalytics.snowplow.tracker.http
 
CollectorCookieJar() - Constructor for class com.snowplowanalytics.snowplow.tracker.http.CollectorCookieJar
 
collectorUrl(String) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.NetworkConfiguration
Sets the endpoint url for when a httpClientAdapter is not specified.
COLOR_DEPTH - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
colorDepth(int) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
 
colorDepth(int) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the color depth parameter and returns itself
com.snowplowanalytics.snowplow.tracker - package com.snowplowanalytics.snowplow.tracker
 
com.snowplowanalytics.snowplow.tracker.configuration - package com.snowplowanalytics.snowplow.tracker.configuration
 
com.snowplowanalytics.snowplow.tracker.constants - package com.snowplowanalytics.snowplow.tracker.constants
 
com.snowplowanalytics.snowplow.tracker.emitter - package com.snowplowanalytics.snowplow.tracker.emitter
 
com.snowplowanalytics.snowplow.tracker.events - package com.snowplowanalytics.snowplow.tracker.events
 
com.snowplowanalytics.snowplow.tracker.http - package com.snowplowanalytics.snowplow.tracker.http
 
com.snowplowanalytics.snowplow.tracker.payload - package com.snowplowanalytics.snowplow.tracker.payload
 
Constants - Class in com.snowplowanalytics.snowplow.tracker.constants
Constants that apply to schemas, event types and sending protocols.
Constants() - Constructor for class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
CONTEXT - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
context - Variable in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
 
CONTEXT_ENCODED - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
country(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Optional.
createTracker(TrackerConfiguration, NetworkConfiguration, EmitterConfiguration, SubjectConfiguration) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Create a Snowplow tracker using Configuration objects.
createTracker(String, String, String) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Create a Snowplow tracker with default configuration by providing three parameters.
createTracker(TrackerConfiguration, NetworkConfiguration, EmitterConfiguration) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Create a Snowplow tracker using Configuration objects.
createTracker(TrackerConfiguration, NetworkConfiguration) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Create a Snowplow tracker using Configuration objects.
createTracker(TrackerConfiguration, NetworkConfiguration, SubjectConfiguration) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Create a Snowplow tracker using Configuration objects.
currency(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Optional.
currency(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem.Builder
Optional.
customContext(List<SelfDescribingJson>) - Method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent.Builder
Adds a list of custom context entities.
customRetryForStatusCodes(Map<Integer, Boolean>) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Set custom retry rules for HTTP status codes received in emit responses from the Collector.

D

DATA - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
DEVICE_CREATED_TIMESTAMP - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
DEVICE_SENT_TIMESTAMP - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
DevicePlatform - Enum in com.snowplowanalytics.snowplow.tracker
The supported platform options for Tracker objects.
doGet(String) - Method in class com.snowplowanalytics.snowplow.tracker.http.AbstractHttpClientAdapter
Sends the Map of key-value pairs for the event as a GET request to the endpoint.
doGet(String) - Method in class com.snowplowanalytics.snowplow.tracker.http.ApacheHttpClientAdapter
Attempts to send a group of payloads with a GET request to the configured endpoint.
doGet(String) - Method in class com.snowplowanalytics.snowplow.tracker.http.OkHttpClientAdapter
Attempts to send a group of payloads with a GET request to the configured endpoint.
DOMAIN_UID - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
domainSessionId(String) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
 
domainSessionId(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the user inputted Domain Session ID for the subject and returns itself
domainUserId(String) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
 
domainUserId(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the user inputted Domain User Id for the subject and returns itself
doPost(String, String) - Method in class com.snowplowanalytics.snowplow.tracker.http.AbstractHttpClientAdapter
Sends the SelfDescribingJson string containing the events as a POST request to the endpoint.
doPost(String, String) - Method in class com.snowplowanalytics.snowplow.tracker.http.ApacheHttpClientAdapter
Attempts to send a group of payloads with a POST request to the configured endpoint.
doPost(String, String) - Method in class com.snowplowanalytics.snowplow.tracker.http.OkHttpClientAdapter
Attempts to send a group of payloads with a POST request to the configured endpoint.

E

EcommerceTransaction - Class in com.snowplowanalytics.snowplow.tracker.events
Constructs an EcommerceTransaction event object.
EcommerceTransaction(EcommerceTransaction.Builder<?>) - Constructor for class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction
 
EcommerceTransaction.Builder<T extends EcommerceTransaction.Builder<T>> - Class in com.snowplowanalytics.snowplow.tracker.events
 
EcommerceTransactionItem - Class in com.snowplowanalytics.snowplow.tracker.events
Constructs an EcommerceTransactionItem object.
EcommerceTransactionItem(EcommerceTransactionItem.Builder<?>) - Constructor for class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem
 
EcommerceTransactionItem.Builder<T extends EcommerceTransactionItem.Builder<T>> - Class in com.snowplowanalytics.snowplow.tracker.events
 
EID - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
Emitter - Interface in com.snowplowanalytics.snowplow.tracker.emitter
Emitter interface.
EmitterCallback - Interface in com.snowplowanalytics.snowplow.tracker.emitter
This interface allows the user to provide callbacks for when events are successfully sent to the event collector, or at other times when data loss may occur, specified using the FailureType enum.
EmitterConfiguration - Class in com.snowplowanalytics.snowplow.tracker.configuration
 
EmitterConfiguration() - Constructor for class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Create an EmitterConfiguration instance.
equals(Object) - Method in class com.snowplowanalytics.snowplow.tracker.events.SelfDescribing
 
equals(Object) - Method in class com.snowplowanalytics.snowplow.tracker.http.CollectorCookie
 
equals(Object) - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
 
EVENT - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
Event - Interface in com.snowplowanalytics.snowplow.tracker.events
The event interface
EVENT_ECOMM - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
EVENT_ECOMM_ITEM - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
EVENT_PAGE_VIEW - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
EVENT_SELF_DESCRIBING - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
EVENT_STRUCTURED - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
eventData(SelfDescribingJson) - Method in class com.snowplowanalytics.snowplow.tracker.events.SelfDescribing.Builder
Required.
eventStore(EventStore) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
The default EventStore is InMemoryEventStore.
EventStore - Interface in com.snowplowanalytics.snowplow.tracker.emitter
EventStore interface.

F

FailureType - Enum in com.snowplowanalytics.snowplow.tracker.emitter
The supported failure options for EmitterCallback.
flushBuffer() - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
Forces all the payloads currently in the buffer to be sent immediately, as a single request.
flushBuffer() - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.Emitter
This can be used to manually send all buffered events.

G

get(TrackerPayload) - Method in class com.snowplowanalytics.snowplow.tracker.http.AbstractHttpClientAdapter
Sends a payload via a GET request.
get(TrackerPayload) - Method in interface com.snowplowanalytics.snowplow.tracker.http.HttpClientAdapter
Sends a single TrackerPayload via a GET request
getAllEvents() - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.EventStore
Get a copy of all the TrackerPayloads in the buffer.
getAllEvents() - Method in class com.snowplowanalytics.snowplow.tracker.emitter.InMemoryEventStore
Get a copy of all the TrackerPayloads in the buffer.
getAppId() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.TrackerConfiguration
Returns the application ID.
getAppId() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerParameters
 
getAppId() - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
 
getBase64Encoded() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerParameters
 
getBase64Encoded() - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
 
getBatchId() - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchPayload
 
getBatchSize() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Returns the number of events to send per request (batched).
getBatchSize() - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
Gets the Emitter batchSize
getBatchSize() - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.Emitter
Gets the Emitter Batch Size
getBuffer() - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
Returns a List of Payloads that are in the buffer.
getBuffer() - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.Emitter
Returns the List of Payloads that are in the buffer.
getBufferCapacity() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Returns the maximum number of events to buffer in memory.
getByteSize() - Method in interface com.snowplowanalytics.snowplow.tracker.payload.Payload
Returns the byte size of a payload.
getByteSize() - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Returns the byte size of a payload.
getByteSize() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
Returns the byte size of a payload.
getCallback() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Returns the custom callback which is called when events are successfully sent to the collector, or after certain failure conditions.
getCollectorUrl() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.NetworkConfiguration
Returns the event collector URL endpoint.
getColorDepth() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the color depth.
getContext() - Method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
 
getContext() - Method in interface com.snowplowanalytics.snowplow.tracker.events.Event
 
getCustomRetryForStatusCodes() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Returns the custom configuration for HTTP status codes.
getDefaultTracker() - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
 
getDeviceCreatedTimestamp() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
 
getDomainSessionId() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the domain session ID (UUID string).
getDomainUserId() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the domain user ID (UUID string).
getEmitter() - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
 
getEventId() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
 
getEventId() - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Generates a random UUID for each event.
getEventsBatch(int) - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.EventStore
Remove some TrackerPayloads from the buffer.
getEventsBatch(int) - Method in class com.snowplowanalytics.snowplow.tracker.emitter.InMemoryEventStore
Remove some TrackerPayloads from the buffer.
getEventStore() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Returns the EventStore used to buffer events.
getHttpClient() - Method in class com.snowplowanalytics.snowplow.tracker.http.AbstractHttpClientAdapter
Returns the HttpClient in use; it is up to the developer to cast it back to its original class.
getHttpClient() - Method in class com.snowplowanalytics.snowplow.tracker.http.ApacheHttpClientAdapter
Returns the HttpClient in use; it is up to the developer to cast it back to its original class.
getHttpClient() - Method in interface com.snowplowanalytics.snowplow.tracker.http.HttpClientAdapter
Returns the HttpClient in use; it is up to the developer to cast it back to its original class.
getHttpClient() - Method in class com.snowplowanalytics.snowplow.tracker.http.OkHttpClientAdapter
Returns the HttpClient in use; it is up to the developer to cast it back to its original class.
getHttpClientAdapter() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.NetworkConfiguration
Returns the HttpClientAdapter used.
getInstancedTrackerNamespaces() - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
 
getIpAddress() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the IP address.
getItems() - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction
The list of EcommerceTransactionItems passed with the event.
getLanguage() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the device language.
getMap() - Method in interface com.snowplowanalytics.snowplow.tracker.payload.Payload
Returns the Payload as a HashMap.
getMap() - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Returns the Payload as a Map.
getMap() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
Returns the Payload as a Map.
getNamespace() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.TrackerConfiguration
Returns the unique tracker namespace.
getNamespace() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerParameters
 
getNamespace() - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
 
getNetworkUserId() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the network user ID (UUID string).
getParameters() - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
 
getPayload() - Method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
 
getPayload() - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction
Returns a TrackerPayload which can be passed to an Emitter.
getPayload() - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem
Returns a TrackerPayload which can be passed to an Emitter.
getPayload() - Method in interface com.snowplowanalytics.snowplow.tracker.events.Event
 
getPayload() - Method in class com.snowplowanalytics.snowplow.tracker.events.PageView
Returns a TrackerPayload which can be passed to an Emitter.
getPayload() - Method in class com.snowplowanalytics.snowplow.tracker.events.ScreenView
Return the payload wrapped into a SelfDescribingJson.
getPayload() - Method in class com.snowplowanalytics.snowplow.tracker.events.SelfDescribing
Returns a TrackerPayload which can be passed to an Emitter.
getPayload() - Method in class com.snowplowanalytics.snowplow.tracker.events.Structured
Returns a TrackerPayload which can be passed to an Emitter.
getPayload() - Method in class com.snowplowanalytics.snowplow.tracker.events.Timing
Return the payload wrapped into a SelfDescribingJson.
getPayloads() - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchPayload
 
getPlatform() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.TrackerConfiguration
Returns the DevicePlatform for the tracker.
getPlatform() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerParameters
 
getPlatform() - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
 
getRequestExecutorService() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Returns the ScheduledExecutorService used for sending events.
getScreenResHeight() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the screen resolution height, in pixels.
getScreenResWidth() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the screen resolution width, in pixels.
getSubject() - Method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
 
getSubject() - Method in interface com.snowplowanalytics.snowplow.tracker.events.Event
 
getSubject() - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Gets the Subject pairs.
getSubject() - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
 
getThreadCount() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Returns the number of threads used for event sending using the ScheduledExecutorService.
getTimestamp() - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Returns the current System time as a String.
getTimezone() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the timezone.
getTimezone() - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Gets the default timezone of the server running the library.
getTracker(String) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Get a Tracker by its namespace
getTrackerVersion() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerParameters
 
getTrackerVersion() - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
The Java tracker release version, e.g.
getTransactionId() - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Returns a Transaction ID integer.
getTrueTimestamp() - Method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
 
getTrueTimestamp() - Method in interface com.snowplowanalytics.snowplow.tracker.events.Event
 
getUrl() - Method in class com.snowplowanalytics.snowplow.tracker.http.AbstractHttpClientAdapter
Returns the HttpClient URI
getUrl() - Method in interface com.snowplowanalytics.snowplow.tracker.http.HttpClientAdapter
Returns the HttpClient URI
getUseragent() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the useragent.
getUserId() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the user ID.
getUTF8Length(String) - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Count the number of bytes a string will occupy when UTF-8 encoded
getViewPortHeight() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the viewport height, in pixels.
getViewPortWidth() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Returns the viewport width, in pixels.

H

hashCode() - Method in class com.snowplowanalytics.snowplow.tracker.events.SelfDescribing
 
hashCode() - Method in class com.snowplowanalytics.snowplow.tracker.http.CollectorCookie
 
hashCode() - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
 
httpClientAdapter(HttpClientAdapter) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.NetworkConfiguration
Sets a custom HttpClientAdapter (default is OkHttpClientAdapter).
HttpClientAdapter - Interface in com.snowplowanalytics.snowplow.tracker.http
Interface for all HttpClients

I

id(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.ScreenView.Builder
One of name or id is required.
InMemoryEventStore - Class in com.snowplowanalytics.snowplow.tracker.emitter
Buffers events (as TrackerPayloads) in memory for sending via the BatchEmitter.
InMemoryEventStore(int) - Constructor for class com.snowplowanalytics.snowplow.tracker.emitter.InMemoryEventStore
Create a InMemoryEventStore object with custom queue capacity.
InMemoryEventStore() - Constructor for class com.snowplowanalytics.snowplow.tracker.emitter.InMemoryEventStore
Create a InMemoryEventStore object with default buffer size (10 000 events).
IP_ADDRESS - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
ipAddress(String) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
 
ipAddress(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the user inputted ip address for the subject and returns itself
isBase64Encoded() - Method in class com.snowplowanalytics.snowplow.tracker.configuration.TrackerConfiguration
Returns whether JSONs in the payload are base-64 encoded.
isExpired() - Method in class com.snowplowanalytics.snowplow.tracker.http.CollectorCookie
 
isSuccessfulSend(int) - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
Checks whether the response code was a success or not.
isValidUrl(String) - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Validates a uri and checks that it is valid before being used by the emitter.
itemId(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem.Builder
Required.
items(List<EcommerceTransactionItem>) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Provide a list of EcommerceTransactionItems.
items(EcommerceTransactionItem...) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Provide EcommerceTransactionItems directly, without explicitly adding them to a list beforehand.

L

label(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.Structured.Builder
Optional.
label(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.Timing.Builder
Optional.
language(String) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
 
LANGUAGE - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
language(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the language parameter and returns itself
loadForRequest(HttpUrl) - Method in class com.snowplowanalytics.snowplow.tracker.http.CollectorCookieJar
 

M

mapToJSONString(Map<String, ?>) - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Processes a Map into a JSON String or returns an empty String if it fails
mapToQueryString(Map<String, ?>) - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Builds a QueryString from a Map of Name-Value pairs.

N

name(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem.Builder
Optional.
name(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.ScreenView.Builder
One of name or id is required.
NAMESPACE - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
NETWORK_UID - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
NetworkConfiguration - Class in com.snowplowanalytics.snowplow.tracker.configuration
 
NetworkConfiguration(HttpClientAdapter) - Constructor for class com.snowplowanalytics.snowplow.tracker.configuration.NetworkConfiguration
Create a NetworkConfiguration instance and specify a custom HttpClientAdapter to use (the default is OkHttpClientAdapter).
NetworkConfiguration(String) - Constructor for class com.snowplowanalytics.snowplow.tracker.configuration.NetworkConfiguration
Create a NetworkConfiguration instance with a collector endpoint URL.
networkUserId(String) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
This overrides the network user ID set by the Collector in response Cookies.
networkUserId(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the user inputted Network User ID for the subject and returns itself.

O

OkHttpClientAdapter - Class in com.snowplowanalytics.snowplow.tracker.http
A HttpClient built using OkHttp to send events via GET or POST requests.
OkHttpClientAdapter(String, OkHttpClient) - Constructor for class com.snowplowanalytics.snowplow.tracker.http.OkHttpClientAdapter
 
OkHttpClientAdapter(String) - Constructor for class com.snowplowanalytics.snowplow.tracker.http.OkHttpClientAdapter
 
OkHttpClientWithCookieJarAdapter - Class in com.snowplowanalytics.snowplow.tracker.http
A HttpClient built using OkHttp to send events via GET or POST requests.
OkHttpClientWithCookieJarAdapter(String) - Constructor for class com.snowplowanalytics.snowplow.tracker.http.OkHttpClientWithCookieJarAdapter
 
onFailure(FailureType, boolean, List<TrackerPayload>) - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.EmitterCallback
 
onSuccess(List<TrackerPayload>) - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.EmitterCallback
 
orderId(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Required.

P

PAGE_REFR - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
PAGE_TITLE - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
PAGE_URL - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
pageTitle(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.PageView.Builder
Optional.
pageUrl(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.PageView.Builder
Required.
PageView - Class in com.snowplowanalytics.snowplow.tracker.events
Constructs a PageView event object.
PageView(PageView.Builder<?>) - Constructor for class com.snowplowanalytics.snowplow.tracker.events.PageView
 
PageView.Builder<T extends PageView.Builder<T>> - Class in com.snowplowanalytics.snowplow.tracker.events
 
Parameter - Class in com.snowplowanalytics.snowplow.tracker.constants
More constants that define the event properties, which apply to schemas, event types and sending protocols.
Parameter() - Constructor for class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
Payload - Interface in com.snowplowanalytics.snowplow.tracker.payload
The Payload is used to store all the parameters and configurations that are used to send data via the HTTP GET/POST request.
payload - Variable in class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
 
platform(DevicePlatform) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.TrackerConfiguration
The DevicePlatform the tracker is running on (default is "srv", ServerSideApp).
PLATFORM - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
post(SelfDescribingJson) - Method in class com.snowplowanalytics.snowplow.tracker.http.AbstractHttpClientAdapter
Sends a payload via a POST request.
post(SelfDescribingJson) - Method in interface com.snowplowanalytics.snowplow.tracker.http.HttpClientAdapter
Sends a group of events compressed into a single SelfDescribingJson payload
POST_CONTENT_TYPE - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
price(Double) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem.Builder
Required.
property(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.Structured.Builder
Optional.
PROTOCOL_VENDOR - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
PROTOCOL_VERSION - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
putTrueTimestamp(TrackerPayload) - Method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
Adds the default parameters to a TrackerPayload object.

Q

quantity(Integer) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem.Builder
Required.

R

referrer(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.PageView.Builder
Optional.
registerTracker(Tracker) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Register a Tracker instance that was created manually, not via the Snowplow.createTracker() method.
removeTracker(String) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Unregister a Tracker, using its namespace.
removeTracker(Tracker) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Unregister a Tracker.
requestExecutorService(ScheduledExecutorService) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Set a custom ScheduledExecutorService to send http requests (default is ScheduledThreadPoolExecutor).
reset() - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Clear (unregister) all trackers.
RESOLUTION - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 

S

saveFromResponse(HttpUrl, List<Cookie>) - Method in class com.snowplowanalytics.snowplow.tracker.http.CollectorCookieJar
 
SCHEMA - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
SCHEMA_CONTEXTS - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
SCHEMA_PAYLOAD_DATA - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
SCHEMA_SCREEN_VIEW - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
SCHEMA_SELF_DESCRIBING_EVENT - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
SCHEMA_USER_TIMINGS - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Constants
 
screenResolution(int, int) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Set the screen resolution.
screenResolution(int, int) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the screen res parameter and returns itself
ScreenView - Class in com.snowplowanalytics.snowplow.tracker.events
Constructs a ScreenView event object.
ScreenView(ScreenView.Builder<?>) - Constructor for class com.snowplowanalytics.snowplow.tracker.events.ScreenView
 
ScreenView.Builder<T extends ScreenView.Builder<T>> - Class in com.snowplowanalytics.snowplow.tracker.events
 
SE_ACTION - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
SE_CATEGORY - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
SE_LABEL - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
SE_PROPERTY - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
SE_VALUE - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
self() - Method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent.Builder
 
SELF_DESCRIBING - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
SELF_DESCRIBING_ENCODED - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
SelfDescribing - Class in com.snowplowanalytics.snowplow.tracker.events
Constructs a SelfDescribing event object.
SelfDescribing(SelfDescribing.Builder<?>) - Constructor for class com.snowplowanalytics.snowplow.tracker.events.SelfDescribing
 
SelfDescribing.Builder<T extends SelfDescribing.Builder<T>> - Class in com.snowplowanalytics.snowplow.tracker.events
 
SelfDescribingJson - Class in com.snowplowanalytics.snowplow.tracker.payload
Builds a SelfDescribingJson object.
SelfDescribingJson(String) - Constructor for class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Creates a SelfDescribingJson with only a Schema String and an empty data map.
SelfDescribingJson(String, TrackerPayload) - Constructor for class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Creates a SelfDescribingJson with a Schema and a TrackerPayload object.
SelfDescribingJson(String, SelfDescribingJson) - Constructor for class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Creates a SelfDescribingJson with a Schema and a SelfDescribingJson object.
SelfDescribingJson(String, Object) - Constructor for class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Creates a SelfDescribingJson with a Schema and a data object.
SESSION_UID - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
setBase64Encode(boolean) - Method in class com.snowplowanalytics.snowplow.tracker.events.SelfDescribing
 
setBatchSize(int) - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
Customize the emitter batch size to any valid integer greater than zero.
setBatchSize(int) - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.Emitter
Customize the emitter batch size to any valid integer greater than zero.
setColorDepth(int) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the color depth parameter
setData(TrackerPayload) - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Adds data to the SelfDescribingJson from a TrackerPayload object.
setData(Object) - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Adds data to the SelfDescribingJson
setData(SelfDescribingJson) - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Allows us to add data from one SelfDescribingJson into another without copying over the Schema.
setDefaultTracker(Tracker) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Set a specific Tracker instance as the default tracker.
setDefaultTracker(String) - Static method in class com.snowplowanalytics.snowplow.tracker.Snowplow
Set a registered Tracker as the default tracker, using its namespace.
setDomainSessionId(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
User inputted Domain Session ID for the subject.
setDomainUserId(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
User inputted Domain User Id for the subject.
setEmitter(Emitter) - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
Change the Emitter used to send events.
setIpAddress(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
User inputted ip address for the subject.
setLanguage(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the language parameter
setNetworkUserId(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
User inputted Network User ID for the subject.
setSchema(String) - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Sets the Schema for the SelfDescribingJson
setScreenResolution(int, int) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the screen res parameter
setSubject(Subject) - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
Sets a new Subject object which will get attached to each event payload.
setTimezone(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the timezone parameter.
setUseragent(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
User inputted useragent for the subject.
setUserId(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the User ID
setViewPort(int, int) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the view port parameter
shipping(Double) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Optional.
shouldRetry(int) - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter
 
size() - Method in class com.snowplowanalytics.snowplow.tracker.emitter.BatchPayload
 
size() - Method in interface com.snowplowanalytics.snowplow.tracker.emitter.EventStore
Get the current size of the buffer.
size() - Method in class com.snowplowanalytics.snowplow.tracker.emitter.InMemoryEventStore
Get the current size of the buffer.
sku(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransactionItem.Builder
Required.
Snowplow - Class in com.snowplowanalytics.snowplow.tracker
 
Snowplow() - Constructor for class com.snowplowanalytics.snowplow.tracker.Snowplow
 
state(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Optional.
Structured - Class in com.snowplowanalytics.snowplow.tracker.events
Constructs a Structured event object.
Structured(Structured.Builder<?>) - Constructor for class com.snowplowanalytics.snowplow.tracker.events.Structured
 
Structured.Builder<T extends Structured.Builder<T>> - Class in com.snowplowanalytics.snowplow.tracker.events
 
subject(Subject) - Method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent.Builder
A custom Subject for the event.
subject - Variable in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
 
Subject - Class in com.snowplowanalytics.snowplow.tracker
An object for managing extra event decoration.
Subject(SubjectConfiguration) - Constructor for class com.snowplowanalytics.snowplow.tracker.Subject
Creates a Subject instance from a SubjectConfiguration.
Subject() - Constructor for class com.snowplowanalytics.snowplow.tracker.Subject
Creates a Subject instance with default configuration (only the timezone is set).
Subject(Subject) - Constructor for class com.snowplowanalytics.snowplow.tracker.Subject
Creates a new Subject object based on the map of another Subject object.
SubjectConfiguration - Class in com.snowplowanalytics.snowplow.tracker.configuration
 
SubjectConfiguration() - Constructor for class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Create a Subject instance.
SV_ID - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
SV_NAME - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 

T

taxValue(Double) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Optional.
threadCount(int) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration
Sets the Thread Count for the ScheduledExecutorService (default is 50).
TI_ITEM_CATEGORY - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TI_ITEM_CURRENCY - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TI_ITEM_ID - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TI_ITEM_NAME - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TI_ITEM_PRICE - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TI_ITEM_QUANTITY - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TI_ITEM_SKU - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
timezone(String) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Note that timezone is set by default to the server's timezone (`TimeZone tz = Calendar.getInstance().getTimeZone().getID()`)
TIMEZONE - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
timezone(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the timezone parameter and returns itself.
Timing - Class in com.snowplowanalytics.snowplow.tracker.events
Constructs a Timing event object.
Timing(Timing.Builder<?>) - Constructor for class com.snowplowanalytics.snowplow.tracker.events.Timing
 
timing(Integer) - Method in class com.snowplowanalytics.snowplow.tracker.events.Timing.Builder
Required.
Timing.Builder<T extends Timing.Builder<T>> - Class in com.snowplowanalytics.snowplow.tracker.events
 
toString() - Method in interface com.snowplowanalytics.snowplow.tracker.payload.Payload
Returns the Payload as a string.
toString() - Method in class com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson
Returns the Payload as a string.
toString() - Method in class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
Returns the Payload as a string.
totalValue(Double) - Method in class com.snowplowanalytics.snowplow.tracker.events.EcommerceTransaction.Builder
Required.
TR_AFFILIATION - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TR_CITY - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TR_COUNTRY - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TR_CURRENCY - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TR_ID - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TR_SHIPPING - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TR_STATE - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TR_TAX - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TR_TOTAL - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
track(Event) - Method in class com.snowplowanalytics.snowplow.tracker.Tracker
Handles tracking the different types of events.
Tracker - Class in com.snowplowanalytics.snowplow.tracker
Allows tracking of Events.
Tracker(TrackerConfiguration, Emitter, Subject) - Constructor for class com.snowplowanalytics.snowplow.tracker.Tracker
Creates a new Snowplow Tracker.
Tracker(TrackerConfiguration, Emitter) - Constructor for class com.snowplowanalytics.snowplow.tracker.Tracker
Creates a new Snowplow Tracker.
TRACKER_VERSION - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
TrackerConfiguration - Class in com.snowplowanalytics.snowplow.tracker.configuration
 
TrackerConfiguration(String, String) - Constructor for class com.snowplowanalytics.snowplow.tracker.configuration.TrackerConfiguration
Create a TrackerConfiguration instance.
TrackerParameters - Class in com.snowplowanalytics.snowplow.tracker.payload
A wrapper for Tracker properties.
TrackerParameters(String, DevicePlatform, String, String, boolean) - Constructor for class com.snowplowanalytics.snowplow.tracker.payload.TrackerParameters
 
TrackerPayload - Class in com.snowplowanalytics.snowplow.tracker.payload
A TrackerPayload stores a map of key - pair values.
TrackerPayload() - Constructor for class com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload
 
TRUE_TIMESTAMP - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
trueTimestamp - Variable in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent.Builder
 
trueTimestamp(Long) - Method in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent.Builder
The true timestamp of that event (as determined by the user).
trueTimestamp - Variable in class com.snowplowanalytics.snowplow.tracker.events.AbstractEvent
The trueTimestamp may be null if none is set.

U

UID - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
url - Variable in class com.snowplowanalytics.snowplow.tracker.http.AbstractHttpClientAdapter
 
urlEncodeUTF8(Object) - Static method in class com.snowplowanalytics.snowplow.tracker.Utils
Encodes an Object in UTF-8.
useragent(String) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
 
USERAGENT - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
useragent(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the user inputted useragent for the subject and returns itself
userId(String) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Set a unique user ID.
userId(String) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the User ID and returns itself
UT_CATEGORY - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
UT_LABEL - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
UT_TIMING - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
UT_VARIABLE - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
Utils - Class in com.snowplowanalytics.snowplow.tracker
Provides basic Utilities for the Snowplow Tracker.
Utils() - Constructor for class com.snowplowanalytics.snowplow.tracker.Utils
 

V

value(Double) - Method in class com.snowplowanalytics.snowplow.tracker.events.Structured.Builder
Optional.
valueOf(String) - Static method in enum com.snowplowanalytics.snowplow.tracker.DevicePlatform
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.snowplowanalytics.snowplow.tracker.emitter.FailureType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.snowplowanalytics.snowplow.tracker.DevicePlatform
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.snowplowanalytics.snowplow.tracker.emitter.FailureType
Returns an array containing the constants of this enum type, in the order they are declared.
variable(String) - Method in class com.snowplowanalytics.snowplow.tracker.events.Timing.Builder
Required.
Version - Class in com.snowplowanalytics.snowplow.tracker
The release version of the Snowplow Java tracker.
Version() - Constructor for class com.snowplowanalytics.snowplow.tracker.Version
 
viewPort(int, int) - Method in class com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration
Set the viewport size.
VIEWPORT - Static variable in class com.snowplowanalytics.snowplow.tracker.constants.Parameter
 
viewPort(int, int) - Method in class com.snowplowanalytics.snowplow.tracker.Subject
Sets the view port parameter and returns itself
A B C D E F G H I L M N O P Q R S T U V 
Skip navigation links