ReadonlyallowedReadonlyavatarReadonlycurrentReadonlydocumentReadonlyemailReadonlyfallbackReadonlyhasReadonlyhasReadonlyhasReadonlyhasReadonlyisReadonlylanguageReadonlylanguagesReadonlymediaReadonlynameReadonlypermissionsReadonlyuniqueReadonlyuserThe 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.
Get the allowed sections for the current user
The allowed sections for the current user
Get the avatar urls for the current user
The avatar urls for the current user
Optionaloptions: UmbClassGetContextOptions
Options 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.
Get the document start node uniques for the current user
The document start node uniques for the current user
Get the email for the current user
The email for the current user
Get the fallback permissions for the current user
The fallback permissions for the current user
Get if the current user has access to all languages
True if the current user has access to all languages, otherwise false
Get if the current user has access to sensitive data
True if the current user has access to sensitive data, otherwise false
Get if the current user has document root access
True if the current user has document root access, otherwise false
Get if the current user has media root access
True if the current user has media root access, otherwise false
Get if the current user is an admin
True if the current user is an admin, otherwise false
Get the language iso code for the current user
The language iso code for the current user
Get the languages for the current user
The languages for the current user
Get the media start node uniques for the current user
The media start node uniques for the current user
Get the name for the current user
The name for the current user
Get the permissions for the current user
The permissions for the current user
Get the unique for the current user
The unique for the current user
Get the user name for the current user
The user name for the current user
Invalidates the loaded current user, so that the next call to load fetches it from the server again. Call this when the loaded user can no longer be trusted, e.g. when authorization is lost — a subsequent sign-in may be for a different user.
The #currentUser state is deliberately NOT cleared here. The backoffice stays mounted behind
the login overlay during a session timeout, and several consumers observe the unfiltered observable
parts (e.g. recycle-bin conditions, sensitive-data property gating, language read-only checks) without
guarding against undefined — clearing would tear down or read-only-flip open workspaces mid-edit for
the common case of the same user signing back in. Consumers of the filtered currentUser
observable hold their last value until the fresh user has been fetched and then re-evaluate.
Checks if the current user is an admin.
True if the current user is an admin, otherwise false
Checks if a user is the current user.
The user id to check
True if the user is the current user, otherwise false
Loads the current user. Concurrent callers share the same in-flight promise,
so awaiting load() always waits for #currentUser to be populated.
Resolves once the current user observable has emitted.
An Observable to observe from.
Optionalcallback: ObserverCallback<UmbObserverValueType<ObservableType>>
Callback method called when data is changed.
OptionalcontrollerAlias: UmbControllerAlias | null
Define 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.
Optionaloptions: boolean | EventListenerOptions
This base provides the necessary for a class to become a context-api controller.