Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

twitter4j.api
Interface TimelineMethods

All Known Subinterfaces:
Twitter
All Known Implementing Classes:
TwitterImpl
public interface TimelineMethods

Author:
Joern Huxhorn - jhuxhorn at googlemail.com

Method Summary
 ResponseList<Status> getFriendsTimeline()
          Returns the 20 most recent statuses posted by the authenticating user and that user's friends.
 ResponseList<Status> getFriendsTimeline(Paging paging)
          Returns the 20 most recent statuses posted by the authenticating user and that user's friends.
 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> getRetweetedByUser(long userId, Paging paging)
          Returns the 20 most recent retweets posted by the specified user.
 ResponseList<Status> getRetweetedByUser(java.lang.String screenName, Paging paging)
          Returns the 20 most recent retweets posted by the specified 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> getRetweetedToUser(long userId, Paging paging)
          Returns the 20 most recent retweets posted by users the specified user follows.
 ResponseList<Status> getRetweetedToUser(java.lang.String screenName, Paging paging)
          Returns the 20 most recent retweets posted by users the specified user follows.
 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 20 most recent statuses posted from the authenticating user.
 ResponseList<Status> getUserTimeline(long userId)
          Returns the 20 most recent statuses posted from the authenticating user.
 ResponseList<Status> getUserTimeline(long userId, Paging paging)
          Returns the 20 most recent statuses posted from the authenticating user.
 ResponseList<Status> getUserTimeline(Paging paging)
          Returns the 20 most recent statuses posted from the authenticating user.
 ResponseList<Status> getUserTimeline(java.lang.String screenName)
          Returns the 20 most recent statuses posted from the authenticating user.
 ResponseList<Status> getUserTimeline(java.lang.String screenName, Paging paging)
          Returns the 20 most recent statuses posted from the authenticating user.
 

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 and requesting it more often than that is unproductive and 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:
GET statuses/public_timeline | dev.twitter.com

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.
Usage note: This home_timeline call is identical to statuses/friends_timeline, except that home_timeline also contains retweets, while statuses/friends_timeline does not for backwards compatibility reasons. In a future version of the API, statuses/friends_timeline will be deprected and replaced by home_timeline.
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:
GET statuses/home_timeline | dev.twitter.com

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.
Usage note: This home_timeline call is identical to statuses/friends_timeline, except that home_timeline also contains retweets, while statuses/friends_timeline does not for backwards compatibility reasons. In a future version of the API, statuses/friends_timeline will be deprected and replaced by home_timeline.
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:
GET statuses/home_timeline | dev.twitter.com

getFriendsTimeline

ResponseList<Status> getFriendsTimeline()
                                        throws TwitterException
Returns the 20 most recent statuses 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/friends_timeline

Returns:
list of the Friends Timeline
Throws:
TwitterException - when Twitter service or network is unavailable
See Also:
GET statuses/friends_timeline | dev.twitter.com

getFriendsTimeline

ResponseList<Status> getFriendsTimeline(Paging paging)
                                        throws TwitterException
Returns the 20 most recent statuses 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/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:
GET statuses/friends_timeline | dev.twitter.com

getUserTimeline

ResponseList<Status> getUserTimeline(java.lang.String screenName,
                                     Paging paging)
                                     throws TwitterException
Returns the 20 most recent statuses posted from the authenticating user. It's also possible to request another user's timeline via the id parameter.
This is the equivalent of the Web / page for your own user, or the profile page for a third party.
For backwards compatibility reasons, retweets are stripped out of the user_timeline when calling in XML or JSON (they appear with 'RT' in RSS and Atom). If you'd like them included, you can merge them in from statuses retweeted_by_me.

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:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

ResponseList<Status> getUserTimeline(long userId,
                                     Paging paging)
                                     throws TwitterException
Returns the 20 most recent statuses posted from the authenticating user. It's also possible to request another user's timeline via the id parameter.
This is the equivalent of the Web / page for your own user, or the profile page for a third party.
For backwards compatibility reasons, retweets are stripped out of the user_timeline when calling in XML or JSON (they appear with 'RT' in RSS and Atom). If you'd like them included, you can merge them in from statuses retweeted_by_me.

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:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

ResponseList<Status> getUserTimeline(java.lang.String screenName)
                                     throws TwitterException
Returns the 20 most recent statuses posted from the authenticating user. It's also possible to request another user's timeline via the id parameter.
This is the equivalent of the Web / page for your own user, or the profile page for a third party.
For backwards compatibility reasons, retweets are stripped out of the user_timeline when calling in XML or JSON (they appear with 'RT' in RSS and Atom). If you'd like them included, you can merge them in from statuses retweeted_by_me.

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:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

ResponseList<Status> getUserTimeline(long userId)
                                     throws TwitterException
Returns the 20 most recent statuses posted from the authenticating user. It's also possible to request another user's timeline via the id parameter.
This is the equivalent of the Web / page for your own user, or the profile page for a third party.
For backwards compatibility reasons, retweets are stripped out of the user_timeline when calling in XML or JSON (they appear with 'RT' in RSS and Atom). If you'd like them included, you can merge them in from statuses retweeted_by_me.

This method calls http://api.twitter.com/1/statuses/user_timeline

Parameters:
userId - 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:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

ResponseList<Status> getUserTimeline()
                                     throws TwitterException
Returns the 20 most recent statuses posted from the authenticating user. It's also possible to request another user's timeline via the id parameter.
This is the equivalent of the Web / page for your own user, or the profile page for a third party.
For backwards compatibility reasons, retweets are stripped out of the user_timeline when calling in XML or JSON (they appear with 'RT' in RSS and Atom). If you'd like them included, you can merge them in from statuses retweeted_by_me.

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:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

ResponseList<Status> getUserTimeline(Paging paging)
                                     throws TwitterException
Returns the 20 most recent statuses posted from the authenticating user. It's also possible to request another user's timeline via the id parameter.
This is the equivalent of the Web / page for your own user, or the profile page for a third party.
For backwards compatibility reasons, retweets are stripped out of the user_timeline when calling in XML or JSON (they appear with 'RT' in RSS and Atom). If you'd like them included, you can merge them in from statuses retweeted_by_me.

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:
GET statuses/user_timeline | dev.twitter.com

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:
GET statuses/mentions | dev.twitter.com

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:
GET statuses/mentions | dev.twitter.com

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:
GET statuses/retweeted_by_me | dev.twitter.com

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:
GET statuses/retweeted_by_me | dev.twitter.com

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:
GET statuses/retweeted_to_me | dev.twitter.com

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:
GET statuses/retweeted_to_me | dev.twitter.com

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:
GET statuses/retweets_of_me | dev.twitter.com

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:
GET statuses/retweets_of_me | dev.twitter.com

getRetweetedToUser

ResponseList<Status> getRetweetedToUser(java.lang.String screenName,
                                        Paging paging)
                                        throws TwitterException
Returns the 20 most recent retweets posted by users the specified user follows. This method is identical to statuses/retweeted_to_me except you can choose the user to view.
This method has not been finalized and the interface is subject to change in incompatible ways.
This method calls http://api.twitter.com/1/statuses/retweeted_to_user

Parameters:
screenName - the user to view
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.1.9
See Also:
#newtwitter and the API - Twitter API Announcements | Google Group

getRetweetedToUser

ResponseList<Status> getRetweetedToUser(long userId,
                                        Paging paging)
                                        throws TwitterException
Returns the 20 most recent retweets posted by users the specified user follows. This method is identical to statuses/retweeted_to_me except you can choose the user to view.
This method has not been finalized and the interface is subject to change in incompatible ways.
This method calls http://api.twitter.com/1/statuses/retweeted_to_user

Parameters:
userId - the user to view
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.1.9
See Also:
#newtwitter and the API - Twitter API Announcements | Google Group

getRetweetedByUser

ResponseList<Status> getRetweetedByUser(java.lang.String screenName,
                                        Paging paging)
                                        throws TwitterException
Returns the 20 most recent retweets posted by the specified user. This method is identical to statuses/retweeted_by_me except you can choose the user to view.
This method has not been finalized and the interface is subject to change in incompatible ways.
This method calls http://api.twitter.com/1/statuses/retweeted_by_user

Parameters:
screenName - the user to view
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:
#newtwitter and the API - Twitter API Announcements | Google Group

getRetweetedByUser

ResponseList<Status> getRetweetedByUser(long userId,
                                        Paging paging)
                                        throws TwitterException
Returns the 20 most recent retweets posted by the specified user. This method is identical to statuses/retweeted_by_me except you can choose the user to view.
This method has not been finalized and the interface is subject to change in incompatible ways.
This method calls http://api.twitter.com/1/statuses/retweeted_by_user

Parameters:
userId - the user to view
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:
#newtwitter and the API - Twitter API Announcements | Google Group
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD