org.matomo.sdk.extra

Class TrackHelper.Screen

java.lang.Object

org.matomo.sdk.extra.TrackHelper.Screen

Enclosing class:

TrackHelper

public static class TrackHelper.Screen
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
TrackMe	build() May throw an IllegalArgumentException if the TrackMe was build with incorrect arguments.
TrackHelper.Screen	campaign(java.lang.String name, java.lang.String keyword) The marketing campaign for this visit if the user opens the app for example because of an ad or a newsletter.
TrackHelper.Screen	dimension(int index, java.lang.String dimensionValue) Requires Custom Dimensions plugin (server-side)
boolean	safelyWith(MatomoApplication matomoApplication)
boolean	safelyWith(Tracker tracker) build() can throw an exception on illegal arguments.
TrackHelper.Screen	title(java.lang.String title) The title of the action being tracked.
TrackHelper.Screen	variable(int index, java.lang.String name, java.lang.String value) Deprecated. Consider using Custom Dimensions
void	with(MatomoApplication matomoApplication)
void	with(Tracker tracker)

Methods inherited from class java.lang.Object

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

Method Detail

title

public TrackHelper.Screen title(java.lang.String title)

The title of the action being tracked. It is possible to use slashes / to set one or several categories for this action.

Parameters:

title - Example: Help / Feedback will create the Action Feedback in the category Help.

Returns:

this object to allow chaining calls

dimension

public TrackHelper.Screen dimension(int index,
                                    java.lang.String dimensionValue)

Requires Custom Dimensions plugin (server-side)

Parameters:

index - accepts values greater than 0

dimensionValue - is limited to 255 characters, you can pass null to delete a value

variable

@Deprecated
public TrackHelper.Screen variable(int index,
                                               java.lang.String name,
                                               java.lang.String value)

Deprecated. Consider using Custom Dimensions

Custom Variable valid per screen. Only takes effect when setting prior to tracking the screen view.

See Also:

and {@link #dimension(int, String)}

campaign

public TrackHelper.Screen campaign(java.lang.String name,
                                   java.lang.String keyword)

The marketing campaign for this visit if the user opens the app for example because of an ad or a newsletter. Used to populate the Referrers > Campaigns report.

Parameters:

name - the name of the campaign

keyword - the keyword of the campaign

Returns:

this object to allow chaining calls

build

public TrackMe build()

May throw an IllegalArgumentException if the TrackMe was build with incorrect arguments.

with

public void with(MatomoApplication matomoApplication)

with

public void with(Tracker tracker)

safelyWith

public boolean safelyWith(MatomoApplication matomoApplication)

safelyWith

public boolean safelyWith(Tracker tracker)

build() can throw an exception on illegal arguments. This can be used to avoid crashes when using dynamic TrackMe arguments.

Returns:

false if an error occured, true if the TrackMe has been submitted to be dispatched.