@umbraco-cms/backoffice

    Class UmbContentTypeWorkspaceContextBase<DetailModelType, DetailRepositoryType>Abstract

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

    Type Parameters

    Hierarchy (View Summary, Expand)

    Implements

    Index

    Constructors

    constructor

    Properties

    _data _detailRepository? _getDataPromise? _host _internal_createUnderParent _internal_createUnderParentEntityType _internal_createUnderParentEntityUnique _workspaceEventUnique alias allowedAtRoot allowedContentTypes collection compositions data description entityType icon IS_CONTENT_TYPE_WORKSPACE_CONTEXT IS_ENTITY_DETAIL_WORKSPACE_CONTEXT isElement isNew loading modalContext? name parentEntityType parentUnique persistedData routes structure unique validationContext variesByCulture variesBySegment workspaceAlias

    Accessors

    controllerAlias

    Methods

    _checkWillNavigateAway _closeModal _create _getHasUnpersistedChanges _internal_getCreateUnderParent _internal_setCreateUnderParent _scaffoldProcessData _update _validateAndLog addEventListener addUmbController addValidationContext consumeContext createScaffold delete destroy dispatchEvent getAlias getCompositions getContext getData getDescription getEntityType getHasUnpersistedChanges getHostElement getIcon getIsNew getName getParent getParentEntityType getParentUnique getPersistedData getUmbControllers getUnique hasUmbController hostConnected hostDisconnected invalidSubmit isLoaded load observe provideContext reload removeEventListener removeUmbController removeUmbControllerByAlias requestSubmit resetState setAlias setCompositions setDescription setIcon setIsNew setName setParent setUnique submit validate validateAndSubmit

    Constructors

    Properties

    Protected Readonly_data

    _data: UmbEntityWorkspaceDataManager<DetailModelType> = ...

    Data manager for the workspace.

    UmbEntityWorkspaceContextBase

    Protected Optional_detailRepository

    _detailRepository?: DetailRepositoryType

    Protected Optional_getDataPromise

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

    _host

    _host: UmbControllerHost

    _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 = ...
    alias: Observable<undefined | string>
    allowedAtRoot: Observable<undefined | boolean>
    allowedContentTypes: Observable<undefined | UmbContentTypeSortModel[]>
    collection: Observable<undefined | null | UmbReferenceByUnique>
    compositions: Observable<undefined | UmbContentTypeCompositionModel[]>
    data: Observable<undefined | DetailModelType> = ...
    description: Observable<undefined | string>
    entityType: Observable<undefined | string> = ...
    icon: Observable<undefined | string>

    ReadonlyIS_CONTENT_TYPE_WORKSPACE_CONTEXT

    IS_CONTENT_TYPE_WORKSPACE_CONTEXT: true
    IS_ENTITY_DETAIL_WORKSPACE_CONTEXT: true
    isElement: Observable<undefined | boolean>
    isNew: Observable<undefined | boolean> = ...
    loading: UmbStateManager<UmbState> = ...
    modalContext?: UmbModalContext<{ preset: object }, any>
    name: Observable<undefined | string>
    parentEntityType: Observable<undefined | string> = ...

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

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

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

    persistedData: Observable<undefined | DetailModelType> = ...
    routes: UmbWorkspaceRouteManager = ...
    structure: UmbContentTypeStructureManager<DetailModelType>
    unique: Observable<UmbEntityUnique> = ...
    validationContext: UmbValidationContext = ...

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

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

    this.validationContext.setDataPath('path.to.data');
    variesByCulture: Observable<undefined | boolean>
    variesBySegment: Observable<undefined | boolean>
    workspaceAlias: string

    Accessors

    Methods

    Protected_checkWillNavigateAway

    Protected_closeModal

    _create

    Protected_getHasUnpersistedChanges

    _internal_getCreateUnderParent

    _internal_setCreateUnderParent

    Protected_scaffoldProcessData

    _update

    Protected_validateAndLog

    • Appends 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.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • 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.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Removes the event listener in target's event listener list with the same type, callback, and options.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    MMNEPVFCICPMFPCPTTAAATR