Struct HMTimerTrigger

Source

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

Available on crate features HMTimerTrigger and HMTrigger only.

Expand description

Timer based trigger.

This class represents a trigger that is based on timers.

Implementations§

Source §

impl HMTimerTrigger

Source

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

Source

pub unsafe fn initWithName_fireDate_recurrence( this: Allocated<Self>, name: &NSString, fire_date: &NSDate, recurrence: Option<&NSDateComponents>, ) -> Retained<Self>

Initialize a new HMTimerTrigger object.

Parameter name: Name for the trigger.

Parameter fireDate: The initial fire date for the timer trigger. The seconds value must be zero. Date should be at least 1 minute ahead for reliable firing. HMErrorCodeDateMustBeOnSpecifiedBoundaries will be returned when adding the trigger to a home if the fireDate includes a seconds value other than 0.

Parameter recurrence: The recurrence interval to fire the trigger. A value of nil indicates that the trigger is non-repeating. The minimum reccurence interval is 5 minutes, maximum recurrence interval is 5 weeks and the recurrence interval must be specified in multiples of whole minutes.

Validity checks are performed when the trigger is added to the home and the NSError in the completion block for addTrigger: method indicates the reason for the failure: HMErrorCodeDateMustBeOnSpecifiedBoundaries is returned if the seconds/nanoseconds fields in recurrence interval or seconds field in fireDate have a value other than 0. HMErrorCodeRecurrenceTooSmall is returned if recurrence interval is less than 5 minutes. HMErrorCodeRecurrenceTooLarge is returned if recurrence interval is greater than 5 weeks. HMErrorCodeFireDateInPast is returned if recurrence is nil and fireDate is in the past.

Source

pub unsafe fn initWithName_fireDate_timeZone_recurrence_recurrenceCalendar( this: Allocated<Self>, name: &NSString, fire_date: &NSDate, time_zone: Option<&NSTimeZone>, recurrence: Option<&NSDateComponents>, recurrence_calendar: Option<&NSCalendar>, ) -> Retained<Self>

👎Deprecated

Source

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

Specifies when, in an absolute time, the trigger should fire the first time.

Timer triggers are only set at the top of the minute. When the timer trigger fires, it will typically fire within 1 minute of the scheduled fire date or calculated recurrence fire date, depending on how the system is managing its resources.

Note: Should be at least 1 minute ahead for reliable firing.

Source

pub unsafe fn timeZone(&self) -> Option<Retained<NSTimeZone>>

👎Deprecated: Use HMEventTrigger with HMCalendarEvent for triggers based on a time-zone-relative time of day

Source

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

The date components that specify how a trigger is to be repeated.

This value must be nil if the trigger should not repeat. The date component values are relative to the initial fire date of the trigger. If the calendar value of the recurrence is nil, the current calendar will be used to calculate the recurrence interval. Recurrence example: if a trigger should repeat every hour, set the ‘hour’ property of the recurrence to 1. The minimum recurrence interval is 5 minutes, maximum recurrence interval is 5 weeks and the recurrence interval must be specified in multiples of whole minutes. Examples are 5 minutes, 6 minutes, 1 day, 2 weeks.

Source

pub unsafe fn recurrenceCalendar(&self) -> Option<Retained<NSCalendar>>

👎Deprecated: No longer supported

Source

pub unsafe fn updateFireDate_completionHandler( &self, fire_date: &NSDate, completion: &Block<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method is used to change the fire date of a timer trigger.

Parameter fireDate: New fire date for the trigger. The seconds value must be zero.

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. HMErrorCodeDateMustBeOnSpecifiedBoundaries will be returned if the fireDate includes a seconds value other than 0.

Source

pub unsafe fn updateTimeZone_completionHandler( &self, time_zone: Option<&NSTimeZone>, completion: &Block<dyn Fn(*mut NSError)>, )

👎Deprecated: Use HMEventTrigger with HMCalendarEvent for triggers based on a time-zone-relative time of day

Available on crate feature block2 only.

Source

pub unsafe fn updateRecurrence_completionHandler( &self, recurrence: Option<&NSDateComponents>, completion: &Block<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method is used to change the recurrence interval for a timer trigger.

Parameter recurrence: New recurrence interval for the trigger. Passing a nil indicates that the trigger is non-repeating. The minimum recurrence interval is 5 minutes, maximum recurrence interval is 5 weeks and the recurrence interval must be specified in multiples of whole minutes.

Parameter completion: Block that is invoked once the request is processed. The NSError provides more information on the status of the request: HMErrorCodeDateMustBeOnSpecifiedBoundaries is returned if the seconds/nanoseconds fields have a value other than 0; HMErrorCodeRecurrenceTooSmall is returned if the recurrence interval is less than 5 minutes; HMErrorCodeRecurrenceTooLarge is returned if the recurrence interval is greater than 5 weeks. * error will be nil on success.

Source §

impl HMTimerTrigger

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = HMTrigger>§

Source

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

Name of the trigger.

Source

pub unsafe fn isEnabled(&self) -> bool

State of the trigger.

TRUE if the trigger is enable, FALSE otherwise.

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.

Source

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

👎Deprecated: No longer supported

The date that this trigger was most recently fired.

Source

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

A unique identifier for the trigger.

Source

pub unsafe fn updateName_completionHandler( &self, name: &NSString, completion: &Block<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: &Block<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: &Block<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: &Block<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.

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