AbstractProtected_Protected Optional_OptionalisEmits true while execute() is performing real work (e.g. after a
preceding modal/dialog has been confirmed) and false otherwise.
Consumers (such as the workspace action element) use this to show in-flight UI - e.g. a button spinner - only while work is actually happening, not while a user is interacting with a modal.
Optional; when not exposed, consumers fall back to assuming work
begins immediately on execute().
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Optionaloptions: boolean | AddEventListenerOptionsCallback method called with the resolved context instance or undefined.
Reference to the created Context Consumer Controller instance
Subscribe to a context. The callback fires when the context resolves, again if the context is replaced, and can also be invoked with undefined if the context is unprovided or the host disconnects. Use this whenever a controller or element needs the context at setup time — both for ongoing observation and for reading values immediately on resolve. This is the default choice; prefer it over getContext unless the context is only needed inside a later user action.
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
AbstractexecuteBy specifying the execute method, the action will act as a button.
Optionaloptions: UmbClassGetContextOptionsOptions for resolving the context once, including timeout-related behavior such as preventTimeout.
A Promise resolving to the Context API instance when available, or undefined when applicable.
Retrieve a context once as a Promise. Use this only when the context is first needed inside a user action or event handler that runs later (for example a button click, a property action, or an entity action execute()). For setup-time access — including a single immediate read — use consumeContext instead so the controller lifecycle handles resolution and cleanup. The returned Promise may reject if the context is not found before the default timeout; callers should handle rejection and/or pass preventTimeout in the options when waiting longer is expected.
AbstractgetBy specifying the href, the action will act as a link.
The execute method will not be called.
An Observable to observe from.
Optionalcallback: ObserverCallback<UmbObserverValueType<ObservableType>>Callback method called when data is changed.
OptionalcontrollerAlias: UmbControllerAlias | nullDefine an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Reference to the created Observer Controller instance.
The API instance to be exposed.
Reference to the created Context Provider Controller instance
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Optionaloptions: boolean | EventListenerOptionsProtectedsetSignals whether execute() is currently performing real work. Subclasses
that opt in to modal-aware execution feedback should:
this.setExecuting(false) in their constructor so isExecuting
is exposed before the workspace-action element observes it.this.setExecuting(true) once any preceding modal has been
confirmed and real work is about to begin.try/finally and call this.setExecuting(false) on
completion so the observable honours its contract.Subclasses that never call this method keep isExecuting undefined,
which signals consumers to fall back to legacy eager-feedback behaviour.
true while real work is in flight; false otherwise.
Base class for an workspace action.
UmbWorkspaceActionBase
Implements
Template: RepositoryType