IPageRetriever.RetrieveAsync Method (String, Action<DocumentQuery>, Action<IPageCacheBuilder<TreeNode>>, Nullable<CancellationToken>)

Asynchronously retrieves pages based on given parameters.

Namespace: Kentico.Content.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131

Syntax

Task<IEnumerable<TreeNode>> RetrieveAsync(
	string className,
	Action<DocumentQuery> applyQueryParametersAction = null,
	Action<IPageCacheBuilder<TreeNode>> buildCacheAction = null,
	Nullable<CancellationToken> cancellationToken = null
)

Parameters

className

Type: System.String
Class name defining the type of pages to be retrieved.

applyQueryParametersAction (Optional)

Type: System.Action<DocumentQuery>
Action to apply the query parameters to limit the set of retrieved pages.

buildCacheAction (Optional)

Type: System.Action<IPageCacheBuilder<TreeNode>>
Action to build cache configuration in case the result should be cached.

cancellationToken (Optional)

Type: System.Nullable<CancellationToken>
The cancellation instruction.

Return Value

Type: Task<IEnumerable<TreeNode>>

Remarks

Default parametrization is applied to reflect current site, culture and preview context. If cache is applied, current site name and culture code are included to the cache key automatically. If cache is applied, dependencies on pages included in the result as well as the page types are automatically configured.