Package com.twitter.clientlib.api

Class UsersApi.APIfindUsersByIdRequest

java.lang.Object

com.twitter.clientlib.api.UsersApi.APIfindUsersByIdRequest

Enclosing class:

UsersApi

public class UsersApi.APIfindUsersByIdRequest
extends Object

Method Summary

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

Set userFields

Parameters:

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

Returns:

APIfindUsersByIdRequest

expansions

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

Set expansions

Parameters:

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

Returns:

APIfindUsersByIdRequest

tweetFields

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

Set tweetFields

Parameters:

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

Returns:

APIfindUsersByIdRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for findUsersById

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

Execute findUsersById request

Returns:

Get2UsersResponse

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

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2UsersResponse> executeWithHttpInfo()
                                                   throws ApiException

Execute findUsersById request with HTTP info returned

Returns:

ApiResponse<Get2UsersResponse>

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

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