Interface: ConversationsHistoryArguments
Extends
Channel.IncludeAllMetadata.TokenOverridable.CursorPaginationEnabled.TimelinePaginationEnabled
Properties
channel
channel: string;
Description
ID of conversation.
Inherited from
Channel.channel
Defined in
packages/web-api/src/types/request/conversations.ts:15
cursor?
optional cursor: string;
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
Defined in
packages/web-api/src/types/request/common.ts:16
include_all_metadata?
optional include_all_metadata: boolean;
Description
Return all metadata associated with messages. Defaults to false.
Inherited from
IncludeAllMetadata.include_all_metadata
Defined in
packages/web-api/src/types/request/conversations.ts:24
inclusive?
optional inclusive: boolean;
Description
Include messages with oldest or latest timestamps in results.
Ignored unless either timestamp is specified. Defaults to false.
Inherited from
TimelinePaginationEnabled.inclusive
Defined in
packages/web-api/src/types/request/common.ts:28
latest?
optional latest: string;
Description
Only messages before this Unix timestamp will be included in results.
Inherited from
TimelinePaginationEnabled.latest
Defined in
packages/web-api/src/types/request/common.ts:23
limit?
optional limit: number;
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
Defined in
packages/web-api/src/types/request/common.ts:9
oldest?
optional oldest: string;
Description
Only messages after this Unix timestamp will be included in results.
Inherited from
TimelinePaginationEnabled.oldest
Defined in
packages/web-api/src/types/request/common.ts:21
token?
optional token: string;
Description
Overridable authentication token bearing required scopes.
Inherited from
TokenOverridable.token