org.agorava.twitter

Interface TwitterUserService

All Superinterfaces:

org.agorava.spi.UserProfileService

public interface TwitterUserService
extends org.agorava.spi.UserProfileService

Interface defining the operations for retrieving information about Twitter users.

Author:

Craig Walls, Antoine Sabot-Durand, Werner Keil

Method Summary

Methods

Modifier and Type	Method and Description
String	getProfileId() Retrieves the authenticated user's Twitter ID.
RateLimitStatus	getRateLimitStatus() Retrieves the rate limit status.
String	getScreenName() Retrieves the authenticated user's Twitter screen name
List<SuggestionCategory>	getSuggestionCategories() Retrieves a list of categories from which suggested users to follow may be found.
List<TwitterProfile>	getSuggestions(String slug) Retrieves a list of suggestions of users to follow for a given category.
TwitterProfile	getUserProfile() Retrieves the authenticated user's Twitter profile details.
TwitterProfile	getUserProfile(long userId) Retrieves a specific user's Twitter profile details.
TwitterProfile	getUserProfile(String screenName) Retrieves a specific user's Twitter profile details.
byte[]	getUserProfileImage(String screenName) Retrieves the user's profile image.
byte[]	getUserProfileImage(String screenName, ImageSize size) Retrieves the user's profile image.
List<TwitterProfile>	getUsers(String... userIds) Retrieves a list of Twitter profiles for the given list of user IDs.
List<TwitterProfile>	getUsersByName(String... screenNames) Retrieves a list of Twitter profiles for the given list of screen names.
List<TwitterProfile>	searchForUsers(String query) Searches for up to 20 users that match a given query.
List<TwitterProfile>	searchForUsers(String query, int page, int pageSize) Searches for users that match a given query.

Method Detail

getProfileId

String getProfileId()

Retrieves the authenticated user's Twitter ID.

Returns:

the user's ID at Twitter

Throws:

AgoravaException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getScreenName

String getScreenName()

Retrieves the authenticated user's Twitter screen name

Returns:

the user's screen name

Throws:

AgoravaException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getUserProfile

TwitterProfile getUserProfile()

Retrieves the authenticated user's Twitter profile details.

Specified by:

getUserProfile in interface org.agorava.spi.UserProfileService

Returns:

a TwitterProfile object representing the user's profile.

Throws:

AgoravaException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getUserProfile

TwitterProfile getUserProfile(String screenName)

Retrieves a specific user's Twitter profile details. Note that this method does not require authentication.

Parameters:

screenName - the screen name for the user whose details are to be retrieved.

Returns:

a TwitterProfile object representing the user's profile.

Throws:

AgoravaException - if there is an error while communicating with Twitter.

getUserProfile

TwitterProfile getUserProfile(long userId)

Retrieves a specific user's Twitter profile details. Note that this method does not require authentication.

Parameters:

userId - the user ID for the user whose details are to be retrieved.

Returns:

a TwitterProfile object representing the user's profile.

Throws:

AgoravaException - if there is an error while communicating with Twitter.

getUserProfileImage

byte[] getUserProfileImage(String screenName)

Retrieves the user's profile image. Returns the image in Twitter's "normal" size (48px x 48px).

Parameters:

screenName - the screen name of the user

Returns:

an array of bytes containing the user's profile image.

Throws:

AgoravaException - if there is an error while communicating with Twitter.

getUserProfileImage

byte[] getUserProfileImage(String screenName,
                         ImageSize size)

Retrieves the user's profile image. Returns the image in Twitter's "normal" type.

Parameters:

screenName - the screen name of the user

size - the size of the image

Returns:

an array of bytes containing the user's profile image.

Throws:

AgoravaException - if there is an error while communicating with Twitter.

getUsers

List<TwitterProfile> getUsers(String... userIds)

Retrieves a list of Twitter profiles for the given list of user IDs.

Throws:

AgoravaException - if there is an error while communicating with Twitter.

searchForUsers

List<TwitterProfile> searchForUsers(String query)

Searches for up to 20 users that match a given query.

Throws:

AgoravaException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

searchForUsers

List<TwitterProfile> searchForUsers(String query,
                                  int page,
                                  int pageSize)

Searches for users that match a given query.

Parameters:

page - the page of search results to return

pageSize - the number of TwitterProfiles per page. Maximum of 20 per page.

Throws:

AgoravaException - if there is an error while communicating with Twitter.

MissingAuthorizationException - if TwitterTemplate was not created with OAuth credentials.

getSuggestionCategories

List<SuggestionCategory> getSuggestionCategories()

Retrieves a list of categories from which suggested users to follow may be found.

Throws:

AgoravaException - if there is an error while communicating with Twitter.

getSuggestions

List<TwitterProfile> getSuggestions(String slug)

Retrieves a list of suggestions of users to follow for a given category.

Parameters:

slug - the category's slug

Throws:

AgoravaException - if there is an error while communicating with Twitter.

getRateLimitStatus

RateLimitStatus getRateLimitStatus()

Retrieves the rate limit status. Can be used with either either an authorized or unauthorized TwitterTemplate. If the TwitterTemplate is authorized, the rate limits apply to the authenticated user. If the TwitterTemplate is unauthorized, the rate limits apply to the IP address from with the request is made.

getUsersByName

List<TwitterProfile> getUsersByName(String... screenNames)

Retrieves a list of Twitter profiles for the given list of screen names.

Throws:

AgoravaException - if there is an error while communicating with Twitter.