KHealth/com.khealth

Package-level declarations

Types

HealthStoreNotAvailableException

object HealthStoreNotAvailableException : Exception

HealthStoreNotInitialisedException

object HealthStoreNotInitialisedException : Exception

KHCervicalMucusAppearance

enum KHCervicalMucusAppearance : Enum<KHCervicalMucusAppearance>

Represents a self-assessed description (look and feel) of the cervical mucus for a user.

KHCyclingPedalingCadenceSample

data class KHCyclingPedalingCadenceSample(val revolutionsPerMinute: Double, val time: Instant)

Represents a single measurement of KHRecord.CyclingPedalingCadence.

KHealth

interface KHealth

KHealth is a Kotlin Multiplatform wrapper around Android's Health Connect and Apple's HealthKit APIs. It provides a set of convenient properties and methods to perform most common operations easily (like checking/requesting permissions, reading/writing data, and more).

KHealthInitProvider

class KHealthInitProvider : ContentProvider

Automatically initializes KHealthContext with the application context upon app launch.

KHExerciseType

enum KHExerciseType : Enum<KHExerciseType>

Depicts the category of KHRecord.Exercise that the user is performing.

KHHeartRateSample

data class KHHeartRateSample(val beatsPerMinute: Long, val time: Instant)

Represents a single measurement of the heart rate (KHRecord.HeartRate).

KHMealType

enum KHMealType : Enum<KHMealType>

The type of food that the KHRecord.Nutrition object represents.

KHMenstruationFlowType

enum KHMenstruationFlowType : Enum<KHMenstruationFlowType>

Refers to the pattern or characteristics of menstrual bleeding, such as light, moderate, or heavy flow, and its duration and consistency throughout the cycle.

KHOvulationTestResult

enum KHOvulationTestResult : Enum<KHOvulationTestResult>

An ovulation test checks for a rise in a hormone called luteinizing hormone (LH) in your urine, which happens just before ovulation.

KHPermission

sealed class KHPermission

Depicts an instance of the app's request to the operating system to provide it with the access to read and/or write a particular kind of data from/to the health store.

KHPowerSample

data class KHPowerSample(val unit: KHUnit.Power, val value: Double, val time: Instant)

Represents a single measurement of power. For example, using a power meter when exercising on a stationary bike.

KHReadRequest

sealed class KHReadRequest<T : KHRecord>

Represents the kind of KHRecord the app wants to read.

KHRecord

sealed class KHRecord

Represents a readable or writable entity.

KHSleepStage

enum KHSleepStage : Enum<KHSleepStage>

Captures the sleep stage the user entered during a sleep session.

KHSleepStageSample

data class KHSleepStageSample(val stage: KHSleepStage, val startTime: Instant, val endTime: Instant)

Represents a single measurement of KHRecord.SleepSession.

KHSpeedSample

data class KHSpeedSample(val unit: KHUnit.Velocity, val value: Double, val time: Instant)

Represents a single measurement of the speed, a scalar magnitude.

KHUnit

sealed class KHUnit

The measurement scale of various types of values.

KHWriteResponse

sealed class KHWriteResponse

Depicts the kind of response from the health store when a KHRecord is written onto it. The transaction can either Success completely, Fail completely, or Fail partially.

NoWriteAccessException