Interface IContentListViewService

Provides services for retrieving content items in a list view format.

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IContentListViewService

Methods

View Source

GetListViewItemsByKeyAsync(IUser, Guid, Guid?, string, string?, Direction, string?, int, int)

Gets content items for display in a list view.

Declaration

Task<Attempt<ListViewPagedModel<IContent>?, ContentCollectionOperationStatus>> GetListViewItemsByKeyAsync(IUser user, Guid key, Guid? dataTypeKey, string orderBy, string? orderCulture, Direction orderDirection, string? filter, int skip, int take)

Parameters

Type	Name	Description
IUser	user	The user requesting the list view items.
Guid	key	The unique identifier of the parent content item.
Guid?	dataTypeKey	The optional data type key to filter the list view configuration.
string	orderBy	The property alias to order by.
string	orderCulture	The culture to use for ordering culture-variant properties.
Direction	orderDirection	The direction of the ordering (ascending or descending).
string	filter	An optional filter string to apply to the results.
int	skip	The number of items to skip.
int	take	The number of items to take.

Returns

Type	Description
Task<Attempt<ListViewPagedModel<IContent>, ContentCollectionOperationStatus>>	An attempt containing the paged list view result or an error status.