Interface IAssetItemDataProvider

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Interface for providing assets data.

[Obsolete("Media libraries and their APIs are obsolete and will be discontinued in the future. Please migrate all media library files to Content hub and use their corresponding content item APIs.")]
public interface IAssetItemDataProvider

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

Get(int, string, int, int, string, CancellationToken?)

Gets a batch of asset items defined by the page index and size for given library identifier and folder path.

Task<AssetItemData> Get(int libraryIdentifier, string folderPath, int pageIndex, int pageSize, string allowedExtensions, CancellationToken? cancellationToken = null)

Parameters

libraryIdentifier int

Assets library identifier.

folderPath string

Path to the folder to load the assets from.

pageIndex int

Index of page to get.

pageSize int

Size of the page to get.

allowedExtensions string

Allowed file extensions to be loaded.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<AssetItemData>

Remarks

When pageSize is 0 paging is not applied and all assets are returned.