predicateForWorkouts(with:totalDistance:)

Declaration

class func predicateForWorkouts(with operatorType: NSComparisonPredicate.Operator, totalDistance: HKQuantity) -> NSPredicate

Parameters

• operatorType:

  The operator type to use when comparing the total distance.

• totalDistance:

  The target distance.

Return Value

A predicate for matching workouts based on the total distance traveled. This predicate works only on workouts.

Discussion

Use this convenience method to create a predicate that matches against a workout’s total distance. The following sample uses both the convenience method and a predicate format string to create equivalent predicates.

See Also

Related Documentation

• totalDistance
• HKPredicateKeyPathWorkoutTotalDistance

Creating workout predicates

• predicateForObjects(from:)
• predicateForWorkouts(with:)
• predicateForWorkouts(activityPredicate:)
• predicateForWorkouts(with:duration:)
• predicateForWorkouts(operatorType:quantityType:averageQuantity:)
• predicateForWorkouts(operatorType:quantityType:maximumQuantity:)
• predicateForWorkouts(operatorType:quantityType:minimumQuantity:)
• predicateForWorkouts(operatorType:quantityType:sumQuantity:)
• predicateForWorkouts(with:totalEnergyBurned:)
• predicateForWorkouts(with:totalFlightsClimbed:)
• predicateForWorkouts(with:totalSwimmingStrokeCount:)