Package com.twitter.clientlib.api

Class SpacesApi.APIspaceTweetsRequest

java.lang.Object

com.twitter.clientlib.api.SpacesApi.APIspaceTweetsRequest

Enclosing class:

SpacesApi

public class SpacesApi.APIspaceTweetsRequest
extends Object

Method Summary

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

Set maxResults

Parameters:

maxResults - The number of Tweets to fetch from the provided space. If not provided, the value will default to the maximum of 100. (optional, default to 100)

Returns:

APIspaceTweetsRequest

tweetFields

public SpacesApi.APIspaceTweetsRequest tweetFields(Set<String> tweetFields)

Set tweetFields

Parameters:

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

Returns:

APIspaceTweetsRequest

expansions

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

Set expansions

Parameters:

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

Returns:

APIspaceTweetsRequest

mediaFields

public SpacesApi.APIspaceTweetsRequest mediaFields(Set<String> mediaFields)

Set mediaFields

Parameters:

mediaFields - A comma separated list of Media fields to display. (optional)

Returns:

APIspaceTweetsRequest

pollFields

public SpacesApi.APIspaceTweetsRequest pollFields(Set<String> pollFields)

Set pollFields

Parameters:

pollFields - A comma separated list of Poll fields to display. (optional)

Returns:

APIspaceTweetsRequest

userFields

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

Set userFields

Parameters:

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

Returns:

APIspaceTweetsRequest

placeFields

public SpacesApi.APIspaceTweetsRequest placeFields(Set<String> placeFields)

Set placeFields

Parameters:

placeFields - A comma separated list of Place fields to display. (optional)

Returns:

APIspaceTweetsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for spaceTweets

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

Execute spaceTweets request

Returns:

Get2SpacesIdTweetsResponse

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

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2SpacesIdTweetsResponse> executeWithHttpInfo()
                                                            throws ApiException

Execute spaceTweets request with HTTP info returned

Returns:

ApiResponse<Get2SpacesIdTweetsResponse>

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

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