Class UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>`Abstract`

Base class for a tree repository.

UmbTreeRepositoryBase

Implements

Constructors

constructor

new UmbTreeRepositoryBase<
    TreeItemType extends UmbTreeItemModel,
    TreeRootType extends UmbTreeRootModel,
    TreeRootItemsRequestArgsType extends
        UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs,
    TreeChildrenOfRequestArgsType extends
        UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs,
    TreeAncestorsOfRequestArgsType extends
        UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs,
>(
    host: UmbControllerHost,
    treeSourceConstructor: UmbTreeDataSourceConstructor<TreeItemType>,
    treeStoreContextAlias?: string | UmbContextToken<any, any>,
): UmbTreeRepositoryBase<
    TreeItemType,
    TreeRootType,
    TreeRootItemsRequestArgsType,
    TreeChildrenOfRequestArgsType,
    TreeAncestorsOfRequestArgsType,
>
Creates an instance of UmbTreeRepositoryBase.
Type Parameters
- TreeItemType extends UmbTreeItemModel
- TreeRootType extends UmbTreeRootModel
- TreeRootItemsRequestArgsType extends UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs
- TreeChildrenOfRequestArgsType extends UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs
- TreeAncestorsOfRequestArgsType extends UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs
Parameters
- host: UmbControllerHost
  The controller host for this controller to be appended to
- treeSourceConstructor: UmbTreeDataSourceConstructor<TreeItemType>
  The constructor for the tree data source
- OptionaltreeStoreContextAlias: string | UmbContextToken<any, any>
  The context alias for the tree store, if any
Returns UmbTreeRepositoryBase<
    TreeItemType,
    TreeRootType,
    TreeRootItemsRequestArgsType,
    TreeChildrenOfRequestArgsType,
    TreeAncestorsOfRequestArgsType,
>
Memberof
UmbTreeRepositoryBase
Overrides UmbRepositoryBase.constructor
- Defined in src/packages/core/tree/data/tree-repository-base.ts:56

Properties

_host

_host: UmbControllerHost

`Protected`_init

_init: Promise<unknown>

`Protected`_treeSource

_treeSource: UmbTreeDataSource<TreeItemType>

`Protected` `Optional`_treeStore

_treeStore?: UmbTreeStore<TreeItemType>

Accessors

controllerAlias

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

addUmbController

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

destroy

destroy(): void
Returns void
Implementation of UmbApi.destroy
Inherited from UmbRepositoryBase.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 UmbRepositoryBase.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 UmbRepositoryBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbRepositoryBase.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 UmbRepositoryBase.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

hasUmbController

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

hostConnected

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

hostDisconnected

hostDisconnected(): void
Returns void
Inherited from UmbRepositoryBase.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 UmbRepositoryBase.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 UmbRepositoryBase.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 UmbRepositoryBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

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

removeUmbControllerByAlias

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

requestTreeItemAncestors

requestTreeItemAncestors(
args: TreeAncestorsOfRequestArgsType,
): Promise<{ data: undefined | TreeItemType[]; error: any }>
Requests ancestors of a given item
Parameters
- args: TreeAncestorsOfRequestArgsType
Returns Promise<{ data: undefined | TreeItemType[]; error: any }>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.requestTreeItemAncestors
- Defined in src/packages/core/tree/data/tree-repository-base.ts:159

requestTreeItemsOf

requestTreeItemsOf(
    args: TreeChildrenOfRequestArgsType,
): Promise<
    {
        asObservable: () => undefined | Observable<TreeItemType[]>;
        data: undefined | UmbPagedModel<TreeItemType>;
        error: undefined | Error | UmbApiError | UmbCancelError | UmbError;
    },
>
Requests tree items of a given parent
Parameters
- args: TreeChildrenOfRequestArgsType
Returns Promise<
    {
        asObservable: () => undefined | Observable<TreeItemType[]>;
        data: undefined | UmbPagedModel<TreeItemType>;
        error: undefined | Error | UmbApiError | UmbCancelError | UmbError;
    },
>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.requestTreeItemsOf
- Defined in src/packages/core/tree/data/tree-repository-base.ts:128

`Abstract`requestTreeRoot

requestTreeRoot(): Promise<UmbRepositoryResponse<TreeRootType>>
Request the tree root item

Returns Promise<UmbRepositoryResponse<TreeRootType>>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.requestTreeRoot
- Defined in src/packages/core/tree/data/tree-repository-base.ts:91

requestTreeRootItems

requestTreeRootItems(
    args: TreeRootItemsRequestArgsType,
): Promise<
    {
        asObservable: () => undefined | Observable<TreeItemType[]>;
        data: undefined | UmbPagedModel<TreeItemType>;
        error: undefined | Error | UmbApiError | UmbCancelError | UmbError;
    },
>
Requests root items of a tree
Parameters
- args: TreeRootItemsRequestArgsType
Returns Promise<
    {
        asObservable: () => undefined | Observable<TreeItemType[]>;
        data: undefined | UmbPagedModel<TreeItemType>;
        error: undefined | Error | UmbApiError | UmbCancelError | UmbError;
    },
>
Memberof
UmbTreeRepositoryBase
Implementation of UmbTreeRepository.requestTreeRootItems
- Defined in src/packages/core/tree/data/tree-repository-base.ts:99

rootTreeItems

rootTreeItems(): Promise<Observable<TreeItemType[]>>
Returns a promise with an observable of tree root items

Returns Promise<Observable<TreeItemType[]>>
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.
Implementation of UmbTreeRepository.rootTreeItems
- Defined in src/packages/core/tree/data/tree-repository-base.ts:176

treeItemsOf

treeItemsOf(parentUnique: null | string): Promise<Observable<TreeItemType[]>>
Returns a promise with an observable of children items of a given parent
Parameters
- parentUnique: null | string
Returns Promise<Observable<TreeItemType[]>>
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.
Implementation of UmbTreeRepository.treeItemsOf
- Defined in src/packages/core/tree/data/tree-repository-base.ts:189

Class UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>Abstract

Implements

Implements

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbTreeRepositoryBase< TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType,>

Memberof

Properties

_host

Protected_init

Protected_treeSource

Protected Optional_treeStore

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

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

removeUmbController

Parameters

Returns void

removeUmbControllerByAlias

Class UmbTreeRepositoryBase<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>`Abstract`

Returns UmbTreeRepositoryBase<
TreeItemType,
TreeRootType,
TreeRootItemsRequestArgsType,
TreeChildrenOfRequestArgsType,
TreeAncestorsOfRequestArgsType,
>

`Protected`_init

`Protected`_treeSource

`Protected` `Optional`_treeStore

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

`Abstract`requestTreeRoot

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