Class UmbMediaTreeRepository

_host

controllerAlias

• get controllerAlias(): UmbControllerAlias

  Returns UmbControllerAlias

addUmbController

• addUmbController(controller: UmbController): void

  Parameters

  • controller: UmbController

  Returns void

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

destroy

• destroy(): void

  Returns void

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

getHostElement

• getHostElement(): Element

  Returns Element

getUmbControllers

• getUmbControllers(
      filterMethod: (ctrl: UmbController) => boolean,
  ): UmbController[]

  Parameters

  • filterMethod: (ctrl: UmbController) => boolean

  Returns UmbController[]

hasUmbController

• hasUmbController(controller: UmbController): boolean

  Parameters

  • controller: UmbController

  Returns boolean

hostConnected

• hostConnected(): void

  Returns void

hostDisconnected

• hostDisconnected(): void

  Returns void

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

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

removeUmbController

• removeUmbController(controller: UmbController): void

  Parameters

  • controller: UmbController

  Returns void

removeUmbControllerByAlias

• removeUmbControllerByAlias(unique: UmbControllerAlias): void

  Parameters

  • unique: UmbControllerAlias

  Returns void

requestTreeItemAncestors

• requestTreeItemAncestors(
      args: UmbTreeAncestorsOfRequestArgs,
  ): Promise<{ data: undefined | UmbMediaTreeItemModel[]; error: any }>

  Requests ancestors of a given item

  Parameters

  • args: UmbTreeAncestorsOfRequestArgs

  Returns Promise<{ data: undefined | UmbMediaTreeItemModel[]; error: any }>

  Memberof

  UmbTreeRepositoryBase

requestTreeItemsOf

• requestTreeItemsOf(
      args: UmbMediaTreeChildrenOfRequestArgs,
  ): Promise<
      {
          asObservable: () => undefined | Observable<UmbMediaTreeItemModel[]>;
          data: undefined | UmbPagedModel<UmbMediaTreeItemModel>;
          error: undefined | Error | UmbApiError | UmbCancelError | UmbError;
      },
  >

  Requests tree items of a given parent

  Parameters

  • args: UmbMediaTreeChildrenOfRequestArgs

  Returns Promise<
      {
          asObservable: () => undefined | Observable<UmbMediaTreeItemModel[]>;
          data: undefined | UmbPagedModel<UmbMediaTreeItemModel>;
          error: undefined | Error | UmbApiError | UmbCancelError | UmbError;
      },
  >

  Memberof

  UmbTreeRepositoryBase

requestTreeRootItems

• requestTreeRootItems(
      args: UmbMediaTreeRootItemsRequestArgs,
  ): Promise<
      {
          asObservable: () => undefined | Observable<UmbMediaTreeItemModel[]>;
          data: undefined | UmbPagedModel<UmbMediaTreeItemModel>;
          error: undefined | Error | UmbApiError | UmbCancelError | UmbError;
      },
  >

  Requests root items of a tree

  Parameters

  • args: UmbMediaTreeRootItemsRequestArgs

  Returns Promise<
      {
          asObservable: () => undefined | Observable<UmbMediaTreeItemModel[]>;
          data: undefined | UmbPagedModel<UmbMediaTreeItemModel>;
          error: undefined | Error | UmbApiError | UmbCancelError | UmbError;
      },
  >

  Memberof

  UmbTreeRepositoryBase

rootTreeItems

• rootTreeItems(): Promise<Observable<UmbMediaTreeItemModel[]>>

  Returns a promise with an observable of tree root items

  Returns Promise<Observable<UmbMediaTreeItemModel[]>>

  Memberof

  UmbTreeRepositoryBase

  Deprecated

  Use requestTreeRootItems instead. This method requires the tree store to be available, which is not always the case. It will be removed in Umbraco 18.

treeItemsOf

• treeItemsOf(
      parentUnique: null | string,
  ): Promise<Observable<UmbMediaTreeItemModel[]>>

  Returns a promise with an observable of children items of a given parent

  Parameters

  • parentUnique: null | string

  Returns Promise<Observable<UmbMediaTreeItemModel[]>>

  Memberof

  UmbTreeRepositoryBase

  Deprecated

  Use requestTreeItemsOf instead. This method requires the tree store to be available, which is not always the case. It will be removed in Umbraco 18.