Returns a sample containing a numeric measurement with the provided metadata.
- iOS 8.0+
- Mac Catalyst 13.0+
- watchOS 2.0+
The type of sample to be created. HealthKit defines a number of different quantity types, representing different types of health and fitness data. For the complete list of quantity type identifiers, see
The value to be stored in the sample. The quantity object must use units that are compatible with the provided quantity type. If the units are not compatible, this method throws an exception (
The start date for the sample. This date must be equal to or earlier than the end date; otherwise, this method throws an exception (
The end date for the sample. This date must be equal to or later than the start date; otherwise, this method throws an exception (
The metadata dictionary contains extra information describing this sample. The dictionary’s keys are all
NSStringobjects. The values may be
NSDateobjects. For a complete list of predefined metadata keys, see Metadata Keys.
Using predefined keys helps facilitate sharing data between apps; however, you are also encouraged to create your own, custom keys as needed to extend the HealthKit quantity sample’s capabilities.
A valid quantity sample with metadata.
HealthKit uses quantity samples to represent sample data using a single numeric value. To create a quantity sample, first create the corresponding quantity type and quantity, and then set its start date, end date, and metadata. You produce a new quantity sample with the provided metadata.