SearchSuggest method

Overview

Returns search terms suggestions.

Name	Description	Type
qOptions	Information about the search combinations.	SearchCombinationOptions
qTerms	Terms to search for.	Array of String

Name	Description	Type
qSearchFields	List of the search fields. If empty, the search is performed in all fields of the app.	Array of String
qContext	Search context. The default value is LockedFieldsOnly.	One of: Cleared: In this mode, the first step is to clear any current selections in the app. The second step is to search for one or more terms in the values of the app. LockedFieldsOnly: In this mode, the search applies only to the values associated with the selections made in locked fields, ignoring selections in any unlocked field. If no locked fields, the behavior is identical to the Cleared context. You cannot make any new selections in a locked field. You can get search hits for the associated values of a locked field but you cannot get the search hits for the non associative values. CurrentSelections: In this mode, the current selections are kept (if any). Search for one or more terms in the values of the app. New selections are made on top of the current selections. If no selections were made before the search, this mode is identical to the Cleared context.

Name

Description

Type

qSearchFields

List of the search fields.

If empty, the search is performed in all fields of the app.

Array of String

qContext

Search context.

The default value is LockedFieldsOnly.

One of:

Cleared: In this mode, the first step is to clear any current selections in the app. The second step is to search for one or more terms in the values of the app.
LockedFieldsOnly: In this mode, the search applies only to the values associated with the selections made in locked fields, ignoring selections in any unlocked field. If no locked fields, the behavior is identical to the Cleared context. You cannot make any new selections in a locked field. You can get search hits for the associated values of a locked field but you cannot get the search hits for the non associative values.
CurrentSelections: In this mode, the current selections are kept (if any). Search for one or more terms in the values of the app. New selections are made on top of the current selections. If no selections were made before the search, this mode is identical to the Cleared context.

The following is returned in the output:

Name	Description	Type
qResult	List of search suggestions.	SearchSuggestionResult

Name	Description	Type
qSuggestions	List of suggestions.	Array of SearchSuggestItem
qFieldNames	List of field names that contain search hits.	Array of String

Name	Description	Type
qValue	Value of the suggestion.	String
qTerm	Index of the suggestion value. The indexing starts from 0 and from the left.	Integer

Name

Description

Type

qValue

Value of the suggestion.

String

qTerm

Index of the suggestion value.

The indexing starts from 0 and from the left.

Integer

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!