Pass a Custom Predicate for HealthKit Data Collection (#5)

StanfordSpezi · May 23, 2023 · 7ae7c34 · 7ae7c34
1 parent d03eabc
commit 7ae7c34
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/Sources/SpeziHealthKit/CollectSample/CollectSample.swift b/Sources/SpeziHealthKit/CollectSample/CollectSample.swift
@@ -22,9 +22,16 @@ public struct CollectSample: HealthKitDataSourceDescription {
 
     /// - Parameters:
     ///   - sampleType: The `HKSampleType` that should be collected
+    ///   - predicate: A custom predicate that should be passed to the HealthKit query.
+    ///                The default predicate collects all samples that have been collected from the first time that the user
+    ///                provided the application authorization to collect the samples.
     ///   - deliverySetting: The ``HealthKitDeliverySetting`` that should be used to collect the sample type. `.manual` is the default argument used.
-    public init<S: HKSampleType>(_ sampleType: S, deliverySetting: HealthKitDeliverySetting = .manual()) {
-        self.collectSamples = CollectSamples([sampleType], deliverySetting: deliverySetting)
+    public init<S: HKSampleType>(
+        _ sampleType: S,
+        predicate: NSPredicate? = nil,
+        deliverySetting: HealthKitDeliverySetting = .manual()
+    ) {
+        self.collectSamples = CollectSamples([sampleType], predicate: predicate, deliverySetting: deliverySetting)
     }
 
 

diff --git a/Sources/SpeziHealthKit/CollectSample/CollectSamples.swift b/Sources/SpeziHealthKit/CollectSample/CollectSamples.swift
@@ -13,14 +13,23 @@ import Spezi
 /// Collects `HKSampleType`s  in the ``HealthKit`` component.
 public struct CollectSamples: HealthKitDataSourceDescription {
     public let sampleTypes: Set<HKSampleType>
+    let predicate: NSPredicate?
     let deliverySetting: HealthKitDeliverySetting
 
 
     /// - Parameters:
     ///   - sampleType: The set of `HKSampleType`s that should be collected
+    ///   - predicate: A custom predicate that should be passed to the HealthKit query.
+    ///                The default predicate collects all samples that have been collected from the first time that the user
+    ///                provided the application authorization to collect the samples.
     ///   - deliverySetting: The ``HealthKitDeliverySetting`` that should be used to collect the sample type. `.manual` is the default argument used.
-    public init(_ sampleTypes: Set<HKSampleType>, deliverySetting: HealthKitDeliverySetting = .manual()) {
+    public init(
+        _ sampleTypes: Set<HKSampleType>,
+        predicate: NSPredicate? = nil,
+        deliverySetting: HealthKitDeliverySetting = .manual()
+    ) {
         self.sampleTypes = sampleTypes
+        self.predicate = predicate
         self.deliverySetting = deliverySetting
     }
 
@@ -35,6 +44,7 @@ public struct CollectSamples: HealthKitDataSourceDescription {
                 healthStore: healthStore,
                 standard: standard,
                 sampleType: sampleType,
+                predicate: predicate,
                 deliverySetting: deliverySetting,
                 adapter: adapter
             )