SearchAllArguments.md

@slack/web-api / SearchAllArguments

Interface: SearchAllArguments

Defined in: src/types/request/search.ts:16

Extends

• TokenOverridable.TraditionalPagingEnabled.Searchable

Properties

count?

optional count: number;

Defined in: src/types/request/common.ts:33

Description

Number of items to return per page. Defaults to 20

Inherited from

TraditionalPagingEnabled.count

---

highlight?

optional highlight: boolean;

Defined in: src/types/request/search.ts:10

Description

Set to true to enable query highlight markers. Defaults to false.

See

`search.messages` Usage info for details.

Inherited from

Searchable.highlight

---

page?

optional page: number;

Defined in: src/types/request/common.ts:35

Description

Page number of results to return. Defaults to 1.

Inherited from

TraditionalPagingEnabled.page

---

query

query: string;

Defined in: src/types/request/search.ts:5

Description

Search query.

Inherited from

Searchable.query

---

sort?

optional sort: "score" | "timestamp";

Defined in: src/types/request/search.ts:12

Description

Return matches sorted by either score or timestamp. Defaults to score.

Inherited from

Searchable.sort

---

sort_dir?

optional sort_dir: "asc" | "desc";

Defined in: src/types/request/common.ts:130

Description

Change sort direction to ascending (asc) or descending (desc). Defaults to desc.

Inherited from

Searchable.sort_dir

---

team_id?

optional team_id: string;

Defined in: src/types/request/common.ts:70

Description

If using an org token, team_id is required.

Inherited from

Searchable.team_id

---

token?

optional token: string;

Defined in: src/types/request/common.ts:43

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token