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.

activityFeedCommentTabChanged

---

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

Return:

Type	Description
Object	This event returns a widget with the previous value and the current value of the tabs.

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

Example:

on

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

afterLoadBreadcrumbs

---

The event occurs after the breadcrumbs are loaded.

Return:

Type	Description
Object	This event returns node URLs.

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

Example:

on

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

afterLoadWidgets

---

The event occurs when all widgets are loaded.

Return:

Type	Description
Boolean	The event returns a boolean value (true or false).

Example:

on

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

afterSaveEvent

---

The event occurs after a form is saved.

Return:

Type	Description
Object	This event returns a form object or an error.

Object

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

Error

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

Example:

on

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:

Type	Description
Object	This event returns a form object or an error.

Object

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

Error

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

Example:

on

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:

Type	Description
Boolean	The event returns a boolean value (true or false).

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

Example:

on

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

validation

---

The event calls the validation of fields.

Return:

Type	Description
List of fields	The event returns the list of fields.

Example:

on

SimpleEventBus.emit('validation', fields);

See SimpleEventBus for more information.