org.agorava.twitter

Interface TwitterTimelineService

public interface TwitterTimelineService

Interface defining the operations for sending and retrieving tweets.

Author:

Craig Walls, Antoine Sabot-Durand

Method Summary

Methods

Modifier and Type	Method and Description
void	addToFavorites(long id) Adds a tweet to the user's collection of favorite tweets.
void	deleteStatus(long tweetId) Removes a status entry.
List<Tweet>	getFavorites() Retrieves the 20 most recent tweets favorited by the authenticated user.
List<Tweet>	getFavorites(int page, int pageSize) Retrieves tweets favorited by the authenticated user.
List<Tweet>	getHomeTimeline() Retrieves the 20 most recently posted tweets, including retweets, from the authenticating user's home timeline.
List<Tweet>	getHomeTimeline(int page, int pageSize) Retrieves tweets, including retweets, from the authenticating user's home timeline.
List<Tweet>	getHomeTimeline(int page, int pageSize, long sinceId, long maxId) Retrieves tweets, including retweets, from the authenticating user's home timeline.
List<Tweet>	getMentions() Retrieve the 20 most recent tweets that mention the authenticated user.
List<Tweet>	getMentions(int page, int pageSize) Retrieve tweets that mention the authenticated user.
List<Tweet>	getMentions(int page, int pageSize, long sinceId, long maxId) Retrieve tweets that mention the authenticated user.
List<Tweet>	getPublicTimeline() Retrieves the 20 most recently posted tweets from the public timeline.
List<TwitterProfile>	getRetweetedBy(long id) Retrieves the profiles of up to 100 users how have retweeted a specific tweet.
List<TwitterProfile>	getRetweetedBy(long tweetId, int page, int pageSize) Retrieves the profiles of users how have retweeted a specific tweet.
List<Long>	getRetweetedByIds(long tweetId) Retrieves the IDs of up to 100 users who have retweeted a specific tweet.
List<Long>	getRetweetedByIds(long tweetId, int page, int pageSize) Retrieves the IDs of users who have retweeted a specific tweet.
List<Tweet>	getRetweetedByMe() Retrieve the 20 most recent retweets posted by the authenticated user.
List<Tweet>	getRetweetedByMe(int page, int pageSize) Retrieve retweets posted by the authenticated user.
List<Tweet>	getRetweetedByMe(int page, int pageSize, long sinceId, long maxId) Retrieve retweets posted by the authenticated user.
List<Tweet>	getRetweetedByUser(long userId) Retrieve the 20 most recent retweets posted by the specified user.
List<Tweet>	getRetweetedByUser(long userId, int page, int pageSize) Retrieve retweets posted by the specified user.
List<Tweet>	getRetweetedByUser(long userId, int page, int pageSize, long sinceId, long maxId) Retrieve retweets posted by the specified user.
List<Tweet>	getRetweetedByUser(String screenName) Retrieve the 20 most recent retweets posted by the specified user.
List<Tweet>	getRetweetedByUser(String screenName, int page, int pageSize) Retrieve retweets posted by the specified user.
List<Tweet>	getRetweetedByUser(String screenName, int page, int pageSize, long sinceId, long maxId) Retrieve retweets posted by the specified user.
List<Tweet>	getRetweetedToMe() Retrieve the 20 most recent retweets posted by users the authenticating user follow.
List<Tweet>	getRetweetedToMe(int page, int pageSize) Retrieve retweets posted by users the authenticating user follow.
List<Tweet>	getRetweetedToMe(int page, int pageSize, long sinceId, long maxId) Retrieve retweets posted by users the authenticating user follow.
List<Tweet>	getRetweetedToUser(long userId) Retrieve the 20 most recent retweets posted by users that the specified user follows.
List<Tweet>	getRetweetedToUser(long userId, int page, int pageSize) Retrieve retweets posted by users that the specified user follows.
List<Tweet>	getRetweetedToUser(long userId, int page, int pageSize, long sinceId, long maxId) Retrieve retweets posted by users that the specified user follows.
List<Tweet>	getRetweetedToUser(String screenName) Retrieve the 20 most recent retweets by users that the specified user follows.
List<Tweet>	getRetweetedToUser(String screenName, int page, int pageSize) Retrieve retweets by users that the specified user follows.
List<Tweet>	getRetweetedToUser(String screenName, int page, int pageSize, long sinceId, long maxId) Retrieve retweets by users that the specified user follows.
List<Tweet>	getRetweets(long tweetId) Retrieves up to 100 retweets of a specific tweet.
List<Tweet>	getRetweets(long tweetId, int count) Retrieves retweets of a specific tweet.
List<Tweet>	getRetweetsOfMe() Retrieve the 20 most recent tweets of the authenticated user that have been retweeted by others.
List<Tweet>	getRetweetsOfMe(int page, int pageSize) Retrieve tweets of the authenticated user that have been retweeted by others.
List<Tweet>	getRetweetsOfMe(int page, int pageSize, long sinceId, long maxId) Retrieve tweets of the authenticated user that have been retweeted by others.
Tweet	getStatus(long tweetId) Returns a single tweet.
List<Tweet>	getUserTimeline() Retrieves the 20 most recent tweets posted by the authenticating user.
List<Tweet>	getUserTimeline(int page, int pageSize) Retrieves tweets posted by the authenticating user.
List<Tweet>	getUserTimeline(int page, int pageSize, long sinceId, long maxId) Retrieves tweets posted by the authenticating user.
List<Tweet>	getUserTimeline(long userId) Retrieves the 20 most recent tweets posted by the given user.
List<Tweet>	getUserTimeline(long userId, int page, int pageSize) Retrieves tweets posted by the given user.
List<Tweet>	getUserTimeline(long userId, int page, int pageSize, long sinceId, long maxId) Retrieves tweets posted by the given user.
List<Tweet>	getUserTimeline(String screenName) Retrieves the 20 most recent tweets posted by the given user.
List<Tweet>	getUserTimeline(String screenName, int page, int pageSize) Retrieves tweets posted by the given user.
List<Tweet>	getUserTimeline(String screenName, int page, int pageSize, long sinceId, long maxId) Retrieves tweets posted by the given user.
void	removeFromFavorites(long id) Removes a tweet from the user's collection of favorite tweets.
void	retweet(long tweetId) Posts a retweet of an existing tweet.
Tweet	updateStatus(String status) Updates the user's status.

Method Detail

getPublicTimeline

List<Tweet> getPublicTimeline()

Retrieves the 20 most recently posted tweets from the public timeline. The public timeline is the timeline containing tweets from all Twitter users. As this is the public timeline, authentication is not required to use this method.

Note that Twitter caches public timeline results for 60 seconds. Calling this method more frequently than that will count against rate limits and will not return any new results.

Returns:

a collection of Tweets in the public timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

getHomeTimeline

List<Tweet> getHomeTimeline()

Retrieves the 20 most recently posted tweets, including retweets, from the authenticating user's home timeline. The home timeline includes tweets from the user's timeline and the timeline of anyone that they follow.

Returns:

a collection of Tweets in the authenticating user's home timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getHomeTimeline

List<Tweet> getHomeTimeline(int page,
                          int pageSize)

Retrieves tweets, including retweets, from the authenticating user's home timeline. The home timeline includes tweets from the user's timeline and the timeline of anyone that they follow.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

Returns:

a collection of Tweets in the authenticating user's home timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getHomeTimeline

List<Tweet> getHomeTimeline(int page,
                          int pageSize,
                          long sinceId,
                          long maxId)

Retrieves tweets, including retweets, from the authenticating user's home timeline. The home timeline includes tweets from the user's timeline and the timeline of anyone that they follow.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Returns:

a collection of Tweets in the authenticating user's home timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getUserTimeline

List<Tweet> getUserTimeline()

Retrieves the 20 most recent tweets posted by the authenticating user.

Returns:

a collection of Tweets that have been posted by the authenticating user.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getUserTimeline

List<Tweet> getUserTimeline(int page,
                          int pageSize)

Retrieves tweets posted by the authenticating user. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

Returns:

a collection of Tweets that have been posted by the authenticating user.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getUserTimeline

List<Tweet> getUserTimeline(int page,
                          int pageSize,
                          long sinceId,
                          long maxId)

Retrieves tweets posted by the authenticating user. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Returns:

a collection of Tweets that have been posted by the authenticating user.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getUserTimeline

List<Tweet> getUserTimeline(String screenName)

Retrieves the 20 most recent tweets posted by the given user.

Parameters:

screenName - The screen name of the user whose timeline is being requested.

Returns:

a collection of Tweets from the specified user's timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

getUserTimeline

List<Tweet> getUserTimeline(String screenName,
                          int page,
                          int pageSize)

Retrieves tweets posted by the given user. The most recent tweets are listed first.

Parameters:

screenName - The screen name of the user whose timeline is being requested.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

Returns:

a collection of Tweets from the specified user's timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

getUserTimeline

List<Tweet> getUserTimeline(String screenName,
                          int page,
                          int pageSize,
                          long sinceId,
                          long maxId)

Retrieves tweets posted by the given user. The most recent tweets are listed first.

Parameters:

screenName - The screen name of the user whose timeline is being requested.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Returns:

a collection of Tweets from the specified user's timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

getUserTimeline

List<Tweet> getUserTimeline(long userId)

Retrieves the 20 most recent tweets posted by the given user.

Parameters:

userId - The user ID of the user whose timeline is being requested.

Returns:

a collection of Tweets from the specified user's timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

getUserTimeline

List<Tweet> getUserTimeline(long userId,
                          int page,
                          int pageSize)

Retrieves tweets posted by the given user. The most recent tweets are listed first.

Parameters:

userId - The user ID of the user whose timeline is being requested.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

Returns:

a collection of Tweets from the specified user's timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

getUserTimeline

List<Tweet> getUserTimeline(long userId,
                          int page,
                          int pageSize,
                          long sinceId,
                          long maxId)

Retrieves tweets posted by the given user. The most recent tweets are listed first.

Parameters:

userId - The user ID of the user whose timeline is being requested.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Returns:

a collection of Tweets from the specified user's timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

getMentions

List<Tweet> getMentions()

Retrieve the 20 most recent tweets that mention the authenticated user.

Returns:

a collection of Tweet objects that mention the authenticated user.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getMentions

List<Tweet> getMentions(int page,
                      int pageSize)

Retrieve tweets that mention the authenticated user. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

Returns:

a collection of Tweet objects that mention the authenticated user.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getMentions

List<Tweet> getMentions(int page,
                      int pageSize,
                      long sinceId,
                      long maxId)

Retrieve tweets that mention the authenticated user. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 200. (Will return at most 200 entries, even if pageSize is greater than 200.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Returns:

a collection of Tweet objects that mention the authenticated user.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByMe

List<Tweet> getRetweetedByMe()

Retrieve the 20 most recent retweets posted by the authenticated user.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByMe

List<Tweet> getRetweetedByMe(int page,
                           int pageSize)

Retrieve retweets posted by the authenticated user. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByMe

List<Tweet> getRetweetedByMe(int page,
                           int pageSize,
                           long sinceId,
                           long maxId)

Retrieve retweets posted by the authenticated user. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByUser

List<Tweet> getRetweetedByUser(long userId)

Retrieve the 20 most recent retweets posted by the specified user.

Parameters:

userId - The user ID to get retweets for.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByUser

List<Tweet> getRetweetedByUser(long userId,
                             int page,
                             int pageSize)

Retrieve retweets posted by the specified user. The most recent tweets are listed first.

Parameters:

userId - The user ID to get retweets for.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByUser

List<Tweet> getRetweetedByUser(long userId,
                             int page,
                             int pageSize,
                             long sinceId,
                             long maxId)

Retrieve retweets posted by the specified user. The most recent tweets are listed first.

Parameters:

userId - The user ID to get retweets for.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByUser

List<Tweet> getRetweetedByUser(String screenName)

Retrieve the 20 most recent retweets posted by the specified user.

Parameters:

screenName - The screen name of the user to get retweets for.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByUser

List<Tweet> getRetweetedByUser(String screenName,
                             int page,
                             int pageSize)

Retrieve retweets posted by the specified user. The most recent tweets are listed first.

Parameters:

screenName - The screen name of the user to get retweets for.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByUser

List<Tweet> getRetweetedByUser(String screenName,
                             int page,
                             int pageSize,
                             long sinceId,
                             long maxId)

Retrieve retweets posted by the specified user. The most recent tweets are listed first.

Parameters:

screenName - The screen name of the user to get retweets for.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedToMe

List<Tweet> getRetweetedToMe()

Retrieve the 20 most recent retweets posted by users the authenticating user follow.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedToMe

List<Tweet> getRetweetedToMe(int page,
                           int pageSize)

Retrieve retweets posted by users the authenticating user follow. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedToMe

List<Tweet> getRetweetedToMe(int page,
                           int pageSize,
                           long sinceId,
                           long maxId)

Retrieve retweets posted by users the authenticating user follow. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedToUser

List<Tweet> getRetweetedToUser(long userId)

Retrieve the 20 most recent retweets posted by users that the specified user follows.

Parameters:

userId - The user ID to get retweets for.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedToUser

List<Tweet> getRetweetedToUser(long userId,
                             int page,
                             int pageSize)

Retrieve retweets posted by users that the specified user follows. The most recent tweets are listed first.

Parameters:

userId - The user ID to get retweets for.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedToUser

List<Tweet> getRetweetedToUser(long userId,
                             int page,
                             int pageSize,
                             long sinceId,
                             long maxId)

Retrieve retweets posted by users that the specified user follows. The most recent tweets are listed first.

Parameters:

userId - The user ID to get retweets for.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedToUser

List<Tweet> getRetweetedToUser(String screenName)

Retrieve the 20 most recent retweets by users that the specified user follows.

Parameters:

screenName - The screen name of the user to get retweets for.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedToUser

List<Tweet> getRetweetedToUser(String screenName,
                             int page,
                             int pageSize)

Retrieve retweets by users that the specified user follows. The most recent tweets are listed first.

Parameters:

screenName - The screen name of the user to get retweets for.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedToUser

List<Tweet> getRetweetedToUser(String screenName,
                             int page,
                             int pageSize,
                             long sinceId,
                             long maxId)

Retrieve retweets by users that the specified user follows. The most recent tweets are listed first.

Parameters:

screenName - The screen name of the user to get retweets for.

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetsOfMe

List<Tweet> getRetweetsOfMe()

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

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetsOfMe

List<Tweet> getRetweetsOfMe(int page,
                          int pageSize)

Retrieve tweets of the authenticated user that have been retweeted by others. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetsOfMe

List<Tweet> getRetweetsOfMe(int page,
                          int pageSize,
                          long sinceId,
                          long maxId)

Retrieve tweets of the authenticated user that have been retweeted by others. The most recent tweets are listed first.

Parameters:

page - The page to return

pageSize - The number of Tweets per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

sinceId - The minimum Tweet ID to return in the results

maxId - The maximum Tweet ID to return in the results

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getStatus

Tweet getStatus(long tweetId)

Returns a single tweet.

Parameters:

tweetId - the tweet's ID

Throws:

ApiException - if there is an error while communicating with Twitter.

updateStatus

Tweet updateStatus(String status)

Updates the user's status.

Parameters:

status - The status message

Throws:

ApiException - if there is an error while communicating with Twitter.

DuplicateTweetException - if the status message duplicates a previously posted status.

MessageTooLongException - if the length of the status message exceeds Twitter's 140 character limit.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

deleteStatus

void deleteStatus(long tweetId)

Removes a status entry.

Parameters:

tweetId - the tweet's ID

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

retweet

void retweet(long tweetId)

Posts a retweet of an existing tweet.

Parameters:

tweetId - The ID of the tweet to be retweeted

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweets

List<Tweet> getRetweets(long tweetId)

Retrieves up to 100 retweets of a specific tweet.

Parameters:

tweetId - the tweet's ID

Throws:

ApiException - if there is an error while communicating with Twitter.

getRetweets

List<Tweet> getRetweets(long tweetId,
                      int count)

Retrieves retweets of a specific tweet.

Parameters:

tweetId - the tweet's ID

count - The maximum number of retweets to return. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

getRetweetedBy

List<TwitterProfile> getRetweetedBy(long id)

Retrieves the profiles of up to 100 users how have retweeted a specific tweet.

Parameters:

id - the tweet's ID

Throws:

ApiException - if there is an error while communicating with Twitter.

getRetweetedBy

List<TwitterProfile> getRetweetedBy(long tweetId,
                                  int page,
                                  int pageSize)

Retrieves the profiles of users how have retweeted a specific tweet.

Parameters:

tweetId - the tweet's ID

page - The page to return

pageSize - The number of TwitterProfiles per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

getRetweetedByIds

List<Long> getRetweetedByIds(long tweetId)

Retrieves the IDs of up to 100 users who have retweeted a specific tweet.

Parameters:

tweetId - the tweet's ID.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getRetweetedByIds

List<Long> getRetweetedByIds(long tweetId,
                           int page,
                           int pageSize)

Retrieves the IDs of users who have retweeted a specific tweet.

Parameters:

tweetId - the tweet's ID.

page - The page to return

pageSize - The number of entries per page. Should be less than or equal to 100. (Will return at most 100 entries, even if pageSize is greater than 100.)

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFavorites

List<Tweet> getFavorites()

Retrieves the 20 most recent tweets favorited by the authenticated user.

Returns:

a collection of Tweets from the specified user's favorite timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFavorites

List<Tweet> getFavorites(int page,
                       int pageSize)

Retrieves tweets favorited by the authenticated user.

Parameters:

page - The page to return

pageSize - The number of entries per page.

Returns:

a collection of Tweets from the specified user's favorite timeline.

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

addToFavorites

void addToFavorites(long id)

Adds a tweet to the user's collection of favorite tweets.

Parameters:

id - the tweet's ID

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

removeFromFavorites

void removeFromFavorites(long id)

Removes a tweet from the user's collection of favorite tweets.

Parameters:

id - the tweet's ID

Throws:

ApiException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.