CervicalMucusRecord

Artifact: androidx.health.connect:connect-client

View Source

Added in 1.1.0

---

Kotlin |Java

public final class CervicalMucusRecord implements 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
static final int	APPEARANCE_CREAMY = 3
static final int	APPEARANCE_DRY = 1
static final int	APPEARANCE_EGG_WHITE = 5 A constant describing clear or egg white like looking cervical mucus.
static final int	APPEARANCE_STICKY = 2
static final int	APPEARANCE_UNKNOWN = 0
static final int	APPEARANCE_UNUSUAL = 6 A constant describing an unusual (worth attention) kind of cervical mucus.
static final int	APPEARANCE_WATERY = 4
static final int	SENSATION_HEAVY = 3
static final int	SENSATION_LIGHT = 1
static final int	SENSATION_MEDIUM = 2
static final int	SENSATION_UNKNOWN = 0

Public constructors
CervicalMucusRecord(     @NonNull Instant time,     ZoneOffset zoneOffset,     @NonNull Metadata metadata,     int appearance,     int sensation )

Public methods
boolean	equals(Object other)
final int	getAppearance() The consistency of the user's cervical mucus.
@NonNull Metadata	getMetadata() Set of common metadata associated with the written record.
final int	getSensation() The feel of the user's cervical mucus.
@NonNull Instant	getTime() Time the record happened.
ZoneOffset	getZoneOffset() User experienced zone offset at time, or null if unknown.
int	hashCode()
@NonNull String	toString()

Constants

APPEARANCE_CREAMY

public static final int APPEARANCE_CREAMY = 3

APPEARANCE_DRY

public static final int APPEARANCE_DRY = 1

APPEARANCE_EGG_WHITE

public static final int APPEARANCE_EGG_WHITE = 5

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

APPEARANCE_STICKY

public static final int APPEARANCE_STICKY = 2

APPEARANCE_UNKNOWN

public static final int APPEARANCE_UNKNOWN = 0

APPEARANCE_UNUSUAL

public static final int APPEARANCE_UNUSUAL = 6

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

APPEARANCE_WATERY

public static final int APPEARANCE_WATERY = 4

SENSATION_HEAVY

public static final int SENSATION_HEAVY = 3

SENSATION_LIGHT

public static final int SENSATION_LIGHT = 1

SENSATION_MEDIUM

public static final int SENSATION_MEDIUM = 2

SENSATION_UNKNOWN

public static final int SENSATION_UNKNOWN = 0

Public constructors

CervicalMucusRecord

Added in 1.1.0

public CervicalMucusRecord(
    @NonNull Instant time,
    ZoneOffset zoneOffset,
    @NonNull Metadata metadata,
    int appearance,
    int sensation
)

Public methods

equals

public boolean equals(Object other)

getAppearance

Added in 1.1.0

public final int getAppearance()

The consistency of the user's cervical mucus.

getMetadata

public @NonNull Metadata getMetadata()

Set of common metadata associated with the written record.

getSensation

Added in 1.1.0

public final int getSensation()

The feel of the user's cervical mucus.

getTime

Added in 1.1.0

public @NonNull Instant getTime()

Time the record happened.

getZoneOffset

Added in 1.1.0

public ZoneOffset getZoneOffset()

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.

hashCode

public int hashCode()

toString

public @NonNull String toString()