View Source

Class FolderTreeControllerBase<TItem>

Inheritance

System.Object

ManagementApiControllerBase

EntityTreeControllerBase<TItem>

NamedEntityTreeControllerBase<TItem>

Namespace: Umbraco.Cms.Api.Management.Controllers.Tree

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public abstract class FolderTreeControllerBase<TItem> : NamedEntityTreeControllerBase<TItem> where TItem : FolderTreeItemResponseModel, new()

Type Parameters

Name	Description
TItem

Constructors

FolderTreeControllerBase(IEntityService)

Declaration

protected FolderTreeControllerBase(IEntityService entityService)

Parameters

Type	Name	Description
IEntityService	entityService

Properties

FolderObjectType

Declaration

protected abstract UmbracoObjectTypes FolderObjectType { get; }

Property Value

Type	Description
UmbracoObjectTypes

ItemOrdering

Declaration

protected override Ordering ItemOrdering { get; }

Property Value

Type	Description
Ordering

Methods

GetAncestorEntitiesAsync(Guid, Boolean)

Declaration

protected override async Task<IEntitySlim[]> GetAncestorEntitiesAsync(Guid descendantKey, bool includeSelf = true)

Parameters

Type	Name	Description
Guid	descendantKey
System.Boolean	includeSelf

Returns

Type	Description
Task<IEntitySlim[]>

GetPagedChildEntities(Guid, Int32, Int32, out Int64)

Declaration

protected override IEntitySlim[] GetPagedChildEntities(Guid parentKey, int skip, int take, out long totalItems)

Parameters

Type	Name	Description
Guid	parentKey
System.Int32	skip
System.Int32	take
System.Int64	totalItems

Returns

Type	Description
IEntitySlim[]

GetPagedRootEntities(Int32, Int32, out Int64)

Declaration

protected override IEntitySlim[] GetPagedRootEntities(int skip, int take, out long totalItems)

Parameters

Type	Name	Description
System.Int32	skip
System.Int32	take
System.Int64	totalItems

Returns

Type	Description
IEntitySlim[]

MapTreeItemViewModel(Nullable<Guid>, IEntitySlim)

Declaration

protected override TItem MapTreeItemViewModel(Guid? parentKey, IEntitySlim entity)

Parameters

Type	Name	Description
System.Nullable<Guid>	parentKey
IEntitySlim	entity

Returns

Type	Description
TItem

RenderFoldersOnly(Boolean)

Declaration

protected void RenderFoldersOnly(bool foldersOnly)

Parameters

Type	Name	Description
System.Boolean	foldersOnly