PlacesGeoResourcesAsync.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_161) on Thu Aug 16 18:54:18 JST 2018 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>PlacesGeoResourcesAsync (twitter4j-async 4.0.7 API)</title>
  8. <meta name="date" content="2018-08-16">
  9. <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
  10. <script type="text/javascript" src="../../script.js"></script>
  11. </head>
  12. <body>
  13. <script type="text/javascript"><!--
  14. try {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="PlacesGeoResourcesAsync (twitter4j-async 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  24. var altColor = "altColor";
  25. var rowColor = "rowColor";
  26. var tableTab = "tableTab";
  27. var activeTableTab = "activeTableTab";
  28. </script>
  29. <noscript>
  30. <div>JavaScript is disabled on your browser.</div>
  31. </noscript>
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="Navigation">
  41. <li><a href="../../overview-summary.html">Overview</a></li>
  42. <li><a href="package-summary.html">Package</a></li>
  43. <li class="navBarCell1Rev">Class</li>
  44. <li><a href="class-use/PlacesGeoResourcesAsync.html">Use</a></li>
  45. <li><a href="package-tree.html">Tree</a></li>
  46. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  47. <li><a href="../../index-all.html">Index</a></li>
  48. <li><a href="../../help-doc.html">Help</a></li>
  49. </ul>
  50. </div>
  51. <div class="subNav">
  52. <ul class="navList">
  53. <li><a href="../../twitter4j/api/ListsResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../../twitter4j/api/SavedSearchesResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../../index.html?twitter4j/api/PlacesGeoResourcesAsync.html" target="_top">Frames</a></li>
  58. <li><a href="PlacesGeoResourcesAsync.html" target="_top">No&nbsp;Frames</a></li>
  59. </ul>
  60. <ul class="navList" id="allclasses_navbar_top">
  61. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  62. </ul>
  63. <div>
  64. <script type="text/javascript"><!--
  65. allClassesLink = document.getElementById("allclasses_navbar_top");
  66. if(window==top) {
  67. allClassesLink.style.display = "block";
  68. }
  69. else {
  70. allClassesLink.style.display = "none";
  71. }
  72. //-->
  73. </script>
  74. </div>
  75. <div>
  76. <ul class="subNavList">
  77. <li>Summary:&nbsp;</li>
  78. <li>Nested&nbsp;|&nbsp;</li>
  79. <li>Field&nbsp;|&nbsp;</li>
  80. <li>Constr&nbsp;|&nbsp;</li>
  81. <li><a href="#method.summary">Method</a></li>
  82. </ul>
  83. <ul class="subNavList">
  84. <li>Detail:&nbsp;</li>
  85. <li>Field&nbsp;|&nbsp;</li>
  86. <li>Constr&nbsp;|&nbsp;</li>
  87. <li><a href="#method.detail">Method</a></li>
  88. </ul>
  89. </div>
  90. <a name="skip.navbar.top">
  91. <!-- -->
  92. </a></div>
  93. <!-- ========= END OF TOP NAVBAR ========= -->
  94. <!-- ======== START OF CLASS DATA ======== -->
  95. <div class="header">
  96. <div class="subTitle">twitter4j.api</div>
  97. <h2 title="Interface PlacesGeoResourcesAsync" class="title">Interface PlacesGeoResourcesAsync</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <div class="description">
  101. <ul class="blockList">
  102. <li class="blockList">
  103. <dl>
  104. <dt>All Known Subinterfaces:</dt>
  105. <dd><a href="../../twitter4j/AsyncTwitter.html" title="interface in twitter4j">AsyncTwitter</a></dd>
  106. </dl>
  107. <hr>
  108. <br>
  109. <pre>public interface <span class="typeNameLabel">PlacesGeoResourcesAsync</span></pre>
  110. <dl>
  111. <dt><span class="simpleTagLabel">Since:</span></dt>
  112. <dd>Twitter4J 2.1.1</dd>
  113. <dt><span class="simpleTagLabel">Author:</span></dt>
  114. <dd>Yusuke Yamamoto - yusuke at mac.com</dd>
  115. </dl>
  116. </li>
  117. </ul>
  118. </div>
  119. <div class="summary">
  120. <ul class="blockList">
  121. <li class="blockList">
  122. <!-- ========== METHOD SUMMARY =========== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="method.summary">
  125. <!-- -->
  126. </a>
  127. <h3>Method Summary</h3>
  128. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  129. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  130. <tr>
  131. <th class="colFirst" scope="col">Modifier and Type</th>
  132. <th class="colLast" scope="col">Method and Description</th>
  133. </tr>
  134. <tr id="i0" class="altColor">
  135. <td class="colFirst"><code>void</code></td>
  136. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/PlacesGeoResourcesAsync.html#getGeoDetails-java.lang.String-">getGeoDetails</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>
  137. <div class="block">Find out more details of a place that was returned from the <a href="../../twitter4j/api/PlacesGeoResourcesAsync.html#reverseGeoCode-twitter4j.GeoQuery-"><code>reverseGeoCode(twitter4j.GeoQuery)</code></a> method.</div>
  138. </td>
  139. </tr>
  140. <tr id="i1" class="rowColor">
  141. <td class="colFirst"><code>void</code></td>
  142. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/PlacesGeoResourcesAsync.html#getSimilarPlaces-twitter4j.GeoLocation-java.lang.String-java.lang.String-java.lang.String-">getSimilarPlaces</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/GeoLocation.html?is-external=true" title="class or interface in twitter4j">GeoLocation</a>&nbsp;location,
  143. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
  144. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;containedWithin,
  145. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streetAddress)</code>
  146. <div class="block">Locates places near the given coordinates which are similar in name.</div>
  147. </td>
  148. </tr>
  149. <tr id="i2" class="altColor">
  150. <td class="colFirst"><code>void</code></td>
  151. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/PlacesGeoResourcesAsync.html#reverseGeoCode-twitter4j.GeoQuery-">reverseGeoCode</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/GeoQuery.html?is-external=true" title="class or interface in twitter4j">GeoQuery</a>&nbsp;query)</code>
  152. <div class="block">Search for places (cities and neighborhoods) that can be attached to a statuses/update.</div>
  153. </td>
  154. </tr>
  155. <tr id="i3" class="rowColor">
  156. <td class="colFirst"><code>void</code></td>
  157. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/PlacesGeoResourcesAsync.html#searchPlaces-twitter4j.GeoQuery-">searchPlaces</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/GeoQuery.html?is-external=true" title="class or interface in twitter4j">GeoQuery</a>&nbsp;query)</code>
  158. <div class="block">Search for places that can be attached to a statuses/update.</div>
  159. </td>
  160. </tr>
  161. </table>
  162. </li>
  163. </ul>
  164. </li>
  165. </ul>
  166. </div>
  167. <div class="details">
  168. <ul class="blockList">
  169. <li class="blockList">
  170. <!-- ============ METHOD DETAIL ========== -->
  171. <ul class="blockList">
  172. <li class="blockList"><a name="method.detail">
  173. <!-- -->
  174. </a>
  175. <h3>Method Detail</h3>
  176. <a name="getGeoDetails-java.lang.String-">
  177. <!-- -->
  178. </a>
  179. <ul class="blockList">
  180. <li class="blockList">
  181. <h4>getGeoDetails</h4>
  182. <pre>void&nbsp;getGeoDetails(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</pre>
  183. <div class="block">Find out more details of a place that was returned from the <a href="../../twitter4j/api/PlacesGeoResourcesAsync.html#reverseGeoCode-twitter4j.GeoQuery-"><code>reverseGeoCode(twitter4j.GeoQuery)</code></a> method.
  184. <br>This method calls https://api.twitter.com/1.1/geo/id/:id.json</div>
  185. <dl>
  186. <dt><span class="paramLabel">Parameters:</span></dt>
  187. <dd><code>id</code> - The ID of the location to query about.</dd>
  188. <dt><span class="simpleTagLabel">Since:</span></dt>
  189. <dd>Twitter4J 2.1.1</dd>
  190. <dt><span class="seeLabel">See Also:</span></dt>
  191. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/geo/id/:place_id">GET geo/id/:place_id | Twitter Developers</a></dd>
  192. </dl>
  193. </li>
  194. </ul>
  195. <a name="getSimilarPlaces-twitter4j.GeoLocation-java.lang.String-java.lang.String-java.lang.String-">
  196. <!-- -->
  197. </a>
  198. <ul class="blockList">
  199. <li class="blockList">
  200. <h4>getSimilarPlaces</h4>
  201. <pre>void&nbsp;getSimilarPlaces(<a href="http://twitter4j.org/apidocs/twitter4j/GeoLocation.html?is-external=true" title="class or interface in twitter4j">GeoLocation</a>&nbsp;location,
  202. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
  203. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;containedWithin,
  204. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streetAddress)</pre>
  205. <div class="block">Locates places near the given coordinates which are similar in name.
  206. <br>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 post/geo/place to create a new one.
  207. <br>The token contained in the response is the token needed to be able to create a new place.
  208. <br>This method calls https://api.twitter.com/1.1/geo/similar_places.json</div>
  209. <dl>
  210. <dt><span class="paramLabel">Parameters:</span></dt>
  211. <dd><code>location</code> - The latitude and longitude to search around.</dd>
  212. <dd><code>name</code> - The name a place is known as.</dd>
  213. <dd><code>containedWithin</code> - optional: 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.</dd>
  214. <dd><code>streetAddress</code> - optional: This parameter searches for places which have this given street address. There are other well-known, and application specific attributes available. Custom attributes are also permitted. Learn more about Place Attributes.</dd>
  215. <dt><span class="simpleTagLabel">Since:</span></dt>
  216. <dd>Twitter4J 2.1.7</dd>
  217. </dl>
  218. </li>
  219. </ul>
  220. <a name="reverseGeoCode-twitter4j.GeoQuery-">
  221. <!-- -->
  222. </a>
  223. <ul class="blockList">
  224. <li class="blockList">
  225. <h4>reverseGeoCode</h4>
  226. <pre>void&nbsp;reverseGeoCode(<a href="http://twitter4j.org/apidocs/twitter4j/GeoQuery.html?is-external=true" title="class or interface in twitter4j">GeoQuery</a>&nbsp;query)</pre>
  227. <div class="block">Search for places (cities and neighborhoods) that can be attached to a statuses/update. Given a latitude and a longitude, return a list of all the valid places that can be used as a place_id when updating a status. Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location up with a call to statuses/update.<br>
  228. There are multiple granularities of places that can be returned -- "neighborhoods", "cities", etc. At this time, only United States data is available through this method.<br>
  229. This API call is meant to be an informative call and will deliver generalized results about geography.
  230. <br>This method calls https://api.twitter.com/1.1/geo/reverse_geocode.json</div>
  231. <dl>
  232. <dt><span class="paramLabel">Parameters:</span></dt>
  233. <dd><code>query</code> - search query</dd>
  234. <dt><span class="simpleTagLabel">Since:</span></dt>
  235. <dd>Twitter4J 2.1.1</dd>
  236. <dt><span class="seeLabel">See Also:</span></dt>
  237. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/geo/reverse_geocode">GET geo/reverse_geocode | Twitter Developers</a></dd>
  238. </dl>
  239. </li>
  240. </ul>
  241. <a name="searchPlaces-twitter4j.GeoQuery-">
  242. <!-- -->
  243. </a>
  244. <ul class="blockListLast">
  245. <li class="blockList">
  246. <h4>searchPlaces</h4>
  247. <pre>void&nbsp;searchPlaces(<a href="http://twitter4j.org/apidocs/twitter4j/GeoQuery.html?is-external=true" title="class or interface in twitter4j">GeoQuery</a>&nbsp;query)</pre>
  248. <div class="block">Search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status.
  249. <br>Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location with a call to statuses/update.
  250. <br>This is the recommended method to use find places that can be attached to statuses/update. Unlike geo/reverse_geocode which provides raw data access, this endpoint can potentially re-order places with regards to the user who is authenticated. This approach is also preferred for interactive place matching with the user.
  251. <br>This method calls https://api.twitter.com/1.1/geo/search.json</div>
  252. <dl>
  253. <dt><span class="paramLabel">Parameters:</span></dt>
  254. <dd><code>query</code> - search query</dd>
  255. <dt><span class="simpleTagLabel">Since:</span></dt>
  256. <dd>Twitter4J 2.1.7</dd>
  257. <dt><span class="seeLabel">See Also:</span></dt>
  258. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/geo/search">GET geo/search | Twitter Developers</a></dd>
  259. </dl>
  260. </li>
  261. </ul>
  262. </li>
  263. </ul>
  264. </li>
  265. </ul>
  266. </div>
  267. </div>
  268. <!-- ========= END OF CLASS DATA ========= -->
  269. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  270. <div class="bottomNav"><a name="navbar.bottom">
  271. <!-- -->
  272. </a>
  273. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  274. <a name="navbar.bottom.firstrow">
  275. <!-- -->
  276. </a>
  277. <ul class="navList" title="Navigation">
  278. <li><a href="../../overview-summary.html">Overview</a></li>
  279. <li><a href="package-summary.html">Package</a></li>
  280. <li class="navBarCell1Rev">Class</li>
  281. <li><a href="class-use/PlacesGeoResourcesAsync.html">Use</a></li>
  282. <li><a href="package-tree.html">Tree</a></li>
  283. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  284. <li><a href="../../index-all.html">Index</a></li>
  285. <li><a href="../../help-doc.html">Help</a></li>
  286. </ul>
  287. </div>
  288. <div class="subNav">
  289. <ul class="navList">
  290. <li><a href="../../twitter4j/api/ListsResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  291. <li><a href="../../twitter4j/api/SavedSearchesResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  292. </ul>
  293. <ul class="navList">
  294. <li><a href="../../index.html?twitter4j/api/PlacesGeoResourcesAsync.html" target="_top">Frames</a></li>
  295. <li><a href="PlacesGeoResourcesAsync.html" target="_top">No&nbsp;Frames</a></li>
  296. </ul>
  297. <ul class="navList" id="allclasses_navbar_bottom">
  298. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  299. </ul>
  300. <div>
  301. <script type="text/javascript"><!--
  302. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  303. if(window==top) {
  304. allClassesLink.style.display = "block";
  305. }
  306. else {
  307. allClassesLink.style.display = "none";
  308. }
  309. //-->
  310. </script>
  311. </div>
  312. <div>
  313. <ul class="subNavList">
  314. <li>Summary:&nbsp;</li>
  315. <li>Nested&nbsp;|&nbsp;</li>
  316. <li>Field&nbsp;|&nbsp;</li>
  317. <li>Constr&nbsp;|&nbsp;</li>
  318. <li><a href="#method.summary">Method</a></li>
  319. </ul>
  320. <ul class="subNavList">
  321. <li>Detail:&nbsp;</li>
  322. <li>Field&nbsp;|&nbsp;</li>
  323. <li>Constr&nbsp;|&nbsp;</li>
  324. <li><a href="#method.detail">Method</a></li>
  325. </ul>
  326. </div>
  327. <a name="skip.navbar.bottom">
  328. <!-- -->
  329. </a></div>
  330. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  331. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  332. </body>
  333. </html>