Struct EKAlarm

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

Available on crate features EKAlarm and EKObject only.

The EKAlarm class provides an interface for accessing and manipulating calendar event alarms.

The EKAlarm class represents alarms on an event. An alarm can be relative (e.g. 15 mins before) or absolute (specific time).

See also Apple’s documentation

Implementations

impl EKAlarm

pub unsafe fn alarmWithAbsoluteDate(date: &NSDate) -> Retained<EKAlarm>

Creates a new autoreleased alarm with an absolute trigger time.

Parameter date: The date the alarm should fire.

pub unsafe fn alarmWithRelativeOffset( offset: NSTimeInterval, ) -> Retained<EKAlarm>

Creates a new autoreleased alarm with a relative trigger time.

Creates a new autoreleased alarm with a relative trigger time. This offset is added to the start date of the event.

Parameter offset: The offset from the event start that the alarm should fire.

pub unsafe fn relativeOffset(&self) -> NSTimeInterval

Specifies a relative offset from an event start date to fire an alarm.

Set this property to an appropriate negative value to establish an alarm trigger relative to the start date/time of an event. Setting this clears any existing date trigger.

pub unsafe fn setRelativeOffset(&self, relative_offset: NSTimeInterval)

Setter for relativeOffset.

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

Represents an alarm that fires at a specific date.

Set this property to a date to establish an absolute alarm trigger. Setting this clears any relative interval trigger.

pub unsafe fn setAbsoluteDate(&self, absolute_date: Option<&NSDate>)

Setter for absoluteDate.

pub unsafe fn structuredLocation( &self, ) -> Option<Retained<EKStructuredLocation>>

Available on crate feature EKStructuredLocation only.

Allows you to set a structured location (a location with a potential geo-coordinate) on an alarm. This is used in conjunction with proximity to do geofence-based triggering of reminders.

pub unsafe fn setStructuredLocation( &self, structured_location: Option<&EKStructuredLocation>, )

Available on crate feature EKStructuredLocation only.

Setter for structuredLocation.

pub unsafe fn proximity(&self) -> EKAlarmProximity

Available on crate feature EKTypes only.

Defines whether this alarm triggers via entering/exiting a geofence as defined by structuredLocation.

pub unsafe fn setProximity(&self, proximity: EKAlarmProximity)

Available on crate feature EKTypes only.

Setter for proximity.

pub unsafe fn type(&self) -> EKAlarmType

Available on crate feature EKTypes only.

The type of alarm, based on the action taken when triggering the alarm.

This field is read-only; to change the type of alarm, set emailAddress for EKAlarmTypeEmail, soundName for EKAlarmTypeAudio or url for EKAlarmTypeProcedure. Setting all of those to nil will change it to EKAlarmTypeDisplay.

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

An email address that is the recipient of an email alarm, which is an alarm that triggers an email message.

When you set the emailAddress property, the action property is set to EKAlarmTypeEmail, and the soundName and url properties are set to nil.

pub unsafe fn setEmailAddress(&self, email_address: Option<&NSString>)

Setter for emailAddress.

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

The name of the sound to play when the alarm triggers.

The value of this property is the name of a system sound that can be used with the soundNamed: class method to create an NSSound object. When you set the soundName property, the action property is set to EKAlarmTypeAudio, and the emailAddress and url properties are set to nil.

pub unsafe fn setSoundName(&self, sound_name: Option<&NSString>)

Setter for soundName.

pub unsafe fn url(&self) -> Option<Retained<NSURL>>

👎Deprecated

The URL to open when the alarm triggers.

When you set the url property, the action property is set to EKAlarmTypeProcedure, and the emailAddress and soundName properties are set to nil. Note: Starting with OS X 10.9, it is not possible to create new procedure alarms or view URLs for existing procedure alarms. Trying to save or modify a procedure alarm will result in a save error. Editing other aspects of events or reminders that have existing procedure alarms is allowed as long as the alarm isn’t modified.

pub unsafe fn setUrl(&self, url: Option<&NSURL>)

👎Deprecated

Setter for url.

impl EKAlarm

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = EKObject>

pub unsafe fn hasChanges(&self) -> bool

pub unsafe fn isNew(&self) -> bool

pub unsafe fn reset(&self)

pub unsafe fn rollback(&self)

pub unsafe fn refresh(&self) -> bool

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 EKAlarm

fn as_ref(&self) -> &AnyObject

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

impl AsRef<EKAlarm> for EKAlarm

fn as_ref(&self) -> &Self

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

impl AsRef<EKObject> for EKAlarm

fn as_ref(&self) -> &EKObject

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

impl AsRef<NSObject> for EKAlarm

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for EKAlarm

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<EKObject> for EKAlarm

fn borrow(&self) -> &EKObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for EKAlarm

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for EKAlarm

const NAME: &'static str = "EKAlarm"

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

type Super = EKObject

The superclass of this class.

type ThreadKind = <<EKAlarm 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 CopyingHelper for EKAlarm

type Result = EKAlarm

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for EKAlarm

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

Formats the value using the given formatter.

impl Deref for EKAlarm

type Target = EKObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for EKAlarm

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 EKAlarm

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for EKAlarm

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for EKAlarm

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 EKAlarm

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 EKAlarm

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

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

impl DowncastTarget for EKAlarm

impl Eq for EKAlarm