com.twitter.sdk.android.core.services

Interface FavoriteService

public interface FavoriteService

Method Summary

Modifier and Type	Method and Description
<any>	create(Long id, Boolean includeEntities) Favorites the status specified in the ID parameter as the authenticating user.
<any>	destroy(Long id, Boolean includeEntities) Un-favorites the status specified in the ID parameter as the authenticating user.
<any>	list(Long userId, String screenName, Integer count, String sinceId, String maxId, Boolean includeEntities) Returns recent Tweets favorited by the authenticating or specified user, by default returns 20 tweets.

Method Detail

list

<any> list(Long userId,
           String screenName,
           Integer count,
           String sinceId,
           String maxId,
           Boolean includeEntities)

Returns recent Tweets favorited by the authenticating or specified user, by default returns 20 tweets.

Parameters:

userId - (optional) The ID of the user for whom to return results for.

screenName - (optional) The screen name of the user for whom to return results for.

count - (optional) Specifies the number of records to retrieve. Must be less than or equal to 200. Defaults to 20.

sinceId - (optional) Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.

maxId - (optional) Returns results with an ID less than (that is, older than) or equal to the specified ID.

includeEntities - (optional) The entities node will be omitted when set to false.

destroy

<any> destroy(Long id,
              Boolean includeEntities)

Un-favorites the status specified in the ID parameter as the authenticating user. Returns the un-favorited status in the requested format when successful.

This process invoked by this method is asynchronous. The immediately returned status may not indicate the resultant favorited status of the Tweet. A 200 OK response from this method will indicate whether the intended action was successful or not.

Parameters:

id - (required) The numerical ID of the desired status.

includeEntities - (optional) The entities node will be omitted when set to false.

create

<any> create(Long id,
             Boolean includeEntities)

Favorites the status specified in the ID parameter as the authenticating user. Returns the favorite status when successful.

This process invoked by this method is asynchronous. The immediately returned status may not indicate the resultant favorited status of the Tweet. A 200 OK response from this method will indicate whether the intended action was successful or not.

Parameters:

id - (required) The numerical ID of the desired status.

includeEntities - (optional) The entities node will be omitted when set to false.