Class

HKWorkoutRouteBuilder

A builder object that incrementally constructs a workout route.

Declaration

@interface HKWorkoutRouteBuilder : HKSeriesBuilder

Overview

To create a workout route, instantiate a HKWorkoutRouteBuilder, and provide it with location data throughout the workout. After the workout ends, call the builder’s finishRouteWithWorkout:metadata:completion: method to construct the route. For detailed instructions, see Creating a Workout Route.

Topics

Creating the Builder

- initWithHealthStore:device:

Creates and returns a new workout route builder.

Building the Route

- finishRouteWithWorkout:metadata:completion:

Creates, saves, and associates the route with the provided workout.

- insertRouteData:completion:

Adds route data to the builder.

- addMetadata:completion:

Adds metadata to the builder.

Relationships

Inherits From

See Also

Route Data

Creating a Workout Route

Record the user’s route during a workout.

Reading Route Data

Access the user’s route for a workout.

HKWorkoutRoute

A sample that contains a workout’s route data.

HKWorkoutRouteQuery

A query to access the location data stored in a workout route.

HKWorkoutRouteTypeIdentifier

A series sample containing location data that defines the route the user took during a workout.

HKSeriesBuilder

An abstract base class for building series samples.

HKSeriesSample

An abstract base class that defines samples that contain a series of items.