Instance Method

delete(_:withCompletion:)

Deletes the specified object from the HealthKit store.

Declaration

func delete(_ object: HKObject, withCompletion completion: @escaping (Bool, Error?) -> Void)

Parameters

object

An object that this app has previously saved to the HealthKit store.

completion

A block that this method calls as soon as the delete operation is complete. This block is passed the following parameters:

success

A Boolean value. This parameter contains true if the object was successfully deleted; otherwise, false.

error

An error object. If an error occurred, this object contains information about the error; otherwise, it is set to nil.

Discussion

Your app can delete only those objects that it has previously saved to the HealthKit store. If the user revokes sharing permission, you can no longer delete the object. This method operates asynchronously. As soon as the delete operation is finished, it calls the completion block on a background queue.

If your app has not requested permission to share the object’s data type, the method fails with an HKError.Code.errorAuthorizationNotDetermined error. If your app has been denied permission to share the object’s data type, it fails with an HKError.Code.errorAuthorizationDenied error.

HealthKit stores a temporary HKDeletedObject entry, letting you query for recently deleted objects. However, the deleted objects are periodically removed to save storage space. If you want your app to receive notifications about all the deleted objects, set up an observer query, and enable it for background delivery. In the background query’s update handler, create an HKAnchoredObjectQuery object to gather the list of recently deleted objects.

See Also

Working with HealthKit Objects

func delete([HKObject], withCompletion: (Bool, Error?) -> Void)

Deletes the specified objects from the HealthKit store.

func deleteObjects(of: HKObjectType, predicate: NSPredicate, withCompletion: (Bool, Int, Error?) -> Void)

Deletes objects saved by this application that match the provided type and predicate.

func earliestPermittedSampleDate() -> Date

Returns the earliest date permitted for samples.

func save(HKObject, withCompletion: (Bool, Error?) -> Void)

Saves the provided object to the HealthKit store.

func save([HKObject], withCompletion: (Bool, Error?) -> Void)

Saves an array of objects to the HealthKit store.