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 HKObject subclass representing an category measurement
    ///
    /// Category samples are samples that can be categorized into an enum of concrete values
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkcategorysample?language=objc)
    #[unsafe(super(HKSample, HKObject, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(all(feature = "HKObject", feature = "HKSample"))]
    pub struct HKCategorySample;
);

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

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

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

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

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

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

        /// The preferred enum for the value is determined by the receiver's category type.
        #[unsafe(method(value))]
        #[unsafe(method_family = none)]
        pub unsafe fn value(&self) -> NSInteger;

        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[cfg(feature = "HKObjectType")]
        /// Creates a new HKCategorySample.
        ///
        ///
        /// Parameter `type`: The type of the sample.
        ///
        /// Parameter `value`: The enumeration value for the sample. See HKCategoryTypeIdentifier for appropriate value.
        ///
        /// Parameter `startDate`: The start date of the sample.
        ///
        /// Parameter `endDate`: The end date of the sample.
        ///
        /// Parameter `metadata`: Metadata for the sample (optional).
        ///
        /// # Safety
        ///
        /// `metadata` generic should be of the correct type.
        #[unsafe(method(categorySampleWithType:value:startDate:endDate:metadata:))]
        #[unsafe(method_family = none)]
        pub unsafe fn categorySampleWithType_value_startDate_endDate_metadata(
            r#type: &HKCategoryType,
            value: NSInteger,
            start_date: &NSDate,
            end_date: &NSDate,
            metadata: Option<&NSDictionary<NSString, AnyObject>>,
        ) -> Retained<Self>;

        #[cfg(feature = "HKObjectType")]
        /// Creates a new HKCategorySample.
        ///
        ///
        /// Parameter `type`: The type of the sample.
        ///
        /// Parameter `value`: The enumeration value for the sample. See HKCategoryTypeIdentifier for appropriate value.
        ///
        /// Parameter `startDate`: The start date of the sample.
        ///
        /// Parameter `endDate`: The end date of the sample.
        #[unsafe(method(categorySampleWithType:value:startDate:endDate:))]
        #[unsafe(method_family = none)]
        pub unsafe fn categorySampleWithType_value_startDate_endDate(
            r#type: &HKCategoryType,
            value: NSInteger,
            start_date: &NSDate,
            end_date: &NSDate,
        ) -> Retained<Self>;

        #[cfg(all(feature = "HKDevice", feature = "HKObjectType"))]
        /// Creates a new HKCategorySample.
        ///
        ///
        /// Parameter `type`: The type of the sample.
        ///
        /// Parameter `value`: The enumeration value for the sample. See HKCategoryTypeIdentifier for appropriate value.
        ///
        /// 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).
        ///
        /// # Safety
        ///
        /// `metadata` generic should be of the correct type.
        #[unsafe(method(categorySampleWithType:value:startDate:endDate:device:metadata:))]
        #[unsafe(method_family = none)]
        pub unsafe fn categorySampleWithType_value_startDate_endDate_device_metadata(
            r#type: &HKCategoryType,
            value: NSInteger,
            start_date: &NSDate,
            end_date: &NSDate,
            device: Option<&HKDevice>,
            metadata: Option<&NSDictionary<NSString, AnyObject>>,
        ) -> Retained<Self>;
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "HKObject", feature = "HKSample"))]
impl HKCategorySample {
    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/hkpredicatekeypathcategoryvalue?language=objc)
    pub static HKPredicateKeyPathCategoryValue: &'static NSString;
}