View Source

Class ExamineManagementController

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

Namespace: Umbraco.Web.Editors

Assembly: Umbraco.Web.dll

Syntax

[PluginController("UmbracoApi")]
public class ExamineManagementController : UmbracoAuthorizedJsonController, IDiscoverable

Constructors

ExamineManagementController(IExamineManager, ILogger, AppCaches, IndexRebuilder)

Declaration

public ExamineManagementController(IExamineManager examineManager, ILogger logger, AppCaches appCaches, IndexRebuilder indexRebuilder)

Parameters

Type	Name	Description
IExamineManager	examineManager
ILogger	logger
AppCaches	appCaches
Umbraco.Examine.IndexRebuilder	indexRebuilder

Methods

GetIndexerDetails()

Get the details for indexers

Declaration

public IEnumerable<ExamineIndexModel> GetIndexerDetails()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ExamineIndexModel>

GetSearcherDetails()

Get the details for searchers

Declaration

public IEnumerable<ExamineSearcherModel> GetSearcherDetails()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ExamineSearcherModel>

GetSearchResults(String, String, Int32, Int32)

Declaration

public SearchResults GetSearchResults(string searcherName, string query, int pageIndex = 0, int pageSize = 20)

Parameters

Type	Name	Description
System.String	searcherName
System.String	query
System.Int32	pageIndex
System.Int32	pageSize

Returns

Type	Description
SearchResults

PostCheckRebuildIndex(String)

Check if the index has been rebuilt

Declaration

public ExamineIndexModel PostCheckRebuildIndex(string indexName)

Parameters

Type	Name	Description
System.String	indexName

Returns

Type	Description
ExamineIndexModel

Remarks

This is kind of rudimentary since there's no way we can know that the index has rebuilt, we have a listener for the index op complete so we'll just check if that key is no longer there in the runtime cache

PostRebuildIndex(String)

Rebuilds the index

Declaration

public HttpResponseMessage PostRebuildIndex(string indexName)

Parameters

Type	Name	Description
System.String	indexName

Returns

Type	Description
HttpResponseMessage