View Source

Interface IApiContentQueryService

Service that handles querying of the Delivery API.

Namespace: Umbraco.Cms.Core.DeliveryApi

Assembly: Umbraco.Core.dll

Syntax

public interface IApiContentQueryService

Methods

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

Declaration

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

Parameters

Type	Name	Description
System.String	fetch
IEnumerable<System.String>	filters
IEnumerable<System.String>	sorts
System.Int32	skip
System.Int32	take

Returns

Type	Description
Attempt<PagedModel<Guid>, ApiContentQueryOperationStatus>

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

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

Declaration

virtual Attempt<PagedModel<Guid>, ApiContentQueryOperationStatus> ExecuteQuery(string fetch, IEnumerable<string> filters, IEnumerable<string> sorts, ProtectedAccess protectedAccess, 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.
ProtectedAccess	protectedAccess	Defines the limitations for querying protected content.
System.Int32	skip	The amount of items to skip.
System.Int32	take	The amount of items to take.

Returns

Type	Description
Attempt<PagedModel<Guid>, ApiContentQueryOperationStatus>	A paged model of item ids that are returned after applying the search queries in an attempt.