ListOperations (Spring Social Twitter 1.1.0.RELEASE API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.social.twitter.api
Interface ListOperations

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

getLists

List<UserList> getLists()

Retrieves user lists for the authenticated user.

Returns:: a list of UserLists for the authenticated 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.

getLists

List<UserList> getLists(long userId)

Retrieves user lists for a given user. Supports either user or application authorization.

Parameters:: userId - the ID of the Twitter user.
Returns:: a list of UserLists for the specified 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 or an application access token.

getLists

List<UserList> getLists(String screenName)

Retrieves user lists for a given user. Supports either user or application authorization.

Parameters:: screenName - the screen name of the Twitter user.
Returns:: a list of UserLists for the specified 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 or an application access token.

getList

UserList getList(long listId)

Retrieves a specific user list.

Parameters:: listId - the ID of the list to retrieve.
Returns:: the requested UserList
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.

getList

UserList getList(String screenName,
                 String listSlug)

Retrieves a specific user list. Supports either user or application authorization.

Parameters:: screenName - the screen name of the list owner.; listSlug - the lists's slug
Returns:: the requested UserList
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.