Skip to main content

EntityActionHandlerComponent

Extends

Constructors

Constructor

new EntityActionHandlerComponent(actionID, options?): EntityActionHandlerComponent;

Parameters

ParameterType
actionIDstring
optionsEntityHandlerComponentOptions

Returns

EntityActionHandlerComponent

Overrides

EntityHandlerComponent.constructor

Properties

PropertyModifierTypeDefault valueInherited from
definitionpublicEntityDefinitionundefinedEntityHandlerComponent.definition
preferredreadonlybooleanundefinedEntityHandlerComponent.preferred
typepublicstringundefinedEntityHandlerComponent.type
uuidpublicstringundefinedEntityHandlerComponent.uuid
TYPEstaticstring'handler'EntityHandlerComponent.TYPE

Accessors

system

Get Signature

get system(): System;
Returns

System

Inherited from

EntityHandlerComponent.system

Methods

getDescription()

getDescription(): ComboBoxItem;

Returns

ComboBoxItem

Overrides

EntityHandlerComponent.getDescription


getPreferredActionId()

getPreferredActionId(): string;

Returns

string

Overrides

EntityHandlerComponent.getPreferredActionId


openEntity()

openEntity(event): Promise<boolean>;

Parameters

ParameterType
eventany

Returns

Promise<boolean>

Overrides

EntityHandlerComponent.openEntity


setDefinition()

setDefinition(definition): void;

Parameters

ParameterType
definitionEntityDefinition

Returns

void

Inherited from

EntityHandlerComponent.setDefinition