Events
Last updated
Last updated
Registering and triggering events
Remove all registered events
Register event listener for a specific plugin
Unregister event listener for a specific plugin.
Trigger an event of specified type with optional specified data
Deprecated
Use api.events.trigger()
instead, deprecated. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.DOCUMENT_CHANGED
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.DOCUMENT_CHANGED_EXTERNAL
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.DOCUMENT_REPLACED
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.DOCUMENT_SAVED
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.DOCUMENT_SAVE_FAILED
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.USERACTION_SAVE
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.USERACTION_CANCEL_SAVE
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.USERACTION_LOCK
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.USERACTION_UNLOCK
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with Event.ARTICLELANGUAGE_CHANGED
instead. Deprecated since 2018-11-20.
Deprecated
Use api.events.trigger()
with "document:startsaving"
instead. Deprecated since 2018-11-20.
Param
Type
Description
name
string
Required - The plugin which listens for the event.
eventType
string
Required - The event to listen for.
func
function
Required - Function to call when event is triggered.
Param
Type
Description
name
string
Required - The plugin which listens for the event.
eventType
string
Required - The event to stop listening for.
Param
Type
Default
Description
name
string
Required - Plugin name or originator of event
eventType
string
Required - Event type to trigger (mandatory)
data
object
Optional data structure to send with event