Package com.twitter.clientlib.api

Class ListsApi.APIlistUserOwnedListsRequest

java.lang.Object

com.twitter.clientlib.api.ListsApi.APIlistUserOwnedListsRequest

Enclosing class:

ListsApi

public class ListsApi.APIlistUserOwnedListsRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listUserOwnedLists
Get2UsersIdOwnedListsResponse	execute()	Execute listUserOwnedLists request
Get2UsersIdOwnedListsResponse	execute(Integer retries)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	executeAsync(ApiCallback<Get2UsersIdOwnedListsResponse> _callback)	Execute listUserOwnedLists request (asynchronously)
ApiResponse<Get2UsersIdOwnedListsResponse>	executeWithHttpInfo()	Execute listUserOwnedLists request with HTTP info returned
ListsApi.APIlistUserOwnedListsRequest	expansions(Set<String> expansions)	Set expansions
ListsApi.APIlistUserOwnedListsRequest	listFields(Set<String> listFields)	Set listFields
ListsApi.APIlistUserOwnedListsRequest	maxResults(Integer maxResults)	Set maxResults
ListsApi.APIlistUserOwnedListsRequest	paginationToken(String paginationToken)	Set paginationToken
ListsApi.APIlistUserOwnedListsRequest	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

maxResults

public ListsApi.APIlistUserOwnedListsRequest maxResults(Integer maxResults)

Set maxResults

Parameters:

maxResults - The maximum number of results. (optional, default to 100)

Returns:

APIlistUserOwnedListsRequest

paginationToken

public ListsApi.APIlistUserOwnedListsRequest paginationToken(String paginationToken)

Set paginationToken

Parameters:

paginationToken - This parameter is used to get a specified 'page' of results. (optional)

Returns:

APIlistUserOwnedListsRequest

listFields

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

Set listFields

Parameters:

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

Returns:

APIlistUserOwnedListsRequest

expansions

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

Set expansions

Parameters:

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

Returns:

APIlistUserOwnedListsRequest

userFields

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

Set userFields

Parameters:

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

Returns:

APIlistUserOwnedListsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listUserOwnedLists

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 Get2UsersIdOwnedListsResponse execute()
                                      throws ApiException

Execute listUserOwnedLists request

Returns:

Get2UsersIdOwnedListsResponse

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 Get2UsersIdOwnedListsResponse execute(Integer retries)
                                      throws ApiException

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2UsersIdOwnedListsResponse> executeWithHttpInfo()
                                                               throws ApiException

Execute listUserOwnedLists request with HTTP info returned

Returns:

ApiResponse<Get2UsersIdOwnedListsResponse>

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<Get2UsersIdOwnedListsResponse> _callback)
                          throws ApiException

Execute listUserOwnedLists 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.	-