FullTextSearchManager

class OC\FullTextSearch\FullTextSearchManager
Class FullTextSearchManager
Source:lib/private/FullTextSearch/FullTextSearchManager.php#42
Implements:OCP\FullTextSearch\IFullTextSearchManager

Properties

Methods

public OC\FullTextSearch\FullTextSearchManager::registerProviderService($providerService)
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#60

Parameters:
Since:

15.0.0

public OC\FullTextSearch\FullTextSearchManager::registerIndexService($indexService)
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#69

Parameters:
Since:

15.0.0

public OC\FullTextSearch\FullTextSearchManager::registerSearchService($searchService)
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#78

Parameters:
Since:

15.0.0

public OC\FullTextSearch\FullTextSearchManager::isAvailable()
Source:lib/private/FullTextSearch/FullTextSearchManager.php#87
Since:16.0.0
Returns:bool
public OC\FullTextSearch\FullTextSearchManager::addJavascriptAPI()
Source:lib/private/FullTextSearch/FullTextSearchManager.php#140
Throws:\OCP\FullTextSearch\Exceptions\FullTextSearchAppNotAvailableException
public OC\FullTextSearch\FullTextSearchManager::isProviderIndexed($providerId)
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#151

Parameters:
  • $providerId (string)
Returns:

bool

Throws:

\OCP\FullTextSearch\Exceptions\FullTextSearchAppNotAvailableException

public OC\FullTextSearch\FullTextSearchManager::getIndex($providerId, $documentId)
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#162

Parameters:
  • $providerId (string)
  • $documentId (string)
Returns:

\OCP\FullTextSearch\Model\IIndex

Throws:

\OCP\FullTextSearch\Exceptions\FullTextSearchAppNotAvailableException

public OC\FullTextSearch\FullTextSearchManager::createIndex($providerId, $documentId, $userId, $status=0)
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#177

Parameters:
  • $providerId (string)
  • $documentId (string)
  • $userId (string)
  • $status (int)
See:

\OCP\FullTextSearch\Model\IIndex for available value for $status.

Returns:

\OCP\FullTextSearch\Model\IIndex

Throws:

\OCP\FullTextSearch\Exceptions\FullTextSearchAppNotAvailableException

public OC\FullTextSearch\FullTextSearchManager::updateIndexStatus($providerId, $documentId, $status, $reset=false)
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#192

Parameters:
  • $providerId (string)
  • $documentId (string)
  • $status (int)
  • $reset (bool)
See:

\OCP\FullTextSearch\Model\IIndex for available value for $status.

Throws:

\OCP\FullTextSearch\Exceptions\FullTextSearchAppNotAvailableException

public OC\FullTextSearch\FullTextSearchManager::updateIndexesStatus($providerId, $documentIds, $status, $reset=false)
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#206

Parameters:
  • $providerId (string)
  • $documentIds (array)
  • $status (int)
  • $reset (bool)
See:

\OCP\FullTextSearch\Model\IIndex for available value for $status.

Throws:

\OCP\FullTextSearch\Exceptions\FullTextSearchAppNotAvailableException

public OC\FullTextSearch\FullTextSearchManager::updateIndexes($indexes)
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#216

Parameters:
Throws:

\OCP\FullTextSearch\Exceptions\FullTextSearchAppNotAvailableException

public OC\FullTextSearch\FullTextSearchManager::search($request, $userId="")
Source:

lib/private/FullTextSearch/FullTextSearchManager.php#228

Parameters:
  • $request (array)
  • $userId (string)
Returns:

\OCP\FullTextSearch\Model\ISearchResult[]

Throws:

\OCP\FullTextSearch\Exceptions\FullTextSearchAppNotAvailableException