Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


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

Component Version macOS Windows Linux Server iOS SDK
Events 6.2 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes
MBS( "Events.Event.Refresh"; EKEvent )   More


Parameter Description Example
EKEvent The reference to the event. $event


Returns 1, 0 or error.


Refreshes an event object to ensure it's still valid.
When the database changes, your application is sent an notification note and the plugin may trigger the notification script. You should generally consider all event 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 0, the record has been deleted or is otherwise invalid. You should not continue to use it. If it returns 1, 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.

See also

This function checks for a license.

Created 10th March 2016, last changed 12nd March 2016

Events.Event.OccurrenceDate - Events.Event.SetAllDay