com.sendbird.android

Class MessageSearchQuery.Builder

java.lang.Object

com.sendbird.android.MessageSearchQuery.Builder

Enclosing class:

MessageSearchQuery

public static class MessageSearchQuery.Builder
extends java.lang.Object

A Builder class to build a MessageSearchQuery

Since:

3.0.116

Constructor Summary

Constructors

Constructor and Description
Builder() A constructor to build a MessageSearchQuery
Builder(MessageSearchQuery query) A constructor to build a MessageSearchQuery

Method Summary

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 BaseMessages 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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

A constructor to build a MessageSearchQuery

Since:

3.0.116

Builder

public Builder(MessageSearchQuery query)

A constructor to build a MessageSearchQuery

Parameters:

query - A class representing query to retrieve list of BaseMessages that matches a given query with given filters.

Since:

3.0.158

Method Detail

setLimit

public MessageSearchQuery.Builder setLimit(int limit)

Sets the maximum number of BaseMessages per queried page. Default is 20.

Parameters:

limit - The maximum number of BaseMessages per page.

Since:

3.0.116

setReverse

public MessageSearchQuery.Builder setReverse(boolean reverse)

Sets whether to reverse the queried result list. Default is false.

Parameters:

reverse - should reverse queried result list.

Since:

3.0.116

setKeyword

public MessageSearchQuery.Builder setKeyword(java.lang.String keyword)

Sets the query keyword to search for.

Parameters:

keyword - keyword to search for.

Since:

3.0.116

setExactMatch

public MessageSearchQuery.Builder setExactMatch(boolean exactMatch)

Sets whether to search the keyword as a complete, exact phrase or not. The search is done case insensitively. Default is false.

Parameters:

exactMatch - should search as a complete, exact phrase.

Since:

3.0.116

setChannelUrl

public MessageSearchQuery.Builder setChannelUrl(java.lang.String channelUrl)

Sets the scope of search to a single channel with given channel url.

Parameters:

channelUrl - channel url of the channel you want to set as a scope for the search.

Since:

3.0.116

setChannelCustomType

public MessageSearchQuery.Builder setChannelCustomType(java.lang.String channelCustomType)

Sets the scope of the search to channels with the given channel custom type.

Parameters:

channelCustomType - channel custom type you want to set as a scope for the search.

Since:

3.0.116

setMessageTimestampFrom

public MessageSearchQuery.Builder setMessageTimestampFrom(long messageTimestampFrom)

Sets the start range of searched messages to search for messages created after the given timestamp. Default is 0.

Parameters:

messageTimestampFrom - starting timestamp to search from.

Since:

3.0.116

setMessageTimestampTo

public MessageSearchQuery.Builder setMessageTimestampTo(long messageTimestampTo)

Sets the end range of searched messages to messages search for created before the given timestamp. Default is Long.MAX_VALUE.

Parameters:

messageTimestampTo - end timestamp to search from.

Since:

3.0.116

setOrder

public MessageSearchQuery.Builder setOrder(MessageSearchQuery.Order order)

Sets the search order. Default is MessageSearchQuery.Order.SCORE

Parameters:

order - the order method for the search.

Since:

3.0.116

setAdvancedQuery

public MessageSearchQuery.Builder setAdvancedQuery(boolean advancedQuery)

Sets whether to search the keyword as a advanced phrase or not. Default is false.

Parameters:

advancedQuery - the order method for the search.

Since:

3.0.162

setTargetFields

public MessageSearchQuery.Builder setTargetFields(java.util.List<java.lang.String> targetFields)

Sets the scope of the search to message fields with the given target fields.

Parameters:

targetFields - the order method for the search.

Since:

3.0.162

build

public MessageSearchQuery build()

Builds the MessageSearchQuery with set parameters.

Returns:

MessageSearchQuery object.

Since:

3.0.116