ctdo
/
twitter-status-bot
16
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
twitter-status-bot/.gems/doc/twitter-5.11.0/rdoc/Twitter/REST/PlacesAndGeo.html

677 lines
29 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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::PlacesAndGeo</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/places_and_geo_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
class="thickbox" title="lib/twitter/rest/places_and_geo.rb">lib/twitter/rest/places_and_geo.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-geo_search">#geo_search</a></li>
<li><a href="#method-i-place">#place</a></li>
<li><a href="#method-i-places_nearby">#places_nearby</a></li>
<li><a href="#method-i-places_similar">#places_similar</a></li>
<li><a href="#method-i-reverse_geocode">#reverse_geocode</a></li>
<li><a href="#method-i-similar_places">#similar_places</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::PlacesAndGeo</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="geo_search-method" class="method-detail ">
<a name="method-i-geo_search"></a>
<div class="method-heading">
<span class="method-name">geo_search</span><span
class="method-args">(options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Search.html">Search</a> for places that can be attached to a {<a
href="Tweets.html#method-i-update">Twitter::REST::Tweets#update</a>}</p>
<p>@see <a
href="https://dev.twitter.com/docs/api/1.1/get/geo/search">dev.twitter.com/docs/api/1.1/get/geo/search</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. @param options [Hash] A
customizable set of options. @option options [Float] :lat The latitude to
search around. This option will be ignored unless it is inside the range
-90.0 to +90.0 (North is positive) inclusive. It will also be ignored if
there isn’t a corresponding :long option. @option options [Float] :long The
longitude to search around. The valid range for longitude is -180.0 to
+180.0 (East is positive) inclusive. This option will be ignored if outside
that range, if it is not a number, if geo_enabled is disabled, or if there
not a corresponding :lat option. @option options [String] :query Free-form
text to match against while executing a geo-based query, best suited for
finding nearby locations by name. @option options [String] :ip An IP
address. Used when attempting to fix geolocation based off of the user’s IP
address. @option options [String] :granularity (‘neighborhood’) This is the
minimal granularity of place types to return and must be one of: ‘poi’,
‘neighborhood’, ‘city’, ‘admin’ or ‘country’. @option options [String]
:accuracy (‘0m’) A hint on the “region” in which to search. If a number,
then this is a radius in meters, but it can also take a string that is
suffixed with ft to specify feet. If coming from a device, in practice,
this value is whatever accuracy the device has measuring its location
(whether it be coming from a GPS, WiFi triangulation, etc.). @option
options [Integer] :max_results A hint as to the number of results to
return. This does not guarantee that the number of results returned will
equal max_results, but instead informs how many “nearby” results to return.
Ideally, only pass in the number of places you intend to display to the
user here. @option options [String] :contained_within This is the place_id
which you would like to restrict the search results to. Setting this value
means only places within the given place_id will be found. @option options
[String] :“attribute:street_address” This option searches for places which
have this given street address. There are other well-known and
application-specific attributes available. Custom attributes are also
permitted. @return [Array&lt;Twitter::Place&gt;]</p>
<div class="method-source-code" id="geo_search-source">
<pre>
<span class="ruby-comment"># File lib/twitter/rest/places_and_geo.rb, line 59</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">geo_search</span>(<span class="ruby-identifier">options</span> = {})
<span class="ruby-identifier">perform_with_object</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/geo/search.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">GeoResults</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- geo_search-source -->
</div>
<div class="aliases">
Also aliased as: <a href="PlacesAndGeo.html#method-i-places_nearby">places_nearby</a>
</div>
</div><!-- geo_search-method -->
<div id="place-method" class="method-detail ">
<a name="method-i-place"></a>
<div class="method-heading">
<span class="method-name">place</span><span
class="method-args">(place_id, options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns all the information about a known place</p>
<p>@see <a
href="https://dev.twitter.com/docs/api/1.1/get/geo/id/:place_id">dev.twitter.com/docs/api/1.1/get/geo/id/:place_id</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. @param place_id [String] A
place in the world. These IDs can be retrieved from {<a
href="PlacesAndGeo.html#method-i-reverse_geocode">Twitter::REST::PlacesAndGeo#reverse_geocode</a>}.
@param options [Hash] A customizable set of options. @return
[Twitter::Place] The requested place.</p>
<div class="method-source-code" id="place-source">
<pre>
<span class="ruby-comment"># File lib/twitter/rest/places_and_geo.rb, line 20</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">place</span>(<span class="ruby-identifier">place_id</span>, <span class="ruby-identifier">options</span> = {})
<span class="ruby-identifier">perform_with_object</span>(<span class="ruby-value">:get</span>, <span class="ruby-node">&quot;/1.1/geo/id/#{place_id}.json&quot;</span>, <span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Place</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- place-source -->
</div>
</div><!-- place-method -->
<div id="places_nearby-method" class="method-detail method-alias">
<a name="method-i-places_nearby"></a>
<div class="method-heading">
<span class="method-name">places_nearby</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="PlacesAndGeo.html#method-i-geo_search">geo_search</a>
</div>
</div><!-- places_nearby-method -->
<div id="places_similar-method" class="method-detail method-alias">
<a name="method-i-places_similar"></a>
<div class="method-heading">
<span class="method-name">places_similar</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="PlacesAndGeo.html#method-i-similar_places">similar_places</a>
</div>
</div><!-- places_similar-method -->
<div id="reverse_geocode-method" class="method-detail ">
<a name="method-i-reverse_geocode"></a>
<div class="method-heading">
<span class="method-name">reverse_geocode</span><span
class="method-args">(options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Searches for up to 20 places that can be used as a place_id</p>
<p>@see <a
href="https://dev.twitter.com/docs/api/1.1/get/geo/reverse_geocode">dev.twitter.com/docs/api/1.1/get/geo/reverse_geocode</a>
@note This request is an informative call and will deliver generalized
results about geography. @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. @param options [Hash] A customizable set of options. @option
options [Float] :lat The latitude to search around. This option will be
ignored unless it is inside the range -90.0 to +90.0 (North is positive)
inclusive. It will also be ignored if there isn’t a corresponding :long
option. @option options [Float] :long The longitude to search around. The
valid range for longitude is -180.0 to +180.0 (East is positive) inclusive.
This option will be ignored if outside that range, if it is not a number,
if geo_enabled is disabled, or if there not a corresponding :lat option.
@option options [String] :accuracy (‘0m’) A hint on the “region” in which
to search. If a number, then this is a radius in meters, but it can also
take a string that is suffixed with ft to specify feet. If coming from a
device, in practice, this value is whatever accuracy the device has
measuring its location (whether it be coming from a GPS, WiFi
triangulation, etc.). @option options [String] :granularity
(‘neighborhood’) This is the minimal granularity of place types to return
and must be one of: ‘poi’, ‘neighborhood’, ‘city’, ‘admin’ or ‘country’.
@option options [Integer] :max_results A hint as to the number of results
to return. This does not guarantee that the number of results returned will
equal max_results, but instead informs how many “nearby” results to return.
Ideally, only pass in the number of places you intend to display to the
user here. @return [Array&lt;Twitter::Place&gt;]</p>
<div class="method-source-code" id="reverse_geocode-source">
<pre>
<span class="ruby-comment"># File lib/twitter/rest/places_and_geo.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">reverse_geocode</span>(<span class="ruby-identifier">options</span> = {})
<span class="ruby-identifier">perform_with_object</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/geo/reverse_geocode.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">GeoResults</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- reverse_geocode-source -->
</div>
</div><!-- reverse_geocode-method -->
<div id="similar_places-method" class="method-detail ">
<a name="method-i-similar_places"></a>
<div class="method-heading">
<span class="method-name">similar_places</span><span
class="method-args">(options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Locates places near the given coordinates which are similar in name</p>
<p>@see <a
href="https://dev.twitter.com/docs/api/1.1/get/geo/similar_places">dev.twitter.com/docs/api/1.1/get/geo/similar_places</a>
@note Conceptually, you would use this method to get a list of known places
to choose from first. Then, if the desired place doesn’t exist, make a
request to {<a
href="PlacesAndGeo.html#method-i-place">Twitter::REST::PlacesAndGeo#place</a>}
to create a new one. The token contained in the response is the token
necessary to create a new place. @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. @param options [Hash] A customizable set of options. @option
options [Float] :lat The latitude to search around. This option will be
ignored unless it is inside the range -90.0 to +90.0 (North is positive)
inclusive. It will also be ignored if there isn’t a corresponding :long
option. @option options [Float] :long The longitude to search around. The
valid range for longitude is -180.0 to +180.0 (East is positive) inclusive.
This option will be ignored if outside that range, if it is not a number,
if geo_enabled is disabled, or if there not a corresponding :lat option.
@option options [String] :name The name a place is known as. @option
options [String] :contained_within This is the place_id which you would
like to restrict the search results to. Setting this value means only
places within the given place_id will be found. @option options [String]
:“attribute:street_address” This option searches for places which have this
given street address. There are other well-known and application-specific
attributes available. Custom attributes are also permitted. @return
[Array&lt;Twitter::Place&gt;]</p>
<div class="method-source-code" id="similar_places-source">
<pre>
<span class="ruby-comment"># File lib/twitter/rest/places_and_geo.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">similar_places</span>(<span class="ruby-identifier">options</span> = {})
<span class="ruby-identifier">perform_with_object</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/geo/similar_places.json'</span>, <span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">GeoResults</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- similar_places-source -->
</div>
<div class="aliases">
Also aliased as: <a href="PlacesAndGeo.html#method-i-places_similar">places_similar</a>
</div>
</div><!-- similar_places-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>
Reference in New Issue View Git Blame Copy Permalink