Это руководство совместимо с Health Connect версии 1.1.0-alpha12 .
Маршруты тренировок позволяют пользователям отслеживать GPS-маршруты соответствующих тренировок и делиться картами своих тренировок с другими приложениями.
В этом руководстве представлена информация о том, как запрашивать разрешения у пользователя, а также описывается, как приложения получают разрешение на запись данных маршрута в рамках сеанса тренировки.
Вот краткое описание функций чтения и записи для маршрутов упражнений:
- Приложения создают новое разрешение на запись для маршрутов тренировок.
- Вставка происходит путем записи сеанса тренировки с маршрутом в качестве поля.
- Чтение:
- Для владельца сеанса доступ к данным осуществляется посредством чтения сеанса.
- Из стороннего приложения через диалоговое окно, позволяющее пользователю разрешить однократное чтение маршрута.
Запросить разрешения у пользователя
После создания экземпляра клиента вашему приложению необходимо запросить разрешения у пользователя. Пользователям должно быть разрешено предоставлять или отказывать в разрешениях в любое время.
Для этого создайте набор разрешений для необходимых типов данных. Убедитесь, что разрешения в наборе сначала объявлены в манифесте Android.
// Create a set of permissions for required data types
val PERMISSIONS =
setOf(
HealthPermission.getReadPermission(ExerciseSessionRecord::class),
HealthPermission.getWritePermission(ExerciseSessionRecord::class)
)
Используйте getGrantedPermissions , чтобы узнать, есть ли у вашего приложения необходимые разрешения. Если нет, используйте createRequestPermissionResultContract для запроса этих разрешений. Откроется экран разрешений 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)
}
}
Поскольку пользователи могут предоставлять или отзывать разрешения в любое время, вашему приложению необходимо периодически проверять наличие предоставленных разрешений и обрабатывать сценарии, в которых разрешения теряются.
Осуществление разрешений на запись и чтение маршрута
Маршруты упражнений имеют собственное разрешение на запись во время выполнения ( android.permission.health.WRITE_EXERCISE_ROUTE ).
Чтобы добавить возможность маршрута тренировки в свое приложение, начните с запроса разрешений на запись для определенного типа данных.
Вам также необходимо задекларировать разрешение на тренировку, поскольку каждый маршрут связан с тренировкой (один сеанс = одна тренировка).
Вот разрешение, которое вам нужно объявить, чтобы иметь возможность писать маршруты упражнений:
<application>
<uses-permission
android:name="android.permission.health.WRITE_EXERCISE_ROUTE" />
<uses-permission
android:name="android.permission.health.WRITE_EXERCISE" />
...
</application>
Чтобы прочитать маршруты тренировок, вам необходимо запросить следующие разрешения:
<application>
<uses-permission
android:name="android.permission.health.READ_EXERCISE_ROUTES" />
<uses-permission
android:name="android.permission.health.READ_EXERCISE" />
...
</application>
Чтобы запросить разрешения, используйте метод PermissionController.createRequestPermissionResultContract() при первом подключении приложения к Health Connect. Несколько разрешений, которые вы можете запросить:
- Чтение данных о работоспособности, включая данные маршрута:
HealthPermission.getReadPermission(ExerciseSessionRecord::class) - Запись данных о работоспособности, включая данные маршрута:
HealthPermission.getWritePermission(ExerciseSessionRecord::class) - Запишите данные маршрута тренировки:
HealthPermission.PERMISSION_WRITE_EXERCISE_ROUTE.
Чтение и запись данных маршрута
Приложения вставляют маршрут, записывая сеанс с маршрутом в качестве поля.
Если у пользователя нет прав на запись и маршрут не установлен, маршрут не обновляется.
Если ваше приложение имеет разрешение на запись маршрута и пытается обновить сеанс, передав объект сеанса без маршрута, существующий маршрут удаляется.
Всякий раз, когда вашему приложению необходимо прочитать данные маршрута, предоставленные сторонним приложением, появляется диалоговое окно с просьбой разрешить операцию чтения.
Запрос маршрута из сеанса
Вот как прочитать сеанс в Health Connect и запросить маршрут из этого сеанса:
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.
}
}
Написать маршрут из сеанса
Следующий код демонстрирует, как записать сеанс, включающий маршрут тренировки:
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))
}