Class UmbExtensionsApiInitializer<ManifestTypes, ManifestTypeName, ManifestType, ManifestTypeAsApi, ControllerType, MyPermittedControllerType>

This Controller manages a set of Extensions and their Manifest. When one or more extensions is permitted to be used, the callback gives all permitted extensions and their manifest.

Example

TODO: Correct this, start using builder pattern:
const controller = new UmbExtensionsApiInitializer(host, extensionRegistry, type, ['constructor argument 1', 'constructor argument '], filter?, (permitted, ctrl) => { console.log("Extension is permitted and this is the manifest: ", ctrl.manifest) }));

UmbExtensionsApiInitializer

Type Parameters

ManifestTypes extends ManifestApi
ManifestTypeName extends string = string
ManifestType extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, ManifestTypeName>
ManifestTypeAsApi extends ManifestApi = ManifestType extends ManifestApi ? ManifestType : never
ControllerType extends UmbExtensionApiInitializer<ManifestTypeAsApi> = UmbExtensionApiInitializer<ManifestTypeAsApi>
MyPermittedControllerType extends ControllerType = PermittedControllerType<ControllerType>

Hierarchy (View Summary)

UmbBaseExtensionsInitializer<
    ManifestTypes,
    ManifestTypeName,
    ManifestTypeAsApi,
    ControllerType,
    MyPermittedControllerType,
>
- UmbExtensionsApiInitializer

Constructors

constructor

new UmbExtensionsApiInitializer<
    ManifestTypes extends ManifestApi<UmbApi>,
    ManifestTypeName extends string = string,
    ManifestType extends
        ManifestBase = SpecificManifestTypeOrManifestBase<
        ManifestTypes,
        ManifestTypeName,
    >,
    ManifestTypeAsApi extends
        ManifestApi<UmbApi> = ManifestType extends ManifestApi<UmbApi>
        ? ManifestType<ManifestType>
        : never,
    ControllerType extends
        UmbExtensionApiInitializer<
            ManifestTypeAsApi,
            any,
            ManifestTypeAsApi extends ManifestApi<UmbApi>
                ? NonNullable<ManifestTypeAsApi<ManifestTypeAsApi>["API_TYPE"]>
                : UmbApi,
        > = UmbExtensionApiInitializer<
        ManifestTypeAsApi,
        any,
        ManifestTypeAsApi extends ManifestApi<UmbApi>
            ? NonNullable<ManifestTypeAsApi<ManifestTypeAsApi>["API_TYPE"]>
            : UmbApi,
    >,
    MyPermittedControllerType extends
        UmbExtensionApiInitializer<
            ManifestTypeAsApi,
            any,
            ManifestTypeAsApi extends ManifestApi<UmbApi>
                ? NonNullable<ManifestTypeAsApi<ManifestTypeAsApi>["API_TYPE"]>
                : UmbApi,
        > = PermittedControllerType<ControllerType>,
>(
    host: UmbControllerHost,
    extensionRegistry: UmbExtensionRegistry<ManifestTypes>,
    type: ManifestTypeName | ManifestTypeName[],
    constructorArguments:
        | undefined
        | unknown[]
        | UmbApiConstructorArgumentsMethodType<ManifestTypeAsApi>,
    filter?: null | ((manifest: ManifestTypeAsApi) => boolean),
    onChange?: (permittedManifests: MyPermittedControllerType[]) => void,
    controllerAlias?: string,
    args?: UmbExtensionsApiInitializerArgs,
): UmbExtensionsApiInitializer<
    ManifestTypes,
    ManifestTypeName,
    ManifestType,
    ManifestTypeAsApi,
    ControllerType,
    MyPermittedControllerType,
>
Type Parameters
- ManifestTypes extends ManifestApi<UmbApi>
- ManifestTypeName extends string = string
- ManifestType extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, ManifestTypeName>
- ManifestTypeAsApi extends ManifestApi<UmbApi> = ManifestType extends ManifestApi<UmbApi> ? ManifestType<ManifestType> : never
- ControllerType extends UmbExtensionApiInitializer<
      ManifestTypeAsApi,
      any,
      ManifestTypeAsApi extends ManifestApi<UmbApi>
          ? NonNullable<ManifestTypeAsApi<ManifestTypeAsApi>["API_TYPE"]>
          : UmbApi,
  > = UmbExtensionApiInitializer<
      ManifestTypeAsApi,
      any,
      ManifestTypeAsApi extends ManifestApi<UmbApi>
          ? NonNullable<ManifestTypeAsApi<ManifestTypeAsApi>["API_TYPE"]>
          : UmbApi,
  >
- MyPermittedControllerType extends UmbExtensionApiInitializer<
      ManifestTypeAsApi,
      any,
      ManifestTypeAsApi extends ManifestApi<UmbApi>
          ? NonNullable<ManifestTypeAsApi<ManifestTypeAsApi>["API_TYPE"]>
          : UmbApi,
  > = PermittedControllerType<ControllerType>
Parameters
- host: UmbControllerHost
- extensionRegistry: UmbExtensionRegistry<ManifestTypes>
- type: ManifestTypeName | ManifestTypeName[]
- constructorArguments: undefined | unknown[] | UmbApiConstructorArgumentsMethodType<ManifestTypeAsApi>
- Optionalfilter: null | ((manifest: ManifestTypeAsApi) => boolean)
- OptionalonChange: (permittedManifests: MyPermittedControllerType[]) => void
- OptionalcontrollerAlias: string
- Optionalargs: UmbExtensionsApiInitializerArgs
Returns UmbExtensionsApiInitializer<
    ManifestTypes,
    ManifestTypeName,
    ManifestType,
    ManifestTypeAsApi,
    ControllerType,
    MyPermittedControllerType,
>
Overrides UmbBaseExtensionsInitializer.constructor
- Defined in src/libs/extension-api/controller/extensions-api-initializer.controller.ts:59

Properties

`Protected`_extensions

_extensions: ControllerType[] = []

_host

_host: UmbControllerHost

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbBaseExtensionsInitializer.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 UmbBaseExtensionsInitializer.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbBaseExtensionsInitializer.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

asPromise

asPromise(): Promise<void>
Returns Promise<void>
Inherited from UmbBaseExtensionsInitializer.asPromise
- Defined in src/libs/extension-api/controller/base-extensions-initializer.controller.ts:41

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 UmbBaseExtensionsInitializer.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

destroy(): void
Returns void
Overrides UmbBaseExtensionsInitializer.destroy
- Defined in src/libs/extension-api/controller/extensions-api-initializer.controller.ts:87

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

getHostElement

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

getUmbControllers

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

hasUmbController

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

hostConnected

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

hostDisconnected

hostDisconnected(): void
Returns void
Inherited from UmbBaseExtensionsInitializer.hostDisconnected
- Defined in src/libs/extension-api/controller/base-extensions-initializer.controller.ts:204

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

removeUmbController

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

removeUmbControllerByAlias

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

Class UmbExtensionsApiInitializer<ManifestTypes, ManifestTypeName, ManifestType, ManifestTypeAsApi, ControllerType, MyPermittedControllerType>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbExtensionsApiInitializer< ManifestTypes, ManifestTypeName, ManifestType, ManifestTypeAsApi, ControllerType, MyPermittedControllerType,>

Properties

Protected_extensions

_host

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

Protected_createController

Parameters

Returns ControllerType

Protected_extensionChanged

Parameters

Returns void

Protected_init

Returns void

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

asPromise

Returns Promise<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

getHostElement

Returns Element

getUmbControllers

Parameters

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

hostConnected

Returns void

hostDisconnected

Returns void

observe

Type Parameters

Parameters

Returns SpecificR

Description

Memberof

provideContext

Type Parameters

Parameters

Returns UmbContextProviderController<R>

Description

Memberof

removeEventListener

Parameters

Returns UmbExtensionsApiInitializer<
ManifestTypes,
ManifestTypeName,
ManifestType,
ManifestTypeAsApi,
ControllerType,
MyPermittedControllerType,
>

`Protected`_extensions

`Protected`_createController

`Protected`_extensionChanged

`Protected`_init