Global Client Events

Global events are used as triggers that execute different client scripts. These scripts may call various actions, for example, to open a created record. See SimpleEventBus for more information.

activityFeedCommentTabChanged

The event occurs after the comment tab in the Activity Feed widget has changed.

Return:

{
	previousTab: 'previous',
	currentTab: 'current',
	widgetInstanceId: '10000001',
}

Example:

SimpleEventBus.on('activityFeedCommentTabChanged', async (obj) => {
  const previousTab = obj.previousTab;
});

afterLoadBreadcrumbs

The event occurs after the breadcrumbs are loaded.

Return:

{
  'currentNode': {
    title: 'current Title',
    url: '/current',
  },
  'previousNode': {
    title: 'previous Title',
    url: '/previous',
  }
}

Example:

SimpleEventBus.on('afterLoadBreadcrumbs', async (obj) => {
  const backUrl = obj.previousNode.url; 
});

afterLoadWidgets

The event occurs when all widgets are loaded.

Return:

Example:

SimpleEventBus.on('afterLoadWidgets', async (obj) => {
  if (obj.name === 'active' && obj.isValid) {
    // do something
  }
});

afterSaveEvent

The event occurs after a form is saved.

Return:

{
  "payload": {
    "view": "Default",
    "tableName": "task",
    "recordId": "166307559406494736",
    "displayValue": ""
  },
  "result": "OK"
}

{
  "payload": {
    "errors": [...]
  },
  "result": "ERROR"
}

Example:

SimpleEventBus.on('afterSaveEvent', async (obj) => {
  const savedRecordId = obj.payload.recordId;
});

afterSaveAndGetUiActionsEvent

The event occurs after a form is saved and when the UI-actions are returned.

Return:

{
  "payload": {
    "view": "Default",
    "tableName": "task",
    "recordId": "166307559406494736",
    "displayValue": ""
  },
  "result": "OK"
}

{
  "payload": {
    "errors": [...]
  },
  "result": "ERROR"
}

Example:

SimpleEventBus.on('afterSaveAndGetUiActionsEvent', async (obj) => {
  const savedRecordId = obj.payload.recordId; 
});

afterValidation

The event occurs after the widget field validation. It is used in combination with the validation event.

Return:

{
  name: 'active',
  isValid: true,
}

Example:

SimpleEventBus.on('afterValidation', async (obj) => {
  if (obj.name === 'active' && obj.isValid) {
    // do something
  }
});

validation

The event calls the validation of fields. 

Return:

Example:

SimpleEventBus.emit('validation', fields);