Timeline

class Timeline(val client: ApiClient) : Endpoint

Collection of api endpoints related to timelines.

See also

Parameters

client

Current ApiClient instance.

Constructors

Link copied to clipboard
fun Timeline(client: ApiClient)

Creates new Timeline endpoint instance.

Properties

Link copied to clipboard
open override val client: ApiClient

Extensions

Link copied to clipboard
val Timeline.homeTimeline: JsonArrayApiAction<Status>

Shorthand property to Timeline.homeTimeline.

fun Timeline.homeTimeline(    count: Int? = null,     sinceId: Long? = null,     maxId: Long? = null,     trimUser: Boolean? = null,     excludeReplies: Boolean? = null,     includeEntities: Boolean? = null,     includeRTs: Boolean? = null,     includeMyRetweet: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     includeCardUri: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>

Returns a collection of the most recent Tweets and Retweets posted by the authenticating user and the users they follow. The home timeline is central to how most users interact with the Twitter service. Up to 800 Tweets are obtainable on the home timeline. It is more volatile for users that follow many users or follow users who Tweet frequently. See Working with Timelines for instructions on traversing timelines efficiently.

Link copied to clipboard
fun Timeline.listTimeline(    listId: Long,     sinceId: Long? = null,     maxId: Long? = null,     count: Int? = null,     includeEntities: Boolean? = null,     includeRTs: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     includeMyRetweet: Boolean? = null,     includeCardUri: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>

Returns a timeline of tweets authored by members of the specified list. Retweets are included by default. Use the include_rts=false parameter to omit retweets. Embedded Timelines is a great way to embed list timelines on your website.

Link copied to clipboard
fun Timeline.listTimelineByOwnerId(    slug: String,     ownerId: Long,     sinceId: Long? = null,     maxId: Long? = null,     count: Int? = null,     includeEntities: Boolean? = null,     includeRTs: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     includeMyRetweet: Boolean? = null,     includeCardUri: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>

Returns a timeline of tweets authored by members of the specified list. Retweets are included by default. Use the include_rts=false parameter to omit retweets. Embedded Timelines is a great way to embed list timelines on your website.

Link copied to clipboard
fun Timeline.listTimelineByOwnerScreenName(    slug: String,     ownerScreenName: String,     sinceId: Long? = null,     maxId: Long? = null,     count: Int? = null,     includeEntities: Boolean? = null,     includeRTs: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     includeMyRetweet: Boolean? = null,     includeCardUri: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>

Returns a timeline of tweets authored by members of the specified list. Retweets are included by default. Use the include_rts=false parameter to omit retweets. Embedded Timelines is a great way to embed list timelines on your website.

Link copied to clipboard
val Timeline.mentionsTimeline: JsonArrayApiAction<Status>

Shorthand property to Timeline.mentionsTimeline.

fun Timeline.mentionsTimeline(    count: Int? = null,     sinceId: Long? = null,     maxId: Long? = null,     trimUser: Boolean? = null,     includeEntities: Boolean? = null,     includeRTs: Boolean? = null,     includeMyRetweet: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     includeCardUri: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>

Returns the 20 most recent mentions (Tweets containing a users's @screen_name) for the authenticating user. The timeline returned is the equivalent of the one seen when you view your mentions on twitter.com. This method can only return up to 800 tweets. See Working with Timelines for instructions on traversing timelines.

Link copied to clipboard
val Timeline.userTimeline: JsonArrayApiAction<Status>

Shorthand property to Timeline.userTimeline.

fun Timeline.userTimeline(    sinceId: Long? = null,     count: Int? = null,     maxId: Long? = null,     trimUser: Boolean? = null,     excludeReplies: Boolean? = null,     includeRTs: Boolean? = null,     includeEntities: Boolean? = null,     includeMyRetweet: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     includeCardUri: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>

Returns a collection of the most recent Tweets posted by the user indicated by the screen_name or user_id parameters. User timelines belonging to protected users may only be requested when the authenticated user either "owns" the timeline or is an approved follower of the owner. The timeline returned is the equivalent of the one seen as a user's profile on Twitter. This method can only return up to 3,200 of a user's most recent Tweets. Native retweets of other statuses by the user is included in this total, regardless of whether include_rts is set to false when requesting this resource. See Working with Timelines for instructions on traversing timelines. See Embedded Timelines, Embedded Tweets, and GET statuses/oembed for tools to render Tweets according to Display Requirements.

Link copied to clipboard
fun Timeline.userTimelineByScreenName(    screenName: String,     sinceId: Long? = null,     count: Int? = null,     maxId: Long? = null,     trimUser: Boolean? = null,     excludeReplies: Boolean? = null,     includeRTs: Boolean? = null,     includeEntities: Boolean? = null,     includeMyRetweet: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     includeCardUri: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>

Returns a collection of the most recent Tweets posted by the user indicated by the screen_name or user_id parameters. User timelines belonging to protected users may only be requested when the authenticated user either "owns" the timeline or is an approved follower of the owner. The timeline returned is the equivalent of the one seen as a user's profile on Twitter. This method can only return up to 3,200 of a user's most recent Tweets. Native retweets of other statuses by the user is included in this total, regardless of whether include_rts is set to false when requesting this resource. See Working with Timelines for instructions on traversing timelines. See Embedded Timelines, Embedded Tweets, and GET statuses/oembed for tools to render Tweets according to Display Requirements.

Link copied to clipboard
fun Timeline.userTimelineByUserId(    userId: Long,     sinceId: Long? = null,     count: Int? = null,     maxId: Long? = null,     trimUser: Boolean? = null,     excludeReplies: Boolean? = null,     includeRTs: Boolean? = null,     includeEntities: Boolean? = null,     includeMyRetweet: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     includeCardUri: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>

Returns a collection of the most recent Tweets posted by the user indicated by the screen_name or user_id parameters. User timelines belonging to protected users may only be requested when the authenticated user either "owns" the timeline or is an approved follower of the owner. The timeline returned is the equivalent of the one seen as a user's profile on Twitter. This method can only return up to 3,200 of a user's most recent Tweets. Native retweets of other statuses by the user is included in this total, regardless of whether include_rts is set to false when requesting this resource. See Working with Timelines for instructions on traversing timelines. See Embedded Timelines, Embedded Tweets, and GET statuses/oembed for tools to render Tweets according to Display Requirements.