twitter4j.api

Interface FriendsFollowersMethods

All Known Subinterfaces:

Twitter

All Known Implementing Classes:

TwitterImpl

public interface FriendsFollowersMethods

Author:

Joern Huxhorn - jhuxhorn at googlemail.com

Method Summary

Methods

Modifier and Type	Method and Description
IDs	getFollowersIDs(long cursor) Returns an array of numeric IDs for every user the specified user is followed by.
IDs	getFollowersIDs(long userId, long cursor) 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.
IDs	getFriendsIDs(long cursor) Returns an array of numeric IDs for every user the authenticating user is following.
IDs	getFriendsIDs(long userId, long cursor) 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.

Method Detail

getFriendsIDs

IDs getFriendsIDs(long cursor)
                  throws TwitterException

Returns an array of numeric IDs for every user the authenticating user is following.
This method calls http://api.twitter.com/1/friends/ids.json

Parameters:

cursor - Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filterd out after connections are queried.
To begin paging provide a value of -1 as the cursor. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth.

Returns:

an array of numeric IDs for every user the authenticating user is following

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

GET friends/ids | Twitter Developers

getFriendsIDs

IDs getFriendsIDs(long userId,
                long cursor)
                  throws TwitterException

Returns an array of numeric IDs for every user the specified user is following.
This method calls http://api.twitter.com/1/friends/ids.json

Parameters:

userId - Specifies the ID of the user for whom to return the friends list.

cursor - Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filterd out after connections are queried.
To begin paging provide a value of -1 as the cursor. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth.

Returns:

an array of numeric IDs for every user the specified user is following

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

GET friends/ids | Twitter Developers

getFriendsIDs

IDs getFriendsIDs(java.lang.String screenName,
                long cursor)
                  throws TwitterException

Returns an array of numeric IDs for every user the specified user is following.
This method calls http://api.twitter.com/1/friends/ids.json

Parameters:

screenName - Specifies the screen name of the user for whom to return the friends list.

cursor - Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filterd out after connections are queried.
To begin paging provide a value of -1 as the cursor. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth.

Returns:

an array of numeric IDs for every user the specified user is following

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

GET friends/ids | Twitter Developers

getFollowersIDs

IDs getFollowersIDs(long cursor)
                    throws TwitterException

Returns an array of numeric IDs for every user the specified user is followed by.
This method calls http://api.twitter.com/1/followers/ids.json

Parameters:

cursor - Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filterd out after connections are queried.
To begin paging provide a value of -1 as the cursor. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth.

Returns:

The ID or screen_name of the user to retrieve the friends ID list for.

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

GET followers/ids | Twitter Developers

getFollowersIDs

IDs getFollowersIDs(long userId,
                  long cursor)
                    throws TwitterException

Returns an array of numeric IDs for every user the specified user is followed by.
This method calls http://api.twitter.com/1/followers/ids.json

Parameters:

userId - Specifies the ID of the user for whom to return the followers list.

cursor - Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filterd out after connections are queried.
To begin paging provide a value of -1 as the cursor. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth.

Returns:

The ID or screen_name of the user to retrieve the friends ID list for.

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

GET followers/ids | Twitter Developers

getFollowersIDs

IDs getFollowersIDs(java.lang.String screenName,
                  long cursor)
                    throws TwitterException

Returns an array of numeric IDs for every user the specified user is followed by.
This method calls http://api.twitter.com/1/followers/ids.json

Parameters:

screenName - Specifies the screen name of the user for whom to return the followers list.

cursor - Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filterd out after connections are queried.
To begin paging provide a value of -1 as the cursor. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth.

Returns:

The ID or screen_name of the user to retrieve the friends ID list for.

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

GET followers/ids | Twitter Developers