com.twitter.sdk.android.tweetui

Class TwitterListTimeline.Builder

Object

com.twitter.sdk.android.tweetui.TwitterListTimeline.Builder

Enclosing class:

TwitterListTimeline

public static class TwitterListTimeline.Builder
extends Object

TwitterListTimeline Builder.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a Builder.

Method Summary

Modifier and Type	Method and Description
TwitterListTimeline	build() Builds a TwitterListTimeline from the Builder parameters.
TwitterListTimeline.Builder	id(Long id) Sets the id for the Twitter List to get Tweets from.
TwitterListTimeline.Builder	includeRetweets(Boolean includeRetweets) Sets whether to includeRetweets for the TwitterListTimeline.
TwitterListTimeline.Builder	maxItemsPerRequest(Integer maxItemsPerRequest) Sets the number of Tweets returned per request for the TwitterListTimeline.
TwitterListTimeline.Builder	slugWithOwnerId(String slug, Long ownerId) Sets the List slug name and owner id for the TwitterListTimeline.
TwitterListTimeline.Builder	slugWithOwnerScreenName(String slug, String ownerScreenName) Sets the slug name and owner screen name for the TwitterListTimeline.

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

id

public TwitterListTimeline.Builder id(Long id)

Sets the id for the Twitter List to get Tweets from.

Parameters:

id - The ID of the Tweet list to get Tweets from.

slugWithOwnerId

public TwitterListTimeline.Builder slugWithOwnerId(String slug,
                                                   Long ownerId)

Sets the List slug name and owner id for the TwitterListTimeline.

Parameters:

slug - The list slug name (e.g. 'textile-engineers').

ownerId - The list owner Twitter user id.

slugWithOwnerScreenName

public TwitterListTimeline.Builder slugWithOwnerScreenName(String slug,
                                                           String ownerScreenName)

Sets the slug name and owner screen name for the TwitterListTimeline.

Parameters:

slug - The list slug name (e.g. "textile-engineers").

ownerScreenName - The list owner screen name (e.g. "twitterdev").

maxItemsPerRequest

public TwitterListTimeline.Builder maxItemsPerRequest(Integer maxItemsPerRequest)

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

Parameters:

maxItemsPerRequest - The number of tweets to return per request.

includeRetweets

public TwitterListTimeline.Builder includeRetweets(Boolean includeRetweets)

Sets whether to includeRetweets for the TwitterListTimeline. Defaults to true.

Parameters:

includeRetweets - When set to false, the timeline will strip any native retweets (though they will still count toward both the maximal length of the timeline and the slice selected by the count parameter).

build

public TwitterListTimeline build()

Builds a TwitterListTimeline from the Builder parameters.

Returns:

a TwitterListTimeline.

Throws:

IllegalStateException - if id or slug/owner pair is not set.