IIndexService¶

interface OCP\FullTextSearch\Service\IIndexService¶

Interface IIndexService

Source:	lib/public/FullTextSearch/Service/IIndexService.php#37

Methods¶

public OCP\FullTextSearch\Service\IIndexService::createIndex($providerId, $documentId, $userId, $status)¶

Create an Index

Source:	lib/public/FullTextSearch/Service/IIndexService.php#51
Parameters:	$providerId (string) $documentId (string) $userId (string) $status (int)
Since:	15.0.1
Returns:	`\OCP\FullTextSearch\Model\IIndex`

public OCP\FullTextSearch\Service\IIndexService::getIndex($providerId, $documentId)¶

Retrieve an Index from the database, based on the Id of the Provider

and the Id of the Document

Source:	lib/public/FullTextSearch/Service/IIndexService.php#65
Parameters:	$providerId (string) $documentId (string)
Since:	15.0.0
Returns:	`\OCP\FullTextSearch\Model\IIndex`

public OCP\FullTextSearch\Service\IIndexService::updateIndexStatus($providerId, $documentId, $status, $reset=false)¶

Update the status of an Index. status is a bit flag, setting $reset to

true will reset the status to the value defined in the parameter.

Source:	lib/public/FullTextSearch/Service/IIndexService.php#79
Parameters:	$providerId (string) $documentId (string) $status (int) $reset (bool)
Since:	15.0.0

public OCP\FullTextSearch\Service\IIndexService::updateIndexesStatus($providerId, $documentIds, $status, $reset=false)¶

Update the status of an array of Index. status is a bit flag, setting $reset to

true will reset the status to the value defined in the parameter.

Source:	lib/public/FullTextSearch/Service/IIndexService.php#93
Parameters:	$providerId (string) $documentIds (array) $status (int) $reset (bool)
Since:	15.0.0

public OCP\FullTextSearch\Service\IIndexService::updateIndexes($indexes)¶

Update an array of Index.

Source:	lib/public/FullTextSearch/Service/IIndexService.php#103
Parameters:	$indexes (array)
Since:	15.0.0