Class UmbBlockEntryContext<BlockManagerContextTokenType, BlockManagerContextType, BlockEntriesContextTokenType, BlockEntriesContextType, BlockType, BlockLayoutType, BlockOriginData>`Abstract`

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

Type Parameters

BlockManagerContextTokenType extends UmbContextToken<BlockManagerContextType>
BlockManagerContextType extends UmbBlockManagerContext<BlockType, BlockLayoutType>
BlockEntriesContextTokenType extends UmbContextToken<BlockEntriesContextType>
BlockEntriesContextType extends UmbBlockEntriesContext<
    BlockManagerContextTokenType,
    BlockManagerContextType,
    BlockType,
    BlockLayoutType,
    BlockOriginData,
>
BlockType extends UmbBlockTypeBaseModel = UmbBlockTypeBaseModel
BlockLayoutType extends UmbBlockLayoutBaseModel = UmbBlockLayoutBaseModel
BlockOriginData extends UmbBlockWorkspaceOriginData = UmbBlockWorkspaceOriginData

Hierarchy (View Summary)

UmbContextBase
- UmbBlockEntryContext

Index

Constructors

constructor

Accessors

controllerAlias

Constructors

constructor

new UmbBlockEntryContext<
    BlockManagerContextTokenType extends
        UmbContextToken<BlockManagerContextType, BlockManagerContextType>,
    BlockManagerContextType extends
        UmbBlockManagerContext<
            BlockType,
            BlockLayoutType,
            UmbBlockWorkspaceOriginData,
        >,
    BlockEntriesContextTokenType extends
        UmbContextToken<BlockEntriesContextType, BlockEntriesContextType>,
    BlockEntriesContextType extends
        UmbBlockEntriesContext<
            BlockManagerContextTokenType,
            BlockManagerContextType,
            BlockType,
            BlockLayoutType,
            BlockOriginData,
        >,
    BlockType extends UmbBlockTypeBaseModel = UmbBlockTypeBaseModel,
    BlockLayoutType extends UmbBlockLayoutBaseModel = UmbBlockLayoutBaseModel,
    BlockOriginData extends
        UmbBlockWorkspaceOriginData = UmbBlockWorkspaceOriginData,
>(
    host: UmbControllerHost,
    blockManagerContextToken: BlockManagerContextTokenType,
    blockEntriesContextToken: BlockEntriesContextTokenType,
): UmbBlockEntryContext<
    BlockManagerContextTokenType,
    BlockManagerContextType,
    BlockEntriesContextTokenType,
    BlockEntriesContextType,
    BlockType,
    BlockLayoutType,
    BlockOriginData,
>
Type Parameters
- BlockManagerContextTokenType extends UmbContextToken<BlockManagerContextType, BlockManagerContextType>
- BlockManagerContextType extends UmbBlockManagerContext<BlockType, BlockLayoutType, UmbBlockWorkspaceOriginData>
- BlockEntriesContextTokenType extends UmbContextToken<BlockEntriesContextType, BlockEntriesContextType>
- BlockEntriesContextType extends UmbBlockEntriesContext<
      BlockManagerContextTokenType,
      BlockManagerContextType,
      BlockType,
      BlockLayoutType,
      BlockOriginData,
  >
- BlockType extends UmbBlockTypeBaseModel = UmbBlockTypeBaseModel
- BlockLayoutType extends UmbBlockLayoutBaseModel = UmbBlockLayoutBaseModel
- BlockOriginData extends UmbBlockWorkspaceOriginData = UmbBlockWorkspaceOriginData
Parameters
- host: UmbControllerHost
- blockManagerContextToken: BlockManagerContextTokenType
- blockEntriesContextToken: BlockEntriesContextTokenType
Returns UmbBlockEntryContext<
    BlockManagerContextTokenType,
    BlockManagerContextType,
    BlockEntriesContextTokenType,
    BlockEntriesContextType,
    BlockType,
    BlockLayoutType,
    BlockOriginData,
>
Overrides UmbContextBase.constructor
- Defined in src/packages/block/block/context/block-entry.context.ts:326

Properties

`Protected`_blockType

_blockType: UmbObjectState<undefined | BlockType> = ...

`Protected`_contentStructureHasProperties

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

`Protected` `Readonly`_contentValueArray

_contentValueArray: Observable<undefined | UmbBlockDataValueModel<unknown>[]> = ...

`Protected` `Readonly`_settingsValueArray

_settingsValueArray: Observable<undefined | UmbBlockDataValueModel<unknown>[]> = ...

`Protected` `Readonly`_variantId

_variantId: Observable<undefined | UmbVariantId> = ...

`Readonly`actionsVisibility

actionsVisibility: Observable<boolean> = ...

`Readonly`blockType

blockType: Observable<undefined | BlockType> = ...

`Readonly`contentElementTypeAlias

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

`Readonly`contentElementTypeIcon

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

`Readonly`contentElementTypeKey

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

`Readonly`contentElementTypeName

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

`Readonly`contentKey

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

`Readonly`contentTypeKey

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

`Readonly`createAfterPath

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

`Readonly`createBeforePath

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

`Readonly`hasExpose

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

`Readonly`index

index: Observable<undefined | number> = ...

`Readonly`label

label: Observable<string> = ...

`Readonly`layout

layout: Observable<undefined | BlockLayoutType> = ...

`Readonly`readOnlyGuard

readOnlyGuard: UmbReadOnlyVariantGuardManager = ...

`Readonly`settingsElementTypeKey

settingsElementTypeKey: Observable<undefined | null | string> = ...

`Readonly`settingsKey

settingsKey: Observable<undefined | null | string> = ...

`Abstract` `Readonly`showContentEdit

showContentEdit: Observable<boolean>

`Readonly`unique

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

`Readonly`unsupported

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

`Readonly`workspaceEditContentPath

workspaceEditContentPath: Observable<string> = ...

`Readonly`workspaceEditSettingsPath

workspaceEditSettingsPath: Observable<string> = ...

`Readonly`workspacePath

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

Accessors

controllerAlias

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

Methods

`Protected` `Abstract`_gotContentType

_gotContentType(contentType: undefined | UmbContentTypeModel): void
Parameters
- contentType: undefined | UmbContentTypeModel
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:564

`Protected` `Abstract`_gotEntries

_gotEntries(): void
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:527

`Protected` `Abstract`_gotManager

_gotManager(): void
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:512

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

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

contentPropertyValueByAlias

contentPropertyValueByAlias<PropertyValueType = unknown>(
propertyAlias: string,
): Promise<Observable<undefined | PropertyValueType>>
Type Parameters
- PropertyValueType = unknown
Parameters
- propertyAlias: string
Returns Promise<Observable<undefined | PropertyValueType>>
- Defined in src/packages/block/block/context/block-entry.context.ts:224

contentValues

contentValues(): Promise<Observable<undefined | UmbBlockDataType>>
Returns Promise<Observable<undefined | UmbBlockDataType>>
- Defined in src/packages/block/block/context/block-entry.context.ts:257

delete

delete(): void
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:752

destroy

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

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

edit

edit(): void
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:726

editSettings

editSettings(): void
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:733

expose

expose(): void
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:759

getContent

getContent(): undefined | UmbBlockDataModel
Get the content of the block.

Returns undefined | UmbBlockDataModel
- the content of the block.
- Defined in src/packages/block/block/context/block-entry.context.ts:272

getContentElementTypeAlias

getContentElementTypeAlias(): undefined | string
Get the alias of the content element type.

Returns undefined | string
- the alias of the content element type.
- Defined in src/packages/block/block/context/block-entry.context.ts:120

getContentElementTypeIcon

getContentElementTypeIcon(): undefined | string
Get the icon of the content element type.

Returns undefined | string
- the icon of the content element type.
- Defined in src/packages/block/block/context/block-entry.context.ts:128

getContentElementTypeName

getContentElementTypeName(): undefined | string
Get the name of the content element type.

Returns undefined | string
- the name of the content element type.
- Defined in src/packages/block/block/context/block-entry.context.ts:112

getContentKey

getContentKey(): undefined | string
Returns undefined | string
- Defined in src/packages/block/block/context/block-entry.context.ts:440

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

getEntityType

getEntityType(): string
Returns string
- Defined in src/packages/block/block/context/block-entry.context.ts:81

getExpose

getExpose(): undefined | UmbBlockExposeModel
Get the expose of the block.

Returns undefined | UmbBlockExposeModel
- the expose of the block.
- Defined in src/packages/block/block/context/block-entry.context.ts:769

getHostElement

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

getIndex

getIndex(): undefined | number
Returns undefined | number
- Defined in src/packages/block/block/context/block-entry.context.ts:90

getLabel

getLabel(): string
Returns string
- Defined in src/packages/block/block/context/block-entry.context.ts:155

getLayout

getLayout(): undefined | BlockLayoutType
Get the layout of the block.

Returns undefined | BlockLayoutType
- the layout of the block.
- Defined in src/packages/block/block/context/block-entry.context.ts:149

getName

getName(): string
Function
Get the current value of this Blocks label. getName

Returns string
- the value of the label.
- Defined in src/packages/block/block/context/block-entry.context.ts:460

getSettings

getSettings(): undefined | UmbBlockDataModel
Get the settings of the block.

Returns undefined | UmbBlockDataModel
- the settings of the block.
- Defined in src/packages/block/block/context/block-entry.context.ts:320

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

getUnique

getUnique(): undefined | string
Returns undefined | string
- Defined in src/packages/block/block/context/block-entry.context.ts:84

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

hideActions

hideActions(): void
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:71

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

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

propertyVariantId

propertyVariantId(
structure: UmbContentTypeStructureManager,
propertyAlias: string,
): Promise<Observable<undefined | UmbVariantId>>
Parameters
- structure: UmbContentTypeStructureManager
- propertyAlias: string
Returns Promise<Observable<undefined | UmbVariantId>>
- Defined in src/packages/block/block/context/block-entry.context.ts:206

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

requestDelete

requestDelete(): Promise<void>
Returns Promise<void>
- Defined in src/packages/block/block/context/block-entry.context.ts:741

setContentKey

setContentKey(contentKey: string): void
Function
Set the contentKey of this entry. setContentKey
Parameters
- contentKey: string
  the entry content key.
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:450

setContentPropertyValue

setContentPropertyValue(propertyAlias: string, value: unknown): void
Parameters
- propertyAlias: string
- value: unknown
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:214

setIndex

setIndex(index: undefined | number): void
Parameters
- index: undefined | number
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:93

setSettingsPropertyValue

setSettingsPropertyValue(propertyAlias: string, value: unknown): void
Parameters
- propertyAlias: string
- value: unknown
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:218

settingsPropertyValueByAlias

settingsPropertyValueByAlias<PropertyValueType = unknown>(
propertyAlias: string,
): Promise<Observable<undefined | PropertyValueType>>
Type Parameters
- PropertyValueType = unknown
Parameters
- propertyAlias: string
Returns Promise<Observable<undefined | PropertyValueType>>
- Defined in src/packages/block/block/context/block-entry.context.ts:238

settingsValues

settingsValues(): Promise<Observable<undefined | UmbBlockDataType>>
Returns Promise<Observable<undefined | UmbBlockDataType>>
- Defined in src/packages/block/block/context/block-entry.context.ts:289

showActions

showActions(): void
Returns void
- Defined in src/packages/block/block/context/block-entry.context.ts:74

Class UmbBlockEntryContext<BlockManagerContextTokenType, BlockManagerContextType, BlockEntriesContextTokenType, BlockEntriesContextType, BlockType, BlockLayoutType, BlockOriginData>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbBlockEntryContext< BlockManagerContextTokenType, BlockManagerContextType, BlockEntriesContextTokenType, BlockEntriesContextType, BlockType, BlockLayoutType, BlockOriginData,>

Properties

Protected_blockType

Protected_contentStructureHasProperties

Protected Readonly_contentValueArray

Protected Optional_entries

_host

Protected_layout

Protected Optional_manager

Protected Readonly_settingsValueArray

Protected Readonly_variantId

ReadonlyactionsVisibility

ReadonlyblockType

ReadonlycontentElementTypeAlias

ReadonlycontentElementTypeIcon

ReadonlycontentElementTypeKey

ReadonlycontentElementTypeName

ReadonlycontentKey

ReadonlycontentTypeKey

ReadonlycreateAfterPath

ReadonlycreateBeforePath

ReadonlyhasExpose

Readonlyindex

Readonlylabel

Readonlylayout

ReadonlyreadOnlyGuard

ReadonlysettingsElementTypeKey

ReadonlysettingsKey

Abstract ReadonlyshowContentEdit

Readonlyunique

Readonlyunsupported

ReadonlyworkspaceEditContentPath

ReadonlyworkspaceEditSettingsPath

ReadonlyworkspacePath

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

Protected Abstract_gotContentType

Parameters

Returns void

Protected Abstract_gotEntries

Returns void

Protected Abstract_gotManager

Returns void

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

contentPropertyValueByAlias

Type Parameters

Parameters

Returns Promise<Observable<undefined | PropertyValueType>>

contentValues

Returns Promise<Observable<undefined | UmbBlockDataType>>

delete

Returns void

destroy

Returns void

dispatchEvent

Class UmbBlockEntryContext<BlockManagerContextTokenType, BlockManagerContextType, BlockEntriesContextTokenType, BlockEntriesContextType, BlockType, BlockLayoutType, BlockOriginData>`Abstract`

Returns UmbBlockEntryContext<
BlockManagerContextTokenType,
BlockManagerContextType,
BlockEntriesContextTokenType,
BlockEntriesContextType,
BlockType,
BlockLayoutType,
BlockOriginData,
>

`Protected`_blockType

`Protected`_contentStructureHasProperties

`Protected` `Readonly`_contentValueArray

`Protected` `Optional`_entries

`Protected`_layout

`Protected` `Optional`_manager

`Protected` `Readonly`_settingsValueArray

`Protected` `Readonly`_variantId

`Readonly`actionsVisibility

`Readonly`blockType

`Readonly`contentElementTypeAlias

`Readonly`contentElementTypeIcon

`Readonly`contentElementTypeKey

`Readonly`contentElementTypeName

`Readonly`contentKey

`Readonly`contentTypeKey

`Readonly`createAfterPath

`Readonly`createBeforePath

`Readonly`hasExpose

`Readonly`index

`Readonly`label

`Readonly`layout

`Readonly`readOnlyGuard

`Readonly`settingsElementTypeKey

`Readonly`settingsKey

`Abstract` `Readonly`showContentEdit

`Readonly`unique

`Readonly`unsupported

`Readonly`workspaceEditContentPath

`Readonly`workspaceEditSettingsPath

`Readonly`workspacePath

`Protected` `Abstract`_gotContentType

`Protected` `Abstract`_gotEntries

`Protected` `Abstract`_gotManager