Class MessageSearchQuery

Description

A class representing query to retrieve list of BaseMessages that matches a given query with given filters. MessageSearchQuery can be generated by using sendbirdChat.createMessageSearchQuery().

Hierarchy

  • default
    • MessageSearchQuery

Properties

advancedQuery channelCustomType channelUrl exactMatch keyword limit messageTimestampFrom messageTimestampTo order reverse targetFields totalCount

Accessors

hasNext isLoading

Methods

next

Properties

ReadonlyadvancedQuery

advancedQuery: boolean = false

Description

Whether the current search query should be an advanced query or not.

ReadonlychannelCustomType

channelCustomType: string = ''

Description

The current custom type of channel set as the search scope.

ReadonlychannelUrl

channelUrl: string = ''

Description

The current channel url set as the search scope.

ReadonlyexactMatch

exactMatch: boolean = false

Description

Whether the current search query should be an exact match or not.

Readonlykeyword

keyword: string = ''

Description

The current search keyword.

Readonlylimit

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

ReadonlymessageTimestampFrom

messageTimestampFrom: null | number = null

Description

The start message timestamp set as the search range.

ReadonlymessageTimestampTo

messageTimestampTo: null | number = null

Description

The end message timestamp set as the search range.

Readonlyorder

order: MessageSearchOrder = MessageSearchOrder.SCORE

Description

The current order method.

Readonlyreverse

reverse: boolean = false

Description

Whether the current search result is set to be reversed or not.

ReadonlytargetFields

targetFields: null | string[] = null

Description

The target fields of the current query as the search scope.

totalCount

totalCount: number = -1

Description

The total count of results that matches the given search.

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

next

  • next(): Promise<BaseMessage[]>

  • Returns Promise<BaseMessage[]>

    Description

    Gets the list of BaseMessages that matches the given search. If this method is repeatedly called after each next() is finished, it retrieves the following search results as BaseMessage list. If there is no more search results, an empty List (not null) is returned.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods