From 9c930a851cc210e998f5fd715f75e90f8dae3eb2 Mon Sep 17 00:00:00 2001 From: Steve Agalloco Date: Wed, 25 Jul 2012 01:04:56 -0400 Subject: [PATCH] documented user_timeline and home_timeline options --- lib/twitter/api.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/twitter/api.rb b/lib/twitter/api.rb index 043ebd00a..b54cd7b41 100644 --- a/lib/twitter/api.rb +++ b/lib/twitter/api.rb @@ -1721,6 +1721,9 @@ def unfavorite(*args) # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200. # @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1. # @option options [Boolean, String, Integer] :exclude_replies 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. + # @option options [Boolean, String, Integer] :include_rts Specifies that the timeline should include native retweets in addition to regular tweets. Note: If you're using the trim_user parameter in conjunction with include_rts, the retweets will no longer contain a full user object. + # @option options [Boolean, String, Integer] :include_entities Specifies that each tweet should include an 'entities' node including metadata about the tweet such as: user_mentions, urls, and hashtags. + # @option options [Boolean] :contributor_details Specifies that the contributors element should be enhanced to include the screen_name of the contributor. # @example Return the 20 most recent statuses, including retweets if they exist, posted by the authenticating user and the users they follow # Twitter.home_timeline def home_timeline(options={}) @@ -1855,6 +1858,9 @@ def retweets_of_me(options={}) # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200. # @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1. # @option options [Boolean, String, Integer] :exclude_replies 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. + # @option options [Boolean, String, Integer] :include_rts Specifies that the timeline should include native retweets in addition to regular tweets. Note: If you're using the trim_user parameter in conjunction with include_rts, the retweets will no longer contain a full user object. + # @option options [Boolean, String, Integer] :include_entities Specifies that each tweet should include an 'entities' node including metadata about the tweet such as: user_mentions, urls, and hashtags. + # @option options [Boolean] :contributor_details Specifies that the contributors element should be enhanced to include the screen_name of the contributor. # @example Return the 20 most recent statuses posted by @sferik # Twitter.user_timeline('sferik') def user_timeline(*args)