Перейти к основному содержимому

SigmaClient.getAllUserExperiments

SigmaClient.getAllUserExperiments()

Используется для получения всех экспериментов пользователя.

Параметры

estimateHoldouts?: boolean
Необязательный параметр. Если true, то метод вернет все эксперименты, включая холдауты, в которые попал пользователь. Если false, то метод вернет только эксперименты, не являющиеся холдаутами. По умолчанию true.

Параметры метода

НазваниеТипЗначение по умолчаниюОписание
callbackSigmaGetAllUserExperimentsCallback-Только для callback версии метода. Объект интерфейса SigmaGetAllUserExperimentsCallback. Данный интерфейс обладает методами onSuccess() - вызывающийся при успешном получении всех экспериментов и onError() - вызывающийся при ошибке.
booleanestimateHoldouts?trueНеобязательный параметр. Если true, то метод вернет все эксперименты, включая холдауты, в которые попал пользователь. Если false, то метод вернет только эксперименты, не являющиеся холдаутами. По умолчанию true.

Возвращаемое значение

ТипОписание
String?Только для suspend версии метода. Строка вида "expId.userGroupIndex|expId.userGroupIndex|...", где expId - идентификатор эксперимента и userGroupIndex индекс группы пользователя в эксперименте или null

Пример использования

Без использования kotlin.coroutines

import ru.expf.sigma.Sigma
import ru.expf.sigma.SigmaGetAllUserExperimentsCallback
...
val client = Sigma.getClient()
client.getAllUserExperiments(
callback = object : SigmaGetAllUserExperimentsCallback {
override fun onSuccess(experiments: String?) {
/** Some code with received experiments string */
}

override fun onError(throwable: Throwable) {
/** Some code with received error */
}
}
)

С использованием kotlin.coroutines

import ru.expf.sigma.Sigma
...
async {
val client = Sigma.getClient()
val experiments = client.getAllUserExperiments()
}.await()