Instance Method

removeEvent:span:commit:error:

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

Declaration

- (BOOL)removeEvent:(EKEvent *)event span:(EKSpan)span commit:(BOOL)commit error:(NSError * _Nullable *)error;

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

YES 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, YES; otherwise, NO. Also returns NO 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