objc2_health_kit/generated/HKMetadata.rs
1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ptr::NonNull;
4use objc2_foundation::*;
5
6use crate::*;
7
8extern "C" {
9 /// Represents the serial number of the device that created the HKObject.
10 ///
11 /// The expected value type is NSString.
12 ///
13 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeydeviceserialnumber?language=objc)
14 pub static HKMetadataKeyDeviceSerialNumber: &'static NSString;
15}
16
17extern "C" {
18 /// Represents the location where a particular body temperature reading was taken.
19 ///
20 /// The expected value type is an NSNumber containing a HKBodyTemperatureSensorLocation value.
21 ///
22 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeybodytemperaturesensorlocation?language=objc)
23 pub static HKMetadataKeyBodyTemperatureSensorLocation: &'static NSString;
24}
25
26extern "C" {
27 /// Represents the location where a particular heart rate reading was taken.
28 ///
29 /// The expected value type is an NSNumber containing a HKHeartRateSensorLocation value.
30 ///
31 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyheartratesensorlocation?language=objc)
32 pub static HKMetadataKeyHeartRateSensorLocation: &'static NSString;
33}
34
35extern "C" {
36 /// Represents the context in which a particular heart rate reading was taken.
37 ///
38 /// The expected value type is an NSNumber containing a HKHeartRateMotionContext value. The value is active
39 /// (HKHeartRateMotionContextActive) if the user is in motion or working out, sedentary if the user is
40 /// still (HKHeartRateMotionContextSedentary), or not set (HKHeartRateMotionContextNotSet) otherwise.
41 ///
42 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyheartratemotioncontext?language=objc)
43 pub static HKMetadataKeyHeartRateMotionContext: &'static NSString;
44}
45
46extern "C" {
47 /// Represents the user's motion when a particular sample was taken.
48 ///
49 /// The expected value type is an NSNumber containing a HKUserMotionContext value. The value is active
50 /// (HKUserMotionContextActive) if the user is in motion or working out, stationary if the user is
51 /// still (HKUserMotionContextStationary), or not set (HKUserMotionContextNotSet) otherwise.
52 ///
53 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyusermotioncontext?language=objc)
54 pub static HKMetadataKeyUserMotionContext: &'static NSString;
55}
56
57extern "C" {
58 /// Represents a per-session estimate prior to longitudinal smoothing applied to the value stored in the associated HKQuantitySample.
59 ///
60 /// The expected value type is an HKQuantity object with a unit compatible with the associated HKQuantitySample.
61 ///
62 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeysessionestimate?language=objc)
63 pub static HKMetadataKeySessionEstimate: &'static NSString;
64}
65
66extern "C" {
67 /// Represents the test used to determine a Heart Rate Recovery value
68 ///
69 /// The expected value type is an NSNumber containing a HKHeartRateRecoveryTestType value.
70 ///
71 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyheartraterecoverytesttype?language=objc)
72 pub static HKMetadataKeyHeartRateRecoveryTestType: &'static NSString;
73}
74
75extern "C" {
76 /// Represents the activity which preceded a Heart Rate Recovery value
77 ///
78 /// The expected value type is an NSNumber containing a HKWorkoutActivityType value.
79 ///
80 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyheartraterecoveryactivitytype?language=objc)
81 pub static HKMetadataKeyHeartRateRecoveryActivityType: &'static NSString;
82}
83
84extern "C" {
85 /// Represents the duration of activity which preceded a Heart Rate Recovery value
86 ///
87 /// The expected value type is an HKQuantity object compatible with a time unit.
88 ///
89 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyheartraterecoveryactivityduration?language=objc)
90 pub static HKMetadataKeyHeartRateRecoveryActivityDuration: &'static NSString;
91}
92
93extern "C" {
94 /// Represents the maximum heart rate observed during the corresponding Heart Rate Recovery sample interval
95 ///
96 /// The expected value type is an HKQuantity object compatible with "count/min" unit (eg "BPM").
97 ///
98 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyheartraterecoverymaxobservedrecoveryheartrate?language=objc)
99 pub static HKMetadataKeyHeartRateRecoveryMaxObservedRecoveryHeartRate: &'static NSString;
100}
101
102extern "C" {
103 /// Represents the type of food that was consumed when creating an HKObject.
104 ///
105 /// This should be a short string representing the type of food, such as 'Banana'. The expected value type
106 /// is NSString.
107 ///
108 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyfoodtype?language=objc)
109 pub static HKMetadataKeyFoodType: &'static NSString;
110}
111
112extern "C" {
113 /// Represents the device identifier portion of a device's UDI (Unique Device Identifier).
114 ///
115 /// The device identifier can be used to reference the GUDID (Globally Unique Device Identifier Database).
116 /// The expected value type is NSString.
117 ///
118 /// * Note that the use of this key is now discouraged in favor of the HKDevice class.
119 ///
120 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyudideviceidentifier?language=objc)
121 pub static HKMetadataKeyUDIDeviceIdentifier: &'static NSString;
122}
123
124extern "C" {
125 /// Represents the production identifier portion of a device's UDI (Unique Device Identifier).
126 ///
127 /// While part of a device's UDI, the production identifier is not saved in the FDA's GUDID
128 /// (Globally Unique Device Identifier Database) and its use in HealthKit is now discouraged for
129 /// user privacy reasons. Apps should consider handling this independently of HealthKit APIs if
130 /// needed.
131 /// The expected value type is NSString.
132 ///
133 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyudiproductionidentifier?language=objc)
134 pub static HKMetadataKeyUDIProductionIdentifier: &'static NSString;
135}
136
137extern "C" {
138 /// Represents a digital signature validating the origin of an HKObject's value.
139 ///
140 /// Intended to provide data integrity for sample data produced by trusted (tamper resistant) measuring devices.
141 /// The digital signature format should be CMS (Cryptographic Message Syntax specified in IETF RFC 5652).
142 /// It should be a “Signed-data” type signature containing the data items to be signed (e.g., timestamp, value, etc.)
143 /// using ASN.1 encoding with DER (Distinguished Encoding Rules). The entire enveloping signature should be further
144 /// encoded using base64. Recommended digest is SHA256, and recommended cipher is FIPS PUB 186-4 Digital Signature
145 /// Standard Elliptic Curve P-256. See documentation for details.
146 ///
147 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeydigitalsignature?language=objc)
148 pub static HKMetadataKeyDigitalSignature: &'static NSString;
149}
150
151extern "C" {
152 /// Represents a unique identifier for an HKObject that is set by its source.
153 /// Uniqueness of objects with the same value of this key is not enforced by HealthKit.
154 ///
155 /// The expected value type is NSString.
156 ///
157 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyexternaluuid?language=objc)
158 pub static HKMetadataKeyExternalUUID: &'static NSString;
159}
160
161extern "C" {
162 /// Represents an identifier for an HKObject that is set by its source and is used by HealthKit to uniquely
163 /// identify an object.
164 ///
165 /// Saving a HKObject with a HKMetadataKeySyncIdentifier will replace an existing HKObject with the
166 /// same HKMetadataKeySyncIdentifier value if the new HKObject has a greater HKMetadataKeySyncVersion.
167 /// The new sample will be added to all HKWorkouts or HKCorrelations containing the replaced sample.
168 /// HKMetadataKeySyncVersion must be provided if HKMetadataKeySyncIdentifier is provided.
169 /// The expected value type is NSString.
170 ///
171 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeysyncidentifier?language=objc)
172 pub static HKMetadataKeySyncIdentifier: &'static NSString;
173}
174
175extern "C" {
176 /// Represents the version of the HKObject that is set by its source and is used by HealthKit to identify an
177 /// object's version.
178 ///
179 /// HKMetadataKeySyncVersion may not be provided if HKMetadataKeySyncIdentifier is not provided.
180 /// The expected value type is NSNumber.
181 ///
182 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeysyncversion?language=objc)
183 pub static HKMetadataKeySyncVersion: &'static NSString;
184}
185
186extern "C" {
187 /// Represents the time zone that the user was in when the HKObject was created.
188 ///
189 /// The expected value type is an NSString compatible with NSTimeZone's +timeZoneWithName:.
190 ///
191 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeytimezone?language=objc)
192 pub static HKMetadataKeyTimeZone: &'static NSString;
193}
194
195extern "C" {
196 /// Represents the name of the device that took the reading.
197 ///
198 /// The expected value type is NSString.
199 ///
200 /// * Note that the use of this key is now discouraged in favor of the HKDevice class.
201 ///
202 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeydevicename?language=objc)
203 pub static HKMetadataKeyDeviceName: &'static NSString;
204}
205
206extern "C" {
207 /// Represents the name of the manufacturer of the device that took the reading.
208 ///
209 /// The expected value type is NSString.
210 ///
211 /// * Note that the use of this key is now discouraged in favor of the HKDevice class.
212 ///
213 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeydevicemanufacturername?language=objc)
214 pub static HKMetadataKeyDeviceManufacturerName: &'static NSString;
215}
216
217extern "C" {
218 /// Represents whether or not the reading was taken in a lab.
219 ///
220 /// The expected value type is an NSNumber containing a BOOL value.
221 ///
222 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeywastakeninlab?language=objc)
223 pub static HKMetadataKeyWasTakenInLab: &'static NSString;
224}
225
226extern "C" {
227 /// Represents the lower limit of the reference range for a lab result.
228 ///
229 /// The expected value type is an NSNumber.
230 ///
231 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyreferencerangelowerlimit?language=objc)
232 pub static HKMetadataKeyReferenceRangeLowerLimit: &'static NSString;
233}
234
235extern "C" {
236 /// Represents the upper limit of the reference range for a lab result.
237 ///
238 /// The expected value type is an NSNumber.
239 ///
240 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyreferencerangeupperlimit?language=objc)
241 pub static HKMetadataKeyReferenceRangeUpperLimit: &'static NSString;
242}
243
244extern "C" {
245 /// Represents whether or not the reading was entered by the user.
246 ///
247 /// The expected value type is an NSNumber containing a BOOL value.
248 ///
249 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeywasuserentered?language=objc)
250 pub static HKMetadataKeyWasUserEntered: &'static NSString;
251}
252
253extern "C" {
254 /// Represents the brand name of a particular workout.
255 ///
256 /// The expected value type is NSString.
257 ///
258 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyworkoutbrandname?language=objc)
259 pub static HKMetadataKeyWorkoutBrandName: &'static NSString;
260}
261
262extern "C" {
263 /// Represents whether or not a workout was performed as part of a group fitness class.
264 ///
265 /// The expected value type is an NSNumber containing a BOOL value.
266 ///
267 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeygroupfitness?language=objc)
268 pub static HKMetadataKeyGroupFitness: &'static NSString;
269}
270
271extern "C" {
272 /// Contains the catalog identifier of the Fitness+ workout.
273 ///
274 /// This key only exists if the workout was completed in Fitness+. The expected value type is an NSString containing the Fitness+ catalog identifier.
275 ///
276 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyapplefitnesspluscatalogidentifier?language=objc)
277 pub static HKMetadataKeyAppleFitnessPlusCatalogIdentifier: &'static NSString;
278}
279
280extern "C" {
281 /// Represents whether or not a workout is a Fitness+ workout.
282 ///
283 /// The expected value type is an NSNumber containing a BOOL value.
284 ///
285 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyapplefitnessplussession?language=objc)
286 pub static HKMetadataKeyAppleFitnessPlusSession: &'static NSString;
287}
288
289extern "C" {
290 /// Represents whether or not a workout was performed indoors as opposed to outdoors.
291 ///
292 /// The expected value type is an NSNumber containing a BOOL value.
293 ///
294 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyindoorworkout?language=objc)
295 pub static HKMetadataKeyIndoorWorkout: &'static NSString;
296}
297
298extern "C" {
299 /// Represents whether or not a workout was performed with a coach or personal trainer.
300 ///
301 /// The expected value type is an NSNumber containing a BOOL value.
302 ///
303 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeycoachedworkout?language=objc)
304 pub static HKMetadataKeyCoachedWorkout: &'static NSString;
305}
306
307extern "C" {
308 /// Represents the weather condition during the sample.
309 ///
310 /// The expected value type is an NSNumber containing an HKWeatherCondition value. This key may be set on an
311 /// HKWorkout object to represent the overall weather condition during the workout.
312 ///
313 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyweathercondition?language=objc)
314 pub static HKMetadataKeyWeatherCondition: &'static NSString;
315}
316
317extern "C" {
318 /// Represents the weather temperature during the sample.
319 ///
320 /// The expected value type is an HKQuantity expressed in a temperature unit. This key may be set on an
321 /// HKWorkout object to represent the overall temperature during the workout.
322 ///
323 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyweathertemperature?language=objc)
324 pub static HKMetadataKeyWeatherTemperature: &'static NSString;
325}
326
327extern "C" {
328 /// Represents the weather humidity during the sample.
329 ///
330 /// The expected value type is an HKQuantity expressed in percent. This key may be set on an HKWorkout
331 /// object to represent the overall humidity during the workout.
332 ///
333 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyweatherhumidity?language=objc)
334 pub static HKMetadataKeyWeatherHumidity: &'static NSString;
335}
336
337extern "C" {
338 /// Represents whether or not protection was used during sexual activity. This can be used to track either
339 /// protection from STIs or protection from pregnancy.
340 ///
341 /// The expected value type is an NSNumber containing a BOOL value.
342 ///
343 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeysexualactivityprotectionused?language=objc)
344 pub static HKMetadataKeySexualActivityProtectionUsed: &'static NSString;
345}
346
347extern "C" {
348 /// Indicates whether or not the sample represents the start of a menstrual cycle. This is a required
349 /// metadata key for category samples of type HKCategoryTypeIdentifierMenstrualFlow.
350 ///
351 /// The expected value type is an NSNumber containing a BOOL value.
352 ///
353 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeymenstrualcyclestart?language=objc)
354 pub static HKMetadataKeyMenstrualCycleStart: &'static NSString;
355}
356
357extern "C" {
358 /// Represents the length of a lap recorded during a workout.
359 ///
360 /// The expected value type is an HKQuantity object compatible with a length unit. This key may be set on an
361 /// HKWorkout object to represent the length of a lap.
362 ///
363 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeylaplength?language=objc)
364 pub static HKMetadataKeyLapLength: &'static NSString;
365}
366
367extern "C" {
368 /// Represents the location type of a swimming workout.
369 ///
370 /// The expected value type is an NSNumber containing an HKWorkoutSwimmingLocationType value. This key may
371 /// be set on an HKWorkout object to represent the swimming location type.
372 ///
373 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyswimminglocationtype?language=objc)
374 pub static HKMetadataKeySwimmingLocationType: &'static NSString;
375}
376
377extern "C" {
378 /// Represents the predominant stroke style during a lap of a swimming workout.
379 ///
380 /// The expected value type is an NSNumber containing an HKSwimmingStrokeStyle value. This key may be set on
381 /// an HKWorkoutEvent object with the type HKWorkoutEventTypeLap to represent the predominant style used
382 /// during the lap.
383 ///
384 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyswimmingstrokestyle?language=objc)
385 pub static HKMetadataKeySwimmingStrokeStyle: &'static NSString;
386}
387
388extern "C" {
389 /// Represents the medical reason for the delivery of an insulin dose. This is a required metadata key for
390 /// samples of type HKQuantityTypeIdentifierInsulinDelivery.
391 ///
392 /// The expected value type is an NSNumber containing a HKInsulinDeliveryReason value.
393 ///
394 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyinsulindeliveryreason?language=objc)
395 pub static HKMetadataKeyInsulinDeliveryReason: &'static NSString;
396}
397
398extern "C" {
399 /// Indicates the relative timing of a blood glucose reading to a meal.
400 ///
401 /// This timing, as well as other factors like meal composition, can be used by medical professionals to
402 /// determine the acceptable value range for a blood glucose reading. For use cases requiring the capture of
403 /// precise timing and composition information, developers should record additional dietary samples, such as
404 /// HKQuantityTypeIdentifierDietaryCarbohydrates. The expected value type is an NSNumber containing a
405 /// HKBloodGlucoseMealTime value.
406 ///
407 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeybloodglucosemealtime?language=objc)
408 pub static HKMetadataKeyBloodGlucoseMealTime: &'static NSString;
409}
410
411extern "C" {
412 /// Represents the test used to create VO2 Max Sample
413 ///
414 /// The expected value type is an NSNumber containing a HKVO2MaxTestType value.
415 ///
416 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyvo2maxtesttype?language=objc)
417 pub static HKMetadataKeyVO2MaxTestType: &'static NSString;
418}
419
420extern "C" {
421 /// Represents the average speed for a workout segment or distance sample.
422 ///
423 /// This represents the average speed when moving so it may not match the value of distance/time for a
424 /// distance sample.
425 ///
426 /// The expected value type is an HKQuantity object compatible with a speed unit (e.g. m/s). This key may be
427 /// set on quantity samples of type HKQuantityTypeIdentifierDistanceDownhillSnowSports or a workout segment
428 /// representing a skiing run.
429 ///
430 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyaveragespeed?language=objc)
431 pub static HKMetadataKeyAverageSpeed: &'static NSString;
432}
433
434extern "C" {
435 /// Represents the maximum speed for a workout segment or distance sample.
436 ///
437 /// The expected value type is an HKQuantity object compatible with a speed unit (e.g. m/s). This key may be
438 /// set on quantity samples of type HKQuantityTypeIdentifierDistanceDownhillSnowSports or a workout segment
439 /// representing a skiing run.
440 ///
441 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeymaximumspeed?language=objc)
442 pub static HKMetadataKeyMaximumSpeed: &'static NSString;
443}
444
445extern "C" {
446 /// Represents the grade of a ski run.
447 ///
448 /// Alpine slope grade is measured in percent where 100% grade is a 45 degree slope.
449 ///
450 /// The expected value type is an HKQuantity object compatible with percent unit. This key may be set on
451 /// quantity samples of type HKQuantityTypeIdentifierDistanceDownhillSnowSports or a workout segment
452 /// representing a skiing run.
453 ///
454 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyalpineslopegrade?language=objc)
455 pub static HKMetadataKeyAlpineSlopeGrade: &'static NSString;
456}
457
458extern "C" {
459 /// Represents the cumulative elevation ascent during a workout.
460 ///
461 /// The expected value type is an HKQuantity object compatible with length unit. This key may be set on a
462 /// workout, workout segments or distance samples.
463 ///
464 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyelevationascended?language=objc)
465 pub static HKMetadataKeyElevationAscended: &'static NSString;
466}
467
468extern "C" {
469 /// Represents the cumulative elevation descent during a workout.
470 ///
471 /// The expected value type is an HKQuantity object compatible with length unit. This key may be set on a
472 /// workout, workout segments or distance samples.
473 ///
474 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyelevationdescended?language=objc)
475 pub static HKMetadataKeyElevationDescended: &'static NSString;
476}
477
478extern "C" {
479 /// Represents the workout duration as displayed by a GymKit connected fitness machine.
480 ///
481 /// The expected value type is an HKQuantity object compatible with a time unit. This key may be set on an
482 /// HKWorkout object to represent the duration of the workout as displayed by a GymKit connected fitness
483 /// machine.
484 ///
485 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyfitnessmachineduration?language=objc)
486 pub static HKMetadataKeyFitnessMachineDuration: &'static NSString;
487}
488
489extern "C" {
490 /// Represents the distance covered during an indoor bike workout.
491 ///
492 /// The expected value type is an HKQuantity object compatible with a length unit. This key may be set on an
493 /// HKWorkout object to represent the distance covered during an indoor bike workout.
494 ///
495 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyindoorbikedistance?language=objc)
496 pub static HKMetadataKeyIndoorBikeDistance: &'static NSString;
497}
498
499extern "C" {
500 /// Represents the distance covered during a cross trainer workout.
501 ///
502 /// The expected value type is an HKQuantity object compatible with a length unit. This key may be set on an
503 /// HKWorkout object to represent the distance covered during a cross trainer workout.
504 ///
505 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeycrosstrainerdistance?language=objc)
506 pub static HKMetadataKeyCrossTrainerDistance: &'static NSString;
507}
508
509extern "C" {
510 /// Represents the threshold heart rate that triggered a heart rate event.
511 ///
512 /// The expected value is an HKQuantity object with a compatible unit (e.g. count/min).
513 /// This key will be set on heart rate event samples of type HKCategoryTypeIdentifierHighHeartRateEvent and
514 /// HKCategoryTypeIdentifierLowHeartRateEvent.
515 ///
516 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyheartrateeventthreshold?language=objc)
517 pub static HKMetadataKeyHeartRateEventThreshold: &'static NSString;
518}
519
520extern "C" {
521 /// Represents the average METs, or Metabolic Equivalent of Task during a workout.
522 ///
523 /// The expected value type is an HKQuantity expressed in a METs (kcal/(kg*hr)) unit. This key may be set on an
524 /// HKWorkout object to represent the average workout intensity represented as METs over the entire workout duration.
525 ///
526 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyaveragemets?language=objc)
527 pub static HKMetadataKeyAverageMETs: &'static NSString;
528}
529
530extern "C" {
531 /// Represents the audio level associated with an audio event.
532 ///
533 /// The expected value is an HKQuantity whose value is the audio level
534 /// associated with the event measured in dBASPL units.
535 ///
536 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyaudioexposurelevel?language=objc)
537 pub static HKMetadataKeyAudioExposureLevel: &'static NSString;
538}
539
540extern "C" {
541 /// Represents the duration of time that is covered by audio samples.
542 ///
543 /// The expected value type is an HKQuantity object compatible with a time unit.
544 /// This key may be set on headphone audio exposure event samples to indicate
545 /// the duration of time that the user was actually exposed to audio through their headphones.
546 ///
547 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyaudioexposureduration?language=objc)
548 pub static HKMetadataKeyAudioExposureDuration: &'static NSString;
549}
550
551extern "C" {
552 /// Represents the ECG algorithm version that was used to generate a particular HKElectrocardiogram.
553 ///
554 /// The expected value type is an an NSNumber containing a HKAppleECGAlgorithmVersion value.
555 ///
556 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyappleecgalgorithmversion?language=objc)
557 pub static HKMetadataKeyAppleECGAlgorithmVersion: &'static NSString;
558}
559
560extern "C" {
561 /// Represents the detected placement of the device during the bout of walking
562 ///
563 /// The expected value type is an NSNumber containing a HKDevicePlacementSide value. This key is expected to
564 /// be written for Walking Aymmetry Percentage.
565 ///
566 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeydeviceplacementside?language=objc)
567 pub static HKMetadataKeyDevicePlacementSide: &'static NSString;
568}
569
570extern "C" {
571 /// Represents the barometric pressure recorded at the time of a sample.
572 ///
573 /// The expected value type is an HKQuantity representing a value in units of pressure (atmospheres, pascals, millimeters of Mercury).
574 ///
575 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeybarometricpressure?language=objc)
576 pub static HKMetadataKeyBarometricPressure: &'static NSString;
577}
578
579extern "C" {
580 /// Represents the calibration status of the devices used to generate this sample.
581 ///
582 /// The expected value is a boolean NSNumber indicating whether the sample value was estimated using a sufficient set of device calibration data. The calibration status of a device may vary per data type. This key is read-only.
583 ///
584 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyappledevicecalibrated?language=objc)
585 pub static HKMetadataKeyAppleDeviceCalibrated: &'static NSString;
586}
587
588extern "C" {
589 /// Represents a VO2Max value that can be associated with, for example, Cardio Fitness Events
590 ///
591 /// This key should be used to store an HKQuantity with a unit of `ml/kg·min`
592 ///
593 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyvo2maxvalue?language=objc)
594 pub static HKMetadataKeyVO2MaxValue: &'static NSString;
595}
596
597extern "C" {
598 /// Can be used to store a snapshot of the threshold used to classify VO2Max values as "low"
599 ///
600 /// This key should be used to store an HKQuantity, with a unit of `ml/kg·min`, representing the low fitness threshold.
601 ///
602 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeylowcardiofitnesseventthreshold?language=objc)
603 pub static HKMetadataKeyLowCardioFitnessEventThreshold: &'static NSString;
604}
605
606extern "C" {
607 /// Represents how far back an estimation algorithm incorporated data from.
608 ///
609 /// The expected value is an NSDate indicating the earliest date of data used to produce an estimated value for an HKSample.
610 ///
611 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeydateofearliestdatausedforestimate?language=objc)
612 pub static HKMetadataKeyDateOfEarliestDataUsedForEstimate: &'static NSString;
613}
614
615extern "C" {
616 /// The version of the algorithm used to generate the sample.
617 ///
618 /// The key for an NSNumber containing an NSInteger indicating the version of the algorithm used to generate the sample.
619 ///
620 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyalgorithmversion?language=objc)
621 pub static HKMetadataKeyAlgorithmVersion: &'static NSString;
622}
623
624extern "C" {
625 /// Represents sum of strokes per length and time for the length. Calculated for each lap event and segment event during swimming workout.
626 ///
627 /// The expected value type is an NSNumber containing a score. This key may be set on an HKWorkout object to represent the SWOLF Score during the whole workout.
628 ///
629 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyswolfscore?language=objc)
630 pub static HKMetadataKeySWOLFScore: &'static NSString;
631}
632
633extern "C" {
634 /// Indicates the quantity was clamped to a lower bound.
635 ///
636 /// Value is a BOOL indicating whether or not the quantity value in the sample has been clamped to some lower bound
637 ///
638 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyquantityclampedtolowerbound?language=objc)
639 pub static HKMetadataKeyQuantityClampedToLowerBound: &'static NSString;
640}
641
642extern "C" {
643 /// Indicates the quantity was clamped to an upper bound.
644 ///
645 /// Value is a BOOL indicating whether or not the quantity value in the sample has been clamped to some upper bound
646 ///
647 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyquantityclampedtoupperbound?language=objc)
648 pub static HKMetadataKeyQuantityClampedToUpperBound: &'static NSString;
649}
650
651extern "C" {
652 /// Represents the description that may be associated with a HKGlassesPrescription.
653 ///
654 /// Glasses are often customized for different purposes like reading or distance. Prescriptions received by an eye care professional can provide different ocular functions.
655 /// Users may also customize their glasses for different scenarios. The value of the metadata is a NSString that describes the purpose of a HKGlassesPrescription.
656 ///
657 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyglassesprescriptiondescription?language=objc)
658 pub static HKMetadataKeyGlassesPrescriptionDescription: &'static NSString;
659}
660
661extern "C" {
662 /// Represents the water salinity for an underwater depth or water temperature sample.
663 ///
664 /// The expected value type is an NSNumber containing a HKWaterSalinity value.
665 ///
666 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeywatersalinity?language=objc)
667 pub static HKMetadataKeyWaterSalinity: &'static NSString;
668}
669
670extern "C" {
671 /// Represents the headphone gain associated with a Headphone audio exposure event.
672 ///
673 /// The expected value is an HKQuantity whose value is the gain
674 /// associated with the event measured in decibels in A-weighted Sound Pressure Level units.
675 ///
676 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyheadphonegain?language=objc)
677 pub static HKMetadataKeyHeadphoneGain: &'static NSString;
678}
679
680extern "C" {
681 /// Represents the test used to determine a Cycling Functional Threshold Power value.
682 ///
683 /// The expected value type is an NSNumber containing a HKCyclingFunctionalThresholdPowerTestType value.
684 ///
685 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeycyclingfunctionalthresholdpowertesttype?language=objc)
686 pub static HKMetadataKeyCyclingFunctionalThresholdPowerTestType: &'static NSString;
687}
688
689extern "C" {
690 /// Represents the activity type related to the sample
691 ///
692 /// The expected value type is an NSNumber containing a HKWorkoutActivityType value.
693 ///
694 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyactivitytype?language=objc)
695 pub static HKMetadataKeyActivityType: &'static NSString;
696}
697
698extern "C" {
699 /// Represents the estimation type used to create the Physical Effort Sample
700 ///
701 /// The expected value type is an NSNumber containing a HKPhysicalEffortEstimationType value.
702 ///
703 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeyphysicaleffortestimationtype?language=objc)
704 pub static HKMetadataKeyPhysicalEffortEstimationType: &'static NSString;
705}
706
707extern "C" {
708 /// Represents maximum intensity of light for an outdoor time sample.
709 ///
710 /// The expected value type is an HKQuantity expressed in HKUnit Lux.
711 ///
712 /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkmetadatakeymaximumlightintensity?language=objc)
713 pub static HKMetadataKeyMaximumLightIntensity: &'static NSString;
714}