Instance Method

remove(_:span:commit:)

Removes an event or recurring events from the event store by either batching or committing the changes.

Declaration

func remove(_ event: EKEvent, span: EKSpan, commit: Bool) throws

Parameters

event

The event to remove.

span

The span to use. Indicates whether the remove affects future instances of the event in the case of a recurring event.

commit

true to remove the event immediately; otherwise, the change is batched until the commit() method is invoked.

error

The error that occurred, if any did. Otherwise, nil.

Return Value

If the event has successfully removed, true; otherwise, false. Also returns false if event cannot be removed because it is not in the event store.

Discussion

This method raises an exception if it is passed an event from another event store.

See Also

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software