Class UmbTreeServerDataSourceBase<ServerTreeItemType, ClientTreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>`Abstract`

A data source for a tree that fetches data from the server UmbTreeServerDataSourceBase

Implements

Type Parameters

ServerTreeItemType extends { hasChildren: boolean }
ClientTreeItemType extends UmbTreeItemModel
TreeRootItemsRequestArgsType extends UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs
TreeChildrenOfRequestArgsType extends UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs
TreeAncestorsOfRequestArgsType extends UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs

Implements

UmbTreeDataSource<
    ClientTreeItemType,
    TreeRootItemsRequestArgsType,
    TreeChildrenOfRequestArgsType,
    TreeAncestorsOfRequestArgsType,
>

Index

Constructors

constructor

Methods

getAncestorsOf getChildrenOf getRootItems

Constructors

constructor

new UmbTreeServerDataSourceBase<
    ServerTreeItemType extends { hasChildren: boolean },
    ClientTreeItemType extends UmbTreeItemModel,
    TreeRootItemsRequestArgsType extends
        UmbTreeRootItemsRequestArgs = UmbTreeRootItemsRequestArgs,
    TreeChildrenOfRequestArgsType extends
        UmbTreeChildrenOfRequestArgs = UmbTreeChildrenOfRequestArgs,
    TreeAncestorsOfRequestArgsType extends
        UmbTreeAncestorsOfRequestArgs = UmbTreeAncestorsOfRequestArgs,
>(
    host: UmbControllerHost,
    args: UmbTreeServerDataSourceBaseArgs<
        ServerTreeItemType,
        ClientTreeItemType,
        TreeRootItemsRequestArgsType,
        TreeChildrenOfRequestArgsType,
        TreeAncestorsOfRequestArgsType,
    >,
): UmbTreeServerDataSourceBase<
    ServerTreeItemType,
    ClientTreeItemType,
    TreeRootItemsRequestArgsType,
    TreeChildrenOfRequestArgsType,
    TreeAncestorsOfRequestArgsType,
>
Creates an instance of UmbTreeServerDataSourceBase.
Type Parameters
- ServerTreeItemType extends { hasChildren: boolean }
- ClientTreeItemType extends UmbTreeItemModel
- 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
- args: UmbTreeServerDataSourceBaseArgs<
      ServerTreeItemType,
      ClientTreeItemType,
      TreeRootItemsRequestArgsType,
      TreeChildrenOfRequestArgsType,
      TreeAncestorsOfRequestArgsType,
  >
Returns UmbTreeServerDataSourceBase<
    ServerTreeItemType,
    ClientTreeItemType,
    TreeRootItemsRequestArgsType,
    TreeChildrenOfRequestArgsType,
    TreeAncestorsOfRequestArgsType,
>
Memberof
UmbTreeServerDataSourceBase
- Defined in src/packages/core/tree/data/tree-server-data-source-base.ts:60

Methods

getAncestorsOf

getAncestorsOf(
    args: TreeAncestorsOfRequestArgsType,
): Promise<
    | { data: ClientTreeItemType[]; error?: undefined }
    | {
        data?: undefined;
        error:
            | undefined
            | (
                (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
            );
    },
>
Fetches the ancestors of a given item from the server
Parameters
- args: TreeAncestorsOfRequestArgsType
Returns Promise<
    | { data: ClientTreeItemType[]; error?: undefined }
    | {
        data?: undefined;
        error:
            | undefined
            | (
                (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
            );
    },
>
Memberof
UmbTreeServerDataSourceBase
Implementation of UmbTreeDataSource.getAncestorsOf
- Defined in src/packages/core/tree/data/tree-server-data-source-base.ts:119

getChildrenOf

getChildrenOf(
    args: TreeChildrenOfRequestArgsType,
): Promise<
    | {
        data: { items: ClientTreeItemType[]; total: number };
        error?: undefined;
    }
    | {
        data?: undefined;
        error: | undefined
        | (
            (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
        );
    },
>
Fetches the children of a given parent unique from the server
Parameters
- args: TreeChildrenOfRequestArgsType
Returns Promise<
    | {
        data: { items: ClientTreeItemType[]; total: number };
        error?: undefined;
    }
    | {
        data?: undefined;
        error: | undefined
        | (
            (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
        );
    },
>
Memberof
UmbTreeServerDataSourceBase
Implementation of UmbTreeDataSource.getChildrenOf
- Defined in src/packages/core/tree/data/tree-server-data-source-base.ts:100

getRootItems

getRootItems(
    args: TreeRootItemsRequestArgsType,
): Promise<
    | {
        data: { items: ClientTreeItemType[]; total: number };
        error?: undefined;
    }
    | {
        data?: undefined;
        error: | undefined
        | (
            (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
        );
    },
>
Fetches the root items for the tree from the server
Parameters
- args: TreeRootItemsRequestArgsType
Returns Promise<
    | {
        data: { items: ClientTreeItemType[]; total: number };
        error?: undefined;
    }
    | {
        data?: undefined;
        error: | undefined
        | (
            (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
        );
    },
>
Memberof
UmbTreeServerDataSourceBase
Implementation of UmbTreeDataSource.getRootItems
- Defined in src/packages/core/tree/data/tree-server-data-source-base.ts:83

Class UmbTreeServerDataSourceBase<ServerTreeItemType, ClientTreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>`Abstract`

Implements

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbTreeServerDataSourceBase<
    ServerTreeItemType,
    ClientTreeItemType,
    TreeRootItemsRequestArgsType,
    TreeChildrenOfRequestArgsType,
    TreeAncestorsOfRequestArgsType,
>

Memberof

Methods

getAncestorsOf

Parameters

Returns Promise<
    | { data: ClientTreeItemType[]; error?: undefined }
    | {
        data?: undefined;
        error:
            | undefined
            | (
                (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
            );
    },
>

Memberof

getChildrenOf

Parameters

Memberof

getRootItems

Parameters

Memberof

Settings

On This Page

Class UmbTreeServerDataSourceBase<ServerTreeItemType, ClientTreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>Abstract

Implements

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbTreeServerDataSourceBase< ServerTreeItemType, ClientTreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType,>

Memberof

Methods

getAncestorsOf

Parameters

Returns Promise< | { data: ClientTreeItemType[]; error?: undefined } | { data?: undefined; error: | undefined | ( (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError) ); },>

Memberof

getChildrenOf

Parameters

Returns Promise< | { data: { items: ClientTreeItemType[]; total: number }; error?: undefined; } | { data?: undefined; error: | undefined | ( (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError) ); },>

Memberof

getRootItems

Parameters

Returns Promise< | { data: { items: ClientTreeItemType[]; total: number }; error?: undefined; } | { data?: undefined; error: | undefined | ( (Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError) ); },>

Memberof

Settings

On This Page

Class UmbTreeServerDataSourceBase<ServerTreeItemType, ClientTreeItemType, TreeRootItemsRequestArgsType, TreeChildrenOfRequestArgsType, TreeAncestorsOfRequestArgsType>`Abstract`

Returns UmbTreeServerDataSourceBase<
ServerTreeItemType,
ClientTreeItemType,
TreeRootItemsRequestArgsType,
TreeChildrenOfRequestArgsType,
TreeAncestorsOfRequestArgsType,
>

Returns Promise<
| { data: ClientTreeItemType[]; error?: undefined }
| {
data?: undefined;
error:
| undefined
| (
(Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
);
},
>

Returns Promise<
| {
data: { items: ClientTreeItemType[]; total: number };
error?: undefined;
}
| {
data?: undefined;
error: | undefined
| (
(Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
);
},
>

Returns Promise<
| {
data: { items: ClientTreeItemType[]; total: number };
error?: undefined;
}
| {
data?: undefined;
error: | undefined
| (
(Error | UmbApiError | UmbCancelError | UmbError) & (UmbApiError | UmbCancelError)
);
},
>