Interface UmbContentTypeStructureDataSource<ItemType>

interface UmbContentTypeStructureDataSource<ItemType> {
    getAllowedChildrenOf(
        unique: string | null,
        parentContentUnique: string | null,
        paging?: UmbOffsetPaginationRequestModel,
    ): Promise<UmbDataSourceResponse<UmbPagedModel<ItemType>>>;
    getAllowedParentsOf?(
        unique: string,
    ): Promise<UmbDataSourceResponse<UmbEntityModel[]>>;
}

Type Parameters

ItemType

Hierarchy (View Summary)

UmbContentTypeStructureDataSource
- UmbDocumentTypeStructureDataSource
- UmbMediaTypeStructureDataSource

Implemented by

UmbContentTypeStructureServerDataSourceBase

Index

Methods

getAllowedChildrenOf getAllowedParentsOf?

Methods

getAllowedChildrenOf

getAllowedChildrenOf(
    unique: string | null,
    parentContentUnique: string | null,
    paging?: UmbOffsetPaginationRequestModel,
): Promise<UmbDataSourceResponse<UmbPagedModel<ItemType>>>
Returns a single page of the content types allowed as children.
Parameters
- unique: string | null
  The content type to get the allowed children of, or null for the root.
- parentContentUnique: string | null
  The content item the children will be created under, if any.
- Optionalpaging: UmbOffsetPaginationRequestModel
  The page to return. Implementations must honour this, as a source that ignores it returns the same page repeatedly when a caller pages through the full set.
Returns Promise<UmbDataSourceResponse<UmbPagedModel<ItemType>>>
A promise resolving to { data: { items, total } }, or { error }.
- Defined in src/packages/content/content-type/repository/structure/content-type-structure-data-source.interface.ts:19

`Optional`getAllowedParentsOf

getAllowedParentsOf?(
unique: string,
): Promise<UmbDataSourceResponse<UmbEntityModel[]>>
Parameters
- unique: string
Returns Promise<UmbDataSourceResponse<UmbEntityModel[]>>
- Defined in src/packages/content/content-type/repository/structure/content-type-structure-data-source.interface.ts:24