ReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlyownerReadonlyownerReadonlyownerReadonlyownerReadonlyvariesReadonlyvariesThe 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 | AddEventListenerOptionsClone a container to a specific Content Type.
The container to clone, assuming it does not already exist on the given Content Type.
OptionaltoContentTypeUnique: stringThe content type to clone to.
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.
OptionalparentType: UmbPropertyContainerTypesGet an observable for the data type detail of a data type that is in use by this content type structure.
The unique identifier of the data type.
An observable that emits the data type detail or undefined.
Create the owner content type. Notice this is for a Content Type that is NOT already stored on the server.
The unique of the parent content type
OptionalsortOrder: numberOptionalpreset: Partial<T>The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
Ensure a container exists for a specific Content Type. Otherwise clone it.
The container to ensure exists on the given ContentType.
The content type to ensure the container for.
Get all property aliases for the content type including inherited and composed content types.
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.
Figure out if any of the Content Types has a Property.
Find a merged container that match the provided container id.
The id to find the merged container of.
Find a merged container that match the provided merged-container key.
The key to find the merged container of.
loadType will load the ContentType and all inherited and composed ContentTypes. This will give us all the structure for properties and containers.
The unique of the ContentType to load.
The id of the container to make unique
The new name to make unique
Find merged child containers that are children of the provided parent container ids. Notice this will find matching containers and include their child containers in this.
The type of the containers to find.
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.
Public methods for consuming structure:
The API instance to be exposed.
Reference to the created Context Provider Controller instance
Reload the owner content type.
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Optionaloptions: boolean | EventListenerOptionsSave the owner content type. Notice this is for a Content Type that is already stored on the server.
Sets the owner content type unique identifier without loading data. This is useful when you need to register the structure synchronously before async initialization.
The unique identifier to set.
setType will set the ContentType from already-fetched data and load all inherited and composed ContentTypes. This is useful when the content type has already been fetched (e.g., via bulk fetch) and you want to avoid re-fetching.
The ContentType to set.
Manages a structure of a Content Type and its properties and containers. This loads and merges the structures of the Content Type and its inherited and composed Content Types. To help manage the data, there is two helper classes: