เพิ่มเส้นทางออกกำลังกาย

คำแนะนำนี้ใช้ได้กับ Health Connect เวอร์ชัน 1.1.0-alpha12

เส้นทางการออกกําลังกายช่วยให้ผู้ใช้ติดตามเส้นทาง GPS สําหรับกิจกรรมการออกกําลังกายที่เกี่ยวข้อง และแชร์แผนที่ของการออกกำลังกายกับแอปอื่นๆ ได้

คู่มือนี้จะอธิบายวิธีที่แอปได้รับสิทธิ์ในการเขียนข้อมูลเส้นทางเป็นส่วนหนึ่งของเซสชันการออกกําลังกาย

ข้อมูลสรุปสั้นๆ เกี่ยวกับฟังก์ชันการอ่านและเขียนสำหรับเส้นทางออกกำลังกายมีดังนี้

1. แอปจะสร้างสิทธิ์การเขียนใหม่สำหรับเส้นทางออกกำลังกาย
2. โดยการแทรกเกิดขึ้นจากการเขียนเซสชันการออกกําลังกายที่มีเส้นทางเป็นช่อง
3. การอ่าน:
   1. สําหรับเจ้าของเซสชัน ระบบจะเข้าถึงข้อมูลโดยใช้การอ่านเซสชัน
   2. จากแอปของบุคคลที่สามผ่านกล่องโต้ตอบที่อนุญาตให้ผู้ใช้ให้สิทธิ์อ่านเส้นทางแบบครั้งเดียว

สิทธิ์

เส้นทางการออกกำลังกายมีสิทธิ์เขียนรันไทม์ของตนเอง (android.permission.health.WRITE_EXERCISE_ROUTE)

หากต้องการเพิ่มความสามารถในการแสดงเส้นทางออกกำลังกายในแอป ให้เริ่มด้วยการขอสิทธิ์เขียนสำหรับประเภทข้อมูลที่ต้องการ

คำขอสิทธิ์ใน Android 14

คำขอสิทธิ์ใน Android 13

นอกจากนี้ คุณยังต้องประกาศสิทธิ์การออกกำลังกายด้วย เนื่องจากเส้นทางแต่ละเส้นทางจะเชื่อมโยงกับเซสชันการออกกำลังกาย (1 เซสชัน = 1 การออกกำลังกาย)

สิทธิ์ที่คุณต้องประกาศเพื่อให้เขียนเส้นทางการออกกำลังกายได้มีดังนี้

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