# CervicalMucusRecord

Artifact: [androidx.health.connect:connect-client](https://developer.android.com/jetpack/androidx/releases/health-connect) [View Source](https://cs.android.com/search?q=file:androidx/health/connect/client/records/CervicalMucusRecord.kt+class:androidx.health.connect.client.records.CervicalMucusRecord) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***


```
class CervicalMucusRecord : Record
```

<br />

*** ** * ** ***

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 https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#APPEARANCE_CREAMY() = 3` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#APPEARANCE_DRY() = 1` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#APPEARANCE_EGG_WHITE() = 5` A constant describing clear or egg white like looking cervical mucus. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#APPEARANCE_STICKY() = 2` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#APPEARANCE_UNKNOWN() = 0` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#APPEARANCE_UNUSUAL() = 6` A constant describing an unusual (worth attention) kind of cervical mucus. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#APPEARANCE_WATERY() = 4` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#SENSATION_HEAVY() = 3` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#SENSATION_LIGHT() = 1` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#SENSATION_MEDIUM() = 2` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#SENSATION_UNKNOWN() = 0` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#CervicalMucusRecord(java.time.Instant,java.time.ZoneOffset,androidx.health.connect.client.records.metadata.Metadata,kotlin.Int,kotlin.Int)( time: https://developer.android.com/reference/java/time/Instant.html, zoneOffset: https://developer.android.com/reference/java/time/ZoneOffset.html?, metadata: https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata, appearance: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, sensation: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#appearance()` The consistency of the user's cervical mucus. |
| `open https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#metadata()` Set of common metadata associated with the written record. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#sensation()` The feel of the user's cervical mucus. |
| `open https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#time()` Time the record happened. |
| `open https://developer.android.com/reference/java/time/ZoneOffset.html?` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/CervicalMucusRecord#zoneOffset()` User experienced zone offset at `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/InstantaneousRecord#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](https://developer.android.com/jetpack/androidx/releases/health-connect#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](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val appearance: Int
```

The consistency of the user's cervical mucus.

Value is one of the following:

- `0`
- `1`
- `2`
- `3`
- `4`
- `5`
- `6`

<br />

### metadata

```
open val metadata: Metadata
```

Set of common metadata associated with the written record.

### sensation

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val sensation: Int
```

The feel of the user's cervical mucus.

Value is one of the following:

- `0`
- `1`
- `2`
- `3`

<br />

### time

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open val time: Instant
```

Time the record happened.

### zoneOffset

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open val zoneOffset: ZoneOffset?
```

User experienced zone offset at `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/InstantaneousRecord#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.