Criteria

@Serializable
data class Criteria(val language: String? = null, val allOfGroups: List<String>? = null, val noneOfGroups: List<String>? = null, val allOfSubstudyIds: List<String>? = null, val noneOfSubstudyIds: List<String>? = null, val minAppVersions: Map<String, Int>? = null, val maxAppVersions: Map<String, Int>? = null, val type: String? = null)

Some objects, like Subpopulations and the schedules in a CriteriaScheduleStrategy, are matched against user criteria in order to return the correct object. The criteria against which user information will be matched are described in the Criteria object. See /articles/filtering.html for a fuller explanation.

Parameters

language

A two-letter language code. The the must declare an Accept-Language header with this language in order to match this object.

allOfGroups

One or more data groups; the user must have all these data groups to match.

noneOfGroups

One or more data groups; the user must have none of these data groups to match.

allOfSubstudyIds

One or more substudy IDs; the user must be assigned to all these substudies to match.

noneOfSubstudyIds

One or more substudy IDs; the user cannot be assigned to any of these substudies for the associated object to match.

minAppVersions

A map of operating system names to minimum app versions. The user must send a User-Agent header in a prescribed format, that declares the app version to be equal to or greater than this version number, in order to match.

maxAppVersions

A map of operating system names to minimum app versions. The user must send a User-Agent header in a prescribed format, that declares the app version to be equal to or less than this version number, in order to match.

type

Criteria

Constructors

Link copied to clipboard
constructor(language: String? = null, allOfGroups: List<String>? = null, noneOfGroups: List<String>? = null, allOfSubstudyIds: List<String>? = null, noneOfSubstudyIds: List<String>? = null, minAppVersions: Map<String, Int>? = null, maxAppVersions: Map<String, Int>? = null, type: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "allOfGroups")
val allOfGroups: List<String>? = null
Link copied to clipboard
@SerialName(value = "allOfSubstudyIds")
val allOfSubstudyIds: List<String>? = null
Link copied to clipboard
@SerialName(value = "language")
val language: String? = null
Link copied to clipboard
@SerialName(value = "maxAppVersions")
val maxAppVersions: Map<String, Int>? = null
Link copied to clipboard
@SerialName(value = "minAppVersions")
val minAppVersions: Map<String, Int>? = null
Link copied to clipboard
@SerialName(value = "noneOfGroups")
val noneOfGroups: List<String>? = null
Link copied to clipboard
@SerialName(value = "noneOfSubstudyIds")
val noneOfSubstudyIds: List<String>? = null
Link copied to clipboard
@SerialName(value = "type")
val type: String? = null