Class UmbExtensionRegistry<IncomingManifestTypes, IncomingConditionConfigTypes, ManifestTypes>

constructor

• new UmbExtensionRegistry<
      IncomingManifestTypes extends ManifestBase,
      IncomingConditionConfigTypes extends
          UmbConditionConfigBase<string> = UmbConditionConfigBase<string>,
      ManifestTypes extends ManifestBase = ManifestBase
      | IncomingManifestTypes,
  >(): UmbExtensionRegistry<
      IncomingManifestTypes,
      IncomingConditionConfigTypes,
      ManifestTypes,
  >

  Type Parameters

  • IncomingManifestTypes extends ManifestBase
  • IncomingConditionConfigTypes extends UmbConditionConfigBase<string> = UmbConditionConfigBase<string>
  • ManifestTypes extends ManifestBase = ManifestBase | IncomingManifestTypes

  Returns UmbExtensionRegistry<
      IncomingManifestTypes,
      IncomingConditionConfigTypes,
      ManifestTypes,
  >

Readonlyextensions

Readonlykinds

ReadonlyMANIFEST_TYPES

appendCondition

• appendCondition(alias: string, newCondition: IncomingConditionConfigTypes): void

  Append a new condition to an existing extension Useful to add a condition for example the Save And Publish workspace action shipped by core.

  Parameters

  • alias: string

    The alias of the extension to append the condition to.
  • newCondition: IncomingConditionConfigTypes

    The condition to append to the extension.

  Returns void

appendConditions

• appendConditions(
      alias: string,
      newConditions: IncomingConditionConfigTypes[],
  ): void

  Appends an array of conditions to an existing extension

  Parameters

  • alias: string

    The alias of the extension to append the condition to
  • newConditions: IncomingConditionConfigTypes[]

    An array of conditions to be appended to an extension manifest.

  Returns void

byAlias

• byAlias<T extends ManifestBase = ManifestBase>(
      alias: string,
  ): Observable<undefined | T>

  Get an observable that provides an extension matching the given alias.

  Type Parameters

  • T extends ManifestBase = ManifestBase

  Parameters

  • alias: string

    The alias of the extension to get.

  Returns Observable<undefined | T>

  • An observable of the extension that matches the alias.

byType

• byType<
      Key extends string,
      T extends
          ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>,
  >(
      type: Key,
  ): Observable<T[]>

  Get an observable that provides extensions matching the given type.

  Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key

    The type of the extensions to get.

  Returns Observable<T[]>

  • An observable of the extensions that matches the type.

byTypeAndAlias

• byTypeAndAlias<
      Key extends string,
      T extends
          ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>,
  >(
      type: Key,
      alias: string,
  ): Observable<undefined | T>

  Get an observable that provides extensions matching the given type and alias.

  Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key

    The type of the extensions to get.
  • alias: string

    The alias of the extensions to get.

  Returns Observable<undefined | T>

  • An observable of the extensions that matches the type and alias.

byTypeAndAliases

• byTypeAndAliases<
      Key extends string,
      T extends
          ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>,
  >(
      type: Key,
      aliases: string[],
  ): Observable<T[]>

  Get an observable that provides extensions matching the given type and alias.

  Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key

    The type of the extensions to get.
  • aliases: string[]

    The aliases of the extensions to get.

  Returns Observable<T[]>

  • An observable of the extensions that matches the type and one of the aliases.

byTypeAndFilter

• byTypeAndFilter<
      Key extends string,
      T extends
          ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>,
  >(
      type: Key,
      filter: (ext: T) => boolean,
  ): Observable<T[]>

  Get an observable of extensions by type and a given filter method. This will return the all extensions that matches the type and which filter method returns true. The filter method will be called for each extension manifest of the given type, and the first argument to it is the extension manifest.

  Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key

    The type of the extension to get.
  • filter: (ext: T) => boolean

    The filter method to use to filter the extensions.

  Returns Observable<T[]>

  • An observable of the extensions that matches the type and filter method.

byTypes

• byTypes<ExtensionTypes extends ManifestBase = ManifestBase>(
      types: string[],
  ): Observable<ExtensionTypes[]>

  Get an observable that provides extensions matching given types.

  Type Parameters

  • ExtensionTypes extends ManifestBase = ManifestBase

  Parameters

  • types: string[]

    The types of the extensions to get.

  Returns Observable<ExtensionTypes[]>

  • An observable of the extensions that matches the types.

byTypesAndFilter

• byTypesAndFilter<ExtensionTypes extends ManifestBase = ManifestBase>(
      types: string[],
      filter: (ext: ExtensionTypes) => boolean,
  ): Observable<ExtensionTypes[]>

  Get an observable of extensions by types and a given filter method. This will return the all extensions that matches the types and which filter method returns true. The filter method will be called for each extension manifest of the given types, and the first argument to it is the extension manifest.

  Type Parameters

  • ExtensionTypes extends ManifestBase = ManifestBase

  Parameters

  • types: string[]

    The types of the extensions to get.
  • filter: (ext: ExtensionTypes) => boolean

    The filter method to use to filter the extensions

  Returns Observable<ExtensionTypes[]>

  • An observable of the extensions that matches the type and filter method

clear

• clear(): void

  Clears all extensions and kinds from the registry.

  Returns void

  Memberof

  UmbExtensionRegistry

defineKind

• defineKind(kind: ManifestKind<ManifestTypes>): void

  Parameters

  • kind: ManifestKind<ManifestTypes>

  Returns void

exclude

• exclude(alias: string): void

  Exclude an extension from being available. Notice if you are looking to replace, then you can achieve such via the overwrites property in the manifest.

  Parameters

  • alias: string

    The alias of the extension to exclude.

  Returns void

getAllExtensions

• getAllExtensions(): ManifestTypes[]

  Get all registered extensions.

  Returns ManifestTypes[]

  • All registered extensions.

  Memberof

  UmbExtensionRegistry

getByAlias

• getByAlias<T extends ManifestBase = ManifestBase>(alias: string): undefined | T

  Get an extension that matches the given alias, this will not return an observable, it is a one of retrieval if it exists at the given point in time.

  Type Parameters

  • T extends ManifestBase = ManifestBase

  Parameters

  • alias: string

    The alias of the extension to get.

  Returns undefined | T

  • The extension manifest that matches the alias.

getByType

• getByType<
      Key extends string,
      T extends
          ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>,
  >(
      type: Key,
  ): T[]

  Get all extensions that matches the given extension type.

  Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key

    The type of the extension to get.

  Returns T[]

  • The extension manifest that matches the alias.

getByTypeAndFilter

• getByTypeAndFilter<
      Key extends string,
      T extends
          ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>,
  >(
      type: Key,
      filter: (ext: T) => boolean,
  ): T[]

  Get an extensions by type and a given filter method. This will return the all extensions that matches the type and which filter method returns true. The filter method will be called for each extension manifest of the given type, and the first argument to it is the extension manifest.

  Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key

    The type of the extension to get.
  • filter: (ext: T) => boolean

    The filter method to use to filter the extensions.

  Returns T[]

  • An observable of the extensions that matches the type and filter method.

isRegistered

• isRegistered(alias: string): boolean

  Check if an extension with the given alias is registered.

  Parameters

  • alias: string

    The alias of the extension to check.

  Returns boolean

  • true if an extension with the given alias is registered.

  Memberof

  UmbExtensionRegistry

register

• register(manifest: ManifestTypes | ManifestKind<ManifestTypes>): void

  Register an extension.

  Parameters

  • manifest: ManifestTypes | ManifestKind<ManifestTypes>

    The extension to register.

  Returns void

  Memberof

  UmbExtensionRegistry

registerMany

• registerMany(manifests: (ManifestTypes | ManifestKind<ManifestTypes>)[]): void

  Register many extensions.

  Parameters

  • manifests: (ManifestTypes | ManifestKind<ManifestTypes>)[]

    The extensions to register.

  Returns void

  Memberof

  UmbExtensionRegistry

unregister

• unregister(alias: string): void

  Unregister an extension with the given alias. Notice it is more secure to exclude it, only unregister extensions that you provided.

  Parameters

  • alias: string

    The alias of the extension to unregister.

  Returns void

  Memberof

  UmbExtensionRegistry

unregisterMany

• unregisterMany(aliases: string[]): void

  Unregister many extensions with the given aliases. Notice it is more secure to exclude it, only unregister extensions that you provided.

  Parameters

  • aliases: string[]

    The aliases of the extensions to unregister.

  Returns void

  Memberof

  UmbExtensionRegistry