Struct HMService

Source

pub struct HMService { /* private fields */ }

Available on crate feature HMService only.

Expand description

Represents a service provided by an accessory.

This class represents a service provided by an accessory in the home. A service is composed of one or more characteristics that can be modified.

Implementations§

Source §

impl HMService

Source

pub unsafe fn accessory(&self) -> Option<Retained<HMAccessory>>

Available on crate feature HMAccessory only.

Accessory that provides this service.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

The type of the service, e.g. HMServiceTypeLightbulb.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

The localized description of the service.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

Name for the service.

Returns the service’s name that is associated with HomeKit. The initial value is the value of the name characteristic of the service, if it has one.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

For HMServiceTypeOutlet and HMServiceTypeSwitch, this is the type of the associated service.

This could be any of the HomeKit Accessory Profile defined services (except HMServiceTypeOutlet or HMServiceTypeSwitch) that supports HMCharacteristicTypePowerState characteristic.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn characteristics(&self) -> Retained<NSArray<HMCharacteristic>>

Available on crate feature HMCharacteristic only.

Array of HMCharacteristic objects that represents all the characteristics provided by the service.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

A unique identifier for the service.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn isUserInteractive(&self) -> bool

Indicates if this service supports user interaction or not.

Applications should use this property to filter out services that the users should not directly interact with, e.g. HMServiceTypeAccessoryInformation.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn isPrimaryService(&self) -> bool

Indicates if this services is the primary service.

Applications should use this property to show the primary service on the accessory.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn linkedServices(&self) -> Option<Retained<NSArray<HMService>>>

Array of HMService objects that represents all the services that the service links to.

Applications should use this property to show logical grouping of services on the accessory. linkedServices will be nil when the service does not link to any other services.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn matterEndpointID(&self) -> Option<Retained<NSNumber>>

The Matter endpoint identifier that this service is mapped to.

This property is nil for HAP accessories, and set to a valid value for Matter devices.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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 service.

Parameter name: New name for the service.

The new name is stored in HomeKit and not on 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.

Source

pub unsafe fn updateAssociatedServiceType_completionHandler( &self, service_type: Option<&NSString>, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method is used to set up the service type of the device connected to a contact sensor, switch or an outlet.

Parameter serviceType: Service type of the device connected to a contact sensor/switch/outlet service.

This method is only valid for the services of the following types: HMServiceTypeOutlet, HMServiceTypeContactSensor and HMServiceTypeSwitch

For services of type HMServiceTypeOutlet and HMServiceTypeSwitch, serviceType can be one of the HomeKit Accessory Profile defined services (except HMServiceTypeOutlet or HMServiceTypeSwitch) that supports HMCharacteristicTypePowerState characteristic.

For services of type HMServiceTypeContactSensor, serviceType can be one of the following services: HMServiceTypeDoor, HMServiceTypeGarageDoorOpener, HMServiceTypeWindow and HMServiceTypeWindowCovering

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 init(this: Allocated<Self>) -> Retained<Self>

👎Deprecated: HMService objects are created by their parent container objects. Directly creating them is not supported.

Source §

impl HMService

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.

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

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