KHealth/com.khealth

Package-level declarations

Types

HealthStoreNotAvailableException

object HealthStoreNotAvailableException

HealthStoreNotInitialisedException

object HealthStoreNotInitialisedException

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.

KHDataType

enum KHDataType : Enum<KHDataType>

Depicts what kind of values a KHRecord refers to.

KHealth

expect class 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).

KHEither

data class KHEither<T, U>(val left: T, val right: U)

Represents a disjoint union entity, generally used to depict objects that are supported on both Android and Apple platforms but use different return types internally.

KHHeartRateSample

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

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

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

data class KHPermission(val dataType: KHDataType, val read: Boolean, val write: Boolean)

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 the health store.

KHPermissionStatus

enum KHPermissionStatus : Enum<KHPermissionStatus>

Represents the user's response to a KHPermission request. He can either grant or deny a permission request. But since Apple's HealthKit does not provide the real read status of any permission due to privacy concerns, another type of status was introduced named NotDetermined. In this case, the user will have to just try to read the data from HealthKit, if the data is returned, it means that the app was granted the permission, otherwise not.

KHPermissionWithStatus

data class KHPermissionWithStatus(val permission: KHPermission, val readStatus: KHPermissionStatus, val writeStatus: KHPermissionStatus)

Clubs a permission with its status. Useful for the case where the app requests statuses for a list of permissions that include a few unsupported ones on the current platform and the library removes it from the input request and output status lists for compatibility reasons. In that case, this object will come handy in detecting exactly which permissions were interacted with (i.e. granted or denied) by the user.

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

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

data class NoWriteAccessException(forPermission: String? = null)