addAttachment(to:name:contentType:url:metadata:completion:)
Adds an attachment to the specified object.
Declaration
@preconcurrency func addAttachment(to object: HKObject, name: String, contentType: UTType, url: URL, metadata: [String : Any] = [:], completion: @escaping @Sendable (HKAttachment?, (any Error)?) -> Void)Parameters
- object:
An object stored in the HealthKit store.
- name:
The filename for the attachment.
- contentType:
The type of data stored in the attachment.
- url:
The url for the attachment. This must be a local file url.
- metadata:
Additional data associated with the attachment.
- completion:
A completion handler that the system calls after adding the attachment. This handler takes the following parameters:
- attachment
An object that represents the attachment. If an error occurred, the system sets this parameter to
nil.- error
If an error occurred, this parameter contains information about the error. Otherwise, it’s
nil.
Discussion
Use this method to add an attachment to an object in the HealthKit store. You can add more than one attachment to the specified object.
To add an attachment, start by creating an attachment store.
// Get the attachment store.
let attachmentStore = HKAttachmentStore(healthStore: store)Next, add the attachment to an object that you’ve already saved to the HealthKit store.
// Get the attachment store.
let attachmentStore = HKAttachmentStore(healthStore: store)
// Attach the image to the sample.
attachmentStore.addAttachment(to: prescription,
name: "Glasses Prescription",
contentType: type,
url: url) { attachment, error in
if let error {
// Handle the error here.
fatalError("*** An error occurred while adding the attachment: \(error.localizedDescription) ***")
}
}You can only add attachments to HKVisionPrescription, HKGlassesPrescription, and HKContactsPrescription samples. The attachment must be a static image or PDF (no videos or GIFs). HealthKit supports attaching Live Photos, however it automatically selects and attaches the key photo.