Interface IContentRetriever

Namespace

Kentico.Content.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Service used for retrieval of content.

public interface IContentRetriever

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

RetrieveAllPagesExtensions.RetrieveAllPages<TResult>(IContentRetriever, RetrieveAllPagesParameters, Action<RetrieveAllPagesQueryParameters>, RetrievalCacheSettings, CancellationToken)

RetrieveAllPagesExtensions.RetrieveAllPages<TResult>(IContentRetriever, RetrieveAllPagesParameters, CancellationToken)

RetrieveAllPagesExtensions.RetrieveAllPages<TResult>(IContentRetriever, CancellationToken)

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

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

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

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

RetrieveContentExtensions.RetrieveContent<TResult>(IContentRetriever, RetrieveContentParameters, Action<RetrieveContentQueryParameters>, RetrievalCacheSettings, CancellationToken)

RetrieveContentExtensions.RetrieveContent<TResult>(IContentRetriever, RetrieveContentParameters, CancellationToken)

RetrieveContentExtensions.RetrieveContent<TResult>(IContentRetriever, CancellationToken)

RetrieveContentOfContentTypesExtensions.RetrieveContentOfContentTypes<TResult>(IContentRetriever, IEnumerable<string>, RetrieveContentOfContentTypesParameters, Action<RetrieveContentOfContentTypesQueryParameters>, RetrievalCacheSettings, CancellationToken)

RetrieveContentOfContentTypesExtensions.RetrieveContentOfContentTypes<TResult>(IContentRetriever, IEnumerable<string>, RetrieveContentOfContentTypesParameters, CancellationToken)

RetrieveContentOfContentTypesExtensions.RetrieveContentOfContentTypes<TResult>(IContentRetriever, IEnumerable<string>, CancellationToken)

RetrieveContentOfReusableSchemasExtensions.RetrieveContentOfReusableSchemas<TResult>(IContentRetriever, IEnumerable<string>, RetrieveContentOfReusableSchemasParameters, Action<RetrieveContentOfReusableSchemasQueryParameters>, RetrievalCacheSettings, CancellationToken)

RetrieveContentOfReusableSchemasExtensions.RetrieveContentOfReusableSchemas<TResult>(IContentRetriever, IEnumerable<string>, RetrieveContentOfReusableSchemasParameters, CancellationToken)

RetrieveContentOfReusableSchemasExtensions.RetrieveContentOfReusableSchemas<TResult>(IContentRetriever, IEnumerable<string>, CancellationToken)

RetrieveCurrentPageExtensions.RetrieveCurrentPage<TResult>(IContentRetriever, RetrieveCurrentPageParameters, Action<RetrieveCurrentPageQueryParameters>, RetrievalCacheSettings, CancellationToken)

RetrieveCurrentPageExtensions.RetrieveCurrentPage<TResult>(IContentRetriever, RetrieveCurrentPageParameters, CancellationToken)

RetrieveCurrentPageExtensions.RetrieveCurrentPage<TResult>(IContentRetriever, CancellationToken)

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

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

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

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

RetrievePagesExtensions.RetrievePages<TResult>(IContentRetriever, RetrievePagesParameters, Action<RetrievePagesQueryParameters>, RetrievalCacheSettings, CancellationToken)

RetrievePagesExtensions.RetrievePages<TResult>(IContentRetriever, RetrievePagesParameters, CancellationToken)

RetrievePagesExtensions.RetrievePages<TResult>(IContentRetriever, CancellationToken)

RetrievePagesOfContentTypesExtensions.RetrievePagesOfContentTypes<TResult>(IContentRetriever, IEnumerable<string>, RetrievePagesOfContentTypesParameters, Action<RetrievePagesOfContentTypesQueryParameters>, RetrievalCacheSettings, CancellationToken)

RetrievePagesOfContentTypesExtensions.RetrievePagesOfContentTypes<TResult>(IContentRetriever, IEnumerable<string>, RetrievePagesOfContentTypesParameters, CancellationToken)

RetrievePagesOfContentTypesExtensions.RetrievePagesOfContentTypes<TResult>(IContentRetriever, IEnumerable<string>, CancellationToken)

RetrievePagesOfReusableSchemasExtensions.RetrievePagesOfReusableSchemas<TResult>(IContentRetriever, IEnumerable<string>, RetrievePagesOfReusableSchemasParameters, Action<RetrievePagesOfReusableSchemasQueryParameters>, RetrievalCacheSettings, CancellationToken)

RetrievePagesOfReusableSchemasExtensions.RetrievePagesOfReusableSchemas<TResult>(IContentRetriever, IEnumerable<string>, RetrievePagesOfReusableSchemasParameters, CancellationToken)

RetrievePagesOfReusableSchemasExtensions.RetrievePagesOfReusableSchemas<TResult>(IContentRetriever, IEnumerable<string>, CancellationToken)

Methods

RetrieveAllPages<TResult>(RetrieveAllPagesParameters, Action<RetrieveAllPagesQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>>, CancellationToken)

Retrieves web pages of all content types.

Task<IEnumerable<TResult>> RetrieveAllPages<TResult>(RetrieveAllPagesParameters parameters, Action<RetrieveAllPagesQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>> configureModel, CancellationToken cancellationToken = default)

Parameters

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.

RetrieveContentOfContentTypes<TResult>(IEnumerable<string>, RetrieveContentOfContentTypesParameters, Action<RetrieveContentOfContentTypesQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>>, CancellationToken)

Retrieves content items of content types specified by contentTypeNames.

Task<IEnumerable<TResult>> RetrieveContentOfContentTypes<TResult>(IEnumerable<string> contentTypeNames, RetrieveContentOfContentTypesParameters parameters, Action<RetrieveContentOfContentTypesQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>> configureModel, CancellationToken cancellationToken = default)

Parameters

contentTypeNames IEnumerable<string>

Names of the content types defining retrieved results.

parameters RetrieveContentOfContentTypesParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrieveContentOfContentTypesQueryParameters>

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.

RetrieveContentOfReusableSchemas<TResult>(IEnumerable<string>, RetrieveContentOfReusableSchemasParameters, Action<RetrieveContentOfReusableSchemasQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>>, CancellationToken)

Retrieves content items of content types specified by reusableSchemaNames.

Task<IEnumerable<TResult>> RetrieveContentOfReusableSchemas<TResult>(IEnumerable<string> reusableSchemaNames, RetrieveContentOfReusableSchemasParameters parameters, Action<RetrieveContentOfReusableSchemasQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>> configureModel, CancellationToken cancellationToken = default)

Parameters

reusableSchemaNames IEnumerable<string>

Names of the reusable schemas defining retrieved results.

parameters RetrieveContentOfReusableSchemasParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrieveContentOfReusableSchemasQueryParameters>

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.

RetrieveContent<TSource, TResult>(RetrieveContentParameters, Action<RetrieveContentQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>>, CancellationToken)

Retrieves content items of content type specified by TSource model.

Task<IEnumerable<TResult>> RetrieveContent<TSource, TResult>(RetrieveContentParameters parameters, Action<RetrieveContentQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>> configureModel, CancellationToken cancellationToken = default) where TSource : IContentItemFieldsSource

Parameters

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 TSource model.

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

RetrieveCurrentPage<TResult>(RetrieveCurrentPageParameters, Action<RetrieveCurrentPageQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>>, CancellationToken)

Retrieves the current web page.

Task<TResult> RetrieveCurrentPage<TResult>(RetrieveCurrentPageParameters parameters, Action<RetrieveCurrentPageQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>> configureModel, CancellationToken cancellationToken = default)

Parameters

parameters RetrieveCurrentPageParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrieveCurrentPageQueryParameters>

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<TResult>

Type Parameters

TResult

Model of the final retrieved result.

RetrievePagesOfContentTypes<TResult>(IEnumerable<string>, RetrievePagesOfContentTypesParameters, Action<RetrievePagesOfContentTypesQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>>, CancellationToken)

Retrieves web pages of content types specified by contentTypeNames.

Task<IEnumerable<TResult>> RetrievePagesOfContentTypes<TResult>(IEnumerable<string> contentTypeNames, RetrievePagesOfContentTypesParameters parameters, Action<RetrievePagesOfContentTypesQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>> configureModel, CancellationToken cancellationToken = default)

Parameters

contentTypeNames IEnumerable<string>

Names of the content types defining retrieved results.

parameters RetrievePagesOfContentTypesParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrievePagesOfContentTypesQueryParameters>

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.

RetrievePagesOfReusableSchemas<TResult>(IEnumerable<string>, RetrievePagesOfReusableSchemasParameters, Action<RetrievePagesOfReusableSchemasQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>>, CancellationToken)

Retrieves web pages of content types specified by reusableSchemaNames.

Task<IEnumerable<TResult>> RetrievePagesOfReusableSchemas<TResult>(IEnumerable<string> reusableSchemaNames, RetrievePagesOfReusableSchemasParameters parameters, Action<RetrievePagesOfReusableSchemasQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TResult, Task<TResult>> configureModel, CancellationToken cancellationToken = default)

Parameters

reusableSchemaNames IEnumerable<string>

Names of the reusable schemas defining retrieved results.

parameters RetrievePagesOfReusableSchemasParameters

Parameters used to modify retrieval.

additionalQueryConfiguration Action<RetrievePagesOfReusableSchemasQueryParameters>

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.

RetrievePages<TSource, TResult>(RetrievePagesParameters, Action<RetrievePagesQueryParameters>, RetrievalCacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>>, CancellationToken)

Retrieves web pages of content type specified by TSource model.

Task<IEnumerable<TResult>> RetrievePages<TSource, TResult>(RetrievePagesParameters parameters, Action<RetrievePagesQueryParameters> additionalQueryConfiguration, RetrievalCacheSettings cacheSettings, Func<IContentQueryDataContainer, TSource, Task<TResult>> configureModel, CancellationToken cancellationToken = default) where TSource : IWebPageFieldsSource

Parameters

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 TSource model.

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