Skip to content

ConversationsHistoryArguments.md

Latest commit

 

History

History
177 lines (107 loc) · 3.57 KB

ConversationsHistoryArguments.md

File metadata and controls

177 lines (107 loc) · 3.57 KB

@slack/web-api / ConversationsHistoryArguments

Interface: ConversationsHistoryArguments

Defined in: src/types/request/conversations.ts:93

Extends

  • Channel.IncludeAllMetadata.TokenOverridable.CursorPaginationEnabled.TimelinePaginationEnabled

Properties

channel

channel: string;

Defined in: src/types/request/conversations.ts:15

Description

ID of conversation.

Inherited from

Channel.channel

cursor?

optional cursor: string;

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

Description

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.

See

pagination for more detail.

Inherited from

CursorPaginationEnabled.cursor

include_all_metadata?

optional include_all_metadata: boolean;

Defined in: src/types/request/conversations.ts:24

Description

Return all metadata associated with messages. Defaults to false.

Inherited from

IncludeAllMetadata.include_all_metadata

inclusive?

optional inclusive: boolean;

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

Description

Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified. Defaults to false.

Inherited from

TimelinePaginationEnabled.inclusive

latest?

optional latest: string;

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

Description

Only messages before this Unix timestamp will be included in results.

Inherited from

TimelinePaginationEnabled.latest

limit?

optional limit: number;

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

Description

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer with a max value of 999. Default is 100.

Inherited from

CursorPaginationEnabled.limit

oldest?

optional oldest: string;

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

Description

Only messages after this Unix timestamp will be included in results.

Inherited from

TimelinePaginationEnabled.oldest

token?

optional token: string;

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

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token