Class RetrieveAllPagesByGuidsExtensions

Namespace

Kentico.Content.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Extension methods for IContentRetriever allowing to retrieve pages by their GUIDs.

public static class RetrieveAllPagesByGuidsExtensions

Inheritance

object

RetrieveAllPagesByGuidsExtensions

Methods

RetrieveAllPagesByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, RetrieveAllPagesParameters, Action<RetrieveAllPagesQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>>, CancellationToken)

Retrieves web pages of all content types by GUIDs.

public static Task<IEnumerable<TResult>> RetrieveAllPagesByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> webPageItemGuids, RetrieveAllPagesParameters parameters, Action<RetrieveAllPagesQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>> configureModel, CancellationToken cancellationToken = default)

Parameters

contentRetriever IContentRetriever

Content retriever.

webPageItemGuids IEnumerable<Guid>

GUID identifiers of web pages.

parameters RetrieveAllPagesParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrieveAllPagesQueryParameters>

Action to additionally modify query during retrieval.

cacheSettings RetrievalCacheSettings

Cache setting used to modify caching during retrieval.

configureModel Func<IContentQueryDataContainer, TResult, 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

TResult

Model of the final retrieved results.

Remarks

Retrieve web pages by their WebPageItemGUID. This guid can be obtained from web page selector.

RetrieveAllPagesByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, RetrieveAllPagesParameters, Action<RetrieveAllPagesQueryParameters>, RetrievalCacheSettings, CancellationToken)

Retrieves web pages of all content types by GUIDs.

public static Task<IEnumerable<TResult>> RetrieveAllPagesByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> webPageItemGuids, RetrieveAllPagesParameters parameters, Action<RetrieveAllPagesQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, CancellationToken cancellationToken = default)

Parameters

contentRetriever IContentRetriever

Content retriever.

webPageItemGuids IEnumerable<Guid>

GUID identifiers of web pages.

parameters RetrieveAllPagesParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrieveAllPagesQueryParameters>

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 results.

Remarks

Retrieve web pages by their WebPageItemGUID. This guid can be obtained from web page selector.

RetrieveAllPagesByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, RetrieveAllPagesParameters, CancellationToken)

Retrieves web pages of all content types by GUIDs.

public static Task<IEnumerable<TResult>> RetrieveAllPagesByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> webPageItemGuids, RetrieveAllPagesParameters parameters, CancellationToken cancellationToken = default)

Parameters

contentRetriever IContentRetriever

Content retriever.

webPageItemGuids IEnumerable<Guid>

GUID identifiers of web pages.

parameters RetrieveAllPagesParameters

Parameters used to modify retrieval.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<TResult>>

Type Parameters

TResult

Model of the final retrieved results.

Remarks

Retrieve web pages by their WebPageItemGUID. This guid can be obtained from web page selector.

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

Retrieves web pages of all content types by GUIDs.

public static Task<IEnumerable<TResult>> RetrieveAllPagesByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> webPageItemGuids, CancellationToken cancellationToken = default)

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 results.

Remarks

Retrieve web pages by their WebPageItemGUID. This guid can be obtained from web page selector.