Class UmbSubmittableWorkspaceContextBase<WorkspaceDataModelType>`Abstract`

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

Type Parameters

WorkspaceDataModelType

Hierarchy (View Summary)

UmbContextBase
- UmbSubmittableWorkspaceContextBase
  - UmbEntityDetailWorkspaceContextBase
  - UmbEditableWorkspaceContextBase

Implements

UmbSubmittableWorkspaceContext

Constructors

constructor

new UmbSubmittableWorkspaceContextBase<WorkspaceDataModelType>(
host: UmbControllerHost,
workspaceAlias: string,
): UmbSubmittableWorkspaceContextBase<WorkspaceDataModelType>
Type Parameters
- WorkspaceDataModelType
Parameters
- host: UmbControllerHost
- workspaceAlias: string
Returns UmbSubmittableWorkspaceContextBase<WorkspaceDataModelType>
Overrides UmbContextBase.constructor
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:53

Properties

_host

_host: UmbControllerHost

isNew

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

`Optional` `Readonly`modalContext

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

`Readonly`routes

routes: UmbWorkspaceRouteManager = ...

`Abstract` `Readonly`unique

unique: Observable<undefined | null | string>

`Readonly`view

view: UmbViewContext = ...

`Readonly`workspaceAlias

workspaceAlias: string

Accessors

controllerAlias

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

Methods

`Protected`_closeModal

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

`Protected`_validateAndLog

_validateAndLog(): Promise<void>
Returns Promise<void>
- 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 UmbContextBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbContextBase.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
- 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 UmbContextBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

destroy(): void
Returns void
Implementation of UmbSubmittableWorkspaceContext.destroy
Overrides UmbContextBase.destroy
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:176

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

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

getUmbControllers

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

`Abstract`getUnique

getUnique(): undefined | null | string
Returns undefined | null | string
Implementation of UmbSubmittableWorkspaceContext.getUnique
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:168

hasUmbController

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

hostConnected

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

hostDisconnected

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

`Protected`invalidSubmit

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

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

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 UmbContextBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

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

removeUmbControllerByAlias

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

requestSubmit

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

`Protected`resetState

resetState(): void
Returns void
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:69

`Protected`setIsNew

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

`Protected` `Abstract`submit

submit(): Promise<void>
Returns Promise<void>
- Defined in src/packages/core/workspace/submittable/submittable-workspace-context-base.ts:171

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

Class UmbSubmittableWorkspaceContextBase<WorkspaceDataModelType>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbSubmittableWorkspaceContextBase<WorkspaceDataModelType>

Properties

_host

isNew

Optional ReadonlymodalContext

Readonlyroutes

Abstract Readonlyunique

Readonlyview

ReadonlyworkspaceAlias

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

Protected_closeModal

Returns void

Protected_validateAndLog

Returns Promise<void>

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

addValidationContext

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

AbstractgetData

Returns undefined | WorkspaceDataModelType

AbstractgetEntityType

Returns string

getHostElement

Returns Element

getIsNew

Returns undefined | boolean

getUmbControllers

Parameters

Returns UmbController[]

AbstractgetUnique

Returns undefined | null | string

hasUmbController

Parameters

Returns boolean

hostConnected

Returns void

hostDisconnected

Returns void

ProtectedinvalidSubmit

Parameters

Returns Promise<void>

observe

Class UmbSubmittableWorkspaceContextBase<WorkspaceDataModelType>`Abstract`

`Optional` `Readonly`modalContext

`Readonly`routes

`Abstract` `Readonly`unique

`Readonly`view

`Readonly`workspaceAlias

`Protected`_closeModal

`Protected`_validateAndLog

`Abstract`getData

`Abstract`getEntityType

`Abstract`getUnique

`Protected`invalidSubmit

`Protected`resetState

`Protected`setIsNew

`Protected` `Abstract`submit