/*
* Copyright 2013 Agorava
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.agorava.twitter;
import org.agorava.twitter.model.MessageTooLongException;
import org.agorava.twitter.model.Tweet;
import org.agorava.twitter.model.TwitterProfile;
import java.util.List;
/**
* Interface defining the operations for sending and retrieving tweets.
*
* @author Craig Walls
* @author Antoine Sabot-Durand
*/
public interface TwitterTimelineService {
/**
* 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.
* <p>
* 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.
* </p>
*
* @return a collection of {@link Tweet}s in the public timeline.
* @throws ApiException if there is an error while communicating with Twitter.
*/
List<Tweet> getPublicTimeline();
/**
* 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.
*
* @return a collection of {@link Tweet}s in the authenticating user's home timeline.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getHomeTimeline();
/**
* 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.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @return a collection of {@link Tweet}s in the authenticating user's home timeline.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
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.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @return a collection of {@link Tweet}s in the authenticating user's home timeline.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getHomeTimeline(int page, int pageSize, long sinceId, long maxId);
/**
* Retrieves the 20 most recent tweets posted by the authenticating user.
*
* @return a collection of {@link Tweet}s that have been posted by the authenticating user.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getUserTimeline();
/**
* Retrieves tweets posted by the authenticating user. The most recent tweets are listed first.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @return a collection of {@link Tweet}s that have been posted by the authenticating user.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getUserTimeline(int page, int pageSize);
/**
* Retrieves tweets posted by the authenticating user. The most recent tweets are listed first.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @return a collection of {@link Tweet}s that have been posted by the authenticating user.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getUserTimeline(int page, int pageSize, long sinceId, long maxId);
/**
* Retrieves the 20 most recent tweets posted by the given user.
*
* @param screenName The screen name of the user whose timeline is being requested.
* @return a collection of {@link Tweet}s from the specified user's timeline.
* @throws ApiException if there is an error while communicating with Twitter.
*/
List<Tweet> getUserTimeline(String screenName);
/**
* Retrieves tweets posted by the given user. The most recent tweets are listed first.
*
* @param screenName The screen name of the user whose timeline is being requested.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @return a collection of {@link Tweet}s from the specified user's timeline.
* @throws ApiException if there is an error while communicating with Twitter.
*/
List<Tweet> getUserTimeline(String screenName, int page, int pageSize);
/**
* Retrieves tweets posted by the given user. The most recent tweets are listed first.
*
* @param screenName The screen name of the user whose timeline is being requested.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @return a collection of {@link Tweet}s from the specified user's timeline.
* @throws ApiException if there is an error while communicating with Twitter.
*/
List<Tweet> getUserTimeline(String screenName, int page, int pageSize, long sinceId, long maxId);
/**
* Retrieves the 20 most recent tweets posted by the given user.
*
* @param userId The user ID of the user whose timeline is being requested.
* @return a collection of {@link Tweet}s from the specified user's timeline.
* @throws ApiException if there is an error while communicating with Twitter.
*/
List<Tweet> getUserTimeline(long userId);
/**
* Retrieves tweets posted by the given user. The most recent tweets are listed first.
*
* @param userId The user ID of the user whose timeline is being requested.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @return a collection of {@link Tweet}s from the specified user's timeline.
* @throws ApiException if there is an error while communicating with Twitter.
*/
List<Tweet> getUserTimeline(long userId, int page, int pageSize);
/**
* Retrieves tweets posted by the given user. The most recent tweets are listed first.
*
* @param userId The user ID of the user whose timeline is being requested.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @return a collection of {@link Tweet}s from the specified user's timeline.
* @throws ApiException if there is an error while communicating with Twitter.
*/
List<Tweet> getUserTimeline(long userId, int page, int pageSize, long sinceId, long maxId);
/**
* Retrieve the 20 most recent tweets that mention the authenticated user.
*
* @return a collection of {@link Tweet} objects that mention the authenticated user.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getMentions();
/**
* Retrieve tweets that mention the authenticated user. The most recent tweets are listed first.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @return a collection of {@link Tweet} objects that mention the authenticated user.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getMentions(int page, int pageSize);
/**
* Retrieve tweets that mention the authenticated user. The most recent tweets are listed first.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 200. (Will return at most 200
* entries, even if pageSize is greater than 200.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @return a collection of {@link Tweet} objects that mention the authenticated user.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getMentions(int page, int pageSize, long sinceId, long maxId);
/**
* Retrieve the 20 most recent retweets posted by the authenticated user.
*
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedByMe();
/**
* Retrieve retweets posted by the authenticated user. The most recent tweets are listed first.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s 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.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedByMe(int page, int pageSize);
/**
* Retrieve retweets posted by the authenticated user. The most recent tweets are listed first.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 100. (Will return at most 100
* entries, even if pageSize is greater than 100.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedByMe(int page, int pageSize, long sinceId, long maxId);
/**
* Retrieve the 20 most recent retweets posted by the specified user.
*
* @param userId The user ID to get retweets for.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedByUser(long userId);
/**
* Retrieve retweets posted by the specified user. The most recent tweets are listed first.
*
* @param userId The user ID to get retweets for.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s 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.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedByUser(long userId, int page, int pageSize);
/**
* Retrieve retweets posted by the specified user. The most recent tweets are listed first.
*
* @param userId The user ID to get retweets for.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 100. (Will return at most 100
* entries, even if pageSize is greater than 100.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedByUser(long userId, int page, int pageSize, long sinceId, long maxId);
/**
* Retrieve the 20 most recent retweets posted by the specified user.
*
* @param screenName The screen name of the user to get retweets for.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedByUser(String screenName);
/**
* Retrieve retweets posted by the specified user. The most recent tweets are listed first.
*
* @param screenName The screen name of the user to get retweets for.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s 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.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedByUser(String screenName, int page, int pageSize);
/**
* Retrieve retweets posted by the specified user. The most recent tweets are listed first.
*
* @param screenName The screen name of the user to get retweets for.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 100. (Will return at most 100
* entries, even if pageSize is greater than 100.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedByUser(String screenName, int page, int pageSize, long sinceId, long maxId);
/**
* Retrieve the 20 most recent retweets posted by users the authenticating user follow.
*
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedToMe();
/**
* Retrieve retweets posted by users the authenticating user follow. The most recent tweets are listed first.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s 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.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedToMe(int page, int pageSize);
/**
* Retrieve retweets posted by users the authenticating user follow. The most recent tweets are listed first.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 100. (Will return at most 100
* entries, even if pageSize is greater than 100.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedToMe(int page, int pageSize, long sinceId, long maxId);
/**
* Retrieve the 20 most recent retweets posted by users that the specified user follows.
*
* @param userId The user ID to get retweets for.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedToUser(long userId);
/**
* Retrieve retweets posted by users that the specified user follows. The most recent tweets are listed first.
*
* @param userId The user ID to get retweets for.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s 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.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
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.
*
* @param userId The user ID to get retweets for.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 100. (Will return at most 100
* entries, even if pageSize is greater than 100.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedToUser(long userId, int page, int pageSize, long sinceId, long maxId);
/**
* Retrieve the 20 most recent retweets by users that the specified user follows.
*
* @param screenName The screen name of the user to get retweets for.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedToUser(String screenName);
/**
* Retrieve retweets by users that the specified user follows. The most recent tweets are listed first.
*
* @param screenName The screen name of the user to get retweets for.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s 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.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
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.
*
* @param screenName The screen name of the user to get retweets for.
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 100. (Will return at most 100
* entries, even if pageSize is greater than 100.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetedToUser(String screenName, int page, int pageSize, long sinceId, long maxId);
/**
* 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.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetsOfMe();
/**
* Retrieve tweets of the authenticated user that have been retweeted by others. The most recent tweets are listed first.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s 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.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
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.
*
* @param page The page to return
* @param pageSize The number of {@link Tweet}s per page. Should be less than or equal to 100. (Will return at most 100
* entries, even if pageSize is greater than 100.)
* @param sinceId The minimum {@link Tweet} ID to return in the results
* @param maxId The maximum {@link Tweet} ID to return in the results
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getRetweetsOfMe(int page, int pageSize, long sinceId, long maxId);
/**
* Returns a single tweet.
*
* @param tweetId the tweet's ID
* @throws ApiException if there is an error while communicating with Twitter.
*/
Tweet getStatus(long tweetId);
/**
* Updates the user's status.
*
* @param status The status message
* @throws ApiException if there is an error while communicating with Twitter.
* @throws DuplicateTweetException if the status message duplicates a previously posted status.
* @throws MessageTooLongException if the length of the status message exceeds Twitter's 140 character limit.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
Tweet updateStatus(String status);
/**
* Updates the user's status along with a picture.
*
* @param status The status message
* @param photo A {@link Resource} for the photo data. The given Resource must implement the getFilename() method (such as
* {@link FileSystemResource} or {@link ClassPathResource}) and must contain GIF, JPG, or PNG data.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws DuplicateTweetException if the status message duplicates a previously posted status.
* @throws MessageTooLongException if the length of the status message exceeds Twitter's 140 character limit.
* @throws OperationNotPermittedException if the photo resource isn't a GIF, JPG, or PNG.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
// TODO: add types for updateStatus(String status, Resource photo);
/**
* Updates the user's status, including additional metadata concerning the status.
*
* @param status The status message
* @param details Metadata pertaining to the status
* @throws ApiException if there is an error while communicating with Twitter.
* @throws DuplicateTweetException if the status message duplicates a previously posted status.
* @throws MessageTooLongException if the length of the status message exceeds Twitter's 140 character limit.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
// TODO: add types for Tweet updateStatus(String status, StatusDetails details);
/**
* Updates the user's status, including a picture and additional metadata concerning the status.
*
* @param status The status message
* @param photo A {@link Resource} for the photo data. The given Resource must implement the getFilename() method (such as
* {@link FileSystemResource} or {@link ClassPathResource}) and must contain GIF, JPG, or PNG data.
* @param details Metadata pertaining to the status
* @throws ApiException if there is an error while communicating with Twitter.
* @throws DuplicateTweetException if the status message duplicates a previously posted status.
* @throws MessageTooLongException if the length of the status message exceeds Twitter's 140 character limit.
* @throws OperationNotPermittedException if the photo resource isn't a GIF, JPG, or PNG.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
// TODO add types for Tweet updateStatus(String status, Resource photo, StatusDetails details);
/**
* Removes a status entry.
*
* @param tweetId the tweet's ID
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
void deleteStatus(long tweetId);
/**
* Posts a retweet of an existing tweet.
*
* @param tweetId The ID of the tweet to be retweeted
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
void retweet(long tweetId);
/**
* Retrieves up to 100 retweets of a specific tweet.
*
* @param tweetId the tweet's ID
* @throws ApiException if there is an error while communicating with Twitter.
*/
List<Tweet> getRetweets(long tweetId);
/**
* Retrieves retweets of a specific tweet.
*
* @param tweetId the tweet's ID
* @param 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.
*/
List<Tweet> getRetweets(long tweetId, int count);
/**
* Retrieves the profiles of up to 100 users how have retweeted a specific tweet.
*
* @param id the tweet's ID
* @throws ApiException if there is an error while communicating with Twitter.
*/
List<TwitterProfile> getRetweetedBy(long id);
/**
* Retrieves the profiles of users how have retweeted a specific tweet.
*
* @param tweetId the tweet's ID
* @param page The page to return
* @param pageSize The number of {@link TwitterProfile}s 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.
*/
List<TwitterProfile> getRetweetedBy(long tweetId, int page, int pageSize);
/**
* Retrieves the IDs of up to 100 users who have retweeted a specific tweet.
*
* @param tweetId the tweet's ID.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Long> getRetweetedByIds(long tweetId);
/**
* Retrieves the IDs of users who have retweeted a specific tweet.
*
* @param tweetId the tweet's ID.
* @param page The page to return
* @param 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.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Long> getRetweetedByIds(long tweetId, int page, int pageSize);
/**
* Retrieves the 20 most recent tweets favorited by the authenticated user.
*
* @return a collection of {@link Tweet}s from the specified user's favorite timeline.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getFavorites();
/**
* Retrieves tweets favorited by the authenticated user.
*
* @param page The page to return
* @param pageSize The number of entries per page.
* @return a collection of {@link Tweet}s from the specified user's favorite timeline.
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
List<Tweet> getFavorites(int page, int pageSize);
/**
* Adds a tweet to the user's collection of favorite tweets.
*
* @param id the tweet's ID
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
void addToFavorites(long id);
/**
* Removes a tweet from the user's collection of favorite tweets.
*
* @param id the tweet's ID
* @throws ApiException if there is an error while communicating with Twitter.
* @throws MissingAuthorizationException if TwitterTemplate was not created with OAuth credentials.
*/
void removeFromFavorites(long id);
}