Interface: SearchAllArguments
Extends
TokenOverridable.TraditionalPagingEnabled.Searchable
Properties
count?
optional count: number;
Description
Number of items to return per page. Defaults to 20
Inherited from
TraditionalPagingEnabled.count
Defined in
packages/web-api/src/types/request/common.ts:33
highlight?
optional highlight: boolean;
Description
Set to true to enable query highlight markers. Defaults to false.
See
search.messages Usage info for details.
Inherited from
Searchable.highlight
Defined in
packages/web-api/src/types/request/search.ts:10
page?
optional page: number;
Description
Page number of results to return. Defaults to 1.
Inherited from
TraditionalPagingEnabled.page
Defined in
packages/web-api/src/types/request/common.ts:35
query
query: string;
Description
Search query.
Inherited from
Searchable.query
Defined in
packages/web-api/src/types/request/search.ts:5
sort?
optional sort: "score" | "timestamp";
Description
Return matches sorted by either score or timestamp. Defaults to score.
Inherited from
Searchable.sort
Defined in
packages/web-api/src/types/request/search.ts:12
sort_dir?
optional sort_dir: "asc" | "desc";
Description
Change sort direction to ascending (asc) or descending (desc). Defaults to desc.
Inherited from
Searchable.sort_dir
Defined in
packages/web-api/src/types/request/common.ts:130
team_id?
optional team_id: string;
Description
If using an org token, team_id is required.
Inherited from
Searchable.team_id
Defined in
packages/web-api/src/types/request/common.ts:70
token?
optional token: string;
Description
Overridable authentication token bearing required scopes.
Inherited from
TokenOverridable.token