Interface IApiContentQueryProvider
Concrete implementation of content querying (e.g. based on Examine)
Namespace: Umbraco.Cms.Core.DeliveryApi
Assembly: Umbraco.Core.dll
Syntax
public interface IApiContentQueryProviderMethods
View SourceAllContentSelectorOption()
Returns a selector option that can be applied to fetch "all content" (i.e. if a selector option is not present when performing a search).
Declaration
SelectorOption AllContentSelectorOption()Returns
| Type | Description |
|---|---|
| SelectorOption |
ExecuteQuery(SelectorOption, IList<FilterOption>, IList<SortOption>, String, ProtectedAccess, Boolean, Int32, Int32)
Returns a page of item ids that passed the search criteria.
Declaration
PagedModel<Guid> ExecuteQuery(SelectorOption selectorOption, IList<FilterOption> filterOptions, IList<SortOption> sortOptions, string culture, ProtectedAccess protectedAccess, bool preview, int skip, int take)Parameters
| Type | Name | Description |
|---|---|---|
| SelectorOption | selectorOption | The selector option of the search criteria. |
| IList<FilterOption> | filterOptions | The filter options of the search criteria. |
| IList<SortOption> | sortOptions | The sorting options of the search criteria. |
| System.String | culture | The requested culture. |
| ProtectedAccess | protectedAccess | Defines the limitations for querying protected content. |
| System.Boolean | preview | Whether or not to search for preview content. |
| System.Int32 | skip | Number of search results to skip (for pagination). |
| System.Int32 | take | Number of search results to retrieve (for pagination). |
Returns
| Type | Description |
|---|---|
| PagedModel<Guid> | A paged model containing the resulting IDs and the total number of results that matching the search criteria. |