userTimeline method

Future<List<Tweet>> userTimeline({ String? userId, String? screenName, int? count, String? sinceId, String? maxId, bool? trimUser, bool? excludeReplies, bool? includeRts, bool? includeExtEditControl, String tweetMode = 'extended', TransformResponse<List<Tweet>> transform = defaultTweetListTransform, })

Returns a collection of the most recent Tweets posted by the user indicated by the screenName or userId 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.

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 includeRts is set to false when requesting this resource.

userId: The ID of the user for whom to return results.

screenName: The screen name of the user for whom to return results.

count: Specifies the number of Tweets to try and retrieve, up to a maximum of 200 per distinct request. 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. We include retweets in the count, even if includeRts is not supplied. It is recommended you always set includeRts to true when using this API method.

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 sinceId, the sinceId 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 true, 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 excludeReplies 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.

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 trimUser parameter in conjunction with includeRts, the retweets will still contain a full user object.

tweetMode: When set to extended, uses the extended Tweets. See https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/intro-to-tweet-json#extendedtweet.

includeExtEditControl: The includeExtEditControl node will not be included when set to false. See https://developer.twitter.com/en/docs/twitter-api/v1/edit-tweets

transform: Can be used to parse the request. By default, the response is parsed in an isolate.

See https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline.

Implementation

Future<List<Tweet>> userTimeline({
  String? userId,
  String? screenName,
  int? count,
  String? sinceId,
  String? maxId,
  bool? trimUser,
  bool? excludeReplies,
  bool? includeRts,
  bool? includeExtEditControl,
  String tweetMode = 'extended',
  TransformResponse<List<Tweet>> transform = defaultTweetListTransform,
}) async {
  final params = <String, String>{}
    ..addParameter('user_id', userId)
    ..addParameter('screen_name', screenName)
    ..addParameter('count', count)
    ..addParameter('since_id', sinceId)
    ..addParameter('max_id', maxId)
    ..addParameter('trim_user', trimUser)
    ..addParameter('exclude_replies', excludeReplies)
    ..addParameter('include_rts', includeRts)
    ..addParameter('include_ext_edit_control', includeExtEditControl)
    ..addParameter('tweet_mode', 'extended');

  return client
      .get(Uri.https(
        'api.twitter.com',
        '1.1/statuses/user_timeline.json',
        params,
      ))
      .then(transform);
}