Package com.twitter.clientlib.api

Class UsersApi.APIfindUserByIdRequest

java.lang.Object

com.twitter.clientlib.api.UsersApi.APIfindUserByIdRequest

Enclosing class:

UsersApi

public class UsersApi.APIfindUserByIdRequest
extends Object

Method Summary

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

userFields

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

Set userFields

Parameters:

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

Returns:

APIfindUserByIdRequest

expansions

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

Set expansions

Parameters:

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

Returns:

APIfindUserByIdRequest

tweetFields

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

Set tweetFields

Parameters:

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

Returns:

APIfindUserByIdRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for findUserById

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

Execute findUserById request

Returns:

Get2UsersIdResponse

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

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2UsersIdResponse> executeWithHttpInfo()
                                                     throws ApiException

Execute findUserById request with HTTP info returned

Returns:

ApiResponse<Get2UsersIdResponse>

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

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