SearchCombinationOptions



Properties

Name Description Type
qSearchFields

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

 Array of Strings
qContext

Search context. The default value is LockedFieldsOnly .

One of:

  • Cleared or CONTEXT_CLEARED
  • LockedFieldsOnly or CONTEXT_LOCKED_FIELDS_ONLY
  • CurrentSelections or CONTEXT_CURRENT_SELECTIONS
 String
qCharEncoding

Encoding used to compute qRanges of type SearchCharRange.

Only affects the computation of the ranges. It does not impact the encoding of the text.

One of:

  • Utf8 or CHAR_ENCODING_UTF8
  • Utf16 or CHAR_ENCODING_UTF16
 String
qAttributes

Optional.

  • For SearchSuggest method, this array is empty.
  • For SearchObjects method, this array is empty or contain qProperty .
  • For SearchResults method, this array is empty, or contains qNum and/or qElemNum . It allows the user to request details in the outputted SearchGroupItemMatch . For more information, see SearchGroupItemMatch.
 Array of Strings