OvulationTestRecord

class OvulationTestRecord : Record


Each record represents the result of an ovulation test.

Summary

Constants

const Int

High fertility.

const Int

Inconclusive result.

const Int

Negative fertility (may also be referred as "low" fertility).

const Int

Positive fertility (may also be referred as "peak" fertility).

Public constructors

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

Public functions

open operator Boolean
equals(other: Any?)
open Int

Public properties

open Metadata

Set of common metadata associated with the written record.

Int

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

open Instant

Time the record happened.

open ZoneOffset?

User experienced zone offset at 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 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-alpha07
OvulationTestRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    result: Int,
    metadata: Metadata = Metadata.EMPTY
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

Public properties

metadata

Added in 1.1.0-alpha07
open val metadataMetadata

Set of common metadata associated with the written record.

result

Added in 1.1.0-alpha07
val resultInt

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

time

Added in 1.1.0-alpha07
open val timeInstant

Time the record happened.

zoneOffset

Added in 1.1.0-alpha07
open val zoneOffsetZoneOffset?

User experienced zone offset at 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.