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.
Creates a new item and returns the created item data.
The data to create the item with.
The API response containing the created item or an error.
Deletes an item by its ID. If connected to server events, the item is also removed from the cache.
The ID of the item to delete.
The API response containing an error if the deletion failed.
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
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.
An Observable to observe from.
Optionalcallback: ObserverCallback<SpecificT>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
Reads a single item by its ID. Uses the cache if connected to server events and the item is cached, otherwise fetches from the server. Deduplicates concurrent requests for the same ID using an in-flight request cache.
The ID of the item to read.
The API response containing the item or an error.
Reads multiple items by their IDs. Only available if a readMany function was provided in the constructor args. Deduplicates concurrent requests: if an ID is already being fetched by another concurrent readMany call, it waits for that request instead of re-fetching.
The IDs of the items to read
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Optionaloptions: boolean | EventListenerOptionsUpdates an existing item and returns the updated item data.
The ID of the item to update.
The data to update the item with.
The API response containing the updated item or an error.
This mixin enables a web-component to host controllers. This enables controllers to be added to the life cycle of this element.