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

Interface for a tree repository. UmbTreeRepository

interface UmbTreeRepository<TreeItemType, TreeRootType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType> {
    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 full)

Implemented by

Properties

requestTreeItemAncestors requestTreeItemsOf requestTreeRoot requestTreeRootItems rootTreeItems treeItemsOf

Methods

destroy

Properties

requestTreeItemAncestors

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

Requests the ancestors of the given item.

Memberof

UmbTreeRepository

requestTreeItemsOf

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

Requests the children of the given parent item.

Memberof

UmbTreeRepository

requestTreeRoot

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

Requests the root of the tree.

Memberof

UmbTreeRepository

requestTreeRootItems

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

Requests the root items of the tree.

Memberof

UmbTreeRepository

rootTreeItems

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

Returns an observable of the root items of the tree.

Memberof

UmbTreeRepository

treeItemsOf

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

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

Memberof

UmbTreeRepository

Methods

destroy

Settings

Member Visibility

On This Page

Properties
Methods
""