Struct HMHomeManager

Source

#[repr(C)]
pub struct HMHomeManager { /* private fields */ }

Available on crate feature HMHomeManager only.

Expand description

Manages collection of one or more homes.

This class is responsible for managing a collection of homes.

Implementations§

Source §

impl HMHomeManager

Source

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

Source

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

Delegate that receives updates on the collection of homes.

Source

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

This is a weak property. Setter for delegate.

Source

pub unsafe fn authorizationStatus(&self) -> HMHomeManagerAuthorizationStatus

The current authorization status of the application.

The authorization is managed by the system, there is no need to explicitly request authorization.

Source

pub unsafe fn primaryHome(&self) -> Option<Retained<HMHome>>

👎Deprecated: No longer supported.

Available on crate feature HMHome only.

The primary home for this collection.

Source

pub unsafe fn homes(&self) -> Retained<NSArray<HMHome>>

Available on crate feature HMHome only.

Array of HMHome objects that represents the homes associated with the home manager.

When a new home manager is created, this array is initialized as an empty array. It is not guaranteed to be filled with the list of homes, represented as HMHome objects, until the homeManagerDidUpdateHomes: delegate method has been invoked.

Source

pub unsafe fn updatePrimaryHome_completionHandler( &self, home: &HMHome, completion: &Block<dyn Fn(*mut NSError)>, )

👎Deprecated: No longer supported.

Available on crate features HMHome and block2 only.

This method is used to change the primary home.

Parameter home: New primary 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.

Source

pub unsafe fn addHomeWithName_completionHandler( &self, home_name: &NSString, completion: &Block<dyn Fn(mut HMHome, mut NSError)>, )

Available on crate features HMHome and block2 only.

Adds a new home to the collection.

Parameter homeName: Name of the home to create and add to the collection.

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.

Source

pub unsafe fn removeHome_completionHandler( &self, home: &HMHome, completion: &Block<dyn Fn(*mut NSError)>, )

Available on crate features HMHome and block2 only.

Removes an existing home from the collection.

Parameter home: Home object that needs to be removed from the collection.

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.

Source §

impl HMHomeManager

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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

Dynamically find the class of this object.

§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());

Source

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.

Source

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`
    }
}