SelectAssociations method

Overview

Selects all search hits for a specified group.

The results depend on the search context.

Name	Description	Type
qOptions	Information about the search fields and the search context.	SearchCombinationOptions
qTerms	List of terms to search for.	Array of String
qMatchIx	Index (value of qId) of the search result to select. The SearchAssociations method returns the index of the search result in qResults/qSearchTermsMatched.	Integer
qSoftLock	This parameter is deprecated and should not be set.	Boolean

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:

"result": {}

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!