Struct HMHome 

pub struct HMHome { /* private fields */ }

Available on crate feature HMHome only.

Represents a home.

This class represents a home and is the entry point to communicate and configure different accessories in the home. This is also used to manage all the rooms, zones, service groups, users, triggers, and action sets in the home.

See also Apple’s documentation

Implementations

impl HMHome

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn HMHomeDelegate>>>

Delegate that receives updates on the state of the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn HMHomeDelegate>>, )

Setter for delegate.

This is a weak property.

Safety

This might not be thread-safe.

pub unsafe fn name(&self) -> Retained<NSString>

The name of the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn isPrimary(&self) -> bool

Specifies whether this home is the primary home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn homeHubState(&self) -> HMHomeHubState

Specifies the state of the home hub.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn uniqueIdentifier(&self) -> Retained<NSUUID>

A unique identifier for the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn updateName_completionHandler( &self, name: &NSString, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method is used to change the name of the home.

Parameter name: New name for the home.

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.

impl HMHome

Methods declared on superclass NSObject.

pub unsafe fn new() -> Retained<Self>

impl HMHome

HMAccessory.

pub unsafe fn accessories(&self) -> Retained<NSArray<HMAccessory>>

Available on crate feature HMAccessory only.

Array of HMAccessory objects that represents all accessories added to the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn addAccessory_completionHandler( &self, accessory: &HMAccessory, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMAccessory and block2 only.

Adds a new accessory to the home.

Parameter accessory: Accessory to add to the home.

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.

pub unsafe fn removeAccessory_completionHandler( &self, accessory: &HMAccessory, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMAccessory and block2 only.

Removes an accessory from the home.

Parameter accessory: Accessory to remove from the home.

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.

pub unsafe fn assignAccessory_toRoom_completionHandler( &self, accessory: &HMAccessory, room: &HMRoom, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMAccessory and HMRoom and block2 only.

Assigns a new room for the accessory.

When an accessory is added to a home, it is automatically assigned the room corresponding to

• [HMHome roomForEntireHome]. This method is used to change the room assigned to an accessory.

Parameter accessory: Accessory whose rooms needs to modified

Parameter room: New room for the accessory.

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.

pub unsafe fn servicesWithTypes( &self, service_types: &NSArray<NSString>, ) -> Option<Retained<NSArray<HMService>>>

Available on crate feature HMService only.

Queries all services that match the specified types.

Parameter serviceTypes: Array of NSString objects that specifies the service types to match.

Returns: Array of HMService objects that match the specified service types, nil if no matching services were found.

pub unsafe fn unblockAccessory_completionHandler( &self, accessory: &HMAccessory, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMAccessory and block2 only.

unblock a blocked accessory.

A misbehaving accessory will automatically be blocked. After that all requests to the accessory will fail. This API must be used to explicitly unblock the accessory

Parameter accessory: accessory to be unblocked

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.

pub unsafe fn addAndSetupAccessoriesWithCompletionHandler( &self, completion: &DynBlock<dyn Fn(*mut NSError)>, )

👎Deprecated: Use -[HMAccessorySetupManager performAccessorySetupUsingRequest:completionHandler:] instead

Available on crate feature block2 only.

Find nearby accessories and add them to the home. During this process, each of the accessories added to the home is assigned to a room and its services are configured.

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.

pub unsafe fn addAndSetupAccessoriesWithPayload_completionHandler( &self, payload: &HMAccessorySetupPayload, completion: &DynBlock<dyn Fn(*mut NSArray<HMAccessory>, *mut NSError)>, )

👎Deprecated: Use -[HMAccessorySetupManager performAccessorySetupUsingRequest:completionHandler:] instead

Available on crate features HMAccessory and HMAccessorySetupPayload and block2 only.

Add accessory with the given setup payload to the home.

Note: This SPI requires entitlement: com.apple.developer.homekit.allow-setup-payload

Parameter completion: Block that is invoked once the request is processed. Accessories provides the list of added accessories. The NSError provides more information on the status of the request, error will be nil on success.

pub unsafe fn supportsAddingNetworkRouter(&self) -> bool

True if this home supports all of the requirements for adding a network router.

This property is not atomic.

Safety

This might not be thread-safe.

impl HMHome

HMUser.

pub unsafe fn currentUser(&self) -> Retained<HMUser>

Available on crate feature HMUser only.

HMUser object representing the current user of the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn users(&self) -> Retained<NSArray<HMUser>>

👎Deprecated: No longer supported.

Available on crate feature HMUser only.

Array of HMUser objects that represent all users associated with the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn manageUsersWithCompletionHandler( &self, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

Presents a view controller to manage users of the home.

This API is available only for users that have administrator access to the home.

Parameter completion: Block that is invoked once user management is completed. The completion block is fired to allow clients to know when the user has dismissed the view. The NSError provides more information on the status of the request, error will be nil on success. If the user does not have administrator privileges the error code will be set to HMErrorCodeInsufficientPrivileges.

pub unsafe fn addUserWithCompletionHandler( &self, completion: &DynBlock<dyn Fn(*mut HMUser, *mut NSError)>, )

👎Deprecated

Available on crate features HMUser and block2 only.

Adds a user to the home.

Parameter completion: Block that is invoked once the request is processed. The HMUser object provides a reference to the user that was added to the home. The NSError provides more information on the status of the request, error will be nil on success. The userInfo dictionary will contain the HMUserFailedAccessoriesKey which provides more details on the accessories that failed to add the user.

pub unsafe fn removeUser_completionHandler( &self, user: &HMUser, completion: &DynBlock<dyn Fn(*mut NSError)>, )

👎Deprecated

Available on crate features HMUser and block2 only.

Removes a user from the home.

Parameter user: HMUser whose access is being revoked.

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. The userInfo dictionary will contain the HMUserFailedAccessoriesKey which provides more details on the accessories that failed to remove the user.

pub unsafe fn homeAccessControlForUser( &self, user: &HMUser, ) -> Retained<HMHomeAccessControl>

Available on crate features HMAccessControl and HMHomeAccessControl and HMUser only.

Retrieve the access level of the user associated with the home.

impl HMHome

HMRoom.

pub unsafe fn rooms(&self) -> Retained<NSArray<HMRoom>>

Available on crate feature HMRoom only.

Array of HMRoom objects that represents all rooms in the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn addRoomWithName_completionHandler( &self, room_name: &NSString, completion: &DynBlock<dyn Fn(*mut HMRoom, *mut NSError)>, )

Available on crate features HMRoom and block2 only.

Adds a room to the home.

Parameter roomName: Name of the room to add to the home.

Parameter completion: Block that is invoked once the request is processed. The HMRoom is the new room added to the home. The NSError provides more information on the status of the request, error will be nil on success.

pub unsafe fn removeRoom_completionHandler( &self, room: &HMRoom, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMRoom and block2 only.

Removes a room from the home.

Any references to this room will be removed from all properties of the home. For example, the room will be removed from the zone. Any accessories associated contained by this room will be moved to the room provided by - [HMHome roomForEntireHome].

Parameter room: Room to remove from the home.

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.

pub unsafe fn roomForEntireHome(&self) -> Retained<HMRoom>

Available on crate feature HMRoom only.

This method returns a room that represents the entire home. This can be used to assign a room to a service that is not necessarily located in one particular room.

Returns: HMRoom that represents the home.

impl HMHome

HMZone.

pub unsafe fn zones(&self) -> Retained<NSArray<HMZone>>

Available on crate feature HMZone only.

Array of HMZone objects that represents all the zones in the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn addZoneWithName_completionHandler( &self, zone_name: &NSString, completion: &DynBlock<dyn Fn(*mut HMZone, *mut NSError)>, )

Available on crate features HMZone and block2 only.

Adds a zone to the home.

Parameter zoneName: Name of the zone to add to the home.

Parameter completion: Block that is invoked once the request is processed. The HMZone is the new zone added to the home. The NSError provides more information on the status of the request, error will be nil on success.

pub unsafe fn removeZone_completionHandler( &self, zone: &HMZone, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMZone and block2 only.

Removes a zone from the home.

Parameter zone: Zone to remove from the home.

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.

impl HMHome

HMServiceGroup.

pub unsafe fn serviceGroups(&self) -> Retained<NSArray<HMServiceGroup>>

Available on crate feature HMServiceGroup only.

Array of HMServiceGroup objects that represents all service groups in the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn addServiceGroupWithName_completionHandler( &self, service_group_name: &NSString, completion: &DynBlock<dyn Fn(*mut HMServiceGroup, *mut NSError)>, )

Available on crate features HMServiceGroup and block2 only.

Adds a service group to the home.

Parameter serviceGroupName: Name of the service group to add to the home.

Parameter completion: Block that is invoked once the request is processed. The HMServiceGroup is the new service group added to the home. The NSError provides more information on the status of the request, error will be nil on success.

pub unsafe fn removeServiceGroup_completionHandler( &self, group: &HMServiceGroup, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMServiceGroup and block2 only.

Removes a service group from the home.

Parameter group: Service group to remove from the home.

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.

impl HMHome

HMActionSet.

pub unsafe fn actionSets(&self) -> Retained<NSArray<HMActionSet>>

Available on crate feature HMActionSet only.

Array of HMActionSet objects that represents all the action sets in the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn addActionSetWithName_completionHandler( &self, action_set_name: &NSString, completion: &DynBlock<dyn Fn(*mut HMActionSet, *mut NSError)>, )

Available on crate features HMActionSet and block2 only.

Adds a new action set to the home.

Parameter actionSetName: Name of the action set to add to the home.

Parameter completion: Block that is invoked once the request is processed. The HMActionSet parameter is the new action set added to the home. The NSError provides more information on the status of the request, error will be nil on success.

pub unsafe fn removeActionSet_completionHandler( &self, action_set: &HMActionSet, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMActionSet and block2 only.

Removes an existing action set from the home.

Parameter actionSet: Action set to remove from the home. A builtin action set cannot be removed.

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.

pub unsafe fn executeActionSet_completionHandler( &self, action_set: &HMActionSet, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMActionSet and block2 only.

Executes all the actions within an action set.

Parameter actionSet: Action set to execute.

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.

pub unsafe fn builtinActionSetOfType( &self, action_set_type: &NSString, ) -> Option<Retained<HMActionSet>>

Available on crate feature HMActionSet only.

Retrieve a built-in action set for the home.

Parameter actionSetType: Type of the builtin action set. Supported action set types are HMActionSetTypeWakeUp, HMActionSetTypeSleep, HMActionSetTypeHomeDeparture and HMActionSetTypeHomeArrival.

Returns: Reference to the built-in action set corresponding to type argument, nil if no matching action set is found.

impl HMHome

HMTrigger.

pub unsafe fn triggers(&self) -> Retained<NSArray<HMTrigger>>

Available on crate feature HMTrigger only.

Array of HMTrigger objects that represents all the triggers in the home.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn addTrigger_completionHandler( &self, trigger: &HMTrigger, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMTrigger and block2 only.

Adds a trigger to the home. Unless the trigger object is added to the home, it cannot be activated. Throws error and will not be added to home if there is no Home Hub associated with the home

Triggers are specific to an iOS device and are not synced across multiple devices to ensure that the action sets are executed only once.

Parameter trigger: Trigger to add to the home.

Parameter completion: Block that is invoked once the request is processed. The HMTrigger parameter is the new trigger added to the home. The NSError provides more information on the status of the request, error will be nil on success. Errors when no Home Hub is associated with the home

pub unsafe fn removeTrigger_completionHandler( &self, trigger: &HMTrigger, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMTrigger and block2 only.

Removes a trigger from the home. If the trigger is active, they are automatically deactivated.

Parameter trigger: Trigger to remove from the home.

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.

impl HMHome

Matter.

pub unsafe fn matterControllerID(&self) -> Retained<NSString>

Identifier of the Matter controller associated with this home. This property can be passed as the first argument to +[MTRDeviceController sharedControllerWithId:xpcConnectBlock:] method to get a MTRDeviceController object.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn matterControllerXPCConnectBlock( &self, ) -> NonNull<DynBlock<dyn Fn() -> NonNull<NSXPCConnection>>>

Available on crate feature block2 only.

Block generating XPC connection on demand through which to access the Matter controller associated with this home. This property can be passed as the second argument to +[MTRDeviceController sharedControllerWithId:xpcConnectBlock:] method to get a MTRDeviceController object.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn matterStartupParametersXPCConnectBlock( &self, ) -> NonNull<DynBlock<dyn Fn() -> NonNull<NSXPCConnection>>>

Available on crate feature block2 only.

Block generating XPC connection on demand through which to access the Matter controller associated with this home. This property can be passed as part of an MTRXPCDeviceControllerParameters to create an MTRDeviceController that will have access to the Apple Home Fabric.

This property is not atomic.

Safety

This might not be thread-safe.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for HMHome

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<HMHome> for HMHome

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for HMHome

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for HMHome

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for HMHome

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for HMHome

const NAME: &'static str = "HMHome"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<HMHome as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for HMHome

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for HMHome

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for HMHome

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for HMHome

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for HMHome

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for HMHome

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for HMHome

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for HMHome

impl Eq for HMHome

impl Send for HMHome

impl Sync for HMHome