CervicalMucusRecord

class CervicalMucusRecord : Record

Captures the description of cervical mucus. Each record represents a self-assessed description of cervical mucus for a user. All fields are optional and can be used to describe the look and feel of cervical mucus.

Summary

Constants
const Int
const Int
const Int

A constant describing clear or egg white like looking cervical mucus.
const Int
const Int
const Int

A constant describing an unusual (worth attention) kind of cervical mucus.
const Int
const Int
const Int
const Int
const Int

Public constructors
CervicalMucusRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    metadata: Metadata,
    appearance: Int,
    sensation: Int
)

Public functions
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
Int

The consistency of the user's cervical mucus.
open Metadata

Set of common metadata associated with the written record.
Int

The feel of the user's cervical mucus.
open Instant

Time the record happened.
open ZoneOffset?

User experienced zone offset at time, or null if unknown.

Constants

APPEARANCE_CREAMY

const val APPEARANCE_CREAMY = 3: Int

APPEARANCE_DRY

const val APPEARANCE_DRY = 1: Int

APPEARANCE_EGG_WHITE

const val APPEARANCE_EGG_WHITE = 5: Int

A constant describing clear or egg white like looking cervical mucus.

APPEARANCE_STICKY

const val APPEARANCE_STICKY = 2: Int

APPEARANCE_UNKNOWN

const val APPEARANCE_UNKNOWN = 0: Int

APPEARANCE_UNUSUAL

const val APPEARANCE_UNUSUAL = 6: Int

A constant describing an unusual (worth attention) kind of cervical mucus.

APPEARANCE_WATERY

const val APPEARANCE_WATERY = 4: Int

SENSATION_HEAVY

const val SENSATION_HEAVY = 3: Int

SENSATION_LIGHT

const val SENSATION_LIGHT = 1: Int

SENSATION_MEDIUM

const val SENSATION_MEDIUM = 2: Int

SENSATION_UNKNOWN

const val SENSATION_UNKNOWN = 0: Int

Public constructors

CervicalMucusRecord

Added in 1.1.0
CervicalMucusRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    metadata: Metadata,
    appearance: Int = APPEARANCE_UNKNOWN,
    sensation: Int = SENSATION_UNKNOWN
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

appearance

Added in 1.1.0
val appearance: Int

The consistency of the user's cervical mucus.

metadata

open val metadata: Metadata

Set of common metadata associated with the written record.

sensation

Added in 1.1.0
val sensation: Int

The feel of the user's cervical mucus.

time

Added in 1.1.0
open val time: Instant

Time the record happened.

zoneOffset

Added in 1.1.0
open val zoneOffset: ZoneOffset?

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.