|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ListOperations
Interface defining the operations for working with a user's lists.
Method Summary | |
---|---|
UserList |
addToList(long listId,
long... newMemberIds)
Adds one or more new members to a user list. |
UserList |
addToList(long listId,
String... newMemberScreenNames)
Adds one or more new members to a user list. |
UserList |
createList(String name,
String description,
boolean isPublic)
Create a new user list |
void |
deleteList(long listId)
Removes a user list. |
UserList |
getList(long listId)
Retrieves a specific user list. |
UserList |
getList(String screenName,
String listSlug)
Retrieves a specific user list. |
CursoredList<TwitterProfile> |
getListMembers(long listId)
Retrieves a list of Twitter profiles whose users are members of the list. |
CursoredList<TwitterProfile> |
getListMembers(String screenName,
String listSlug)
Retrieves a list of Twitter profiles whose users are members of the list. |
CursoredList<TwitterProfile> |
getListMembersInCursor(long listId,
long cursor)
Retrieves a list of Twitter profiles whose users are members of the list. |
CursoredList<TwitterProfile> |
getListMembersInCursor(String screenName,
String listSlug,
long cursor)
Retrieves a list of Twitter profiles whose users are members of the list. |
List<UserList> |
getLists()
Retrieves user lists for the authenticated user. |
List<UserList> |
getLists(long userId)
Retrieves user lists for a given user. |
List<UserList> |
getLists(String screenName)
Retrieves user lists for a given user. |
List<Tweet> |
getListStatuses(long listId)
Retrieves the timeline tweets for the given user list. |
List<Tweet> |
getListStatuses(long listId,
int pageSize)
Retrieves the timeline tweets for the given user list. |
List<Tweet> |
getListStatuses(long listId,
int pageSize,
long sinceId,
long maxId)
Retrieves the timeline tweets for the given user list. |
List<Tweet> |
getListStatuses(String screenName,
String listSlug)
Retrieves the timeline tweets for the given user list. |
List<Tweet> |
getListStatuses(String screenName,
String listSlug,
int pageSize)
Retrieves the timeline tweets for the given user list. |
List<Tweet> |
getListStatuses(String screenName,
String listSlug,
int pageSize,
long sinceId,
long maxId)
Retrieves the timeline tweets for the given user list. |
List<TwitterProfile> |
getListSubscribers(long listId)
Retrieves the subscribers to a list. |
List<TwitterProfile> |
getListSubscribers(String screenName,
String listSlug)
Retrieves the subscribers to a list. |
CursoredList<UserList> |
getMemberships(long userId)
Retrieves the lists that a given user is a member of. |
CursoredList<UserList> |
getMemberships(String screenName)
Retrieves the lists that a given user is a member of. |
CursoredList<UserList> |
getMembershipsInCursor(long userId,
long cursor)
Retrieves the lists that a given user is a member of. |
CursoredList<UserList> |
getMembershipsInCursor(String screenName,
long cursor)
Retrieves the lists that a given user is a member of. |
CursoredList<UserList> |
getSubscriptions(long userId)
Retrieves the lists that a given user is subscribed to. |
CursoredList<UserList> |
getSubscriptions(String screenName)
Retrieves the lists that a given user is subscribed to. |
CursoredList<UserList> |
getSubscriptionsInCursor(long userId,
long cursor)
Retrieves the lists that a given user is subscribed to. |
CursoredList<UserList> |
getSubscriptionsInCursor(String screenName,
long cursor)
Retrieves the lists that a given user is subscribed to. |
boolean |
isMember(long listId,
long memberId)
Checks to see if a given user is a member of a given list. |
boolean |
isMember(String screenName,
String listSlug,
String memberScreenName)
Checks to see if a given user is a member of a given list. |
boolean |
isSubscriber(long listId,
long subscriberId)
Checks to see if a given user subscribes to a given list. |
boolean |
isSubscriber(String screenName,
String listSlug,
String subscriberScreenName)
Checks to see if a given user subscribes to a given list. |
void |
removeFromList(long listId,
long memberId)
Removes a member from a user list. |
void |
removeFromList(long listId,
String memberScreenName)
Removes a member from a user list. |
UserList |
subscribe(long listId)
Subscribes the authenticating user to a list. |
UserList |
subscribe(String screenName,
String listSlug)
Subscribes the authenticating user to a list. |
UserList |
unsubscribe(long listId)
Unsubscribes the authenticating user from a list. |
UserList |
unsubscribe(String screenName,
String listSlug)
Unsubscribes the authenticating user from a list. |
UserList |
updateList(long listId,
String name,
String description,
boolean isPublic)
Updates an existing user list |
Method Detail |
---|
List<UserList> getLists()
UserList
s for the authenticated user.
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.List<UserList> getLists(long userId)
userId
- the ID of the Twitter user.
UserList
s for the specified user.
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.List<UserList> getLists(String screenName)
screenName
- the screen name of the Twitter user.
UserList
s for the specified user.
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.UserList getList(long listId)
listId
- the ID of the list to retrieve.
UserList
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.UserList getList(String screenName, String listSlug)
screenName
- the screen name of the list owner.listSlug
- the lists's slug
UserList
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.List<Tweet> getListStatuses(long listId)
listId
- the ID of the list to retrieve.
Tweet
objects for the items in the user list timeline.
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.List<Tweet> getListStatuses(long listId, int pageSize)
listId
- the ID of the list to retrieve.pageSize
- The number of Tweet
s per page.
Tweet
objects for the items in the user list timeline.
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.List<Tweet> getListStatuses(long listId, int pageSize, long sinceId, long maxId)
listId
- the ID of the list to retrieve.pageSize
- The number of Tweet
s per page.sinceId
- The minimum Tweet
ID to return in the resultsmaxId
- The maximum Tweet
ID to return in the results
Tweet
objects for the items in the user list timeline.
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.List<Tweet> getListStatuses(String screenName, String listSlug)
screenName
- the screen name of the Twitter user.listSlug
- the list's slug.
Tweet
objects for the items in the user list timeline.
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.List<Tweet> getListStatuses(String screenName, String listSlug, int pageSize)
screenName
- the screen name of the Twitter user.listSlug
- the list's slug.pageSize
- The number of Tweet
s per page.
Tweet
objects for the items in the user list timeline.
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.List<Tweet> getListStatuses(String screenName, String listSlug, int pageSize, long sinceId, long maxId)
screenName
- the screen name of the Twitter user.listSlug
- the list's slug.pageSize
- The number of Tweet
s per page.sinceId
- The minimum Tweet
ID to return in the resultsmaxId
- The maximum Tweet
ID to return in the results
Tweet
objects for the items in the user list timeline.
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.UserList createList(String name, String description, boolean isPublic)
name
- the name of the list.description
- the list description.isPublic
- if true, the list will be public; if false the list will be private.
UserList
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.UserList updateList(long listId, String name, String description, boolean isPublic)
listId
- the ID of the listname
- the new name of the list.description
- the new list description.isPublic
- if true, the list will be public; if false the list will be private.
UserList
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.void deleteList(long listId)
listId
- the ID of the list to be removed.
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.CursoredList<TwitterProfile> getListMembers(long listId)
listId
- the ID of the list.
TwitterProfile
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.CursoredList<TwitterProfile> getListMembersInCursor(long listId, long cursor)
listId
- the ID of the list.cursor
- the cursor to use when fetching the list members.
TwitterProfile
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.CursoredList<TwitterProfile> getListMembers(String screenName, String listSlug)
screenName
- the screen name of the list owner.listSlug
- the slug of the list.
TwitterProfile
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.CursoredList<TwitterProfile> getListMembersInCursor(String screenName, String listSlug, long cursor)
screenName
- the screen name of the list owner.listSlug
- the slug of the list.cursor
- the cursor to use when fetching the list members.
TwitterProfile
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.UserList addToList(long listId, long... newMemberIds)
listId
- the ID of the list.newMemberIds
- one or more profile IDs of the Twitter profiles to add to the list.
UserList
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.UserList addToList(long listId, String... newMemberScreenNames)
listId
- the ID of the list.newMemberScreenNames
- one or more profile IDs of the Twitter profiles to add to the list.
UserList
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.void removeFromList(long listId, long memberId)
listId
- the ID of the list.memberId
- the ID of the member to be removed.
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.void removeFromList(long listId, String memberScreenName)
listId
- the ID of the list.memberScreenName
- the ID of the member to be removed.
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.UserList subscribe(long listId)
listId
- the ID of the list.
UserList
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.UserList subscribe(String screenName, String listSlug)
screenName
- the screen name of the list owner.listSlug
- the slug of the list.
UserList
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.UserList unsubscribe(long listId)
listId
- the ID of the list.
UserList
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.UserList unsubscribe(String screenName, String listSlug)
screenName
- the screen name of the list owner.listSlug
- the slug of the list.
UserList
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.List<TwitterProfile> getListSubscribers(long listId)
listId
- the ID of the list.
TwitterProfile
s for the list's subscribers.
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.List<TwitterProfile> getListSubscribers(String screenName, String listSlug)
screenName
- the screen name of the list owner.listSlug
- the slug of the list.
TwitterProfile
s for the list's subscribers.
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.CursoredList<UserList> getMemberships(long userId)
userId
- the user ID
UserList
s that the user is a member of.
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.CursoredList<UserList> getMemberships(String screenName)
screenName
- the user's screen name
UserList
s that the user is a member of.
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.CursoredList<UserList> getMembershipsInCursor(long userId, long cursor)
userId
- the user IDcursor
- the cursor to use when fetching the list memberships.
UserList
s that the user is a member of.
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.CursoredList<UserList> getMembershipsInCursor(String screenName, long cursor)
screenName
- the user's screen namecursor
- the cursor to use when fetching the list memberships.
UserList
s that the user is a member of.
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.CursoredList<UserList> getSubscriptions(long userId)
userId
- the user ID
UserList
s that the user is subscribed to.
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.CursoredList<UserList> getSubscriptions(String screenName)
screenName
- the user's screen name
UserList
s that the user is subscribed to.
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.CursoredList<UserList> getSubscriptionsInCursor(long userId, long cursor)
userId
- the user IDcursor
- the cursor to use when fetching the list subscriptions.
UserList
s that the user is subscribed to.
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.CursoredList<UserList> getSubscriptionsInCursor(String screenName, long cursor)
screenName
- the user's screen namecursor
- the cursor to use when fetching the list subscriptions.
UserList
s that the user is subscribed to.
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.boolean isMember(long listId, long memberId)
listId
- the list IDmemberId
- the user ID to check for membership
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.boolean isMember(String screenName, String listSlug, String memberScreenName)
screenName
- the screen name of the list's ownerlistSlug
- the list's slugmemberScreenName
- the screenName to check for membership
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.boolean isSubscriber(long listId, long subscriberId)
listId
- the list IDsubscriberId
- the user ID to check for subscribership
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.boolean isSubscriber(String screenName, String listSlug, String subscriberScreenName)
screenName
- the screen name of the list's ownerlistSlug
- the list's slugsubscriberScreenName
- the screenName to check for subscribership
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |