Class UmbContentTypePropertyStructureHelper<T>

This class is a helper class for managing the structure of containers in a content type. This requires a structure manager UmbContentTypeStructureManager to manage the structure.

Type Parameters

T extends UmbContentTypeModel

Hierarchy (View Summary)

UmbControllerBase
- UmbContentTypePropertyStructureHelper

Constructors

constructor

new UmbContentTypePropertyStructureHelper<T extends UmbContentTypeModel>(
host: UmbControllerHost,
): UmbContentTypePropertyStructureHelper<T>
Type Parameters
- T extends UmbContentTypeModel
Parameters
- host: UmbControllerHost
Returns UmbContentTypePropertyStructureHelper<T>
Overrides UmbControllerBase.constructor
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:26

Properties

_host

_host: UmbControllerHost

`Readonly`propertyAliases

propertyAliases: Observable<string[]> = ...

`Readonly`propertyStructure

propertyStructure: Observable<UmbPropertyTypeModel[]> = ...

Accessors

controllerAlias

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

Methods

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

addUmbController

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

contentTypeOfProperty

contentTypeOfProperty(
propertyUnique: string,
): Promise<undefined | Observable<undefined | T>>
Parameters
- propertyUnique: string
Returns Promise<undefined | Observable<undefined | T>>
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:91

contentTypes

contentTypes(): Promise<undefined | Observable<T[]>>
Returns Promise<undefined | Observable<T[]>>
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:34

destroy

destroy(): void
Returns void
Inherited from UmbControllerBase.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 UmbControllerBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getContainerId

getContainerId(): undefined | null | string
Returns undefined | null | string
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:62

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

getHostElement

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

getStructureManager

getStructureManager(): undefined | UmbContentTypeStructureManager<T>
Returns undefined | UmbContentTypeStructureManager<T>
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:53

getUmbControllers

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

insertProperty

insertProperty(
property: UmbPropertyTypeModel,
sortOrder?: number,
): Promise<boolean>
Manipulate methods:
Parameters
- property: UmbPropertyTypeModel
- OptionalsortOrder: number
Returns Promise<boolean>
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:101

isOwnerProperty

isOwnerProperty(
propertyUnique: string,
): Promise<undefined | Observable<undefined | boolean>>
Parameters
- propertyUnique: string
Returns Promise<undefined | Observable<undefined | boolean>>
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:82

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

partialUpdateProperty

partialUpdateProperty(
propertyKey?: string,
partialUpdate?: Partial<UmbPropertyTypeModel>,
): Promise<void>
Parameters
- OptionalpropertyKey: string
- OptionalpartialUpdate: Partial<UmbPropertyTypeModel>
Returns Promise<void>
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:123

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

removeProperty

removeProperty(propertyUnique: string): Promise<boolean>
Parameters
- propertyUnique: string
Returns Promise<boolean>
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:114

removeUmbController

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

removeUmbControllerByAlias

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

setContainerId

setContainerId(value?: null | string): void
Parameters
- Optionalvalue: null | string
Returns void
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:57

setStructureManager

setStructureManager(structure: UmbContentTypeStructureManager<T>): void
Parameters
- structure: UmbContentTypeStructureManager<T>
Returns void
- Defined in src/packages/content/content-type/structure/content-type-property-structure-helper.class.ts:40

Class UmbContentTypePropertyStructureHelper<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbContentTypePropertyStructureHelper<T>

Properties

_host

ReadonlypropertyAliases

ReadonlypropertyStructure

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

contentTypeOfProperty

Parameters

Returns Promise<undefined | Observable<undefined | T>>

contentTypes

Returns Promise<undefined | Observable<T[]>>

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getContainerId

Returns undefined | null | string

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getStructureManager

Returns undefined | UmbContentTypeStructureManager<T>

getUmbControllers

Parameters

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

hostConnected

Returns void

hostDisconnected

Returns void

insertProperty

Parameters

Returns Promise<boolean>

isOwnerProperty

Parameters

Returns Promise<undefined | Observable<undefined | boolean>>

observe

Type Parameters

Parameters

Returns SpecificR

Description

Memberof

partialUpdateProperty

Parameters

Returns Promise<void>

`Readonly`propertyAliases

`Readonly`propertyStructure