Package com.twitter.clientlib.api

Class UsersApi.APIusersIdBlockingRequest

java.lang.Object

com.twitter.clientlib.api.UsersApi.APIusersIdBlockingRequest

Enclosing class:

UsersApi

public class UsersApi.APIusersIdBlockingRequest
extends Object

Method Summary

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

Set maxResults

Parameters:

maxResults - The maximum number of results. (optional)

Returns:

APIusersIdBlockingRequest

paginationToken

public UsersApi.APIusersIdBlockingRequest paginationToken(String paginationToken)

Set paginationToken

Parameters:

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

Returns:

APIusersIdBlockingRequest

userFields

public UsersApi.APIusersIdBlockingRequest userFields(Set<String> userFields)

Set userFields

Parameters:

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

Returns:

APIusersIdBlockingRequest

expansions

public UsersApi.APIusersIdBlockingRequest expansions(Set<String> expansions)

Set expansions

Parameters:

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

Returns:

APIusersIdBlockingRequest

tweetFields

public UsersApi.APIusersIdBlockingRequest tweetFields(Set<String> tweetFields)

Set tweetFields

Parameters:

tweetFields - A comma separated list of Tweet fields to display. (optional)

Returns:

APIusersIdBlockingRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for usersIdBlocking

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

Execute usersIdBlocking request

Returns:

Get2UsersIdBlockingResponse

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

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2UsersIdBlockingResponse> executeWithHttpInfo()
                                                             throws ApiException

Execute usersIdBlocking request with HTTP info returned

Returns:

ApiResponse<Get2UsersIdBlockingResponse>

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

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