twitter4j.api

Interface ListMethodsAsync

All Known Implementing Classes:

AsyncTwitter

public interface ListMethodsAsync

Author:

Joern Huxhorn - jhuxhorn at googlemail.com

Method Summary

Methods

Modifier and Type	Method and Description
void	createUserList(java.lang.String listName, boolean isPublicList, java.lang.String description) Creates a new list for the authenticated user.
void	destroyUserList(int listId) Deletes the specified list.
void	getUserListMemberships(java.lang.String listMemberScreenName, long cursor) List the lists the specified user has been added to.
void	getUserLists(java.lang.String listOwnerScreenName, long cursor) List the lists of the specified user.
void	getUserListStatuses(java.lang.String listOwnerScreenName, int id, Paging paging) Show tweet timeline for members of the specified list.
void	getUserListSubscriptions(java.lang.String listOwnerScreenName, long cursor) List the lists the specified user follows.
void	showUserList(java.lang.String listOwnerScreenName, int id) Show the specified list.
void	updateUserList(int listId, java.lang.String newListName, boolean isPublicList, java.lang.String newDescription) Updates the specified list.

Method Detail

createUserList

void createUserList(java.lang.String listName,
                  boolean isPublicList,
                  java.lang.String description)

Creates a new list for the authenticated user. Accounts are limited to 20 lists.
This method calls http://api.twitter.com/1/user/lists.json

Parameters:

listName - The name of the list you are creating. Required.

isPublicList - set true if you wish to make a public list

description - The description of the list you are creating. Optional.

Since:

Twitter4J 2.1.1

See Also:

POST :user/lists | dev.twitter.com

updateUserList

void updateUserList(int listId,
                  java.lang.String newListName,
                  boolean isPublicList,
                  java.lang.String newDescription)

Updates the specified list.
This method calls http://api.twitter.com/1/:user/lists/:id.json

Parameters:

listId - The id of the list to update.

newListName - What you'd like to change the list's name to.

isPublicList - Whether your list is public or private. Optional. Values can be public or private. Lists are public by default if no mode is specified.

newDescription - What you'd like to change the list description to.

Since:

Twitter4J 2.1.1

See Also:

POST :user/lists/:id | dev.twitter.com

getUserLists

void getUserLists(java.lang.String listOwnerScreenName,
                long cursor)

List the lists of the specified user. Private lists will be included if the authenticated users is the same as the user whose lists are being returned.
This method calls http://api.twitter.com/1/:user/lists.json

Parameters:

listOwnerScreenName - The screen name of the list owner

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/lists | dev.twitter.com

showUserList

void showUserList(java.lang.String listOwnerScreenName,
                int id)

Show the specified list. Private lists will only be shown if the authenticated user owns the specified list.
This method calls http://api.twitter.com/1/:user/lists/:id.json

Parameters:

listOwnerScreenName - The screen name of the list owner

id - The id of the list to show

Since:

Twitter4J 2.1.1

See Also:

GET :user/lists/:id | dev.twitter.com

destroyUserList

void destroyUserList(int listId)

Deletes the specified list. Must be owned by the authenticated user.
This method calls http://api.twitter.com/1/:user/lists/:id.json

Parameters:

listId - The id of the list to delete

Since:

Twitter4J 2.1.1

See Also:

DELETE :user/lists/:id | dev.twitter.com

getUserListStatuses

void getUserListStatuses(java.lang.String listOwnerScreenName,
                       int id,
                       Paging paging)

Show tweet timeline for members of the specified list.
http://api.twitter.com/1/user/lists/list_id/statuses.json

Parameters:

listOwnerScreenName - The screen name of the list owner

id - The id of the list to delete

paging - controls pagination. Supports since_id, max_id, count and page parameters.

Since:

Twitter4J 2.1.1

See Also:

GET :user/lists/:id/statuses | dev.twitter.com

getUserListMemberships

void getUserListMemberships(java.lang.String listMemberScreenName,
                          long cursor)

List the lists the specified user has been added to.
This method calls http://api.twitter.com/1/:user/lists/memberships.json

Parameters:

listMemberScreenName - The screen name of the list member

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/lists/memberships | dev.twitter.com

getUserListSubscriptions

void getUserListSubscriptions(java.lang.String listOwnerScreenName,
                            long cursor)

List the lists the specified user follows.
This method calls http://api.twitter.com/1/[user]/lists/subscriptions.json

Parameters:

listOwnerScreenName - The screen name of the list owner

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/lists/subscriptions | dev.twitter.com