861 lines
38 KiB
HTML
861 lines
38 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||
<head>
|
||
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
|
||
|
||
<title>Module: Twitter::REST::Timelines</title>
|
||
|
||
<link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
|
||
|
||
<script src="../../js/jquery.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
|
||
|
||
</head>
|
||
<body id="top" class="module">
|
||
|
||
<div id="metadata">
|
||
<div id="home-metadata">
|
||
<div id="home-section" class="section">
|
||
<h3 class="section-header">
|
||
<a href="../../index.html">Home</a>
|
||
<a href="../../index.html#classes">Classes</a>
|
||
<a href="../../index.html#methods">Methods</a>
|
||
</h3>
|
||
</div>
|
||
</div>
|
||
|
||
<div id="file-metadata">
|
||
<div id="file-list-section" class="section">
|
||
<h3 class="section-header">In Files</h3>
|
||
<div class="section-body">
|
||
<ul>
|
||
|
||
<li><a href="../../lib/twitter/rest/timelines_rb.html?TB_iframe=true&height=550&width=785"
|
||
class="thickbox" title="lib/twitter/rest/timelines.rb">lib/twitter/rest/timelines.rb</a></li>
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div id="class-metadata">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!-- Method Quickref -->
|
||
<div id="method-list-section" class="section">
|
||
<h3 class="section-header">Methods</h3>
|
||
<ul class="link-list">
|
||
|
||
<li><a href="#method-i-home_timeline">#home_timeline</a></li>
|
||
|
||
<li><a href="#method-i-mentions">#mentions</a></li>
|
||
|
||
<li><a href="#method-i-mentions_timeline">#mentions_timeline</a></li>
|
||
|
||
<li><a href="#method-i-retweeted_by">#retweeted_by</a></li>
|
||
|
||
<li><a href="#method-i-retweeted_by_me">#retweeted_by_me</a></li>
|
||
|
||
<li><a href="#method-i-retweeted_by_user">#retweeted_by_user</a></li>
|
||
|
||
<li><a href="#method-i-retweeted_to_me">#retweeted_to_me</a></li>
|
||
|
||
<li><a href="#method-i-retweets_of_me">#retweets_of_me</a></li>
|
||
|
||
<li><a href="#method-i-user_timeline">#user_timeline</a></li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
<!-- Included Modules -->
|
||
<div id="includes-section" class="section">
|
||
<h3 class="section-header">Included Modules</h3>
|
||
<ul class="link-list">
|
||
|
||
|
||
<li><a class="include" href="Utils.html">Twitter::REST::Utils</a></li>
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div id="project-metadata">
|
||
|
||
|
||
|
||
<div id="classindex-section" class="section project-section">
|
||
<h3 class="section-header">Class/Module Index
|
||
<span class="search-toggle"><img src="../../images/find.png"
|
||
height="16" width="16" alt="[+]"
|
||
title="show/hide quicksearch" /></span></h3>
|
||
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
||
<fieldset>
|
||
<legend>Quicksearch</legend>
|
||
<input type="text" name="quicksearch" value=""
|
||
class="quicksearch-field" />
|
||
</fieldset>
|
||
</form>
|
||
|
||
<ul class="link-list">
|
||
|
||
<li><a href="../../Twitter.html">Twitter</a></li>
|
||
|
||
<li><a href="../../Twitter/Arguments.html">Twitter::Arguments</a></li>
|
||
|
||
<li><a href="../../Twitter/Base.html">Twitter::Base</a></li>
|
||
|
||
<li><a href="../../Twitter/BasicUser.html">Twitter::BasicUser</a></li>
|
||
|
||
<li><a href="../../Twitter/Client.html">Twitter::Client</a></li>
|
||
|
||
<li><a href="../../Twitter/Configuration.html">Twitter::Configuration</a></li>
|
||
|
||
<li><a href="../../Twitter/Creatable.html">Twitter::Creatable</a></li>
|
||
|
||
<li><a href="../../Twitter/Cursor.html">Twitter::Cursor</a></li>
|
||
|
||
<li><a href="../../Twitter/DirectMessage.html">Twitter::DirectMessage</a></li>
|
||
|
||
<li><a href="../../Twitter/Entities.html">Twitter::Entities</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity.html">Twitter::Entity</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/Hashtag.html">Twitter::Entity::Hashtag</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/Symbol.html">Twitter::Entity::Symbol</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/URI.html">Twitter::Entity::URI</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/URI.html">Twitter::Entity::URL</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/UserMention.html">Twitter::Entity::UserMention</a></li>
|
||
|
||
<li><a href="../../Twitter/Enumerable.html">Twitter::Enumerable</a></li>
|
||
|
||
<li><a href="../../Twitter/Error.html">Twitter::Error</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/AlreadyFavorited.html">Twitter::Error::AlreadyFavorited</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/AlreadyRetweeted.html">Twitter::Error::AlreadyRetweeted</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/BadGateway.html">Twitter::Error::BadGateway</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/BadRequest.html">Twitter::Error::BadRequest</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/ClientError.html">Twitter::Error::ClientError</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/Code.html">Twitter::Error::Code</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/ConfigurationError.html">Twitter::Error::ConfigurationError</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/DuplicateStatus.html">Twitter::Error::DuplicateStatus</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/Forbidden.html">Twitter::Error::Forbidden</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/GatewayTimeout.html">Twitter::Error::GatewayTimeout</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/InternalServerError.html">Twitter::Error::InternalServerError</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/NotAcceptable.html">Twitter::Error::NotAcceptable</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/NotFound.html">Twitter::Error::NotFound</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/RequestTimeout.html">Twitter::Error::RequestTimeout</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/ServerError.html">Twitter::Error::ServerError</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/ServiceUnavailable.html">Twitter::Error::ServiceUnavailable</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/TooManyRequests.html">Twitter::Error::TooManyRequests</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/UnacceptableIO.html">Twitter::Error::UnacceptableIO</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/Unauthorized.html">Twitter::Error::Unauthorized</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/UnprocessableEntity.html">Twitter::Error::UnprocessableEntity</a></li>
|
||
|
||
<li><a href="../../Twitter/Factory.html">Twitter::Factory</a></li>
|
||
|
||
<li><a href="../../Twitter/Geo.html">Twitter::Geo</a></li>
|
||
|
||
<li><a href="../../Twitter/Geo/Point.html">Twitter::Geo::Point</a></li>
|
||
|
||
<li><a href="../../Twitter/Geo/Polygon.html">Twitter::Geo::Polygon</a></li>
|
||
|
||
<li><a href="../../Twitter/GeoFactory.html">Twitter::GeoFactory</a></li>
|
||
|
||
<li><a href="../../Twitter/GeoResults.html">Twitter::GeoResults</a></li>
|
||
|
||
<li><a href="../../Twitter/Identity.html">Twitter::Identity</a></li>
|
||
|
||
<li><a href="../../Twitter/Language.html">Twitter::Language</a></li>
|
||
|
||
<li><a href="../../Twitter/List.html">Twitter::List</a></li>
|
||
|
||
<li><a href="../../Twitter/Media.html">Twitter::Media</a></li>
|
||
|
||
<li><a href="../../Twitter/Media/Photo.html">Twitter::Media::Photo</a></li>
|
||
|
||
<li><a href="../../Twitter/MediaFactory.html">Twitter::MediaFactory</a></li>
|
||
|
||
<li><a href="../../Twitter/Metadata.html">Twitter::Metadata</a></li>
|
||
|
||
<li><a href="../../Twitter/OEmbed.html">Twitter::OEmbed</a></li>
|
||
|
||
<li><a href="../../Twitter/Place.html">Twitter::Place</a></li>
|
||
|
||
<li><a href="../../Twitter/Profile.html">Twitter::Profile</a></li>
|
||
|
||
<li><a href="../../Twitter/ProfileBanner.html">Twitter::ProfileBanner</a></li>
|
||
|
||
<li><a href="../../Twitter/REST.html">Twitter::REST</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/API.html">Twitter::REST::API</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Client.html">Twitter::REST::Client</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/DirectMessages.html">Twitter::REST::DirectMessages</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Favorites.html">Twitter::REST::Favorites</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/FriendsAndFollowers.html">Twitter::REST::FriendsAndFollowers</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Help.html">Twitter::REST::Help</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Lists.html">Twitter::REST::Lists</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Media.html">Twitter::REST::Media</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/OAuth.html">Twitter::REST::OAuth</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/PlacesAndGeo.html">Twitter::REST::PlacesAndGeo</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Request.html">Twitter::REST::Request</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Request/MultipartWithFile.html">Twitter::REST::Request::MultipartWithFile</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Response.html">Twitter::REST::Response</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Response/ParseErrorJson.html">Twitter::REST::Response::ParseErrorJson</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Response/ParseJson.html">Twitter::REST::Response::ParseJson</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Response/RaiseError.html">Twitter::REST::Response::RaiseError</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/SavedSearches.html">Twitter::REST::SavedSearches</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Search.html">Twitter::REST::Search</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/SpamReporting.html">Twitter::REST::SpamReporting</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/SuggestedUsers.html">Twitter::REST::SuggestedUsers</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Timelines.html">Twitter::REST::Timelines</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Trends.html">Twitter::REST::Trends</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Tweets.html">Twitter::REST::Tweets</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Undocumented.html">Twitter::REST::Undocumented</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Users.html">Twitter::REST::Users</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Utils.html">Twitter::REST::Utils</a></li>
|
||
|
||
<li><a href="../../Twitter/RateLimit.html">Twitter::RateLimit</a></li>
|
||
|
||
<li><a href="../../Twitter/Relationship.html">Twitter::Relationship</a></li>
|
||
|
||
<li><a href="../../Twitter/Request.html">Twitter::Request</a></li>
|
||
|
||
<li><a href="../../Twitter/SavedSearch.html">Twitter::SavedSearch</a></li>
|
||
|
||
<li><a href="../../Twitter/SearchResults.html">Twitter::SearchResults</a></li>
|
||
|
||
<li><a href="../../Twitter/Settings.html">Twitter::Settings</a></li>
|
||
|
||
<li><a href="../../Twitter/Size.html">Twitter::Size</a></li>
|
||
|
||
<li><a href="../../Twitter/SourceUser.html">Twitter::SourceUser</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming.html">Twitter::Streaming</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/Client.html">Twitter::Streaming::Client</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/Connection.html">Twitter::Streaming::Connection</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/DeletedTweet.html">Twitter::Streaming::DeletedTweet</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/Event.html">Twitter::Streaming::Event</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/FriendList.html">Twitter::Streaming::FriendList</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/MessageParser.html">Twitter::Streaming::MessageParser</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/Response.html">Twitter::Streaming::Response</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/StallWarning.html">Twitter::Streaming::StallWarning</a></li>
|
||
|
||
<li><a href="../../Twitter/Suggestion.html">Twitter::Suggestion</a></li>
|
||
|
||
<li><a href="../../Twitter/TargetUser.html">Twitter::TargetUser</a></li>
|
||
|
||
<li><a href="../../Twitter/Token.html">Twitter::Token</a></li>
|
||
|
||
<li><a href="../../Twitter/Trend.html">Twitter::Trend</a></li>
|
||
|
||
<li><a href="../../Twitter/TrendResults.html">Twitter::TrendResults</a></li>
|
||
|
||
<li><a href="../../Twitter/Tweet.html">Twitter::Tweet</a></li>
|
||
|
||
<li><a href="../../Twitter/User.html">Twitter::User</a></li>
|
||
|
||
<li><a href="../../Twitter/Utils.html">Twitter::Utils</a></li>
|
||
|
||
<li><a href="../../Twitter/Utils/ClassMethods.html">Twitter::Utils::ClassMethods</a></li>
|
||
|
||
<li><a href="../../Twitter/Version.html">Twitter::Version</a></li>
|
||
|
||
</ul>
|
||
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="documentation">
|
||
<h1 class="module">Twitter::REST::Timelines</h1>
|
||
|
||
<div id="description" class="description">
|
||
|
||
</div><!-- description -->
|
||
|
||
|
||
|
||
|
||
<div id="5Buntitled-5D" class="documentation-section">
|
||
|
||
|
||
|
||
|
||
|
||
<!-- Constants -->
|
||
<div id="constants-list" class="section">
|
||
<h3 class="section-header">Constants</h3>
|
||
<dl>
|
||
|
||
<dt><a name="DEFAULT_TWEETS_PER_REQUEST">DEFAULT_TWEETS_PER_REQUEST</a></dt>
|
||
|
||
<dd class="description"></dd>
|
||
|
||
|
||
<dt><a name="MAX_TWEETS_PER_REQUEST">MAX_TWEETS_PER_REQUEST</a></dt>
|
||
|
||
<dd class="description"></dd>
|
||
|
||
|
||
</dl>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<!-- Methods -->
|
||
|
||
<div id="public-instance-method-details" class="method-section section">
|
||
<h3 class="section-header">Public Instance Methods</h3>
|
||
|
||
|
||
<div id="home_timeline-method" class="method-detail ">
|
||
<a name="method-i-home_timeline"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">home_timeline</span><span
|
||
class="method-args">(options = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the 20 most recent <a href="Tweets.html">Tweets</a>, including
|
||
retweets if they exist, posted by the authenticating user and the users
|
||
they follow</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline">dev.twitter.com/docs/api/1.1/get/statuses/home_timeline</a>
|
||
@note This method can only return up to 800 <a
|
||
href="Tweets.html">Tweets</a>, including retweets. @rate_limited Yes
|
||
@authentication Requires user context @raise [Twitter::Error::Unauthorized]
|
||
<a href="../Error.html">Error</a> raised when supplied user credentials are
|
||
not valid. @return [Array<Twitter::Tweet>] @param options [Hash] A
|
||
customizable set of options. @option options [Integer] :since_id Returns
|
||
results with an ID greater than (that is, more recent than) the specified
|
||
ID. @option options [Integer] :max_id Returns results with an ID less than
|
||
(that is, older than) or equal to the specified ID. @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]
|
||
:contributor_details Specifies that the contributors element should be
|
||
enhanced to include the screen_name of the contributor.</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="home_timeline-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/timelines.rb, line 113</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">home_timeline</span>(<span class="ruby-identifier">options</span> = {})
|
||
<span class="ruby-identifier">perform_with_objects</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/statuses/home_timeline.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Tweet</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- home_timeline-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- home_timeline-method -->
|
||
|
||
|
||
<div id="mentions-method" class="method-detail method-alias">
|
||
<a name="method-i-mentions"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">mentions</span><span
|
||
class="method-args">(options = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="aliases">
|
||
Alias for: <a href="Timelines.html#method-i-mentions_timeline">mentions_timeline</a>
|
||
</div>
|
||
|
||
</div><!-- mentions-method -->
|
||
|
||
|
||
<div id="mentions_timeline-method" class="method-detail ">
|
||
<a name="method-i-mentions_timeline"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">mentions_timeline</span><span
|
||
class="method-args">(options = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the 20 most recent mentions (statuses containing @username) for the
|
||
authenticating user</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/statuses/mentions_timeline">dev.twitter.com/docs/api/1.1/get/statuses/mentions_timeline</a>
|
||
@note This method can only return up to 800 <a
|
||
href="Tweets.html">Tweets</a>. @rate_limited Yes @authentication Requires
|
||
user context @raise [Twitter::Error::Unauthorized] <a
|
||
href="../Error.html">Error</a> raised when supplied user credentials are
|
||
not valid. @return [Array<Twitter::Tweet>] @param options [Hash] A
|
||
customizable set of options. @option options [Integer] :since_id Returns
|
||
results with an ID greater than (that is, more recent than) the specified
|
||
ID. @option options [Integer] :max_id Returns results with an ID less than
|
||
(that is, older than) or equal to the specified ID. @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.</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="mentions_timeline-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/timelines.rb, line 26</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">mentions_timeline</span>(<span class="ruby-identifier">options</span> = {})
|
||
<span class="ruby-identifier">perform_with_objects</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/statuses/mentions_timeline.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Tweet</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- mentions_timeline-source -->
|
||
|
||
</div>
|
||
|
||
|
||
<div class="aliases">
|
||
Also aliased as: <a href="Timelines.html#method-i-mentions">mentions</a>
|
||
</div>
|
||
|
||
|
||
|
||
</div><!-- mentions_timeline-method -->
|
||
|
||
|
||
<div id="retweeted_by-method" class="method-detail method-alias">
|
||
<a name="method-i-retweeted_by"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">retweeted_by</span><span
|
||
class="method-args">(user, options = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="aliases">
|
||
Alias for: <a href="Timelines.html#method-i-retweeted_by_user">retweeted_by_user</a>
|
||
</div>
|
||
|
||
</div><!-- retweeted_by-method -->
|
||
|
||
|
||
<div id="retweeted_by_me-method" class="method-detail ">
|
||
<a name="method-i-retweeted_by_me"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">retweeted_by_me</span><span
|
||
class="method-args">(options = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the 20 most recent retweets posted by the authenticating user</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/statuses/user_timeline">dev.twitter.com/docs/api/1.1/get/statuses/user_timeline</a>
|
||
@note This method can only return up to 3,200 <a
|
||
href="Tweets.html">Tweets</a>. @rate_limited Yes @authentication Requires
|
||
user context @raise [Twitter::Error::Unauthorized] <a
|
||
href="../Error.html">Error</a> raised when supplied user credentials are
|
||
not valid. @return [Array<Twitter::Tweet>] @param options [Hash] A
|
||
customizable set of options. @option options [Integer] :since_id Returns
|
||
results with an ID greater than (that is, more recent than) the specified
|
||
ID. @option options [Integer] :max_id Returns results with an ID less than
|
||
(that is, older than) or equal to the specified ID. @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]
|
||
:contributor_details Specifies that the contributors element should be
|
||
enhanced to include the screen_name of the contributor.</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="retweeted_by_me-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/timelines.rb, line 91</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">retweeted_by_me</span>(<span class="ruby-identifier">options</span> = {})
|
||
<span class="ruby-identifier">retweets_from_timeline</span>(<span class="ruby-identifier">options</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opts</span><span class="ruby-operator">|</span>
|
||
<span class="ruby-identifier">user_timeline</span>(<span class="ruby-identifier">opts</span>)
|
||
<span class="ruby-keyword">end</span>
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- retweeted_by_me-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- retweeted_by_me-method -->
|
||
|
||
|
||
<div id="retweeted_by_user-method" class="method-detail ">
|
||
<a name="method-i-retweeted_by_user"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">retweeted_by_user</span><span
|
||
class="method-args">(user, options = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the 20 most recent retweets posted by the specified user</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/statuses/user_timeline">dev.twitter.com/docs/api/1.1/get/statuses/user_timeline</a>
|
||
@note This method can only return up to 3,200 <a
|
||
href="Tweets.html">Tweets</a>. @rate_limited Yes @authentication Requires
|
||
user context @raise [Twitter::Error::Unauthorized] <a
|
||
href="../Error.html">Error</a> raised when supplied user credentials are
|
||
not valid. @return [Array<Twitter::Tweet>] @param user [Integer,
|
||
String, Twitter::User] A <a href="../../Twitter.html">Twitter</a> user ID,
|
||
screen name, URI, or object. @param options [Hash] A customizable set of
|
||
options. @option options [Integer] :since_id Returns results with an ID
|
||
greater than (that is, more recent than) the specified ID. @option options
|
||
[Integer] :max_id Returns results with an ID less than (that is, older
|
||
than) or equal to the specified ID. @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]
|
||
:contributor_details Specifies that the contributors element should be
|
||
enhanced to include the screen_name of the contributor.</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="retweeted_by_user-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/timelines.rb, line 69</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">retweeted_by_user</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">options</span> = {})
|
||
<span class="ruby-identifier">retweets_from_timeline</span>(<span class="ruby-identifier">options</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opts</span><span class="ruby-operator">|</span>
|
||
<span class="ruby-identifier">user_timeline</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">opts</span>)
|
||
<span class="ruby-keyword">end</span>
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- retweeted_by_user-source -->
|
||
|
||
</div>
|
||
|
||
|
||
<div class="aliases">
|
||
Also aliased as: <a href="Timelines.html#method-i-retweeted_by">retweeted_by</a>
|
||
</div>
|
||
|
||
|
||
|
||
</div><!-- retweeted_by_user-method -->
|
||
|
||
|
||
<div id="retweeted_to_me-method" class="method-detail ">
|
||
<a name="method-i-retweeted_to_me"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">retweeted_to_me</span><span
|
||
class="method-args">(options = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the 20 most recent retweets posted by users the authenticating user
|
||
follow.</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline">dev.twitter.com/docs/api/1.1/get/statuses/home_timeline</a>
|
||
@note This method can only return up to 800 <a
|
||
href="Tweets.html">Tweets</a>, including retweets. @rate_limited Yes
|
||
@authentication Requires user context @raise [Twitter::Error::Unauthorized]
|
||
<a href="../Error.html">Error</a> raised when supplied user credentials are
|
||
not valid. @return [Array<Twitter::Tweet>] @param options [Hash] A
|
||
customizable set of options. @option options [Integer] :since_id Returns
|
||
results with an ID greater than (that is, more recent than) the specified
|
||
ID. @option options [Integer] :max_id Returns results with an ID less than
|
||
(that is, older than) or equal to the specified ID. @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]
|
||
:contributor_details Specifies that the contributors element should be
|
||
enhanced to include the screen_name of the contributor.</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="retweeted_to_me-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/timelines.rb, line 132</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">retweeted_to_me</span>(<span class="ruby-identifier">options</span> = {})
|
||
<span class="ruby-identifier">retweets_from_timeline</span>(<span class="ruby-identifier">options</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opts</span><span class="ruby-operator">|</span>
|
||
<span class="ruby-identifier">home_timeline</span>(<span class="ruby-identifier">opts</span>)
|
||
<span class="ruby-keyword">end</span>
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- retweeted_to_me-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- retweeted_to_me-method -->
|
||
|
||
|
||
<div id="retweets_of_me-method" class="method-detail ">
|
||
<a name="method-i-retweets_of_me"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">retweets_of_me</span><span
|
||
class="method-args">(options = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the 20 most recent tweets of the authenticated user that have been
|
||
retweeted by others</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/statuses/retweets_of_me">dev.twitter.com/docs/api/1.1/get/statuses/retweets_of_me</a>
|
||
@rate_limited Yes @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return
|
||
[Array<Twitter::Tweet>] @param options [Hash] A customizable set of
|
||
options. @option options [Integer] :count Specifies the number of records
|
||
to retrieve. Must be less than or equal to 200. @option options [Integer]
|
||
:since_id Returns results with an ID greater than (that is, more recent
|
||
than) the specified ID. @option options [Integer] :max_id Returns results
|
||
with an ID less than (that is, older than) or equal to the specified ID.
|
||
@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]
|
||
:include_user_entities The user entities node will be disincluded when set
|
||
to false.</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="retweets_of_me-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/timelines.rb, line 151</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">retweets_of_me</span>(<span class="ruby-identifier">options</span> = {})
|
||
<span class="ruby-identifier">perform_with_objects</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/statuses/retweets_of_me.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Tweet</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- retweets_of_me-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- retweets_of_me-method -->
|
||
|
||
|
||
<div id="user_timeline-method" class="method-detail ">
|
||
<a name="method-i-user_timeline"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">user_timeline</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the 20 most recent <a href="Tweets.html">Tweets</a> posted by the
|
||
specified user</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/statuses/user_timeline">dev.twitter.com/docs/api/1.1/get/statuses/user_timeline</a>
|
||
@note This method can only return up to 3,200 <a
|
||
href="Tweets.html">Tweets</a>. @rate_limited Yes @authentication Requires
|
||
user context @raise [Twitter::Error::Unauthorized] <a
|
||
href="../Error.html">Error</a> raised when supplied user credentials are
|
||
not valid. @return [Array<Twitter::Tweet>] @overload <a
|
||
href="Timelines.html#method-i-user_timeline">user_timeline</a>(user,
|
||
options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param options [Hash] A customizable set of options.
|
||
@option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
|
||
@option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
|
||
@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] :contributor_details Specifies that the contributors element should be enhanced to include the screen_name of the contributor.
|
||
@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.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="user_timeline-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/timelines.rb, line 49</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">user_timeline</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">objects_from_response_with_user</span>(<span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Tweet</span>, <span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/statuses/user_timeline.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- user_timeline-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- user_timeline-method -->
|
||
|
||
|
||
</div><!-- public-instance-method-details -->
|
||
|
||
</div><!-- 5Buntitled-5D -->
|
||
|
||
|
||
</div><!-- documentation -->
|
||
|
||
<div id="validator-badges">
|
||
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
||
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
||
Rdoc Generator</a> 2</small>.</p>
|
||
</div>
|
||
|
||
</body>
|
||
</html>
|
||
|