Interface MessageListParams

Description

Represents a message list params.

interface MessageListParams {
    customTypesFilter?: string[];
    includeMetaArray?: boolean;
    includeParentMessageInfo?: boolean;
    includeReactions?: boolean;
    includeThreadInfo?: boolean;
    isInclusive?: boolean;
    messageTypeFilter?: MessageTypeFilter;
    nextResultSize: number;
    prevResultSize: number;
    replyType?: ReplyType;
    reverse?: boolean;
    senderUserIdsFilter?: string[];
    showSubchannelMessagesOnly?: boolean;
}

Properties

customTypesFilter? includeMetaArray? includeParentMessageInfo? includeReactions? includeThreadInfo? isInclusive? messageTypeFilter? nextResultSize prevResultSize replyType? reverse? senderUserIdsFilter? showSubchannelMessagesOnly?

Properties

OptionalcustomTypesFilter

customTypesFilter?: string[]

Restricts the search scope only to retrieve the messages that match any of given custom types. When a empty string is given, messages that does not have a custom type will also be returned.

OptionalincludeMetaArray

includeMetaArray?: boolean

Whether the result message includes MessageMetaArray.

OptionalincludeParentMessageInfo

includeParentMessageInfo?: boolean

Whether the result message includes parent message info.

OptionalincludeReactions

includeReactions?: boolean

Whether the result message includes Reactions.

OptionalincludeThreadInfo

includeThreadInfo?: boolean

Whether the result message includes ThreadInfo.

OptionalisInclusive

isInclusive?: boolean

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

OptionalmessageTypeFilter

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.

OptionalreplyType

replyType?: ReplyType

Determines the reply types to include in the results.

Optionalreverse

reverse?: boolean

Determines whether to sort the retrieved messages in reverse order.

OptionalsenderUserIdsFilter

senderUserIdsFilter?: string[]

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

OptionalshowSubchannelMessagesOnly

showSubchannelMessagesOnly?: boolean

Whether to show subchannel message only. (default: false) This only takes effect when the requested channel is a dynamically partitioned OpenChannel.

Settings

Member Visibility

On This Page

Properties