|
Spring Social Twitter | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface UserOperations
Interface defining the operations for retrieving information about Twitter users.
| Method Summary | |
|---|---|
long |
getProfileId()
Retrieves the authenticated user's Twitter ID. |
java.util.Map<ResourceFamily,java.util.List<RateLimitStatus>> |
getRateLimitStatus(ResourceFamily... resources)
Retrieves the rate limit statuses for each of the resource families passed as arguments |
java.lang.String |
getScreenName()
Retrieves the authenticated user's Twitter screen name |
java.util.List<SuggestionCategory> |
getSuggestionCategories()
Retrieves a list of categories from which suggested users to follow may be found. |
java.util.List<TwitterProfile> |
getSuggestions(java.lang.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(java.lang.String screenName)
Retrieves a specific user's Twitter profile details. |
java.util.List<TwitterProfile> |
getUsers(long... userIds)
Retrieves a list of Twitter profiles for the given list of user IDs. |
java.util.List<TwitterProfile> |
getUsers(java.lang.String... screenNames)
Retrieves a list of Twitter profiles for the given list of screen names. |
java.util.List<TwitterProfile> |
searchForUsers(java.lang.String query)
Searches for up to 20 users that match a given query. |
java.util.List<TwitterProfile> |
searchForUsers(java.lang.String query,
int page,
int pageSize)
Searches for users that match a given query. |
| Method Detail |
|---|
long getProfileId()
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.java.lang.String getScreenName()
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.TwitterProfile getUserProfile()
TwitterProfile object representing the user's profile.
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.TwitterProfile getUserProfile(java.lang.String screenName)
screenName - the screen name for the user whose details are to be retrieved.
TwitterProfile object representing the user's profile.
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.TwitterProfile getUserProfile(long userId)
userId - the user ID for the user whose details are to be retrieved.
TwitterProfile object representing the user's profile.
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.java.util.List<TwitterProfile> getUsers(long... userIds)
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.java.util.List<TwitterProfile> getUsers(java.lang.String... screenNames)
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.java.util.List<TwitterProfile> searchForUsers(java.lang.String query)
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.
java.util.List<TwitterProfile> searchForUsers(java.lang.String query,
int page,
int pageSize)
page - the page of search results to returnpageSize - the number of TwitterProfiles per page. Maximum of 20 per page.
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.java.util.List<SuggestionCategory> getSuggestionCategories()
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.java.util.List<TwitterProfile> getSuggestions(java.lang.String slug)
slug - the category's slug
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.java.util.Map<ResourceFamily,java.util.List<RateLimitStatus>> getRateLimitStatus(ResourceFamily... resources)
resources - the list of resource families to inquire about
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.
|
Spring Social Twitter | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||