Package com.twitter.clientlib.api

Class ListsApi.APIlistUserPinnedListsRequest

java.lang.Object

com.twitter.clientlib.api.ListsApi.APIlistUserPinnedListsRequest

Enclosing class:

ListsApi

public class ListsApi.APIlistUserPinnedListsRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listUserPinnedLists
Get2UsersIdPinnedListsResponse	execute()	Execute listUserPinnedLists request
Get2UsersIdPinnedListsResponse	execute(Integer retries)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	executeAsync(ApiCallback<Get2UsersIdPinnedListsResponse> _callback)	Execute listUserPinnedLists request (asynchronously)
ApiResponse<Get2UsersIdPinnedListsResponse>	executeWithHttpInfo()	Execute listUserPinnedLists request with HTTP info returned
ListsApi.APIlistUserPinnedListsRequest	expansions(Set<String> expansions)	Set expansions
ListsApi.APIlistUserPinnedListsRequest	listFields(Set<String> listFields)	Set listFields
ListsApi.APIlistUserPinnedListsRequest	userFields(Set<String> userFields)	Set userFields

Methods inherited from class java.lang.Object

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

Method Detail

listFields

public ListsApi.APIlistUserPinnedListsRequest listFields(Set<String> listFields)

Set listFields

Parameters:

listFields - A comma separated list of List fields to display. (optional)

Returns:

APIlistUserPinnedListsRequest

expansions

public ListsApi.APIlistUserPinnedListsRequest expansions(Set<String> expansions)

Set expansions

Parameters:

expansions - A comma separated list of fields to expand. (optional)

Returns:

APIlistUserPinnedListsRequest

userFields

public ListsApi.APIlistUserPinnedListsRequest userFields(Set<String> userFields)

Set userFields

Parameters:

userFields - A comma separated list of User fields to display. (optional)

Returns:

APIlistUserPinnedListsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listUserPinnedLists

Parameters:

_callback - ApiCallback API callback

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

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

execute

public Get2UsersIdPinnedListsResponse execute()
                                       throws ApiException

Execute listUserPinnedLists request

Returns:

Get2UsersIdPinnedListsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

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

execute

public Get2UsersIdPinnedListsResponse execute(Integer retries)
                                       throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2UsersIdPinnedListsResponse> executeWithHttpInfo()
                                                                throws ApiException

Execute listUserPinnedLists request with HTTP info returned

Returns:

ApiResponse<Get2UsersIdPinnedListsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

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

executeAsync

public okhttp3.Call executeAsync(ApiCallback<Get2UsersIdPinnedListsResponse> _callback)
                          throws ApiException

Execute listUserPinnedLists request (asynchronously)

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

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