Struct EKCalendarItem

Source

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

Available on crate features EKCalendarItem and EKObject only.

Expand description

Apple’s documentation

Implementations§

Source §

impl EKCalendarItem

Source

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

This is now deprecated; use calendarItemIdentifier instead.

Source

pub unsafe fn calendar(&self) -> Option<Retained<EKCalendar>>

Available on crate feature EKCalendar only.

The calendar that this calendar item belongs to.

This will be nil for new calendar items until you set it.

Source

pub unsafe fn setCalendar(&self, calendar: Option<&EKCalendar>)

Available on crate feature EKCalendar only.

Setter for calendar.

Source

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

A unique identifier for a calendar item.

Item identifiers are not sync-proof in that a full sync will lose this identifier, so you should always have a back up plan for dealing with a reminder that is no longer fetchable by this property, e.g. by title, etc. Use [EKEventStore calendarItemWithIdentifier:] to look up the item by this value.

Source

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

A server-provided identifier for this calendar item

This identifier, provided by the server, allows you to reference the same event or reminder across multiple devices. For calendars stored locally on the device, including the birthday calendar, it simply passes through to calendarItemIdentifier.

This identifier is unique as of creation for every calendar item. However, there are some cases where duplicate copies of a calendar item can exist in the same database, including:

A calendar item was imported from an ICS file into multiple calendars
An event was created in a calendar shared with the user and the user was also invited to the event
The user is a delegate of a calendar that also has this event
A subscribed calendar was added to multiple accounts In such cases, you should choose between calendar items based on other factors, such as the calendar or source.

This identifier is the same for all occurrences of a recurring event. If you wish to differentiate between occurrences, you may want to use the start date.

This may be nil for new calendar items that do not yet belong to a calendar.

In addition, there are two caveats for Exchange-based calendars:

This identifier will be different between EventKit on iOS versus OS X
This identifier will be different between devices for EKReminders

Source

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

The title of this calendar item.

This will be an empty string for new calendar items until you set it.

Source

pub unsafe fn setTitle(&self, title: Option<&NSString>)

Setter for title.

Source

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

Source

pub unsafe fn setLocation(&self, location: Option<&NSString>)

Setter for location.

Source

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

Source

pub unsafe fn setNotes(&self, notes: Option<&NSString>)

Setter for notes.

Source

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

Source

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

Setter for URL.

Source

pub unsafe fn setTimeZone(&self, time_zone: Option<&NSTimeZone>)

Setter for timeZone.

Source

pub unsafe fn hasAlarms(&self) -> bool

Source

pub unsafe fn hasRecurrenceRules(&self) -> bool

Source

pub unsafe fn hasAttendees(&self) -> bool

Source

pub unsafe fn hasNotes(&self) -> bool

Source

pub unsafe fn attendees(&self) -> Option<Retained<NSArray<EKParticipant>>>

Available on crate feature EKParticipant only.

Source

pub unsafe fn alarms(&self) -> Option<Retained<NSArray<EKAlarm>>>

Available on crate feature EKAlarm only.

Source

pub unsafe fn setAlarms(&self, alarms: Option<&NSArray<EKAlarm>>)

Available on crate feature EKAlarm only.

Setter for alarms.

Source

pub unsafe fn addAlarm(&self, alarm: &EKAlarm)

Available on crate feature EKAlarm only.

Adds an alarm to this item.

This method add an alarm to an item. Be warned that some calendars can only allow a certain maximum number of alarms. When this item is saved, it will truncate any extra alarms from the array.

Source

pub unsafe fn removeAlarm(&self, alarm: &EKAlarm)

Available on crate feature EKAlarm only.

Removes an alarm from this item.

Source

pub unsafe fn recurrenceRules( &self, ) -> Option<Retained<NSArray<EKRecurrenceRule>>>

Available on crate feature EKRecurrenceRule only.

An array of EKRecurrenceRules, or nil if none.

Source

pub unsafe fn setRecurrenceRules( &self, recurrence_rules: Option<&NSArray<EKRecurrenceRule>>, )

Available on crate feature EKRecurrenceRule only.

Setter for recurrenceRules.

Source

pub unsafe fn addRecurrenceRule(&self, rule: &EKRecurrenceRule)

Available on crate feature EKRecurrenceRule only.

Source

pub unsafe fn removeRecurrenceRule(&self, rule: &EKRecurrenceRule)

Available on crate feature EKRecurrenceRule only.

Source §

impl EKCalendarItem

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = EKObject>§

Source

pub unsafe fn hasChanges(&self) -> bool

Source

pub unsafe fn isNew(&self) -> bool

Source

pub unsafe fn reset(&self)

Source

pub unsafe fn rollback(&self)

Source

pub unsafe fn refresh(&self) -> bool

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