MenstruationFlowRecord

class MenstruationFlowRecord : Record


Captures a description of how heavy a user's menstrual flow was (light, medium, or heavy). Each record represents a description of how heavy the user's menstrual bleeding was.

Summary

Constants

const Int
const Int
const Int
const Int

Public constructors

MenstruationFlowRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    flow: Int,
    metadata: Metadata
)

Public functions

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

Public properties

Int

How heavy the user's menstrual flow was.

open Metadata

Set of common metadata associated with the written record.

open Instant

Time the record happened.

open ZoneOffset?

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

Constants

FLOW_HEAVY

const val FLOW_HEAVY = 3: Int

FLOW_LIGHT

const val FLOW_LIGHT = 1: Int

FLOW_MEDIUM

const val FLOW_MEDIUM = 2: Int

FLOW_UNKNOWN

const val FLOW_UNKNOWN = 0: Int

Public constructors

MenstruationFlowRecord

Added in 1.1.0-alpha07
MenstruationFlowRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    flow: Int = FLOW_UNKNOWN,
    metadata: Metadata = Metadata.EMPTY
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

Public properties

flow

Added in 1.1.0-alpha07
val flowInt

How heavy the user's menstrual flow was. Optional field.

metadata

Added in 1.1.0-alpha07
open val metadataMetadata

Set of common metadata associated with the written record.

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.