Type Alias SearchCombinationOptions

type SearchCombinationOptions = {
    qAttributes?: string[];
    qCharEncoding?: CharEncodingType;
    qContext?: SearchContextType;
    qSearchFields?: string[];
}

Index

Properties

qAttributes? qCharEncoding? qContext? qSearchFields?

Properties

`Optional`qAttributes

qAttributes?: string[]

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.

`Optional`qCharEncoding

qCharEncoding?: CharEncodingType

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

`Optional`qContext

qContext?: SearchContextType

Search context. The default value is LockedFieldsOnly .

One of:

Cleared or CONTEXT_CLEARED
LockedFieldsOnly or CONTEXT_LOCKED_FIELDS_ONLY
CurrentSelections or CONTEXT_CURRENT_SELECTIONS

`Optional`qSearchFields

qSearchFields?: string[]

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