db._svc.DataTriggerService

All functionality to respond to data-update events to DataTriggers.

Todo

this is really low-level functionality probably not suitable for published API

datatrigger.init()

Initialize datatrigger servce

Returns

Promise – resolving when init is complete

registerDataTrigger(key, bodId, beforeAfter, onCreate, onUpdate, onDelete, actionFn, priority)

Register a system-level trigger(triggers that are not DataTrigger business objects)

Arguments
  • key (string) – key under which to register

  • bodId (string) – id of BusinessObjectDef to which trigger applies; if null, applies globally

  • beforeAfter (string) – ‘before’ or ‘after’

  • onCreate (boolean) – trigger on create

  • onUpdate (boolean) – trigger on update

  • onDelete (boolean) – trigger on delete

  • actionFn (function) – function to invoke

  • priority (number) – relative priority

refreshDataTriggers()

Reload all DataTriggers from the database

Returns

Promise resolving when reload is complete

processBeforeCreate(modelObj, keyFilter, saveOptions)

Process triggers for pre-create

Arguments
  • modelObj (BusinessObject) – object for which to process triggers

  • keyFilter (string) – regular expression string; process only those triggers whose key matches

  • saveOptions (object) – object passed to save() function; injected into DataTriggers’ action function

Returns

Promise – resolves to: map of DataTrigger key to return/resolve value from respective action invication

processBeforeUpdate(modelObj, keyFilter, saveOptions)

Process triggers for pre-update

Arguments
  • modelObj (BusinessObject) – object for which to process triggers

  • keyFilter (string) – regular expression string; process only those triggers whose key matches

  • saveOptions (object) – object passed to save() function; injected into DataTriggers’ action function

Returns

Promise – resolves to: map of DataTrigger key to return/resolve value from respective action invication

processBeforeDelete(modelObj, keyFilter, saveOptions)

Process triggers for pre-delete

Arguments
  • modelObj (BusinessObject) – object for which to process triggers

  • keyFilter (string) – regular expression string; process only those triggers whose key matches

  • saveOptions (object) – object passed to save() function; injected into DataTriggers’ action function

Returns

Promise – resolves to: map of DataTrigger key to return/resolve value from respective action invication

processAfterCreate(modelObj, keyFilter, saveOptions)

Process triggers for post-create

Arguments
  • modelObj (BusinessObject) – object for which to process triggers

  • keyFilter (string) – regular expression string; process only those triggers whose key matches

  • saveOptions (object) – object passed to save() function; injected into DataTriggers’ action function

Returns

Promise – resolves to: map of DataTrigger key to return/resolve value from respective action invication

processAfterUpdate(modelObj, keyFilter, saveOptions)

Process triggers for post-update

Arguments
  • modelObj (BusinessObject) – object for which to process triggers

  • keyFilter (string) – regular expression string; process only those triggers whose key matches

  • saveOptions (object) – object passed to save() function; injected into DataTriggers’ action function

Returns

Promise – resolves to: map of DataTrigger key to return/resolve value from respective action invication

processAfterDelete(modelObj, keyFilter, saveOptions)

Process triggers for post-delete

Arguments
  • modelObj (BusinessObject) – object for which to process triggers

  • keyFilter (string) – regular expression string; process only those triggers whose key matches

  • saveOptions (object) – object passed to save() function; injected into DataTriggers’ action function

Returns

Promise – resolves to: map of DataTrigger key to return/resolve value from respective action invication