742 lines
30 KiB
HTML
742 lines
30 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>Class: Twitter::REST::Client</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="class">
|
||
|
||
<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/client_rb.html?TB_iframe=true&height=550&width=785"
|
||
class="thickbox" title="lib/twitter/rest/client.rb">lib/twitter/rest/client.rb</a></li>
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div id="class-metadata">
|
||
|
||
<!-- Parent Class -->
|
||
<div id="parent-class-section" class="section">
|
||
<h3 class="section-header">Parent</h3>
|
||
|
||
<p class="link"><a href="../Client.html">Twitter::Client</a></p>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!-- Method Quickref -->
|
||
<div id="method-list-section" class="section">
|
||
<h3 class="section-header">Methods</h3>
|
||
<ul class="link-list">
|
||
|
||
<li><a href="#method-i-bearer_token-3F">#bearer_token?</a></li>
|
||
|
||
<li><a href="#method-i-connection_options">#connection_options</a></li>
|
||
|
||
<li><a href="#method-i-connection_options-3D">#connection_options=</a></li>
|
||
|
||
<li><a href="#method-i-credentials-3F">#credentials?</a></li>
|
||
|
||
<li><a href="#method-i-get">#get</a></li>
|
||
|
||
<li><a href="#method-i-middleware">#middleware</a></li>
|
||
|
||
<li><a href="#method-i-middleware-3D">#middleware=</a></li>
|
||
|
||
<li><a href="#method-i-post">#post</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="API.html">Twitter::REST::API</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="class">Twitter::REST::Client</h1>
|
||
|
||
<div id="description" class="description">
|
||
|
||
<p>Wrapper for the <a href="../../Twitter.html">Twitter</a> <a
|
||
href="../REST.html">REST</a> <a href="API.html">API</a></p>
|
||
|
||
<p>@note All methods have been separated into modules and follow the same
|
||
grouping used in {<a
|
||
href="http://dev.twitter.com/doc">dev.twitter.com/doc</a> the <a
|
||
href="../../Twitter.html">Twitter</a> <a href="API.html">API</a>
|
||
Documentation}. @see <a
|
||
href="http://dev.twitter.com/pages/every_developer">dev.twitter.com/pages/every_developer</a></p>
|
||
|
||
</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="ENDPOINT">ENDPOINT</a></dt>
|
||
|
||
<dd class="description"></dd>
|
||
|
||
|
||
<dt><a name="URL_PREFIX">URL_PREFIX</a></dt>
|
||
|
||
<dd class="description"></dd>
|
||
|
||
|
||
</dl>
|
||
</div>
|
||
|
||
|
||
|
||
<!-- Attributes -->
|
||
<div id="attribute-method-details" class="method-section section">
|
||
<h3 class="section-header">Attributes</h3>
|
||
|
||
|
||
<div id="bearer_token-attribute-method" class="method-detail">
|
||
<a name="bearer_token"></a>
|
||
|
||
<a name="bearer_token="></a>
|
||
|
||
<div class="method-heading attribute-method-heading">
|
||
<span class="method-name">bearer_token</span><span
|
||
class="attribute-access-type">[RW]</span>
|
||
</div>
|
||
|
||
<div class="method-description">
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div><!-- attribute-method-details -->
|
||
|
||
|
||
<!-- Methods -->
|
||
|
||
<div id="public-instance-method-details" class="method-section section">
|
||
<h3 class="section-header">Public Instance Methods</h3>
|
||
|
||
|
||
<div id="bearer_token-3F-method" class="method-detail ">
|
||
<a name="method-i-bearer_token-3F"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">bearer_token?</span><span
|
||
class="method-args">()</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>@return [Boolean]</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="bearer_token-3F-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/client.rb, line 89</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">bearer_token?</span>
|
||
<span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-identifier">bearer_token</span>
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- bearer_token-3F-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- bearer_token-3F-method -->
|
||
|
||
|
||
<div id="connection_options-method" class="method-detail ">
|
||
<a name="method-i-connection_options"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">connection_options</span><span
|
||
class="method-args">()</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>@return [Hash]</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="connection_options-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/client.rb, line 33</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">connection_options</span>
|
||
<span class="ruby-ivar">@connection_options</span> <span class="ruby-operator">||=</span> {
|
||
<span class="ruby-value">:builder</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">middleware</span>,
|
||
<span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> {
|
||
<span class="ruby-value">:accept</span> =<span class="ruby-operator">></span> <span class="ruby-string">'application/json'</span>,
|
||
<span class="ruby-value">:user_agent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">user_agent</span>,
|
||
},
|
||
<span class="ruby-value">:request</span> =<span class="ruby-operator">></span> {
|
||
<span class="ruby-value">:open_timeout</span> =<span class="ruby-operator">></span> <span class="ruby-value">10</span>,
|
||
<span class="ruby-value">:timeout</span> =<span class="ruby-operator">></span> <span class="ruby-value">30</span>,
|
||
},
|
||
<span class="ruby-value">:proxy</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">proxy</span>
|
||
}
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- connection_options-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- connection_options-method -->
|
||
|
||
|
||
<div id="connection_options-3D-method" class="method-detail ">
|
||
<a name="method-i-connection_options-3D"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">connection_options=</span><span
|
||
class="method-args">(connection_options)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>@param <a
|
||
href="Client.html#method-i-connection_options">connection_options</a>
|
||
[Hash] @return [Hash]</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="connection_options-3D-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/client.rb, line 27</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">connection_options=</span>(<span class="ruby-identifier">connection_options</span>)
|
||
<span class="ruby-identifier">warn</span> <span class="ruby-node">"#{Kernel.caller.first}: [DEPRECATION] Twitter::REST::Client#connection_options= is deprecated and will be removed in version 6.0.0."</span>
|
||
<span class="ruby-ivar">@connection_options</span> = <span class="ruby-identifier">connection_options</span>
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- connection_options-3D-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- connection_options-3D-method -->
|
||
|
||
|
||
<div id="credentials-3F-method" class="method-detail ">
|
||
<a name="method-i-credentials-3F"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">credentials?</span><span
|
||
class="method-args">()</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>@return [Boolean]</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="credentials-3F-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/client.rb, line 94</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">credentials?</span>
|
||
<span class="ruby-keyword">super</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">bearer_token?</span>
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- credentials-3F-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- credentials-3F-method -->
|
||
|
||
|
||
<div id="get-method" class="method-detail ">
|
||
<a name="method-i-get"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">get</span><span
|
||
class="method-args">(path, params = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Perform an HTTP GET request</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="get-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/client.rb, line 77</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">params</span> = {})
|
||
<span class="ruby-identifier">headers</span> = <span class="ruby-identifier">request_headers</span>(<span class="ruby-value">:get</span>, <span class="ruby-constant">URL_PREFIX</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">path</span>, <span class="ruby-identifier">params</span>)
|
||
<span class="ruby-identifier">request</span>(<span class="ruby-value">:get</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">params</span>, <span class="ruby-identifier">headers</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- get-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- get-method -->
|
||
|
||
|
||
<div id="middleware-method" class="method-detail ">
|
||
<a name="method-i-middleware"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">middleware</span><span
|
||
class="method-args">()</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>@note Faraday’s middleware stack implementation is comparable to that of
|
||
Rack middleware. The order of middleware is important: the first
|
||
middleware on the list wraps all others, while the last middleware is the
|
||
innermost one. @see <a
|
||
href="https://github.com/technoweenie/faraday#advanced-middleware-usage">github.com/technoweenie/faraday#advanced-middleware-usage</a>
|
||
@see <a
|
||
href="http://mislav.uniqpath.com/2011/07/faraday-advanced-http/">mislav.uniqpath.com/2011/07/faraday-advanced-http/</a>
|
||
@return [Faraday::RackBuilder]</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="middleware-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/client.rb, line 59</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">middleware</span>
|
||
<span class="ruby-ivar">@middleware</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Faraday</span><span class="ruby-operator">::</span><span class="ruby-constant">RackBuilder</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">faraday</span><span class="ruby-operator">|</span>
|
||
<span class="ruby-comment"># Convert file uploads to Faraday::UploadIO objects</span>
|
||
<span class="ruby-identifier">faraday</span>.<span class="ruby-identifier">request</span> <span class="ruby-value">:multipart_with_file</span>
|
||
<span class="ruby-comment"># Checks for files in the payload, otherwise leaves everything untouched</span>
|
||
<span class="ruby-identifier">faraday</span>.<span class="ruby-identifier">request</span> <span class="ruby-value">:multipart</span>
|
||
<span class="ruby-comment"># Encodes as "application/x-www-form-urlencoded" if not already encoded</span>
|
||
<span class="ruby-identifier">faraday</span>.<span class="ruby-identifier">request</span> <span class="ruby-value">:url_encoded</span>
|
||
<span class="ruby-comment"># Handle error responses</span>
|
||
<span class="ruby-identifier">faraday</span>.<span class="ruby-identifier">response</span> <span class="ruby-value">:raise_error</span>
|
||
<span class="ruby-comment"># Parse JSON response bodies</span>
|
||
<span class="ruby-identifier">faraday</span>.<span class="ruby-identifier">response</span> <span class="ruby-value">:parse_json</span>
|
||
<span class="ruby-comment"># Set default HTTP adapter</span>
|
||
<span class="ruby-identifier">faraday</span>.<span class="ruby-identifier">adapter</span> <span class="ruby-value">:net_http</span>
|
||
<span class="ruby-keyword">end</span>
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- middleware-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- middleware-method -->
|
||
|
||
|
||
<div id="middleware-3D-method" class="method-detail ">
|
||
<a name="method-i-middleware-3D"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">middleware=</span><span
|
||
class="method-args">(middleware)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>@params middleware [Faraday::RackBuilder] @return [Faraday::RackBuilder]</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="middleware-3D-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/client.rb, line 50</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">middleware=</span>(<span class="ruby-identifier">middleware</span>)
|
||
<span class="ruby-identifier">warn</span> <span class="ruby-node">"#{Kernel.caller.first}: [DEPRECATION] Twitter::REST::Client#middleware= is deprecated and will be removed in version 6.0.0."</span>
|
||
<span class="ruby-ivar">@middleware</span> = <span class="ruby-identifier">middleware</span>
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- middleware-3D-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- middleware-3D-method -->
|
||
|
||
|
||
<div id="post-method" class="method-detail ">
|
||
<a name="method-i-post"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">post</span><span
|
||
class="method-args">(path, params = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Perform an HTTP POST request</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="post-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/client.rb, line 83</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">post</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">params</span> = {})
|
||
<span class="ruby-identifier">headers</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">values</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_io</span>) } <span class="ruby-operator">?</span> <span class="ruby-identifier">request_headers</span>(<span class="ruby-value">:post</span>, <span class="ruby-constant">URL_PREFIX</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">path</span>, <span class="ruby-identifier">params</span>, {}) <span class="ruby-operator">:</span> <span class="ruby-identifier">request_headers</span>(<span class="ruby-value">:post</span>, <span class="ruby-constant">URL_PREFIX</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">path</span>, <span class="ruby-identifier">params</span>)
|
||
<span class="ruby-identifier">request</span>(<span class="ruby-value">:post</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">params</span>, <span class="ruby-identifier">headers</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- post-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- post-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>
|
||
|