Ten przewodnik jest zgodny z wersją Health Connect 1.1.0-alpha12.
Trasy ćwiczeń umożliwiają użytkownikom śledzenie trasy GPS dla powiązanych ćwiczeń oraz udostępnianie map swoich treningów innym aplikacjom.
Ten przewodnik zawiera informacje o tym, jak prosić użytkowników o uprawnienia, a także o tym, jak aplikacje uzyskują uprawnienia do zapisywania danych trasy w ramach sesji ćwiczeń.
Oto krótkie podsumowanie funkcji odczytu i zapisu tras ćwiczeń:
- Aplikacje tworzą nowe uprawnienie do zapisu dotyczące tras ćwiczeń.
- Wstawianie odbywa się przez zapisanie sesji ćwiczeń z polem trasy.
- Odczyt:
- Właściciel sesji uzyskuje dostęp do danych za pomocą sesji odczytu.
- z aplikacji innej firmy za pomocą okna dialogowego, które umożliwia użytkownikowi jednorazowe odczytanie trasy;
Prośba o uprawnienia od użytkownika
Po utworzeniu instancji klienta aplikacja musi poprosić użytkownika o przyznanie uprawnień. Użytkownicy muszą mieć możliwość przyznania lub odmowy przyznania uprawnień w dowolnym momencie.
Aby to zrobić, utwórz zestaw uprawnień dla wymaganych typów danych. Najpierw sprawdź, czy uprawnienia w zestawie są zadeklarowane w pliku manifestu Androida.
// Create a set of permissions for required data types
val PERMISSIONS =
setOf(
HealthPermission.getReadPermission(ExerciseSessionRecord::class),
HealthPermission.getWritePermission(ExerciseSessionRecord::class)
)
Użyj getGrantedPermissions, aby sprawdzić, czy Twoja aplikacja ma już przyznane wymagane uprawnienia. Jeśli nie, użyj createRequestPermissionResultContract, aby poprosić o te uprawnienia. Wyświetli się ekran uprawnień Health Connect.
// Create the permissions launcher
val requestPermissionActivityContract = PermissionController.createRequestPermissionResultContract()
val requestPermissions = registerForActivityResult(requestPermissionActivityContract) { granted ->
if (granted.containsAll(PERMISSIONS)) {
// Permissions successfully granted
} else {
// Lack of required permissions
}
}
suspend fun checkPermissionsAndRun(healthConnectClient: HealthConnectClient) {
val granted = healthConnectClient.permissionController.getGrantedPermissions()
if (granted.containsAll(PERMISSIONS)) {
// Permissions already granted; proceed with inserting or reading data
} else {
requestPermissions.launch(PERMISSIONS)
}
}
Użytkownicy mogą w dowolnym momencie przyznać lub wycofać uprawnienia, dlatego aplikacja musi okresowo sprawdzać, czy zostały one przyznane, oraz obsługiwać scenariusze, w których użytkownik wycofuje uprawnienia.
Uprawnienia do zapisu i odczytu trasy ćwiczeń
Trasy ćwiczeń mają własne uprawnienia do zapisu w czasie działania (android.permission.health.WRITE_EXERCISE_ROUTE).
Aby dodać do aplikacji możliwość tworzenia tras ćwiczeń, najpierw poproś o uprawnienia do zapisu w przypadku konkretnego typu danych.
Musisz też zadeklarować uprawnienia do ćwiczeń, ponieważ każda trasa jest powiązana z sesją ćwiczeń (jedna sesja = jedno ćwiczenie).
Oto uprawnienia, które musisz zadeklarować, aby móc zapisywać trasy ćwiczeń:
<application>
<uses-permission
android:name="android.permission.health.WRITE_EXERCISE_ROUTE" />
<uses-permission
android:name="android.permission.health.WRITE_EXERCISE" />
...
</application>
Aby odczytywać trasy ćwiczeń, musisz poprosić o te uprawnienia:
<application>
<uses-permission
android:name="android.permission.health.READ_EXERCISE_ROUTES" />
<uses-permission
android:name="android.permission.health.READ_EXERCISE" />
...
</application>
Aby poprosić o uprawnienia, użyj metody PermissionController.createRequestPermissionResultContract() podczas pierwszego łączenia aplikacji z Health Connect. Oto kilka uprawnień, o które możesz poprosić:
- odczytywać dane dotyczące zdrowia, w tym dane o trasie:
HealthPermission.getReadPermission(ExerciseSessionRecord::class) - Zapisuj dane o zdrowiu, w tym dane trasy:
HealthPermission.getWritePermission(ExerciseSessionRecord::class) - Zapisuj dane trasy ćwiczeń:
HealthPermission.PERMISSION_WRITE_EXERCISE_ROUTE
Odczytywanie i zapisywanie danych trasy
Aplikacje wstawiają trasę, zapisując sesję z trasą jako polem.
Jeśli użytkownik nie ma uprawnień do zapisu i nie ustawiono trasy, nie będzie ona aktualizowana.
Jeśli aplikacja ma uprawnienia do zapisu trasy i próbuje zaktualizować sesję, przekazując obiekt sesji bez trasy, dotychczasowa trasa zostanie usunięta.
Gdy aplikacja potrzebuje odczytać dane trasy udostępnione przez aplikację innej firmy, pojawia się okno z prośbą o zezwolenie na odczyt.
Prośba o wyznanie trasy z sesji
Aby odczytać sesję w Health Connect i poprosić o trasę z tej sesji:
suspend fun readExerciseSessionAndRoute() {
val endTime = Instant.now()
val startTime = endTime.minus(Duration.ofHours(1))
val grantedPermissions =
healthConnectClient.permissionController.getGrantedPermissions()
if (!grantedPermissions.contains(
HealthPermission.getReadPermission(ExerciseSessionRecord::class))) {
// The user doesn't allow the app to read exercise session data.
return
}
val readResponse =
healthConnectClient.readRecords(
ReadRecordsRequest(
ExerciseSessionRecord::class,
TimeRangeFilter.between(startTime, endTime)
)
)
val exerciseRecord = readResponse.records.first()
val recordId = exerciseRecord.metadata.id
// See https://developer.android.com/training/basics/intents/result#launch
// for appropriately handling ActivityResultContract.
val requestExerciseRouteLauncher = fragment.registerForActivityResul
(ExerciseRouteRequestContract()) { exerciseRoute: ExerciseRoute? ->
if (exerciseRoute != null) {
displayExerciseRoute(exerciseRoute)
} else {
// Consent was denied
}
}
val exerciseSessionRecord =
healthConnectClient.readRecord(ExerciseSessionRecord::class, recordId).record
when (val exerciseRouteResult = exerciseSessionRecord.exerciseRouteResult) {
is ExerciseRouteResult.Data ->
displayExerciseRoute(exerciseRouteResult.exerciseRoute)
is ExerciseRouteResult.ConsentRequired ->
requestExerciseRouteLauncher.launch(recordId)
is ExerciseRouteResult.NoData -> Unit // No exercise route to show
else -> Unit
}
}
fun displayExerciseRoute(route: ExerciseRoute?) {
val locations = route.route.orEmpty()
for (location in locations) {
// Handle location.
}
}
Pisanie trasy z sesji
Poniższy kod pokazuje, jak nagrywać sesję, która obejmuje trasę ćwiczeń:
suspend fun InsertExerciseRoute(healthConnectClient: HealthConnectClient) {
val grantedPermissions =
healthConnectClient.permissionController.getGrantedPermissions()
if (!grantedPermissions.contains(
getWritePermission(ExerciseSessionRecord::class))) {
// The user doesn't allow the app to write exercise session data.
return
}
val sessionStartTime = Instant.now()
val sessionDuration = Duration.ofMinutes(20)
val sessionEndTime = sessionStartTime.plus(sessionDuration)
val exerciseRoute =
if (grantedPermissions.contains(PERMISSION_WRITE_EXERCISE_ROUTE)) ExerciseRoute(
listOf(
ExerciseRoute.Location(
// Location times must be on or after the session start time
time = sessionStartTime,
latitude = 6.5483,
longitude = 0.5488,
horizontalAccuracy = Length.meters(2.0),
verticalAccuracy = Length.meters(2.0),
altitude = Length.meters(9.0),
), ExerciseRoute.Location(
// Location times must be before the session end time
time = sessionEndTime.minusSeconds(1),
latitude = 6.4578,
longitude = 0.6577,
horizontalAccuracy = Length.meters(2.0),
verticalAccuracy = Length.meters(2.0),
altitude = Length.meters(9.2),
)
)
)
else
// The user doesn't allow the app to write exercise route data.
null
val exerciseSessionRecord = ExerciseSessionRecord(
startTime = sessionStartTime,
startZoneOffset = ZoneOffset.UTC,
endTime = sessionEndTime,
endZoneOffset = ZoneOffset.UTC,
exerciseType = ExerciseSessionRecord.EXERCISE_TYPE_BIKING,
title = "Morning Bike Ride",
exerciseRoute = exerciseRoute,
metadata = Metadata.manualEntry(
device = Device(type = Device.TYPE_PHONE)
),
)
val response = healthConnectClient.insertRecords(listOf(exerciseSessionRecord))
}