Type Method

predicateForActivitySummary(with:)

Returns a predicate that matches the activity summary for the specified day.

Declaration

class func predicateForActivitySummary(with dateComponents: DateComponents) -> NSPredicate

Parameters

dateComponents

Date components that uniquely identify the day as perceived by the user. This day may be longer or shorter than 24 hours (for example, if the user traveled across time zones).

The date components must have a valid calendar property.

Return Value

A predicate for matching a single activity summary.

Discussion

Use this convenience method to create a predicate that matches the activity summary for the specified day. The following sample uses both the convenience method and a predicate format string to create equivalent predicates.

let forDay = HKQuery.predicateForActivitySummaryWithDateComponents(day)
let explicitForDay = NSPredicate(format: "%K == %@", HKPredicateKeyPathDateComponents, day)

See Also

Creating Activity Summary Predicates

class func predicate(forActivitySummariesBetweenStart: DateComponents, end: DateComponents) -> NSPredicate

Returns a predicate for matching all the activity summaries that fall between the days identified by the start and end date components.