formData.registerEvent

(FintechOS Platform 24.2 and later)

Defines a custom event and event handler. Custom events are user-defined events (as opposed to the events built into the programming language) that can be triggered programatically using the formData.notify function.

Syntax

Copy

formData.registerEvent(eventName: string, handler: function): any

Parameter	Description
`eventName`	Name of the custom event.
`handler`	Event handler's callback function.

You can define multiple handlers for the same custom event by storing the formData.registerEvent definitions in variables. This way, when you trigger the event (via the formData.notify function), all handlers' callback functions are executed.

Copy

var firstHandler = formData.registerEvent('myCustomEvent', firstFunction);
var secondHandler = formData.registerEvent('myCustomEvent', secondFunction);
var thirdHandler = formData.registerEvent('myCustomEvent', thirdFunction);

Use the dispose() method to remove such event handlers.

Copy

firstHandler.dispose();
secondHandler.dispose();
thirdHandler.dispose();

Examples

Create a custom event handler that logs an individual's name and age

In this example, we define a handler that logs the name and age properties of a payload object in the browser console when a custom event called myCustomEvent is triggered.

Copy

formData.registerEvent('myCustomEvent', function(payload){
  console.log('Hello ' + payload.name + '! You are ' + payload.age + ' years old.');
});

Copy

var customEventName= 'myCustomEvent';

function onMyCustomEvent(payload){
  console.log('Hello ' + payload.name + '! You are ' + payload.age + ' years old.');
}

formData.registerEvent(customEventName, onMyCustomEvent);

Copy

var customEventName= 'myCustomEvent';

var onMyCustomEvent = function(payload){
  console.log('Hello ' + payload.name + '! You are ' + payload.age + ' years old.');
}

formData.registerEvent(customEventName, onMyCustomEvent);

Create a two distinct event handlers that log an individual's name and age on the same custom event

In this example, we define two handlers called nameHandler and ageHandler that log the name and age properties of a payload object in the browser console when a custom event called myCustomEvent is triggered.

Copy

var customEventName= 'myCustomEvent';

var displayName = function(payload){
  console.log('Hello ' + payload.name + '.');
}
var displayAge = function(payload){
  console.log('You are ' + payload.age + ' years old.');
}

var nameHandler = formData.registerEvent(customEventName, displayName);
var ageHandler = formData.registerEvent(customEventName, displayAge);