Class UmbDocumentWorkspaceContext

The data supplier for a Element Property Dataset

Hierarchy (View Summary)

UmbContentDetailWorkspaceContextBase<
    ContentModel,
    UmbDocumentDetailRepository,
    ContentTypeModel,
    UmbDocumentVariantModel,
>
- UmbDocumentWorkspaceContext

Implements

UmbContentWorkspaceContext<
    ContentModel,
    ContentTypeModel,
    UmbDocumentVariantModel,
>
UmbPublishableWorkspaceContext

Index

Constructors

constructor

new UmbDocumentWorkspaceContext(
host: UmbControllerHost,
): UmbDocumentWorkspaceContext
Parameters
- host: UmbControllerHost
Returns UmbDocumentWorkspaceContext
Overrides UmbContentDetailWorkspaceContextBase.constructor
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:79

Properties

`Protected` `Readonly`_data

_data: UmbContentWorkspaceDataManager<
UmbDocumentDetailModel,
UmbDocumentVariantModel,
> = ...

Description

Data manager for the workspace.

Memberof

UmbEntityWorkspaceContextBase

`Protected` `Optional`_detailRepository

_detailRepository?: UmbDocumentDetailRepository

`Protected` `Optional`_getDataPromise

_getDataPromise?: Promise<
    | UmbRepositoryResponse<UmbDocumentDetailModel>
    | UmbRepositoryResponseWithAsObservable<
        UmbDocumentDetailModel,
        UmbDocumentDetailModel,
    >,
>

_host

_host: UmbControllerHost

`Readonly`_internal_createUnderParent

_internal_createUnderParent: Observable<undefined | UmbEntityModel> = ...

The parent entity that the new entity will be created under. Internal property. Use UMB_PARENT_ENTITY_CONTEXT to get the parent entity.

`Readonly`_internal_createUnderParentEntityType

_internal_createUnderParentEntityType: Observable<undefined | string> = ...

The entity type that the new entity will be created under. Internal property. Use UMB_PARENT_ENTITY_CONTEXT to get the parent entity.

`Readonly`_internal_createUnderParentEntityUnique

_internal_createUnderParentEntityUnique: Observable<undefined | UmbEntityUnique> = ...

The entity unique that the new entity will be created under. Internal property. Use UMB_PARENT_ENTITY_CONTEXT to get the parent entity.

`Protected` `Readonly`_segments

_segments: Observable<UmbSegmentCollectionItemModel[]> = ...

`Protected` `Readonly`_workspaceEventUnique

_workspaceEventUnique: string = ...

`Readonly`collection

collection: UmbContentCollectionManager

`Readonly`contentTypeHasCollection

contentTypeHasCollection: Observable<boolean> = ...

`Readonly`contentTypeIcon

contentTypeIcon: Observable<null | string> = ...

`Readonly`contentTypeUnique

contentTypeUnique: Observable<undefined | string> = ...

`Readonly`data

data: Observable<undefined | UmbDocumentDetailModel> = ...

`Readonly`entityType

entityType: Observable<undefined | string> = ...

`Readonly`forbidden

forbidden: UmbStateManager<UmbState> = ...

`Readonly`IS_CONTENT_WORKSPACE_CONTEXT

IS_CONTENT_WORKSPACE_CONTEXT: true = ...

`Readonly`IS_ENTITY_DETAIL_WORKSPACE_CONTEXT

IS_ENTITY_DETAIL_WORKSPACE_CONTEXT: true

isNew

isNew: Observable<undefined | boolean> = ...

`Readonly`isTrashed

isTrashed: Observable<undefined | boolean> = ...

`Readonly`loading

loading: UmbStateManager<UmbState> = ...

`Optional` `Readonly`modalContext

modalContext?: UmbModalContext<{ preset: object }, any>

`Readonly`parentEntityType

parentEntityType: Observable<undefined | string> = ...

Deprecated

Will be removed in v.18: Use UMB_PARENT_ENTITY_CONTEXT instead to get the parent both when creating and editing.

`Readonly`parentUnique

parentUnique: Observable<undefined | UmbEntityUnique> = ...

Deprecated

Will be removed in v.18: Use UMB_PARENT_ENTITY_CONTEXT instead to get the parent both when creating and editing.

`Readonly`persistedData

persistedData: Observable<undefined | UmbDocumentDetailModel> = ...

`Readonly`propertyViewGuard

propertyViewGuard: UmbVariantPropertyGuardManager = ...

`Readonly`propertyWriteGuard

propertyWriteGuard: UmbVariantPropertyGuardManager = ...

`Readonly`publishingRepository

publishingRepository: UmbDocumentPublishingRepository = ...

The publishing repository for the document workspace.

Deprecated

Will be removed in v17. Use the methods on the UMB_DOCUMENT_PUBLISHING_WORKSPACE_CONTEXT instead.

Memberof

UmbDocumentWorkspaceContext

`Readonly`readOnlyGuard

readOnlyGuard: UmbReadOnlyVariantGuardManager = ...

`Readonly`routes

routes: UmbWorkspaceRouteManager = ...

`Readonly`splitView

splitView: UmbWorkspaceSplitViewManager = ...

`Readonly`structure

structure: UmbContentTypeStructureManager<UmbDocumentTypeDetailModel>

`Readonly`templateId

templateId: Observable<null | string> = ...

`Readonly`unique

unique: Observable<UmbEntityUnique> = ...

`Protected`validationContext

validationContext: UmbValidationContext = ...

The base validation context for the workspace. This ensures that at least one validation context is always present.

Example: You can manually validate all properties on the context:

try {
  await this.validationContext.validate();
} catch (error) {
  console.error(error);
}

Example: You can set the data path on the context to map to a specific part of the server validation:

this.validationContext.setDataPath('path.to.data');

`Readonly`values

values: Observable<undefined | UmbElementValueModel<unknown>[]> = ...

`Readonly`variantOptions

variantOptions: Observable<
UmbEntityVariantOptionModel<UmbDocumentVariantModel>[],
>

`Readonly`variants

variants: Observable<UmbDocumentVariantModel[]> = ...

`Readonly`varies

varies: Observable<undefined | boolean>

`Readonly`variesByCulture

variesByCulture: Observable<undefined | boolean>

`Readonly`variesBySegment

variesBySegment: Observable<undefined | boolean>

`Readonly`view

view: UmbViewContext = ...

`Readonly`workspaceAlias

workspaceAlias: string

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbContentDetailWorkspaceContextBase.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

Methods

`Protected`_checkWillNavigateAway

_checkWillNavigateAway(newUrl: string): boolean
Protected
Check if the workspace is about to navigate away.
Parameters
- newUrl: string
  The new url that the workspace is navigating to.
Returns boolean
true if the workspace is navigating away.

Memberof
UmbEntityWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase._checkWillNavigateAway
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:372

`Protected`_closeModal

_closeModal(): void
Returns void
Inherited from UmbContentDetailWorkspaceContextBase._closeModal
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:160

`Protected`_create

_create(
currentData: UmbDocumentDetailModel,
parent: UmbEntityModel,
): Promise<void>
Parameters
- currentData: UmbDocumentDetailModel
- parent: UmbEntityModel
Returns Promise<void>
Inherited from UmbContentDetailWorkspaceContextBase._create
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:376

`Protected`_determineVariantOptions

_determineVariantOptions(): Promise<
    {
        options: UmbEntityVariantOptionModel<UmbDocumentVariantModel>[];
        selected: string[];
    },
>
Returns Promise<
    {
        options: UmbEntityVariantOptionModel<UmbDocumentVariantModel>[];
        selected: string[];
    },
>
Inherited from UmbContentDetailWorkspaceContextBase._determineVariantOptions
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:698

`Protected`_getHasUnpersistedChanges

_getHasUnpersistedChanges(): boolean
Returns boolean
Inherited from UmbContentDetailWorkspaceContextBase._getHasUnpersistedChanges
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:472

`Protected`_handleSave

_handleSave(): Promise<void>
Returns Promise<void>
Overrides UmbContentDetailWorkspaceContextBase._handleSave
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:287

`Protected`_handleSubmit

_handleSubmit(): Promise<void>
Returns Promise<void>
Inherited from UmbContentDetailWorkspaceContextBase._handleSubmit
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:850

_internal_getCreateUnderParent

_internal_getCreateUnderParent(): undefined | UmbEntityModel
Gets the parent that a new entity will be created under.

Returns undefined | UmbEntityModel
The parent entity
Inherited from UmbContentDetailWorkspaceContextBase._internal_getCreateUnderParent
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:184

_internal_setCreateUnderParent

_internal_setCreateUnderParent(parent: UmbEntityModel): void
Sets the parent that a new entity will be created under.
Parameters
- parent: UmbEntityModel
  The parent entity
Returns void
Inherited from UmbContentDetailWorkspaceContextBase._internal_setCreateUnderParent
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:193

`Protected`_performCreateOrUpdate

_performCreateOrUpdate(
variantIds: UmbVariantId[],
saveData: UmbDocumentDetailModel,
): Promise<void>
Protected
Perform the create or update of the content
Parameters
- variantIds: UmbVariantId[]
- saveData: UmbDocumentDetailModel
Returns Promise<void>
Deprecated
Use the public performCreateOrUpdate instead. Will be removed in v. 17.

Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase._performCreateOrUpdate
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:919

`Protected`_runMandatoryValidationForSaveData

_runMandatoryValidationForSaveData(
saveData: UmbDocumentDetailModel,
variantIds?: UmbVariantId[],
): Promise<void>
Protected
Run the mandatory validation for the save data
Parameters
- saveData: UmbDocumentDetailModel
  The data to validate
- variantIds: UmbVariantId[] = []
Returns Promise<void>
Deprecated
Use the public runMandatoryValidationForSaveData instead. Will be removed in v. 17.

Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase._runMandatoryValidationForSaveData
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:745

`Protected`_saveableVariantsFilter

_saveableVariantsFilter(option: UmbEntityVariantOptionModel): boolean
Parameters
- option: UmbEntityVariantOptionModel
Returns boolean
Inherited from UmbContentDetailWorkspaceContextBase._saveableVariantsFilter
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:733

`Protected`_scaffoldProcessData

_scaffoldProcessData(
data: UmbDocumentDetailModel,
): Promise<UmbDocumentDetailModel>
Parameters
- data: UmbDocumentDetailModel
Returns Promise<UmbDocumentDetailModel>
Inherited from UmbContentDetailWorkspaceContextBase._scaffoldProcessData
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:395

`Protected`_update

_update(currentData: UmbDocumentDetailModel): Promise<void>
Parameters
- currentData: UmbDocumentDetailModel
Returns Promise<void>
Inherited from UmbContentDetailWorkspaceContextBase._update
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:407

`Protected`_validateAndLog

_validateAndLog(): Promise<void>
Returns Promise<void>
Inherited from UmbContentDetailWorkspaceContextBase._validateAndLog
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:97

`Protected`_variantOptionsFilter

_variantOptionsFilter(variantOption: UmbEntityVariantOptionModel): boolean
Parameters
- variantOption: UmbEntityVariantOptionModel
Returns boolean
Inherited from UmbContentDetailWorkspaceContextBase._variantOptionsFilter
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:167

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

addValidationContext

addValidationContext(context: UmbValidationController): void
Appends a validation context to the workspace.
Parameters
- context: UmbValidationController
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.addValidationContext
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:30

askServerToValidate

askServerToValidate(
saveData: UmbDocumentDetailModel,
variantIds: UmbVariantId[],
): Promise<void>
Ask the server to validate the save data
Parameters
- saveData: UmbDocumentDetailModel
  The data to validate
- variantIds: UmbVariantId[]
  The variant ids to validate
Returns Promise<void>
Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase.askServerToValidate
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:798

constructSaveData

constructSaveData(variantIds: UmbVariantId[]): Promise<UmbDocumentDetailModel>
Get the data to save
Parameters
- variantIds: UmbVariantId[]
  The variant ids to save
Returns Promise<UmbDocumentDetailModel>
{Promise}

Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase.constructSaveData
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:846

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Inherited from UmbContentDetailWorkspaceContextBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

create

create(
    parent: UmbEntityModel,
    documentTypeUnique: string,
    blueprintUnique?: string,
): Promise<undefined | UmbDocumentDetailModel>
Parameters
- parent: UmbEntityModel
- documentTypeUnique: string
- OptionalblueprintUnique: string
Returns Promise<undefined | UmbDocumentDetailModel>
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:227

createPropertyDatasetContext

createPropertyDatasetContext(
host: UmbControllerHost,
variantId: UmbVariantId,
): UmbDocumentPropertyDatasetContext
Parameters
- host: UmbControllerHost
- variantId: UmbVariantId
Returns UmbDocumentPropertyDatasetContext
Implementation of UmbContentWorkspaceContext.createPropertyDatasetContext
Overrides UmbContentDetailWorkspaceContextBase.createPropertyDatasetContext
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:406

createScaffold

createScaffold(
args: UmbEntityDetailWorkspaceContextCreateArgs,
): Promise<undefined | UmbDocumentDetailModel>
Create a data scaffold
Parameters
- args: UmbEntityDetailWorkspaceContextCreateArgs
  The arguments to create the scaffold.
  - parent: UmbEntityModel
  - Optionalpreset?: UmbDeepPartialObject<DetailModelType>
Returns Promise<undefined | UmbDocumentDetailModel>
The data of the scaffold.
Inherited from UmbContentDetailWorkspaceContextBase.createScaffold
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:299

delete

delete(unique: string): Promise<void>
Deletes the entity.
Parameters
- unique: string
  The unique identifier of the entity to delete.
Returns Promise<void>
Inherited from UmbContentDetailWorkspaceContextBase.delete
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:360

destroy

destroy(): void
Returns void
Implementation of UmbPublishableWorkspaceContext.destroy
Inherited from UmbContentDetailWorkspaceContextBase.destroy
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:1058

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbContentDetailWorkspaceContextBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

finishPropertyValueChange

finishPropertyValueChange(): void
Returns void
Implementation of UmbContentWorkspaceContext.finishPropertyValueChange
Inherited from UmbContentDetailWorkspaceContextBase.finishPropertyValueChange
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:685

getChangedVariants

getChangedVariants(): UmbVariantId[]
Gets the changed variant ids

Returns UmbVariantId[]
- The changed variant ids
Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase.getChangedVariants
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:694

getCollectionAlias

getCollectionAlias(): string
Returns string
Deprecated
will be removed in v.18
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:255

getContentTypeId

getContentTypeId(): undefined | string
Gets the unique identifier of the content type.

Returns undefined | string
The unique identifier of the content type.

Deprecated
Use getContentTypeUnique instead.

Memberof
UmbDocumentWorkspaceContext
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:265

getContentTypeUnique

getContentTypeUnique(): undefined | string
Gets the unique identifier of the content type.

Returns undefined | string
The unique identifier of the content type.

Memberof
UmbDocumentWorkspaceContext
Overrides UmbContentDetailWorkspaceContextBase.getContentTypeUnique
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:274

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Inherited from UmbContentDetailWorkspaceContextBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getData

getData(): undefined | UmbDocumentDetailModel
Get the current data

Returns undefined | UmbDocumentDetailModel
The entity context
Implementation of UmbContentWorkspaceContext.getData
Inherited from UmbContentDetailWorkspaceContextBase.getData
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:155

getEntityType

getEntityType(): string
Get the entity type

Returns string
The entity type
Implementation of UmbPublishableWorkspaceContext.getEntityType
Inherited from UmbContentDetailWorkspaceContextBase.getEntityType
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:145

getHasUnpersistedChanges

getHasUnpersistedChanges(): boolean
Check if there are unpersisted changes.

Returns boolean
true if there are unpersisted changes.
Inherited from UmbContentDetailWorkspaceContextBase.getHasUnpersistedChanges
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:468

getHostElement

getHostElement(): Element
Returns Element
Implementation of UmbPublishableWorkspaceContext.getHostElement
Inherited from UmbContentDetailWorkspaceContextBase.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getIsNew

getIsNew(): undefined | boolean
Returns undefined | boolean
Implementation of UmbPublishableWorkspaceContext.getIsNew
Inherited from UmbContentDetailWorkspaceContextBase.getIsNew
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:74

getName

getName(variantId?: UmbVariantId): undefined | string
Get the name of a variant
Parameters
- OptionalvariantId: UmbVariantId
  The variant id
Returns undefined | string
- The name of the variant
Memberof
UmbContentDetailWorkspaceContextBase
Implementation of UmbContentWorkspaceContext.getName
Inherited from UmbContentDetailWorkspaceContextBase.getName
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:482

getParent

getParent(): undefined | UmbEntityModel
Get the parent

Returns undefined | UmbEntityModel
The parent entity

Deprecated
Will be removed in v.18: Use UMB_PARENT_ENTITY_CONTEXT instead to get the parent both when creating and editing.
Inherited from UmbContentDetailWorkspaceContextBase.getParent
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:202

getParentEntityType

getParentEntityType(): undefined | string
Get the parent entity type

Returns undefined | string
The parent entity type

Deprecated
Will be removed in v.18
Inherited from UmbContentDetailWorkspaceContextBase.getParentEntityType
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:229

getParentUnique

getParentUnique(): undefined | UmbEntityUnique
Get the parent unique

Returns undefined | UmbEntityUnique
The parent unique identifier

Deprecated
Will be removed in v.18: Use UMB_PARENT_ENTITY_CONTEXT instead to get the parent both when creating and editing.
Inherited from UmbContentDetailWorkspaceContextBase.getParentUnique
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:220

getPersistedData

getPersistedData(): undefined | UmbDocumentDetailModel
Get the persisted data

Returns undefined | UmbDocumentDetailModel
The persisted data
Inherited from UmbContentDetailWorkspaceContextBase.getPersistedData
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:163

getPropertyValue

getPropertyValue<ReturnType = unknown>(
alias: string,
variantId?: UmbVariantId,
): undefined | ReturnType
Get the current value of the property with the given alias and variantId.
Type Parameters
- ReturnType = unknown
Parameters
- alias: string
  The alias of the property
- OptionalvariantId: UmbVariantId
  The variant id of the property
Returns undefined | ReturnType
The value or undefined if not set or found.
Implementation of UmbContentWorkspaceContext.getPropertyValue
Inherited from UmbContentDetailWorkspaceContextBase.getPropertyValue
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:615

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Inherited from UmbContentDetailWorkspaceContextBase.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

getUnique

getUnique(): undefined | UmbEntityUnique
Get the unique

Returns undefined | UmbEntityUnique
The unique identifier
Implementation of UmbPublishableWorkspaceContext.getUnique
Inherited from UmbContentDetailWorkspaceContextBase.getUnique
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:171

getValues

getValues(): undefined | UmbElementValueModel<unknown>[]
Get the values of the content

Returns undefined | UmbElementValueModel<unknown>[]
- The values of the content
Memberof
UmbContentDetailWorkspaceContextBase
Implementation of UmbContentWorkspaceContext.getValues
Inherited from UmbContentDetailWorkspaceContextBase.getValues
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:587

getVariant

getVariant(variantId: UmbVariantId): undefined | UmbDocumentVariantModel
Get the variant by the given variantId
Parameters
- variantId: UmbVariantId
  The variant id
Returns undefined | UmbDocumentVariantModel
- The variant or undefined if not found
Memberof
UmbContentDetailWorkspaceContextBase
Implementation of UmbContentWorkspaceContext.getVariant
Inherited from UmbContentDetailWorkspaceContextBase.getVariant
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:562

getVariants

getVariants(): undefined | UmbDocumentVariantModel[]
Returns undefined | UmbDocumentVariantModel[]
Inherited from UmbContentDetailWorkspaceContextBase.getVariants
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:566

getVariantValidationContext

getVariantValidationContext(
variantId: UmbVariantId,
): undefined | UmbValidationController
Parameters
- variantId: UmbVariantId
Returns undefined | UmbValidationController
Implementation of UmbContentWorkspaceContext.getVariantValidationContext
Inherited from UmbContentDetailWorkspaceContextBase.getVariantValidationContext
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:170

getVaries

getVaries(): undefined | boolean
Get whether the content varies

Returns undefined | boolean
- If the content varies
Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase.getVaries
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:542

getVariesByCulture

getVariesByCulture(): undefined | boolean
Get whether the content varies by culture

Returns undefined | boolean
- If the content varies by culture
Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase.getVariesByCulture
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:524

getVariesBySegment

getVariesBySegment(): undefined | boolean
Get whether the content varies by segment

Returns undefined | boolean
- If the content varies by segment
Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase.getVariesBySegment
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:533

hasUmbController

hasUmbController(controller: UmbController): boolean
Parameters
- controller: UmbController
Returns boolean
Inherited from UmbContentDetailWorkspaceContextBase.hasUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:4

hostConnected

hostConnected(): void
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.hostConnected
- Defined in src/libs/controller-api/controller.interface.ts:4

hostDisconnected

hostDisconnected(): void
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.hostDisconnected
- Defined in src/libs/controller-api/controller.interface.ts:5

initiatePropertyValueChange

initiatePropertyValueChange(): void
Returns void
Implementation of UmbContentWorkspaceContext.initiatePropertyValueChange
Inherited from UmbContentDetailWorkspaceContextBase.initiatePropertyValueChange
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:681

`Protected`invalidSubmit

invalidSubmit(reason?: any): Promise<void>
Parameters
- Optionalreason: any
Returns Promise<void>
Inherited from UmbContentDetailWorkspaceContextBase.invalidSubmit
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:172

isLoaded

isLoaded(): undefined | Promise<any>
Method to check if the workspace data is loaded.

Returns undefined | Promise<any>
true if the workspace data is loaded.

Memberof
UmbEntityWorkspaceContextBase
Implementation of UmbContentWorkspaceContext.isLoaded
Inherited from UmbContentDetailWorkspaceContextBase.isLoaded
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:286

load

load(
    unique: string,
): Promise<
    | UmbRepositoryResponse<UmbDocumentDetailModel>
    | UmbRepositoryResponseWithAsObservable<
        UmbDocumentDetailModel,
        UmbDocumentDetailModel,
    >,
>
Parameters
- unique: string
Returns Promise<
    | UmbRepositoryResponse<UmbDocumentDetailModel>
    | UmbRepositoryResponseWithAsObservable<
        UmbDocumentDetailModel,
        UmbDocumentDetailModel,
    >,
>
Overrides UmbContentDetailWorkspaceContextBase.load
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:217

loadLanguages

loadLanguages(): Promise<void>
Returns Promise<void>
Inherited from UmbContentDetailWorkspaceContextBase.loadLanguages
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:384

name

name(variantId?: UmbVariantId): Observable<string>
Get an observable for the name of a variant
Parameters
- OptionalvariantId: UmbVariantId
  The variant id
Returns Observable<string>
- The name of the variant
Memberof
UmbContentDetailWorkspaceContextBase
Implementation of UmbContentWorkspaceContext.name
Inherited from UmbContentDetailWorkspaceContextBase.name
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:511

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  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.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Inherited from UmbContentDetailWorkspaceContextBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

performCreateOrUpdate

performCreateOrUpdate(
variantIds: UmbVariantId[],
saveData: UmbDocumentDetailModel,
): Promise<void>
Perform the create or update of the content
Parameters
- variantIds: UmbVariantId[]
  The variant ids to save
- saveData: UmbDocumentDetailModel
  The data to save
Returns Promise<void>
Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase.performCreateOrUpdate
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:929

propertyStructureById

propertyStructureById(
propertyId: string,
): Promise<Observable<undefined | UmbPropertyTypeModel>>
Observe the property type
Parameters
- propertyId: string
  The id of the property
Returns Promise<Observable<undefined | UmbPropertyTypeModel>>
- An observable for the property type
Memberof
UmbContentDetailWorkspaceContextBase
Implementation of UmbContentWorkspaceContext.propertyStructureById
Inherited from UmbContentDetailWorkspaceContextBase.propertyStructureById
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:576

propertyValueByAlias

propertyValueByAlias<PropertyValueType = unknown>(
propertyAlias: string,
variantId?: UmbVariantId,
): Promise<undefined | Observable<undefined | PropertyValueType>>
Function
propertyValueByAlias
Type Parameters
- PropertyValueType = unknown
Parameters
- propertyAlias: string
  The alias of the property
- OptionalvariantId: UmbVariantId
  The variant
Returns Promise<undefined | Observable<undefined | PropertyValueType>>
- An observable for the value of the property
Description
Get an Observable for the value of this property.
Implementation of UmbContentWorkspaceContext.propertyValueByAlias
Inherited from UmbContentDetailWorkspaceContextBase.propertyValueByAlias
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:598

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbContentDetailWorkspaceContextBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

publish

publish(): Promise<void>
Returns Promise<void>
Implementation of UmbPublishableWorkspaceContext.publish
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:340

publishWithDescendants

publishWithDescendants(): Promise<void>
Publish the document and all its descendants.

Returns Promise<void>
Deprecated
Will be removed in v17. Use the UMB_DOCUMENT_PUBLISHING_WORKSPACE_CONTEXT instead.
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:396

reload

reload(): Promise<void>
Reload the workspace data

Returns Promise<void>
The promise of the reload
Inherited from UmbContentDetailWorkspaceContextBase.reload
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:270

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

requestSave

requestSave(): Promise<void>
Request a save of the workspace, in the case of Document Workspaces the validation does not need to be valid for this to be saved.

Returns Promise<void>
A promise which resolves once it has been completed.
Inherited from UmbContentDetailWorkspaceContextBase.requestSave
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:836

requestSubmit

requestSubmit(): Promise<void>
Request a submit of the workspace, in the case of Document Workspaces the validation does not need to be valid for this to be submitted.

Returns Promise<void>
a promise which resolves once it has been completed.
Implementation of UmbPublishableWorkspaceContext.requestSubmit
Inherited from UmbContentDetailWorkspaceContextBase.requestSubmit
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:824

resetState

resetState(): void
Returns void
Overrides UmbContentDetailWorkspaceContextBase.resetState
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:212

runMandatoryValidationForSaveData

runMandatoryValidationForSaveData(
saveData: UmbDocumentDetailModel,
variantIds?: UmbVariantId[],
): Promise<void>
Run the mandatory validation for the save data
Parameters
- saveData: UmbDocumentDetailModel
  The data to validate
- variantIds: UmbVariantId[] = []
Returns Promise<void>
Memberof
UmbContentDetailWorkspaceContextBase
Inherited from UmbContentDetailWorkspaceContextBase.runMandatoryValidationForSaveData
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:759

saveAndPreview

saveAndPreview(): Promise<void>
Returns Promise<void>
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:296

saveAndPublish

saveAndPublish(): Promise<void>
Save the document and publish it.

Returns Promise<void>
Deprecated
Will be removed in v17. Use the UMB_DOCUMENT_PUBLISHING_WORKSPACE_CONTEXT instead.
Implementation of UmbPublishableWorkspaceContext.saveAndPublish
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:354

schedule

schedule(): Promise<void>
Schedule the document to be published at a later date.

Returns Promise<void>
Deprecated
Will be removed in v17. Use the UMB_DOCUMENT_PUBLISHING_WORKSPACE_CONTEXT instead.
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:368

`Protected`setIsNew

setIsNew(isNew: boolean): void
Parameters
- isNew: boolean
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.setIsNew
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:78

setName

setName(name: string, variantId?: UmbVariantId): void
Set the name of a variant
Parameters
- name: string
  The name of the variant
- OptionalvariantId: UmbVariantId
  The variant id
Returns void
Memberof
UmbContentDetailWorkspaceContextBase
Implementation of UmbContentWorkspaceContext.setName
Inherited from UmbContentDetailWorkspaceContextBase.setName
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:498

setParent

setParent(parent: UmbEntityModel): void
Set the parent
Parameters
- parent: UmbEntityModel
  The parent entity
Returns void
Deprecated
Will be removed in v.18.
Inherited from UmbContentDetailWorkspaceContextBase.setParent
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:211

setPropertyValue

setPropertyValue<ValueType = unknown>(
    alias: string,
    value: ValueType,
    variantId?: UmbVariantId,
): Promise<void>
Set the value of the property with the given alias and variantId.
Type Parameters
- ValueType = unknown
Parameters
- alias: string
  The alias of the property
- value: ValueType
  The value to set
- OptionalvariantId: UmbVariantId
  The variant id of the property
Returns Promise<void>
Memberof
UmbContentDetailWorkspaceContextBase
Implementation of UmbContentWorkspaceContext.setPropertyValue
Inherited from UmbContentDetailWorkspaceContextBase.setPropertyValue
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:634

setTemplate

setTemplate(templateUnique: string): void
Set the template
Parameters
- templateUnique: string
  The unique identifier of the template.
Returns void
Memberof
UmbDocumentWorkspaceContext
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:283

setUnique

setUnique(unique: string): void
Parameters
- unique: string
Returns void
Inherited from UmbContentDetailWorkspaceContextBase.setUnique
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:175

submit

submit(): Promise<void>
Returns Promise<void>
Inherited from UmbContentDetailWorkspaceContextBase.submit
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:828

unpublish

unpublish(): Promise<void>
Unpublish the document.

Returns Promise<void>
Deprecated
Will be removed in v17. Use the UMB_DOCUMENT_PUBLISHING_WORKSPACE_CONTEXT instead.
Implementation of UmbPublishableWorkspaceContext.unpublish
- Defined in src/packages/documents/documents/workspace/document-workspace.context.ts:382

validate

validate(): Promise<void[]>
If a Workspace has multiple validation contexts, then this method can be overwritten to return the correct one.

Returns Promise<void[]>
Promise that resolves to void when the validation is complete.
Inherited from UmbContentDetailWorkspaceContextBase.validate
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:86

validateAndSubmit

validateAndSubmit(
onValid: () => Promise<void>,
onInvalid: (reason?: any) => Promise<void>,
): Promise<void>
Parameters
- onValid: () => Promise<void>
- onInvalid: (reason?: any) => Promise<void>
Returns Promise<void>
Inherited from UmbContentDetailWorkspaceContextBase.validateAndSubmit
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:108

variantById

variantById(
variantId: UmbVariantId,
): Observable<undefined | UmbDocumentVariantModel>
Get the variant by the given variantId
Parameters
- variantId: UmbVariantId
  The variant id
Returns Observable<undefined | UmbDocumentVariantModel>
- The variant or undefined if not found
Memberof
UmbContentDetailWorkspaceContextBase
Implementation of UmbContentWorkspaceContext.variantById
Inherited from UmbContentDetailWorkspaceContextBase.variantById
- Defined in src/packages/content/content/workspace/content-detail-workspace-base.ts:552

Class UmbDocumentWorkspaceContext

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UmbDocumentWorkspaceContext

Properties

Protected Readonly_data

Description

Memberof

Protected Optional_detailRepository

Protected Optional_getDataPromise

_host

Readonly_internal_createUnderParent

Readonly_internal_createUnderParentEntityType

Readonly_internal_createUnderParentEntityUnique

Protected Readonly_segments

Protected Readonly_workspaceEventUnique

Readonlycollection

ReadonlycontentTypeHasCollection

ReadonlycontentTypeIcon

ReadonlycontentTypeUnique

Readonlydata

ReadonlyentityType

Readonlyforbidden

ReadonlyIS_CONTENT_WORKSPACE_CONTEXT

ReadonlyIS_ENTITY_DETAIL_WORKSPACE_CONTEXT

isNew

ReadonlyisTrashed

Readonlyloading

Optional ReadonlymodalContext

ReadonlyparentEntityType

Deprecated

ReadonlyparentUnique

Deprecated

ReadonlypersistedData

ReadonlypropertyViewGuard

ReadonlypropertyWriteGuard

ReadonlypublishingRepository

Deprecated

Memberof

ReadonlyreadOnlyGuard

Readonlyroutes

ReadonlysplitView

Readonlystructure

ReadonlytemplateId

Readonlyunique

ProtectedvalidationContext

Example: You can manually validate all properties on the context:

Example: You can set the data path on the context to map to a specific part of the server validation:

Readonlyvalues

ReadonlyvariantOptions

Readonlyvariants

Readonlyvaries

ReadonlyvariesByCulture

ReadonlyvariesBySegment

Readonlyview

ReadonlyworkspaceAlias

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

Protected_checkWillNavigateAway

Parameters

Returns boolean

Memberof

Protected_closeModal

Returns void

Protected_create

Parameters

Returns Promise<void>

Protected_determineVariantOptions

Returns Promise< { options: UmbEntityVariantOptionModel<UmbDocumentVariantModel>[]; selected: string[]; },>

Protected_getHasUnpersistedChanges

`Protected` `Readonly`_data

`Protected` `Optional`_detailRepository

`Protected` `Optional`_getDataPromise

`Readonly`_internal_createUnderParent

`Readonly`_internal_createUnderParentEntityType

`Readonly`_internal_createUnderParentEntityUnique

`Protected` `Readonly`_segments

`Protected` `Readonly`_workspaceEventUnique

`Readonly`collection

`Readonly`contentTypeHasCollection

`Readonly`contentTypeIcon

`Readonly`contentTypeUnique

`Readonly`data

`Readonly`entityType

`Readonly`forbidden

`Readonly`IS_CONTENT_WORKSPACE_CONTEXT

`Readonly`IS_ENTITY_DETAIL_WORKSPACE_CONTEXT

`Readonly`isTrashed

`Readonly`loading

`Optional` `Readonly`modalContext

`Readonly`parentEntityType

`Readonly`parentUnique

`Readonly`persistedData

`Readonly`propertyViewGuard

`Readonly`propertyWriteGuard

`Readonly`publishingRepository

`Readonly`readOnlyGuard

`Readonly`routes

`Readonly`splitView

`Readonly`structure

`Readonly`templateId

`Readonly`unique

`Protected`validationContext

`Readonly`values

`Readonly`variantOptions

`Readonly`variants

`Readonly`varies

`Readonly`variesByCulture

`Readonly`variesBySegment

`Readonly`view

`Readonly`workspaceAlias

`Protected`_checkWillNavigateAway

`Protected`_closeModal

`Protected`_create

`Protected`_determineVariantOptions

Returns Promise<
{
options: UmbEntityVariantOptionModel<UmbDocumentVariantModel>[];
selected: string[];
},
>

`Protected`_getHasUnpersistedChanges

`Protected`_handleSave

`Protected`_handleSubmit

`Protected`_performCreateOrUpdate

`Protected`_runMandatoryValidationForSaveData

`Protected`_saveableVariantsFilter

`Protected`_scaffoldProcessData

`Protected`_update

`Protected`_validateAndLog

`Protected`_variantOptionsFilter

`Optional`preset?: UmbDeepPartialObject<DetailModelType>