penicillin/blue.starry.penicillin.endpoints/Favorites

Favorites

class Favorites(val client: ApiClient) : Endpoint
Content copied to clipboard

Collection of api endpoints related to favorites.

See also

Parameters

client

Current ApiClient instance.

Constructors

Link copied to clipboard
fun Favorites(client: ApiClient)
Content copied to clipboard

Creates new Favorites endpoint instance.

Properties

Link copied to clipboard
open override val client: ApiClient
Content copied to clipboard

Extensions

Link copied to clipboard
fun Favorites.create(    id: Long,     includeEntities: Boolean? = null,     vararg options: Option): JsonObjectApiAction<Status>
Content copied to clipboard

Note: favorites are now known as likes. Favorites (likes) the Tweet specified in the ID parameter as the authenticating user. Returns the favorite Tweet when successful. The process invoked by this method is asynchronous. The immediately returned Tweet object 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.

Link copied to clipboard
fun Favorites.destroy(    id: Long,     includeEntities: Boolean? = null,     vararg options: Option): JsonObjectApiAction<Status>
Content copied to clipboard

Note: favorites are now known as likes. Unfavorites (un-likes) the Tweet specified in the ID parameter as the authenticating user. Returns the un-liked Tweet when successful. The process invoked by this method is asynchronous. The immediately returned Tweet object 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.

Link copied to clipboard
val Favorites.list: JsonArrayApiAction<Status>
Content copied to clipboard

Shorthand property to Favorites.list.

fun Favorites.list(    count: Int? = null,     sinceId: Long? = null,     maxId: Long? = null,     includeEntities: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>
Content copied to clipboard

Note: favorites are now known as likes. Returns the 20 most recent Tweets liked by the authenticating or specified user.

Link copied to clipboard
fun Favorites.listByScreenName(    screenName: String,     count: Int? = null,     sinceId: Long? = null,     maxId: Long? = null,     includeEntities: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>
Content copied to clipboard

Note: favorites are now known as likes. Returns the 20 most recent Tweets liked by the authenticating or specified user.

Link copied to clipboard
fun Favorites.listByUserId(    userId: Long,     count: Int? = null,     sinceId: Long? = null,     maxId: Long? = null,     includeEntities: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>
Content copied to clipboard

Note: favorites are now known as likes. Returns the 20 most recent Tweets liked by the authenticating or specified user.