Summary: Nested Classes | Constants | Methods | Inherited Methods

MenstrualCyclePhaseRecord

Kotlin |Java

public final class MenstrualCyclePhaseRecord
extends IntervalRecord

java.lang.Object
↳	android.health.connect.datatypes.Record
	↳	android.health.connect.datatypes.IntervalRecord
		↳	android.health.connect.datatypes.MenstrualCyclePhaseRecord

Represents a user's menstrual cycle phase for a specific day.

This record is designed to capture the current phase of the menstrual cycle (e.g., follicular, luteal) for a given day. It is not intended for predictive use cases.

Summary

Nested classes
`class`	`MenstrualCyclePhaseRecord.Builder` Builder class for `MenstrualCyclePhaseRecord`.

Constants
`int`	`PHASE_FOLLICULAR` Represents the follicular phase of the menstrual cycle.
`int`	`PHASE_LUTEAL` Represents the luteal phase of the menstrual cycle.

Public methods
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`LocalDate`	`getDate()` Returns the date of the record.
`int`	`getDayOfCycle()` Returns the day within the menstrual cycle.
`int`	`getPhase()` Returns the phase of the menstrual cycle.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isDayOfCycleSet()` Returns whether the day of cycle was set in this record.

Inherited methods

From class


        
          android.health.connect.datatypes.IntervalRecord

`boolean`	`equals(Object object)` Indicates whether some other object is "equal to" this one.
`Instant`	`getEndTime()`
`ZoneOffset`	`getEndZoneOffset()`
`Instant`	`getStartTime()`
`ZoneOffset`	`getStartZoneOffset()`
`int`	`hashCode()` Returns a hash code value for the object.

From class


        
          android.health.connect.datatypes.Record

`boolean`	`equals(Object object)` Indicates whether some other object is "equal to" this one.
`Metadata`	`getMetadata()`
`int`	`hashCode()` Returns a hash code value for the object.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

PHASE_FOLLICULAR

public static final int PHASE_FOLLICULAR

Represents the follicular phase of the menstrual cycle. This phase begins with menstruation and ends with ovulation.

Constant Value: 1 (0x00000001)

PHASE_LUTEAL

public static final int PHASE_LUTEAL

Represents the luteal phase of the menstrual cycle. This phase begins after ovulation and ends just before the next menstrual period.

Constant Value: 2 (0x00000002)

Public methods

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

Parameters
`o`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj

getDate

public LocalDate getDate ()

Returns the date of the record.

Returns
`LocalDate`	This value cannot be `null`.

getDayOfCycle

public int getDayOfCycle ()

Returns the day within the menstrual cycle.

Returns
`int`

Throws
`IllegalStateException`	if the day of cycle was not set.

getPhase

public int getPhase ()

Returns the phase of the menstrual cycle.

Returns
`int`	Value is one of the following: `PHASE_FOLLICULAR` `PHASE_LUTEAL`

hashCode

public int hashCode ()

Returns a hash code value for the object.

Returns
`int`	a hash code value for this object.

isDayOfCycleSet

public boolean isDayOfCycleSet ()

Returns whether the day of cycle was set in this record.

Returns
`boolean`

MenstrualCyclePhaseRecord

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

PHASE_FOLLICULAR

PHASE_LUTEAL

Public methods

equals

getDate

getDayOfCycle

getPhase

hashCode

isDayOfCycleSet