Interface IFreeTextAgent

Interface for the FreeText Agent This agent can be used to manage the free text system

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[Agent("FreeText Agent", "Interface for the FreeText Agent. This agent can be used to manage the free text system")]
public interface IFreeTextAgent : IAgent

Examples

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   using (FreeTextAgent agent = new FreeTextAgent())
   {
      // call methods on agent here...
   }
}

Methods

FreetextIndexRowsAsync(string, int[], CancellationToken)

Update the freetext index for one or more rows from the same table

Declaration

Task FreetextIndexRowsAsync(string tableName, int[] iDs, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	tableName	The name of the table the rows come from; this table should have at least one freetext-indexable field
int[]	iDs	One or more primary keys, identifying records to be (re)indexed. It doesn't matter if they have been indexed before or not
CancellationToken	cancellationToken

Returns

Type	Description
Task	This method has no return value

GetStatusAsync(CancellationToken)

Returns status for the freetext search words

Declaration

Task<FreeText> GetStatusAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<FreeText>	The freetext status

RegenerateIndexAsync(bool, CancellationToken)

Wipe and regenerate the freetext index by scanning the database (freetext search will be unavailable while this operation runs

Declaration

Task<BatchTaskInfo> RegenerateIndexAsync(bool runAsBatch, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool	runAsBatch	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
CancellationToken	cancellationToken

Returns

Type	Description
Task<BatchTaskInfo>	Information about the batch task, if batch execution was requested. Otherwise null

SetEnabledAsync(bool, CancellationToken)

Sets freetext search to enabled (true) or disabled (false)

Declaration

Task SetEnabledAsync(bool enabled, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool	enabled	If enabled true, else false
CancellationToken	cancellationToken

Returns

Type	Description
Task	This method has no return value

SetMultiWordOperatorAsync(FreeTextOperator, CancellationToken)

Sets the operator used when matching multiple words

Declaration

Task SetMultiWordOperatorAsync(FreeTextOperator freeTextOperator, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
FreeTextOperator	freeTextOperator	The operator
CancellationToken	cancellationToken

Returns

Type	Description
Task	No return value

SetSingleWordOperatorAsync(FreeTextOperator, CancellationToken)

Sets the operator used when matching single words

Declaration

Task SetSingleWordOperatorAsync(FreeTextOperator freeTextOperator, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
FreeTextOperator	freeTextOperator	The operator
CancellationToken	cancellationToken

Returns

Type	Description
Task	This method has no return value