Interface UmbEntityAction<ArgsMetaType>

Interface for an entity action. UmbEntityAction

interface UmbEntityAction<ArgsMetaType> {
    args: UmbEntityActionArgs<ArgsMetaType>;
    destroy(): void;
    execute(): Promise<void>;
    getHref(): Promise<undefined | string>;
}

Type Parameters

ArgsMetaType

Hierarchy (view full)

UmbAction<UmbEntityActionArgs<ArgsMetaType>>
- UmbEntityAction

Implemented by

UmbEntityActionBase

Index

Properties

Methods

destroy execute getHref

Properties

args

args: UmbEntityActionArgs<ArgsMetaType>

Methods

destroy

destroy(): void
Returns void
Inherited from UmbAction.destroy
- Defined in src/libs/extension-api/models/api.interface.ts:2

execute

execute(): Promise<void>
The execute method, the action will act as a button.

Returns Promise<void>
Overrides UmbAction.execute
- Defined in src/packages/core/entity-action/entity-action.interface.ts:19

getHref

getHref(): Promise<undefined | string>
The href location, the action will act as a link.

Returns Promise<undefined | string>
- Defined in src/packages/core/entity-action/entity-action.interface.ts:13