InterfacePreviousMessageListQueryParams

interface PreviousMessageListQueryParams {
    customTypesFilter?: string[];
    includeMetaArray?: boolean;
    includeParentMessageInfo?: boolean;
    includeReactions?: boolean;
    includeThreadInfo?: boolean;
    limit?: number;
    messageTypeFilter?: MessageTypeFilter;
    replyType?: ReplyType;
    reverse?: boolean;
    senderUserIdsFilter?: string[];
    showSubchannelMessagesOnly?: boolean;
}

Hierarchy

  • BaseListQueryParams
    • PreviousMessageListQueryParams

Properties

customTypesFilter? includeMetaArray? includeParentMessageInfo? includeReactions? includeThreadInfo? limit? messageTypeFilter? replyType? reverse? senderUserIdsFilter? showSubchannelMessagesOnly?

Properties

OptionalcustomTypesFilter

customTypesFilter?: string[]

Description

The custom type filter of the message.

OptionalincludeMetaArray

includeMetaArray?: boolean

Description

Whether the meta arrays should be included in the results. If the value is null, it follows the default value.

OptionalincludeParentMessageInfo

includeParentMessageInfo?: boolean

Description

Whether the information of a parent message should be included in the reply messages included in the results.

OptionalincludeReactions

includeReactions?: boolean

Description

Whether the reaction data should be included in the results. If the value is null, it follows the default value.

OptionalincludeThreadInfo

includeThreadInfo?: boolean

Description

Whether the thread information should be included in the results. If the value is null, it follows the default value.

Optionallimit

limit?: number

Description

The maximum number of data per queried page.

OptionalmessageTypeFilter

messageTypeFilter?: MessageTypeFilter

Description

Message type filter.

OptionalreplyType

replyType?: ReplyType

Description

Determines the reply types to include in the results.

Optionalreverse

reverse?: boolean

Description

Indicates whether the queried result will be reversed. If true, the result will be returned by creation time descending order.

OptionalsenderUserIdsFilter

senderUserIdsFilter?: string[]

Description

Sender user IDs filter.

OptionalshowSubchannelMessagesOnly

showSubchannelMessagesOnly?: boolean

Description

If set to true, only messages that belong to current user's subchannel is fetched. If set to false, all messages will be fetched. Default is false. Takes effect only when the requested channel is a dynamically partitioned open channel.

Settings

Member Visibility

On This Page

Properties