Struct EKEvent

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

Available on crate features EKCalendarItem and EKEvent and EKObject only.

The EKEvent class represents an occurrence of an event.

See also Apple’s documentation

Implementations

impl EKEvent

pub unsafe fn eventWithEventStore( event_store: &EKEventStore, ) -> Retained<EKEvent>

Available on crate feature EKEventStore only.

Creates a new autoreleased event object.

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

A unique identifier for this event.

This identifier can be used to look the event up using [EKEventStore eventWithIdentifier:]. You can use this not only to simply fetch the event, but also to validate the event has not been deleted out from under you when you get an external change notification via the EKEventStore database changed notification. If eventWithIdentifier: returns nil, the event was deleted.

Please note that if you change the calendar of an event, this ID will likely change. It is currently also possible for the ID to change due to a sync operation. For example, if a user moved an event on a different client to another calendar, we’d see it as a completely new event here.

This may be nil for events that have not been saved.

pub unsafe fn isAllDay(&self) -> bool

Indicates this event is an ‘all day’ event.

pub unsafe fn setAllDay(&self, all_day: bool)

Setter for isAllDay.

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

The start date for the event.

This property represents the start date for this event. Floating events (such as all-day events) are currently always returned in the default time zone. ([NSTimeZone defaultTimeZone])

This will be nil for new events until you set it.

pub unsafe fn setStartDate(&self, start_date: Option<&NSDate>)

Setter for startDate.

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

The end date for the event.

This will be nil for new events until you set it.

pub unsafe fn setEndDate(&self, end_date: Option<&NSDate>)

Setter for endDate.

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 event. The getter for EKEvent’s location property just returns the structured location’s title. The setter for EKEvent’s location property is equivalent to [event setStructuredLocation:[EKStructuredLocation locationWithTitle:…]].

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

Available on crate feature EKStructuredLocation only.

Setter for structuredLocation.

pub unsafe fn compareStartDateWithEvent( &self, other: &EKEvent, ) -> NSComparisonResult

Comparison function you can pass to sort NSArrays of EKEvents by start date.

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

Available on crate feature EKParticipant only.

The organizer of this event, or nil.

pub unsafe fn availability(&self) -> EKEventAvailability

The availability setting for this event.

The availability setting is used by CalDAV and Exchange servers to indicate how the time should be treated for scheduling. If the calendar the event is currently in does not support event availability, EKEventAvailabilityNotSupported is returned.

pub unsafe fn setAvailability(&self, availability: EKEventAvailability)

Setter for availability.

pub unsafe fn status(&self) -> EKEventStatus

The status of the event.

While the status offers four different values in the EKEventStatus enumeration, in practice, the only actionable and reliable status is canceled. Any other status should be considered informational at best. You cannot set this property. If you wish to cancel an event, you should simply remove it using removeEvent:.

pub unsafe fn isDetached(&self) -> bool

Represents whether this event is detached from a recurring series.

If this EKEvent is an instance of a repeating event, and an attribute of this EKEvent has been changed from the default value generated by the repeating event, isDetached will return YES. If the EKEvent is unchanged from its default state, or is not a repeating event, isDetached returns NO.

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

The occurrence date of an event if it is part of a recurring series.

This is only set if the event is part of a recurring series. It returns the date on which this event was originally scheduled to occur. For occurrences that are unmodified from the recurring series, this is the same as the start date. This value will remain the same even if the event has been detached and its start date has changed. Floating events (such as all-day events) are currently returned in the default time zone. ([NSTimeZone defaultTimeZone])

This will be nil for new events until you set startDate.

pub unsafe fn refresh(&self) -> bool

Refreshes an event object to ensure it’s still valid.

When the database changes, your application is sent an EKEventStoreChangedNotification note. You should generally consider all EKEvent instances to be invalid as soon as you receive the notification. However, for events you truly care to keep around, you can call this method. It ensures the record is still valid by ensuring the event and start date are still valid. It also attempts to refresh all properties except those you might have modified. If this method returns NO, the record has been deleted or is otherwise invalid. You should not continue to use it. If it returns YES, all is still well, and the record is ready for continued use. You should only call this method on events that are more critical to keep around if possible, such as an event that is being actively edited, as this call is fairly heavyweight. Do not use it to refresh the entire selected range of events you might have had selected. It is mostly pointless anyway, as recurrence information may have changed.

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

Specifies the contact identifier of the person this event was created for.

This property is only valid for events in the built-in Birthdays calendar. It specifies the contact identifier (for use with the Contacts framework) of the person this event was created for. For any other type of event, this property returns nil.

pub unsafe fn birthdayPersonID(&self) -> NSInteger

Specifies the address book ID of the person this event was created for.

This property is only valid for events in the built-in Birthdays calendar. It specifies the Address Book ID of the person this event was created for. For any other type of event, this property returns -1.

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

👎Deprecated: Use birthdayContactIdentifier instead

Specifies the address book unique ID of the person this event was created for.

This property is only valid for events in the built-in Birthdays calendar. It specifies the Address Book unique ID of the person this event was created for. For any other type of event, this property returns nil.

impl EKEvent

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = EKCalendarItem>

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

This is now deprecated; use calendarItemIdentifier instead.

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.

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

Available on crate feature EKCalendar only.

Setter for calendar.

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.

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

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.

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

Setter for title.

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

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

Setter for location.

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

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

Setter for notes.

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

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

Setter for URL.

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

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

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

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

Setter for timeZone.

pub unsafe fn hasAlarms(&self) -> bool

pub unsafe fn hasRecurrenceRules(&self) -> bool

pub unsafe fn hasAttendees(&self) -> bool

pub unsafe fn hasNotes(&self) -> bool

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

Available on crate feature EKParticipant only.

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

Available on crate feature EKAlarm only.

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

Available on crate feature EKAlarm only.

Setter for alarms.

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.

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

Available on crate feature EKAlarm only.

Removes an alarm from this item.

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

Available on crate feature EKRecurrenceRule only.

An array of EKRecurrenceRules, or nil if none.

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

Available on crate feature EKRecurrenceRule only.

Setter for recurrenceRules.

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

Available on crate feature EKRecurrenceRule only.

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

Available on crate feature EKRecurrenceRule only.

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 EKEvent

fn as_ref(&self) -> &AnyObject

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

impl AsRef<EKCalendarItem> for EKEvent

fn as_ref(&self) -> &EKCalendarItem

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

impl AsRef<EKEvent> for EKEvent

fn as_ref(&self) -> &Self

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

impl AsRef<EKObject> for EKEvent

fn as_ref(&self) -> &EKObject

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

impl AsRef<NSObject> for EKEvent

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for EKEvent

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<EKCalendarItem> for EKEvent

fn borrow(&self) -> &EKCalendarItem

Immutably borrows from an owned value.

impl Borrow<EKObject> for EKEvent

fn borrow(&self) -> &EKObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for EKEvent

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for EKEvent

const NAME: &'static str = "EKEvent"

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

type Super = EKCalendarItem

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for EKEvent

type Target = EKCalendarItem

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for EKEvent

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 EKEvent

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for EKEvent

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 EKEvent

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 EKEvent

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

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

impl DowncastTarget for EKEvent

impl Eq for EKEvent