org.piwik.sdk

Class TrackMe

java.lang.Object

org.piwik.sdk.TrackMe

public class TrackMe
extends java.lang.Object

This objects represents one query to Piwik. For each event send to Piwik a TrackMe gets created, either explicitly by you or implicitly by the Tracker.

Constructor Summary

Constructors

Constructor and Description
TrackMe()
TrackMe(TrackMe trackMe)

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(QueryParams queryParams)
java.lang.String	get(java.lang.String queryParams) Consider using QueryParams instead of raw strings
boolean	has(QueryParams queryParams)
boolean	isEmpty()
TrackMe	putAll(TrackMe trackMe) Adds TrackMe to this TrackMe, overriding values if necessary.
TrackMe	set(QueryParams key, float value)
TrackMe	set(QueryParams key, int value)
TrackMe	set(QueryParams key, long value)
TrackMe	set(QueryParams key, java.lang.String value) You can set any additional Tracking API Parameters within the SDK.
TrackMe	set(java.lang.String key, java.lang.String value) Consider using QueryParams instead of raw strings
java.util.Map<java.lang.String,java.lang.String>	toMap() The tracker calls this to get the final data that will be transmitted
TrackMe	trySet(QueryParams key, float value) Only sets the value if it doesn't exist.
TrackMe	trySet(QueryParams key, int value) Only sets the value if it doesn't exist.
TrackMe	trySet(QueryParams key, long value)
TrackMe	trySet(QueryParams key, java.lang.String value) Only sets the value if it doesn't exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrackMe

public TrackMe()

TrackMe

public TrackMe(TrackMe trackMe)

Method Detail

putAll

public TrackMe putAll(@NonNull
                      TrackMe trackMe)

Adds TrackMe to this TrackMe, overriding values if necessary.

set

public TrackMe set(@NonNull
                   java.lang.String key,
                   java.lang.String value)

Consider using QueryParams instead of raw strings

get

@Nullable
public java.lang.String get(@NonNull
                                       java.lang.String queryParams)

Consider using QueryParams instead of raw strings

set

public TrackMe set(@NonNull
                   QueryParams key,
                   java.lang.String value)

You can set any additional Tracking API Parameters within the SDK. This includes for example the local time (parameters h, m and s).

 set(QueryParams.HOURS, "10");
 set(QueryParams.MINUTES, "45");
 set(QueryParams.SECONDS, "30");
 

Parameters:

key - query params name

value - value

Returns:

tracker instance

set

public TrackMe set(@NonNull
                   QueryParams key,
                   int value)

set

public TrackMe set(@NonNull
                   QueryParams key,
                   float value)

set

public TrackMe set(@NonNull
                   QueryParams key,
                   long value)

has

public boolean has(@NonNull
                   QueryParams queryParams)

trySet

public TrackMe trySet(@NonNull
                      QueryParams key,
                      int value)

Only sets the value if it doesn't exist.

Parameters:

key - type

value - value

Returns:

this (for chaining)

trySet

public TrackMe trySet(@NonNull
                      QueryParams key,
                      float value)

Only sets the value if it doesn't exist.

Parameters:

key - type

value - value

Returns:

this (for chaining)

trySet

public TrackMe trySet(@NonNull
                      QueryParams key,
                      long value)

trySet

public TrackMe trySet(@NonNull
                      QueryParams key,
                      java.lang.String value)

Only sets the value if it doesn't exist.

Parameters:

key - type

value - value

Returns:

this (for chaining)

toMap

public java.util.Map<java.lang.String,java.lang.String> toMap()

The tracker calls this to get the final data that will be transmitted

Returns:

the parameter map, but without the base URL

get

public java.lang.String get(@NonNull
                            QueryParams queryParams)

isEmpty

public boolean isEmpty()