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.

Twitter API reference

Receiver

Timeline endpoint instance.

Return

JsonArrayApiAction for Status model.

Parameters

count

Specifies the number of records to retrieve. Must be less than or equal to 200. Defaults to 20. The value of count is best thought of as a limit to the number of tweets to return because suspended or deleted content is removed after the count has been applied.

sinceId

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 occurred since the since_id, the since_id will be forced to the oldest ID available.

maxId

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

trimUser

When set to either true, t or 1, each Tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.

excludeReplies

This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count Tweets — this is because the count parameter retrieves that many Tweets before filtering out retweets and replies.

includeEntities

The entities node will not be included when set to false.

includeRTs

When set to false , the timeline will strip any native retweets (though they will still count toward both the maximal length of the timeline and the slice selected by the count parameter). Note: If you're using the trim_user parameter in conjunction with include_rts, the retweets will still contain a full user object.

includeMyRetweet

Not documented yet.

tweetMode

Not documented yet.

options

Optional. Custom parameters of this request.


val Timeline.homeTimeline: JsonArrayApiAction<Status>

Shorthand property to Timeline.homeTimeline.

See also