Type Method

predicateForQuantitySamplesWithOperatorType:quantity:

Returns a predicate that matches samples based on the target quantity.

Declaration

+ (NSPredicate *)predicateForQuantitySamplesWithOperatorType:(NSPredicateOperatorType)operatorType quantity:(HKQuantity *)quantity;

Parameters

operatorType

The operator type to use when comparing the sample’s quantity to the target quantity.

quantity

The target quantity object.

Return Value

A predicate that matches samples based on the target quantity. This predicate works only on quantity samples.

Discussion

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

HKQuantity *targetWeight =
[HKQuantity quantityWithUnit:[HKUnit poundUnit]
                 doubleValue:150.0];
 
NSPredicate *underTargetWeight =
[HKQuery predicateForQuantitySamplesWithOperatorType:
    NSLessThanOrEqualToPredicateOperatorType
    quantity:targetWeight];
 
NSPredicate *explicitUnderTargetWeight =
[NSPredicate predicateWithFormat:@"%K <= %@",
 HKPredicateKeyPathQuantity,
 targetWeight];

See Also