Table of Contents

Class ContentQueryExecutorExtensions

Namespace
CMS.ContentEngine
Assembly
CMS.ContentEngine.dll

Extension methods for the IContentQueryExecutor.

public static class ContentQueryExecutorExtensions
Inheritance
object
ContentQueryExecutorExtensions

Methods

GetMappedResult<TModel>(IContentQueryExecutor, ContentItemQueryBuilder, ContentQueryExecutionOptions, Func<IContentQueryDataContainer, TModel, Task<TModel>>, CancellationToken)

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

public static Task<IEnumerable<TModel>> GetMappedResult<TModel>(this IContentQueryExecutor executor, ContentItemQueryBuilder builder, ContentQueryExecutionOptions options, Func<IContentQueryDataContainer, 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<IContentQueryDataContainer, TModel, Task<TModel>>

Asynchronous 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

The content type model is created based on the registered model Type for the result content type.

Exceptions

ArgumentNullException

Thrown when 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

GetMappedResult<TModel>(IContentQueryExecutor, ContentItemQueryBuilder, ContentQueryExecutionOptions, Func<IContentQueryDataContainer, TModel, TModel>, CancellationToken)

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

public static Task<IEnumerable<TModel>> GetMappedResult<TModel>(this IContentQueryExecutor executor, ContentItemQueryBuilder builder, ContentQueryExecutionOptions options, Func<IContentQueryDataContainer, 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<IContentQueryDataContainer, 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

The content type model is created based on the registered model Type for the result content type.

Exceptions

ArgumentNullException

Thrown when 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

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

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

public static Task<IEnumerable<TModel>> GetMappedResult<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

The content type model is created based on the registered model Type for the result content type.

Exceptions

ArgumentNullException

Thrown when 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