com.twitter.sdk.android.tweetui

Class SearchTimeline.Builder

Object

com.twitter.sdk.android.tweetui.SearchTimeline.Builder

Enclosing class:

SearchTimeline

public static class SearchTimeline.Builder
extends Object

SearchTimeline Builder

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a Builder.

Method Summary

Modifier and Type	Method and Description
SearchTimeline	build() Builds a SearchTimeline from the Builder parameters.
SearchTimeline.Builder	geocode(Geocode geocode) Sets the geocode for the SearchTimeline.
SearchTimeline.Builder	languageCode(String languageCode) Sets the languageCode for the SearchTimeline.
SearchTimeline.Builder	maxItemsPerRequest(Integer maxItemsPerRequest) Sets the number of Tweets returned per request for the SearchTimeline.
SearchTimeline.Builder	query(String query) Sets the query for the SearchTimeline.
SearchTimeline.Builder	resultType(SearchTimeline.ResultType resultType) The result_type parameter allows one to choose if the result set will be represented by recent or popular Tweets, or a mix of both.
SearchTimeline.Builder	untilDate(Date date) Returns tweets generated before the given date.

Methods inherited from class Object

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

Constructor Detail

Builder

public Builder()

Constructs a Builder.

Method Detail

query

public SearchTimeline.Builder query(String query)

Sets the query for the SearchTimeline.

Parameters:

query - A UTF-8, URL-encoded search query of 500 characters maximum, including operators. Queries may additionally be limited by complexity.

geocode

public SearchTimeline.Builder geocode(Geocode geocode)

Sets the geocode for the SearchTimeline.

Parameters:

geocode - Restricts query to a given geolocation

resultType

public SearchTimeline.Builder resultType(SearchTimeline.ResultType resultType)

The result_type parameter allows one to choose if the result set will be represented by recent or popular Tweets, or a mix of both.

Parameters:

resultType - possible options include recent, popular, mixed, or filtered.

languageCode

public SearchTimeline.Builder languageCode(String languageCode)

Sets the languageCode for the SearchTimeline.

Parameters:

languageCode - Restricts tweets to the given language, given by an ISO 639-1 code. Language detection is best-effort.

maxItemsPerRequest

public SearchTimeline.Builder maxItemsPerRequest(Integer maxItemsPerRequest)

Sets the number of Tweets returned per request for the SearchTimeline.

Parameters:

maxItemsPerRequest - The number of tweets to return per request, up to a maximum of 100.

untilDate

public SearchTimeline.Builder untilDate(Date date)

Returns tweets generated before the given date. Date should be formatted as YYYY-MM-DD. Keep in mind that the search index may not go back as far as the date you specify here.

Parameters:

date - Date before which the tweets were created.

build

public SearchTimeline build()

Builds a SearchTimeline from the Builder parameters.

Returns:

a SearchTimeline.

Throws:

IllegalStateException - if query is not set (is null).