Class UmbContentTypeWorkspaceContextBase<DetailModelType, DetailRepositoryType>`Abstract`

This base provides the necessary for a class to become a context-api controller.

Type Parameters

DetailModelType extends UmbContentTypeDetailModel = UmbContentTypeDetailModel
DetailRepositoryType extends UmbDetailRepository<DetailModelType> = UmbDetailRepository<DetailModelType>

Hierarchy (View Summary)

UmbEntityDetailWorkspaceContextBase<DetailModelType, DetailRepositoryType>
- UmbContentTypeWorkspaceContextBase

Implements

Index

Constructors

constructor

Accessors

controllerAlias

Methods

Constructors

constructor

new UmbContentTypeWorkspaceContextBase<
    DetailModelType extends
        UmbContentTypeDetailModel = UmbContentTypeDetailModel,
    DetailRepositoryType extends
        UmbDetailRepository<DetailModelType> = UmbDetailRepository<
        DetailModelType,
    >,
>(
    host: UmbControllerHost,
    args: UmbContentTypeWorkspaceContextArgs,
): UmbContentTypeWorkspaceContextBase<DetailModelType, DetailRepositoryType>
Type Parameters
- DetailModelType extends UmbContentTypeDetailModel = UmbContentTypeDetailModel
- DetailRepositoryType extends UmbDetailRepository<DetailModelType> = UmbDetailRepository<DetailModelType>
Parameters
- host: UmbControllerHost
- args: UmbContentTypeWorkspaceContextArgs
Returns UmbContentTypeWorkspaceContextBase<DetailModelType, DetailRepositoryType>
Overrides UmbEntityDetailWorkspaceContextBase.constructor
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:55

Properties

`Protected` `Readonly`_data

_data: UmbEntityWorkspaceDataManager<DetailModelType> = ...

Description

Data manager for the workspace.

Memberof

UmbEntityWorkspaceContextBase

`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`_workspaceEventUnique

_workspaceEventUnique: string = ...

`Readonly`alias

alias: Observable<undefined | string>

`Readonly`allowedAtRoot

allowedAtRoot: Observable<undefined | boolean>

`Readonly`allowedContentTypes

allowedContentTypes: Observable<undefined | UmbContentTypeSortModel[]>

`Readonly`collection

collection: Observable<undefined | null | UmbReferenceByUnique>

`Readonly`compositions

compositions: Observable<undefined | UmbContentTypeCompositionModel[]>

`Readonly`data

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

`Readonly`description

description: Observable<undefined | string>

`Readonly`entityType

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

`Readonly`forbidden

forbidden: UmbStateManager<UmbState> = ...

`Readonly`icon

icon: Observable<undefined | string>

`Readonly`IS_CONTENT_TYPE_WORKSPACE_CONTEXT

IS_CONTENT_TYPE_WORKSPACE_CONTEXT: true

`Readonly`IS_ENTITY_DETAIL_WORKSPACE_CONTEXT

IS_ENTITY_DETAIL_WORKSPACE_CONTEXT: true

`Readonly`isElement

isElement: Observable<undefined | boolean>

isNew

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

`Readonly`loading

loading: UmbStateManager<UmbState> = ...

`Optional` `Readonly`modalContext

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

`Readonly`name

name: Observable<undefined | string>

`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 | DetailModelType> = ...

`Readonly`routes

routes: UmbWorkspaceRouteManager = ...

`Readonly`structure

structure: UmbContentTypeStructureManager<DetailModelType>

`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`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 UmbEntityDetailWorkspaceContextBase.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 UmbEntityDetailWorkspaceContextBase._checkWillNavigateAway
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:372

`Protected`_closeModal

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

`Protected`_create

_create(currentData: DetailModelType, parent: UmbEntityModel): Promise<void>
Creates the Content Type
Parameters
- currentData: DetailModelType
  The current data
- parent: UmbEntityModel
  The parent entity
Returns Promise<void>
Memberof
UmbContentTypeWorkspaceContextBase
Overrides UmbEntityDetailWorkspaceContextBase._create
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:157

`Protected`_getHasUnpersistedChanges

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

_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 UmbEntityDetailWorkspaceContextBase._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 UmbEntityDetailWorkspaceContextBase._internal_setCreateUnderParent
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:193

`Protected`_scaffoldProcessData

_scaffoldProcessData(data: DetailModelType): Promise<DetailModelType>
Parameters
- data: DetailModelType
Returns Promise<DetailModelType>
Inherited from UmbEntityDetailWorkspaceContextBase._scaffoldProcessData
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:330

`Protected`_update

_update(): Promise<void>
Updates the content type for the workspace

Returns Promise<void>
Memberof
UmbContentTypeWorkspaceContextBase
Overrides UmbEntityDetailWorkspaceContextBase._update
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:183

`Protected`_validateAndLog

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

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 UmbEntityDetailWorkspaceContextBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbEntityDetailWorkspaceContextBase.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 UmbEntityDetailWorkspaceContextBase.addValidationContext
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:30

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 UmbEntityDetailWorkspaceContextBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

createScaffold

createScaffold(
args: UmbEntityDetailWorkspaceContextCreateArgs<DetailModelType>,
): Promise<undefined | DetailModelType>
Creates a new scaffold
Parameters
- args: UmbEntityDetailWorkspaceContextCreateArgs<DetailModelType>
  The arguments for creating a new scaffold
Returns Promise<undefined | DetailModelType>
The new scaffold
Overrides UmbEntityDetailWorkspaceContextBase.createScaffold
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:83

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 UmbEntityDetailWorkspaceContextBase.delete
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:360

destroy

destroy(): void
Returns void
Implementation of UmbRoutableWorkspaceContext.destroy
Overrides UmbEntityDetailWorkspaceContextBase.destroy
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:298

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 UmbEntityDetailWorkspaceContextBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getAlias

getAlias(): undefined | string
Gets the alias of the content type

Returns undefined | string
The alias of the content type
Implementation of UmbContentTypeWorkspaceContext.getAlias
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:236

getCompositions

getCompositions(): undefined | UmbContentTypeCompositionModel[]
Gets the compositions of the content type

Returns undefined | UmbContentTypeCompositionModel[]
The icon of the content type
Implementation of UmbContentTypeWorkspaceContext.getCompositions
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:268

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 UmbEntityDetailWorkspaceContextBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getData

getData(): undefined | DetailModelType
Get the current data

Returns undefined | DetailModelType
The entity context
Overrides UmbEntityDetailWorkspaceContextBase.getData
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:294

getDescription

getDescription(): undefined | string
Gets the description of the content type

Returns undefined | string
The description of the content type
Implementation of UmbContentTypeWorkspaceContext.getDescription
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:252

getEntityType

getEntityType(): string
Get the entity type

Returns string
The entity type
Implementation of UmbRoutableWorkspaceContext.getEntityType
Inherited from UmbEntityDetailWorkspaceContextBase.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 UmbEntityDetailWorkspaceContextBase.getHasUnpersistedChanges
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:468

getHostElement

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

getIcon

getIcon(): undefined | string
Gets the icon of the content type

Returns undefined | string
The icon of the content type
Implementation of UmbContentTypeWorkspaceContext.getIcon
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:285

getIsNew

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

getName

getName(): undefined | string
Gets the name of the content type

Returns undefined | string
The name of the content type
Implementation of UmbContentTypeWorkspaceContext.getName
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:220

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 UmbEntityDetailWorkspaceContextBase.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 UmbEntityDetailWorkspaceContextBase.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 UmbEntityDetailWorkspaceContextBase.getParentUnique
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:220

getPersistedData

getPersistedData(): undefined | DetailModelType
Get the persisted data

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

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Inherited from UmbEntityDetailWorkspaceContextBase.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 UmbContentTypeWorkspaceContext.getUnique
Inherited from UmbEntityDetailWorkspaceContextBase.getUnique
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:171

hasUmbController

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

hostConnected

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

hostDisconnected

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

`Protected`invalidSubmit

invalidSubmit(reason?: any): Promise<void>
Parameters
- Optionalreason: any
Returns Promise<void>
Inherited from UmbEntityDetailWorkspaceContextBase.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
Inherited from UmbEntityDetailWorkspaceContextBase.isLoaded
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:286

load

load(
    unique: string,
): Promise<
    | UmbRepositoryResponse<DetailModelType>
    | UmbRepositoryResponseWithAsObservable<DetailModelType, DetailModelType>,
>
Loads the data for the workspace
Parameters
- unique: string
  The unique identifier of the data to load
Returns Promise<
| UmbRepositoryResponse<DetailModelType>
| UmbRepositoryResponseWithAsObservable<DetailModelType, DetailModelType>,
>
The loaded data
Overrides UmbEntityDetailWorkspaceContextBase.load
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:117

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 UmbEntityDetailWorkspaceContextBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

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 UmbEntityDetailWorkspaceContextBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

reload

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

Returns Promise<void>
The promise of the reload
Inherited from UmbEntityDetailWorkspaceContextBase.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 UmbEntityDetailWorkspaceContextBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

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

removeUmbControllerByAlias

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

requestSubmit

requestSubmit(): Promise<void>
Returns Promise<void>
Implementation of UmbContentTypeWorkspaceContext.requestSubmit
Inherited from UmbEntityDetailWorkspaceContextBase.requestSubmit
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:90

resetState

resetState(): void
Returns void
Inherited from UmbEntityDetailWorkspaceContextBase.resetState
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:481

setAlias

setAlias(alias: string): void
Sets the alias of the content type
Parameters
- alias: string
  The alias of the content type
Returns void
Implementation of UmbContentTypeWorkspaceContext.setAlias
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:244

setCompositions

setCompositions(compositions: UmbContentTypeCompositionModel[]): void
Sets the compositions of the content type
Parameters
- compositions: UmbContentTypeCompositionModel[]
  The compositions of the content type
Returns void
Implementation of UmbContentTypeWorkspaceContext.setCompositions
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:277

setDescription

setDescription(description: string): void
Sets the description of the content type
Parameters
- description: string
  The description of the content type
Returns void
Implementation of UmbContentTypeWorkspaceContext.setDescription
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:260

setIcon

setIcon(icon: string): void
Parameters
- icon: string
Returns void
Implementation of UmbContentTypeWorkspaceContext.setIcon
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:290

`Protected`setIsNew

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

setName

setName(name: string): void
Sets the name of the content type
Parameters
- name: string
  The name of the content type
Returns void
Implementation of UmbContentTypeWorkspaceContext.setName
- Defined in src/packages/content/content-type/workspace/content-type-workspace-context-base.ts:228

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 UmbEntityDetailWorkspaceContextBase.setParent
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:211

setUnique

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

submit

submit(): Promise<void>
Returns Promise<void>
Inherited from UmbEntityDetailWorkspaceContextBase.submit
- Defined in src/packages/core/workspace/entity-detail/entity-detail-workspace-base.ts:334

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 UmbEntityDetailWorkspaceContextBase.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 UmbEntityDetailWorkspaceContextBase.validateAndSubmit
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:108

Class UmbContentTypeWorkspaceContextBase<DetailModelType, DetailRepositoryType>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbContentTypeWorkspaceContextBase<DetailModelType, DetailRepositoryType>

Properties

Protected Readonly_data

Description

Memberof

Protected Optional_detailRepository

Protected Optional_getDataPromise

_host

Readonly_internal_createUnderParent

Readonly_internal_createUnderParentEntityType

Readonly_internal_createUnderParentEntityUnique

Protected Readonly_workspaceEventUnique

Readonlyalias

ReadonlyallowedAtRoot

ReadonlyallowedContentTypes

Readonlycollection

Readonlycompositions

Readonlydata

Readonlydescription

ReadonlyentityType

Readonlyforbidden

Readonlyicon

ReadonlyIS_CONTENT_TYPE_WORKSPACE_CONTEXT

ReadonlyIS_ENTITY_DETAIL_WORKSPACE_CONTEXT

ReadonlyisElement

isNew

Readonlyloading

Optional ReadonlymodalContext

Readonlyname

ReadonlyparentEntityType

Deprecated

ReadonlyparentUnique

Deprecated

ReadonlypersistedData

Readonlyroutes

Readonlystructure

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:

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>

Memberof

Protected_getHasUnpersistedChanges

Returns boolean

_internal_getCreateUnderParent

Returns undefined | UmbEntityModel

_internal_setCreateUnderParent

Parameters

Returns void

Protected_scaffoldProcessData

Parameters

Class UmbContentTypeWorkspaceContextBase<DetailModelType, DetailRepositoryType>`Abstract`

`Protected` `Readonly`_data

`Protected` `Optional`_detailRepository

`Protected` `Optional`_getDataPromise

`Readonly`_internal_createUnderParent

`Readonly`_internal_createUnderParentEntityType

`Readonly`_internal_createUnderParentEntityUnique

`Protected` `Readonly`_workspaceEventUnique

`Readonly`alias

`Readonly`allowedAtRoot

`Readonly`allowedContentTypes

`Readonly`collection

`Readonly`compositions

`Readonly`data

`Readonly`description

`Readonly`entityType

`Readonly`forbidden

`Readonly`icon

`Readonly`IS_CONTENT_TYPE_WORKSPACE_CONTEXT

`Readonly`IS_ENTITY_DETAIL_WORKSPACE_CONTEXT

`Readonly`isElement

`Readonly`loading

`Optional` `Readonly`modalContext

`Readonly`name

`Readonly`parentEntityType

`Readonly`parentUnique

`Readonly`persistedData

`Readonly`routes

`Readonly`structure

`Readonly`unique

`Protected`validationContext

`Readonly`variesByCulture

`Readonly`variesBySegment

`Readonly`view

`Readonly`workspaceAlias

`Protected`_checkWillNavigateAway

`Protected`_closeModal

`Protected`_create

`Protected`_getHasUnpersistedChanges

`Protected`_scaffoldProcessData

`Protected`_update

`Protected`_validateAndLog