org.springframework.social.twitter.api

Interface FriendOperations

public interface FriendOperations

Interface defining the operations for working with a user's friends and followers.

Method Summary

Methods

Modifier and Type	Method and Description
TwitterProfile	disableNotifications(long userId) Disable mobile device notifications from Twitter for the specified user.
TwitterProfile	disableNotifications(String screenName) Disable mobile device notifications from Twitter for the specified user.
TwitterProfile	enableNotifications(long userId) Enable mobile device notifications from Twitter for the specified user.
TwitterProfile	enableNotifications(String screenName) Enable mobile device notifications from Twitter for the specified user.
String	follow(long userId) Allows the authenticated user to follow (create a friendship) with another user.
String	follow(String screenName) Allows the authenticated user to follow (create a friendship) with another user.
CursoredList<Long>	getFollowerIds() Retrieves a list of up to 5000 IDs for the Twitter users that follow the authenticated user.
CursoredList<Long>	getFollowerIds(long userId) Retrieves a list of up to 5000IDs for the Twitter users that follow the given user.
CursoredList<Long>	getFollowerIds(String screenName) Retrieves a list of up to 5000 IDs for the Twitter users that follow the given user.
CursoredList<Long>	getFollowerIdsInCursor(long cursor) Retrieves a list of up to 5000 IDs for the Twitter users that follow the authenticated user.
CursoredList<Long>	getFollowerIdsInCursor(long userId, long cursor) Retrieves a list of up to 5000IDs for the Twitter users that follow the given user.
CursoredList<Long>	getFollowerIdsInCursor(String screenName, long cursor) Retrieves a list of up to 5000 IDs for the Twitter users that follow the given user.
CursoredList<TwitterProfile>	getFollowers() Retrieves a list of up to 5000 users that the authenticated user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers).
CursoredList<TwitterProfile>	getFollowers(long userId) Retrieves a list of up to 5000 users that the given user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers).
CursoredList<TwitterProfile>	getFollowers(String screenName) Retrieves a list of up to 5000 users that the given user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers).
CursoredList<TwitterProfile>	getFollowersInCursor(long cursor) Retrieves a list of up to 5000 users that the authenticated user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers).
CursoredList<TwitterProfile>	getFollowersInCursor(long userId, long cursor) Retrieves a list of up to 5000 users that the given user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers).
CursoredList<TwitterProfile>	getFollowersInCursor(String screenName, long cursor) Retrieves a list of up to 5000 users that the given user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers).
CursoredList<Long>	getFriendIds() Retrieves a list of up to 5000 IDs for the Twitter users that the authenticated user follows.
CursoredList<Long>	getFriendIds(long userId) Retrieves a list of up to 5000 IDs for the Twitter users that the given user follows.
CursoredList<Long>	getFriendIds(String screenName) Retrieves a list of up to 5000 IDs for the Twitter users that the given user follows.
CursoredList<Long>	getFriendIdsInCursor(long cursor) Retrieves a list of up to 5000 IDs for the Twitter users that the authenticated user follows.
CursoredList<Long>	getFriendIdsInCursor(long userId, long cursor) Retrieves a list of up to 5000 IDs for the Twitter users that the given user follows.
CursoredList<Long>	getFriendIdsInCursor(String screenName, long cursor) Retrieves a list of up to 5000 IDs for the Twitter users that the given user follows.
CursoredList<TwitterProfile>	getFriends() Retrieves a list of up to 5000 users that the authenticated user follows.
CursoredList<TwitterProfile>	getFriends(long userId) Retrieves a list of up to 5000 users that the given user follows.
CursoredList<TwitterProfile>	getFriends(String screenName) Retrieves a list of up to 5000 users that the given user follows.
CursoredList<TwitterProfile>	getFriendsInCursor(long cursor) Retrieves a list of up to 5000 users that the authenticated user follows.
CursoredList<TwitterProfile>	getFriendsInCursor(long userId, long cursor) Retrieves a list of up to 5000 users that the given user follows.
CursoredList<TwitterProfile>	getFriendsInCursor(String screenName, long cursor) Retrieves a list of up to 5000 users that the given user follows.
CursoredList<Long>	getIncomingFriendships()
CursoredList<Long>	getIncomingFriendships(long cursor)
CursoredList<Long>	getOutgoingFriendships()
CursoredList<Long>	getOutgoingFriendships(long cursor)
String	unfollow(long userId) Allows the authenticated use to unfollow (destroy a friendship) with another user
String	unfollow(String screenName) Allows the authenticated use to unfollow (destroy a friendship) with another user

Method Detail

getFriends

CursoredList<TwitterProfile> getFriends()

Retrieves a list of up to 5000 users that the authenticated user follows. Note that this method make multiple calls to Twitter's REST API (one call to get a list of the friend IDs and one call for every 100 friends). If all you need is the friend IDs, consider calling getFriendIds() instead. Or if you need only a subset of the user's friends, call UserOperations.getUsers() passing in the list of friend IDs you need.

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFriendsInCursor

CursoredList<TwitterProfile> getFriendsInCursor(long cursor)

Retrieves a list of up to 5000 users that the authenticated user follows. Note that this method make multiple calls to Twitter's REST API (one call to get a list of the friend IDs and one call for every 100 friends). If all you need is the friend IDs, consider calling getFriendIds() instead. Or if you need only a subset of the user's friends, call UserOperations.getUsers() passing in the list of friend IDs you need.

Parameters:

cursor - the cursor used to fetch the friend IDs

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFriends

CursoredList<TwitterProfile> getFriends(long userId)

Retrieves a list of up to 5000 users that the given user follows. Note that this method make multiple calls to Twitter's REST API (one call to get a list of the friend IDs and one call for every 100 friends). If all you need is the friend IDs, consider calling getFriendIds() instead. Or if you need only a subset of the user's friends, call UserOperations.getUsers() passing in the list of friend IDs you need. Supports either application or user authorization.

Parameters:

userId - The user's Twitter ID

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFriendsInCursor

CursoredList<TwitterProfile> getFriendsInCursor(long userId,
                                              long cursor)

Retrieves a list of up to 5000 users that the given user follows. Note that this method make multiple calls to Twitter's REST API (one call to get a list of the friend IDs and one call for every 100 friends). If all you need is the friend IDs, consider calling getFriendIds() instead. Or if you need only a subset of the user's friends, call UserOperations.getUsers() passing in the list of friend IDs you need. Supports either application or user authorization.

Parameters:

userId - The user's Twitter ID

cursor - the cursor used to fetch the friend IDs

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFriends

CursoredList<TwitterProfile> getFriends(String screenName)

Retrieves a list of up to 5000 users that the given user follows. Note that this method make multiple calls to Twitter's REST API (one call to get a list of the friend IDs and one call for every 100 friends). If all you need is the friend IDs, consider calling getFriendIds() instead. Or if you need only a subset of the user's friends, call UserOperations.getUsers() passing in the list of friend IDs you need.

Parameters:

screenName - The user's Twitter screen name

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFriendsInCursor

CursoredList<TwitterProfile> getFriendsInCursor(String screenName,
                                              long cursor)

Retrieves a list of up to 5000 users that the given user follows. Note that this method make multiple calls to Twitter's REST API (one call to get a list of the friend IDs and one call for every 100 friends). If all you need is the friend IDs, consider calling getFriendIds() instead. Or if you need only a subset of the user's friends, call UserOperations.getUsers() passing in the list of friend IDs you need. Supports either application or user authorization.

Parameters:

screenName - The user's Twitter screen name

cursor - the cursor used to fetch the friend IDs

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFriendIds

CursoredList<Long> getFriendIds()

Retrieves a list of up to 5000 IDs for the Twitter users that the authenticated user follows. Call getFriendIdsForCursor() with a cursor value to get the next/previous page of entries.

Returns:

a cursored list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFriendIdsInCursor

CursoredList<Long> getFriendIdsInCursor(long cursor)

Retrieves a list of up to 5000 IDs for the Twitter users that the authenticated user follows.

Parameters:

cursor - The cursor value to fetch a specific page of entries. Use -1 for the first page of entries.

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFriendIds

CursoredList<Long> getFriendIds(long userId)

Retrieves a list of up to 5000 IDs for the Twitter users that the given user follows. Supports either application or user authorization.

Parameters:

userId - the user's Twitter ID

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFriendIdsInCursor

CursoredList<Long> getFriendIdsInCursor(long userId,
                                      long cursor)

Retrieves a list of up to 5000 IDs for the Twitter users that the given user follows. Supports either application or user authorization.

Parameters:

userId - the user's Twitter ID

cursor - the cursor value to fetch a specific page of entries. Use -1 for the first page of entries.

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFriendIds

CursoredList<Long> getFriendIds(String screenName)

Retrieves a list of up to 5000 IDs for the Twitter users that the given user follows. Supports either application or user authorization.

Parameters:

screenName - the user's Twitter screen name

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFriendIdsInCursor

CursoredList<Long> getFriendIdsInCursor(String screenName,
                                      long cursor)

Retrieves a list of up to 5000 IDs for the Twitter users that the given user follows. Supports either application or user authorization.

Parameters:

screenName - the user's Twitter screen name

cursor - the cursor value to fetch a specific page of entries. Use -1 for the first page of entries.

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFollowers

CursoredList<TwitterProfile> getFollowers()

Retrieves a list of up to 5000 users that the authenticated user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers). If all you need is the follower IDs, consider calling getFollowerIds() instead. Or if you need only a subset of the user's followers, call UserOperations.getUsers() passing in the list of follower IDs you need.

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFollowersInCursor

CursoredList<TwitterProfile> getFollowersInCursor(long cursor)

Retrieves a list of up to 5000 users that the authenticated user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers). If all you need is the follower IDs, consider calling getFollowerIds() instead. Or if you need only a subset of the user's followers, call UserOperations.getUsers() passing in the list of follower IDs you need.

Parameters:

cursor - the cursor used to fetch the follower IDs

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFollowers

CursoredList<TwitterProfile> getFollowers(long userId)

Retrieves a list of up to 5000 users that the given user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers). If all you need is the follower IDs, consider calling getFollowerIds() instead. Or if you need only a subset of the user's followers, call UserOperations.getUsers() passing in the list of follower IDs you need. Supports either application or user authorization.

Parameters:

userId - The user's Twitter ID

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFollowersInCursor

CursoredList<TwitterProfile> getFollowersInCursor(long userId,
                                                long cursor)

Retrieves a list of up to 5000 users that the given user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers). If all you need is the follower IDs, consider calling getFollowerIds() instead. Or if you need only a subset of the user's followers, call UserOperations.getUsers() passing in the list of follower IDs you need. Supports either application or user authorization.

Parameters:

userId - The user's Twitter ID

cursor - the cursor used to fetch the follower IDs

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFollowers

CursoredList<TwitterProfile> getFollowers(String screenName)

Retrieves a list of up to 5000 users that the given user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers). If all you need is the follower IDs, consider calling getFollowerIds() instead. Or if you need only a subset of the user's followers, call UserOperations.getUsers() passing in the list of follower IDs you need. Supports either application or user authorization.

Parameters:

screenName - The user's Twitter screen name

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFollowersInCursor

CursoredList<TwitterProfile> getFollowersInCursor(String screenName,
                                                long cursor)

Retrieves a list of up to 5000 users that the given user is being followed by Note that this method make multiple calls to Twitter's REST API (one call to get a list of the follower IDs and one call for every 100 followers). If all you need is the follower IDs, consider calling getFollowerIds() instead. Or if you need only a subset of the user's followers, call UserOperations.getUsers() passing in the list of follower IDs you need. Supports either application or user authorization.

Parameters:

screenName - The user's Twitter screen name

cursor - the cursor used to fetch the follower IDs

Returns:

a list of TwitterProfiles

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFollowerIds

CursoredList<Long> getFollowerIds()

Retrieves a list of up to 5000 IDs for the Twitter users that follow the authenticated user.

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFollowerIdsInCursor

CursoredList<Long> getFollowerIdsInCursor(long cursor)

Retrieves a list of up to 5000 IDs for the Twitter users that follow the authenticated user.

Parameters:

cursor - the cursor value to fetch a specific page of entries. Use -1 for the first page of entries.

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getFollowerIds

CursoredList<Long> getFollowerIds(long userId)

Retrieves a list of up to 5000IDs for the Twitter users that follow the given user. Supports either application or user authorization.

Parameters:

userId - the user's Twitter ID

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFollowerIdsInCursor

CursoredList<Long> getFollowerIdsInCursor(long userId,
                                        long cursor)

Retrieves a list of up to 5000IDs for the Twitter users that follow the given user. Supports either application or user authorization.

Parameters:

userId - the user's Twitter ID

cursor - the cursor value to fetch a specific page of entries. Use -1 for the first page of entries.

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFollowerIds

CursoredList<Long> getFollowerIds(String screenName)

Retrieves a list of up to 5000 IDs for the Twitter users that follow the given user. Supports either application or user authorization.

Parameters:

screenName - the user's Twitter screen name

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

getFollowerIdsInCursor

CursoredList<Long> getFollowerIdsInCursor(String screenName,
                                        long cursor)

Retrieves a list of up to 5000 IDs for the Twitter users that follow the given user. Supports either application or user authorization.

Parameters:

screenName - the user's Twitter screen name

cursor - the cursor value to fetch a specific page of entries. Use -1 for the first page of entries.

Returns:

a list of user IDs

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials or an application access token.

follow

String follow(long userId)

Allows the authenticated user to follow (create a friendship) with another user.

Parameters:

userId - The Twitter ID of the user to follow

Returns:

the name of the followed user if successful

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

follow

String follow(String screenName)

Allows the authenticated user to follow (create a friendship) with another user.

Parameters:

screenName - The screen name of the user to follow

Returns:

the name of the followed user if successful

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

unfollow

String unfollow(long userId)

Allows the authenticated use to unfollow (destroy a friendship) with another user

Parameters:

userId - the Twitter ID of the user to unfollow

Returns:

the name of the unfolloed user if successful

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

unfollow

String unfollow(String screenName)

Allows the authenticated use to unfollow (destroy a friendship) with another user

Parameters:

screenName - the screen name of the user to unfollow

Returns:

the name of the unfolloed user if successful

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

enableNotifications

TwitterProfile enableNotifications(long userId)

Enable mobile device notifications from Twitter for the specified user.

Parameters:

userId - the Twitter ID of the user to receive notifications for.

Returns:

the TwitterProfile for the user

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

enableNotifications

TwitterProfile enableNotifications(String screenName)

Enable mobile device notifications from Twitter for the specified user.

Parameters:

screenName - the Twitter screen name of the user to receive notifications for.

Returns:

the TwitterProfile for the user

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

disableNotifications

TwitterProfile disableNotifications(long userId)

Disable mobile device notifications from Twitter for the specified user.

Parameters:

userId - the Twitter ID of the user to stop notifications for.

Returns:

the TwitterProfile for the user

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

disableNotifications

TwitterProfile disableNotifications(String screenName)

Disable mobile device notifications from Twitter for the specified user.

Parameters:

screenName - the Twitter screen name of the user to stop notifications for.

Returns:

the TwitterProfile for the user

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getIncomingFriendships

CursoredList<Long> getIncomingFriendships()

Returns:

an array of numeric IDs for every user who has a pending request to follow the authenticating user.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getIncomingFriendships

CursoredList<Long> getIncomingFriendships(long cursor)

Parameters:

cursor - the cursor of the page to retrieve.

Returns:

an array of numeric IDs for every user who has a pending request to follow the authenticating user.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getOutgoingFriendships

CursoredList<Long> getOutgoingFriendships()

Returns:

an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getOutgoingFriendships

CursoredList<Long> getOutgoingFriendships(long cursor)

Parameters:

cursor - the cursor of the page to retrieve.

Returns:

an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Twitter.

org.springframework.social.MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.