Skip to content

Listeners

Document events

js
const eventHandler = () => console.log('[create] triggered.')
document.on('create', eventHandler)
NameTrigger
createDocument was created
updateDocument was updated
removeDocument was removed
sendDocument was sent
saveCombined event for create/update
formUpdateDocument form was updated
watchDocument received an update from the server via WebSocket (Widget needs option socket: { enabled: true } for "watch" to work)
beforeSaveBefore save request is made. Can abort operation by returning true in event handler.
beforeSendBefore send request is made. Can abort operation by returning true in event handler.
beforeUpdateFormBefore the document is edited. This includes changes to recipients.

UI events

js
const eventHandler = () => console.log('[create] triggered.')
document.ui.on('create', eventHandler)
NameTrigger
openView was opened
closeView was closed

Unregister listeners

All listeners returns a function which unregisters the listener

js
const unregisterListenerFunc = document.ui.on('close', () => {
  console.log('[close] triggered.')
})

unregisterListenerFunc()