objc2-health-kit 0.3.2

Bindings to the HealthKit framework
Documentation
//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use objc2_foundation::*;

use crate::*;

extern_class!(
    /// An abstract HKSample subclass representing a quantity measurement.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkquantitysample?language=objc)
    #[unsafe(super(HKSample, HKObject, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(all(feature = "HKObject", feature = "HKSample"))]
    pub struct HKQuantitySample;
);

#[cfg(all(feature = "HKObject", feature = "HKSample"))]
unsafe impl Send for HKQuantitySample {}

#[cfg(all(feature = "HKObject", feature = "HKSample"))]
unsafe impl Sync for HKQuantitySample {}

#[cfg(all(feature = "HKObject", feature = "HKSample"))]
extern_conformance!(
    unsafe impl NSCoding for HKQuantitySample {}
);

#[cfg(all(feature = "HKObject", feature = "HKSample"))]
extern_conformance!(
    unsafe impl NSObjectProtocol for HKQuantitySample {}
);

#[cfg(all(feature = "HKObject", feature = "HKSample"))]
extern_conformance!(
    unsafe impl NSSecureCoding for HKQuantitySample {}
);

#[cfg(all(feature = "HKObject", feature = "HKSample"))]
impl HKQuantitySample {
    extern_methods!(
        #[cfg(feature = "HKObjectType")]
        #[unsafe(method(quantityType))]
        #[unsafe(method_family = none)]
        pub unsafe fn quantityType(&self) -> Retained<HKQuantityType>;

        #[cfg(feature = "HKQuantity")]
        #[unsafe(method(quantity))]
        #[unsafe(method_family = none)]
        pub unsafe fn quantity(&self) -> Retained<HKQuantity>;

        /// The number of individual values making up the receiver's quantity.
        ///
        /// Requests for the individual series quantities can be made using HKQuantitySeriesSampleQuery.
        #[unsafe(method(count))]
        #[unsafe(method_family = none)]
        pub unsafe fn count(&self) -> NSInteger;

        #[cfg(all(feature = "HKObjectType", feature = "HKQuantity"))]
        /// Creates a new HKQuantitySample with the given type, quantity, start date, and end date.
        ///
        /// The quantity must have a unit that is compatible with the given quantity type.
        /// See -[HKQuantityType isCompatibleWithUnit:].
        #[unsafe(method(quantitySampleWithType:quantity:startDate:endDate:))]
        #[unsafe(method_family = none)]
        pub unsafe fn quantitySampleWithType_quantity_startDate_endDate(
            quantity_type: &HKQuantityType,
            quantity: &HKQuantity,
            start_date: &NSDate,
            end_date: &NSDate,
        ) -> Retained<Self>;

        #[cfg(all(feature = "HKObjectType", feature = "HKQuantity"))]
        /// Creates a new HKQuantitySample with the given type, quantity, start date, end date, and metadata.
        ///
        /// The quantity must have a unit that is compatible with the given quantity type.
        /// See -[HKQuantityType isCompatibleWithUnit:].
        ///
        /// # Safety
        ///
        /// `metadata` generic should be of the correct type.
        #[unsafe(method(quantitySampleWithType:quantity:startDate:endDate:metadata:))]
        #[unsafe(method_family = none)]
        pub unsafe fn quantitySampleWithType_quantity_startDate_endDate_metadata(
            quantity_type: &HKQuantityType,
            quantity: &HKQuantity,
            start_date: &NSDate,
            end_date: &NSDate,
            metadata: Option<&NSDictionary<NSString, AnyObject>>,
        ) -> Retained<Self>;

        #[cfg(all(feature = "HKDevice", feature = "HKObjectType", feature = "HKQuantity"))]
        /// Creates a new HKQuantitySample with the given type, quantity, start date, end date, and metadata.
        ///
        /// Parameter `quantityType`: The type of the sample.
        ///
        /// Parameter `startDate`: The start date of the sample.
        ///
        /// Parameter `endDate`: The end date of the sample.
        ///
        /// Parameter `device`: The HKDevice that generated the sample (optional).
        ///
        /// Parameter `metadata`: Metadata for the sample (optional).
        ///
        /// The quantity must have a unit that is compatible with the given quantity type.
        /// See -[HKQuantityType isCompatibleWithUnit:].
        ///
        /// # Safety
        ///
        /// `metadata` generic should be of the correct type.
        #[unsafe(method(quantitySampleWithType:quantity:startDate:endDate:device:metadata:))]
        #[unsafe(method_family = none)]
        pub unsafe fn quantitySampleWithType_quantity_startDate_endDate_device_metadata(
            quantity_type: &HKQuantityType,
            quantity: &HKQuantity,
            start_date: &NSDate,
            end_date: &NSDate,
            device: Option<&HKDevice>,
            metadata: Option<&NSDictionary<NSString, AnyObject>>,
        ) -> Retained<Self>;
    );
}

/// Methods declared on superclass `HKObject`.
#[cfg(all(feature = "HKObject", feature = "HKSample"))]
impl HKQuantitySample {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "HKObject", feature = "HKSample"))]
impl HKQuantitySample {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkpredicatekeypathquantity?language=objc)
    pub static HKPredicateKeyPathQuantity: &'static NSString;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkpredicatekeypathcount?language=objc)
    pub static HKPredicateKeyPathCount: &'static NSString;
}