OptionalcontrollerAlias: UmbControllerAliasInternalThe OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.
InternalInterceptor which checks responses for 500 errors and displays them as a notification if any.
The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.
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 | AddEventListenerOptionsInternalInterceptor which checks responses for 403 errors and displays them as a notification.
The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.
InternalInterceptor which checks responses for the Umb-Generated-Resource header and replaces the value into the response body.
The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.
InternalInterceptor which checks responses for the umb-notifications header and displays them as a notification if any. Removes the umb-notifications from the headers.
The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.
Binds the default interceptors to the client. This includes the auth response interceptor, the error interceptor and the umb-notifications interceptor.
The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.
Callback 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().
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.
InternalObserves the auth signaler's authorization state to retry GET-requests that received a 401 Unauthorized response. Also notifies the user about non-GET requests that received a 401 Unauthorized response after re-authentication completes.
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 | EventListenerOptions
Interceptor which checks responses for 401 errors and signals the auth layer to show the login UI.