ClassPreviousMessageListQuery

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 channelUrl customTypesFilter includeMetaArray includeParentMessageInfo includeReactions includeThreadInfo limit messageTypeFilter replyType reverse senderUserIdsFilter showSubchannelMessagesOnly

Accessors

hasNext isLoading

Methods

load

Properties

ReadonlychannelType

channelType: ChannelType

Description

A channel type.

ReadonlychannelUrl

channelUrl: string

Description

A channel URL.

ReadonlycustomTypesFilter

customTypesFilter: null | string[] = null

Description

The custom type filter of the message.

ReadonlyincludeMetaArray

includeMetaArray: boolean = false

Description

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

ReadonlyincludeParentMessageInfo

includeParentMessageInfo: boolean = false

Description

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

ReadonlyincludeReactions

includeReactions: boolean = false

Description

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

ReadonlyincludeThreadInfo

includeThreadInfo: boolean = false

Description

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

Readonlylimit

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

ReadonlymessageTypeFilter

messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL

Description

Message type filter.

ReadonlyreplyType

replyType: ReplyType = ReplyType.NONE

Description

Determines the reply types to include in the results.

Readonlyreverse

reverse: boolean = false

Description

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

ReadonlysenderUserIdsFilter

senderUserIdsFilter: null | string[] = null

Description

Sender user IDs filter.

ReadonlyshowSubchannelMessagesOnly

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

hasNext

  • get hasNext(): boolean

  • Returns boolean

    Description

    Whether there is a next page.

isLoading

  • get isLoading(): boolean

  • Returns boolean

    Description

    Whether the current query is in communication progress with server.

Methods

load

  • load(): Promise<BaseMessage[]>

  • Returns Promise<BaseMessage[]>

    Description

    Requests query result for the previous messages.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods