twitter4j.api
Interface TimelineMethodsAsync

All Known Subinterfaces:
AsyncTwitter
All Known Implementing Classes:
AsyncTwitterImpl

public interface TimelineMethodsAsync

Author:
Joern Huxhorn - jhuxhorn at googlemail.com

Method Summary
 void getFriendsTimeline()
          Returns the 20 most recent statuses posted by the authenticating user and that user's friends.
 void getFriendsTimeline(Paging paging)
          Returns the 20 most recent statuses posted by the authenticating user and that user's friends.
 void getHomeTimeline()
          Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends.
 void getHomeTimeline(Paging paging)
          Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends.
 void getMentions()
          Returns the 20 most recent replies (status updates prefixed with @username) to the authenticating user.
 void getMentions(Paging paging)
          Returns the 20 most recent replies (status updates prefixed with @username) to the authenticating user.
 void getPublicTimeline()
          Returns the 20 most recent statuses from non-protected users who have set a custom user icon.
 void getRetweetedByMe()
          Returns the 20 most recent retweets posted by the authenticating user.
 void getRetweetedByMe(Paging paging)
          Returns the 20 most recent retweets posted by the authenticating user.
 void getRetweetedByUser(long userId, Paging paging)
          Returns the 20 most recent retweets posted by the specified user.
 void getRetweetedByUser(java.lang.String screenName, Paging paging)
          Returns the 20 most recent retweets posted by the specified user.
 void getRetweetedToMe()
          Returns the 20 most recent retweets posted by the authenticating user's friends.
 void getRetweetedToMe(Paging paging)
          Returns the 20 most recent retweets posted by the authenticating user's friends.
 void getRetweetedToUser(long userId, Paging paging)
          Returns the 20 most recent retweets posted by users the specified user follows.
 void getRetweetedToUser(java.lang.String screenName, Paging paging)
          Returns the 20 most recent retweets posted by users the specified user follows.
 void getRetweetsOfMe()
          Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.
 void getRetweetsOfMe(Paging paging)
          Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.
 void getUserTimeline()
          Returns the 20 most recent statuses posted from the authenticating user.
 void getUserTimeline(long userId)
          Returns the 20 most recent statuses posted from the authenticating user.
 void getUserTimeline(long userId, Paging paging)
          Returns the 20 most recent statuses posted from the authenticating user.
 void getUserTimeline(Paging paging)
          Returns the 20 most recent statuses posted from the authenticating user.
 void getUserTimeline(java.lang.String screenName)
          Returns the 20 most recent statuses posted from the authenticating user.
 void getUserTimeline(java.lang.String screenName, Paging paging)
          Returns the 20 most recent statuses posted from the authenticating user.
 

Method Detail

getPublicTimeline

void getPublicTimeline()
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

See Also:
GET statuses/public_timeline | dev.twitter.com

getHomeTimeline

void getHomeTimeline()
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

Since:
Twitter4J 2.0.10
See Also:
GET statuses/home_timeline | dev.twitter.com

getHomeTimeline

void getHomeTimeline(Paging paging)
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
Since:
Twitter4J 2.0.10
See Also:
GET statuses/home_timeline | dev.twitter.com

getFriendsTimeline

void getFriendsTimeline()
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.

See Also:
GET statuses/friends_timeline | dev.twitter.com

getFriendsTimeline

void getFriendsTimeline(Paging paging)
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
Since:
Twitter4J 2.0.1
See Also:
GET statuses/friends_timeline | dev.twitter.com

getUserTimeline

void getUserTimeline(java.lang.String screenName,
                     Paging paging)
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.
paging - controls pagination
Since:
Twitter4J 2.0.1
See Also:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

void getUserTimeline(long userId,
                     Paging paging)
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.
paging - controls pagination
Since:
Twitter4J 2.1.0
See Also:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

void getUserTimeline(Paging paging)
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
Since:
Twitter4J 2.0.1
See Also:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

void getUserTimeline(java.lang.String screenName)
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.
See Also:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

void getUserTimeline(long userId)
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.
Since:
Twitter4J 2.1.0
See Also:
GET statuses/user_timeline | dev.twitter.com

getUserTimeline

void getUserTimeline()
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

See Also:
GET statuses/user_timeline | dev.twitter.com

getMentions

void getMentions()
Returns the 20 most recent replies (status updates prefixed with @username) to the authenticating user. Replies are only available to the authenticating user; you can not request a list of replies to another user whether public or protected.
This method calls http://api.twitter.com/1/statuses/mentions

Since:
Twitter4J 2.0.1
See Also:
GET statuses/mentions | dev.twitter.com

getMentions

void getMentions(Paging paging)
Returns the 20 most recent replies (status updates prefixed with @username) to the authenticating user. Replies are only available to the authenticating user; you can not request a list of replies to another user whether public or protected.
This method calls http://api.twitter.com/1/statuses/mentions

Parameters:
paging - controls pagination
Since:
Twitter4J 2.0.1
See Also:
GET statuses/mentions | dev.twitter.com

getRetweetedByMe

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

Since:
Twitter4J 2.0.10
See Also:
GET statuses/retweeted_by_me | dev.twitter.com

getRetweetedByMe

void getRetweetedByMe(Paging paging)
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
Since:
Twitter4J 2.0.10
See Also:
GET statuses/retweeted_by_me | dev.twitter.com

getRetweetedToMe

void getRetweetedToMe()
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

Since:
Twitter4J 2.0.10
See Also:
GET statuses/retweeted_to_me | dev.twitter.com

getRetweetedToMe

void getRetweetedToMe(Paging paging)
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
Since:
Twitter4J 2.0.10
See Also:
GET statuses/retweeted_to_me | dev.twitter.com

getRetweetsOfMe

void getRetweetsOfMe()
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

Since:
Twitter4J 2.0.10
See Also:
GET statuses/retweets_of_me | dev.twitter.com

getRetweetsOfMe

void getRetweetsOfMe(Paging paging)
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
Since:
Twitter4J 2.0.10
See Also:
GET statuses/retweets_of_me | dev.twitter.com

getRetweetedToUser

void getRetweetedToUser(java.lang.String screenName,
                        Paging paging)
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.
Since:
Twitter4J 2.1.9
See Also:
#newtwitter and the API - Twitter API Announcements | Google Group

getRetweetedToUser

void getRetweetedToUser(long userId,
                        Paging paging)
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.
Since:
Twitter4J 2.1.9
See Also:
#newtwitter and the API - Twitter API Announcements | Google Group

getRetweetedByUser

void getRetweetedByUser(java.lang.String screenName,
                        Paging paging)
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.
Since:
Twitter4J 2.0.10
See Also:
#newtwitter and the API - Twitter API Announcements | Google Group

getRetweetedByUser

void getRetweetedByUser(long userId,
                        Paging paging)
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.
Since:
Twitter4J 2.0.10
See Also:
#newtwitter and the API - Twitter API Announcements | Google Group