View Source

Class QueryMediaApiController

Inheritance

System.Object

DeliveryApiControllerBase

MediaApiControllerBase

Namespace: Umbraco.Cms.Api.Delivery.Controllers.Media

Assembly: Umbraco.Cms.Api.Delivery.dll

Syntax

public class QueryMediaApiController : MediaApiControllerBase

Constructors

QueryMediaApiController(IPublishedSnapshotAccessor, IApiMediaWithCropsResponseBuilder, IApiMediaQueryService)

Declaration

public QueryMediaApiController(IPublishedSnapshotAccessor publishedSnapshotAccessor, IApiMediaWithCropsResponseBuilder apiMediaWithCropsResponseBuilder, IApiMediaQueryService apiMediaQueryService)

Parameters

Type	Name	Description
IPublishedSnapshotAccessor	publishedSnapshotAccessor
IApiMediaWithCropsResponseBuilder	apiMediaWithCropsResponseBuilder
IApiMediaQueryService	apiMediaQueryService

Methods

Query(String, String[], String[], Int32, Int32)

Declaration

public async Task<IActionResult> Query(string fetch, string[] filter, string[] sort, int skip = 0, int take = 10)

Parameters

Type	Name	Description
System.String	fetch
System.String[]	filter
System.String[]	sort
System.Int32	skip
System.Int32	take

Returns

Type	Description
Task<IActionResult>

QueryV20(String, String[], String[], Int32, Int32)

Gets a paginated list of media item(s) from query.

Declaration

public async Task<IActionResult> QueryV20(string fetch, string[] filter, string[] sort, int skip = 0, int take = 10)

Parameters

Type	Name	Description
System.String	fetch	Optional fetch query parameter value.
System.String[]	filter	Optional filter query parameters values.
System.String[]	sort	Optional sort query parameters values.
System.Int32	skip	The amount of items to skip.
System.Int32	take	The amount of items to take.

Returns

Type	Description
Task<IActionResult>	The paged result of the media item(s).