Interface UmbSortChildrenOfDataSource

interface UmbSortChildrenOfDataSource {
    sortChildrenOf(
        args: UmbSortChildrenOfArgs,
    ): Promise<UmbDataSourceErrorResponse>;
    sortChildrenOfByField?(
        args: UmbSortChildrenOfByFieldArgs,
    ): Promise<UmbDataSourceErrorResponse>;
}

Index

Methods

sortChildrenOf sortChildrenOfByField?

Methods

sortChildrenOf

sortChildrenOf(args: UmbSortChildrenOfArgs): Promise<UmbDataSourceErrorResponse>
Persists an explicit sort order for the children of an entity.
Parameters
- args: UmbSortChildrenOfArgs
  the parent and the ordered children
Returns Promise<UmbDataSourceErrorResponse>
the result of the operation
- Defined in src/packages/core/tree/entity-actions/sort-children-of/sort-children-of-data-source.interface.ts:10

`Optional`sortChildrenOfByField

sortChildrenOfByField?(
args: UmbSortChildrenOfByFieldArgs,
): Promise<UmbDataSourceErrorResponse>
Sorts the children of an entity by a single field on the server. Optional: only implemented by data sources whose entity supports server-side field sorting.
Parameters
- args: UmbSortChildrenOfByFieldArgs
  the parent, field and direction
Returns Promise<UmbDataSourceErrorResponse>
the result of the operation
- Defined in src/packages/core/tree/entity-actions/sort-children-of/sort-children-of-data-source.interface.ts:18