Class ContentQueryDataContainerExtensions

Namespace

CMS.ContentEngine

Assembly

CMS.ContentEngine.dll

Content query data container interface extensions.

public static class ContentQueryDataContainerExtensions

Inheritance

object

ContentQueryDataContainerExtensions

Methods

GetAiProvenance(IContentQueryDataContainer)

Gets the AI provenance of the content item's fields that was included to the query via WithAiProvenance() or WithAiProvenance().

public static IReadOnlyDictionary<string, AiProvenance> GetAiProvenance(this IContentQueryDataContainer dataContainer)

Parameters

dataContainer IContentQueryDataContainer

Content query data container.

Returns

IReadOnlyDictionary<string, AiProvenance>

Field code names with their AI provenance, compared case-insensitively. Fields with no AI origin are omitted, so an empty result means no field of the item was marked.

Exceptions

ArgumentNullException

Thrown when dataContainer is null.

InvalidOperationException

Thrown when the AI provenance was not included to the query.

See Also

AiProvenance

GetTotalCount(IContentQueryDataContainer)

Gets the total number of results if IncludeTotalCount() is configured for the query.

public static int? GetTotalCount(this IContentQueryDataContainer dataContainer)

Parameters

dataContainer IContentQueryDataContainer

Returns

int?

Remarks

Provided only when IncludeTotalCount() is configured.

See Also

Offset(int, int)

TryGetAiProvenance(IContentQueryDataContainer, out IReadOnlyDictionary<string, AiProvenance>)

Tries to get the AI provenance of the content item's fields that was included to the query via WithAiProvenance() or WithAiProvenance().

public static bool TryGetAiProvenance(this IContentQueryDataContainer dataContainer, out IReadOnlyDictionary<string, AiProvenance> aiProvenance)

Parameters

dataContainer IContentQueryDataContainer

Content query data container.

aiProvenance IReadOnlyDictionary<string, AiProvenance>

Field code names with their AI provenance, compared case-insensitively. Fields with no AI origin are omitted.

Returns

bool

Returns true when the AI provenance was included to the query.

Exceptions

ArgumentNullException

Thrown when dataContainer is null.