Package com.twitter.clientlib.api

Class UsersApi.APIfindUserByUsernameRequest

java.lang.Object

com.twitter.clientlib.api.UsersApi.APIfindUserByUsernameRequest

Enclosing class:

UsersApi

public class UsersApi.APIfindUserByUsernameRequest
extends Object

Method Summary

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

Set userFields

Parameters:

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

Returns:

APIfindUserByUsernameRequest

expansions

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

Set expansions

Parameters:

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

Returns:

APIfindUserByUsernameRequest

tweetFields

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

Set tweetFields

Parameters:

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

Returns:

APIfindUserByUsernameRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for findUserByUsername

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

Execute findUserByUsername request

Returns:

Get2UsersByUsernameUsernameResponse

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

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2UsersByUsernameUsernameResponse> executeWithHttpInfo()
                                                                     throws ApiException

Execute findUserByUsername request with HTTP info returned

Returns:

ApiResponse<Get2UsersByUsernameUsernameResponse>

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

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