Package com.twitter.clientlib.api

Class ListsApi

java.lang.Object

com.twitter.clientlib.api.ApiCommon

com.twitter.clientlib.api.ListsApi

public class ListsApi
extends ApiCommon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ListsApi.APIgetUserListMembershipsRequest
class	ListsApi.APIlistAddMemberRequest
class	ListsApi.APIlistIdCreateRequest
class	ListsApi.APIlistIdDeleteRequest
class	ListsApi.APIlistIdGetRequest
class	ListsApi.APIlistIdUpdateRequest
class	ListsApi.APIlistRemoveMemberRequest
class	ListsApi.APIlistUserFollowRequest
class	ListsApi.APIlistUserOwnedListsRequest
class	ListsApi.APIlistUserPinnedListsRequest
class	ListsApi.APIlistUserPinRequest
class	ListsApi.APIlistUserUnfollowRequest
class	ListsApi.APIlistUserUnpinRequest
class	ListsApi.APIuserFollowedListsRequest

Field Summary

Fields inherited from class com.twitter.clientlib.api.ApiCommon

localVarApiClient

Constructor Summary

Constructors

Constructor	Description
ListsApi()

Method Summary

Modifier and Type	Method	Description
ListsApi.APIgetUserListMembershipsRequest	getUserListMemberships(String id)	Get a User's List Memberships Get a User's List Memberships.
ListsApi.APIlistAddMemberRequest	listAddMember(String id)	Add a List member Causes a User to become a member of a List.
ListsApi.APIlistIdCreateRequest	listIdCreate()	Create List Creates a new List.
ListsApi.APIlistIdDeleteRequest	listIdDelete(String id)	Delete List Delete a List that you own.
ListsApi.APIlistIdGetRequest	listIdGet(String id)	List lookup by List ID.
ListsApi.APIlistIdUpdateRequest	listIdUpdate(String id)	Update List.
ListsApi.APIlistRemoveMemberRequest	listRemoveMember(String id, String userId)	Remove a List member Causes a User to be removed from the members of a List.
ListsApi.APIlistUserFollowRequest	listUserFollow(String id)	Follow a List Causes a User to follow a List.
ListsApi.APIlistUserOwnedListsRequest	listUserOwnedLists(String id)	Get a User's Owned Lists.
ListsApi.APIlistUserPinRequest	listUserPin(ListPinnedRequest listPinnedRequest, String id)	Pin a List Causes a User to pin a List.
ListsApi.APIlistUserPinnedListsRequest	listUserPinnedLists(String id)	Get a User's Pinned Lists Get a User's Pinned Lists.
ListsApi.APIlistUserUnfollowRequest	listUserUnfollow(String id, String listId)	Unfollow a List Causes a User to unfollow a List.
ListsApi.APIlistUserUnpinRequest	listUserUnpin(String id, String listId)	Unpin a List Causes a User to remove a pinned List.
ListsApi.APIuserFollowedListsRequest	userFollowedLists(String id)	Get User's Followed Lists Returns a User's followed Lists.

Methods inherited from class com.twitter.clientlib.api.ApiCommon

handleRateLimit, reduceAuthNames, setClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListsApi

public ListsApi()

Method Detail

getUserListMemberships

public ListsApi.APIgetUserListMembershipsRequest getUserListMemberships(String id)

Get a User's List Memberships Get a User's List Memberships.

Parameters:

id - The ID of the User to lookup. (required)

Returns:

APIgetUserListMembershipsRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listAddMember

public ListsApi.APIlistAddMemberRequest listAddMember(String id)

Add a List member Causes a User to become a member of a List.

Parameters:

id - The ID of the List for which to add a member. (required)

Returns:

APIlistAddMemberRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listIdCreate

public ListsApi.APIlistIdCreateRequest listIdCreate()

Create List Creates a new List.

Returns:

APIlistIdCreateRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listIdDelete

public ListsApi.APIlistIdDeleteRequest listIdDelete(String id)

Delete List Delete a List that you own.

Parameters:

id - The ID of the List to delete. (required)

Returns:

APIlistIdDeleteRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listIdGet

public ListsApi.APIlistIdGetRequest listIdGet(String id)

List lookup by List ID. Returns a List.

Parameters:

id - The ID of the List. (required)

Returns:

APIlistIdGetRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listIdUpdate

public ListsApi.APIlistIdUpdateRequest listIdUpdate(String id)

Update List. Update a List that you own.

Parameters:

id - The ID of the List to modify. (required)

Returns:

APIlistIdUpdateRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listRemoveMember

public ListsApi.APIlistRemoveMemberRequest listRemoveMember(String id,
                                                            String userId)

Remove a List member Causes a User to be removed from the members of a List.

Parameters:

id - The ID of the List to remove a member. (required)

userId - The ID of User that will be removed from the List. (required)

Returns:

APIlistRemoveMemberRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listUserFollow

public ListsApi.APIlistUserFollowRequest listUserFollow(String id)

Follow a List Causes a User to follow a List.

Parameters:

id - The ID of the authenticated source User that will follow the List. (required)

Returns:

APIlistUserFollowRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listUserOwnedLists

public ListsApi.APIlistUserOwnedListsRequest listUserOwnedLists(String id)

Get a User's Owned Lists. Get a User's Owned Lists.

Parameters:

id - The ID of the User to lookup. (required)

Returns:

APIlistUserOwnedListsRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listUserPin

public ListsApi.APIlistUserPinRequest listUserPin(ListPinnedRequest listPinnedRequest,
                                                  String id)

Pin a List Causes a User to pin a List.

Parameters:

listPinnedRequest - (required)

id - The ID of the authenticated source User that will pin the List. (required)

Returns:

APIlistUserPinRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listUserPinnedLists

public ListsApi.APIlistUserPinnedListsRequest listUserPinnedLists(String id)

Get a User's Pinned Lists Get a User's Pinned Lists.

Parameters:

id - The ID of the authenticated source User for whom to return results. (required)

Returns:

APIlistUserPinnedListsRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listUserUnfollow

public ListsApi.APIlistUserUnfollowRequest listUserUnfollow(String id,
                                                            String listId)

Unfollow a List Causes a User to unfollow a List.

Parameters:

id - The ID of the authenticated source User that will unfollow the List. (required)

listId - The ID of the List to unfollow. (required)

Returns:

APIlistUserUnfollowRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listUserUnpin

public ListsApi.APIlistUserUnpinRequest listUserUnpin(String id,
                                                      String listId)

Unpin a List Causes a User to remove a pinned List.

Parameters:

id - The ID of the authenticated source User for whom to return results. (required)

listId - The ID of the List to unpin. (required)

Returns:

APIlistUserUnpinRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

userFollowedLists

public ListsApi.APIuserFollowedListsRequest userFollowedLists(String id)

Get User's Followed Lists Returns a User's followed Lists.

Parameters:

id - The ID of the User to lookup. (required)

Returns:

APIuserFollowedListsRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-