Documentation Archive Developer
Search

HealthKit Changes for Objective-C

HealthKit

HKAnchoredObjectQuery.h

Added -[HKAnchoredObjectQuery initWithType:predicate:anchor:limit:resultsHandler:]
Added HKAnchoredObjectQuery.updateHandler
Added HKQueryAnchor
Added +[HKQueryAnchor anchorFromValue:]
Modified -[HKAnchoredObjectQuery initWithType:predicate:anchor:limit:completionHandler:]
DeclarationDeprecation
From
- (instancetype)initWithType:(HKSampleType *)type predicate:(NSPredicate *)predicate anchor:(NSUInteger)anchor limit:(NSUInteger)limit completionHandler:(void (^)(HKAnchoredObjectQuery *query, NSArray *results, NSUInteger newAnchor, NSError *error))handler
--
To
- (instancetype _Nonnull)initWithType:(HKSampleType * _Nonnull)type predicate:(NSPredicate * _Nullable)predicate anchor:(NSUInteger)anchor limit:(NSUInteger)limit completionHandler:(void (^ _Nonnull)(HKAnchoredObjectQuery * _Nonnull query, NSArray<__kindof HKSample *> * _Nullable results, NSUInteger newAnchor, NSError * _Nullable error))handler
iOS 9.0

HKCategorySample.h

Added +[HKCategorySample categorySampleWithType:value:startDate:endDate:device:metadata:]
Modified +[HKCategorySample categorySampleWithType:value:startDate:endDate:metadata:]
Declaration
From
+ (instancetype)categorySampleWithType:(HKCategoryType *)type value:(NSInteger)value startDate:(NSDate *)startDate endDate:(NSDate *)endDate metadata:(NSDictionary *)metadata
To
+ (instancetype _Nonnull)categorySampleWithType:(HKCategoryType * _Nonnull)type value:(NSInteger)value startDate:(NSDate * _Nonnull)startDate endDate:(NSDate * _Nonnull)endDate metadata:(NSDictionary<NSString *,id> * _Nullable)metadata

HKCorrelation.h

Added +[HKCorrelation correlationWithType:startDate:endDate:objects:device:metadata:]
Modified HKCorrelation
Protocols
FromNSSecureCoding
To--

Modified +[HKCorrelation correlationWithType:startDate:endDate:objects:]
Declaration
From
+ (instancetype)correlationWithType:(HKCorrelationType *)correlationType startDate:(NSDate *)startDate endDate:(NSDate *)endDate objects:(NSSet *)objects
To
+ (instancetype _Nonnull)correlationWithType:(HKCorrelationType * _Nonnull)correlationType startDate:(NSDate * _Nonnull)startDate endDate:(NSDate * _Nonnull)endDate objects:(NSSet<HKSample *> * _Nonnull)objects

Modified +[HKCorrelation correlationWithType:startDate:endDate:objects:metadata:]
Declaration
From
+ (instancetype)correlationWithType:(HKCorrelationType *)correlationType startDate:(NSDate *)startDate endDate:(NSDate *)endDate objects:(NSSet *)objects metadata:(NSDictionary *)metadata
To
+ (instancetype _Nonnull)correlationWithType:(HKCorrelationType * _Nonnull)correlationType startDate:(NSDate * _Nonnull)startDate endDate:(NSDate * _Nonnull)endDate objects:(NSSet<HKSample *> * _Nonnull)objects metadata:(NSDictionary<NSString *,id> * _Nullable)metadata

Modified HKCorrelation.objects
Declaration
From
@property(readonly, copy) NSSet *objects
To
@property(readonly, copy, nonnull) NSSet<__kindof HKSample *> *objects

Modified -[HKCorrelation objectsForType:]
Declaration
From
- (NSSet *)objectsForType:(HKObjectType *)objectType
To
- (NSSet<__kindof HKSample *> * _Nonnull)objectsForType:(HKObjectType * _Nonnull)objectType

HKCorrelationQuery.h

Modified -[HKCorrelationQuery initWithType:predicate:samplePredicates:completion:]
Declaration
From
- (instancetype)initWithType:(HKCorrelationType *)correlationType predicate:(NSPredicate *)predicate samplePredicates:(NSDictionary *)samplePredicates completion:(void (^)(HKCorrelationQuery *query, NSArray *correlations, NSError *error))completion
To
- (instancetype _Nonnull)initWithType:(HKCorrelationType * _Nonnull)correlationType predicate:(NSPredicate * _Nullable)predicate samplePredicates:(NSDictionary<HKSampleType *,NSPredicate *> * _Nullable)samplePredicates completion:(void (^ _Nonnull)(HKCorrelationQuery * _Nonnull query, NSArray<HKCorrelation *> * _Nullable correlations, NSError * _Nullable error))completion

Modified HKCorrelationQuery.samplePredicates
Declaration
From
@property(readonly, copy) NSDictionary *samplePredicates
To
@property(readonly, copy, nullable) NSDictionary<__kindof HKSampleType *,NSPredicate *> *samplePredicates

HKDefines.h

Added #def HK_AVAILABLE_WATCHOS_ONLY
Added #def HK_CLASS_AVAILABLE_WATCHOS_ONLY
Added HKCategoryValue
Added HKCategoryValueAppleStandHour
Added HKCategoryValueAppleStandHourIdle
Added HKCategoryValueAppleStandHourStood
Added HKCategoryValueCervicalMucusQuality
Added HKCategoryValueCervicalMucusQualityCreamy
Added HKCategoryValueCervicalMucusQualityDry
Added HKCategoryValueCervicalMucusQualityEggWhite
Added HKCategoryValueCervicalMucusQualitySticky
Added HKCategoryValueCervicalMucusQualityWatery
Added HKCategoryValueMenstrualFlow
Added HKCategoryValueMenstrualFlowHeavy
Added HKCategoryValueMenstrualFlowLight
Added HKCategoryValueMenstrualFlowMedium
Added HKCategoryValueMenstrualFlowUnspecified
Added HKCategoryValueNotApplicable
Added HKCategoryValueOvulationTestResult
Added HKCategoryValueOvulationTestResultIndeterminate
Added HKCategoryValueOvulationTestResultNegative
Added HKCategoryValueOvulationTestResultPositive
Added HKErrorAnotherWorkoutSessionStarted
Added HKErrorUserExitedWorkoutSession
Added HKFitzpatrickSkinType
Added HKFitzpatrickSkinTypeI
Added HKFitzpatrickSkinTypeII
Added HKFitzpatrickSkinTypeIII
Added HKFitzpatrickSkinTypeIV
Added HKFitzpatrickSkinTypeNotSet
Added HKFitzpatrickSkinTypeV
Added HKFitzpatrickSkinTypeVI

HKDeletedObject.h (Added)

Added HKDeletedObject
Added HKDeletedObject.UUID

HKDevice.h (Added)

Added HKDevice
Added HKDevice.firmwareVersion
Added HKDevice.hardwareVersion
Added -[HKDevice initWithName:manufacturer:model:hardwareVersion:firmwareVersion:softwareVersion:localIdentifier:UDIDeviceIdentifier:]
Added +[HKDevice localDevice]
Added HKDevice.localIdentifier
Added HKDevice.manufacturer
Added HKDevice.model
Added HKDevice.name
Added HKDevice.softwareVersion
Added HKDevice.UDIDeviceIdentifier
Added HKDevicePropertyKeyFirmwareVersion
Added HKDevicePropertyKeyHardwareVersion
Added HKDevicePropertyKeyLocalIdentifier
Added HKDevicePropertyKeyManufacturer
Added HKDevicePropertyKeyModel
Added HKDevicePropertyKeyName
Added HKDevicePropertyKeySoftwareVersion
Added HKDevicePropertyKeyUDIDeviceIdentifier

HKHealthStore.h

Added HKFitzpatrickSkinTypeObject
Added HKFitzpatrickSkinTypeObject.skinType
Added -[HKHealthStore deleteObjects:withCompletion:]
Added -[HKHealthStore deleteObjectsOfType:predicate:withCompletion:]
Added -[HKHealthStore earliestPermittedSampleDate]
Added -[HKHealthStore fitzpatrickSkinTypeWithError:]
Added -[HKHealthStore handleAuthorizationForExtensionWithCompletion:]
Added -[HKHealthStore splitTotalEnergy:startDate:endDate:resultsHandler:]
Modified HKBiologicalSexObject
Protocols
From--
ToNSCopying, NSSecureCoding

Modified HKBloodTypeObject
Protocols
From--
ToNSCopying, NSSecureCoding

Modified HKHealthStore
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

Modified -[HKHealthStore addSamples:toWorkout:completion:]
Declaration
From
- (void)addSamples:(NSArray *)samples toWorkout:(HKWorkout *)workout completion:(void (^)(BOOL success, NSError *error))completion
To
- (void)addSamples:(NSArray<HKSample *> * _Nonnull)samples toWorkout:(HKWorkout * _Nonnull)workout completion:(void (^ _Nonnull)(BOOL success, NSError * _Nullable error))completion

Modified -[HKHealthStore authorizationStatusForType:]
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

Modified -[HKHealthStore biologicalSexWithError:]
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

Modified -[HKHealthStore bloodTypeWithError:]
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

Modified -[HKHealthStore dateOfBirthWithError:]
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

Modified -[HKHealthStore deleteObject:withCompletion:]
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

Modified -[HKHealthStore executeQuery:]
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

Modified +[HKHealthStore isHealthDataAvailable]
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

Modified -[HKHealthStore preferredUnitsForQuantityTypes:completion:]
Declaration
From
- (void)preferredUnitsForQuantityTypes:(NSSet *)quantityTypes completion:(void (^)(NSDictionary *preferredUnits, NSError *error))completion
To
- (void)preferredUnitsForQuantityTypes:(NSSet<HKQuantityType *> * _Nonnull)quantityTypes completion:(void (^ _Nonnull)(NSDictionary<HKQuantityType *,HKUnit *> * _Nonnull preferredUnits, NSError * _Nullable error))completion

Modified -[HKHealthStore requestAuthorizationToShareTypes:readTypes:completion:]
DeclarationApp Extension[Available]App Extension[Message]
From
- (void)requestAuthorizationToShareTypes:(NSSet *)typesToShare readTypes:(NSSet *)typesToRead completion:(void (^)(BOOL success, NSError *error))completion
noHealthKit is not supported in extensions
To
- (void)requestAuthorizationToShareTypes:(NSSet<HKSampleType *> * _Nullable)typesToShare readTypes:(NSSet<HKObjectType *> * _Nullable)typesToRead completion:(void (^ _Nonnull)(BOOL success, NSError * _Nullable error))completion
----

Modified -[HKHealthStore saveObject:withCompletion:]
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

Modified -[HKHealthStore saveObjects:withCompletion:]
DeclarationApp Extension[Available]App Extension[Message]
From
- (void)saveObjects:(NSArray *)objects withCompletion:(void (^)(BOOL success, NSError *error))completion
noHealthKit is not supported in extensions
To
- (void)saveObjects:(NSArray<HKObject *> * _Nonnull)objects withCompletion:(void (^ _Nonnull)(BOOL success, NSError * _Nullable error))completion
----

Modified -[HKHealthStore stopQuery:]
App Extension[Available]App Extension[Message]
FromnoHealthKit is not supported in extensions
To----

HKMetadata.h

Added HKMetadataKeyMenstrualCycleStart
Added HKMetadataKeySexualActivityProtectionUsed

HKObject.h

Added HKObject.device
Added HKObject.sourceRevision
Added HKPredicateKeyPathDevice
Added HKPredicateKeyPathSourceRevision
Modified HKObject.metadata
Declaration
From
@property(readonly, copy) NSDictionary *metadata
To
@property(readonly, copy, nullable) NSDictionary<NSString *,id> *metadata

Modified HKObject.source
Deprecation
From--
ToiOS 9.0

HKQuantitySample.h

Added +[HKQuantitySample quantitySampleWithType:quantity:startDate:endDate:device:metadata:]
Modified +[HKQuantitySample quantitySampleWithType:quantity:startDate:endDate:metadata:]
Declaration
From
+ (instancetype)quantitySampleWithType:(HKQuantityType *)quantityType quantity:(HKQuantity *)quantity startDate:(NSDate *)startDate endDate:(NSDate *)endDate metadata:(NSDictionary *)metadata
To
+ (instancetype _Nonnull)quantitySampleWithType:(HKQuantityType * _Nonnull)quantityType quantity:(HKQuantity * _Nonnull)quantity startDate:(NSDate * _Nonnull)startDate endDate:(NSDate * _Nonnull)endDate metadata:(NSDictionary<NSString *,id> * _Nullable)metadata

HKQuery.h

Added +[HKQuery predicateForObjectsFromDevices:]
Added +[HKQuery predicateForObjectsFromSourceRevisions:]
Added +[HKQuery predicateForObjectsWithDeviceProperty:allowedValues:]
Modified +[HKQuery predicateForObjectsFromSources:]
Declaration
From
+ (NSPredicate *)predicateForObjectsFromSources:(NSSet *)sources
To
+ (NSPredicate * _Nonnull)predicateForObjectsFromSources:(NSSet<HKSource *> * _Nonnull)sources

Modified +[HKQuery predicateForObjectsWithUUIDs:]
Declaration
From
+ (NSPredicate *)predicateForObjectsWithUUIDs:(NSSet *)UUIDs
To
+ (NSPredicate * _Nonnull)predicateForObjectsWithUUIDs:(NSSet<NSUUID *> * _Nonnull)UUIDs

HKSampleQuery.h

Modified -[HKSampleQuery initWithSampleType:predicate:limit:sortDescriptors:resultsHandler:]
Declaration
From
- (instancetype)initWithSampleType:(HKSampleType *)sampleType predicate:(NSPredicate *)predicate limit:(NSUInteger)limit sortDescriptors:(NSArray *)sortDescriptors resultsHandler:(void (^)(HKSampleQuery *query, NSArray *results, NSError *error))resultsHandler
To
- (instancetype _Nonnull)initWithSampleType:(HKSampleType * _Nonnull)sampleType predicate:(NSPredicate * _Nullable)predicate limit:(NSUInteger)limit sortDescriptors:(NSArray<NSSortDescriptor *> * _Nullable)sortDescriptors resultsHandler:(void (^ _Nonnull)(HKSampleQuery * _Nonnull query, NSArray<__kindof HKSample *> * _Nullable results, NSError * _Nullable error))resultsHandler

Modified HKSampleQuery.sortDescriptors
Declaration
From
@property(readonly, copy) NSArray *sortDescriptors
To
@property(readonly, copy, nullable) NSArray<NSSortDescriptor *> *sortDescriptors

HKSourceQuery.h

Modified -[HKSourceQuery initWithSampleType:samplePredicate:completionHandler:]
Declaration
From
- (instancetype)initWithSampleType:(HKSampleType *)sampleType samplePredicate:(NSPredicate *)objectPredicate completionHandler:(void (^)(HKSourceQuery *query, NSSet *sources, NSError *error))completionHandler
To
- (instancetype _Nonnull)initWithSampleType:(HKSampleType * _Nonnull)sampleType samplePredicate:(NSPredicate * _Nullable)objectPredicate completionHandler:(void (^ _Nonnull)(HKSourceQuery * _Nonnull query, NSSet<HKSource *> * _Nullable sources, NSError * _Nullable error))completionHandler

HKSourceRevision.h (Added)

Added HKSourceRevision
Added -[HKSourceRevision initWithSource:version:]
Added HKSourceRevision.source
Added HKSourceRevision.version

HKStatistics.h

Modified HKStatistics.sources
Declaration
From
@property(readonly, strong) NSArray *sources
To
@property(readonly, strong, nullable) NSArray<HKSource *> *sources

HKStatisticsCollectionQuery.h

Modified -[HKStatisticsCollection sources]
Declaration
From
- (NSSet *)sources
To
- (NSSet<HKSource *> * _Nonnull)sources

Modified -[HKStatisticsCollection statistics]
Declaration
From
- (NSArray *)statistics
To
- (NSArray<HKStatistics *> * _Nonnull)statistics

HKTypeIdentifiers.h

Added HKCategoryTypeIdentifierAppleStandHour
Added HKCategoryTypeIdentifierCervicalMucusQuality
Added HKCategoryTypeIdentifierIntermenstrualBleeding
Added HKCategoryTypeIdentifierMenstrualFlow
Added HKCategoryTypeIdentifierOvulationTestResult
Added HKCategoryTypeIdentifierSexualActivity
Added HKCharacteristicTypeIdentifierFitzpatrickSkinType
Added HKQuantityTypeIdentifierBasalBodyTemperature
Added HKQuantityTypeIdentifierDietaryWater
Added HKQuantityTypeIdentifierUVExposure

HKUnit.h

Added +[HKUnit cupImperialUnit]
Added +[HKUnit cupUSUnit]
Added +[HKUnit yardUnit]

HKWorkout.h

Added +[HKWorkout workoutWithActivityType:startDate:endDate:duration:totalEnergyBurned:totalDistance:device:metadata:]
Added +[HKWorkout workoutWithActivityType:startDate:endDate:workoutEvents:totalEnergyBurned:totalDistance:device:metadata:]
Modified HKWorkout.workoutEvents
Declaration
From
@property(readonly, copy) NSArray *workoutEvents
To
@property(readonly, copy, nullable) NSArray<HKWorkoutEvent *> *workoutEvents

Modified +[HKWorkout workoutWithActivityType:startDate:endDate:duration:totalEnergyBurned:totalDistance:metadata:]
Declaration
From
+ (instancetype)workoutWithActivityType:(HKWorkoutActivityType)workoutActivityType startDate:(NSDate *)startDate endDate:(NSDate *)endDate duration:(NSTimeInterval)duration totalEnergyBurned:(HKQuantity *)totalEnergyBurned totalDistance:(HKQuantity *)totalDistance metadata:(NSDictionary *)metadata
To
+ (instancetype _Nonnull)workoutWithActivityType:(HKWorkoutActivityType)workoutActivityType startDate:(NSDate * _Nonnull)startDate endDate:(NSDate * _Nonnull)endDate duration:(NSTimeInterval)duration totalEnergyBurned:(HKQuantity * _Nullable)totalEnergyBurned totalDistance:(HKQuantity * _Nullable)totalDistance metadata:(NSDictionary<NSString *,id> * _Nullable)metadata

Modified +[HKWorkout workoutWithActivityType:startDate:endDate:workoutEvents:totalEnergyBurned:totalDistance:metadata:]
Declaration
From
+ (instancetype)workoutWithActivityType:(HKWorkoutActivityType)workoutActivityType startDate:(NSDate *)startDate endDate:(NSDate *)endDate workoutEvents:(NSArray *)workoutEvents totalEnergyBurned:(HKQuantity *)totalEnergyBurned totalDistance:(HKQuantity *)totalDistance metadata:(NSDictionary *)metadata
To
+ (instancetype _Nonnull)workoutWithActivityType:(HKWorkoutActivityType)workoutActivityType startDate:(NSDate * _Nonnull)startDate endDate:(NSDate * _Nonnull)endDate workoutEvents:(NSArray<HKWorkoutEvent *> * _Nullable)workoutEvents totalEnergyBurned:(HKQuantity * _Nullable)totalEnergyBurned totalDistance:(HKQuantity * _Nullable)totalDistance metadata:(NSDictionary<NSString *,id> * _Nullable)metadata

HKWorkoutSession.h (Added)

Added HKWorkoutSessionLocationType
Added HKWorkoutSessionState