View Source

Interface IApiMediaQueryService

Service that handles querying of the Media APIs.

Namespace: Umbraco.Cms.Core.DeliveryApi

Assembly: Umbraco.Core.dll

Syntax

public interface IApiMediaQueryService

Methods

ExecuteQuery(String, IEnumerable<String>, IEnumerable<String>, Int32, Int32)

Returns an attempt with a collection of media ids that passed the search criteria as a paged model.

Declaration

Attempt<PagedModel<Guid>, ApiMediaQueryOperationStatus> ExecuteQuery(string fetch, IEnumerable<string> filters, IEnumerable<string> sorts, int skip, int take)

Parameters

Type	Name	Description
System.String	fetch	Optional fetch query parameter value.
IEnumerable<System.String>	filters	Optional filter query parameters values.
IEnumerable<System.String>	sorts	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
Attempt<PagedModel<Guid>, ApiMediaQueryOperationStatus>	A paged model of media ids that are returned after applying the search queries in an attempt.

GetByPath(String)

Returns the media item that matches the supplied path (if any).

Declaration

IPublishedContent GetByPath(string path)

Parameters

Type	Name	Description
System.String	path	The path to look up.

Returns

Type	Description
IPublishedContent	The media item at , or null if it does not exist.