Interface IWebPageItemUsageRetriever

Namespace

CMS.Websites

Assembly

CMS.Websites.dll

Provides methods for retrieving web page item usages.

public interface IWebPageItemUsageRetriever

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 web page item ID and language name.

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

Parameters

webPageItemId int

Web page item identifier.

languageName string

Language name of the language variant of the web page item.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<ContentItemLanguageMetadata>>

The items directly referencing the languageName language variant of the web page item.

Exceptions

ArgumentException

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