Class RetrievePagesByGuidsExtensions

Namespace

Kentico.Content.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Extensions for the RetrievePages<TSource, TResult>(RetrievePagesParameters, Action<RetrievePagesQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>>, CancellationToken) method allowing to specify GUIDs of results.

public static class RetrievePagesByGuidsExtensions

Inheritance

object

RetrievePagesByGuidsExtensions

Methods

RetrievePagesByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, RetrievePagesParameters, Action<RetrievePagesQueryParameters>, RetrievalCacheSettings, CancellationToken)

Retrieves web pages of content type specified by TResult model.

public static Task<IEnumerable<TResult>> RetrievePagesByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> webPageItemGuids, RetrievePagesParameters parameters, Action<RetrievePagesQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, CancellationToken cancellationToken = default) where TResult : IWebPageFieldsSource

Parameters

contentRetriever IContentRetriever

Content retriever.

webPageItemGuids IEnumerable<Guid>

GUID identifiers of web pages.

parameters RetrievePagesParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrievePagesQueryParameters>

Action to additionally modify query during retrieval.

cacheSettings RetrievalCacheSettings

Cache setting used to modify caching during retrieval.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<TResult>>

Type Parameters

TResult

Model of the final retrieved result.

Remarks

Retrieve web pages by their WebPageItemGUID. This guid can be obtained from web page selector. When working with combined content selector use the RetrieveContentByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, RetrieveContentParameters, Action<RetrieveContentQueryParameters>, RetrievalCacheSettings, CancellationToken) method.

RetrievePagesByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, RetrievePagesParameters, CancellationToken)

Retrieves web pages of content type specified by TResult model.

public static Task<IEnumerable<TResult>> RetrievePagesByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> webPageItemGuids, RetrievePagesParameters parameters, CancellationToken cancellationToken = default) where TResult : IWebPageFieldsSource

Parameters

contentRetriever IContentRetriever

Content retriever.

webPageItemGuids IEnumerable<Guid>

GUID identifiers of web pages.

parameters RetrievePagesParameters

Parameters used to modify retrieval.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<TResult>>

Type Parameters

TResult

Model of the final retrieved result.

Remarks

Retrieve web pages by their WebPageItemGUID. This guid can be obtained from web page selector. When working with combined content selector use the RetrieveContentByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, RetrieveContentParameters, CancellationToken) method.

RetrievePagesByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, CancellationToken)

Retrieves web pages of content type specified by TResult model and GUIDs.

public static Task<IEnumerable<TResult>> RetrievePagesByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> webPageItemGuids, CancellationToken cancellationToken = default) where TResult : IWebPageFieldsSource

Parameters

contentRetriever IContentRetriever

Content retriever.

webPageItemGuids IEnumerable<Guid>

GUID identifiers of web pages.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<TResult>>

Type Parameters

TResult

Model of the final retrieved result.

Remarks

Retrieve web pages by their WebPageItemGUID. This guid can be obtained from web page selector. When working with combined content selector use the RetrieveContentByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, CancellationToken) method.

RetrievePagesByGuids<TSource, TResult>(IContentRetriever, IEnumerable<Guid>, RetrievePagesParameters, Action<RetrievePagesQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>>, CancellationToken)

Retrieves web pages of content type specified by TSource model.

public static Task<IEnumerable<TResult>> RetrievePagesByGuids<TSource, TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> webPageItemGuids, RetrievePagesParameters parameters, Action<RetrievePagesQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>> configureModel, CancellationToken cancellationToken = default) where TSource : IWebPageFieldsSource

Parameters

contentRetriever IContentRetriever

Content retriever.

webPageItemGuids IEnumerable<Guid>

GUID identifiers of web pages.

parameters RetrievePagesParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrievePagesQueryParameters>

Action to additionally modify query during retrieval.

cacheSettings RetrievalCacheSettings

Cache setting used to modify caching during retrieval.

configureModel Func<IContentQueryDataContainer, TSource, Task<TResult>>

Function providing additional configuration for the resulting TResult instance based on content query data container.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<TResult>>

Type Parameters

TSource

Source model used to define content type of retrieved results.

TResult

Model of the final retrieved result.

Remarks

Retrieve web pages by their WebPageItemGUID. This guid can be obtained from web page selector. When working with combined content selector use the RetrieveContentByGuids<TSource, TResult>(IContentRetriever, IEnumerable<Guid>, RetrieveContentParameters, Action<RetrieveContentQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>>, CancellationToken) method.