The controller host providing this context.
ReadonlycollectionThe alias of the collection to render, e.g. Umb.Collection.Document.
Undefined means the host has no collection concept at all.
ReadonlycollectionThe resolved collection configuration, or undefined while it is loading and when no collection is configured.
ReadonlydataThe resolved configuration data type. Exposed so hosts can derive presentation of their own from it — a workspace view reads its icon and label from here — without that presentation concern moving into this context.
ReadonlydataThe data type configuring the collection, taken from the content type's collection reference. Undefined means no collection is configured.
ReadonlyhasWhether a collection should be rendered at all. True only once both a collection alias and a configuring data type are known.
ReadonlyuniqueThe entity the collection is scoped to. null is the root; undefined means there is no subject at all, which is
the case for a content type without a hierarchy.
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().
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.
Returns the resolved configuration data type.
The data type, or undefined while it is loading and when no collection is configured.
Returns the entity the collection is scoped to.
The unique of the entity, null for the root, or undefined when there is
no subject.
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. 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 | EventListenerOptionsSets the entity the collection is scoped to.
The unique of the entity, null for the root, or undefined when
there is no subject.
Resolves the configuration of a content collection, for any host that can say which collection it renders, which data type configures it and which entity it is scoped to.