twitter4j.api

Interface ListMethodsAsync

All Known Subinterfaces:

AsyncTwitter

All Known Implementing Classes:

AsyncTwitterImpl

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	getAllSubscribingUserLists(long userId) Returns all lists the authenticating or specified user subscribes to, including their own.
void	getAllSubscribingUserLists(java.lang.String screenName) Returns all lists the authenticating or specified user subscribes to, including their own.
void	getUserListMemberships(long cursor) List the lists the authenticating user has been added to.
void	getUserListMemberships(long listMemberId, long cursor) List the lists the specified user has been added to.
void	getUserListMemberships(long listMemberId, long cursor, boolean filterToOwnedLists) List the lists the specified user has been added to.
void	getUserListMemberships(java.lang.String listMemberScreenName, long cursor) List the lists the specified user has been added to.
void	getUserListMemberships(java.lang.String listMemberScreenName, long cursor, boolean filterToOwnedLists) List the lists the specified user has been added to.
void	getUserLists(long listOwnerUserId, long cursor) List the lists of the specified user.
void	getUserLists(java.lang.String listOwnerScreenName, long cursor) List the lists of the specified user.
void	getUserListStatuses(int listId, Paging paging) Show tweet timeline for members of the specified list.
void	getUserListStatuses(long listOwnerId, int id, Paging paging) Deprecated. use getUserListStatuses(int, twitter4j.Paging) instead
void	getUserListStatuses(java.lang.String listOwnerScreenName, int id, Paging paging) Deprecated. use getUserListStatuses(int, twitter4j.Paging) instead
void	getUserListSubscriptions(java.lang.String listOwnerScreenName, long cursor) List the lists the specified user follows.
void	showUserList(int listId) Show the specified list.
void	showUserList(java.lang.String listOwnerScreenName, int id) Deprecated. use showUserList(int) instead
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/lists/create.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 lists/create | Twitter Developers

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/lists/update.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 lists/update | Twitter Developers

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/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 lists | Twitter Developers

getUserLists

void getUserLists(long listOwnerUserId,
                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/lists.json

Parameters:

listOwnerUserId - The id 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.2.3

See Also:

GET lists | Twitter Developers

showUserList

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

Deprecated. use showUserList(int) instead

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/lists/show.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 | Twitter Developers

showUserList

void showUserList(int listId)

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/lists/show.json

Parameters:

listId - The id of the list to show

Since:

Twitter4J 2.2.3

See Also:

https://dev.twitter.com/docs/api/1/get/lists/show | Twitter Developers

destroyUserList

void destroyUserList(int listId)

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

Parameters:

listId - The id of the list to delete

Since:

Twitter4J 2.1.1

See Also:

POST lists/destroy | Twitter Developers

getUserListStatuses

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

Deprecated. use getUserListStatuses(int, twitter4j.Paging) instead

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 lists/statuses | Twitter Developers

getUserListStatuses

void getUserListStatuses(long listOwnerId,
                       int id,
                       Paging paging)

Deprecated. use getUserListStatuses(int, twitter4j.Paging) instead

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

Parameters:

listOwnerId - 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 lists/statuses | Twitter Developers

getUserListStatuses

void getUserListStatuses(int listId,
                       Paging paging)

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

Parameters:

listId - The id of the list

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

Since:

Twitter4J 2.2.3

See Also:

GET lists/statuses | Twitter Developers

getUserListMemberships

void getUserListMemberships(long cursor)

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

Parameters:

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.2.4

See Also:

GET lists/memberships | Twitter Developers

getUserListMemberships

void getUserListMemberships(long listMemberId,
                          long cursor)

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

Parameters:

listMemberId - The id 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.2.4

See Also:

GET lists/memberships | Twitter Developers

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/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 lists/memberships | Twitter Developers

getUserListMemberships

void getUserListMemberships(long listMemberId,
                          long cursor,
                          boolean filterToOwnedLists)

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

Parameters:

listMemberId - The id 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.

filterToOwnedLists - Whether to return just lists the authenticating user owns, and the user represented by listMemberScreenName is a member of.

Since:

Twitter4J 2.2.4

See Also:

GET lists/memberships | Twitter Developers

getUserListMemberships

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

List the lists the specified user has been added to.
This method calls http://api.twitter.com/1/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.

filterToOwnedLists - Whether to return just lists the authenticating user owns, and the user represented by listMemberScreenName is a member of.

Since:

Twitter4J 2.2.4

See Also:

GET lists/memberships | Twitter Developers

getUserListSubscriptions

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

List the lists the specified user follows.
This method calls http://api.twitter.com/1/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 lists/subscriptions | Twitter Developers

getAllSubscribingUserLists

void getAllSubscribingUserLists(java.lang.String screenName)

Returns all lists the authenticating or specified user subscribes to, including their own.
This method has not been finalized and the interface is subject to change in incompatible ways.
This method calls http://api.twitter.com/1/lists/all.json

Parameters:

screenName - screen name to look up

Since:

Twitter4J 2.1.9

getAllSubscribingUserLists

void getAllSubscribingUserLists(long userId)

Returns all lists the authenticating or specified user subscribes to, including their own.
This method has not been finalized and the interface is subject to change in incompatible ways.
This method calls http://api.twitter.com/1/lists/all.json

Parameters:

userId - user id to look up

Since:

Twitter4J 2.1.9