twitter4j.api
Interface UserMethodsAsync

All Known Implementing Classes:

AsyncTwitter

public interface UserMethodsAsync

Author:

Joern Huxhorn - jhuxhorn at googlemail.com

Method Summary

void	getFollowersStatuses() Returns the authenticating user's followers, each with current status inline.
void	getFollowersStatuses(int userId) Returns the specified user's followers, each with current status inline.
void	getFollowersStatuses(int userId, long cursor) Returns the specified user's followers, each with current status inline.
void	getFollowersStatuses(long cursor) Returns the authenticating user's followers, each with current status inline.
void	getFollowersStatuses(java.lang.String screenName) 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() Returns the specified user's friends, each with current status inline.
void	getFriendsStatuses(int userId) Returns a user's friends, each with current status inline.
void	getFriendsStatuses(int userId, long cursor) Returns a user's friends, each with current status inline.
void	getFriendsStatuses(long cursor) Returns a user's friends, each with current status inline.
void	getFriendsStatuses(java.lang.String screenName) 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	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(int[] 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(int 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(int 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(int[] 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.json

Since:

Twitter4J 2.1.1

See Also:

GET users/suggestions | 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

getFriendsStatuses

void getFriendsStatuses()

Returns the specified user's friends, each with current status inline.
This method calls http://api.twitter.com/1/statuses/friends

Since:

Twitter4J 2.0.9

See Also:

GET statuses/friends | 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)

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

Since:

Twitter4J 2.0.9

See Also:

GET statuses/friends | dev.twitter.com

getFriendsStatuses

void getFriendsStatuses(int userId)

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 ID of the user for whom to request a list of friends

Since:

Twitter4J 2.1.0

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(int 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()

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

Since:

Twitter4J 2.0.9

See Also:

GET statuses/followers | 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)

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.

Since:

Twitter4J 2.0.9

See Also:

GET statuses/followers | dev.twitter.com

getFollowersStatuses

void getFollowersStatuses(int userId)

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.

Since:

Twitter4J 2.1.0

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(int 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