Interface IFreeTextAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll This agent can be used to manage the free text system
Implements
IAgentBase, IDisposableMethods
FreetextIndexRowsAsync(string, int[], RequestOptions)
Update the freetext index for one or more rows from the same tableParameters
tableName string
The name of the table the rows come from; this table should have at least one freetext-indexable field
iDs int[]
One or more primary keys, identifying records to be (re)indexed. It doesn’t matter if they have been indexed before or not
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueGetStatusAsync(RequestOptions)
Returns status for the freetext search wordsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<FreeText> The freetext statusRegenerateIndexAsync(bool, RequestOptions)
Wipe and regenerate the freetext index by scanning the database (freetext search will be unavailable while this operation runsParameters
runAsBatch bool
If true, then execute the regeneration as a Batch Task; the service call will return immediately. Otherwise wait until the task completes, may cause a timeout if called as a Web Service
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<BatchTaskInfo> Information about the batch task, if batch execution was requested. Otherwise nullSetEnabledAsync(bool, RequestOptions)
Sets freetext search to enabled (true) or disabled (false)Parameters
enabled bool
If enabled true, else false
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueSetMultiWordOperatorAsync(FreeTextOperator, RequestOptions)
Sets the operator used when matching multiple wordsParameters
freeTextOperator FreeTextOperator
The operator
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task No return valueSetSingleWordOperatorAsync(FreeTextOperator, RequestOptions)
Sets the operator used when matching single wordsParameters
freeTextOperator FreeTextOperator
The operator
requestOptions RequestOptions
Override language/culture codes on this request.