Interface IContentItemUsageRetriever

Namespace

CMS.ContentEngine

Assembly

CMS.ContentEngine.dll

Provides methods for retrieving content item usages.

public interface IContentItemUsageRetriever

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

Retrieve(int, string, CancellationToken)

Retrieves the content item usage for a given content item ID and language name.

Task<IEnumerable<ContentItemLanguageMetadata>> Retrieve(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Content item identifier.

languageName string

Language name of the language variant of the content item.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<ContentItemLanguageMetadata>>

The items directly referencing the languageName language variant of the content item.

Exceptions

ArgumentException

Thrown when corresponding content item or content language do not exist.