1324 lines
56 KiB
HTML
1324 lines
56 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::FriendsAndFollowers</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/friends_and_followers_rb.html?TB_iframe=true&height=550&width=785"
|
|
class="thickbox" title="lib/twitter/rest/friends_and_followers.rb">lib/twitter/rest/friends_and_followers.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-create_friendship">#create_friendship</a></li>
|
|
|
|
<li><a href="#method-i-create_friendship-21">#create_friendship!</a></li>
|
|
|
|
<li><a href="#method-i-destroy_friendship">#destroy_friendship</a></li>
|
|
|
|
<li><a href="#method-i-follow">#follow</a></li>
|
|
|
|
<li><a href="#method-i-follow-21">#follow!</a></li>
|
|
|
|
<li><a href="#method-i-follower_ids">#follower_ids</a></li>
|
|
|
|
<li><a href="#method-i-followers">#followers</a></li>
|
|
|
|
<li><a href="#method-i-following">#following</a></li>
|
|
|
|
<li><a href="#method-i-friend_ids">#friend_ids</a></li>
|
|
|
|
<li><a href="#method-i-friends">#friends</a></li>
|
|
|
|
<li><a href="#method-i-friendship">#friendship</a></li>
|
|
|
|
<li><a href="#method-i-friendship-3F">#friendship?</a></li>
|
|
|
|
<li><a href="#method-i-friendship_show">#friendship_show</a></li>
|
|
|
|
<li><a href="#method-i-friendship_update">#friendship_update</a></li>
|
|
|
|
<li><a href="#method-i-friendships">#friendships</a></li>
|
|
|
|
<li><a href="#method-i-friendships_incoming">#friendships_incoming</a></li>
|
|
|
|
<li><a href="#method-i-friendships_outgoing">#friendships_outgoing</a></li>
|
|
|
|
<li><a href="#method-i-no_retweet_ids">#no_retweet_ids</a></li>
|
|
|
|
<li><a href="#method-i-no_retweets_ids">#no_retweets_ids</a></li>
|
|
|
|
<li><a href="#method-i-relationship">#relationship</a></li>
|
|
|
|
<li><a href="#method-i-unfollow">#unfollow</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>
|
|
|
|
|
|
|
|
<li><a class="include" href="../Utils.html">Twitter::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::FriendsAndFollowers</h1>
|
|
|
|
<div id="description" class="description">
|
|
|
|
</div><!-- description -->
|
|
|
|
|
|
|
|
|
|
<div id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Methods -->
|
|
|
|
<div id="public-instance-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Instance Methods</h3>
|
|
|
|
|
|
<div id="create_friendship-method" class="method-detail method-alias">
|
|
<a name="method-i-create_friendship"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">create_friendship</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="aliases">
|
|
Alias for: <a href="FriendsAndFollowers.html#method-i-follow">follow</a>
|
|
</div>
|
|
|
|
</div><!-- create_friendship-method -->
|
|
|
|
|
|
<div id="create_friendship-21-method" class="method-detail method-alias">
|
|
<a name="method-i-create_friendship-21"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">create_friendship!</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="aliases">
|
|
Alias for: <a href="FriendsAndFollowers.html#method-i-follow-21">follow!</a>
|
|
</div>
|
|
|
|
</div><!-- create_friendship-21-method -->
|
|
|
|
|
|
<div id="destroy_friendship-method" class="method-detail method-alias">
|
|
<a name="method-i-destroy_friendship"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">destroy_friendship</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="aliases">
|
|
Alias for: <a href="FriendsAndFollowers.html#method-i-unfollow">unfollow</a>
|
|
</div>
|
|
|
|
</div><!-- destroy_friendship-method -->
|
|
|
|
|
|
<div id="follow-method" class="method-detail ">
|
|
<a name="method-i-follow"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">follow</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Allows the authenticating user to follow the specified users, unless they
|
|
are already followed</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/post/friendships/create">dev.twitter.com/docs/api/1.1/post/friendships/create</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::User>] The followed users. @overload follow(*users)</p>
|
|
|
|
<pre>@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.</pre>
|
|
|
|
<p>@overload follow(*users, options)</p>
|
|
|
|
<pre>@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
|
|
@param options [Hash] A customizable set of options.
|
|
@option options [Boolean] :follow (false) Enable notifications for the target user.</pre>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="follow-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 106</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">follow</span>(*<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">arguments</span> = <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Arguments</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">existing_friends</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span>
|
|
<span class="ruby-identifier">friend_ids</span>.<span class="ruby-identifier">to_a</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">new_friends</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span>
|
|
<span class="ruby-identifier">users</span>(<span class="ruby-identifier">args</span>).<span class="ruby-identifier">collect</span>(&<span class="ruby-value">:id</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">follow!</span>(<span class="ruby-identifier">new_friends</span>.<span class="ruby-identifier">value</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">existing_friends</span>.<span class="ruby-identifier">value</span>, <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">options</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- follow-source -->
|
|
|
|
</div>
|
|
|
|
|
|
<div class="aliases">
|
|
Also aliased as: <a href="FriendsAndFollowers.html#method-i-create_friendship">create_friendship</a>
|
|
</div>
|
|
|
|
|
|
|
|
</div><!-- follow-method -->
|
|
|
|
|
|
<div id="follow-21-method" class="method-detail ">
|
|
<a name="method-i-follow-21"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">follow!</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Allows the authenticating user to follow the specified users</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/post/friendships/create">dev.twitter.com/docs/api/1.1/post/friendships/create</a>
|
|
@rate_limited No @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::User>] The followed users. @overload follow!(*users)</p>
|
|
|
|
<pre>@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.</pre>
|
|
|
|
<p>@overload follow!(*users, options)</p>
|
|
|
|
<pre>@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
|
|
@param options [Hash] A customizable set of options.
|
|
@option options [Boolean] :follow (false) Enable notifications for the target user.</pre>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="follow-21-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 132</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">follow!</span>(*<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">arguments</span> = <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Arguments</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">pmap</span>(<span class="ruby-identifier">arguments</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">user</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">perform_with_object</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/friendships/create.json'</span>, <span class="ruby-identifier">merge_user</span>(<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">options</span>, <span class="ruby-identifier">user</span>), <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>)
|
|
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">compact</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- follow-21-source -->
|
|
|
|
</div>
|
|
|
|
|
|
<div class="aliases">
|
|
Also aliased as: <a href="FriendsAndFollowers.html#method-i-create_friendship-21">create_friendship!</a>
|
|
</div>
|
|
|
|
|
|
|
|
</div><!-- follow-21-method -->
|
|
|
|
|
|
<div id="follower_ids-method" class="method-detail ">
|
|
<a name="method-i-follower_ids"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">follower_ids</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/followers/ids">dev.twitter.com/docs/api/1.1/get/followers/ids</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 [Twitter::Cursor]
|
|
@overload <a
|
|
href="FriendsAndFollowers.html#method-i-follower_ids">follower_ids</a>(options
|
|
= {})</p>
|
|
|
|
<pre>Returns an array of numeric IDs for every user following the authenticated user
|
|
|
|
@param options [Hash] A customizable set of options.</pre>
|
|
|
|
<p>@overload <a
|
|
href="FriendsAndFollowers.html#method-i-follower_ids">follower_ids</a>(user,
|
|
options = {})</p>
|
|
|
|
<pre>Returns an array of numeric IDs for every user following the specified user
|
|
|
|
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
|
@param options [Hash] A customizable set of options.</pre>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="follower_ids-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 47</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">follower_ids</span>(*<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">cursor_from_response_with_user</span>(<span class="ruby-value">:ids</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/followers/ids.json'</span>, <span class="ruby-identifier">args</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- follower_ids-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- follower_ids-method -->
|
|
|
|
|
|
<div id="followers-method" class="method-detail ">
|
|
<a name="method-i-followers"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">followers</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Returns a cursored collection of user objects for users following the
|
|
specified user.</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/followers/list">dev.twitter.com/docs/api/1.1/get/followers/list</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 [Twitter::Cursor]
|
|
@overload followers(options = {})</p>
|
|
|
|
<pre>Returns a cursored collection of user objects for users following the authenticated user.
|
|
|
|
@param options [Hash] A customizable set of options.
|
|
@option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets 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.</pre>
|
|
|
|
<p>@overload followers(user, options = {})</p>
|
|
|
|
<pre>Returns a cursored collection of user objects for users following the specified user.
|
|
|
|
@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 [Boolean, String, Integer] :skip_status Do not include contributee's Tweets 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.</pre>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="followers-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 229</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">followers</span>(*<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">cursor_from_response_with_user</span>(<span class="ruby-value">:users</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>, <span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/followers/list.json'</span>, <span class="ruby-identifier">args</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- followers-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- followers-method -->
|
|
|
|
|
|
<div id="following-method" class="method-detail method-alias">
|
|
<a name="method-i-following"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">following</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="aliases">
|
|
Alias for: <a href="FriendsAndFollowers.html#method-i-friends">friends</a>
|
|
</div>
|
|
|
|
</div><!-- following-method -->
|
|
|
|
|
|
<div id="friend_ids-method" class="method-detail ">
|
|
<a name="method-i-friend_ids"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">friend_ids</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/friends/ids">dev.twitter.com/docs/api/1.1/get/friends/ids</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 [Twitter::Cursor]
|
|
@overload <a
|
|
href="FriendsAndFollowers.html#method-i-friend_ids">friend_ids</a>(options
|
|
= {})</p>
|
|
|
|
<pre>Returns an array of numeric IDs for every user the authenticated user is following
|
|
|
|
@param options [Hash] A customizable set of options.</pre>
|
|
|
|
<p>@overload <a
|
|
href="FriendsAndFollowers.html#method-i-friend_ids">friend_ids</a>(user,
|
|
options = {})</p>
|
|
|
|
<pre>Returns an array of numeric IDs for every user the specified user is following
|
|
|
|
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
|
@param options [Hash] A customizable set of options.</pre>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="friend_ids-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 29</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">friend_ids</span>(*<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">cursor_from_response_with_user</span>(<span class="ruby-value">:ids</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/friends/ids.json'</span>, <span class="ruby-identifier">args</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- friend_ids-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- friend_ids-method -->
|
|
|
|
|
|
<div id="friends-method" class="method-detail ">
|
|
<a name="method-i-friends"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">friends</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Returns a cursored collection of user objects for every user the specified
|
|
user is following (otherwise known as their “friends”).</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/friends/list">dev.twitter.com/docs/api/1.1/get/friends/list</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 [Twitter::Cursor]
|
|
@overload friends(options = {})</p>
|
|
|
|
<pre>Returns a cursored collection of user objects for every user the authenticated user is following (otherwise known as their "friends").
|
|
|
|
@param options [Hash] A customizable set of options.
|
|
@option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets 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.</pre>
|
|
|
|
<p>@overload friends(user, options = {})</p>
|
|
|
|
<pre>Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
|
|
|
|
@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 [Boolean, String, Integer] :skip_status Do not include contributee's Tweets 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.</pre>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="friends-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 253</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">friends</span>(*<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">cursor_from_response_with_user</span>(<span class="ruby-value">:users</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>, <span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/friends/list.json'</span>, <span class="ruby-identifier">args</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- friends-source -->
|
|
|
|
</div>
|
|
|
|
|
|
<div class="aliases">
|
|
Also aliased as: <a href="FriendsAndFollowers.html#method-i-following">following</a>
|
|
</div>
|
|
|
|
|
|
|
|
</div><!-- friends-method -->
|
|
|
|
|
|
<div id="friendship-method" class="method-detail ">
|
|
<a name="method-i-friendship"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">friendship</span><span
|
|
class="method-args">(source, target, options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Returns detailed information about the relationship between two users</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/friendships/show">dev.twitter.com/docs/api/1.1/get/friendships/show</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
|
|
[Twitter::Relationship] @param source [Integer, String, Twitter::User] The
|
|
<a href="../../Twitter.html">Twitter</a> user ID, screen name, or object of
|
|
the source user. @param target [Integer, String, Twitter::User] The <a
|
|
href="../../Twitter.html">Twitter</a> user ID, screen name, or object of
|
|
the target user. @param options [Hash] A customizable set of options.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="friendship-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 185</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">friendship</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">target</span>, <span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-identifier">merge_user!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-identifier">source</span>, <span class="ruby-string">'source'</span>)
|
|
<span class="ruby-identifier">options</span>[<span class="ruby-value">:source_id</span>] = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:source_user_id</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:source_user_id</span>].<span class="ruby-identifier">nil?</span>
|
|
<span class="ruby-identifier">merge_user!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-identifier">target</span>, <span class="ruby-string">'target'</span>)
|
|
<span class="ruby-identifier">options</span>[<span class="ruby-value">:target_id</span>] = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:target_user_id</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:target_user_id</span>].<span class="ruby-identifier">nil?</span>
|
|
<span class="ruby-identifier">perform_with_object</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/friendships/show.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Relationship</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- friendship-source -->
|
|
|
|
</div>
|
|
|
|
|
|
<div class="aliases">
|
|
Also aliased as: <a href="FriendsAndFollowers.html#method-i-friendship_show">friendship_show</a>, <a href="FriendsAndFollowers.html#method-i-relationship">relationship</a>
|
|
</div>
|
|
|
|
|
|
|
|
</div><!-- friendship-method -->
|
|
|
|
|
|
<div id="friendship-3F-method" class="method-detail ">
|
|
<a name="method-i-friendship-3F"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">friendship?</span><span
|
|
class="method-args">(source, target, options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Test for the existence of friendship between two users</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/friendships/show">dev.twitter.com/docs/api/1.1/get/friendships/show</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 [Boolean] true if
|
|
user_a follows user_b, otherwise false. @param source [Integer, String,
|
|
Twitter::User] The <a href="../../Twitter.html">Twitter</a> user ID, screen
|
|
name, or object of the source user. @param target [Integer, String,
|
|
Twitter::User] The <a href="../../Twitter.html">Twitter</a> user ID, screen
|
|
name, or object of the target user. @param options [Hash] A customizable
|
|
set of options.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="friendship-3F-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 205</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">friendship?</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">target</span>, <span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-identifier">friendship</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">target</span>, <span class="ruby-identifier">options</span>).<span class="ruby-identifier">source</span>.<span class="ruby-identifier">following?</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- friendship-3F-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- friendship-3F-method -->
|
|
|
|
|
|
<div id="friendship_show-method" class="method-detail method-alias">
|
|
<a name="method-i-friendship_show"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">friendship_show</span><span
|
|
class="method-args">(source, target, 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="FriendsAndFollowers.html#method-i-friendship">friendship</a>
|
|
</div>
|
|
|
|
</div><!-- friendship_show-method -->
|
|
|
|
|
|
<div id="friendship_update-method" class="method-detail ">
|
|
<a name="method-i-friendship_update"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">friendship_update</span><span
|
|
class="method-args">(user, options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Allows one to enable or disable retweets and device notifications from the
|
|
specified user.</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/post/friendships/update">dev.twitter.com/docs/api/1.1/post/friendships/update</a>
|
|
@rate_limited No @authentication Requires user context @raise
|
|
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
|
when supplied user credentials are not valid. @return
|
|
[Twitter::Relationship] @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
|
|
[Boolean] :device Enable/disable device notifications from the target user.
|
|
@option options [Boolean] :retweets Enable/disable retweets from the target
|
|
user.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="friendship_update-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 170</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">friendship_update</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-identifier">merge_user!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-identifier">user</span>)
|
|
<span class="ruby-identifier">perform_with_object</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/friendships/update.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Relationship</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- friendship_update-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- friendship_update-method -->
|
|
|
|
|
|
<div id="friendships-method" class="method-detail ">
|
|
<a name="method-i-friendships"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">friendships</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 relationship of the authenticating user to the comma separated
|
|
list of up to 100 screen_names or user_ids provided. Values for connections
|
|
can be: following, following_requested, followed_by, none.</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/friendships/lookup">dev.twitter.com/docs/api/1.1/get/friendships/lookup</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::User>] The requested users. @overload
|
|
friendships(*users)</p>
|
|
|
|
<pre>@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.</pre>
|
|
|
|
<p>@overload friendships(*users, options)</p>
|
|
|
|
<pre>@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
|
|
@param options [Hash] A customizable set of options.</pre>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="friendships-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 63</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">friendships</span>(*<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">arguments</span> = <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Arguments</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">merge_users!</span>(<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">options</span>, <span class="ruby-identifier">arguments</span>)
|
|
<span class="ruby-identifier">perform_with_objects</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/friendships/lookup.json'</span>, <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- friendships-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- friendships-method -->
|
|
|
|
|
|
<div id="friendships_incoming-method" class="method-detail ">
|
|
<a name="method-i-friendships_incoming"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">friendships_incoming</span><span
|
|
class="method-args">(options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Returns an array of numeric IDs for every user who has a pending request to
|
|
follow the authenticating user</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/friendships/incoming">dev.twitter.com/docs/api/1.1/get/friendships/incoming</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 [Twitter::Cursor]
|
|
@param options [Hash] A customizable set of options.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="friendships_incoming-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 77</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">friendships_incoming</span>(<span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-identifier">perform_with_cursor</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/friendships/incoming.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-value">:ids</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- friendships_incoming-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- friendships_incoming-method -->
|
|
|
|
|
|
<div id="friendships_outgoing-method" class="method-detail ">
|
|
<a name="method-i-friendships_outgoing"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">friendships_outgoing</span><span
|
|
class="method-args">(options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Returns an array of numeric IDs for every protected user for whom the
|
|
authenticating user has a pending follow request</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/friendships/outgoing">dev.twitter.com/docs/api/1.1/get/friendships/outgoing</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 [Twitter::Cursor]
|
|
@param options [Hash] A customizable set of options.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="friendships_outgoing-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 89</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">friendships_outgoing</span>(<span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-identifier">perform_with_cursor</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/friendships/outgoing.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-value">:ids</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- friendships_outgoing-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- friendships_outgoing-method -->
|
|
|
|
|
|
<div id="no_retweet_ids-method" class="method-detail ">
|
|
<a name="method-i-no_retweet_ids"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">no_retweet_ids</span><span
|
|
class="method-args">(options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Returns a collection of user IDs that the currently authenticated user does
|
|
not want to receive retweets from. @see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/friendships/no_retweets/ids">dev.twitter.com/docs/api/1.1/get/friendships/no_retweets/ids</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<Integer>] @param options [Hash] A customizable set of options.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="no_retweet_ids-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 265</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">no_retweet_ids</span>(<span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-identifier">get</span>(<span class="ruby-string">'/1.1/friendships/no_retweets/ids.json'</span>, <span class="ruby-identifier">options</span>).<span class="ruby-identifier">body</span>.<span class="ruby-identifier">collect</span>(&<span class="ruby-value">:to_i</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- no_retweet_ids-source -->
|
|
|
|
</div>
|
|
|
|
|
|
<div class="aliases">
|
|
Also aliased as: <a href="FriendsAndFollowers.html#method-i-no_retweets_ids">no_retweets_ids</a>
|
|
</div>
|
|
|
|
|
|
|
|
</div><!-- no_retweet_ids-method -->
|
|
|
|
|
|
<div id="no_retweets_ids-method" class="method-detail method-alias">
|
|
<a name="method-i-no_retweets_ids"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">no_retweets_ids</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="FriendsAndFollowers.html#method-i-no_retweet_ids">no_retweet_ids</a>
|
|
</div>
|
|
|
|
</div><!-- no_retweets_ids-method -->
|
|
|
|
|
|
<div id="relationship-method" class="method-detail method-alias">
|
|
<a name="method-i-relationship"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">relationship</span><span
|
|
class="method-args">(source, target, 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="FriendsAndFollowers.html#method-i-friendship">friendship</a>
|
|
</div>
|
|
|
|
</div><!-- relationship-method -->
|
|
|
|
|
|
<div id="unfollow-method" class="method-detail ">
|
|
<a name="method-i-unfollow"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">unfollow</span><span
|
|
class="method-args">(*args)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Allows the authenticating user to unfollow the specified users</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/post/friendships/destroy">dev.twitter.com/docs/api/1.1/post/friendships/destroy</a>
|
|
@rate_limited No @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::User>] The unfollowed users. @overload
|
|
unfollow(*users)</p>
|
|
|
|
<pre>@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.</pre>
|
|
|
|
<p>@overload unfollow(*users, options)</p>
|
|
|
|
<pre>@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
|
|
@param options [Hash] A customizable set of options.</pre>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="unfollow-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/rest/friends_and_followers.rb, line 153</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">unfollow</span>(*<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">parallel_users_from_response</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/friendships/destroy.json'</span>, <span class="ruby-identifier">args</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- unfollow-source -->
|
|
|
|
</div>
|
|
|
|
|
|
<div class="aliases">
|
|
Also aliased as: <a href="FriendsAndFollowers.html#method-i-destroy_friendship">destroy_friendship</a>
|
|
</div>
|
|
|
|
|
|
|
|
</div><!-- unfollow-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>
|
|
|