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

A

ActivityHelper - Class in org.matomo.sdk.tools

ActivityHelper() - Constructor for class org.matomo.sdk.tools.ActivityHelper

add(Event) - Method in class org.matomo.sdk.dispatcher.EventCache

add(int, String) - Method in class org.matomo.sdk.extra.DimensionQueue

The added id-value-pair will be injected into the next tracked event, if that events slot for this ID is still empty.

addItem(EcommerceItems.Item) - Method in class org.matomo.sdk.extra.EcommerceItems

Adds a product into the ecommerce order.

addTrackingCallback(Tracker.Callback) - Method in class org.matomo.sdk.Tracker

ApkChecksum(Context) - Constructor for class org.matomo.sdk.extra.DownloadTracker.Extra.ApkChecksum

ApkChecksum(PackageInfo) - Constructor for class org.matomo.sdk.extra.DownloadTracker.Extra.ApkChecksum

AppTracking(TrackHelper, Application) - Constructor for class org.matomo.sdk.extra.TrackHelper.AppTracking

B

breadcrumbsToPath(String) - Static method in class org.matomo.sdk.tools.ActivityHelper

build(Tracker) - Method in class org.matomo.sdk.dispatcher.DefaultDispatcherFactory

build(Tracker) - Method in interface org.matomo.sdk.dispatcher.DispatcherFactory

build() - Method in class org.matomo.sdk.extra.TrackHelper.CartUpdate

build() - Method in class org.matomo.sdk.extra.TrackHelper.ContentImpression

build() - Method in class org.matomo.sdk.extra.TrackHelper.ContentInteraction

build() - Method in class org.matomo.sdk.extra.TrackHelper.EventBuilder

build() - Method in class org.matomo.sdk.extra.TrackHelper.Exception

build() - Method in class org.matomo.sdk.extra.TrackHelper.Goal

build() - Method in class org.matomo.sdk.extra.TrackHelper.Order

build() - Method in class org.matomo.sdk.extra.TrackHelper.Outlink

build() - Method in class org.matomo.sdk.extra.TrackHelper.Screen

build() - Method in class org.matomo.sdk.extra.TrackHelper.Search

build(Matomo) - Method in class org.matomo.sdk.TrackerBuilder

buildExtraIdentifier() - Method in class org.matomo.sdk.extra.DownloadTracker.Extra.ApkChecksum

buildExtraIdentifier() - Method in interface org.matomo.sdk.extra.DownloadTracker.Extra

Example:
com.example.pkg:1/ABCDEF01234567
"ABCDEF01234567" is the extra identifier here.

buildExtraIdentifier() - Method in class org.matomo.sdk.extra.DownloadTracker.Extra.None

BuildInfo - Class in org.matomo.sdk.tools

BuildInfo() - Constructor for class org.matomo.sdk.tools.BuildInfo

buildPackets(List<Event>) - Method in class org.matomo.sdk.dispatcher.PacketFactory

C

cache(List<Event>) - Method in class org.matomo.sdk.dispatcher.EventDiskCache

campaign(String, String) - Method in class org.matomo.sdk.extra.TrackHelper.Screen

The marketing campaign for this visit if the user opens the app for example because of an ad or a newsletter.

cartUpdate(int) - Method in class org.matomo.sdk.extra.TrackHelper

Tracks a shopping cart.

category(String) - Method in class org.matomo.sdk.extra.EcommerceItems.Item

category(String) - Method in class org.matomo.sdk.extra.TrackHelper.Search

You can optionally specify a search category with this parameter.

Checksum - Class in org.matomo.sdk.tools

Offers to calculate checksums

Checksum() - Constructor for class org.matomo.sdk.tools.Checksum

clear() - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

clear() - Method in interface org.matomo.sdk.dispatcher.Dispatcher

To clear the dispatchers queue

clear() - Method in class org.matomo.sdk.dispatcher.EventCache

clear() - Method in class org.matomo.sdk.extra.EcommerceItems

Clears all items from the ecommerce order

Connectivity - Class in org.matomo.sdk.tools

Connectivity(Context) - Constructor for class org.matomo.sdk.tools.Connectivity

Connectivity.Type - Enum in org.matomo.sdk.tools

count(Integer) - Method in class org.matomo.sdk.extra.TrackHelper.Search

We recommend to set the search count to the number of search results displayed on the results page.

createDefault(String, int) - Static method in class org.matomo.sdk.TrackerBuilder

CurrencyFormatter - Class in org.matomo.sdk.tools

CurrencyFormatter() - Constructor for class org.matomo.sdk.tools.CurrencyFormatter

Custom() - Constructor for class org.matomo.sdk.extra.DownloadTracker.Extra.Custom

CustomDimension - Class in org.matomo.sdk.extra

Allows you to track Custom Dimensions.

CustomDimension(int, String) - Constructor for class org.matomo.sdk.extra.CustomDimension

CustomVariables - Class in org.matomo.sdk.extra

A custom variable is a custom name-value pair that you can assign to your users or screen views, and then visualize the reports of how many visits, conversions, etc.

CustomVariables() - Constructor for class org.matomo.sdk.extra.CustomVariables

CustomVariables(CustomVariables) - Constructor for class org.matomo.sdk.extra.CustomVariables

CustomVariables(String) - Constructor for class org.matomo.sdk.extra.CustomVariables

D

DEFAULT_CONNECTION_TIMEOUT - Static variable in interface org.matomo.sdk.dispatcher.Dispatcher

DEFAULT_DISPATCH_INTERVAL - Static variable in interface org.matomo.sdk.dispatcher.Dispatcher

DefaultDispatcher - Class in org.matomo.sdk.dispatcher

Responsible for transmitting packets to a server

DefaultDispatcher(EventCache, Connectivity, PacketFactory, PacketSender) - Constructor for class org.matomo.sdk.dispatcher.DefaultDispatcher

DefaultDispatcherFactory - Class in org.matomo.sdk.dispatcher

DefaultDispatcherFactory() - Constructor for class org.matomo.sdk.dispatcher.DefaultDispatcherFactory

DefaultPacketSender - Class in org.matomo.sdk.dispatcher

DefaultPacketSender() - Constructor for class org.matomo.sdk.dispatcher.DefaultPacketSender

description(String) - Method in class org.matomo.sdk.extra.TrackHelper.Exception

DeviceHelper - Class in org.matomo.sdk.tools

Helper class to gain information about the device we are running on

DeviceHelper(Context, PropertySource, BuildInfo) - Constructor for class org.matomo.sdk.tools.DeviceHelper

dimension(int, String) - Method in class org.matomo.sdk.extra.TrackHelper

dimension(int, String) - Method in class org.matomo.sdk.extra.TrackHelper.Dimension

dimension(int, String) - Method in class org.matomo.sdk.extra.TrackHelper.Screen

Requires Custom Dimensions plugin (server-side)

DimensionQueue - Class in org.matomo.sdk.extra

A helper class for custom dimensions.

DimensionQueue(Tracker) - Constructor for class org.matomo.sdk.extra.DimensionQueue

discount(Integer) - Method in class org.matomo.sdk.extra.TrackHelper.Order

dispatch() - Method in class org.matomo.sdk.Tracker

Processes all queued events in background thread

dispatchBlocking() - Method in class org.matomo.sdk.Tracker

Process all queued events and block until processing is complete

Dispatcher - Interface in org.matomo.sdk.dispatcher

Responsible for transmitting packets to a server

DispatcherFactory - Interface in org.matomo.sdk.dispatcher

DispatchMode - Enum in org.matomo.sdk.dispatcher

download(DownloadTracker) - Method in class org.matomo.sdk.extra.TrackHelper

Sends a download event for this app.

download() - Method in class org.matomo.sdk.extra.TrackHelper

DownloadTracker - Class in org.matomo.sdk.extra

DownloadTracker(Tracker) - Constructor for class org.matomo.sdk.extra.DownloadTracker

DownloadTracker(Tracker, PackageInfo) - Constructor for class org.matomo.sdk.extra.DownloadTracker

DownloadTracker.Extra - Interface in org.matomo.sdk.extra

DownloadTracker.Extra.ApkChecksum - Class in org.matomo.sdk.extra

The MD5 checksum of the apk file.

DownloadTracker.Extra.Custom - Class in org.matomo.sdk.extra

Custom exta identifier.

DownloadTracker.Extra.None - Class in org.matomo.sdk.extra

No extra identifier.

drainTo(List<Event>) - Method in class org.matomo.sdk.dispatcher.EventCache

E

EcommerceItems - Class in org.matomo.sdk.extra

EcommerceItems() - Constructor for class org.matomo.sdk.extra.EcommerceItems

EcommerceItems.Item - Class in org.matomo.sdk.extra

equals(Object) - Method in class org.matomo.sdk.dispatcher.Event

equals(Object, Object) - Static method in class org.matomo.sdk.tools.Objects

equals(Object) - Method in class org.matomo.sdk.Tracker

equals(Object) - Method in class org.matomo.sdk.TrackerBuilder

Event - Class in org.matomo.sdk.dispatcher

Event(Map<String, String>) - Constructor for class org.matomo.sdk.dispatcher.Event

Event(String) - Constructor for class org.matomo.sdk.dispatcher.Event

Event(long, String) - Constructor for class org.matomo.sdk.dispatcher.Event

event(String, String) - Method in class org.matomo.sdk.extra.TrackHelper

Events are a useful way to collect data about a user's interaction with interactive components of your app, like button presses or the use of a particular item in a game.

EventCache - Class in org.matomo.sdk.dispatcher

EventCache(EventDiskCache) - Constructor for class org.matomo.sdk.dispatcher.EventCache

EventDiskCache - Class in org.matomo.sdk.dispatcher

EventDiskCache(Tracker) - Constructor for class org.matomo.sdk.dispatcher.EventDiskCache

exception(Throwable) - Method in class org.matomo.sdk.extra.TrackHelper

Caught exceptions are errors in your app for which you've defined exception handling code, such as the occasional timeout of a network connection during a request for data.

F

fatal(boolean) - Method in class org.matomo.sdk.extra.TrackHelper.Exception

force() - Method in class org.matomo.sdk.extra.TrackHelper.Download

Normally a download event is only fired once per app version.

forceDispatch() - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

Starts the dispatcher for one cycle if it is currently not working.

forceDispatch() - Method in interface org.matomo.sdk.dispatcher.Dispatcher

Starts the dispatcher for one cycle if it is currently not working.

forceDispatchBlocking() - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

forceDispatchBlocking() - Method in interface org.matomo.sdk.dispatcher.Dispatcher

Dispatch all events in the EventCache and return only after the dispatch is complete.

fromString(String) - Static method in enum org.matomo.sdk.dispatcher.DispatchMode

G

get(String) - Method in class org.matomo.sdk.TrackMe

Consider using QueryParams instead of raw strings

get(QueryParams) - Method in class org.matomo.sdk.TrackMe

getAPIUrl() - Method in class org.matomo.sdk.Tracker

getApiUrl() - Method in class org.matomo.sdk.TrackerBuilder

getApplicationBaseUrl() - Method in class org.matomo.sdk.TrackerBuilder

getBreadcrumbs(Activity) - Static method in class org.matomo.sdk.tools.ActivityHelper

getBuildId() - Method in class org.matomo.sdk.tools.BuildInfo

getCategory() - Method in class org.matomo.sdk.extra.EcommerceItems.Item

getConnectionTimeOut() - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

Connection timeout in milliseconds

getConnectionTimeOut() - Method in interface org.matomo.sdk.dispatcher.Dispatcher

Connection timeout in milliseconds

getContext() - Method in class org.matomo.sdk.Matomo

getDefaultExceptionHandler() - Method in class org.matomo.sdk.extra.MatomoExceptionHandler

This will give you the previous exception handler that is now wrapped.

getDefaultTrackMe() - Method in class org.matomo.sdk.Tracker

Matomo will use the content of this object to fill in missing values before any transmission.

getDimension(TrackMe, int) - Static method in class org.matomo.sdk.extra.CustomDimension

getDispatcherFactory() - Method in class org.matomo.sdk.Matomo

getDispatchGzipped() - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

getDispatchGzipped() - Method in interface org.matomo.sdk.dispatcher.Dispatcher

getDispatchInterval() - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

getDispatchInterval() - Method in interface org.matomo.sdk.dispatcher.Dispatcher

getDispatchInterval() - Method in class org.matomo.sdk.Tracker

getDispatchMode() - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

getDispatchMode() - Method in interface org.matomo.sdk.dispatcher.Dispatcher

getDispatchMode() - Method in class org.matomo.sdk.Tracker

The current dispatch behavior.

getDispatchTimeout() - Method in class org.matomo.sdk.Tracker

Dispatcher.getConnectionTimeOut()

getDryRunTarget() - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

getDryRunTarget() - Method in interface org.matomo.sdk.dispatcher.Dispatcher

For debugging purposes Mind thread-safety!

getDryRunTarget() - Method in class org.matomo.sdk.Tracker

If we are in dry-run mode then this will return a datastructure.

getEncodedQuery() - Method in class org.matomo.sdk.dispatcher.Event

getEventCount() - Method in class org.matomo.sdk.dispatcher.Packet

Used to determine the event cache queue positions.

getHex(byte[]) - Static method in class org.matomo.sdk.tools.Checksum

Transforms byte into hex representation.

getHttpAgent() - Method in class org.matomo.sdk.tools.PropertySource

getId() - Method in class org.matomo.sdk.extra.CustomDimension

getInstance(Context) - Static method in class org.matomo.sdk.Matomo

getJVMVersion() - Method in class org.matomo.sdk.tools.PropertySource

getLastEventX() - Method in class org.matomo.sdk.Tracker

For testing purposes

getMatomo() - Method in class org.matomo.sdk.extra.MatomoApplication

getMatomo() - Method in class org.matomo.sdk.Tracker

getMD5Checksum(String) - Static method in class org.matomo.sdk.tools.Checksum

MD5-Checksum for a string.

getMD5Checksum(File) - Static method in class org.matomo.sdk.tools.Checksum

MD5-Checksum for a file.

getModel() - Method in class org.matomo.sdk.tools.BuildInfo

getName() - Method in class org.matomo.sdk.extra.EcommerceItems.Item

getName() - Method in class org.matomo.sdk.Tracker

getOfflineCacheAge() - Method in class org.matomo.sdk.Tracker

See Tracker.setOfflineCacheAge(long)

getOfflineCacheSize() - Method in class org.matomo.sdk.Tracker

Maximum size the offline cache is allowed to grow to.

getPostData() - Method in class org.matomo.sdk.dispatcher.Packet

getPreferences() - Method in class org.matomo.sdk.Matomo

Base preferences, tracker idenpendent.

getPreferences() - Method in class org.matomo.sdk.Tracker

getPrice() - Method in class org.matomo.sdk.extra.EcommerceItems.Item

getQuantity() - Method in class org.matomo.sdk.extra.EcommerceItems.Item

getRelease() - Method in class org.matomo.sdk.tools.BuildInfo

getResolution() - Method in class org.matomo.sdk.tools.DeviceHelper

Tries to get the most accurate device resolution.

getSessionTimeout() - Method in class org.matomo.sdk.Tracker

Default is 30min (30*60*1000).

getSiteId() - Method in class org.matomo.sdk.Tracker

getSiteId() - Method in class org.matomo.sdk.TrackerBuilder

getSku() - Method in class org.matomo.sdk.extra.EcommerceItems.Item

getSystemProperty(String) - Method in class org.matomo.sdk.tools.PropertySource

getTargetURL() - Method in class org.matomo.sdk.dispatcher.Packet

getTimeStamp() - Method in class org.matomo.sdk.dispatcher.Event

getTimeStamp() - Method in class org.matomo.sdk.dispatcher.Packet

A timestamp to use when replaying offline data

getTracker() - Method in class org.matomo.sdk.extra.MatomoApplication

Gives you an all purpose thread-safe persisted Tracker.

getTracker() - Method in class org.matomo.sdk.extra.MatomoExceptionHandler

getTrackerName() - Method in class org.matomo.sdk.TrackerBuilder

getTrackerPreferences(Tracker) - Method in class org.matomo.sdk.Matomo

getType() - Method in class org.matomo.sdk.tools.Connectivity

getUserAgent() - Method in class org.matomo.sdk.tools.DeviceHelper

Returns android system user agent

getUserId() - Method in class org.matomo.sdk.Tracker

getUserLanguage() - Method in class org.matomo.sdk.tools.DeviceHelper

Returns user language

getValue() - Method in class org.matomo.sdk.extra.CustomDimension

getVersion() - Method in class org.matomo.sdk.extra.DownloadTracker

getVisitorId() - Method in class org.matomo.sdk.Tracker

goal(int) - Method in class org.matomo.sdk.extra.TrackHelper

By default, Goals in Matomo are defined as "matching" parts of the screen path or screen title.

H

has(QueryParams) - Method in class org.matomo.sdk.TrackMe

hashCode() - Method in class org.matomo.sdk.dispatcher.Event

hashCode() - Method in class org.matomo.sdk.Tracker

hashCode() - Method in class org.matomo.sdk.TrackerBuilder

I

identifier(DownloadTracker.Extra) - Method in class org.matomo.sdk.extra.TrackHelper.Download

Sets the identifier type for this download

impression(String) - Method in class org.matomo.sdk.extra.TrackHelper

Tracking the impressions

injectVisitVariables(TrackMe) - Method in class org.matomo.sdk.extra.CustomVariables

Sets the custom variables with scope VISIT to a TrackMe.

InstallReferrerReceiver - Class in org.matomo.sdk.extra

InstallReferrerReceiver() - Constructor for class org.matomo.sdk.extra.InstallReferrerReceiver

interaction(String, String) - Method in class org.matomo.sdk.extra.TrackHelper

Tracking the interactions

isConnected() - Method in class org.matomo.sdk.tools.Connectivity

isEmpty() - Method in class org.matomo.sdk.dispatcher.EventCache

isEmpty() - Method in class org.matomo.sdk.dispatcher.EventDiskCache

isEmpty() - Method in class org.matomo.sdk.TrackMe

isIntensiveWork() - Method in class org.matomo.sdk.extra.DownloadTracker.Extra.ApkChecksum

isIntensiveWork() - Method in interface org.matomo.sdk.extra.DownloadTracker.Extra

Does your DownloadTracker.Extra implementation do work intensive stuff? Network? IO?

isIntensiveWork() - Method in class org.matomo.sdk.extra.DownloadTracker.Extra.None

isOptOut() - Method in class org.matomo.sdk.Tracker

Item(String) - Constructor for class org.matomo.sdk.extra.EcommerceItems.Item

If the same sku is used twice, the first item is overwritten.

items(EcommerceItems) - Method in class org.matomo.sdk.extra.TrackHelper.CartUpdate

items(EcommerceItems) - Method in class org.matomo.sdk.extra.TrackHelper.Order

J

joinSlash(List<String>) - Static method in class org.matomo.sdk.tools.ActivityHelper

L

LegacySettingsPorter - Class in org.matomo.sdk

LegacySettingsPorter(Matomo) - Constructor for class org.matomo.sdk.LegacySettingsPorter

LOGGER_PREFIX - Static variable in class org.matomo.sdk.Matomo

M

makeRandomVisitorId() - Static method in class org.matomo.sdk.Tracker

Matomo - Class in org.matomo.sdk

MatomoApplication - Class in org.matomo.sdk.extra

MatomoApplication() - Constructor for class org.matomo.sdk.extra.MatomoApplication

MatomoExceptionHandler - Class in org.matomo.sdk.extra

An exception handler that wraps the existing exception handler and dispatches event to a Tracker.

MatomoExceptionHandler(Tracker, TrackMe) - Constructor for class org.matomo.sdk.extra.MatomoExceptionHandler

MAX_LENGTH - Static variable in class org.matomo.sdk.extra.CustomVariables

mBaseTrackMe - Variable in class org.matomo.sdk.extra.TrackHelper

N

name(String) - Method in class org.matomo.sdk.extra.EcommerceItems.Item

name(String) - Method in class org.matomo.sdk.extra.TrackHelper.EventBuilder

Defines a label associated with the event.

None() - Constructor for class org.matomo.sdk.extra.DownloadTracker.Extra.None

O

Objects - Class in org.matomo.sdk.tools

Objects() - Constructor for class org.matomo.sdk.tools.Objects

onCreateTrackerConfig() - Method in class org.matomo.sdk.extra.MatomoApplication

See TrackerBuilder.

onLowMemory() - Method in class org.matomo.sdk.extra.MatomoApplication

onReceive(Context, Intent) - Method in class org.matomo.sdk.extra.InstallReferrerReceiver

onTrack(TrackMe) - Method in interface org.matomo.sdk.Tracker.Callback

This method will be called after parameter injection and before transmission within Tracker.track(TrackMe).

onTrimMemory(int) - Method in class org.matomo.sdk.extra.MatomoApplication

order(String, int) - Method in class org.matomo.sdk.extra.TrackHelper

Tracks an Ecommerce order, including any ecommerce item previously added to the order.

org.matomo.sdk - package org.matomo.sdk

org.matomo.sdk.dispatcher - package org.matomo.sdk.dispatcher

org.matomo.sdk.extra - package org.matomo.sdk.extra

org.matomo.sdk.tools - package org.matomo.sdk.tools

outlink(URL) - Method in class org.matomo.sdk.extra.TrackHelper

Tracks an Outlink

P

Packet - Class in org.matomo.sdk.dispatcher

Data that can be send to the backend API via the Dispatcher

Packet(String) - Constructor for class org.matomo.sdk.dispatcher.Packet

Constructor for GET requests

Packet(String, JSONObject, int) - Constructor for class org.matomo.sdk.dispatcher.Packet

Constructor for POST requests

PacketFactory - Class in org.matomo.sdk.dispatcher

PacketFactory(String) - Constructor for class org.matomo.sdk.dispatcher.PacketFactory

PacketSender - Interface in org.matomo.sdk.dispatcher

PAGE_SIZE - Static variable in class org.matomo.sdk.dispatcher.PacketFactory

parse(URI, String) - Static method in class org.matomo.sdk.tools.UrlHelper

parse(List<Pair<String, String>>, Scanner, String) - Static method in class org.matomo.sdk.tools.UrlHelper

path(String) - Method in class org.matomo.sdk.extra.TrackHelper.EventBuilder

The path under which this event occurred.

piece(String) - Method in class org.matomo.sdk.extra.TrackHelper.ContentImpression

piece(String) - Method in class org.matomo.sdk.extra.TrackHelper.ContentInteraction

port(Tracker) - Method in class org.matomo.sdk.LegacySettingsPorter

PREF_KEY_DISPATCHER_MODE - Static variable in class org.matomo.sdk.Tracker

PREF_KEY_OFFLINE_CACHE_AGE - Static variable in class org.matomo.sdk.Tracker

PREF_KEY_OFFLINE_CACHE_SIZE - Static variable in class org.matomo.sdk.Tracker

PREF_KEY_TRACKER_FIRSTVISIT - Static variable in class org.matomo.sdk.Tracker

PREF_KEY_TRACKER_OPTOUT - Static variable in class org.matomo.sdk.Tracker

PREF_KEY_TRACKER_PREVIOUSVISIT - Static variable in class org.matomo.sdk.Tracker

PREF_KEY_TRACKER_USERID - Static variable in class org.matomo.sdk.Tracker

PREF_KEY_TRACKER_VISITCOUNT - Static variable in class org.matomo.sdk.Tracker

PREF_KEY_TRACKER_VISITORID - Static variable in class org.matomo.sdk.Tracker

price(int) - Method in class org.matomo.sdk.extra.EcommerceItems.Item

priceString(Integer) - Static method in class org.matomo.sdk.tools.CurrencyFormatter

PropertySource - Class in org.matomo.sdk.tools

PropertySource() - Constructor for class org.matomo.sdk.tools.PropertySource

put(int, String, String) - Method in class org.matomo.sdk.extra.CustomVariables

Custom variable names and values are limited to 200 characters in length each.

put(String, JSONArray) - Method in class org.matomo.sdk.extra.CustomVariables

putAll(CustomVariables) - Method in class org.matomo.sdk.extra.CustomVariables

putAll(TrackMe) - Method in class org.matomo.sdk.TrackMe

Adds TrackMe to this TrackMe, overriding values if necessary.

Q

quantity(int) - Method in class org.matomo.sdk.extra.EcommerceItems.Item

QueryParams - Enum in org.matomo.sdk

Query parameters supported by the tracking HTTP API.

R

remove(String) - Method in class org.matomo.sdk.extra.EcommerceItems

Remove a product from an ecommerce order.

remove(EcommerceItems.Item) - Method in class org.matomo.sdk.extra.EcommerceItems

removeTrackingCallback(Tracker.Callback) - Method in class org.matomo.sdk.Tracker

requeue(List<Event>) - Method in class org.matomo.sdk.dispatcher.EventCache

revenue(Float) - Method in class org.matomo.sdk.extra.TrackHelper.Goal

Tracking request will trigger a conversion for the goal of the website being tracked with this ID

S

screen(String) - Method in class org.matomo.sdk.extra.TrackHelper

To track a screenview.

screen(Activity) - Method in class org.matomo.sdk.extra.TrackHelper

Calls TrackHelper.screen(String) for an activity.

screens(Application) - Method in class org.matomo.sdk.extra.TrackHelper

This method will bind a tracker to your application, causing it to automatically track Activities with TrackHelper.screen(Activity) within your app.

search(String) - Method in class org.matomo.sdk.extra.TrackHelper

Tracks an site search

send(Packet) - Method in class org.matomo.sdk.dispatcher.DefaultPacketSender

send(Packet) - Method in interface org.matomo.sdk.dispatcher.PacketSender

set(String, String) - Method in class org.matomo.sdk.TrackMe

Consider using QueryParams instead of raw strings

set(QueryParams, String) - Method in class org.matomo.sdk.TrackMe

You can set any additional Tracking API Parameters within the SDK.

set(QueryParams, int) - Method in class org.matomo.sdk.TrackMe

set(QueryParams, float) - Method in class org.matomo.sdk.TrackMe

set(QueryParams, long) - Method in class org.matomo.sdk.TrackMe

setApplicationBaseUrl(String) - Method in class org.matomo.sdk.TrackerBuilder

Domain used to build the required parameter url (http://developer.matomo.org/api-reference/tracking-api) Defaults to`https://your.packagename`

setConnectionTimeOut(int) - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

Timeout when trying to establish connection and when trying to read a response.

setConnectionTimeOut(int) - Method in interface org.matomo.sdk.dispatcher.Dispatcher

Timeout when trying to establish connection and when trying to read a response.

setDimension(TrackMe, int, String) - Static method in class org.matomo.sdk.extra.CustomDimension

This method sets a tracking API parameter dimension%dimensionId%=%dimensionValue%.

setDimension(TrackMe, CustomDimension) - Static method in class org.matomo.sdk.extra.CustomDimension

setDispatcherFactory(DispatcherFactory) - Method in class org.matomo.sdk.Matomo

If you want to use your own Dispatcher

setDispatchGzipped(boolean) - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

Packets are collected and dispatched in batches.

setDispatchGzipped(boolean) - Method in interface org.matomo.sdk.dispatcher.Dispatcher

Packets are collected and dispatched in batches.

setDispatchGzipped(boolean) - Method in class org.matomo.sdk.Tracker

Defines if when dispatched, posted JSON must be Gzipped.

setDispatchInterval(long) - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

Packets are collected and dispatched in batches, this intervals sets the pause between batches.

setDispatchInterval(long) - Method in interface org.matomo.sdk.dispatcher.Dispatcher

Packets are collected and dispatched in batches, this intervals sets the pause between batches.

setDispatchInterval(long) - Method in class org.matomo.sdk.Tracker

Set the interval to 0 to dispatch events as soon as they are queued.

setDispatchMode(DispatchMode) - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

setDispatchMode(DispatchMode) - Method in interface org.matomo.sdk.dispatcher.Dispatcher

setDispatchMode(DispatchMode) - Method in class org.matomo.sdk.Tracker

Sets the dispatch mode.

setDispatchTimeout(int) - Method in class org.matomo.sdk.Tracker

Dispatcher.setConnectionTimeOut(int)

setDryRunTarget(List<Packet>) - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

setDryRunTarget(List<Packet>) - Method in interface org.matomo.sdk.dispatcher.Dispatcher

For debugging purposes When this is non null then instead of sending data over the network it will be written into this list.

setDryRunTarget(List<Packet>) - Method in class org.matomo.sdk.Tracker

Set a data structure here to put the Dispatcher into dry-run-mode.

setGzipData(boolean) - Method in class org.matomo.sdk.dispatcher.DefaultPacketSender

setGzipData(boolean) - Method in interface org.matomo.sdk.dispatcher.PacketSender

setOfflineCacheAge(long) - Method in class org.matomo.sdk.Tracker

For how long events should be stored if they could not be send.

setOfflineCacheSize(long) - Method in class org.matomo.sdk.Tracker

How large the offline cache may be.

setOptOut(boolean) - Method in class org.matomo.sdk.Tracker

Use this to disable this Tracker, e.g.

setSessionTimeout(int) - Method in class org.matomo.sdk.Tracker

setTimeout(long) - Method in class org.matomo.sdk.dispatcher.DefaultPacketSender

setTimeout(long) - Method in interface org.matomo.sdk.dispatcher.PacketSender

setTrackerName(String) - Method in class org.matomo.sdk.TrackerBuilder

A unique name for this Tracker.

setUserId(String) - Method in class org.matomo.sdk.Tracker

Defines the User ID for this request.

setVersion(String) - Method in class org.matomo.sdk.extra.DownloadTracker

setVisitorId(String) - Method in class org.matomo.sdk.Tracker

The unique visitor ID, must be a 16 characters hexadecimal string.

shipping(Integer) - Method in class org.matomo.sdk.extra.TrackHelper.Order

size() - Method in class org.matomo.sdk.extra.CustomVariables

startNewSession() - Method in class org.matomo.sdk.Tracker

submit(TrackMe) - Method in class org.matomo.sdk.dispatcher.DefaultDispatcher

submit(TrackMe) - Method in interface org.matomo.sdk.dispatcher.Dispatcher

Submit for transmission

subTotal(Integer) - Method in class org.matomo.sdk.extra.TrackHelper.Order

T

TAG - Static variable in class org.matomo.sdk.extra.DownloadTracker

tag(Class...) - Static method in class org.matomo.sdk.Matomo

tag(String...) - Static method in class org.matomo.sdk.Matomo

target(String) - Method in class org.matomo.sdk.extra.TrackHelper.ContentImpression

target(String) - Method in class org.matomo.sdk.extra.TrackHelper.ContentInteraction

tax(Integer) - Method in class org.matomo.sdk.extra.TrackHelper.Order

title(String) - Method in class org.matomo.sdk.extra.TrackHelper.Screen

The title of the action being tracked.

toJson() - Method in class org.matomo.sdk.extra.EcommerceItems.Item

toJson() - Method in class org.matomo.sdk.extra.EcommerceItems

toMap() - Method in class org.matomo.sdk.TrackMe

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

toString() - Method in enum org.matomo.sdk.dispatcher.DispatchMode

toString() - Method in class org.matomo.sdk.dispatcher.Event

toString() - Method in class org.matomo.sdk.dispatcher.Packet

toString() - Method in class org.matomo.sdk.extra.CustomVariables

toString() - Method in enum org.matomo.sdk.QueryParams

toVisitVariables() - Method in class org.matomo.sdk.extra.CustomVariables

track() - Static method in class org.matomo.sdk.extra.TrackHelper

track(TrackMe) - Static method in class org.matomo.sdk.extra.TrackHelper

track(TrackMe) - Method in class org.matomo.sdk.Tracker

Tracker - Class in org.matomo.sdk

Main tracking class This class is threadsafe.

Tracker(Matomo, TrackerBuilder) - Constructor for class org.matomo.sdk.Tracker

Tracker.Callback - Interface in org.matomo.sdk

TrackerBuilder - Class in org.matomo.sdk

Configuration details for a Tracker

TrackerBuilder(String, int, String) - Constructor for class org.matomo.sdk.TrackerBuilder

TrackHelper - Class in org.matomo.sdk.extra

TrackHelper.AppTracking - Class in org.matomo.sdk.extra

TrackHelper.CartUpdate - Class in org.matomo.sdk.extra

TrackHelper.ContentImpression - Class in org.matomo.sdk.extra

TrackHelper.ContentInteraction - Class in org.matomo.sdk.extra

TrackHelper.Dimension - Class in org.matomo.sdk.extra

TrackHelper.Download - Class in org.matomo.sdk.extra

TrackHelper.EventBuilder - Class in org.matomo.sdk.extra

TrackHelper.Exception - Class in org.matomo.sdk.extra

TrackHelper.Goal - Class in org.matomo.sdk.extra

TrackHelper.Order - Class in org.matomo.sdk.extra

TrackHelper.Outlink - Class in org.matomo.sdk.extra

TrackHelper.Screen - Class in org.matomo.sdk.extra

TrackHelper.Search - Class in org.matomo.sdk.extra

TrackHelper.UncaughtExceptions - Class in org.matomo.sdk.extra

TrackHelper.VisitVariables - Class in org.matomo.sdk.extra

TrackMe - Class in org.matomo.sdk

This objects represents one query to Matomo.

TrackMe() - Constructor for class org.matomo.sdk.TrackMe

TrackMe(TrackMe) - Constructor for class org.matomo.sdk.TrackMe

trackNewAppDownload(TrackMe, DownloadTracker.Extra) - Method in class org.matomo.sdk.extra.DownloadTracker

trackOnce(TrackMe, DownloadTracker.Extra) - Method in class org.matomo.sdk.extra.DownloadTracker

trySet(QueryParams, int) - Method in class org.matomo.sdk.TrackMe

Only sets the value if it doesn't exist.

trySet(QueryParams, float) - Method in class org.matomo.sdk.TrackMe

Only sets the value if it doesn't exist.

trySet(QueryParams, long) - Method in class org.matomo.sdk.TrackMe

trySet(QueryParams, String) - Method in class org.matomo.sdk.TrackMe

Only sets the value if it doesn't exist.

U

uncache() - Method in class org.matomo.sdk.dispatcher.EventDiskCache

uncaughtException(Thread, Throwable) - Method in class org.matomo.sdk.extra.MatomoExceptionHandler

uncaughtExceptions() - Method in class org.matomo.sdk.extra.TrackHelper

This will create an exception handler that wraps any existing exception handler.

updateState(boolean) - Method in class org.matomo.sdk.dispatcher.EventCache

UrlHelper - Class in org.matomo.sdk.tools

Helps us with Urls.

UrlHelper() - Constructor for class org.matomo.sdk.tools.UrlHelper

V

value(Float) - Method in class org.matomo.sdk.extra.TrackHelper.EventBuilder

Defines a numeric value associated with the event.

valueOf(String) - Static method in enum org.matomo.sdk.dispatcher.DispatchMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.matomo.sdk.QueryParams

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.matomo.sdk.tools.Connectivity.Type

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.matomo.sdk.dispatcher.DispatchMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.matomo.sdk.QueryParams

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.matomo.sdk.tools.Connectivity.Type

Returns an array containing the constants of this enum type, in the order they are declared.

variable(int, String, String) - Method in class org.matomo.sdk.extra.TrackHelper.Screen

Deprecated.

Consider using Custom Dimensions

version(String) - Method in class org.matomo.sdk.extra.TrackHelper.Download

To track specific app versions.

visitVariables(int, String, String) - Method in class org.matomo.sdk.extra.TrackHelper

Deprecated.

Consider using Custom Dimensions

visitVariables(CustomVariables) - Method in class org.matomo.sdk.extra.TrackHelper

Deprecated.

Consider using Custom Dimensions

VisitVariables(TrackHelper, CustomVariables) - Constructor for class org.matomo.sdk.extra.TrackHelper.VisitVariables

visitVariables(int, String, String) - Method in class org.matomo.sdk.extra.TrackHelper.VisitVariables

W

with(Tracker) - Method in class org.matomo.sdk.extra.TrackHelper.AppTracking

with(Tracker) - Method in class org.matomo.sdk.extra.TrackHelper.Download

with(Tracker) - Method in class org.matomo.sdk.extra.TrackHelper.UncaughtExceptions

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