Interface SearchSorting

Sorting parameters provided with a Search request.

interface SearchSorting {
    field: string;
    fieldType?: SearchFieldType;
    filter?: _SearchQueryExpression;
    language?: string;
    mode?: SearchSortMode;
    order: SearchSortOrder;
}

Properties

field fieldType? filter? language? mode? order

Properties

Readonlyfield

field: string

Use any searchable field of the resource as sort criterion, or "score" to sort by relevance score calculated by the API.

Optional ReadonlyfieldType

fieldType?: SearchFieldType

Provide the data type of the given field.

Optional Readonlyfilter

filter?: _SearchQueryExpression

Allows you to apply a sort filter.

Optional Readonlylanguage

language?: string

String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

Optional Readonlymode

mode?: SearchSortMode

Specify the sort mode to be applied for a set-type field.

Readonlyorder

order: SearchSortOrder

Specify the order in which the search results should be sorted. Can be asc for ascending, or desc for descending order.

Settings

Member Visibility

On This Page

Properties