objc2-home-kit 0.3.2

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

use crate::*;

extern_class!(
    /// Used to describe a collection of HMRoom objects
    ///
    ///
    /// This class is used to group a collection of rooms.
    /// This allows for association of a set of rooms into a group.
    /// Eg. "Living Room" and "Kitchen" rooms can be grouped together
    /// in the "Downstairs" zone.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/homekit/hmzone?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct HMZone;
);

unsafe impl Send for HMZone {}

unsafe impl Sync for HMZone {}

extern_conformance!(
    unsafe impl NSObjectProtocol for HMZone {}
);

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

        /// Name of the zone.
        ///
        /// This property is not atomic.
        ///
        /// # Safety
        ///
        /// This might not be thread-safe.
        #[unsafe(method(name))]
        #[unsafe(method_family = none)]
        pub unsafe fn name(&self) -> Retained<NSString>;

        #[cfg(feature = "HMRoom")]
        /// Array of HMRoom objects that correspond to the rooms contained in this zone.
        ///
        /// This property is not atomic.
        ///
        /// # Safety
        ///
        /// This might not be thread-safe.
        #[unsafe(method(rooms))]
        #[unsafe(method_family = none)]
        pub unsafe fn rooms(&self) -> Retained<NSArray<HMRoom>>;

        /// A unique identifier for the zone.
        ///
        /// This property is not atomic.
        ///
        /// # Safety
        ///
        /// This might not be thread-safe.
        #[unsafe(method(uniqueIdentifier))]
        #[unsafe(method_family = none)]
        pub unsafe fn uniqueIdentifier(&self) -> Retained<NSUUID>;

        #[cfg(feature = "block2")]
        /// This method is used to change the name of the zone.
        ///
        ///
        /// Parameter `name`: New name for the zone.
        ///
        ///
        /// Parameter `completion`: Block that is invoked once the request is processed.
        /// The NSError provides more information on the status of the request, error
        /// will be nil on success.
        #[unsafe(method(updateName:completionHandler:))]
        #[unsafe(method_family = none)]
        pub unsafe fn updateName_completionHandler(
            &self,
            name: &NSString,
            completion: &block2::DynBlock<dyn Fn(*mut NSError)>,
        );

        #[cfg(all(feature = "HMRoom", feature = "block2"))]
        /// Adds a room to a zone.
        ///
        ///
        /// Both the room and the zone should be part of the home.  A room can be added to multiple
        /// zones, e.g., a room "Kitchen" can be added to "Downstairs" as well as "Outdoor" zones.
        ///
        ///
        /// Parameter `room`: Room to add to this zone.
        ///
        ///
        /// Parameter `completion`: Block that is invoked once the request is processed.
        /// The NSError provides more information on the status of the request, error
        /// will be nil on success.
        #[unsafe(method(addRoom:completionHandler:))]
        #[unsafe(method_family = none)]
        pub unsafe fn addRoom_completionHandler(
            &self,
            room: &HMRoom,
            completion: &block2::DynBlock<dyn Fn(*mut NSError)>,
        );

        #[cfg(all(feature = "HMRoom", feature = "block2"))]
        /// Removes a room from the zone.
        ///
        ///
        /// Parameter `room`: Room to remove from this zone.
        ///
        ///
        /// Parameter `completion`: Block that is invoked once the request is processed.
        /// The NSError provides more information on the status of the request, error
        /// will be nil on success.
        #[unsafe(method(removeRoom:completionHandler:))]
        #[unsafe(method_family = none)]
        pub unsafe fn removeRoom_completionHandler(
            &self,
            room: &HMRoom,
            completion: &block2::DynBlock<dyn Fn(*mut NSError)>,
        );
    );
}

/// Methods declared on superclass `NSObject`.
impl HMZone {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}