Package com.twitter.clientlib.api

Class SpacesApi.APIfindSpacesByIdsRequest

java.lang.Object

com.twitter.clientlib.api.SpacesApi.APIfindSpacesByIdsRequest

Enclosing class:

SpacesApi

public class SpacesApi.APIfindSpacesByIdsRequest
extends Object

Method Summary

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

spaceFields

public SpacesApi.APIfindSpacesByIdsRequest spaceFields(Set<String> spaceFields)

Set spaceFields

Parameters:

spaceFields - A comma separated list of Space fields to display. (optional)

Returns:

APIfindSpacesByIdsRequest

expansions

public SpacesApi.APIfindSpacesByIdsRequest expansions(Set<String> expansions)

Set expansions

Parameters:

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

Returns:

APIfindSpacesByIdsRequest

userFields

public SpacesApi.APIfindSpacesByIdsRequest userFields(Set<String> userFields)

Set userFields

Parameters:

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

Returns:

APIfindSpacesByIdsRequest

topicFields

public SpacesApi.APIfindSpacesByIdsRequest topicFields(Set<String> topicFields)

Set topicFields

Parameters:

topicFields - A comma separated list of Topic fields to display. (optional)

Returns:

APIfindSpacesByIdsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for findSpacesByIds

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

Execute findSpacesByIds request

Returns:

Get2SpacesResponse

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

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2SpacesResponse> executeWithHttpInfo()
                                                    throws ApiException

Execute findSpacesByIds request with HTTP info returned

Returns:

ApiResponse<Get2SpacesResponse>

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

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