Class RetrieveContentByGuidsExtensions

Namespace

Kentico.Content.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

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

public static class RetrieveContentByGuidsExtensions

Inheritance

object

RetrieveContentByGuidsExtensions

Methods

RetrieveContentByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, RetrieveContentParameters, Action<RetrieveContentQueryParameters>, RetrievalCacheSettings, CancellationToken)

Retrieves content items of content type specified by TResult model.

public static Task<IEnumerable<TResult>> RetrieveContentByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> contentItemGuids, RetrieveContentParameters parameters, Action<RetrieveContentQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, CancellationToken cancellationToken = default) where TResult : IContentItemFieldsSource

Parameters

contentRetriever IContentRetriever

Content retriever.

contentItemGuids IEnumerable<Guid>

GUID identifiers of content items.

parameters RetrieveContentParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrieveContentQueryParameters>

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.

RetrieveContentByGuids<TResult>(IContentRetriever, IEnumerable<Guid>, RetrieveContentParameters, CancellationToken)

Retrieves content items of content type specified by TResult model.

public static Task<IEnumerable<TResult>> RetrieveContentByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> contentItemGuids, RetrieveContentParameters parameters, CancellationToken cancellationToken = default) where TResult : IContentItemFieldsSource

Parameters

contentRetriever IContentRetriever

Content retriever.

contentItemGuids IEnumerable<Guid>

GUID identifiers of content items.

parameters RetrieveContentParameters

Parameters used to modify retrieval.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<TResult>>

Type Parameters

TResult

Model of the final retrieved result.

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

Retrieves content items of content type specified by TResult model and GUIDs.

public static Task<IEnumerable<TResult>> RetrieveContentByGuids<TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> contentItemGuids, CancellationToken cancellationToken = default) where TResult : IContentItemFieldsSource

Parameters

contentRetriever IContentRetriever

Content retriever.

contentItemGuids IEnumerable<Guid>

GUID identifiers of content items.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<TResult>>

Type Parameters

TResult

Model of the final retrieved result.

RetrieveContentByGuids<TSource, TResult>(IContentRetriever, IEnumerable<Guid>, RetrieveContentParameters, Action<RetrieveContentQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>>, CancellationToken)

Retrieves content items of content type specified by TSource model.

public static Task<IEnumerable<TResult>> RetrieveContentByGuids<TSource, TResult>(this IContentRetriever contentRetriever, IEnumerable<Guid> contentItemGuids, RetrieveContentParameters parameters, Action<RetrieveContentQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>> configureModel, CancellationToken cancellationToken = default) where TSource : IContentItemFieldsSource

Parameters

contentRetriever IContentRetriever

Content retriever.

contentItemGuids IEnumerable<Guid>

GUID identifiers of content items.

parameters RetrieveContentParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrieveContentQueryParameters>

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.