Interface IContentItemAssetRetriever

Namespace

CMS.ContentEngine

Assembly

CMS.ContentEngine.dll

Interface to retrieve content item asset data.

public interface IContentItemAssetRetriever

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

Retrieve(IContentQueryDataContainer, string, CancellationToken)

Retrieves content item asset data.

Task<ContentItemAsset> Retrieve(IContentQueryDataContainer container, string fieldName, CancellationToken cancellationToken = default)

Parameters

container IContentQueryDataContainer

Container with content item asset field.

fieldName string

Field to retrieve content item asset from.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ContentItemAsset>

Exceptions

ArgumentNullException

Thrown when container is null.

ArgumentException

Thrown when fieldName is null or empty or the ContentItemGUID was not included in the container.

InvalidOperationException

Thrown when content type does not contain asset field with specified name or the data cannot be deserialized.