public static class MessageSearchQuery.Builder
extends java.lang.Object
Constructor and Description |
---|
Builder()
A constructor to build a MessageSearchQuery
|
Builder(MessageSearchQuery query)
A constructor to build a MessageSearchQuery
|
Modifier and Type | Method and Description |
---|---|
MessageSearchQuery |
build()
Builds the
MessageSearchQuery with set parameters. |
MessageSearchQuery.Builder |
setAdvancedQuery(boolean advancedQuery)
Sets whether to search the keyword as a advanced phrase or not.
|
MessageSearchQuery.Builder |
setChannelCustomType(java.lang.String channelCustomType)
Sets the scope of the search to channels with the given channel custom type.
|
MessageSearchQuery.Builder |
setChannelUrl(java.lang.String channelUrl)
Sets the scope of search to a single channel with given channel url.
|
MessageSearchQuery.Builder |
setExactMatch(boolean exactMatch)
Sets whether to search the keyword as a complete, exact phrase or not.
|
MessageSearchQuery.Builder |
setKeyword(java.lang.String keyword)
Sets the query keyword to search for.
|
MessageSearchQuery.Builder |
setLimit(int limit)
Sets the maximum number of
BaseMessage s per queried page. |
MessageSearchQuery.Builder |
setMessageTimestampFrom(long messageTimestampFrom)
Sets the start range of searched messages to search for messages created after the given timestamp.
|
MessageSearchQuery.Builder |
setMessageTimestampTo(long messageTimestampTo)
Sets the end range of searched messages to messages search for created before the given timestamp.
|
MessageSearchQuery.Builder |
setOrder(MessageSearchQuery.Order order)
Sets the search order.
|
MessageSearchQuery.Builder |
setReverse(boolean reverse)
Sets whether to reverse the queried result list.
|
MessageSearchQuery.Builder |
setTargetFields(java.util.List<java.lang.String> targetFields)
Sets the scope of the search to message fields with the given target fields.
|
public Builder()
public Builder(MessageSearchQuery query)
query
- A class representing query to retrieve list of BaseMessage
s that matches a given query with given filters.public MessageSearchQuery.Builder setLimit(int limit)
BaseMessage
s per queried page.
Default is 20
.limit
- The maximum number of BaseMessage
s per page.public MessageSearchQuery.Builder setReverse(boolean reverse)
false
.reverse
- should reverse queried result list.public MessageSearchQuery.Builder setKeyword(java.lang.String keyword)
keyword
- keyword to search for.public MessageSearchQuery.Builder setExactMatch(boolean exactMatch)
false
.exactMatch
- should search as a complete, exact phrase.public MessageSearchQuery.Builder setChannelUrl(java.lang.String channelUrl)
channelUrl
- channel url of the channel you want to set as a scope for the search.public MessageSearchQuery.Builder setChannelCustomType(java.lang.String channelCustomType)
channelCustomType
- channel custom type you want to set as a scope for the search.public MessageSearchQuery.Builder setMessageTimestampFrom(long messageTimestampFrom)
0
.messageTimestampFrom
- starting timestamp to search from.public MessageSearchQuery.Builder setMessageTimestampTo(long messageTimestampTo)
Long.MAX_VALUE
.messageTimestampTo
- end timestamp to search from.public MessageSearchQuery.Builder setOrder(MessageSearchQuery.Order order)
MessageSearchQuery.Order.SCORE
order
- the order method for the search.public MessageSearchQuery.Builder setAdvancedQuery(boolean advancedQuery)
false
.advancedQuery
- the order method for the search.public MessageSearchQuery.Builder setTargetFields(java.util.List<java.lang.String> targetFields)
targetFields
- the order method for the search.public MessageSearchQuery build()
MessageSearchQuery
with set parameters. Copyright © 2021, Sendbird or its affiliates. All rights reserved.
Report a bug or request a feature
For further developer documentation, see Chat SDK Documentation. That documentation contains more detailed descriptions, conceptual overviews, definitions of terms, and code examples.