public class Twitter extends TwitterOAuthSupportBaseImpl implements java.io.Serializable, SearchMethods, TrendsMethods, TimelineMethods, StatusMethods, UserMethods, ListMethods, ListMembersMethods, ListSubscribersMethods, DirectMessageMethods, FriendshipMethods, FriendsFollowersMethods, AccountMethods, FavoriteMethods, NotificationMethods, BlockMethods, SpamReportingMethods, SavedSearchesMethods, LocalTrendsMethods, GeoMethods, LegalResources, NewTwitterMethods, HelpMethods
Modifier and Type | Field and Description |
---|---|
private static twitter4j.internal.http.HttpParameter |
INCLUDE_ENTITIES |
private static long |
serialVersionUID |
id, screenName
http, rateLimitStatusListener
auth, conf
Constructor and Description |
---|
Twitter()
Deprecated.
use
TwitterFactory.getInstance() instead |
Twitter(Configuration conf) |
Twitter(Configuration conf,
Authorization auth) |
Twitter(Configuration conf,
java.lang.String screenName,
java.lang.String password) |
Twitter(java.lang.String screenName,
java.lang.String password)
Deprecated.
use
TwitterFactory.getInstance(String,String) instead |
Modifier and Type | Method and Description |
---|---|
private void |
addParameterToList(java.util.List<twitter4j.internal.http.HttpParameter> colors,
java.lang.String paramName,
java.lang.String color) |
UserList |
addUserListMember(int listId,
int userId)
Adds a member to a list.
|
UserList |
addUserListMembers(int listId,
int[] userIds)
Adds multiple members to a list, by specifying a comma-separated list of member ids or screen names.
|
UserList |
addUserListMembers(int listId,
java.lang.String[] screenNames)
Adds multiple members to a list, by specifying a comma-separated list of member ids or screen names.
|
private void |
checkFileValidity(java.io.File image)
Check the existence, and the type of the specified file.
|
User |
checkUserListMembership(java.lang.String listOwnerScreenName,
int listId,
int userId)
Check if a user is a member of the specified list.
This method calls http://api.twitter.com/1/[listOwner]/[listId]/members/id.json |
User |
checkUserListSubscription(java.lang.String listOwnerScreenName,
int listId,
int userId)
Check if the specified user is a subscriber of the specified list.
|
User |
createBlock(int userId)
Blocks the user specified in the ID parameter as the authenticating user.
|
User |
createBlock(java.lang.String screenName)
Blocks the user specified in the ID parameter as the authenticating user.
|
Status |
createFavorite(long id)
Favorites the status specified in the ID parameter as the authenticating user.
|
User |
createFriendship(int userId)
Allows the authenticating users to follow the user specified in the ID parameter.
Returns the befriended user in the requested format when successful. |
User |
createFriendship(int userId,
boolean follow)
Allows the authenticating users to follow the user specified in the ID parameter.
Returns the befriended user in the requested format when successful. |
User |
createFriendship(java.lang.String screenName)
Allows the authenticating users to follow the user specified in the ID parameter.
Returns the befriended user in the requested format when successful. |
User |
createFriendship(java.lang.String screenName,
boolean follow)
Allows the authenticating users to follow the user specified in the ID parameter.
Returns the befriended user in the requested format when successful. |
Place |
createPlace(java.lang.String name,
java.lang.String containedWithin,
java.lang.String token,
GeoLocation location,
java.lang.String streetAddress)
Creates a new place at the given latitude and longitude.
|
SavedSearch |
createSavedSearch(java.lang.String query)
Creates a saved search for the authenticated user.
|
UserList |
createUserList(java.lang.String listName,
boolean isPublicList,
java.lang.String description)
Creates a new list for the authenticated user.
|
UserList |
deleteUserListMember(int listId,
int userId)
Removes the specified member from the list.
|
User |
destroyBlock(int userId)
Un-blocks the user specified in the ID parameter as the authenticating user.
|
User |
destroyBlock(java.lang.String screen_name)
Un-blocks the user specified in the ID parameter as the authenticating user.
|
DirectMessage |
destroyDirectMessage(int id)
Destroys the direct message specified in the required ID parameter.
|
Status |
destroyFavorite(long id)
Un-favorites the status specified in the ID parameter as the authenticating user.
|
User |
destroyFriendship(int userId)
Allows the authenticating users to unfollow the user specified in the ID parameter.
Returns the unfollowed user in the requested format when successful. |
User |
destroyFriendship(java.lang.String screenName)
Allows the authenticating users to unfollow the user specified in the ID parameter.
Returns the unfollowed user in the requested format when successful. |
SavedSearch |
destroySavedSearch(int id)
Destroys a saved search for the authenticated user.
|
Status |
destroyStatus(long statusId)
Destroys the status specified by the required ID parameter.
Usage note: The authenticating user must be the author of the specified status. |
UserList |
destroyUserList(int listId)
Deletes the specified list.
|
User |
disableNotification(int userId)
Disables notifications for updates from the specified user to the authenticating user.
|
User |
disableNotification(java.lang.String screenName)
Disables notifications for updates from the specified user to the authenticating user.
|
User |
enableNotification(int userId)
Enables notifications for updates from the specified user to the authenticating user.
|
User |
enableNotification(java.lang.String screenName)
Enables notifications for updates from the specified user to the authenticating user.
|
boolean |
existsBlock(int userId)
Returns if the authenticating user is blocking a target user.
|
boolean |
existsBlock(java.lang.String screenName)
Returns if the authenticating user is blocking a target user.
|
boolean |
existsFriendship(java.lang.String userA,
java.lang.String userB)
Tests for the existence of friendship between two users.
|
ResponseList<Location> |
getAvailableTrends()
Returns the locations that Twitter has trending topic information for.
|
ResponseList<Location> |
getAvailableTrends(GeoLocation location)
Returns the sorted locations that Twitter has trending topic information for.
|
ResponseList<User> |
getBlockingUsers()
Returns a list of user objects that the authenticating user is blocking.
|
ResponseList<User> |
getBlockingUsers(int page)
Returns a list of user objects that the authenticating user is blocking.
|
IDs |
getBlockingUsersIDs()
Returns an array of numeric user ids the authenticating user is blocking.
|
Trends |
getCurrentTrends()
Returns the current top 10 trending topics on Twitter.
|
Trends |
getCurrentTrends(boolean excludeHashTags)
Returns the current top 10 trending topics on Twitter.
|
java.util.List<Trends> |
getDailyTrends()
Returns the top 20 trending topics for each hour in a given day.
|
java.util.List<Trends> |
getDailyTrends(java.util.Date date,
boolean excludeHashTags)
Returns the top 20 trending topics for each hour in a given day.
|
ResponseList<DirectMessage> |
getDirectMessages()
Returns a list of the direct messages sent to the authenticating user.
|
ResponseList<DirectMessage> |
getDirectMessages(Paging paging)
Returns a list of the direct messages sent to the authenticating user.
|
ResponseList<Status> |
getFavorites()
Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter in the requested format.
|
ResponseList<Status> |
getFavorites(int page)
Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter in the requested format.
|
ResponseList<Status> |
getFavorites(java.lang.String id)
Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter in the requested format.
|
ResponseList<Status> |
getFavorites(java.lang.String id,
int page)
Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter in the requested format.
|
IDs |
getFollowersIDs()
Returns an array of numeric IDs for every user the specified user is followed by.
|
IDs |
getFollowersIDs(int userId)
Returns an array of numeric IDs for every user the specified user is followed by.
|
IDs |
getFollowersIDs(int userId,
long cursor)
Returns an array of numeric IDs for every user the specified user is followed by.
|
IDs |
getFollowersIDs(long cursor)
Returns an array of numeric IDs for every user the specified user is followed by.
|
IDs |
getFollowersIDs(java.lang.String screenName)
Returns an array of numeric IDs for every user the specified user is followed by.
|
IDs |
getFollowersIDs(java.lang.String screenName,
long cursor)
Returns an array of numeric IDs for every user the specified user is followed by.
|
PagableResponseList<User> |
getFollowersStatuses()
Returns the authenticating user's followers, each with current status inline.
|
PagableResponseList<User> |
getFollowersStatuses(int userId)
Returns the specified user's followers, each with current status inline.
|
PagableResponseList<User> |
getFollowersStatuses(int userId,
long cursor)
Returns the specified user's followers, each with current status inline.
|
PagableResponseList<User> |
getFollowersStatuses(long cursor)
Returns the authenticating user's followers, each with current status inline.
|
PagableResponseList<User> |
getFollowersStatuses(java.lang.String screenName)
Returns the specified user's followers, each with current status inline.
|
PagableResponseList<User> |
getFollowersStatuses(java.lang.String screenName,
long cursor)
Returns the specified user's followers, each with current status inline.
|
IDs |
getFriendsIDs()
Returns an array of numeric IDs for every user the authenticating user is following.
|
IDs |
getFriendsIDs(int userId)
Returns an array of numeric IDs for every user the specified user is following.
all IDs are attempted to be returned, but large sets of IDs will likely fail with timeout errors. |
IDs |
getFriendsIDs(int userId,
long cursor)
Returns an array of numeric IDs for every user the specified user is following.
|
IDs |
getFriendsIDs(long cursor)
Returns an array of numeric IDs for every user the authenticating user is following.
|
IDs |
getFriendsIDs(java.lang.String screenName)
Returns an array of numeric IDs for every user the specified user is following.
|
IDs |
getFriendsIDs(java.lang.String screenName,
long cursor)
Returns an array of numeric IDs for every user the specified user is following.
|
PagableResponseList<User> |
getFriendsStatuses()
Returns a user's friends, each with current status inline.
|
PagableResponseList<User> |
getFriendsStatuses(int userId)
Returns a user's friends, each with current status inline.
|
PagableResponseList<User> |
getFriendsStatuses(int userId,
long cursor)
Returns a user's friends, each with current status inline.
|
PagableResponseList<User> |
getFriendsStatuses(long cursor)
Returns a user's friends, each with current status inline.
|
PagableResponseList<User> |
getFriendsStatuses(java.lang.String screenName)
Returns a user's friends, each with current status inline.
|
PagableResponseList<User> |
getFriendsStatuses(java.lang.String screenName,
long cursor)
Returns a user's friends, each with current status inline.
|
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.
|
Place |
getGeoDetails(java.lang.String id)
Find out more details of a place that was returned from the
GeoMethodsAsync.reverseGeoCode(twitter4j.GeoQuery) method. |
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.
|
int |
getId()
Returns authenticating user's user id.
This method may internally call verifyCredentials() on the first invocation if - this instance is authenticated by Basic and email address is supplied instead of screen name, or - this instance is authenticated by OAuth. |
IDs |
getIncomingFriendships(long cursor)
Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user.
|
Trends |
getLocationTrends(int woeid)
Returns the top 10 trending topics for a specific location Twitter has trending topic information for.
|
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<Place> |
getNearbyPlaces(GeoQuery query)
Search for places (cities and neighborhoods) that can be attached to a statuses/update.
|
IDs |
getOutgoingFriendships(long cursor)
Returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
|
java.lang.String |
getPrivacyPolicy()
Returns Twitter's Privacy Policy.
|
ProfileImage |
getProfileImage(java.lang.String screenName,
ProfileImage.ImageSize size)
Access the profile image in various sizes for the user with the indicated screen_name.
|
ResponseList<Status> |
getPublicTimeline()
Returns the 20 most recent statuses from non-protected users who have set a custom user icon.
|
RateLimitStatus |
getRateLimitStatus()
Returns the remaining number of API requests available to the requesting user before the API limit is reached for the current hour.
|
RelatedResults |
getRelatedResults(long statusId)
If available, returns an array of replies and mentions related to the specified Tweet.
|
ResponseList<User> |
getRetweetedBy(long statusId)
Show user objects of up to 100 members who retweeted the status.
|
ResponseList<User> |
getRetweetedBy(long statusId,
Paging paging)
Show user objects of up to 100 members who retweeted the status.
|
IDs |
getRetweetedByIDs(long statusId)
Show user ids of up to 100 users who retweeted the status represented by id
This method calls http://api.twitter.com/1/statuses/:id/retweeted_by/ids.format |
IDs |
getRetweetedByIDs(long statusId,
Paging paging)
Show user ids of up to 100 users who retweeted the status.
|
ResponseList<Status> |
getRetweetedByMe()
Returns the 20 most recent retweets posted by the authenticating user.
|
ResponseList<Status> |
getRetweetedByMe(Paging paging)
Returns the 20 most recent retweets posted by the authenticating user.
|
ResponseList<Status> |
getRetweetedToMe()
Returns the 20 most recent retweets posted by the authenticating user's friends.
|
ResponseList<Status> |
getRetweetedToMe(Paging paging)
Returns the 20 most recent retweets posted by the authenticating user's friends.
|
ResponseList<Status> |
getRetweets(long statusId)
Returns up to 100 of the first retweets of a given tweet.
|
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.
|
java.util.List<SavedSearch> |
getSavedSearches()
Returns the authenticated user's saved search queries.
|
java.lang.String |
getScreenName()
Returns authenticating user's screen name.
This method may internally call verifyCredentials() on the first invocation if - this instance is authenticated by Basic and email address is supplied instead of screen name, or - this instance is authenticated by OAuth. Note that this method returns a transiently cached (will be lost upon serialization) screen name while it is possible to change a user's screen name. |
ResponseList<DirectMessage> |
getSentDirectMessages()
Returns a list of the direct messages sent by the authenticating user.
|
ResponseList<DirectMessage> |
getSentDirectMessages(Paging paging)
Returns a list of the direct messages sent by the authenticating user.
|
SimilarPlaces |
getSimilarPlaces(GeoLocation location,
java.lang.String name,
java.lang.String containedWithin,
java.lang.String streetAddress)
Locates places near the given coordinates which are similar in name.
|
ResponseList<Category> |
getSuggestedUserCategories()
Access to Twitter's suggested user list.
|
java.lang.String |
getTermsOfService()
Returns Twitter's' Terms of Service.
|
Trends |
getTrends()
Returns the top ten topics that are currently trending on Twitter.
|
PagableResponseList<User> |
getUserListMembers(java.lang.String listOwnerScreenName,
int listId,
long cursor)
Returns the members of the specified list.
|
PagableResponseList<UserList> |
getUserListMemberships(java.lang.String listMemberScreenName,
long cursor)
List the lists the specified user has been added to.
|
PagableResponseList<UserList> |
getUserLists(java.lang.String listOwnerScreenName,
long cursor)
List the lists of the specified user.
|
ResponseList<Status> |
getUserListStatuses(java.lang.String listOwnerScreenName,
int id,
Paging paging)
Show tweet timeline for members of the specified list.
|
PagableResponseList<User> |
getUserListSubscribers(java.lang.String listOwnerScreenName,
int listId,
long cursor)
Returns the subscribers of the specified list.
|
PagableResponseList<UserList> |
getUserListSubscriptions(java.lang.String listOwnerScreenName,
long cursor)
List the lists the specified user follows.
|
ResponseList<User> |
getUserSuggestions(java.lang.String categorySlug)
Access the users in a given category of the Twitter suggested user list.
It is recommended that end clients cache this data for no more than one hour. |
ResponseList<Status> |
getUserTimeline()
Returns the 20 most recent statuses posted from the authenticating user.
|
ResponseList<Status> |
getUserTimeline(int userId)
Returns the 20 most recent statuses posted from the authenticating user.
|
ResponseList<Status> |
getUserTimeline(int 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.
|
java.util.List<Trends> |
getWeeklyTrends()
Returns the top 30 trending topics for each day in a given week.
|
java.util.List<Trends> |
getWeeklyTrends(java.util.Date date,
boolean excludeHashTags)
Returns the top 30 trending topics for each day in a given week.
|
ResponseList<User> |
lookupUsers(int[] ids)
Return up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two.
|
ResponseList<User> |
lookupUsers(java.lang.String[] screenNames)
Return up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two.
|
private twitter4j.internal.http.HttpParameter[] |
mergeParameters(twitter4j.internal.http.HttpParameter[] params1,
twitter4j.internal.http.HttpParameter params2) |
private twitter4j.internal.http.HttpParameter[] |
mergeParameters(twitter4j.internal.http.HttpParameter[] params1,
twitter4j.internal.http.HttpParameter[] params2) |
User |
reportSpam(int userId)
The user specified in the id is blocked by the authenticated user and reported as a spammer.
|
User |
reportSpam(java.lang.String screenName)
The user specified in the id is blocked by the authenticated user and reported as a spammer.
|
Status |
retweetStatus(long statusId)
Retweets a tweet.
|
ResponseList<Place> |
reverseGeoCode(GeoQuery query)
Search for places (cities and neighborhoods) that can be attached to a statuses/update.
|
QueryResult |
search(Query query)
Returns tweets that match a specified query.
|
ResponseList<Place> |
searchPlaces(GeoQuery query)
Search for places that can be attached to a statuses/update.
|
ResponseList<User> |
searchUsers(java.lang.String query,
int page)
Run a search for users similar to the Find People button on Twitter.com; the same results returned by people search on Twitter.com will be returned by using this API.
Usage note: It is only possible to retrieve the first 1000 matches from this API. |
DirectMessage |
sendDirectMessage(int userId,
java.lang.String text)
Sends a new direct message to the specified user from the authenticating user.
|
DirectMessage |
sendDirectMessage(java.lang.String screenName,
java.lang.String text)
Sends a new direct message to the specified user from the authenticating user.
|
Relationship |
showFriendship(int sourceId,
int targetId)
Returns detailed information about the relationship between two users.
|
Relationship |
showFriendship(java.lang.String sourceScreenName,
java.lang.String targetScreenName)
Returns detailed information about the relationship between two users.
|
SavedSearch |
showSavedSearch(int id)
Retrieve the data for a saved search owned by the authenticating user specified by the given id.
|
Status |
showStatus(long id)
Returns a single status, specified by the id parameter below.
|
User |
showUser(int userId)
Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
|
User |
showUser(java.lang.String screenName)
Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
|
UserList |
showUserList(java.lang.String listOwnerScreenName,
int id)
Show the specified list.
|
UserList |
subscribeUserList(java.lang.String listOwnerScreenName,
int listId)
Make the authenticated user follow the specified list.
|
boolean |
test()
Returns the string "ok" in the requested format with a 200 OK HTTP status code.
|
private static java.lang.String |
toCommaSeparatedString(int[] strArray) |
private static java.lang.String |
toCommaSeparatedString(java.lang.String[] strArray) |
private java.lang.String |
toDateStr(java.util.Date date) |
java.lang.String |
toString() |
UserList |
unsubscribeUserList(java.lang.String listOwnerScreenName,
int listId)
Unsubscribes the authenticated user form the specified list.
|
User |
updateDeliveryDevice(Device device)
Sets which device Twitter delivers updates to for the authenticating user.
|
User |
updateProfile(java.lang.String name,
java.lang.String url,
java.lang.String location,
java.lang.String description)
Sets values that users are able to set under the "Account" tab of their settings page.
|
User |
updateProfile(java.lang.String name,
java.lang.String email,
java.lang.String url,
java.lang.String location,
java.lang.String description)
Sets values that users are able to set under the "Account" tab of their settings page.
|
User |
updateProfileBackgroundImage(java.io.File image,
boolean tile)
Updates the authenticating user's profile background image.
|
User |
updateProfileColors(java.lang.String profileBackgroundColor,
java.lang.String profileTextColor,
java.lang.String profileLinkColor,
java.lang.String profileSidebarFillColor,
java.lang.String profileSidebarBorderColor)
Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com.
|
User |
updateProfileImage(java.io.File image)
Updates the authenticating user's profile image.
|
Status |
updateStatus(StatusUpdate latestStatus)
Updates the authenticating user's status.
|
Status |
updateStatus(java.lang.String status)
Updates the authenticating user's status.
|
Status |
updateStatus(java.lang.String status,
GeoLocation location)
Updates the authenticating user's status.
|
Status |
updateStatus(java.lang.String status,
long inReplyToStatusId)
Updates the authenticating user's status.
|
Status |
updateStatus(java.lang.String status,
long inReplyToStatusId,
GeoLocation location)
Updates the authenticating user's status.
|
UserList |
updateUserList(int listId,
java.lang.String newListName,
boolean isPublicList,
java.lang.String newDescription)
Updates the specified list.
|
User |
verifyCredentials()
Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not.
|
getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthRequestToken, getOAuthRequestToken, isOAuthEnabled, setOAuthAccessToken, setOAuthAccessToken, setOAuthConsumer
equals, hashCode, httpResponseReceived, setRateLimitStatusListener, shutdown
ensureAuthorizationEnabled, ensureOAuthEnabled, getAuthorization, getConfiguration, isBasicAuthEnabled
private static final long serialVersionUID
private static twitter4j.internal.http.HttpParameter INCLUDE_ENTITIES
Twitter(Configuration conf)
public Twitter()
TwitterFactory.getInstance()
insteadpublic Twitter(java.lang.String screenName, java.lang.String password)
TwitterFactory.getInstance(String,String)
insteadscreenName
- the screen name of the userpassword
- the password of the userTwitter(Configuration conf, java.lang.String screenName, java.lang.String password)
Twitter(Configuration conf, Authorization auth)
private twitter4j.internal.http.HttpParameter[] mergeParameters(twitter4j.internal.http.HttpParameter[] params1, twitter4j.internal.http.HttpParameter[] params2)
private twitter4j.internal.http.HttpParameter[] mergeParameters(twitter4j.internal.http.HttpParameter[] params1, twitter4j.internal.http.HttpParameter params2)
public java.lang.String getScreenName() throws TwitterException, java.lang.IllegalStateException
TwitterException
- when verifyCredentials threw an exception.java.lang.IllegalStateException
- if no credentials are supplied. i.e.) this is an anonymous Twitter instancepublic int getId() throws TwitterException, java.lang.IllegalStateException
TwitterException
- when verifyCredentials threw an exception.java.lang.IllegalStateException
- if no credentials are supplied. i.e.) this is an anonymous Twitter instancepublic QueryResult search(Query query) throws TwitterException
search
in interface SearchMethods
query
- - the search conditionTwitterException
- when Twitter service or network is unavailablepublic Trends getTrends() throws TwitterException
getTrends
in interface TrendsMethods
TwitterException
- when Twitter service or network is unavailablepublic Trends getCurrentTrends() throws TwitterException
getCurrentTrends
in interface TrendsMethods
TwitterException
- when Twitter service or network is unavailablepublic Trends getCurrentTrends(boolean excludeHashTags) throws TwitterException
getCurrentTrends
in interface TrendsMethods
excludeHashTags
- Setting this to true will remove all hashtags from the trends list.TwitterException
- when Twitter service or network is unavailablepublic java.util.List<Trends> getDailyTrends() throws TwitterException
getDailyTrends
in interface TrendsMethods
TwitterException
- when Twitter service or network is unavailablepublic java.util.List<Trends> getDailyTrends(java.util.Date date, boolean excludeHashTags) throws TwitterException
getDailyTrends
in interface TrendsMethods
date
- Permits specifying a start date for the report.excludeHashTags
- Setting this to true will remove all hashtags from the trends list.TwitterException
- when Twitter service or network is unavailableprivate java.lang.String toDateStr(java.util.Date date)
public java.util.List<Trends> getWeeklyTrends() throws TwitterException
getWeeklyTrends
in interface TrendsMethods
TwitterException
- when Twitter service or network is unavailablepublic java.util.List<Trends> getWeeklyTrends(java.util.Date date, boolean excludeHashTags) throws TwitterException
getWeeklyTrends
in interface TrendsMethods
date
- Permits specifying a start date for the report.excludeHashTags
- Setting this to true will remove all hashtags from the trends list.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getPublicTimeline() throws TwitterException
getPublicTimeline
in interface TimelineMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getHomeTimeline() throws TwitterException
getHomeTimeline
in interface TimelineMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getHomeTimeline(Paging paging) throws TwitterException
getHomeTimeline
in interface TimelineMethods
paging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getFriendsTimeline() throws TwitterException
getFriendsTimeline
in interface TimelineMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getFriendsTimeline(Paging paging) throws TwitterException
getFriendsTimeline
in interface TimelineMethods
paging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getUserTimeline(java.lang.String screenName, Paging paging) throws TwitterException
getUserTimeline
in interface TimelineMethods
screenName
- specifies the screen name of the user for whom to return the user_timelinepaging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getUserTimeline(int userId, Paging paging) throws TwitterException
getUserTimeline
in interface TimelineMethods
userId
- specifies the ID of the user for whom to return the user_timelinepaging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getUserTimeline(java.lang.String screenName) throws TwitterException
getUserTimeline
in interface TimelineMethods
screenName
- specifies the screen name of the user for whom to return the user_timelineTwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getUserTimeline(int userId) throws TwitterException
getUserTimeline
in interface TimelineMethods
userId
- specifies the ID of the user for whom to return the user_timelineTwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getUserTimeline() throws TwitterException
getUserTimeline
in interface TimelineMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getUserTimeline(Paging paging) throws TwitterException
getUserTimeline
in interface TimelineMethods
paging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getMentions() throws TwitterException
getMentions
in interface TimelineMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getMentions(Paging paging) throws TwitterException
getMentions
in interface TimelineMethods
paging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getRetweetedByMe() throws TwitterException
getRetweetedByMe
in interface TimelineMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getRetweetedByMe(Paging paging) throws TwitterException
getRetweetedByMe
in interface TimelineMethods
paging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getRetweetedToMe() throws TwitterException
getRetweetedToMe
in interface TimelineMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getRetweetedToMe(Paging paging) throws TwitterException
getRetweetedToMe
in interface TimelineMethods
paging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getRetweetsOfMe() throws TwitterException
getRetweetsOfMe
in interface TimelineMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getRetweetsOfMe(Paging paging) throws TwitterException
getRetweetsOfMe
in interface TimelineMethods
paging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<User> getRetweetedBy(long statusId) throws TwitterException
getRetweetedBy
in interface StatusMethods
statusId
- The ID of the status you want to get retweeters ofTwitterException
- when Twitter service or network is unavailablepublic ResponseList<User> getRetweetedBy(long statusId, Paging paging) throws TwitterException
getRetweetedBy
in interface StatusMethods
statusId
- The ID of the status you want to get retweeters ofpaging
- specify your paging requirementsTwitterException
- when Twitter service or network is unavailablepublic IDs getRetweetedByIDs(long statusId) throws TwitterException
getRetweetedByIDs
in interface StatusMethods
statusId
- The ID of the status you want to get retweeters ofTwitterException
- when Twitter service or network is unavailablepublic IDs getRetweetedByIDs(long statusId, Paging paging) throws TwitterException
getRetweetedByIDs
in interface StatusMethods
statusId
- The ID of the status you want to get retweeters ofpaging
- specify your paging requirementsTwitterException
- when Twitter service or network is unavailablepublic Status showStatus(long id) throws TwitterException
showStatus
in interface StatusMethods
id
- the numerical ID of the status you're trying to retrieveTwitterException
- when Twitter service or network is unavailablepublic Status updateStatus(java.lang.String status) throws TwitterException
updateStatus
in interface StatusMethods
status
- the text of your status updateTwitterException
- when Twitter service or network is unavailablepublic Status updateStatus(java.lang.String status, GeoLocation location) throws TwitterException
updateStatus
in interface StatusMethods
status
- the text of your status updatelocation
- The location that this tweet refers to.TwitterException
- when Twitter service or network is unavailablepublic Status updateStatus(java.lang.String status, long inReplyToStatusId) throws TwitterException
updateStatus
in interface StatusMethods
status
- the text of your status updateinReplyToStatusId
- The ID of an existing status that the status to be posted is in reply to. This implicitly sets the in_reply_to_user_id attribute of the resulting status to the user ID of the message being replied to. Invalid/missing status IDs will be ignored.TwitterException
- when Twitter service or network is unavailablepublic Status updateStatus(java.lang.String status, long inReplyToStatusId, GeoLocation location) throws TwitterException
updateStatus
in interface StatusMethods
status
- the text of your status updateinReplyToStatusId
- The ID of an existing status that the status to be posted is in reply to. This implicitly sets the in_reply_to_user_id attribute of the resulting status to the user ID of the message being replied to. Invalid/missing status IDs will be ignored.location
- The location that this tweet refers to.TwitterException
- when Twitter service or network is unavailablepublic Status updateStatus(StatusUpdate latestStatus) throws TwitterException
updateStatus
in interface StatusMethods
latestStatus
- the latest status to be updated.TwitterException
- when Twitter service or network is unavailablepublic Status destroyStatus(long statusId) throws TwitterException
destroyStatus
in interface StatusMethods
statusId
- The ID of the status to destroy.TwitterException
- when Twitter service or network is unavailablepublic Status retweetStatus(long statusId) throws TwitterException
retweetStatus
in interface StatusMethods
statusId
- The ID of the status to retweet.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getRetweets(long statusId) throws TwitterException
getRetweets
in interface StatusMethods
statusId
- The numerical ID of the tweet you want the retweets of.TwitterException
- when Twitter service or network is unavailablepublic User showUser(java.lang.String screenName) throws TwitterException
showUser
in interface UserMethods
screenName
- the screen name of the user for whom to request the detailTwitterException
- when Twitter service or network is unavailablepublic User showUser(int userId) throws TwitterException
showUser
in interface UserMethods
userId
- the ID of the user for whom to request the detailTwitterException
- when Twitter service or network is unavailablepublic ResponseList<User> lookupUsers(java.lang.String[] screenNames) throws TwitterException
lookupUsers
in interface UserMethods
screenNames
- Specifies the screen names of the users to return.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<User> lookupUsers(int[] ids) throws TwitterException
lookupUsers
in interface UserMethods
ids
- Specifies the screen names of the users to return.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<User> searchUsers(java.lang.String query, int page) throws TwitterException
searchUsers
in interface UserMethods
query
- The query to run against people search.page
- Specifies the page of results to retrieve. Number of statuses per page is fixed to 20.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Category> getSuggestedUserCategories() throws TwitterException
getSuggestedUserCategories
in interface UserMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<User> getUserSuggestions(java.lang.String categorySlug) throws TwitterException
getUserSuggestions
in interface UserMethods
categorySlug
- slugTwitterException
- when Twitter service or network is unavailablepublic ProfileImage getProfileImage(java.lang.String screenName, ProfileImage.ImageSize size) throws TwitterException
getProfileImage
in interface UserMethods
screenName
- The screen name of the user for whom to return results for.size
- Specifies the size of image to fetch. Not specifying a size will give the default, normal size of 48px by 48px. Valid options include: BIGGER - 73px by 73px NORMAL - 48px by 48px MINI - 24px by 24pxTwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFriendsStatuses() throws TwitterException
getFriendsStatuses
in interface UserMethods
TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFriendsStatuses(long cursor) throws TwitterException
getFriendsStatuses
in interface UserMethods
cursor
- Breaks the results into pages. A single page contains 100 users. This is recommended for users who are followed by many other users. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFriendsStatuses(java.lang.String screenName) throws TwitterException
getFriendsStatuses
in interface UserMethods
screenName
- the screen name of the user for whom to request a list of friendsTwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFriendsStatuses(int userId) throws TwitterException
getFriendsStatuses
in interface UserMethods
userId
- the ID of the user for whom to request a list of friendsTwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFriendsStatuses(java.lang.String screenName, long cursor) throws TwitterException
getFriendsStatuses
in interface UserMethods
screenName
- the screen name of the user for whom to request a list of friendscursor
- Breaks the results into pages. A single page contains 100 users. This is recommended for users who are followed by many other users. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFriendsStatuses(int userId, long cursor) throws TwitterException
getFriendsStatuses
in interface UserMethods
userId
- the ID of the user for whom to request a list of friendscursor
- Breaks the results into pages. A single page contains 100 users. This is recommended for users who are followed by many other users. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFollowersStatuses() throws TwitterException
getFollowersStatuses
in interface UserMethods
TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFollowersStatuses(long cursor) throws TwitterException
getFollowersStatuses
in interface UserMethods
cursor
- Breaks the results into pages. A single page contains 100 users. This is recommended for users who are followed by many other users. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFollowersStatuses(java.lang.String screenName) throws TwitterException
getFollowersStatuses
in interface UserMethods
screenName
- The screen name of the user for whom to request a list of followers.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFollowersStatuses(int userId) throws TwitterException
getFollowersStatuses
in interface UserMethods
userId
- The ID of the user for whom to request a list of followers.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFollowersStatuses(java.lang.String screenName, long cursor) throws TwitterException
getFollowersStatuses
in interface UserMethods
screenName
- The screen name of the user for whom to request a list of followers.cursor
- Breaks the results into pages. A single page contains 100 users. This is recommended for users who are followed by many other users. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getFollowersStatuses(int userId, long cursor) throws TwitterException
getFollowersStatuses
in interface UserMethods
userId
- The ID of the user for whom to request a list of followers.cursor
- Breaks the results into pages. A single page contains 100 users. This is recommended for users who are followed by many other users. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic UserList createUserList(java.lang.String listName, boolean isPublicList, java.lang.String description) throws TwitterException
createUserList
in interface ListMethods
listName
- The name of the list you are creating. Required.isPublicList
- set true if you wish to make a public listdescription
- The description of the list you are creating. Optional.TwitterException
- when Twitter service or network is unavailable, or the authenticated user already has 20 lists(TwitterException.getStatusCode() == 403).public UserList updateUserList(int listId, java.lang.String newListName, boolean isPublicList, java.lang.String newDescription) throws TwitterException
updateUserList
in interface ListMethods
listId
- The id of the list to update.newListName
- What you'd like to change the list's name to.isPublicList
- Whether your list is public or private. Optional. Values can be public or private. Lists are public by default if no mode is specified.newDescription
- What you'd like to change the list description to.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<UserList> getUserLists(java.lang.String listOwnerScreenName, long cursor) throws TwitterException
getUserLists
in interface ListMethods
listOwnerScreenName
- The screen name of the list ownercursor
- Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic UserList showUserList(java.lang.String listOwnerScreenName, int id) throws TwitterException
showUserList
in interface ListMethods
listOwnerScreenName
- The screen name of the list ownerid
- The id of the list to showTwitterException
- when Twitter service or network is unavailablepublic UserList destroyUserList(int listId) throws TwitterException
destroyUserList
in interface ListMethods
listId
- The id of the list to deleteTwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getUserListStatuses(java.lang.String listOwnerScreenName, int id, Paging paging) throws TwitterException
getUserListStatuses
in interface ListMethods
listOwnerScreenName
- The screen name of the list ownerid
- The id of the list to deletepaging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<UserList> getUserListMemberships(java.lang.String listMemberScreenName, long cursor) throws TwitterException
getUserListMemberships
in interface ListMethods
listMemberScreenName
- The screen name of the list membercursor
- Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<UserList> getUserListSubscriptions(java.lang.String listOwnerScreenName, long cursor) throws TwitterException
getUserListSubscriptions
in interface ListMethods
listOwnerScreenName
- The screen name of the list ownercursor
- Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic PagableResponseList<User> getUserListMembers(java.lang.String listOwnerScreenName, int listId, long cursor) throws TwitterException
getUserListMembers
in interface ListMembersMethods
listOwnerScreenName
- The screen name of the list ownerlistId
- The id of the listcursor
- Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic UserList addUserListMember(int listId, int userId) throws TwitterException
addUserListMember
in interface ListMembersMethods
listId
- The id of the list.userId
- The id of the user to add as a member of the list.TwitterException
- when Twitter service or network is unavailablepublic UserList addUserListMembers(int listId, int[] userIds) throws TwitterException
addUserListMembers
in interface ListMembersMethods
listId
- The id of the list.userIds
- The array of ids of the user to add as member of the list. up to 100 are allowed in a single request.TwitterException
public UserList addUserListMembers(int listId, java.lang.String[] screenNames) throws TwitterException
addUserListMembers
in interface ListMembersMethods
listId
- The id of the list.screenNames
- The array of screen names of the user to add as member of the list. up to 100 are allowed in a single request.TwitterException
public UserList deleteUserListMember(int listId, int userId) throws TwitterException
deleteUserListMember
in interface ListMembersMethods
listId
- The id of the list.userId
- The screen name of the member you wish to remove from the list.TwitterException
- when Twitter service or network is unavailablepublic User checkUserListMembership(java.lang.String listOwnerScreenName, int listId, int userId) throws TwitterException
checkUserListMembership
in interface ListMembersMethods
listOwnerScreenName
- The screen name of the list ownerlistId
- The id of the list.userId
- The id of the user who you want to know is a member or not of the specified list.TwitterException
- when Twitter service or network is unavailable
, or the user is not a member of the specified list(TwitterException.getStatusCode() returns 404 in that case.)public PagableResponseList<User> getUserListSubscribers(java.lang.String listOwnerScreenName, int listId, long cursor) throws TwitterException
getUserListSubscribers
in interface ListSubscribersMethods
listOwnerScreenName
- The screen name of the list ownerlistId
- The id of the listcursor
- Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.TwitterException
- when Twitter service or network is unavailablepublic UserList subscribeUserList(java.lang.String listOwnerScreenName, int listId) throws TwitterException
subscribeUserList
in interface ListSubscribersMethods
listOwnerScreenName
- The screen name of the list ownerlistId
- The id of the list.TwitterException
- when Twitter service or network is unavailablepublic UserList unsubscribeUserList(java.lang.String listOwnerScreenName, int listId) throws TwitterException
unsubscribeUserList
in interface ListSubscribersMethods
listOwnerScreenName
- The screen name of the list ownerlistId
- The id of the list.TwitterException
- when Twitter service or network is unavailablepublic User checkUserListSubscription(java.lang.String listOwnerScreenName, int listId, int userId) throws TwitterException
checkUserListSubscription
in interface ListSubscribersMethods
listOwnerScreenName
- The screen name of the list ownerlistId
- The id of the list.userId
- The id of the user who you want to know is a member or not of the specified list.TwitterException
- when Twitter service or network is unavailable
, or the user is not a member of the specified list(TwitterException.getStatusCode() returns 404 in that case.)public ResponseList<DirectMessage> getDirectMessages() throws TwitterException
getDirectMessages
in interface DirectMessageMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<DirectMessage> getDirectMessages(Paging paging) throws TwitterException
getDirectMessages
in interface DirectMessageMethods
paging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<DirectMessage> getSentDirectMessages() throws TwitterException
getSentDirectMessages
in interface DirectMessageMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<DirectMessage> getSentDirectMessages(Paging paging) throws TwitterException
getSentDirectMessages
in interface DirectMessageMethods
paging
- controls pagination. Supports since_id, max_id, count and page parameters.TwitterException
- when Twitter service or network is unavailablepublic DirectMessage sendDirectMessage(java.lang.String screenName, java.lang.String text) throws TwitterException
sendDirectMessage
in interface DirectMessageMethods
screenName
- the screen name of the user to whom send the direct messagetext
- The text of your direct message.TwitterException
- when Twitter service or network is unavailablepublic DirectMessage sendDirectMessage(int userId, java.lang.String text) throws TwitterException
sendDirectMessage
in interface DirectMessageMethods
userId
- the screen name of the user to whom send the direct messagetext
- The text of your direct message.TwitterException
- when Twitter service or network is unavailablepublic DirectMessage destroyDirectMessage(int id) throws TwitterException
destroyDirectMessage
in interface DirectMessageMethods
id
- the ID of the direct message to destroyTwitterException
- when Twitter service or network is unavailablepublic User createFriendship(java.lang.String screenName) throws TwitterException
createFriendship
in interface FriendshipMethods
screenName
- the screen name of the user to be befriendedTwitterException
- when Twitter service or network is unavailablepublic User createFriendship(int userId) throws TwitterException
createFriendship
in interface FriendshipMethods
userId
- the ID of the user to be befriendedTwitterException
- when Twitter service or network is unavailablepublic User createFriendship(java.lang.String screenName, boolean follow) throws TwitterException
createFriendship
in interface FriendshipMethods
screenName
- the screen name of the user to be befriendedfollow
- Enable notifications for the target user in addition to becoming friends.TwitterException
- when Twitter service or network is unavailablepublic User createFriendship(int userId, boolean follow) throws TwitterException
createFriendship
in interface FriendshipMethods
userId
- the ID of the user to be befriendedfollow
- Enable notifications for the target user in addition to becoming friends.TwitterException
- when Twitter service or network is unavailablepublic User destroyFriendship(java.lang.String screenName) throws TwitterException
destroyFriendship
in interface FriendshipMethods
screenName
- the screen name of the user for whom to request a list of friendsTwitterException
- when Twitter service or network is unavailablepublic User destroyFriendship(int userId) throws TwitterException
destroyFriendship
in interface FriendshipMethods
userId
- the ID of the user for whom to request a list of friendsTwitterException
- when Twitter service or network is unavailablepublic boolean existsFriendship(java.lang.String userA, java.lang.String userB) throws TwitterException
existsFriendship
in interface FriendshipMethods
userA
- The ID or screen_name of the first user to test friendship for.userB
- The ID or screen_name of the second user to test friendship for.TwitterException
- when Twitter service or network is unavailablepublic Relationship showFriendship(java.lang.String sourceScreenName, java.lang.String targetScreenName) throws TwitterException
showFriendship
in interface FriendshipMethods
sourceScreenName
- the screen name of the source usertargetScreenName
- the screen name of the target userTwitterException
- when Twitter service or network is unavailablepublic Relationship showFriendship(int sourceId, int targetId) throws TwitterException
showFriendship
in interface FriendshipMethods
sourceId
- the screen ID of the source usertargetId
- the screen ID of the target userTwitterException
- when Twitter service or network is unavailablepublic IDs getIncomingFriendships(long cursor) throws TwitterException
getIncomingFriendships
in interface FriendshipMethods
cursor
- Breaks the results into pages. A single page contains 5000 identifiers. Provide a value of -1 to begin paging.TwitterException
- when Twitter service or network is unavailablepublic IDs getOutgoingFriendships(long cursor) throws TwitterException
getOutgoingFriendships
in interface FriendshipMethods
cursor
- Breaks the results into pages. A single page contains 5000 identifiers. Provide a value of -1 to begin paging.TwitterException
- when Twitter service or network is unavailablepublic IDs getFriendsIDs() throws TwitterException
getFriendsIDs
in interface FriendsFollowersMethods
TwitterException
- when Twitter service or network is unavailablepublic IDs getFriendsIDs(long cursor) throws TwitterException
getFriendsIDs
in interface FriendsFollowersMethods
cursor
- Specifies the page number of the results beginning at 1. A single page contains 5000 ids. This is recommended for users with large ID lists. If not provided all ids are returned.TwitterException
- when Twitter service or network is unavailablepublic IDs getFriendsIDs(int userId) throws TwitterException
getFriendsIDs
in interface FriendsFollowersMethods
userId
- Specifies the ID of the user for whom to return the friends list.TwitterException
- when Twitter service or network is unavailablepublic IDs getFriendsIDs(int userId, long cursor) throws TwitterException
getFriendsIDs
in interface FriendsFollowersMethods
userId
- Specifies the ID of the user for whom to return the friends list.cursor
- Specifies the page number of the results beginning at 1. A single page contains 5000 ids. This is recommended for users with large ID lists. If not provided all ids are returned.TwitterException
- when Twitter service or network is unavailablepublic IDs getFriendsIDs(java.lang.String screenName) throws TwitterException
getFriendsIDs
in interface FriendsFollowersMethods
screenName
- Specifies the screen name of the user for whom to return the friends list.TwitterException
- when Twitter service or network is unavailablepublic IDs getFriendsIDs(java.lang.String screenName, long cursor) throws TwitterException
getFriendsIDs
in interface FriendsFollowersMethods
screenName
- Specifies the screen name of the user for whom to return the friends list.cursor
- Specifies the page number of the results beginning at 1. A single page contains 5000 ids. This is recommended for users with large ID lists. If not provided all ids are returned.TwitterException
- when Twitter service or network is unavailablepublic IDs getFollowersIDs() throws TwitterException
getFollowersIDs
in interface FriendsFollowersMethods
TwitterException
- when Twitter service or network is unavailablepublic IDs getFollowersIDs(long cursor) throws TwitterException
getFollowersIDs
in interface FriendsFollowersMethods
cursor
- Specifies the page number of the results beginning at 1. A single page contains 5000 ids. This is recommended for users with large ID lists. If not provided all ids are returned.TwitterException
- when Twitter service or network is unavailablepublic IDs getFollowersIDs(int userId) throws TwitterException
getFollowersIDs
in interface FriendsFollowersMethods
userId
- Specifies the ID of the user for whom to return the followers list.TwitterException
- when Twitter service or network is unavailablepublic IDs getFollowersIDs(int userId, long cursor) throws TwitterException
getFollowersIDs
in interface FriendsFollowersMethods
userId
- Specifies the ID of the user for whom to return the followers list.cursor
- Specifies the page number of the results beginning at 1. A single page contains 5000 ids. This is recommended for users with large ID lists. If not provided all ids are returned.TwitterException
- when Twitter service or network is unavailablepublic IDs getFollowersIDs(java.lang.String screenName) throws TwitterException
getFollowersIDs
in interface FriendsFollowersMethods
screenName
- Specifies the screen name of the user for whom to return the followers list.TwitterException
- when Twitter service or network is unavailablepublic IDs getFollowersIDs(java.lang.String screenName, long cursor) throws TwitterException
getFollowersIDs
in interface FriendsFollowersMethods
screenName
- Specifies the screen name of the user for whom to return the followers list.cursor
- Specifies the page number of the results beginning at 1. A single page contains 5000 ids. This is recommended for users with large ID lists. If not provided all ids are returned.TwitterException
- when Twitter service or network is unavailablepublic User verifyCredentials() throws TwitterException
verifyCredentials
in interface AccountMethods
TwitterException
- when Twitter service or network is unavailable, or if supplied credential is wrong (TwitterException.getStatusCode() == 401)public RateLimitStatus getRateLimitStatus() throws TwitterException
getRateLimitStatus
in interface AccountMethods
TwitterException
- when Twitter service or network is unavailablepublic User updateProfile(java.lang.String name, java.lang.String email, java.lang.String url, java.lang.String location, java.lang.String description) throws TwitterException
updateProfile
in interface AccountMethods
name
- Optional. Maximum of 20 characters.email
- Optional. Maximum of 40 characters. Must be a valid email address.url
- Optional. Maximum of 100 characters. Will be prepended with "http://" if not present.location
- Optional. Maximum of 30 characters. The contents are not normalized or geocoded in any way.description
- Optional. Maximum of 160 characters.TwitterException
- when Twitter service or network is unavailablepublic User updateProfile(java.lang.String name, java.lang.String url, java.lang.String location, java.lang.String description) throws TwitterException
updateProfile
in interface AccountMethods
name
- Optional. Maximum of 20 characters.url
- Optional. Maximum of 100 characters. Will be prepended with "http://" if not present.location
- Optional. Maximum of 30 characters. The contents are not normalized or geocoded in any way.description
- Optional. Maximum of 160 characters.TwitterException
- when Twitter service or network is unavailablepublic User updateDeliveryDevice(Device device) throws TwitterException
updateDeliveryDevice
in interface AccountMethods
device
- new Delivery device. Must be one of: IM, SMS, NONE.TwitterException
- when Twitter service or network is unavailablepublic User updateProfileColors(java.lang.String profileBackgroundColor, java.lang.String profileTextColor, java.lang.String profileLinkColor, java.lang.String profileSidebarFillColor, java.lang.String profileSidebarBorderColor) throws TwitterException
updateProfileColors
in interface AccountMethods
profileBackgroundColor
- optional, can be nullprofileTextColor
- optional, can be nullprofileLinkColor
- optional, can be nullprofileSidebarFillColor
- optional, can be nullprofileSidebarBorderColor
- optional, can be nullTwitterException
- when Twitter service or network is unavailableprivate void addParameterToList(java.util.List<twitter4j.internal.http.HttpParameter> colors, java.lang.String paramName, java.lang.String color)
public User updateProfileImage(java.io.File image) throws TwitterException
updateProfileImage
in interface AccountMethods
image
- Must be a valid GIF, JPG, or PNG image of less than 700 kilobytes in size. Images with width larger than 500 pixels will be scaled down.TwitterException
- when Twitter service or network is unavailable,
or when the specified file is not found (FileNotFoundException will be nested),
or when the specified file object in not representing a file (IOException will be nested)public User updateProfileBackgroundImage(java.io.File image, boolean tile) throws TwitterException
updateProfileBackgroundImage
in interface AccountMethods
image
- Must be a valid GIF, JPG, or PNG image of less than 800 kilobytes in size. Images with width larger than 2048 pixels will be forceably scaled down.tile
- If set to true the background image will be displayed tiled. The image will not be tiled otherwise.TwitterException
- when Twitter service or network is unavailable,
or when the specified file is not found (FileNotFoundException will be nested),
or when the specified file object in not representing a file (IOException will be nested)private void checkFileValidity(java.io.File image) throws TwitterException
image
- image to be uploadedTwitterException
- when the specified file is not found (FileNotFoundException will be nested)
, or when the specified file object is not representing a file(IOException will be nested).public ResponseList<Status> getFavorites() throws TwitterException
getFavorites
in interface FavoriteMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getFavorites(int page) throws TwitterException
getFavorites
in interface FavoriteMethods
page
- the number of pageTwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getFavorites(java.lang.String id) throws TwitterException
getFavorites
in interface FavoriteMethods
id
- the ID or screen name of the user for whom to request a list of favorite statusesTwitterException
- when Twitter service or network is unavailablepublic ResponseList<Status> getFavorites(java.lang.String id, int page) throws TwitterException
getFavorites
in interface FavoriteMethods
id
- the ID or screen name of the user for whom to request a list of favorite statusespage
- the number of pageTwitterException
- when Twitter service or network is unavailablepublic Status createFavorite(long id) throws TwitterException
createFavorite
in interface FavoriteMethods
id
- the ID of the status to favoriteTwitterException
- when Twitter service or network is unavailablepublic Status destroyFavorite(long id) throws TwitterException
destroyFavorite
in interface FavoriteMethods
id
- the ID of the status to un-favoriteTwitterException
- when Twitter service or network is unavailablepublic User enableNotification(java.lang.String screenName) throws TwitterException
enableNotification
in interface NotificationMethods
screenName
- Specifies the screen name of the user to follow with device updates.TwitterException
- when Twitter service or network is unavailablepublic User enableNotification(int userId) throws TwitterException
enableNotification
in interface NotificationMethods
userId
- Specifies the ID of the user to follow with device updates.TwitterException
- when Twitter service or network is unavailablepublic User disableNotification(java.lang.String screenName) throws TwitterException
disableNotification
in interface NotificationMethods
screenName
- Specifies the screen name of the user to disable device notifications.TwitterException
- when Twitter service or network is unavailablepublic User disableNotification(int userId) throws TwitterException
disableNotification
in interface NotificationMethods
userId
- Specifies the ID of the user to disable device notifications.TwitterException
- when Twitter service or network is unavailablepublic User createBlock(java.lang.String screenName) throws TwitterException
createBlock
in interface BlockMethods
screenName
- the screen_name of the user to blockTwitterException
- when Twitter service or network is unavailablepublic User createBlock(int userId) throws TwitterException
createBlock
in interface BlockMethods
userId
- the ID of the user to blockTwitterException
- when Twitter service or network is unavailablepublic User destroyBlock(java.lang.String screen_name) throws TwitterException
destroyBlock
in interface BlockMethods
screen_name
- the screen_name of the user to blockTwitterException
- when Twitter service or network is unavailablepublic User destroyBlock(int userId) throws TwitterException
destroyBlock
in interface BlockMethods
userId
- the ID of the user to blockTwitterException
- when Twitter service or network is unavailablepublic boolean existsBlock(java.lang.String screenName) throws TwitterException
existsBlock
in interface BlockMethods
screenName
- The screen_name of the potentially blocked user.TwitterException
- when Twitter service or network is unavailablepublic boolean existsBlock(int userId) throws TwitterException
existsBlock
in interface BlockMethods
userId
- The ID of the potentially blocked user.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<User> getBlockingUsers() throws TwitterException
getBlockingUsers
in interface BlockMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<User> getBlockingUsers(int page) throws TwitterException
getBlockingUsers
in interface BlockMethods
page
- the number of pageTwitterException
- when Twitter service or network is unavailablepublic IDs getBlockingUsersIDs() throws TwitterException
getBlockingUsersIDs
in interface BlockMethods
TwitterException
- when Twitter service or network is unavailablepublic User reportSpam(int userId) throws TwitterException
reportSpam
in interface SpamReportingMethods
userId
- The ID of the user you want to report as a spammer.TwitterException
- when Twitter service or network is unavailablepublic User reportSpam(java.lang.String screenName) throws TwitterException
reportSpam
in interface SpamReportingMethods
screenName
- The screen name of the user you want to report as a spammer.TwitterException
- when Twitter service or network is unavailablepublic java.util.List<SavedSearch> getSavedSearches() throws TwitterException
getSavedSearches
in interface SavedSearchesMethods
TwitterException
- when Twitter service or network is unavailablepublic SavedSearch showSavedSearch(int id) throws TwitterException
showSavedSearch
in interface SavedSearchesMethods
id
- The id of the saved search to be retrieved.TwitterException
- when Twitter service or network is unavailablepublic SavedSearch createSavedSearch(java.lang.String query) throws TwitterException
createSavedSearch
in interface SavedSearchesMethods
query
- the query stringTwitterException
- when Twitter service or network is unavailablepublic SavedSearch destroySavedSearch(int id) throws TwitterException
destroySavedSearch
in interface SavedSearchesMethods
id
- The id of the saved search to be deleted.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Location> getAvailableTrends() throws TwitterException
getAvailableTrends
in interface LocalTrendsMethods
TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Location> getAvailableTrends(GeoLocation location) throws TwitterException
getAvailableTrends
in interface LocalTrendsMethods
location
- the available trend locations will be sorted by distance to the lat and long passed in. The sort is nearest to furthest.TwitterException
- when Twitter service or network is unavailablepublic Trends getLocationTrends(int woeid) throws TwitterException
getLocationTrends
in interface LocalTrendsMethods
woeid
- The WOEID of the location to be querying forTwitterException
- when Twitter service or network is unavailablepublic ResponseList<Place> searchPlaces(GeoQuery query) throws TwitterException
searchPlaces
in interface GeoMethods
query
- search queryTwitterException
- when Twitter service or network is unavailablepublic SimilarPlaces getSimilarPlaces(GeoLocation location, java.lang.String name, java.lang.String containedWithin, java.lang.String streetAddress) throws TwitterException
getSimilarPlaces
in interface GeoMethods
location
- The latitude and longitude to search around.name
- The name a place is known as.containedWithin
- optional: the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.streetAddress
- optional: This parameter searches for places which have this given street address. There are other well-known, and application specific attributes available. Custom attributes are also permitted. Learn more about Place Attributes.TwitterException
- when Twitter service or network is unavailablepublic ResponseList<Place> getNearbyPlaces(GeoQuery query) throws TwitterException
getNearbyPlaces
in interface GeoMethods
query
- search queryTwitterException
- when Twitter service or network is unavailablepublic ResponseList<Place> reverseGeoCode(GeoQuery query) throws TwitterException
reverseGeoCode
in interface GeoMethods
query
- search queryTwitterException
- when Twitter service or network is unavailablepublic Place getGeoDetails(java.lang.String id) throws TwitterException
GeoMethodsAsync.reverseGeoCode(twitter4j.GeoQuery)
method.
getGeoDetails
in interface GeoMethods
id
- The ID of the location to query about.TwitterException
- when Twitter service or network is unavailablepublic Place createPlace(java.lang.String name, java.lang.String containedWithin, java.lang.String token, GeoLocation location, java.lang.String streetAddress) throws TwitterException
createPlace
in interface GeoMethods
name
- The name a place is known as.containedWithin
- The place_id within which the new place can be found. Try and be as close as possible with the containing place. For example, for a room in a building, set the contained_within as the building place_id.token
- The token found in the response from geo/similar_places.location
- The latitude and longitude the place is located at.streetAddress
- optional: This parameter searches for places which have this given street address. There are other well-known, and application specific attributes available. Custom attributes are also permitted. Learn more about Place Attributes.TwitterException
- when Twitter service or network is unavailablepublic java.lang.String getTermsOfService() throws TwitterException
getTermsOfService
in interface LegalResources
TwitterException
- when Twitter service or network is unavailablepublic java.lang.String getPrivacyPolicy() throws TwitterException
getPrivacyPolicy
in interface LegalResources
TwitterException
- when Twitter service or network is unavailablepublic RelatedResults getRelatedResults(long statusId) throws TwitterException
getRelatedResults
in interface NewTwitterMethods
statusId
- the numerical ID of the status you're trying to retrieveTwitterException
- when Twitter service or network is unavailablepublic boolean test() throws TwitterException
test
in interface HelpMethods
TwitterException
- when Twitter service or network is unavailableprivate static java.lang.String toCommaSeparatedString(java.lang.String[] strArray)
private static java.lang.String toCommaSeparatedString(int[] strArray)
public java.lang.String toString()
toString
in class TwitterBase