Interface IContentFolderTreePathManager

Namespace

CMS.ContentEngine

Assembly

CMS.ContentEngine.dll

Provides methods for management of folder tree paths.

public interface IContentFolderTreePathManager

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

Create(string, int, CancellationToken)

Creates a new unique path under the folder specified by parentFolderId and with slug generated from folderTreePathSlugInput

Task<string> Create(string folderTreePathSlugInput, int parentFolderId, CancellationToken cancellationToken = default)

Parameters

folderTreePathSlugInput string

The slug to use to generate the path.

parentFolderId int

Id of the folder whose path to use as base.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<string>

Update(ContentFolderInfo, string, CancellationToken)

Updates the folder tree path of the contentFolder to the new path specified by newFolderPath

Task<bool> Update(ContentFolderInfo contentFolder, string newFolderPath, CancellationToken cancellationToken = default)

Parameters

contentFolder ContentFolderInfo

The folder whose path to update.

newFolderPath string

Updated path of the folder.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<bool>

Update(ContentFolderInfo, CancellationToken)

Updates the folder of the contentFolder to a path created using the parent folder's path.

Task Update(ContentFolderInfo contentFolder, CancellationToken cancellationToken = default)

Parameters

contentFolder ContentFolderInfo

The folder whose path to update

cancellationToken CancellationToken

Cancellation token

Returns

Task