Description

A class representing query to retrieve previous message list for a channel. The query can be get by calling sendbirdChat.openChannel.createPreviousMessageListQuery() or sendbirdChat.openChannel.createPreviousMessageListQuery().

Hierarchy

  • default
    • PreviousMessageListQuery

Properties

channelType: ChannelType

Description

A channel type.

channelUrl: string

Description

A channel URL.

customTypesFilter: null | string[] = null

Description

The custom type filter of the message.

includeMetaArray: boolean = false

Description

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

includeParentMessageInfo: boolean = false

Description

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

includeReactions: boolean = false

Description

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

includeThreadInfo: boolean = false

Description

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

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL

Description

Message type filter.

replyType: ReplyType = ReplyType.NONE

Description

Determines the reply types to include in the results.

reverse: boolean = false

Description

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

senderUserIdsFilter: null | string[] = null

Description

Sender user IDs filter.

showSubchannelMessagesOnly: boolean = false

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.

Accessors

  • get hasNext(): boolean
  • Returns boolean

    Description

    Whether there is a next page.

  • get isLoading(): boolean
  • Returns boolean

    Description

    Whether the current query is in communication progress with server.

Methods

  • Returns Promise<BaseMessage[]>

    Description

    Requests query result for the previous messages.

Generated using TypeDoc