Interface UmbWorkspaceAction<ArgsMetaType>

interface UmbWorkspaceAction<ArgsMetaType = never> {
    args: UmbWorkspaceActionArgs;
    isDisabled: Observable<boolean>;
    destroy(): void;
    execute(): Promise<void>;
    getHref(): Promise<undefined | string>;
}

Type Parameters

ArgsMetaType = never

Hierarchy (View Summary, Expand)

UmbAction<UmbWorkspaceActionArgs<ArgsMetaType>>
- UmbWorkspaceAction
  - UmbWorkspaceActionDefaultKind

Implemented by

UmbWorkspaceActionBase

Index

Properties

args isDisabled

Methods

destroy execute getHref?

Properties

args

args: UmbWorkspaceActionArgs

isDisabled

isDisabled: Observable<boolean>

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/workspace/components/workspace-action/workspace-action.interface.ts:18

`Optional`getHref

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

Returns Promise<undefined | string>
- Defined in src/packages/core/workspace/components/workspace-action/workspace-action.interface.ts:12