Interface IMediaListViewService
Provides methods for retrieving media items in a list view format with paging and filtering support.
Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IMediaListViewService
Methods
View SourceGetListViewItemsByKeyAsync(IUser, Guid?, Guid?, string, Direction, string?, int, int)
Gets media items for a list view by their container key with paging and filtering support.
Declaration
Task<Attempt<ListViewPagedModel<IMedia>?, ContentCollectionOperationStatus>> GetListViewItemsByKeyAsync(IUser user, Guid? key, Guid? dataTypeKey, string orderBy, Direction orderDirection, string? filter, int skip, int take)
Parameters
| Type | Name | Description |
|---|---|---|
| IUser | user | The user requesting the list view items. |
| Guid? | key | The key of the parent container, or null for root level items. |
| Guid? | dataTypeKey | The optional data type key to filter by. |
| string | orderBy | The property to order results by. |
| Direction | orderDirection | The direction to order results. |
| string | filter | An optional filter string to apply. |
| int | skip | The number of items to skip. |
| int | take | The number of items to take. |
Returns
| Type | Description |
|---|---|
| Task<Attempt<ListViewPagedModel<IMedia>, ContentCollectionOperationStatus>> | An Attempt<TResult, TStatus> containing the paged media items if successful, or an error status if not. |