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!(
    /// A sample object representing the results of a standard hearing test.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/healthkit/hkaudiogramsample?language=objc)
    #[unsafe(super(HKSample, HKObject, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(all(feature = "HKObject", feature = "HKSample"))]
    pub struct HKAudiogramSample;
);

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

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

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

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

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

#[cfg(all(feature = "HKObject", feature = "HKSample"))]
impl HKAudiogramSample {
    extern_methods!(
        #[cfg(feature = "HKAudiogramSensitivityPoint")]
        /// The hearing sensitivity readings associated with a hearing test.
        #[unsafe(method(sensitivityPoints))]
        #[unsafe(method_family = none)]
        pub unsafe fn sensitivityPoints(&self) -> Retained<NSArray<HKAudiogramSensitivityPoint>>;

        #[cfg(feature = "HKAudiogramSensitivityPoint")]
        /// Creates a new audiogram sample with the specified attributes.
        ///
        /// Parameter `sensitivityPoints`: Sensitivity data associated with the sample, with a maximum limit of 30 points. Frequencies must be unique, and ordered ascending.
        ///
        /// Parameter `startDate`: The start date for the hearing test.
        ///
        /// Parameter `endDate`: The end date for the hearing test.
        ///
        /// Parameter `metadata`: Optional meta data associated with the sample.
        ///
        /// Returns: A new instance of an audiogram sample.
        ///
        /// # Safety
        ///
        /// `metadata` generic should be of the correct type.
        #[deprecated]
        #[unsafe(method(audiogramSampleWithSensitivityPoints:startDate:endDate:metadata:))]
        #[unsafe(method_family = none)]
        pub unsafe fn audiogramSampleWithSensitivityPoints_startDate_endDate_metadata(
            sensitivity_points: &NSArray<HKAudiogramSensitivityPoint>,
            start_date: &NSDate,
            end_date: &NSDate,
            metadata: Option<&NSDictionary<NSString, AnyObject>>,
        ) -> Retained<Self>;

        #[cfg(all(feature = "HKAudiogramSensitivityPoint", feature = "HKDevice"))]
        /// Creates a new audiogram sample with the specified attributes.
        ///
        /// Parameter `sensitivityPoints`: Sensitivity data associated with the sample, with a maximum limit of 30 points. Frequencies must be unique, and ordered ascending.
        ///
        /// Parameter `startDate`: The start date of the hearing test.
        ///
        /// Parameter `endDate`: The end date of the hearing test.
        ///
        /// Parameter `device`: The device that generated the sample data.
        ///
        /// Parameter `metadata`: Optional metadata associated with the sample.
        ///
        /// Returns: A new instance of an audiogram sample.
        ///
        /// # Safety
        ///
        /// `metadata` generic should be of the correct type.
        #[unsafe(method(audiogramSampleWithSensitivityPoints:startDate:endDate:device:metadata:))]
        #[unsafe(method_family = none)]
        pub unsafe fn audiogramSampleWithSensitivityPoints_startDate_endDate_device_metadata(
            sensitivity_points: &NSArray<HKAudiogramSensitivityPoint>,
            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 HKAudiogramSample {
    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 HKAudiogramSample {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}