Interface ThreadedMessageListParams

Description

Represents a message list params.

Hierarchy

  • ThreadedMessageListParams

Properties

customTypesFilter? includeMetaArray? includeParentMessageInfo? includeReactions? isInclusive? messageTypeFilter? nextResultSize prevResultSize reverse? senderUserIdsFilter?

Properties

Optional customTypesFilter

customTypesFilter?: string[]

Restricts the search scope only to retrieve the messages with the specified custom message types.

Optional includeMetaArray

includeMetaArray?: boolean

Whether the result message includes MessageMetaArray.

Optional includeParentMessageInfo

includeParentMessageInfo?: boolean

Whether the result message includes the parent message info.

Optional includeReactions

includeReactions?: boolean

Whether the result message includes Reactions.

Optional isInclusive

isInclusive?: boolean

Determines whether to include the messages sent exactly on the specified timestamp or have the matching message ID in the results.

Optional messageTypeFilter

messageTypeFilter?: MessageTypeFilter

Restricts the search scope only to retrieve the messages with the specified message type.

nextResultSize

nextResultSize: number

The number of newer messages added either before the timestamp or the message that has a specific message ID.

prevResultSize

prevResultSize: number

The number of previous messages added either before the timestamp or the message that has a specific message ID.

Optional reverse

reverse?: boolean

Determines whether to sort the retrieved messages in reverse order.

Optional senderUserIdsFilter

senderUserIdsFilter?: string[]

Restricts the search scope only to retrieve the messages sent by the users with the specified user IDs.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc