Thêm tuyến đường tập thể dục

Hướng dẫn này tương thích với Health Connect phiên bản 1.1.0-alpha12.

Với tuyến đường tập thể dục, người dùng có thể theo dõi tuyến đường qua GPS cho các hoạt động tập thể dục được liên kết và chia sẻ bản đồ trong bài tập của họ với các ứng dụng khác.

Hướng dẫn này cung cấp thông tin về cách yêu cầu người dùng cấp quyền, đồng thời trình bày cách các ứng dụng nhận quyền ghi dữ liệu về tuyến đường trong một phiên tập thể dục.

Chức năng đọc và ghi cho các tuyến đường tập thể dục bao gồm:

  1. Các ứng dụng tạo một quyền ghi mới cho các tuyến đường tập thể dục.
  2. Trường hợp chèn xảy ra bằng cách ghi một phiên tập thể dục có một tuyến đường làm trường của phiên đó.
  3. Đọc:
    1. Đối với chủ sở hữu phiên, dữ liệu được truy cập bằng cách dùng một lần đọc phiên.
    2. Từ ứng dụng của bên thứ ba, thông qua một hộp thoại cho phép người dùng cấp quyền đọc một lần đối với tuyến đường.

Nếu người dùng không có quyền ghi và tuyến đường chưa được thiết lập, thì tuyến đường này sẽ không cập nhật.

Nếu ứng dụng của bạn có quyền ghi tuyến đường và tìm cách cập nhật một phiên bằng cách truyền đối tượng phiên nhưng không có tuyến đường, thì tuyến đường hiện có sẽ bị xoá.

Các quyền bắt buộc

Quyền truy cập vào các lộ trình tập thể dục được bảo vệ bằng các quyền sau:

  • android.permission.health.READ_EXERCISE_ROUTES
  • android.permission.health.WRITE_EXERCISE_ROUTE

Để thêm chức năng tuyến đường tập thể dục vào ứng dụng của bạn, hãy bắt đầu bằng cách yêu cầu quyền ghi cho một kiểu dữ liệu cụ thể.

Bạn cũng phải khai báo quyền đối với bài tập thể dục, vì mỗi tuyến đường được liên kết với một phiên tập thể dục (một phiên = một bài tập).

Dưới đây là quyền bạn cần khai báo để có thể ghi tuyến đường tập thể dục:

<application>
  <uses-permission
android:name="android.permission.health.WRITE_EXERCISE_ROUTE" />
  <uses-permission
android:name="android.permission.health.WRITE_EXERCISE" />
...
</application>

Để đọc lộ trình tập thể dục, bạn cần yêu cầu các quyền sau:

<application>
  <uses-permission
android:name="android.permission.health.READ_EXERCISE_ROUTES" />
  <uses-permission
android:name="android.permission.health.READ_EXERCISE" />
...
</application>

Để yêu cầu cấp quyền, hãy sử dụng phương thức PermissionController.createRequestPermissionResultContract() khi bạn lần đầu kết nối ứng dụng của mình với Health Connect. Dưới đây là một số quyền mà bạn có thể muốn yêu cầu:

  • Đọc dữ liệu sức khoẻ, bao gồm cả dữ liệu tuyến đường: HealthPermission.getReadPermission(ExerciseSessionRecord::class)
  • Ghi dữ liệu sức khoẻ, bao gồm cả dữ liệu tuyến đường: HealthPermission.getWritePermission(ExerciseSessionRecord::class)
  • Ghi dữ liệu tuyến đường tập thể dục: HealthPermission.PERMISSION_WRITE_EXERCISE_ROUTE

Yêu cầu người dùng cấp quyền

Sau khi tạo một phiên bản ứng dụng, ứng dụng của bạn cần yêu cầu người dùng cấp quyền. Người dùng phải được phép cấp hoặc từ chối cấp quyền bất cứ lúc nào.

Để thực hiện việc này, hãy tạo một tập hợp quyền cho các kiểu dữ liệu bắt buộc. Trước tiên, bạn cần khai báo các quyền trong tập hợp này ở tệp kê khai Android.

// Create a set of permissions for required data types
val PERMISSIONS =
    setOf(
  HealthPermission.getReadPermission(ExerciseSessionRecord::class),
  HealthPermission.getWritePermission(ExerciseSessionRecord::class)
)

Hãy sử dụng getGrantedPermissions để xem ứng dụng của bạn đã được cấp các quyền cần thiết chưa. Nếu chưa, hãy sử dụng createRequestPermissionResultContract để yêu cầu các quyền đó. Thao tác này sẽ hiện màn hình các quyền của 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)
  }
}

Vì người dùng có thể cấp hoặc thu hồi quyền bất cứ lúc nào, nên ứng dụng của bạn cần kiểm tra định kỳ các quyền đã cấp và xử lý các tình huống khi mất quyền.

Thông tin có trong bản ghi phiên tập thể dục

Mỗi bản ghi phiên tập thể dục chứa các thông tin sau:

  • Loại bài tập thể dục, ví dụ: đạp xe.
  • Tuyến đường tập thể dục, chứa các thông tin như vĩ độ, kinh độ và độ cao.

Phương pháp tổng hợp được hỗ trợ

Không có phương pháp tổng hợp nào được hỗ trợ cho loại dữ liệu này.

Ví dụ về cách sử dụng

Yêu cầu dữ liệu về tuyến đường hoặc ghi dữ liệu về tuyến đường từ một phiên.

Yêu cầu dữ liệu về tuyến đường từ một phiên

Sau đây là cách đọc một phiên trong Health Connect và yêu cầu dữ liệu về tuyến đường từ phiên đó:

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.
    }
  }

Ghi một tuyến đường từ một phiên

Mã sau đây minh hoạ cách ghi lại một phiên có dữ liệu về tuyến đường tập thể dục:

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))
}