twitter4j.api
Interface TimelineMethods

All Known Implementing Classes:

Twitter

public interface TimelineMethods

Author:

Joern Huxhorn - jhuxhorn at googlemail.com

Method Summary

ResponseList<Status>	getFriendsTimeline() Returns the 20 most recent statuses posted in the last 24 hours from the authenticating1 user and that user's friends.
ResponseList<Status>	getFriendsTimeline(Paging paging) Returns the 20 most recent statuses posted in the last 24 hours from the specified userid.
ResponseList<Status>	getHomeTimeline() Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends.
ResponseList<Status>	getHomeTimeline(Paging paging) Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends.
ResponseList<Status>	getMentions() Returns the 20 most recent mentions (status containing @username) for the authenticating user.
ResponseList<Status>	getMentions(Paging paging) Returns the 20 most recent mentions (status containing @username) for the authenticating user.
ResponseList<Status>	getPublicTimeline() Returns the 20 most recent statuses from non-protected users who have set a custom user icon.
ResponseList<Status>	getRetweetedByMe() Returns the 20 most recent retweets posted by the authenticating user.
ResponseList<Status>	getRetweetedByMe(Paging paging) Returns the 20 most recent retweets posted by the authenticating user.
ResponseList<Status>	getRetweetedToMe() Returns the 20 most recent retweets posted by the authenticating user's friends.
ResponseList<Status>	getRetweetedToMe(Paging paging) Returns the 20 most recent retweets posted by the authenticating user's friends.
ResponseList<Status>	getRetweetsOfMe() Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.
ResponseList<Status>	getRetweetsOfMe(Paging paging) Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.
ResponseList<Status>	getUserTimeline() Returns the most recent statuses posted in the last 24 hours from the authenticating user.
ResponseList<Status>	getUserTimeline(int user_id) Returns the most recent statuses posted in the last 24 hours from the specified userid.
ResponseList<Status>	getUserTimeline(int userId, Paging paging) Returns the most recent statuses posted in the last 24 hours from the specified screen name.
ResponseList<Status>	getUserTimeline(Paging paging) Returns the most recent statuses posted in the last 24 hours from the authenticating user.
ResponseList<Status>	getUserTimeline(java.lang.String screenName) Returns the most recent statuses posted in the last 24 hours from the specified userid.
ResponseList<Status>	getUserTimeline(java.lang.String screenName, Paging paging) Returns the most recent statuses posted in the last 24 hours from the specified screen name.

Method Detail

getPublicTimeline

ResponseList<Status> getPublicTimeline()
                                       throws TwitterException

Returns the 20 most recent statuses from non-protected users who have set a custom user icon. The public timeline is cached for 60 seconds so requesting it more often than that is a waste of resources.
This method calls http://api.twitter.com/1/statuses/public_timeline

Returns:

list of statuses of the Public Timeline

Throws:

TwitterException - when Twitter service or network is unavailable

See Also:

Twitter API Wiki / Twitter REST API Method: statuses public_timeline

getHomeTimeline

ResponseList<Status> getHomeTimeline()
                                     throws TwitterException

Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends. This is the equivalent of /timeline/home on the Web.
This method calls http://api.twitter.com/1/statuses/home_timeline

Returns:

list of the home Timeline

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

Twitter API Wiki / Twitter REST API Method: statuses home_timeline

getHomeTimeline

ResponseList<Status> getHomeTimeline(Paging paging)
                                     throws TwitterException

Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends. This is the equivalent of /timeline/home on the Web.
This method calls http://api.twitter.com/1/statuses/home_timeline

Parameters:

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Returns:

list of the home Timeline

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

Twitter API Wiki / Twitter REST API Method: statuses home_timeline

getFriendsTimeline

ResponseList<Status> getFriendsTimeline()
                                        throws TwitterException

Returns the 20 most recent statuses posted in the last 24 hours from the authenticating1 user and that user's friends. It's also possible to request another user's friends_timeline via the id parameter below.
Note: Retweets will not appear in the friends_timeline for backwards compatibility. If you want retweets included use getHomeTimeline().
This method calls http://api.twitter.com/1/statuses/friends_timeline

Returns:

list of the Friends Timeline

Throws:

TwitterException - when Twitter service or network is unavailable

See Also:

Twitter API Wiki / Twitter REST API Method: statuses friends_timeline

getFriendsTimeline

ResponseList<Status> getFriendsTimeline(Paging paging)
                                        throws TwitterException

Returns the 20 most recent statuses posted in the last 24 hours from the specified userid.
This method calls http://api.twitter.com/1/statuses/friends_timeline

Parameters:

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Returns:

list of the Friends Timeline

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.1

See Also:

Twitter API Wiki / Twitter REST API Method: statuses friends_timeline

getUserTimeline

ResponseList<Status> getUserTimeline(java.lang.String screenName,
                                     Paging paging)
                                     throws TwitterException

Returns the most recent statuses posted in the last 24 hours from the specified screen name.
This method calls http://api.twitter.com/1/statuses/user_timeline.json

Parameters:

screenName - specifies the screen name of the user for whom to return the user_timeline

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Returns:

list of the user Timeline

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.1

See Also:

Twitter API Wiki / Twitter REST API Method: statuses friends_timeline

getUserTimeline

ResponseList<Status> getUserTimeline(int userId,
                                     Paging paging)
                                     throws TwitterException

Returns the most recent statuses posted in the last 24 hours from the specified screen name.
This method calls http://api.twitter.com/1/statuses/user_timeline.json

Parameters:

userId - specifies the ID of the user for whom to return the user_timeline

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Returns:

list of the user Timeline

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.1.0

See Also:

Twitter API Wiki / Twitter REST API Method: statuses friends_timeline

getUserTimeline

ResponseList<Status> getUserTimeline(java.lang.String screenName)
                                     throws TwitterException

Returns the most recent statuses posted in the last 24 hours from the specified userid.
This method calls http://api.twitter.com/1/statuses/user_timeline

Parameters:

screenName - specifies the screen name of the user for whom to return the user_timeline

Returns:

the 20 most recent statuses posted in the last 24 hours from the user

Throws:

TwitterException - when Twitter service or network is unavailable

See Also:

Twitter API Wiki / Twitter REST API Method: statuses friends_timeline

getUserTimeline

ResponseList<Status> getUserTimeline(int user_id)
                                     throws TwitterException

Returns the most recent statuses posted in the last 24 hours from the specified userid.
This method calls http://api.twitter.com/1/statuses/user_timeline

Parameters:

user_id - specifies the ID of the user for whom to return the user_timeline

Returns:

the 20 most recent statuses posted in the last 24 hours from the user

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.1.0

See Also:

Twitter API Wiki / Twitter REST API Method: statuses friends_timeline

getUserTimeline

ResponseList<Status> getUserTimeline()
                                     throws TwitterException

Returns the most recent statuses posted in the last 24 hours from the authenticating user.
This method calls http://api.twitter.com/1/statuses/user_timeline

Returns:

the 20 most recent statuses posted in the last 24 hours from the user

Throws:

TwitterException - when Twitter service or network is unavailable

See Also:

Twitter API Wiki / Twitter REST API Method: statuses friends_timeline

getUserTimeline

ResponseList<Status> getUserTimeline(Paging paging)
                                     throws TwitterException

Returns the most recent statuses posted in the last 24 hours from the authenticating user.
This method calls http://api.twitter.com/1/statuses/user_timeline

Parameters:

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Returns:

the 20 most recent statuses posted in the last 24 hours from the user

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.1

See Also:

Twitter API Wiki / Twitter REST API Method: statuses friends_timeline

getMentions

ResponseList<Status> getMentions()
                                 throws TwitterException

Returns the 20 most recent mentions (status containing @username) for the authenticating user.
This method calls http://api.twitter.com/1/statuses/mentions

Returns:

the 20 most recent replies

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.1

See Also:

Twitter API Wiki / Twitter REST API Method: statuses mentions

getMentions

ResponseList<Status> getMentions(Paging paging)
                                 throws TwitterException

Returns the 20 most recent mentions (status containing @username) for the authenticating user.
This method calls http://api.twitter.com/1/statuses/mentions

Parameters:

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Returns:

the 20 most recent replies

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.1

See Also:

Twitter API Wiki / Twitter REST API Method: statuses mentions

getRetweetedByMe

ResponseList<Status> getRetweetedByMe()
                                      throws TwitterException

Returns the 20 most recent retweets posted by the authenticating user.
This method calls http://api.twitter.com/1/statuses/retweeted_by_me

Returns:

the 20 most recent retweets posted by the authenticating user

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

Twitter API Wiki / Twitter REST API Method: statuses/retweeted_by_me

getRetweetedByMe

ResponseList<Status> getRetweetedByMe(Paging paging)
                                      throws TwitterException

Returns the 20 most recent retweets posted by the authenticating user.
This method calls http://api.twitter.com/1/statuses/retweeted_by_me

Parameters:

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Returns:

the 20 most recent retweets posted by the authenticating user

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

Twitter API Wiki / Twitter REST API Method: statuses/retweeted_by_me

getRetweetedToMe

ResponseList<Status> getRetweetedToMe()
                                      throws TwitterException

Returns the 20 most recent retweets posted by the authenticating user's friends.
This method calls http://api.twitter.com/1/statuses/retweeted_to_me

Returns:

the 20 most recent retweets posted by the authenticating user's friends.

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

Twitter API Wiki / Twitter REST API Method: statuses/retweeted_to_me

getRetweetedToMe

ResponseList<Status> getRetweetedToMe(Paging paging)
                                      throws TwitterException

Returns the 20 most recent retweets posted by the authenticating user's friends.
This method calls http://api.twitter.com/1/statuses/retweeted_to_me

Parameters:

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Returns:

the 20 most recent retweets posted by the authenticating user's friends.

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

Twitter API Wiki / Twitter REST API Method: statuses/retweeted_to_me

getRetweetsOfMe

ResponseList<Status> getRetweetsOfMe()
                                     throws TwitterException

Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.
This method calls http://api.twitter.com/1/statuses/retweets_of_me

Returns:

the 20 most recent tweets of the authenticated user that have been retweeted by others.

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

Twitter API Wiki / Twitter REST API Method: statuses/retweets_of_me

getRetweetsOfMe

ResponseList<Status> getRetweetsOfMe(Paging paging)
                                     throws TwitterException

Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.
This method calls http://api.twitter.com/1/statuses/retweets_of_me

Parameters:

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Returns:

the 20 most recent tweets of the authenticated user that have been retweeted by others.

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

Twitter API Wiki / Twitter REST API Method: statuses/retweets_of_me