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

AddWords(String)

Adds the words in the string to the stop word list

Declaration

void AddWords(string stopWords)

Parameters

Type	Name	Description
String	stopWords	The stop words to add

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeleteStopWordsById(Int32[])

Delete the stop words with these ids

Declaration

void DeleteStopWordsById(int[] stopWordIds)

Parameters

Type	Name	Description
Int32[]	stopWordIds	The ids of the stopwords to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

FreetextIndexRows(String, Int32[])

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

Declaration

void FreetextIndexRows(string tableName, int[] iDs)

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
Int32[]	iDs	One or more primary keys, identifying records to be (re)indexed. It doesn't matter if they have been indexed before or not

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetStatus()

Returns status for the freetext search words

Declaration

FreeText GetStatus()

Returns

Type	Description
FreeText	The freetext status

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetStopWordList()

Returns the list of stop words

Declaration

string[] GetStopWordList()

Returns

Type	Description
String[]	The list of stop words

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetSuggestedStopWords(Int32)

Returns the top used words in the freetext index table, sorted as most used first

Declaration

MDOListItem[] GetSuggestedStopWords(int countWords)

Parameters

Type	Name	Description
Int32	countWords	The count of words that will be returned

Returns

Type	Description
MDOListItem[]	The most used words

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

RegenerateIndex(Boolean)

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

Declaration

BatchTaskInfo RegenerateIndex(bool runAsBatch)

Parameters

Type	Name	Description
Boolean	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

Returns

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

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SetAutoEnableTravelAreas(Boolean)

Automatically enable freetext search for new travel areas? true or false

Declaration

void SetAutoEnableTravelAreas(bool autoEnable)

Parameters

Type	Name	Description
Boolean	autoEnable	If true, auto enable

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SetEnabled(Boolean)

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

Declaration

void SetEnabled(bool enabled)

Parameters

Type	Name	Description
Boolean	enabled	If enabled true, else false

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SetMultiWordOperator(FreeTextOperator)

Sets the operator used when matching multiple words

Declaration

void SetMultiWordOperator(FreeTextOperator freeTextOperator)

Parameters

Type	Name	Description
FreeTextOperator	freeTextOperator	The operator

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SetSingleWordOperator(FreeTextOperator)

Sets the operator used when matching single words

Declaration

void SetSingleWordOperator(FreeTextOperator freeTextOperator)

Parameters

Type	Name	Description
FreeTextOperator	freeTextOperator	The operator

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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