यह गाइड, Health Connect के 1.1.0-alpha12 वर्शन के साथ काम करती है.
कसरत के लिए रूट की सुविधा की मदद से, उपयोगकर्ता कसरत से जुड़ी गतिविधियों के लिए जीपीएस रूट ट्रैक कर सकते हैं. साथ ही, अपने वर्कआउट के मैप को अन्य ऐप्लिकेशन के साथ शेयर कर सकते हैं.
इस गाइड में, उपयोगकर्ता से अनुमतियां मांगने का तरीका बताया गया है. साथ ही, इसमें यह भी बताया गया है कि ऐप्लिकेशन को कसरत के सेशन के दौरान, रास्ते का डेटा लिखने की अनुमति कैसे मिलती है.
कसरत के रूट की जानकारी देखने और उसमें बदलाव करने की सुविधा में ये काम शामिल हैं:
- ऐप्लिकेशन, कसरत के रूट के लिए लिखने की नई अनुमति बनाते हैं.
- कसरत का सेशन लिखकर, रूट को फ़ील्ड के तौर पर जोड़ें.
- पढ़ना:
- सेशन के मालिक के लिए, सेशन रीड का इस्तेमाल करके डेटा ऐक्सेस किया जाता है.
- तीसरे पक्ष के ऐप्लिकेशन से, डायलॉग बॉक्स के ज़रिए. इसकी मदद से, उपयोगकर्ता किसी रास्ते को एक बार पढ़ने की अनुमति दे सकता है.
अगर उपयोगकर्ता के पास लिखने की अनुमतियां नहीं हैं और रास्ता सेट नहीं किया गया है, तो रास्ता अपडेट नहीं होता.
अगर आपके ऐप्लिकेशन के पास रूट में बदलाव करने की अनुमति है और वह बिना रूट वाले सेशन ऑब्जेक्ट को पास करके सेशन को अपडेट करने की कोशिश करता है, तो मौजूदा रूट मिटा दिया जाता है.
ज़रूरी अनुमतियां
कसरत के रूट का ऐक्सेस, इन अनुमतियों से सुरक्षित होता है:
android.permission.health.READ_EXERCISE_ROUTES
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>
अनुमतियों का अनुरोध करने के लिए, अपने ऐप्लिकेशन को पहली बार Health Connect से कनेक्ट करते समय, PermissionController.createRequestPermissionResultContract()
तरीके का इस्तेमाल करें. आपको इन अनुमतियों का अनुरोध करना पड़ सकता है:
- सेहत से जुड़ा डेटा पढ़ें. इसमें रास्ते की जानकारी भी शामिल है:
HealthPermission.getReadPermission(ExerciseSessionRecord::class)
- सेहत से जुड़ा डेटा लिखें. इसमें रास्ते का डेटा भी शामिल है:
HealthPermission.getWritePermission(ExerciseSessionRecord::class)
- कसरत के रूट का डेटा लिखें:
HealthPermission.PERMISSION_WRITE_EXERCISE_ROUTE
उपयोगकर्ता से अनुमतियों का अनुरोध करना
क्लाइंट इंस्टेंस बनाने के बाद, आपके ऐप्लिकेशन को उपयोगकर्ता से अनुमतियों का अनुरोध करना होगा. उपयोगकर्ताओं को किसी भी समय अनुमतियां देने या अस्वीकार करने की अनुमति होनी चाहिए.
ऐसा करने के लिए, ज़रूरी डेटा टाइप के लिए अनुमतियों का सेट बनाएं. पक्का करें कि सेट में मौजूद अनुमतियों का एलान, आपके 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)
}
}
उपयोगकर्ता किसी भी समय अनुमतियां दे सकते हैं या उन्हें रद्द कर सकते हैं. इसलिए, आपके ऐप्लिकेशन को समय-समय पर यह देखना होगा कि उपयोगकर्ता ने कौनसी अनुमतियां दी हैं. साथ ही, उन स्थितियों को मैनेज करना होगा जिनमें अनुमति रद्द हो जाती है.
कसरत के सेशन के रिकॉर्ड में शामिल जानकारी
हर कसरत के सेशन के रिकॉर्ड में यह जानकारी शामिल होती है:
- कसरत का टाइप, जैसे कि साइकल चलाना.
- कसरत का रास्ता, जिसमें अक्षांश, देशांतर, और ऊंचाई जैसी जानकारी शामिल होती है.
इस्तेमाल किए जा सकने वाले एग्रीगेशन
इस डेटा टाइप के लिए, एग्रीगेशन की सुविधा काम नहीं करती.
इस्तेमाल का उदाहरण
किसी सेशन से रास्ते का अनुरोध करें या रास्ता लिखें.
किसी सेशन से रास्ते का अनुरोध करना
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))
}