Class NSFreeText

Used to manage freetext search.

Syntax

Constructors

NSFreeText()

Initializes a new instance of the NSFreeText class.

Declaration

NSFreeText

Methods

GetAutoEnableTravelAreas()

Used to manage freetext search.

Declaration

Bool GetAutoEnableTravelAreas()

Returns

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

Examples

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

GetCountWords()

Used to manage freetext search.

Declaration

Integer GetCountWords()

Returns

Type	Description
Integer	Count of unique search words.

Examples

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

GetFreeTextEnabled()

Used to manage freetext search.

Declaration

Bool GetFreeTextEnabled()

Returns

Type	Description
Bool	True if free-text search enabled.

Examples

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

GetLastGenerated()

Used to manage freetext search.

Declaration

DateTime GetLastGenerated()

Returns

Type	Description
DateTime	Last time search has been generated.

Examples

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

GetMultiWordOperator()

Used to manage freetext search.

Declaration

Integer GetMultiWordOperator()

Returns

Type	Description
Integer	Starts with, contains or exact match. See FreeTextOperator

Examples

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

GetOccurrences()

Used to manage freetext search.

Declaration

Integer GetOccurrences()

Returns

Type	Description
Integer	Total count of search words.

Examples

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

GetSingleWordOperator()

Used to manage freetext search.

Declaration

Integer GetSingleWordOperator()

Returns

Type	Description
Integer	Starts with, contains or exact match. See FreeTextOperator

Examples

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

SetAutoEnableTravelAreas(Bool)

Used to manage freetext search.

Declaration

Void SetAutoEnableTravelAreas(Bool autoEnableTravelAreas)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetCountWords(Integer)

Used to manage freetext search.

Declaration

Void SetCountWords(Integer countWords)

Parameters

Type	Name	Description
Integer	countWords	Count of unique search words.

Returns

Type	Description
Void

Examples

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

SetFreeTextEnabled(Bool)

Used to manage freetext search.

Declaration

Void SetFreeTextEnabled(Bool freeTextEnabled)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetLastGenerated(DateTime)

Used to manage freetext search.

Declaration

Void SetLastGenerated(DateTime lastGenerated)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetMultiWordOperator(Integer)

Used to manage freetext search.

Declaration

Void SetMultiWordOperator(Integer multiWordOperator)

Parameters

Type	Name	Description
Integer	multiWordOperator	Starts with, contains or exact match. See FreeTextOperator.

Returns

Type	Description
Void

Examples

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

SetOccurrences(Integer)

Used to manage freetext search.

Declaration

Void SetOccurrences(Integer occurrences)

Parameters

Type	Name	Description
Integer	occurrences	Total count of search words.

Returns

Type	Description
Void

Examples

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

SetSingleWordOperator(Integer)

Used to manage freetext search.

Declaration

Void SetSingleWordOperator(Integer singleWordOperator)

Parameters

Type	Name	Description
Integer	singleWordOperator	Starts with, contains or exact match. See FreeTextOperator.

Returns

Type	Description
Void

Examples

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