# OvulationTestRecord

Artifact: [androidx.health.connect:connect-client](https://developer.android.com/jetpack/androidx/releases/health-connect) [View Source](https://cs.android.com/search?q=file:androidx/health/connect/client/records/OvulationTestRecord.kt+class:androidx.health.connect.client.records.OvulationTestRecord) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***


```
class OvulationTestRecord : Record
```

<br />

*** ** * ** ***

Each record represents the result of an ovulation test.

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#RESULT_HIGH() = 2` High fertility. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#RESULT_INCONCLUSIVE() = 0` Inconclusive result. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#RESULT_NEGATIVE() = 3` Negative fertility (may also be referred as "low" fertility). |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#RESULT_POSITIVE() = 1` Positive fertility (may also be referred as "peak" fertility). |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#OvulationTestRecord(java.time.Instant,java.time.ZoneOffset,kotlin.Int,androidx.health.connect.client.records.metadata.Metadata)( time: https://developer.android.com/reference/java/time/Instant.html, zoneOffset: https://developer.android.com/reference/java/time/ZoneOffset.html?, result: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, metadata: https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata )` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#toString()()` |

| ### Public properties |
|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#metadata()` Set of common metadata associated with the written record. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#result()` The result of a user's ovulation test, which shows if they're ovulating or not. |
| `open https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#time()` Time the record happened. |
| `open https://developer.android.com/reference/java/time/ZoneOffset.html?` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#zoneOffset()` User experienced zone offset at `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/InstantaneousRecord#time()`, or null if unknown. |

## Constants

### RESULT_HIGH

```
const val RESULT_HIGH = 2: Int
```

High fertility. Refers to a rise in estrogen or luteinizing hormone that may signal the fertile window (time in the menstrual cycle when conception is likely to occur).

### RESULT_INCONCLUSIVE

```
const val RESULT_INCONCLUSIVE = 0: Int
```

Inconclusive result. Refers to ovulation test results that are indeterminate (e.g. may be testing malfunction, user error, etc.). ". Any unknown value will also be returned as `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/OvulationTestRecord#RESULT_INCONCLUSIVE()`.

### RESULT_NEGATIVE

```
const val RESULT_NEGATIVE = 3: Int
```

Negative fertility (may also be referred as "low" fertility). Refers to the time in the cycle where fertility/conception is expected to be low.

### RESULT_POSITIVE

```
const val RESULT_POSITIVE = 1: Int
```

Positive fertility (may also be referred as "peak" fertility). Refers to the peak of the luteinizing hormone (LH) surge and ovulation is expected to occur in 10-36 hours.

## Public constructors

### OvulationTestRecord

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
OvulationTestRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    result: Int,
    metadata: Metadata
)
```

## Public functions

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### toString

```
open fun toString(): String
```

## Public properties

### metadata

```
open val metadata: Metadata
```

Set of common metadata associated with the written record.

### result

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val result: Int
```

The result of a user's ovulation test, which shows if they're ovulating or not. Required field.

Value is one of the following:

- `0`
- `1`
- `2`
- `3`

<br />

### time

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open val time: Instant
```

Time the record happened.

### zoneOffset

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open val zoneOffset: ZoneOffset?
```

User experienced zone offset at `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/InstantaneousRecord#time()`, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.