Skip to content
REFERENCE · SDK CONTRACT

Platform support

The facade keeps common workflows uniform while preserving platform-specific privacy and capability rules.

Baseline

PlatformMinimum OSNative API
AndroidAndroid 8.0 / API 26Health Connect
iOSiOS 15HealthKit

Operation matrix

OperationAndroidiOSNotes
ReadType and OS availability vary.
WriteRequires per-type authorization.
UpdateHealth Connect-specific capability.
DeleteNative ownership rules apply.
AggregateMetrics vary by data type and platform.
Incremental syncUnified through platform cursor mechanisms.
Background readCapability-basedCapability-basedRequires permission and OS scheduling.

Important differences

iOS read authorization

HealthKit does not disclose whether a user denied read permission. Read permission checks return unknown; applications should execute the query and accept an empty result as valid.

Android declarations

Every requested Health Connect type must have a matching <uses-permission> entry. Missing declarations produce a configuration error before the operation can succeed.

Feature discovery

Newer records and operations can depend on Health Connect SDK extensions or OS releases. Use getFeatureStatus() for optional capabilities and keep fallbacks in product flows.

Record availability

Not every conceptual record has a perfect equivalent on both platforms. Consult the generated API documentation and the platform annotations on each data type before designing a cross-platform feature.

Released under the Apache 2.0 License.