EditService<TEvent>
A service which is used by the reactive and template editing directives of the Scheduler. Used to persist the changes which are applied during editing.
Methods
create
Creates a new event.
Parameters
event
TEvent
The event that will be created.
createException
Creates an exception to an existing recurring event. The recurrenceId
field of the recurrence exception
or the custom field that is set by the model map will point to the master recurring event.
Parameters
event
TEvent
The instance of the occurrence that will be removed from the series.
value
any
An object which contains the updated field values, for example, a form group value.
findRecurrenceMaster
Returns the master recurring event for a specified recurring event.
Parameters
event
TEvent
An event from the recurrence series.
Returns
TEvent
the master recurring event for the series.
isException
Checks if the event is a recurrence exception.
Parameters
event
TEvent
The event that will be checked.
Returns
boolean
true
if the event is a unique event which belongs to a recurrence series. Otherwise, returns false
.
isRecurring
Checks if the event is part of the recurrence series.
Parameters
event
TEvent
The event that will be checked.
Returns
boolean
true
if the event is an occurrence, an exception, or a master event. Otherwise, returns false
.
remove
Removes a non-recurring event.
Parameters
event
TEvent
A reference to the event that will be removed.
removeOccurrence
Removes a single occurrence from a series of recurring events. The recurrenceId
field of the occurrence
or the custom field which is set by a model map will point to the master recurring event.
Parameters
event
TEvent
A reference to the occurrence.
removeSeries
Removes the recurrence series and exceptions, if any.
Parameters
event
TEvent
Any event from the recurrence series.
update
Updates the specified event by copying the changed fields from the supplied value
object.
Parameters
event
TEvent
The event that will be updated.
value
any
An object which contains the new field values, for example, a form group value.