Interface IWebPageFolderRetriever

Namespace

CMS.Websites

Assembly

CMS.Websites.dll

Interface for retrieving web page folders.

public interface IWebPageFolderRetriever

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

Retrieve(string, PathMatch, Action<DataQuerySettings>, CancellationToken)

Retrieves folders on path specified in pathMatch on the website channel with the name websiteName.

Task<IEnumerable<WebPageFolder>> Retrieve(string websiteName, PathMatch pathMatch, Action<DataQuerySettings> queryOptions = null, CancellationToken cancellationToken = default)

Parameters

websiteName string

Name of the website channel.

pathMatch PathMatch

Web page tree path for which the query should be limited.

queryOptions Action<DataQuerySettings>

Settings to further constraint the query.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<IEnumerable<WebPageFolder>>

Retrieve(string, PathMatch[], Action<DataQuerySettings>, CancellationToken)

Retrieves folders on paths specified in pathMatches on the website channel with the name websiteName.

Task<IEnumerable<WebPageFolder>> Retrieve(string websiteName, PathMatch[] pathMatches, Action<DataQuerySettings> queryOptions = null, CancellationToken cancellationToken = default)

Parameters

websiteName string

Name of the website channel.

pathMatches PathMatch[]

Web page tree paths for which the query should be limited.

queryOptions Action<DataQuerySettings>

Settings to further constraint the query.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<IEnumerable<WebPageFolder>>