Tracker (tracker 4.1.1 API)

java.lang.Object
- org.matomo.sdk.Tracker

public class Tracker
extends java.lang.Object

Main tracking class This class is threadsafe.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Tracker.Callback

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Tracker.Callback`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`PREF_KEY_DISPATCHER_MODE`
`protected static java.lang.String`	`PREF_KEY_OFFLINE_CACHE_AGE`
`protected static java.lang.String`	`PREF_KEY_OFFLINE_CACHE_SIZE`
`protected static java.lang.String`	`PREF_KEY_TRACKER_FIRSTVISIT`
`protected static java.lang.String`	`PREF_KEY_TRACKER_OPTOUT`
`protected static java.lang.String`	`PREF_KEY_TRACKER_PREVIOUSVISIT`
`protected static java.lang.String`	`PREF_KEY_TRACKER_USERID`
`protected static java.lang.String`	`PREF_KEY_TRACKER_VISITCOUNT`
`protected static java.lang.String`	`PREF_KEY_TRACKER_VISITORID`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Tracker(Matomo matomo, TrackerBuilder config)

Constructors
Modifier	Constructor and Description
`protected`	`Tracker(Matomo matomo, TrackerBuilder config)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTrackingCallback(Tracker.Callback callback)`
`void`	`dispatch()` Processes all queued events in background thread
`void`	`dispatchBlocking()` Process all queued events and block until processing is complete
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getAPIUrl()`
`TrackMe`	`getDefaultTrackMe()` Matomo will use the content of this object to fill in missing values before any transmission.
`long`	`getDispatchInterval()`
`DispatchMode`	`getDispatchMode()` The current dispatch behavior.
`int`	`getDispatchTimeout()` `Dispatcher.getConnectionTimeOut()`
`java.util.List<Packet>`	`getDryRunTarget()` If we are in dry-run mode then this will return a datastructure.
`TrackMe`	`getLastEventX()` For testing purposes
`Matomo`	`getMatomo()`
`java.lang.String`	`getName()`
`long`	`getOfflineCacheAge()` See `setOfflineCacheAge(long)`
`long`	`getOfflineCacheSize()` Maximum size the offline cache is allowed to grow to.
`android.content.SharedPreferences`	`getPreferences()`
`long`	`getSessionTimeout()` Default is 30min (30601000).
`protected int`	`getSiteId()`
`java.lang.String`	`getUserId()`
`java.lang.String`	`getVisitorId()`
`int`	`hashCode()`
`boolean`	`isOptOut()`
`static java.lang.String`	`makeRandomVisitorId()`
`void`	`removeTrackingCallback(Tracker.Callback callback)`
`Tracker`	`setDispatchGzipped(boolean dispatchGzipped)` Defines if when dispatched, posted JSON must be Gzipped.
`Tracker`	`setDispatchInterval(long dispatchInterval)` Set the interval to 0 to dispatch events as soon as they are queued.
`void`	`setDispatchMode(DispatchMode mode)` Sets the dispatch mode.
`void`	`setDispatchTimeout(int timeout)` `Dispatcher.setConnectionTimeOut(int)`
`void`	`setDryRunTarget(java.util.List<Packet> dryRunTarget)` Set a data structure here to put the Dispatcher into dry-run-mode.
`void`	`setOfflineCacheAge(long age)` For how long events should be stored if they could not be send.
`void`	`setOfflineCacheSize(long size)` How large the offline cache may be.
`void`	`setOptOut(boolean optOut)` Use this to disable this Tracker, e.g.
`void`	`setSessionTimeout(int milliseconds)`
`Tracker`	`setUserId(java.lang.String userId)` Defines the User ID for this request.
`Tracker`	`setVisitorId(java.lang.String visitorId)` The unique visitor ID, must be a 16 characters hexadecimal string.
`void`	`startNewSession()`
`Tracker`	`track(TrackMe trackMe)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PREF_KEY_TRACKER_OPTOUT
```
protected static final java.lang.String PREF_KEY_TRACKER_OPTOUT
```
    See Also:
    
    Constant Field Values
  - PREF_KEY_TRACKER_USERID
```
protected static final java.lang.String PREF_KEY_TRACKER_USERID
```
    See Also:
    
    Constant Field Values
  - PREF_KEY_TRACKER_VISITORID
```
protected static final java.lang.String PREF_KEY_TRACKER_VISITORID
```
    See Also:
    
    Constant Field Values
  - PREF_KEY_TRACKER_FIRSTVISIT
```
protected static final java.lang.String PREF_KEY_TRACKER_FIRSTVISIT
```
    See Also:
    
    Constant Field Values
  - PREF_KEY_TRACKER_VISITCOUNT
```
protected static final java.lang.String PREF_KEY_TRACKER_VISITCOUNT
```
    See Also:
    
    Constant Field Values
  - PREF_KEY_TRACKER_PREVIOUSVISIT
```
protected static final java.lang.String PREF_KEY_TRACKER_PREVIOUSVISIT
```
    See Also:
    
    Constant Field Values
  - PREF_KEY_OFFLINE_CACHE_AGE
```
protected static final java.lang.String PREF_KEY_OFFLINE_CACHE_AGE
```
    See Also:
    
    Constant Field Values
  - PREF_KEY_OFFLINE_CACHE_SIZE
```
protected static final java.lang.String PREF_KEY_OFFLINE_CACHE_SIZE
```
    See Also:
    
    Constant Field Values
  - PREF_KEY_DISPATCHER_MODE
```
protected static final java.lang.String PREF_KEY_DISPATCHER_MODE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Tracker
```
protected Tracker(Matomo matomo,
                  TrackerBuilder config)
```
- Method Detail
  - addTrackingCallback
```
public void addTrackingCallback(Tracker.Callback callback)
```
  - removeTrackingCallback
```
public void removeTrackingCallback(Tracker.Callback callback)
```
  - setOptOut
```
public void setOptOut(boolean optOut)
```
    Use this to disable this Tracker, e.g. if the user opted out of tracking. The Tracker will persist the choice and remain disable on next instance creation.
    
    Parameters:
    
    optOut - true to disable reporting
  - isOptOut
```
public boolean isOptOut()
```
    Returns:
    
    true if Matomo is currently disabled
  - getName
```
public java.lang.String getName()
```
  - getMatomo
```
public Matomo getMatomo()
```
  - getAPIUrl
```
public java.lang.String getAPIUrl()
```
  - getSiteId
```
protected int getSiteId()
```
  - getDefaultTrackMe
```
public TrackMe getDefaultTrackMe()
```
    Matomo will use the content of this object to fill in missing values before any transmission. While you can modify it's values, you can also just set them in your TrackMe object as already set values will not be overwritten.
    
    Returns:
    
    the default TrackMe object
  - startNewSession
```
public void startNewSession()
```
  - setSessionTimeout
```
public void setSessionTimeout(int milliseconds)
```
  - getSessionTimeout
```
public long getSessionTimeout()
```
    Default is 30min (30*60*1000).
    
    Returns:
    
    session timeout value in miliseconds
  - getDispatchTimeout
```
public int getDispatchTimeout()
```
    Dispatcher.getConnectionTimeOut()
  - setDispatchTimeout
```
public void setDispatchTimeout(int timeout)
```
    Dispatcher.setConnectionTimeOut(int)
  - dispatch
```
public void dispatch()
```
    Processes all queued events in background thread
  - dispatchBlocking
```
public void dispatchBlocking()
```
    Process all queued events and block until processing is complete
  - setDispatchInterval
```
public Tracker setDispatchInterval(long dispatchInterval)
```
    Set the interval to 0 to dispatch events as soon as they are queued. If a negative value is used the dispatch timer will never run, a manual dispatch must be used.
    
    Parameters:
    
    dispatchInterval - in milliseconds
  - setDispatchGzipped
```
public Tracker setDispatchGzipped(boolean dispatchGzipped)
```
    Defines if when dispatched, posted JSON must be Gzipped. Need to be handle from web server side with mod_deflate/APACHE lua_zlib/NGINX.
    
    Parameters:
    
    dispatchGzipped - boolean
  - getDispatchInterval
```
public long getDispatchInterval()
```
    Returns:
    
    in milliseconds
  - setOfflineCacheAge
```
public void setOfflineCacheAge(long age)
```
    For how long events should be stored if they could not be send. Events older than the set limit will be discarded on the next dispatch attempt.
    The Matomo backend accepts backdated events for up to 24 hours by default.
    >0 = limit in ms
    0 = unlimited
    -1 = disabled offline cache
    
    Parameters:
    
    age - in milliseconds
  - getOfflineCacheAge
```
public long getOfflineCacheAge()
```
    See setOfflineCacheAge(long)
    
    Returns:
    
    maximum cache age in milliseconds
  - setOfflineCacheSize
```
public void setOfflineCacheSize(long size)
```
    How large the offline cache may be. If the limit is reached the oldest files will be deleted first. Events older than the set limit will be discarded on the next dispatch attempt.
    The Matomo backend accepts backdated events for up to 24 hours by default.
    >0 = limit in byte
    0 = unlimited
    
    Parameters:
    
    size - in byte
  - getOfflineCacheSize
```
public long getOfflineCacheSize()
```
    Maximum size the offline cache is allowed to grow to.
    
    Returns:
    
    size in byte
  - getDispatchMode
```
public DispatchMode getDispatchMode()
```
    The current dispatch behavior.
    
    See Also:
    
    DispatchMode
  - setDispatchMode
```
public void setDispatchMode(DispatchMode mode)
```
    Sets the dispatch mode.
    
    See Also:
    
    DispatchMode
  - setUserId
```
public Tracker setUserId(java.lang.String userId)
```
    Defines the User ID for this request. User ID is any non empty unique string identifying the user (such as an email address or a username). To access this value, users must be logged-in in your system so you can fetch this user ID from your system, and pass it to Matomo.
    When specified, the User ID will be "enforced". This means that if there is no recent visit with this User ID, a new one will be created. If a visit is found in the last 30 minutes with your specified User ID, then the new action will be recorded to this existing visit.
    
    Parameters:
    
    userId - passing null will delete the current user-id.
  - getUserId
```
public java.lang.String getUserId()
```
    Returns:
    
    a user-id string, either the one you set or the one Matomo generated for you.
  - setVisitorId
```
public Tracker setVisitorId(java.lang.String visitorId)
                     throws java.lang.IllegalArgumentException
```
    The unique visitor ID, must be a 16 characters hexadecimal string. Every unique visitor must be assigned a different ID and this ID must not change after it is assigned. If this value is not set Matomo will still track visits, but the unique visitors metric might be less accurate.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - getVisitorId
```
public java.lang.String getVisitorId()
```
  - track
```
public Tracker track(TrackMe trackMe)
```
  - makeRandomVisitorId
```
public static java.lang.String makeRandomVisitorId()
```
  - getPreferences
```
public android.content.SharedPreferences getPreferences()
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getLastEventX
```
public TrackMe getLastEventX()
```
    For testing purposes
    
    Returns:
    
    query of the event
  - setDryRunTarget
```
public void setDryRunTarget(java.util.List<Packet> dryRunTarget)
```
    Set a data structure here to put the Dispatcher into dry-run-mode. Data will be processed but at the last step just stored instead of transmitted. Set it to null to disable it.
    
    Parameters:
    
    dryRunTarget - a data structure the data should be passed into
  - getDryRunTarget
```
public java.util.List<Packet> getDryRunTarget()
```
    If we are in dry-run mode then this will return a datastructure.
    
    Returns:
    
    a datastructure or null

Class Tracker

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREF_KEY_TRACKER_OPTOUT

PREF_KEY_TRACKER_USERID

PREF_KEY_TRACKER_VISITORID

PREF_KEY_TRACKER_FIRSTVISIT

PREF_KEY_TRACKER_VISITCOUNT

PREF_KEY_TRACKER_PREVIOUSVISIT

PREF_KEY_OFFLINE_CACHE_AGE

PREF_KEY_OFFLINE_CACHE_SIZE

PREF_KEY_DISPATCHER_MODE

Constructor Detail

Tracker

Method Detail

addTrackingCallback

removeTrackingCallback

setOptOut

isOptOut

getName

getMatomo

getAPIUrl

getSiteId

getDefaultTrackMe

startNewSession

setSessionTimeout

getSessionTimeout

getDispatchTimeout

setDispatchTimeout

dispatch

dispatchBlocking

setDispatchInterval

setDispatchGzipped

getDispatchInterval

setOfflineCacheAge

getOfflineCacheAge

setOfflineCacheSize

getOfflineCacheSize

getDispatchMode

setDispatchMode

setUserId

getUserId

setVisitorId

getVisitorId

track

makeRandomVisitorId

getPreferences

equals

hashCode

getLastEventX

setDryRunTarget

getDryRunTarget