Skip to content

Commit 7350c81

Browse files
committed
Update SearchMessagesArguments to support cursor pagination
1 parent 893a37d commit 7350c81

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

packages/web-api/src/types/request/search.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,19 @@ interface Searchable extends OptionalTeamAssignable, SortDir {
1212
sort?: 'score' | 'timestamp';
1313
}
1414

15+
interface SearchMessagesCursorPagination {
16+
/**
17+
* @description Paginate through collections of data by setting the `cursor` parameter to `*` for the first "page"
18+
* or a `next_cursor` attribute returned by a previous request's `response_metadata`.
19+
* Use the `count` parameter to set the number of items to return per page rather than `limit`.
20+
* @see {@link https://docs.slack.dev/apis/web-api/pagination pagination} for more detail.
21+
*/
22+
cursor?: string;
23+
}
24+
1525
// https://docs.slack.dev/reference/methods/search.all
1626
export interface SearchAllArguments extends TokenOverridable, TraditionalPagingEnabled, Searchable {}
1727
// https://docs.slack.dev/reference/methods/search.files
1828
export interface SearchFilesArguments extends TokenOverridable, TraditionalPagingEnabled, Searchable {}
1929
// https://docs.slack.dev/reference/methods/search.messages
20-
export interface SearchMessagesArguments extends TokenOverridable, TraditionalPagingEnabled, Searchable {}
30+
export interface SearchMessagesArguments extends TokenOverridable, TraditionalPagingEnabled, Searchable, SearchMessagesCursorPagination {}

0 commit comments

Comments
 (0)