TrendsResourcesAsync.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  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>TrendsResourcesAsync (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="TrendsResourcesAsync (twitter4j-async 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":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/TrendsResourcesAsync.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/TimelinesResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../../twitter4j/api/TweetsResourcesAsync.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/TrendsResourcesAsync.html" target="_top">Frames</a></li>
  58. <li><a href="TrendsResourcesAsync.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 TrendsResourcesAsync" class="title">Interface TrendsResourcesAsync</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">TrendsResourcesAsync</span></pre>
  110. <dl>
  111. <dt><span class="simpleTagLabel">Since:</span></dt>
  112. <dd>Twitter4J 2.1.3</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/TrendsResourcesAsync.html#getAvailableTrends--">getAvailableTrends</a></span>()</code>
  137. <div class="block">Retrieves the locations that Twitter has trending topic information for.</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/TrendsResourcesAsync.html#getClosestTrends-twitter4j.GeoLocation-">getClosestTrends</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/GeoLocation.html?is-external=true" title="class or interface in twitter4j">GeoLocation</a>&nbsp;location)</code>
  143. <div class="block">Returns the locations that Twitter has trending topic information for, closest to a specified location.<br>
  144. The response is an array of "locations" that encode the location's WOEID and some other human-readable information such as a canonical name and country the location belongs in.<br>
  145. A WOEID is a <a href="http://developer.yahoo.com/geo/geoplanet/">Yahoo! Where On Earth ID</a>.</div>
  146. </td>
  147. </tr>
  148. <tr id="i2" class="altColor">
  149. <td class="colFirst"><code>void</code></td>
  150. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/TrendsResourcesAsync.html#getPlaceTrends-int-">getPlaceTrends</a></span>(int&nbsp;woeid)</code>
  151. <div class="block">Returns the top 10 trending topics for a specific WOEID, if trending information is available for it.<br>
  152. The response is an array of "trend" objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on <a href="http://search.twitter.com/">Twitter Search</a>, and the Twitter Search URL.<br>
  153. This information is cached for 5 minutes.</div>
  154. </td>
  155. </tr>
  156. </table>
  157. </li>
  158. </ul>
  159. </li>
  160. </ul>
  161. </div>
  162. <div class="details">
  163. <ul class="blockList">
  164. <li class="blockList">
  165. <!-- ============ METHOD DETAIL ========== -->
  166. <ul class="blockList">
  167. <li class="blockList"><a name="method.detail">
  168. <!-- -->
  169. </a>
  170. <h3>Method Detail</h3>
  171. <a name="getPlaceTrends-int-">
  172. <!-- -->
  173. </a>
  174. <ul class="blockList">
  175. <li class="blockList">
  176. <h4>getPlaceTrends</h4>
  177. <pre>void&nbsp;getPlaceTrends(int&nbsp;woeid)</pre>
  178. <div class="block">Returns the top 10 trending topics for a specific WOEID, if trending information is available for it.<br>
  179. The response is an array of "trend" objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on <a href="http://search.twitter.com/">Twitter Search</a>, and the Twitter Search URL.<br>
  180. This information is cached for 5 minutes. Requesting more frequently than that will not return any more data, and will count against your rate limit usage.<br>
  181. <br>This method calls https://api.twitter.com/1.1/trends/place.json</div>
  182. <dl>
  183. <dt><span class="paramLabel">Parameters:</span></dt>
  184. <dd><code>woeid</code> - <a href="http://developer.yahoo.com/geo/geoplanet/">The Yahoo! Where On Earth ID</a> of the location to return trending information for. Global information is available by using 1 as the WOEID.</dd>
  185. <dt><span class="simpleTagLabel">Since:</span></dt>
  186. <dd>Twitter4J 3.0.2</dd>
  187. <dt><span class="seeLabel">See Also:</span></dt>
  188. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/trends/place">GET trends/place | Twitter Developers</a></dd>
  189. </dl>
  190. </li>
  191. </ul>
  192. <a name="getAvailableTrends--">
  193. <!-- -->
  194. </a>
  195. <ul class="blockList">
  196. <li class="blockList">
  197. <h4>getAvailableTrends</h4>
  198. <pre>void&nbsp;getAvailableTrends()</pre>
  199. <div class="block">Retrieves the locations that Twitter has trending topic information for. The response is an array of &quot;locations&quot; that encode the location's WOEID (a <a href="http://developer.yahoo.com/geo/geoplanet/">Yahoo! Where On Earth ID</a>) and some other human-readable information such as a canonical name and country the location belongs in.
  200. <br>This method calls https://api.twitter.com/1.1/trends/available.json</div>
  201. <dl>
  202. <dt><span class="simpleTagLabel">Since:</span></dt>
  203. <dd>Twitter4J 2.1.1</dd>
  204. <dt><span class="seeLabel">See Also:</span></dt>
  205. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/trends/available">GET trends/available | Twitter Developers</a></dd>
  206. </dl>
  207. </li>
  208. </ul>
  209. <a name="getClosestTrends-twitter4j.GeoLocation-">
  210. <!-- -->
  211. </a>
  212. <ul class="blockListLast">
  213. <li class="blockList">
  214. <h4>getClosestTrends</h4>
  215. <pre>void&nbsp;getClosestTrends(<a href="http://twitter4j.org/apidocs/twitter4j/GeoLocation.html?is-external=true" title="class or interface in twitter4j">GeoLocation</a>&nbsp;location)</pre>
  216. <div class="block">Returns the locations that Twitter has trending topic information for, closest to a specified location.<br>
  217. The response is an array of "locations" that encode the location's WOEID and some other human-readable information such as a canonical name and country the location belongs in.<br>
  218. A WOEID is a <a href="http://developer.yahoo.com/geo/geoplanet/">Yahoo! Where On Earth ID</a>.
  219. <br>This method calls https://api.twitter.com/1.1/trends/closest.json</div>
  220. <dl>
  221. <dt><span class="paramLabel">Parameters:</span></dt>
  222. <dd><code>location</code> - the available trend locations will be sorted by distance to the lat and long passed in. The sort is nearest to furthest.</dd>
  223. <dt><span class="simpleTagLabel">Since:</span></dt>
  224. <dd>Twitter4J 3.0.2</dd>
  225. <dt><span class="seeLabel">See Also:</span></dt>
  226. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/trends/closest">GET trends/closest | Twitter Developers</a></dd>
  227. </dl>
  228. </li>
  229. </ul>
  230. </li>
  231. </ul>
  232. </li>
  233. </ul>
  234. </div>
  235. </div>
  236. <!-- ========= END OF CLASS DATA ========= -->
  237. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  238. <div class="bottomNav"><a name="navbar.bottom">
  239. <!-- -->
  240. </a>
  241. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  242. <a name="navbar.bottom.firstrow">
  243. <!-- -->
  244. </a>
  245. <ul class="navList" title="Navigation">
  246. <li><a href="../../overview-summary.html">Overview</a></li>
  247. <li><a href="package-summary.html">Package</a></li>
  248. <li class="navBarCell1Rev">Class</li>
  249. <li><a href="class-use/TrendsResourcesAsync.html">Use</a></li>
  250. <li><a href="package-tree.html">Tree</a></li>
  251. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  252. <li><a href="../../index-all.html">Index</a></li>
  253. <li><a href="../../help-doc.html">Help</a></li>
  254. </ul>
  255. </div>
  256. <div class="subNav">
  257. <ul class="navList">
  258. <li><a href="../../twitter4j/api/TimelinesResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  259. <li><a href="../../twitter4j/api/TweetsResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  260. </ul>
  261. <ul class="navList">
  262. <li><a href="../../index.html?twitter4j/api/TrendsResourcesAsync.html" target="_top">Frames</a></li>
  263. <li><a href="TrendsResourcesAsync.html" target="_top">No&nbsp;Frames</a></li>
  264. </ul>
  265. <ul class="navList" id="allclasses_navbar_bottom">
  266. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  267. </ul>
  268. <div>
  269. <script type="text/javascript"><!--
  270. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  271. if(window==top) {
  272. allClassesLink.style.display = "block";
  273. }
  274. else {
  275. allClassesLink.style.display = "none";
  276. }
  277. //-->
  278. </script>
  279. </div>
  280. <div>
  281. <ul class="subNavList">
  282. <li>Summary:&nbsp;</li>
  283. <li>Nested&nbsp;|&nbsp;</li>
  284. <li>Field&nbsp;|&nbsp;</li>
  285. <li>Constr&nbsp;|&nbsp;</li>
  286. <li><a href="#method.summary">Method</a></li>
  287. </ul>
  288. <ul class="subNavList">
  289. <li>Detail:&nbsp;</li>
  290. <li>Field&nbsp;|&nbsp;</li>
  291. <li>Constr&nbsp;|&nbsp;</li>
  292. <li><a href="#method.detail">Method</a></li>
  293. </ul>
  294. </div>
  295. <a name="skip.navbar.bottom">
  296. <!-- -->
  297. </a></div>
  298. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  299. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  300. </body>
  301. </html>