Message search allows you to retrieve a list of messages that contain a search query or a specified keyword in group channels by implementing MessageSearchQuery
. The query retrieves a list of messages that contain a search term and meet the optional parameter value set in the MessageSearchQueryParams
class.
You can create the query instance by following the code below.
Then, the query retrieves a list of match results. Calling the builder method again returns the next page of the results.
Use the hasNext
method to see if there is a next page.
Use the isLoading
method to see if the search results are loading.
You can build the query class using the following parameters, which allows you to add various search options.
Parameter name | Type | Description |
---|---|---|
keyword | String | Specifies the search term. |
channelURL | String | Specifies the URL of the target channel. |
channelCustomType | String | Specifies the custom channel type. |
limit | UInt | Specifies the number of messages to return per page. Acceptable values are |
exactMatch | Bool | Determines whether to search for messages that exactly match the search term. If set to |
messageTimestampFrom | Int64 | Restricts the search scope to the messages sent after the specified time in Unix milliseconds |
messageTimestampTo | Int64 | Restricts the search scope to the messages sent before the specified time in Unix milliseconds |
order | Determines which field the results are sorted by. Acceptable values are the following: | |
reverse | Bool | Determines whether to sort the results in reverse order. If set to |