IPageRetriever.RetrieveAsync<TPageType> Method (Action<DocumentQuery<TPageType>>, Action<IPageCacheBuilder<TPageType>>, 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<TPageType>> RetrieveAsync<TPageType>(
	Action<DocumentQuery<TPageType>> applyQueryParametersAction = null,
	Action<IPageCacheBuilder<TPageType>> buildCacheAction = null,
	Nullable<CancellationToken> cancellationToken = null
)
where TPageType : new(), TreeNode

Parameters

applyQueryParametersAction (Optional)

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

buildCacheAction (Optional)

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

cancellationToken (Optional)

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

Type Parameters

TPageType

Type of the pages to be retrieved.

Return Value

Type: Task<IEnumerable<TPageType>>

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.