Protected Readonly_dataProtected Optional_detailProtected Optional_getProtected Readonly_workspaceReadonlycontentReadonlycontentReadonlydataReadonlyentityReadonlyIS_ReadonlyIS_ReadonlyisReadonlyloadingOptional ReadonlymodalReadonlyparentReadonlyparentReadonlypersistedReadonlypublishingThe publishing repository for the document workspace.
ReadonlyreadReadonlyroutesReadonlysplitReadonlystructureReadonlytemplateReadonlyuniqueReadonlyurlsProtectedvalidationThe base validation context for the workspace. This ensures that at least one validation context is always present.
ReadonlyvaluesReadonlyvariantReadonlyvariantsReadonlyvariesReadonlyvariesReadonlyvariesReadonlyworkspaceProtected_checkProtected_closeProtected_createProtected_determineProtected_getCheck if there are unpersisted changes.
true if there are unpersisted changes.
Protected_handleProtected_performProtectedPerform the create or update of the content
Protected_runProtectedRun the mandatory validation for the save data
The data to validate
Protected_saveableProtected_scaffoldProtected_updateAppends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Optionaloptions: boolean | AddEventListenerOptionsAppends a validation context to the workspace.
Ask the server to validate the save data
The data to validate
The variant ids to validate
Get the data to save
The variant ids to save
{Promise
Callback method called when context is resolved.
Reference to the created Context Consumer Controller instance
OptionalblueprintUnique: stringCreate a data scaffold
The arguments to create the scaffold.
Optionalpreset?: Partial<DetailModelType>The data of the scaffold.
Deletes the entity.
The unique identifier of the entity to delete.
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
A Promise with the reference to the Context Api Instance
Get the entity type
The entity type
Get the name of a variant
OptionalvariantId: UmbVariantIdThe variant id
Get the current value of the property with the given alias and variantId.
The alias of the property
OptionalvariantId: UmbVariantIdThe variant id of the property
The value or undefined if not set or found.
Get the values of the content
Get the variant by the given variantId
The variant id
Get an observable for the name of a variant
OptionalvariantId: UmbVariantIdThe variant id
An Observable to observe from.
Optionalcallback: ObserverCallback<SpecificT>Callback method called when data is changed.
OptionalcontrollerAlias: null | UmbControllerAliasDefine 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.
Perform the create or update of the content
The variant ids to save
The data to save
Observe the property type
The id of the property
The alias of the property
OptionalvariantId: UmbVariantIdThe variant
The API instance to be exposed.
Reference to the created Context Provider Controller instance
Reload the workspace data
The promise of the reload
Removes the event listener in target's event listener list with the same type, callback, and options.
Optionaloptions: boolean | EventListenerOptionsRequest a submit of the workspace, in the case of Document Workspaces the validation does not need to be valid for this to be submitted.
a promise which resolves once it has been completed.
Run the mandatory validation for the save data
The data to validate
ProtectedsetSet the name of a variant
The name of the variant
OptionalvariantId: UmbVariantIdThe variant id
Set the value of the property with the given alias and variantId.
The alias of the property
The value to set
OptionalvariantId: UmbVariantIdThe variant id of the property
If a Workspace has multiple validation contexts, then this method can be overwritten to return the correct one.
Promise that resolves to void when the validation is complete.
Get the variant by the given variantId
The variant id
The data supplier for a Element Property Dataset