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

twitter4j.api
Interface UserMethodsAsync

All Known Subinterfaces:
AsyncTwitter
All Known Implementing Classes:
AsyncTwitterImpl
public interface UserMethodsAsync

Author:
Joern Huxhorn - jhuxhorn at googlemail.com

Method Summary
 void getFollowersStatuses(long cursor)
          Returns the authenticating user's followers, each with current status inline.
 void getFollowersStatuses(long userId, long cursor)
          Returns the specified user's followers, each with current status inline.
 void getFollowersStatuses(java.lang.String screenName, long cursor)
          Returns the specified user's followers, each with current status inline.
 void getFriendsStatuses(long cursor)
          Returns a user's friends, each with current status inline.
 void getFriendsStatuses(long userId, long cursor)
          Returns a user's friends, each with current status inline.
 void getFriendsStatuses(java.lang.String screenName, long cursor)
          Returns a user's friends, each with current status inline.
 void getMemberSuggestions(java.lang.String categorySlug)
          Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.
 void getProfileImage(java.lang.String screenName, ProfileImage.ImageSize size)
          Access the profile image in various sizes for the user with the indicated screen_name.
 void getSuggestedUserCategories()
          Access to Twitter's suggested user list.
 void 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.
 void lookupUsers(long[] ids)
          Return up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two.
 void 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.
 void 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.
 void showUser(long userId)
          Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
 void showUser(java.lang.String screenName)
          Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
 

Method Detail

showUser

void showUser(java.lang.String screenName)
Returns extended information of a given user, specified by ID or screen name as per the required id parameter. The author's most recent status will be returned inline.
This method calls http://api.twitter.com/1/users/show.json

Parameters:
screenName - the screen name of the user for whom to request the detail
See Also:
GET users/show | dev.twitter.com

showUser

void showUser(long userId)
Returns extended information of a given user, specified by ID or screen name as per the required id parameter. The author's most recent status will be returned inline.
This method calls http://api.twitter.com/1/users/show.json

Parameters:
userId - the ID of the user for whom to request the retrieve
See Also:
GET users/show | dev.twitter.com

lookupUsers

void 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. The author's most recent status (if the authenticating user has permission) will be returned inline.
This method calls http://api.twitter.com/1/users/lookup.json

Parameters:
screenNames - Specifies the screen names of the users to retrieve.
Since:
Twitter4J 2.1.1
See Also:
GET users/lookup | dev.twitter.com

lookupUsers

void lookupUsers(long[] ids)
Return up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two. The author's most recent status (if the authenticating user has permission) will be returned inline.
This method calls http://api.twitter.com/1/users/lookup.json

Parameters:
ids - Specifies the screen names of the users to retrieve.
Throws:
TwitterException - when Twitter service or network is unavailable
Since:
Twitter4J 2.1.1
See Also:
GET users/lookup | dev.twitter.com

searchUsers

void 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.
This method calls http://api.twitter.com/1/users/search.json

Parameters:
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.
Throws:
TwitterException - when Twitter service or network is unavailable
See Also:
GET users/search | dev.twitter.com

getSuggestedUserCategories

void getSuggestedUserCategories()
Access to Twitter's suggested user list. This returns the list of suggested user categories. The category can be used in the users/suggestions/category endpoint to get the users in that category.
This method calls http://api.twitter.com/1/users/suggestions/:slug.json

Since:
Twitter4J 2.1.1
See Also:
GET users/suggestions/:slug | dev.twitter.com

getUserSuggestions

void 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.
This method calls http://api.twitter.com/1/users/suggestions/:slug.json

Parameters:
categorySlug - slug
Since:
Twitter4J 2.1.1
See Also:
GET users/suggestions/slug | dev.twitter.com

getMemberSuggestions

void getMemberSuggestions(java.lang.String categorySlug)
Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.
This method has not been finalized and the interface is subject to change in incompatible ways.
This method calls http://api.twitter.com/1/users/suggestions/:slug/members.json

Parameters:
categorySlug - slug
Since:
Twitter4J 2.1.9
See Also:
#newtwitter and the API - Twitter API Announcements | Google Group

getProfileImage

void getProfileImage(java.lang.String screenName,
                     ProfileImage.ImageSize size)
Access the profile image in various sizes for the user with the indicated screen_name. If no size is provided the normal image is returned. This resource does not return JSON or XML, but instead returns a 302 redirect to the actual image resource. This method should only be used by application developers to lookup or check the profile image URL for a user. This method must not be used as the image source URL presented to users of your application.
This method calls http://api.twitter.com/1/users/profile_image/:screen_name.json

Parameters:
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 24px
Since:
Twitter4J 2.1.7
See Also:
GET users/profile_image/:screen_name | dev.twitter.com

getFriendsStatuses

void getFriendsStatuses(long cursor)
Returns a user's friends, each with current status inline. They are ordered by the order in which the user followed them, most recently followed first, 100 at a time. (Please note that the result set isn't guaranteed to be 100 every time as suspended users will be filtered out.)
This method calls http://api.twitter.com/1/statuses/friends

Parameters:
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.
Since:
Twitter4J 2.0.9
See Also:
GET statuses/friends | dev.twitter.com

getFriendsStatuses

void getFriendsStatuses(java.lang.String screenName,
                        long cursor)
Returns a user's friends, each with current status inline. They are ordered by the order in which the user followed them, most recently followed first, 100 at a time. (Please note that the result set isn't guaranteed to be 100 every time as suspended users will be filtered out.)
This method calls http://api.twitter.com/1/statuses/friends

Parameters:
screenName - the screen name of the user for whom to request a list of friends
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.
Since:
Twitter4J 2.0.9
See Also:
GET statuses/friends | dev.twitter.com

getFriendsStatuses

void getFriendsStatuses(long userId,
                        long cursor)
Returns a user's friends, each with current status inline. They are ordered by the order in which the user followed them, most recently followed first, 100 at a time. (Please note that the result set isn't guaranteed to be 100 every time as suspended users will be filtered out.)
This method calls http://api.twitter.com/1/statuses/friends

Parameters:
userId - the screen name of the user for whom to request a list of friends
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.
Since:
Twitter4J 2.1.0
See Also:
GET statuses/friends | dev.twitter.com

getFollowersStatuses

void getFollowersStatuses(long cursor)
Returns the authenticating user's followers, each with current status inline. They are ordered by the order in which they joined Twitter (this is going to be changed).
This method calls http://api.twitter.com/1/statuses/followers.json

Parameters:
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.
Since:
Twitter4J 2.0.9
See Also:
GET statuses/followers | dev.twitter.com

getFollowersStatuses

void getFollowersStatuses(java.lang.String screenName,
                          long cursor)
Returns the specified user's followers, each with current status inline. They are ordered by the order in which they joined Twitter (this is going to be changed).
This method calls http://api.twitter.com/1/statuses/followers.json

Parameters:
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.
Since:
Twitter4J 2.0.9
See Also:
GET statuses/followers | dev.twitter.com

getFollowersStatuses

void getFollowersStatuses(long userId,
                          long cursor)
Returns the specified user's followers, each with current status inline. They are ordered by the order in which they joined Twitter (this is going to be changed).
This method calls http://api.twitter.com/1/statuses/followers.json

Parameters:
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.
Since:
Twitter4J 2.1.0
See Also:
GET statuses/followers | dev.twitter.com
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD