View Source

Class ContentTreeController

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.ControllerBase

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

TreeControllerBase

TreeController

ContentTreeControllerBase

Namespace: Umbraco.Cms.Web.BackOffice.Trees

Assembly: Umbraco.Web.BackOffice.dll

Syntax

[Authorize(Policy = "SectionAccessForContentTree")]
[PluginController("UmbracoTrees")]
public class ContentTreeController : ContentTreeControllerBase, IUmbracoFeature, ITree, ITreeNodeController, ISearchableTreeWithCulture, ISearchableTree, IDiscoverable

Constructors

ContentTreeController(ILocalizedTextService, UmbracoApiControllerTypeCollection, IMenuItemCollectionFactory, IEntityService, IBackOfficeSecurityAccessor, ILogger<ContentTreeController>, ActionCollection, IUserService, IDataTypeService, UmbracoTreeSearcher, ActionCollection, IContentService, IPublicAccessService, ILocalizationService, IEventAggregator, IEmailSender, AppCaches)

Declaration

public ContentTreeController(ILocalizedTextService localizedTextService, UmbracoApiControllerTypeCollection umbracoApiControllerTypeCollection, IMenuItemCollectionFactory menuItemCollectionFactory, IEntityService entityService, IBackOfficeSecurityAccessor backofficeSecurityAccessor, ILogger<ContentTreeController> logger, ActionCollection actionCollection, IUserService userService, IDataTypeService dataTypeService, UmbracoTreeSearcher treeSearcher, ActionCollection actions, IContentService contentService, IPublicAccessService publicAccessService, ILocalizationService localizationService, IEventAggregator eventAggregator, IEmailSender emailSender, AppCaches appCaches)

Parameters

Type	Name	Description
ILocalizedTextService	localizedTextService
UmbracoApiControllerTypeCollection	umbracoApiControllerTypeCollection
IMenuItemCollectionFactory	menuItemCollectionFactory
IEntityService	entityService
IBackOfficeSecurityAccessor	backofficeSecurityAccessor
Microsoft.Extensions.Logging.ILogger<ContentTreeController>	logger
ActionCollection	actionCollection
IUserService	userService
IDataTypeService	dataTypeService
UmbracoTreeSearcher	treeSearcher
ActionCollection	actions
IContentService	contentService
IPublicAccessService	publicAccessService
ILocalizationService	localizationService
IEventAggregator	eventAggregator
IEmailSender	emailSender
AppCaches	appCaches

Properties

RecycleBinId

Declaration

protected override int RecycleBinId { get; }

Property Value

Type	Description
System.Int32

RecycleBinSmells

Declaration

protected override bool RecycleBinSmells { get; }

Property Value

Type	Description
System.Boolean

UmbracoObjectType

Declaration

protected override UmbracoObjectTypes UmbracoObjectType { get; }

Property Value

Type	Description
UmbracoObjectTypes

UserStartNodes

Declaration

protected override int[] UserStartNodes { get; }

Property Value

Type	Description
System.Int32[]

Methods

GetAllNodeMenuItems(IUmbracoEntity)

Returns a collection of all menu items that can be on a content node

Declaration

protected MenuItemCollection GetAllNodeMenuItems(IUmbracoEntity item)

Parameters

Type	Name	Description
IUmbracoEntity	item

Returns

Type	Description
MenuItemCollection

GetChildEntities(String, FormCollection)

Declaration

protected override ActionResult<IEnumerable<IEntitySlim>> GetChildEntities(string id, FormCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
Microsoft.AspNetCore.Http.FormCollection	queryStrings

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<IEnumerable<IEntitySlim>>

GetNodeMenuItemsForDeletedContent(IUmbracoEntity)

Returns a collection of all menu items that can be on a deleted (in recycle bin) content node

Declaration

protected MenuItemCollection GetNodeMenuItemsForDeletedContent(IUmbracoEntity item)

Parameters

Type	Name	Description
IUmbracoEntity	item

Returns

Type	Description
MenuItemCollection

GetSingleTreeNode(IEntitySlim, String, FormCollection)

Declaration

protected override TreeNode GetSingleTreeNode(IEntitySlim entity, string parentId, FormCollection queryStrings)

Parameters

Type	Name	Description
IEntitySlim	entity
System.String	parentId
Microsoft.AspNetCore.Http.FormCollection	queryStrings

Returns

Type	Description
TreeNode

HasPathAccess(String, FormCollection)

Returns true or false if the current user has access to the node based on the user's allowed start node (path) access

Declaration

protected override bool HasPathAccess(string id, FormCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
Microsoft.AspNetCore.Http.FormCollection	queryStrings

Returns

Type	Description
System.Boolean

PerformGetMenuForNode(String, FormCollection)

Declaration

protected override ActionResult<MenuItemCollection> PerformGetMenuForNode(string id, FormCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
Microsoft.AspNetCore.Http.FormCollection	queryStrings

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<MenuItemCollection>

SearchAsync(String, Int32, Int64, String)

Declaration

public async Task<EntitySearchResults> SearchAsync(string query, int pageSize, long pageIndex, string searchFrom = null)

Parameters

Type	Name	Description
System.String	query
System.Int32	pageSize
System.Int64	pageIndex
System.String	searchFrom

Returns

Type	Description
Task<EntitySearchResults>

SearchAsync(String, Int32, Int64, String, String)

Declaration

public async Task<EntitySearchResults> SearchAsync(string query, int pageSize, long pageIndex, string searchFrom = null, string culture = null)

Parameters

Type	Name	Description
System.String	query
System.Int32	pageSize
System.Int64	pageIndex
System.String	searchFrom
System.String	culture

Returns

Type	Description
Task<EntitySearchResults>