Package com.twitter.clientlib.api

Class BookmarksApi.APIgetUsersIdBookmarksRequest

java.lang.Object

com.twitter.clientlib.api.BookmarksApi.APIgetUsersIdBookmarksRequest

Enclosing class:

BookmarksApi

public class BookmarksApi.APIgetUsersIdBookmarksRequest
extends Object

Method Summary

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

Set maxResults

Parameters:

maxResults - The maximum number of results. (optional)

Returns:

APIgetUsersIdBookmarksRequest

paginationToken

public BookmarksApi.APIgetUsersIdBookmarksRequest paginationToken(String paginationToken)

Set paginationToken

Parameters:

paginationToken - This parameter is used to get the next 'page' of results. (optional)

Returns:

APIgetUsersIdBookmarksRequest

tweetFields

public BookmarksApi.APIgetUsersIdBookmarksRequest tweetFields(Set<String> tweetFields)

Set tweetFields

Parameters:

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

Returns:

APIgetUsersIdBookmarksRequest

expansions

public BookmarksApi.APIgetUsersIdBookmarksRequest expansions(Set<String> expansions)

Set expansions

Parameters:

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

Returns:

APIgetUsersIdBookmarksRequest

mediaFields

public BookmarksApi.APIgetUsersIdBookmarksRequest mediaFields(Set<String> mediaFields)

Set mediaFields

Parameters:

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

Returns:

APIgetUsersIdBookmarksRequest

pollFields

public BookmarksApi.APIgetUsersIdBookmarksRequest pollFields(Set<String> pollFields)

Set pollFields

Parameters:

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

Returns:

APIgetUsersIdBookmarksRequest

userFields

public BookmarksApi.APIgetUsersIdBookmarksRequest userFields(Set<String> userFields)

Set userFields

Parameters:

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

Returns:

APIgetUsersIdBookmarksRequest

placeFields

public BookmarksApi.APIgetUsersIdBookmarksRequest placeFields(Set<String> placeFields)

Set placeFields

Parameters:

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

Returns:

APIgetUsersIdBookmarksRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for getUsersIdBookmarks

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

Execute getUsersIdBookmarks request

Returns:

Get2UsersIdBookmarksResponse

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

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2UsersIdBookmarksResponse> executeWithHttpInfo()
                                                              throws ApiException

Execute getUsersIdBookmarks request with HTTP info returned

Returns:

ApiResponse<Get2UsersIdBookmarksResponse>

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

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