Skip to main content

DomainAction

Defined in: js-api/src/domains-ui.ts:69

A declarative action offered for a domain row (see DomainObjectHandler.getRibbonActions) — the JS mirror of the Entity View ribbon icons. Only actions the current user may perform are returned, so a consumer renders the list as-is without any permission checks of its own.

Properties

PropertyTypeDescriptionDefined in
changesRow?booleanWhether running the action may have changed the row — what a list or a page reloads on. The platform's own actions (DomainObjectHandler.getRibbonActions) all declare it; a custom action that omits it is up to its consumer to classify.js-api/src/domains-ui.ts:77
icon?stringFontAwesome icon name, matching the platform ribbon ('pencil', 'trash-alt'...).js-api/src/domains-ui.ts:72
namestring-js-api/src/domains-ui.ts:70

Methods

run()

run(): any

Defined in: js-api/src/domains-ui.ts:78

Returns

any