Class UmbEntityNamedDetailWorkspaceContextBase<NamedDetailModelType, NamedDetailRepositoryType, CreateArgsType>Abstract

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

Type Parameters

Hierarchy (View Summary, Expand)

Implements

Constructors

constructor

Properties

_data _detailRepository? _getDataPromise? _host _workspaceEventUnique data entityType IS_ENTITY_DETAIL_WORKSPACE_CONTEXT IS_ENTITY_NAMED_DETAIL_WORKSPACE_CONTEXT isNew loading modalContext? name parentEntityType parentUnique persistedData routes unique validationContext workspaceAlias

Accessors

controllerAlias

Methods

_checkWillNavigateAway _closeModal _create _getHasUnpersistedChanges _scaffoldProcessData _update addEventListener addUmbController addValidationContext consumeContext createScaffold delete destroy dispatchEvent getContext getData getEntityType getHostElement getIsNew getName getParent getParentEntityType getParentUnique getPersistedData getUmbControllers getUnique hasUmbController hostConnected hostDisconnected invalidSubmit isLoaded load observe provideContext reload removeEventListener removeUmbController removeUmbControllerByAlias requestSubmit resetState setIsNew setName setParent setUnique submit validate validateAndSubmit

Constructors

constructor

Properties

Protected Readonly_data

_data: UmbEntityWorkspaceDataManager<NamedDetailModelType> = ...

Description

Data manager for the workspace.

Memberof

UmbEntityWorkspaceContextBase

Protected Optional_detailRepository

_detailRepository?: NamedDetailRepositoryType

Protected Optional_getDataPromise

_getDataPromise?: Promise<any>

_host

_host: UmbControllerHost

Protected Readonly_workspaceEventUnique

_workspaceEventUnique: string = ...

Readonlydata

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

ReadonlyentityType

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

ReadonlyIS_ENTITY_DETAIL_WORKSPACE_CONTEXT

IS_ENTITY_DETAIL_WORKSPACE_CONTEXT: true

ReadonlyIS_ENTITY_NAMED_DETAIL_WORKSPACE_CONTEXT

IS_ENTITY_NAMED_DETAIL_WORKSPACE_CONTEXT: true

isNew

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

Readonlyloading

loading: UmbStateManager<UmbState> = ...

Optional ReadonlymodalContext

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

Readonlyname

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

ReadonlyparentEntityType

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

ReadonlyparentUnique

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

ReadonlypersistedData

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

Readonlyroutes

routes: UmbWorkspaceRouteManager = ...

Readonlyunique

unique: Observable<UmbEntityUnique> = ...

ProtectedvalidationContext

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');

ReadonlyworkspaceAlias

workspaceAlias: string

Accessors

controllerAlias

Methods

Protected_checkWillNavigateAway

Protected_closeModal

Protected_create

Protected_getHasUnpersistedChanges

Protected_scaffoldProcessData

Protected_update

addEventListener

  • addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

    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

addUmbController

addValidationContext

consumeContext

createScaffold

delete

destroy

dispatchEvent

  • dispatchEvent(event: Event): boolean

    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

getContext

getData

getEntityType

getHostElement

getIsNew

getName

getParent

getParentEntityType

getParentUnique

getPersistedData

getUmbControllers

getUnique

hasUmbController

hostConnected

hostDisconnected

ProtectedinvalidSubmit

isLoaded

load

observe

provideContext

reload

removeEventListener

  • removeEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void

    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

removeUmbController

removeUmbControllerByAlias

requestSubmit

resetState

ProtectedsetIsNew

setName

setParent

setUnique

submit

validate

validateAndSubmit

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR