penicillin/blue.starry.penicillin.endpoints/Collections

Collections

class Collections(val client: ApiClient) : Endpoint

Collection of api endpoints related to tweet collections.

Parameters

client

Current ApiClient instance.

Constructors

Collections

fun Collections(client: ApiClient)

Creates new Collections endpoint instance.

Properties

client

open override val client: ApiClient

Extensions

create

fun Collections.create( name: String, description: String? = null, url: String? = null, timelineOrder: CollectionTimelineOrder = CollectionTimelineOrder.Default, vararg options: Option): JsonObjectApiAction<Collection.Model>

Create a Collection owned by the currently authenticated user. The API endpoint may refuse to complete the request if the authenticated user has exceeded the total number of allowed collections for their account.

delete

fun Collections.delete(id: String, vararg options: Option): JsonObjectApiAction<Collection.DestroyResult>

Permanently delete a Collection owned by the currently authenticated user.

list

val Collections.list: JsonObjectApiAction<Collection.List>

Shorthand property to Collections.list.

fun Collections.list( tweetId: Long? = null, count: Int? = null, cursor: String? = null, vararg options: Option): JsonObjectApiAction<Collection.List>

Find Collections created by a specific user or containing a specific curated Tweet. Results are organized in a cursored collection.

listByScreenName

fun Collections.listByScreenName( screenName: String, tweetId: Long? = null, count: Int? = null, cursor: String? = null, vararg options: Option): JsonObjectApiAction<Collection.List>

Find Collections created by a specific user or containing a specific curated Tweet. Results are organized in a cursored collection.

listByUserId

fun Collections.listByUserId( userId: Long, tweetId: Long? = null, count: Int? = null, cursor: String? = null, vararg options: Option): JsonObjectApiAction<Collection.List>

Find Collections created by a specific user or containing a specific curated Tweet. Results are organized in a cursored collection.

show

fun Collections.show(id: String, vararg options: Option): JsonObjectApiAction<Collection.Model>

Retrieve information associated with a specific Collection.

update

fun Collections.update( id: String, name: String? = null, description: String? = null, url: String? = null, vararg options: Option): JsonObjectApiAction<Collection.Model>

Update information concerning a Collection owned by the currently authenticated user. Partial updates are not currently supported: please provide name, description, and url whenever using this method. Omitted description or url parameters will be treated as if an empty string was passed, overwriting any previously stored value for the Collection.

Collections

See also

Parameters

Constructors

Properties

Extensions