Struct HMEventTrigger 

pub struct HMEventTrigger { /* private fields */ }

Available on crate features HMEventTrigger and HMTrigger only.

Triggers based on events.

This class represents a trigger that is based on events.

See also Apple’s documentation

Implementations

impl HMEventTrigger

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

pub unsafe fn initWithName_events_predicate( this: Allocated<Self>, name: &NSString, events: &NSArray<HMEvent>, predicate: Option<&NSPredicate>, ) -> Retained<Self>

Available on crate feature HMEvent only.

Initializes a new event trigger object.

Parameter name: Name of the event trigger.

Parameter events: Array of events that can trigger the evaluation of the trigger. Note: The trigger will be evaluated if any one of the events is true.

Parameter predicate: The predicate to evaluate before executing any of the actions sets associated to this event.

Returns: Instance object representing the event trigger.

pub unsafe fn initWithName_events_endEvents_recurrences_predicate( this: Allocated<Self>, name: &NSString, events: &NSArray<HMEvent>, end_events: Option<&NSArray<HMEvent>>, recurrences: Option<&NSArray<NSDateComponents>>, predicate: Option<&NSPredicate>, ) -> Retained<Self>

Available on crate feature HMEvent only.

Initializes a new event trigger object.

Parameter name: Name of the event trigger.

Parameter events: Array of events that can trigger the evaluation of the trigger. Note: The trigger will be evaluated if any one of the events is true.

Parameter endEvents: Array of end events that can trigger the restoration to the state before the scene was run.

Parameter recurrences: Specifies the days of the week when the trigger is to be evaluated. Only the ‘weekday’ property is honored in NSDateComponents.

Parameter predicate: The predicate to evaluate before executing any of the actions sets associated to this event.

Returns: Instance object representing the event trigger.

pub unsafe fn events(&self) -> Retained<NSArray<HMEvent>>

Available on crate feature HMEvent only.

The events associated with the trigger.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn endEvents(&self) -> Retained<NSArray<HMEvent>>

Available on crate feature HMEvent only.

The events that correspond to executing the restore of the scene before the trigger was executed. E.g. Execute the scene for 10 mins and restore original state is achieved by specifying a corresponding HMDurationEvent in the list of endEvents.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn predicate(&self) -> Option<Retained<NSPredicate>>

The predicate to evaluate before executing the action sets associated with the trigger.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn recurrences(&self) -> Option<Retained<NSArray<NSDateComponents>>>

recurrences Specifies the recurrences for when the trigger is evaluated. This only supports days of the week.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn executeOnce(&self) -> bool

Specifies whether this trigger is executed only once after which the trigger is disabled.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn triggerActivationState(&self) -> HMEventTriggerActivationState

Available on crate feature HMEventTriggerActivationState only.

Specifies the current activation state of the trigger.

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Use updateEvents:completionHandler: instead

Available on crate features HMEvent and block2 only.

Adds a new event to the event trigger.

Parameter event: Event to add to the event trigger.

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 removeEvent_completionHandler( &self, event: &HMEvent, completion: &DynBlock<dyn Fn(*mut NSError)>, )

👎Deprecated: Use updateEvents:completionHandler: instead

Available on crate features HMEvent and block2 only.

Removes the specified event from the event trigger.

Parameter event: Event to remove from the event trigger.

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 updateEvents_completionHandler( &self, events: &NSArray<HMEvent>, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMEvent and block2 only.

Updates the set of events in the event trigger.

Parameter events: Events to update in the event trigger

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 updateEndEvents_completionHandler( &self, end_events: &NSArray<HMEvent>, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features HMEvent and block2 only.

Updates the set of events in the event trigger.

Parameter endEvents: Events to update in the event trigger

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 updatePredicate_completionHandler( &self, predicate: Option<&NSPredicate>, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method replaces the predicate used to evaluate execution of the action sets associated with the trigger.

Parameter predicate: The new predicate for the event trigger.

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 updateRecurrences_completionHandler( &self, recurrences: Option<&NSArray<NSDateComponents>>, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method replaces the recurrences which secifies the days of the week when the trigger is to be evaluated.

Parameter recurrences: The new recurrences for the event trigger.

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 updateExecuteOnce_completionHandler( &self, execute_once: bool, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method is used to update whether the event trigger repeats or not.

Parameter executeOnce: Specifies whether the event trigger is repeated or not.

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 HMEventTrigger

Methods declared on superclass NSObject.

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

impl HMEventTrigger

NSPredicate.

pub unsafe fn predicateForEvaluatingTriggerOccurringBeforeSignificantEvent_applyingOffset( significant_event: &NSString, offset: Option<&NSDateComponents>, ) -> Retained<NSPredicate>

👎Deprecated: Use predicateForEvaluatingTriggerOccurringBeforeSignificantEvent: instead

Creates a predicate that will evaluate whether the event occurred before a significant event.

Parameter significantEvent: The significant event to compare against. The valid values are: HMSignificantEventSunrise and HMSignificantEventSunset.

Parameter offset: An offset from the time of the signficant event. To specify an offset before the significant event, the properties of the NSDateComponents must be negative value. e.g. To specify 30 mins before sunset, the ‘minute’ property must be set to -30.

Returns: Predicate object representing a condition to evaluate before executing the action set.

pub unsafe fn predicateForEvaluatingTriggerOccurringBeforeSignificantEvent( significant_event: &HMSignificantTimeEvent, ) -> Retained<NSPredicate>

Available on crate features HMEvent and HMSignificantTimeEvent and HMTimeEvent only.

Creates a predicate that will evaluate whether the event occurred before a significant event.

Parameter significantEvent: The significant event to compare against.

Returns: Predicate object representing a condition to evaluate before executing the action set.

pub unsafe fn predicateForEvaluatingTriggerOccurringAfterSignificantEvent_applyingOffset( significant_event: &NSString, offset: Option<&NSDateComponents>, ) -> Retained<NSPredicate>

👎Deprecated: Use predicateForEvaluatingTriggerOccurringAfterSignificantEvent: instead

Creates a predicate that will evaluate whether the event occurred after a significant event.

Parameter significantEvent: The significant event to compare against. The valid values are: HMSignificantEventSunrise and HMSignificantEventSunset.

Parameter offset: An offset from the time of the signficant event. To specify an offset after the significant event, the properties of the NSDateComponents must be positive value. e.g. To specify 30 mins after sunset, the ‘minute’ property must be set to 30.

Returns: Predicate object representing a condition to evaluate before executing the action set.

pub unsafe fn predicateForEvaluatingTriggerOccurringAfterSignificantEvent( significant_event: &HMSignificantTimeEvent, ) -> Retained<NSPredicate>

Available on crate features HMEvent and HMSignificantTimeEvent and HMTimeEvent only.

Creates a predicate that will evaluate whether the event occurred after a significant event.

Parameter significantEvent: The significant event to compare against.

Returns: Predicate object representing a condition to evaluate before executing the action set.

pub unsafe fn predicateForEvaluatingTriggerOccurringBetweenSignificantEvent_secondSignificantEvent( first_significant_event: &HMSignificantTimeEvent, second_significant_event: &HMSignificantTimeEvent, ) -> Retained<NSPredicate>

Available on crate features HMEvent and HMSignificantTimeEvent and HMTimeEvent only.

Creates a predicate that will evaluate whether the event occurred between two significant events.

Parameter firstSignificantEvent: The first significant event.

Parameter secondSignificantEvent: The second significant event.

Returns: Predicate object representing a condition to evaluate before executing the action set.

pub unsafe fn predicateForEvaluatingTriggerOccurringBeforeDateWithComponents( date_components: &NSDateComponents, ) -> Retained<NSPredicate>

Creates a predicate that will evaluate whether the event occurred before the time specified.

Parameter dateComponents: Date components representing the time to compare against when the event occurs.

Returns: Predicate object representing a condition to evaluate before executing the action set.

pub unsafe fn predicateForEvaluatingTriggerOccurringOnDateWithComponents( date_components: &NSDateComponents, ) -> Retained<NSPredicate>

Creates a predicate that will evaluate whether the event occurred at the time specified.

Parameter dateComponents: Date components representing the time to compare against when the event occurs.

Returns: Predicate object representing a condition to evaluate before executing the action set.

pub unsafe fn predicateForEvaluatingTriggerOccurringAfterDateWithComponents( date_components: &NSDateComponents, ) -> Retained<NSPredicate>

Creates a predicate that will evaluate whether the event occurred at or after the time specified.

Parameter dateComponents: Date components representing the time to compare against when the event occurs.

Returns: Predicate object representing a condition to evaluate before executing the action set.

pub unsafe fn predicateForEvaluatingTriggerOccurringBetweenDateWithComponents_secondDateWithComponents( first_date_components: &NSDateComponents, second_date_with_components: &NSDateComponents, ) -> Retained<NSPredicate>

Creates a predicate that will evaluate whether the event occurred between two times.

Parameter firstDateComponents: The first date component.

Parameter secondDateWithComponents: The second date component.

Returns: Predicate object representing a condition to evaluate before executing the action set.

pub unsafe fn predicateForEvaluatingTriggerWithCharacteristic_relatedBy_toValue( characteristic: &HMCharacteristic, operator_type: NSPredicateOperatorType, value: &AnyObject, ) -> Retained<NSPredicate>

Available on crate feature HMCharacteristic only.

Creates a predicate that will evaluate whether a characteristic value is related to the specified value.

Parameter characteristic: The characteristic that is evaluated as part of the predicate.

Parameter operatorType: The relation between the characteristic and the target value. This can be either Less Than, Greater Than, Less Than or Equal, Greater Than or Equal, Equal, or Not Equal. Anything else will cause an exception to be thrown.

Parameter value: The value of the characteristic to compare when evaluating the predicate.

Returns: Predicate object representing a condition to evaluate before executing the action set.

Safety

value should be of the correct type.

pub unsafe fn predicateForEvaluatingTriggerWithPresence( presence_event: &HMPresenceEvent, ) -> Retained<NSPredicate>

Available on crate features HMEvent and HMPresenceEvent only.

Creates a predicate that will evaluate based on the presence event.

Parameter presenceEvent: The presenceEvent that is evaluated as part of the predicate.

Returns: Predicate object representing a condition to evaluate before executing the action set.

Methods from Deref<Target = HMTrigger>

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

Name of the trigger.

This property is not atomic.

Safety

This might not be thread-safe.

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.

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.

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.

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.

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.

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.

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.

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:

1. The trigger must be added to a home.
2. The trigger must have at least one action set associated with it.
3. Each action set added to the trigger must have at least one action.
4. 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.

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 HMEventTrigger

fn as_ref(&self) -> &AnyObject

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

impl AsRef<HMEventTrigger> for HMEventTrigger

fn as_ref(&self) -> &Self

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

impl AsRef<HMTrigger> for HMEventTrigger

fn as_ref(&self) -> &HMTrigger

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

impl AsRef<NSObject> for HMEventTrigger

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for HMEventTrigger

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<HMTrigger> for HMEventTrigger

fn borrow(&self) -> &HMTrigger

Immutably borrows from an owned value.

impl Borrow<NSObject> for HMEventTrigger

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for HMEventTrigger

const NAME: &'static str = "HMEventTrigger"

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

type Super = HMTrigger

The superclass of this class.

type ThreadKind = <<HMEventTrigger 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 HMEventTrigger

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

Formats the value using the given formatter.

impl Deref for HMEventTrigger

type Target = HMTrigger

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for HMEventTrigger

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 HMEventTrigger

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for HMEventTrigger

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 HMEventTrigger

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 HMEventTrigger

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

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

impl DowncastTarget for HMEventTrigger

impl Eq for HMEventTrigger

impl Send for HMEventTrigger

impl Sync for HMEventTrigger