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<
        {
            asObservable?: () => Observable<TreeItemType[]>;
            data?: TreeItemType[];
            error?: ProblemDetails;
        },
    >;
    requestTreeItemsOf: (
        args: TreeChildrenOfRequestArgsType,
    ) => Promise<
        {
            asObservable?: () => Observable<TreeItemType[]>;
            data?: UmbPagedModel<TreeItemType>;
            error?: ProblemDetails;
        },
    >;
    requestTreeRoot: () => Promise<
        { data?: TreeRootType; error?: ProblemDetails },
    >;
    requestTreeRootItems: (
        args: TreeRootItemsRequestArgsType,
    ) => Promise<
        {
            asObservable?: () => Observable<TreeItemType[]>;
            data?: UmbPagedModel<TreeItemType>;
            error?: ProblemDetails;
        },
    >;
    rootTreeItems: () => Promise<Observable<TreeItemType[]>>;
    treeItemsOf: (
        parentUnique: null | string,
    ) => Promise<Observable<TreeItemType[]>>;
    destroy(): void;
}

Type Parameters

Hierarchy (View Summary, Expand)

Implemented by

Properties

requestTreeItemAncestors: (
    args: TreeAncestorsOfRequestArgsType,
) => Promise<
    {
        asObservable?: () => Observable<TreeItemType[]>;
        data?: TreeItemType[];
        error?: ProblemDetails;
    },
>

Requests the ancestors of the given item.

UmbTreeRepository

requestTreeItemsOf: (
    args: TreeChildrenOfRequestArgsType,
) => Promise<
    {
        asObservable?: () => Observable<TreeItemType[]>;
        data?: UmbPagedModel<TreeItemType>;
        error?: ProblemDetails;
    },
>

Requests the children of the given parent item.

UmbTreeRepository

requestTreeRoot: () => Promise<{ data?: TreeRootType; error?: ProblemDetails }>

Requests the root of the tree.

UmbTreeRepository

requestTreeRootItems: (
    args: TreeRootItemsRequestArgsType,
) => Promise<
    {
        asObservable?: () => Observable<TreeItemType[]>;
        data?: UmbPagedModel<TreeItemType>;
        error?: ProblemDetails;
    },
>

Requests the root items of the tree.

UmbTreeRepository

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

Returns an observable of the root items of the tree.

UmbTreeRepository

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

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

UmbTreeRepository

Methods

MMNEPVFCICPMFPCPTTAAATR