org.matomo.sdk.extra

Class TrackHelper.Search

java.lang.Object

org.matomo.sdk.extra.TrackHelper.Search

Enclosing class:

TrackHelper

public static class TrackHelper.Search
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.Search	category(java.lang.String category) You can optionally specify a search category with this parameter.
TrackHelper.Search	count(java.lang.Integer count) We recommend to set the search count to the number of search results displayed on the results page.
boolean	safelyWith(MatomoApplication matomoApplication)
boolean	safelyWith(Tracker tracker) build() can throw an exception on illegal arguments.
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

category

public TrackHelper.Search category(java.lang.String category)

You can optionally specify a search category with this parameter.

Returns:

this object, to chain calls.

count

public TrackHelper.Search count(java.lang.Integer count)

We recommend to set the search count to the number of search results displayed on the results page. When keywords are tracked with a count of 0, they will appear in the "No Result Search Keyword" report.

Returns:

this object, to chain 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.