Class FreeTextAgent

Proxy class for the FreeText Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Inheritance

object

FreeTextAgent

Implements

IFreeTextAgent

IAgent

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.Implementation.dll

Syntax

public class FreeTextAgent : IFreeTextAgent, IAgent

Constructors

FreeTextAgent(IFreeTextImplementation, ISoRequestItemsAccessor)

Proxy class for the FreeText Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration

public FreeTextAgent(IFreeTextImplementation freeTextImplementation, ISoRequestItemsAccessor accessor)

Parameters

Type	Name	Description
IFreeTextImplementation	freeTextImplementation
ISoRequestItemsAccessor	accessor

FreeTextAgent(IFreeTextImplementation, ISoRequestItemsAccessor, IDebugUser, IServiceCallsRepository, IScriptingConfiguration, IOnlineConfiguration)

Proxy class for the FreeText Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration

public FreeTextAgent(IFreeTextImplementation freeTextImplementation, ISoRequestItemsAccessor accessor, IDebugUser debugUser, IServiceCallsRepository serviceCallsRepository, ConfigFile.IScriptingConfiguration scriptingConfiguration, ConfigFile.IOnlineConfiguration onlineConfiguration)

Parameters

Type	Name	Description
IFreeTextImplementation	freeTextImplementation
ISoRequestItemsAccessor	accessor
IDebugUser	debugUser
IServiceCallsRepository	serviceCallsRepository
IScriptingConfiguration	scriptingConfiguration
IOnlineConfiguration	onlineConfiguration

Methods

FreetextIndexRowsAsync(string, int[], CancellationToken)

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

Declaration

public 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	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

GetStatusAsync(CancellationToken)

Returns status for the freetext search words

Declaration

public Task<FreeText> GetStatusAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

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

public 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	This operation cannot be cancelled; the cancellationToken parameter is ignored

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

public Task SetEnabledAsync(bool enabled, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool	enabled	If enabled true, else false
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

SetMultiWordOperatorAsync(FreeTextOperator, CancellationToken)

Sets the operator used when matching multiple words

Declaration

public Task SetMultiWordOperatorAsync(FreeTextOperator freeTextOperator, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
FreeTextOperator	freeTextOperator	The operator
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	No return value

SetSingleWordOperatorAsync(FreeTextOperator, CancellationToken)

Sets the operator used when matching single words

Declaration

public Task SetSingleWordOperatorAsync(FreeTextOperator freeTextOperator, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
FreeTextOperator	freeTextOperator	The operator
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

Implements

IFreeTextAgent

IAgent