twitter4j.api
Interface ListSubscribersMethodsAsync

All Known Subinterfaces:
AsyncTwitter
All Known Implementing Classes:
AsyncTwitterImpl

public interface ListSubscribersMethodsAsync

Author:
Joern Huxhorn - jhuxhorn at googlemail.com

Method Summary
 void checkUserListSubscription(java.lang.String listOwnerScreenName, int listId, long userId)
          Check if the specified user is a subscriber of the specified list.
 void getUserListSubscribers(java.lang.String listOwnerScreenName, int listId, long cursor)
          Returns the subscribers of the specified list.
 void subscribeUserList(java.lang.String listOwnerScreenName, int listId)
          Make the authenticated user follow the specified list.
 void unsubscribeUserList(java.lang.String listOwnerScreenName, int listId)
          Unsubscribes the authenticated user form the specified list.
 

Method Detail

getUserListSubscribers

void getUserListSubscribers(java.lang.String listOwnerScreenName,
                            int listId,
                            long cursor)
Returns the subscribers of the specified list.
This method calls http://api.twitter.com/1/:user/:list_id/subscribers.json

Parameters:
listOwnerScreenName - The screen name of the list owner
listId - The id of the list
cursor - Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
Since:
Twitter4J 2.1.1
See Also:
GET :user/:list_id/subscribers | dev.twitter.com

subscribeUserList

void subscribeUserList(java.lang.String listOwnerScreenName,
                       int listId)
Make the authenticated user follow the specified list.
This method calls http://api.twitter.com/1/:listOwner/:listId/subscribers.json

Parameters:
listOwnerScreenName - The screen name of the list owner
listId - The id of the list.
Since:
Twitter4J 2.1.1
See Also:
POST :user/:list_id/subscribers | dev.twitter.com

unsubscribeUserList

void unsubscribeUserList(java.lang.String listOwnerScreenName,
                         int listId)
Unsubscribes the authenticated user form the specified list.
This method calls http://api.twitter.com/1/:listOwner/:listId/subscribers.json

Parameters:
listOwnerScreenName - The screen name of the list owner
listId - The id of the list.
Since:
Twitter4J 2.1.1
See Also:
DELETE :user/:list_id/subscribers | dev.twitter.com

checkUserListSubscription

void checkUserListSubscription(java.lang.String listOwnerScreenName,
                               int listId,
                               long userId)
Check if the specified user is a subscriber of the specified list.
This method calls http://api.twitter.com/1/:listOwner/:listId/subscribers/:userId.json

Parameters:
listOwnerScreenName - The screen name of the list owner
listId - The id of the list.
userId - The id of the user who you want to know is a member or not of the specified list. , or the user is not a member of the specified list(TwitterException.getStatusCode() returns 404 in that case.)
Since:
Twitter4J 2.1.1
See Also:
GET :user/:list_id/subscribers/:id | dev.twitter.com