Unreal API reference
Modules and headers
Section titled “Modules and headers”| Surface | Module | Primary headers |
|---|---|---|
| Base runtime | HealthBridge |
HealthBridgeService.h, HealthBridgeEvents.h, HealthBridgeTypes.h, HealthDataTypeRegistry.h, HealthBridgeBlueprintLibrary.h |
| Samples | HealthBridgeSamples |
HealthDataReviewActor.h, HealthDataReviewWidget.h |
| Editor tools | HealthBridgeEditor |
Editor-only; do not add to runtime dependencies |
Primary runtime types
Section titled “Primary runtime types”| Type | Purpose |
|---|---|
FHealthBridgeService |
Static C++ API and provider lifecycle |
UHealthBridgeSubsystem |
Game-instance Blueprint/UObject facade |
IHealthBridgeProvider |
Active provider interface |
FHealthBridgeEvents |
Native multicast events |
UHealthBridgeSettings |
Permissions and mock configuration |
FHealthDataTypeRegistry |
Unified health-type metadata |
UHealthBridgeBlueprintLibrary |
Query, registry, date, value, route, and settings helpers |
Service operations
Section titled “Service operations”FHealthBridgeService exposes:
PrewarmAutoInitializeIsReadyandGetProviderGetRecentWorkoutsandGetRecentWorkoutsDetailedReadDataWriteDataandWriteWorkoutGetWorkoutRouteDeleteDataandDeleteWorkoutPublishHeartRateSample
All completion callbacks and SDK events are delivered on the game thread.
Blueprint subsystem nodes
Section titled “Blueprint subsystem nodes”- Prewarm and Auto Initialize
- Is Ready, Get Provider Name, and Supports Capability
- Get Recent Workouts
- Read Data and enum-backed Read Data Type
- Write Data, Write Data Type, and Write Workout
- Get Workout Route
- Delete Data, Delete Data Type, and Delete Workout
- Start Heart Rate Monitoring and Stop Heart Rate Monitoring
Result types
Section titled “Result types”Always check bSuccess before consuming a result:
FHealthDataReadResultFHealthDataWriteResultFHealthDataDeleteResultFWorkoutRouteReadResultFHealthPermissionResult
Read results can succeed with an empty sample array. Route results can require additional user consent.
Events
Section titled “Events”Native events include:
OnProviderInitializedOnPermissionsResolvedOnHeartRateUpdatedOnDataReadCompletedOnDataWriteCompletedOnDataDeleteCompletedOnWorkoutRouteReadCompletedOnWorkoutsImported
The subsystem exposes Blueprint-assignable equivalents. Remove native delegate handles when their owner is destroyed.
Blueprint helper categories
Section titled “Blueprint helper categories”UHealthBridgeBlueprintLibrary provides helpers for:
- Data-type registry lookup and platform support.
- Configured Android and iOS permissions.
- Unix-millisecond date conversion.
- Generic sample numeric and string values.
- Workout and route values.
- Read, write, and delete query construction.
Query defaults
Section titled “Query defaults”FHealthDataQuery defaults to 7 days and 100 records. Days are clamped to 1–90;
the record limit is clamped to at least 1.