com.yandex.metrica

Class ReporterConfig.Builder

  1. Method Summary
  2. Methods inherited from class java.lang.Object
  3. Method Detail
    1. withSessionTimeout
    2. withLogs
    3. withStatisticsSending
    4. withMaxReportsInDatabaseCount
    5. withUserProfileID
    6. build
java.lang.Object
com.yandex.metrica.ReporterConfig.Builder
Enclosing class:
ReporterConfig

public static class ReporterConfig.Builder
extends java.lang.Object

Method Summary

All Methods
Instance Methods
Concrete Methods
Modifier and TypeMethod and Description
ReporterConfigbuild()
Создает объект расширенной конфигурации ReporterConfig.
ReporterConfig.BuilderwithLogs()
Включает логирование работы библиотеки.
ReporterConfig.BuilderwithMaxReportsInDatabaseCount(int maxReportsInDatabaseCount)
Задает максимальное количество отчетов, которое может храниться в базе данных.
ReporterConfig.BuilderwithSessionTimeout(int sessionTimeout)
Задает длительность тайм-аута сессии в секундах.
ReporterConfig.BuilderwithStatisticsSending(boolean enabled)
Включает/отключает отправку статистики на сервер AppMetrica.
ReporterConfig.BuilderwithUserProfileID(java.lang.String userProfileID)
Задает идентификатор профиля пользователя.

Methods inherited from class java.lang.Object

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

Method Detail

withSessionTimeout

@NonNull
public ReporterConfig.Builder withSessionTimeout(int sessionTimeout)

Задает длительность тайм-аута сессии в секундах.

По умолчанию сессия завершается, если приложение неактивно в течение времени, заданного 10. Чтобы изменить тайм-аут, передайте нужное значение в секундах в методе IReporter.setSessionTimeout(int sessionTimeoutSeconds). Минимальное допустимое значение параметра sessionTimeoutSeconds - 10 секунд.

В Metrica под продолжительностью сессии подразумевается следующее: ПРИМЕР: Пусть продолжительность тайм-аута сессии составляет 2 минуты. Тогда, если началось взаимодействие с вашим приложением после 2 минут бездействия, будет запущена новая сессия. В противном случае, сессия будет продолжена.

Parameters:
sessionTimeout - Тайм-аут сессии в секундах.
Returns:
Объект ReporterConfig.Builder.

withLogs

@NonNull
public ReporterConfig.Builder withLogs()
Включает логирование работы библиотеки. Должен вызываться перед YandexMetrica.getReporter(Context, String).
Returns:
Объект ReporterConfig.Builder.

withStatisticsSending

@NonNull
public ReporterConfig.Builder withStatisticsSending(boolean enabled)
Включает/отключает отправку статистики на сервер AppMetrica.

ПРИМЕЧАНИЕ: Отключение отправки статистики для репортера не влияет на отправку данных с главного API key. Но отключение отправки данных для главного API key прекращает отправку статистики со всех репортеров.

Parameters:
enabled - Признак включения отправки статистики.

Значение по умолчанию — true. Возможные значения: true — логирование работы репортера включено. false — логирование работы репортера выключено.

Returns:
Объект ReporterConfig.Builder.

withMaxReportsInDatabaseCount

@NonNull
public ReporterConfig.Builder withMaxReportsInDatabaseCount(int maxReportsInDatabaseCount)
Задает максимальное количество отчетов, которое может храниться в базе данных. Если заданное число будет превышено, часть отчетов будет удвлена.

ПРИМЕЧАНИЕ: Значение по умолчанию - YandexMetricaDefaultValues.DEFAULT_MAX_REPORTS_IN_DATABASE_COUNT

Parameters:
maxReportsInDatabaseCount - Задает максимальное количество отчетов, которое может храниться в базе данных. Должно находиться в интервале [YandexMetricaDefaultValues.DEFAULT_MAX_REPORTS_COUNT_LOWER_BOUND; YandexMetricaDefaultValues.DEFAULT_MAX_REPORTS_COUNT_UPPER_BOUND]. Иначе будет использовано максимально близкое возможное значение.
Returns:
Объект ReporterConfig.Builder.

withUserProfileID

@NonNull
public ReporterConfig.Builder withUserProfileID(@Nullable
                                                         java.lang.String userProfileID)
Задает идентификатор профиля пользователя. Может содержать до 200 символов.
Parameters:
userProfileID - Идентификатор пользователя.
Returns:
Объект YandexMetricaConfig.Builder.
See Also:
YandexMetrica.setUserProfileID(String)

build

@NonNull
public ReporterConfig build()
Создает объект расширенной конфигурации ReporterConfig.
Returns:
Объект класса ReporterConfig.