requestExerciseRoute

Health Connect requires users' permission to access routes for exercise records (see Android docs). When exercise records are fetched, they will include an exerciseRoute field with a type (and possibly a route). This method should be called to request permissions to fetch the route if the type is ExerciseRouteResultType.CONSENT_REQUIRED.

NOTE: To read exercise routes, you need to declare the required permissions in your app's AndroidManifest.xml:

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

Method

requestExerciseRoute(recordId: string): Promise<ExerciseRoute>

Example

import {
  requestExerciseRoute,
  readRecord,
  ExerciseRouteResultType,
} from "react-native-health-connect";

const recordId = "6bd8109d-349b-319a-890a-c5a20902b530";

readRecord("ExerciseSession", recordId)
  .then((exercise) => {
    console.log("Exercise record: ", JSON.stringify(exercise, null, 2));

    // Check if consent is required to read route:
    if (
      exercise.exerciseRoute.type === ExerciseRouteResultType.CONSENT_REQUIRED
    ) {
      requestExerciseRoute(recordId).then(({ route }) => {
        if (route) {
          console.log(JSON.stringify(route, null, 2));
        } else {
          console.log("User denied access");
        }
      });
    }
  })
  .catch((err) => {
    console.error("Error reading exercise record", { err });
  });