Class NSFreeText

Used to manage freetext search.

Constructors

NSFreeText()

Initializes a new instance of the NSFreeText class.

Declaration

NSFreeText

Methods

GetAutoEnableTravelAreas()

Declaration

Bool GetAutoEnableTravelAreas()

Examples

NSFreeText thing;
Bool autoEnableTravelAreas = thing.GetAutoEnableTravelAreas();

Returns

Type	Description
Bool	Automatically enable free-text search for new travel areas.

GetCountWords()

Declaration

Integer GetCountWords()

Examples

NSFreeText thing;
Integer countWords = thing.GetCountWords();

Returns

Type	Description
Integer	Count of unique search words.

GetFreeTextEnabled()

Declaration

Bool GetFreeTextEnabled()

Examples

NSFreeText thing;
Bool freeTextEnabled = thing.GetFreeTextEnabled();

Returns

Type	Description
Bool	True if free-text search enabled.

GetLastGenerated()

Declaration

DateTime GetLastGenerated()

Examples

NSFreeText thing;
DateTime lastGenerated = thing.GetLastGenerated();

Returns

Type	Description
DateTime	Last time search has been generated.

GetMultiWordOperator()

Declaration

Integer GetMultiWordOperator()

Examples

NSFreeText thing;
Integer multiWordOperator = thing.GetMultiWordOperator();

Returns

Type	Description
Integer	Starts with, contains or exact match. See <xref href="CRMScript.NetServer.FreeTextOperator" data-throw-if-not-resolved="false"></xref>

GetOccurrences()

Declaration

Integer GetOccurrences()

Examples

NSFreeText thing;
Integer occurrences = thing.GetOccurrences();

Returns

Type	Description
Integer	Total count of search words.

GetSingleWordOperator()

Declaration

Integer GetSingleWordOperator()

Examples

NSFreeText thing;
Integer singleWordOperator = thing.GetSingleWordOperator();

Returns

Type	Description
Integer	Starts with, contains or exact match. See <xref href="CRMScript.NetServer.FreeTextOperator" data-throw-if-not-resolved="false"></xref>

SetAutoEnableTravelAreas(Bool)

Declaration

Void SetAutoEnableTravelAreas(Bool autoEnableTravelAreas)

Examples

NSFreeText thing;
Bool autoEnableTravelAreas;
thing.SetAutoEnableTravelAreas(autoEnableTravelAreas);

Parameters

Type	Name	Description
Bool	autoEnableTravelAreas	Automatically enable free-text search for new travel areas.

Returns

Type	Description
Void

SetCountWords(Integer)

Declaration

Void SetCountWords(Integer countWords)

Examples

NSFreeText thing;
Integer countWords;
thing.SetCountWords(countWords);

Parameters

Type	Name	Description
Integer	countWords	Count of unique search words.

Returns

Type	Description
Void

SetFreeTextEnabled(Bool)

Declaration

Void SetFreeTextEnabled(Bool freeTextEnabled)

Examples

NSFreeText thing;
Bool freeTextEnabled;
thing.SetFreeTextEnabled(freeTextEnabled);

Parameters

Type	Name	Description
Bool	freeTextEnabled	True if free-text search enabled.

Returns

Type	Description
Void

SetLastGenerated(DateTime)

Declaration

Void SetLastGenerated(DateTime lastGenerated)

Examples

NSFreeText thing;
DateTime lastGenerated;
thing.SetLastGenerated(lastGenerated);

Parameters

Type	Name	Description
DateTime	lastGenerated	Last time search has been generated.

Returns

Type	Description
Void

SetMultiWordOperator(Integer)

Declaration

Void SetMultiWordOperator(Integer multiWordOperator)

Examples

NSFreeText thing;
Integer multiWordOperator;
thing.SetMultiWordOperator(multiWordOperator);

Parameters

Type	Name	Description
Integer	multiWordOperator	Starts with, contains or exact match. See <xref href="CRMScript.NetServer.FreeTextOperator" data-throw-if-not-resolved="false"></xref>.

Returns

Type	Description
Void

SetOccurrences(Integer)

Declaration

Void SetOccurrences(Integer occurrences)

Examples

NSFreeText thing;
Integer occurrences;
thing.SetOccurrences(occurrences);

Parameters

Type	Name	Description
Integer	occurrences	Total count of search words.

Returns

Type	Description
Void

SetSingleWordOperator(Integer)

Declaration

Void SetSingleWordOperator(Integer singleWordOperator)

Examples

NSFreeText thing;
Integer singleWordOperator;
thing.SetSingleWordOperator(singleWordOperator);

Parameters

Type	Name	Description
Integer	singleWordOperator	Starts with, contains or exact match. See <xref href="CRMScript.NetServer.FreeTextOperator" data-throw-if-not-resolved="false"></xref>.

Returns

Type	Description
Void