Struct HMTrigger

Source

pub struct HMTrigger { /* private fields */ }

Available on crate feature HMTrigger only.

Expand description

Represents a trigger event.

This class describes a trigger which is an event that can be used to execute one or more action sets when the event fires.

Implementations§

Source §

impl HMTrigger

Source

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

Source

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

Name of the trigger.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn isEnabled(&self) -> bool

State of the trigger.

TRUE if the trigger is enable, FALSE otherwise.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

Available on crate feature HMActionSet only.

Array of HMActionSet objects that represent all the action sets associated with this trigger.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn lastFireDate(&self) -> Option<Retained<NSDate>>

👎Deprecated: No longer supported

The date that this trigger was most recently fired.

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

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

Parameter name: New name for the trigger.

Parameter completion: Block that is invoked once the request is processed. The NSError provides more information on the status of the request.

Source

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

Available on crate features HMActionSet and block2 only.

Registers an action set to be executed when the trigger is fired.

Parameter actionSet: HMActionSet to execute when the trigger fires. The order of execution of the action set is not guaranteed.

Parameter completion: Block that is invoked once the request is processed. The NSError provides more information on the status of the request.

Source

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

Available on crate features HMActionSet and block2 only.

De-registers an action set from the trigger.

Parameter actionSet: The HMActionSet to disassociate from the trigger.

Parameter completion: Block that is invoked once the request is processed. The NSError provides more information on the status of the request.

Source

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

Available on crate feature block2 only.

Enables or disables the trigger.

In order for the trigger to be enabled the following criteria must be met:

The trigger must be added to a home.
The trigger must have at least one action set associated with it.
Each action set added to the trigger must have at least one action.
For HMTimerTrigger: The next fire date of the timer trigger must be less than 5 weeks in the future. The fire date of a one-shot timer trigger must be in the future.

Parameter enable: Setting this to TRUE will enable the trigger, FALSE will disable it.

Parameter completion: Block that is invoked once the request is processed. The NSError provides more information on the status of the request.

Source §

impl HMTrigger

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