Interface UmbSortChildrenOfRepository

interface UmbSortChildrenOfRepository {
    destroy(): void;
    requestSortByFieldOptions?(): Promise<UmbSortChildrenByFieldOption[]>;
    sortChildrenOf(
        args: UmbSortChildrenOfArgs,
    ): Promise<UmbRepositoryErrorResponse>;
    sortChildrenOfByField?(
        args: UmbSortChildrenOfByFieldArgs,
    ): Promise<UmbRepositoryErrorResponse>;
}

Hierarchy (View Summary)

UmbApi
- UmbSortChildrenOfRepository

Implemented by

UmbSortChildrenOfDocumentRepository

Index

Methods

destroy requestSortByFieldOptions? sortChildrenOf sortChildrenOfByField?

Methods

destroy

destroy(): void
Returns void
Inherited from UmbApi.destroy
- Defined in src/libs/extension-api/models/api.interface.ts:2

`Optional`requestSortByFieldOptions

requestSortByFieldOptions?(): Promise<UmbSortChildrenByFieldOption[]>
Requests the fields the children of an entity can be sorted by on the server. Optional: only implemented by repositories whose entity supports server-side field sorting.

Returns Promise<UmbSortChildrenByFieldOption[]>
the available fields
- Defined in src/packages/core/tree/entity-actions/sort-children-of/sort-children-of-repository.interface.ts:26

sortChildrenOf

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

`Optional`sortChildrenOfByField

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