Package com.twitter.clientlib.api

Class BookmarksApi

java.lang.Object

com.twitter.clientlib.api.ApiCommon

com.twitter.clientlib.api.BookmarksApi

public class BookmarksApi
extends ApiCommon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BookmarksApi.APIgetUsersIdBookmarksRequest
class	BookmarksApi.APIpostUsersIdBookmarksRequest
class	BookmarksApi.APIusersIdBookmarksDeleteRequest

Field Summary

Fields inherited from class com.twitter.clientlib.api.ApiCommon

localVarApiClient

Constructor Summary

Constructors

Constructor	Description
BookmarksApi()

Method Summary

Modifier and Type	Method	Description
BookmarksApi.APIgetUsersIdBookmarksRequest	getUsersIdBookmarks(String id)	Bookmarks by User Returns Tweet objects that have been bookmarked by the requesting User
BookmarksApi.APIpostUsersIdBookmarksRequest	postUsersIdBookmarks(BookmarkAddRequest bookmarkAddRequest, String id)	Add Tweet to Bookmarks Adds a Tweet (ID in the body) to the requesting User's (in the path) bookmarks
BookmarksApi.APIusersIdBookmarksDeleteRequest	usersIdBookmarksDelete(String id, String tweetId)	Remove a bookmarked Tweet Removes a Tweet from the requesting User's bookmarked Tweets.

Methods inherited from class com.twitter.clientlib.api.ApiCommon

handleRateLimit, reduceAuthNames, setClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BookmarksApi

public BookmarksApi()

Method Detail

getUsersIdBookmarks

public BookmarksApi.APIgetUsersIdBookmarksRequest getUsersIdBookmarks(String id)

Bookmarks by User Returns Tweet objects that have been bookmarked by the requesting User

Parameters:

id - The ID of the authenticated source User for whom to return results. (required)

Returns:

APIgetUsersIdBookmarksRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

postUsersIdBookmarks

public BookmarksApi.APIpostUsersIdBookmarksRequest postUsersIdBookmarks(BookmarkAddRequest bookmarkAddRequest,
                                                                        String id)

Add Tweet to Bookmarks Adds a Tweet (ID in the body) to the requesting User's (in the path) bookmarks

Parameters:

bookmarkAddRequest - (required)

id - The ID of the authenticated source User for whom to add bookmarks. (required)

Returns:

APIpostUsersIdBookmarksRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

usersIdBookmarksDelete

public BookmarksApi.APIusersIdBookmarksDeleteRequest usersIdBookmarksDelete(String id,
                                                                            String tweetId)

Remove a bookmarked Tweet Removes a Tweet from the requesting User's bookmarked Tweets.

Parameters:

id - The ID of the authenticated source User whose bookmark is to be removed. (required)

tweetId - The ID of the Tweet that the source User is removing from bookmarks. (required)

Returns:

APIusersIdBookmarksDeleteRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-