@umbraco-cms/backoffice
    Preparing search index...

    Interface UmbTreeRepository<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>

    Interface for a tree repository. UmbTreeRepository

    interface UmbTreeRepository<
        TreeItemType extends UmbTreeItemModel = UmbTreeItemModel,
        TreeRootType extends UmbTreeRootModel = UmbTreeRootModel,
        TreeRootItemsRequestArgsType extends
            UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs,
        TreeChildrenOfRequestArgsType extends
            UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs,
        TreeAncestorsOfRequestArgsType extends
            UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs,
    > {
        requestTreeItemAncestors: (
            args: TreeAncestorsOfRequestArgsType,
        ) => Promise<UmbRepositoryResponse<TreeItemType[]>>;
        requestTreeItemsOf: (
            args: TreeChildrenOfRequestArgsType,
        ) => Promise<
            UmbRepositoryResponseWithAsObservable<
                UmbPagedModel<TreeItemType>,
                TreeItemType[],
            >,
        >;
        requestTreeRoot: () => Promise<UmbRepositoryResponse<TreeRootType>>;
        requestTreeRootItems: (
            args: TreeRootItemsRequestArgsType,
        ) => Promise<
            UmbRepositoryResponseWithAsObservable<
                UmbPagedModel<TreeItemType>,
                TreeItemType[],
            >,
        >;
        rootTreeItems: () => Promise<Observable<TreeItemType[]>>;
        treeItemsOf: (
            parentUnique: null | string,
        ) => Promise<Observable<TreeItemType[]>>;
        destroy(): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    requestTreeItemAncestors requestTreeItemsOf requestTreeRoot requestTreeRootItems rootTreeItems treeItemsOf

    Methods

    destroy

    Properties

    requestTreeItemAncestors: (
        args: TreeAncestorsOfRequestArgsType,
    ) => Promise<UmbRepositoryResponse<TreeItemType[]>>

    Requests the ancestors of the given item.

    UmbTreeRepository

    requestTreeItemsOf: (
        args: TreeChildrenOfRequestArgsType,
    ) => Promise<
        UmbRepositoryResponseWithAsObservable<
            UmbPagedModel<TreeItemType>,
            TreeItemType[],
        >,
    >

    Requests the children of the given parent item.

    UmbTreeRepository

    requestTreeRoot: () => Promise<UmbRepositoryResponse<TreeRootType>>

    Requests the root of the tree.

    UmbTreeRepository

    requestTreeRootItems: (
        args: TreeRootItemsRequestArgsType,
    ) => Promise<
        UmbRepositoryResponseWithAsObservable<
            UmbPagedModel<TreeItemType>,
            TreeItemType[],
        >,
    >

    Requests the root items of the tree.

    UmbTreeRepository

    rootTreeItems: () => Promise<Observable<TreeItemType[]>>

    Returns an observable of the root items of the tree.

    UmbTreeRepository

    Use requestTreeRootItems instead. It will be removed in Umbraco 18.

    treeItemsOf: (
        parentUnique: null | string,
    ) => Promise<Observable<TreeItemType[]>>

    Returns an observable of the children of the given parent item.

    UmbTreeRepository

    Use requestTreeItemsOf instead. It will be removed in Umbraco 18.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods