# MindfulnessSessionRecord

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/MindfulnessSessionRecord.kt+class:androidx.health.connect.client.records.MindfulnessSessionRecord) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***


```
public final class MindfulnessSessionRecord implements Record
```

<br />

*** ** * ** ***

Captures any mindfulness session a user does. This can be mindfulness sessions like meditation, breathing.

Each record needs a start time and end time. Records don't need to be back-to-back or directly after each other, there can be gaps in between.

The ability to insert or read this record type is dependent on the version of HealthConnect installed on the device. To check if available: call `https://developer.android.com/reference/androidx/health/connect/client/HealthConnectFeatures#getFeatureStatus(kotlin.Int)` and pass `https://developer.android.com/reference/androidx/health/connect/client/HealthConnectFeatures#FEATURE_MINDFULNESS_SESSION()` as an argument.

## Summary

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#MINDFULNESS_SESSION_TYPE_BREATHING() = 2` Guided breathing mindfulness session. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#MINDFULNESS_SESSION_TYPE_MEDITATION() = 1` Meditation mindfulness session. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#MINDFULNESS_SESSION_TYPE_MOVEMENT() = 4` Stretches/movement mindfulness session. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#MINDFULNESS_SESSION_TYPE_MUSIC() = 3` Music/soundscapes mindfulness session. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#MINDFULNESS_SESSION_TYPE_UNGUIDED() = 5` Unguided mindfulness session. |
| `static final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#MINDFULNESS_SESSION_TYPE_UNKNOWN() = 0` Can be used to represent any generic mindfulness session that does not fall into a specific category. |

| ### Public fields |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/aggregate/AggregateMetric<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Duration.html>` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#MINDFULNESS_DURATION_TOTAL()` Metric identifier to retrieve the total mindfulness session duration from `https://developer.android.com/reference/androidx/health/connect/client/aggregate/AggregationResult`. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#MindfulnessSessionRecord(java.time.Instant,java.time.ZoneOffset,java.time.Instant,java.time.ZoneOffset,androidx.health.connect.client.records.metadata.Metadata,kotlin.Int,kotlin.String,kotlin.String)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html startTime, https://developer.android.com/reference/java/time/ZoneOffset.html startZoneOffset, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html endTime, https://developer.android.com/reference/java/time/ZoneOffset.html endZoneOffset, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/records/metadata/Metadata metadata, int mindfulnessSessionType, https://developer.android.com/reference/java/lang/String.html title, https://developer.android.com/reference/java/lang/String.html notes )` |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#getEndTime()()` End time of the record. |
| `https://developer.android.com/reference/java/time/ZoneOffset.html` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#getEndZoneOffset()()` User experienced zone offset at `https://developer.android.com/reference/androidx/health/connect/client/records/IntervalRecord#endTime()`, or null if unknown. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/records/metadata/Metadata` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#getMetadata()()` Set of common metadata associated with the written record. |
| `final int` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#getMindfulnessSessionType()()` Type of mindfulness session (e.g. meditation, breathing, including unknown type). |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#getNotes()()` Additional notes for the session. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#getStartTime()()` Start time of the record. |
| `https://developer.android.com/reference/java/time/ZoneOffset.html` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#getStartZoneOffset()()` User experienced zone offset at `https://developer.android.com/reference/androidx/health/connect/client/records/IntervalRecord#startTime()`, or null if unknown. |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#getTitle()()` Title of the session. |
| `int` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#hashCode()()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#toString()()` |

## Constants

### MINDFULNESS_SESSION_TYPE_BREATHING

```
public static final int MINDFULNESS_SESSION_TYPE_BREATHING = 2
```

Guided breathing mindfulness session.

### MINDFULNESS_SESSION_TYPE_MEDITATION

```
public static final int MINDFULNESS_SESSION_TYPE_MEDITATION = 1
```

Meditation mindfulness session.

### MINDFULNESS_SESSION_TYPE_MOVEMENT

```
public static final int MINDFULNESS_SESSION_TYPE_MOVEMENT = 4
```

Stretches/movement mindfulness session.

### MINDFULNESS_SESSION_TYPE_MUSIC

```
public static final int MINDFULNESS_SESSION_TYPE_MUSIC = 3
```

Music/soundscapes mindfulness session.

### MINDFULNESS_SESSION_TYPE_UNGUIDED

```
public static final int MINDFULNESS_SESSION_TYPE_UNGUIDED = 5
```

Unguided mindfulness session.

### MINDFULNESS_SESSION_TYPE_UNKNOWN

```
public static final int MINDFULNESS_SESSION_TYPE_UNKNOWN = 0
```

Can be used to represent any generic mindfulness session that does not fall into a specific category. Any unknown new value definition will also fall automatically into `https://developer.android.com/reference/androidx/health/connect/client/records/MindfulnessSessionRecord#MINDFULNESS_SESSION_TYPE_UNKNOWN()`.

Use this type if the mindfulness session type is unknown.

## Public fields

### MINDFULNESS_DURATION_TOTAL

```
public static final @NonNull AggregateMetric<@NonNull Duration> MINDFULNESS_DURATION_TOTAL
```

Metric identifier to retrieve the total mindfulness session duration from `https://developer.android.com/reference/androidx/health/connect/client/aggregate/AggregationResult`. To check if this metric is available, use `https://developer.android.com/reference/androidx/health/connect/client/HealthConnectFeatures#getFeatureStatus(kotlin.Int)` with `https://developer.android.com/reference/androidx/health/connect/client/HealthConnectFeatures#FEATURE_MINDFULNESS_SESSION()` as the argument.

## Public constructors

### MindfulnessSessionRecord

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

```
public MindfulnessSessionRecord(
    @NonNull Instant startTime,
    ZoneOffset startZoneOffset,
    @NonNull Instant endTime,
    ZoneOffset endZoneOffset,
    @NonNull Metadata metadata,
    int mindfulnessSessionType,
    String title,
    String notes
)
```

## Public methods

### equals

```
public boolean equals(Object other)
```

### getEndTime

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

```
public @NonNull Instant getEndTime()
```

End time of the record.

### getEndZoneOffset

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

```
public ZoneOffset getEndZoneOffset()
```

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

### getMetadata

```
public @NonNull Metadata getMetadata()
```

Set of common metadata associated with the written record.

### getMindfulnessSessionType

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

```
public final int getMindfulnessSessionType()
```

Type of mindfulness session (e.g. meditation, breathing, including unknown type).

### getNotes

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

```
public final String getNotes()
```

Additional notes for the session.

### getStartTime

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

```
public @NonNull Instant getStartTime()
```

Start time of the record.

### getStartZoneOffset

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

```
public ZoneOffset getStartZoneOffset()
```

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

### getTitle

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

```
public final String getTitle()
```

Title of the session.

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```