Table of Contents

Class ContentQueryExecutorExtensions

Namespace
CMS.Websites
Assembly
CMS.Websites.dll

Extension methods for the IContentQueryExecutor.

public static class ContentQueryExecutorExtensions
Inheritance
object
ContentQueryExecutorExtensions

Methods

GetMappedWebPageResult<TModel>(IContentQueryExecutor, ContentItemQueryBuilder, ContentQueryExecutionOptions, Func<IWebPageContentQueryDataContainer, TModel, Task<TModel>>, CancellationToken)

Executes the content items query for web page items, maps the content query result to content type model registered via RegisterContentTypeMappingAttribute and casts it to TModel.

public static Task<IEnumerable<TModel>> GetMappedWebPageResult<TModel>(this IContentQueryExecutor executor, ContentItemQueryBuilder builder, ContentQueryExecutionOptions options, Func<IWebPageContentQueryDataContainer, TModel, Task<TModel>> configureModel, CancellationToken cancellationToken = default)

Parameters

executor IContentQueryExecutor

The IContentQueryExecutor.

builder ContentItemQueryBuilder

The content item queries builder.

options ContentQueryExecutionOptions

Options object for configuration of query execution.

configureModel Func<IWebPageContentQueryDataContainer, TModel, Task<TModel>>

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

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<IEnumerable<TModel>>

Type Parameters

TModel

Type of the selected result.

Remarks

This method should be used instead of IContentQueryExecutor.GetMappedResult, when working with web page items.

Exceptions

ArgumentNullException

Thrown when executor or builder is null.

ArgumentException

Thrown when no model was registered for result content type via RegisterContentTypeMappingAttribute.

InvalidOperationException

Thrown when the data cannot be bound to the model e.g., the types of the properties doesn't match the registered model type, the registered model type does not have parameterless constructor or when more types are registered to one content type name.

See Also

GetMappedWebPageResult<TModel>(IContentQueryExecutor, ContentItemQueryBuilder, ContentQueryExecutionOptions, Func<IWebPageContentQueryDataContainer, TModel, TModel>, CancellationToken)

Executes the content items query for web page items, maps the content query result to content type model registered via RegisterContentTypeMappingAttribute and casts it to TModel.

public static Task<IEnumerable<TModel>> GetMappedWebPageResult<TModel>(this IContentQueryExecutor executor, ContentItemQueryBuilder builder, ContentQueryExecutionOptions options, Func<IWebPageContentQueryDataContainer, TModel, TModel> configureModel, CancellationToken cancellationToken = default)

Parameters

executor IContentQueryExecutor

The IContentQueryExecutor.

builder ContentItemQueryBuilder

The content item queries builder.

options ContentQueryExecutionOptions

Options object for configuration of query execution.

configureModel Func<IWebPageContentQueryDataContainer, TModel, TModel>

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

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<IEnumerable<TModel>>

Type Parameters

TModel

Type of the selected result.

Remarks

This method should be used instead of IContentQueryExecutor.GetMappedResult, when working with web page items.

Exceptions

ArgumentNullException

Thrown when executor or builder is null.

ArgumentException

Thrown when no model was registered for result content type via RegisterContentTypeMappingAttribute.

InvalidOperationException

Thrown when the data cannot be bound to the model e.g., the types of the properties doesn't match the registered model type, the registered model type does not have parameterless constructor or when more types are registered to one content type name.

See Also

GetMappedWebPageResult<TModel>(IContentQueryExecutor, ContentItemQueryBuilder, ContentQueryExecutionOptions, CancellationToken)

Executes the content items query for web page items, maps the content query result to content type model registered via RegisterContentTypeMappingAttribute and casts it to TModel.

public static Task<IEnumerable<TModel>> GetMappedWebPageResult<TModel>(this IContentQueryExecutor executor, ContentItemQueryBuilder builder, ContentQueryExecutionOptions options = null, CancellationToken cancellationToken = default)

Parameters

executor IContentQueryExecutor

The IContentQueryExecutor.

builder ContentItemQueryBuilder

The content item queries builder.

options ContentQueryExecutionOptions

Options object for configuration of query execution.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<IEnumerable<TModel>>

Type Parameters

TModel

Type of the selected result.

Remarks

This method should be used instead of IContentQueryExecutor.GetMappedResult, when working with web page items.

Exceptions

ArgumentNullException

Thrown when executor or builder is null.

ArgumentException

Thrown when no model was registered for result content type via RegisterContentTypeMappingAttribute.

InvalidOperationException

Thrown when the data cannot be bound to the model e.g., the types of the properties doesn't match the registered model type, the registered model type does not have parameterless constructor or when more types are registered to one content type name.

See Also

GetWebPageResult<TModel>(IContentQueryExecutor, ContentItemQueryBuilder, Func<IWebPageContentQueryDataContainer, Task<TModel>>, ContentQueryExecutionOptions, CancellationToken)

Executes the content items query for web page items.

public static Task<IEnumerable<TModel>> GetWebPageResult<TModel>(this IContentQueryExecutor executor, ContentItemQueryBuilder builder, Func<IWebPageContentQueryDataContainer, Task<TModel>> resultSelector, ContentQueryExecutionOptions options = null, CancellationToken cancellationToken = default)

Parameters

executor IContentQueryExecutor

The IContentQueryExecutor.

builder ContentItemQueryBuilder

The content item queries builder.

resultSelector Func<IWebPageContentQueryDataContainer, Task<TModel>>

Function asynchronously converting a web page content query data record container to the resulting TModel instance.

options ContentQueryExecutionOptions

Options object for configuration of query execution.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<IEnumerable<TModel>>

Type Parameters

TModel

Type of the selected result.

Remarks

This method should be used instead of IContentQueryExecutor.GetResult, when working with web page items.

Exceptions

ArgumentNullException

Thrown when executor, builder or resultSelector is null.

GetWebPageResult<TModel>(IContentQueryExecutor, ContentItemQueryBuilder, Func<IWebPageContentQueryDataContainer, TModel>, ContentQueryExecutionOptions, CancellationToken)

Executes the content items query for web page items.

public static Task<IEnumerable<TModel>> GetWebPageResult<TModel>(this IContentQueryExecutor executor, ContentItemQueryBuilder builder, Func<IWebPageContentQueryDataContainer, TModel> resultSelector, ContentQueryExecutionOptions options = null, CancellationToken cancellationToken = default)

Parameters

executor IContentQueryExecutor

The IContentQueryExecutor.

builder ContentItemQueryBuilder

The content item queries builder.

resultSelector Func<IWebPageContentQueryDataContainer, TModel>

Function converting a web page content query data record container to the resulting TModel instance.

options ContentQueryExecutionOptions

Options object for configuration of query execution.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<IEnumerable<TModel>>

Type Parameters

TModel

Type of the selected result.

Remarks

This method should be used instead of IContentQueryExecutor.GetResult, when working with web page items.

Exceptions

ArgumentNullException

Thrown when executor, builder or resultSelector is null.