HelpResourcesAsync.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  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>HelpResourcesAsync (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="HelpResourcesAsync (twitter4j-async 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/HelpResourcesAsync.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/FriendsFollowersResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../../twitter4j/api/ListsResourcesAsync.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/HelpResourcesAsync.html" target="_top">Frames</a></li>
  58. <li><a href="HelpResourcesAsync.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 HelpResourcesAsync" class="title">Interface HelpResourcesAsync</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">HelpResourcesAsync</span></pre>
  110. <dl>
  111. <dt><span class="simpleTagLabel">Author:</span></dt>
  112. <dd>Joern Huxhorn - jhuxhorn at googlemail.com</dd>
  113. </dl>
  114. </li>
  115. </ul>
  116. </div>
  117. <div class="summary">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <!-- ========== METHOD SUMMARY =========== -->
  121. <ul class="blockList">
  122. <li class="blockList"><a name="method.summary">
  123. <!-- -->
  124. </a>
  125. <h3>Method Summary</h3>
  126. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  127. <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>
  128. <tr>
  129. <th class="colFirst" scope="col">Modifier and Type</th>
  130. <th class="colLast" scope="col">Method and Description</th>
  131. </tr>
  132. <tr id="i0" class="altColor">
  133. <td class="colFirst"><code>void</code></td>
  134. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/HelpResourcesAsync.html#getAPIConfiguration--">getAPIConfiguration</a></span>()</code>
  135. <div class="block">Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.<br>
  136. It is recommended applications request this endpoint when they are loaded, but no more than once a day.</div>
  137. </td>
  138. </tr>
  139. <tr id="i1" class="rowColor">
  140. <td class="colFirst"><code>void</code></td>
  141. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/HelpResourcesAsync.html#getLanguages--">getLanguages</a></span>()</code>
  142. <div class="block">Returns the list of languages supported by Twitter along with their ISO 639-1 code.</div>
  143. </td>
  144. </tr>
  145. <tr id="i2" class="altColor">
  146. <td class="colFirst"><code>void</code></td>
  147. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/HelpResourcesAsync.html#getPrivacyPolicy--">getPrivacyPolicy</a></span>()</code>
  148. <div class="block">Returns Twitter's Privacy Policy.</div>
  149. </td>
  150. </tr>
  151. <tr id="i3" class="rowColor">
  152. <td class="colFirst"><code>void</code></td>
  153. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/HelpResourcesAsync.html#getRateLimitStatus--">getRateLimitStatus</a></span>()</code>
  154. <div class="block">Returns the current rate limits for methods belonging to the specified resource families.<br>
  155. Each 1.1 API resource belongs to a "resource family" which is indicated in its method documentation.</div>
  156. </td>
  157. </tr>
  158. <tr id="i4" class="altColor">
  159. <td class="colFirst"><code>void</code></td>
  160. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/HelpResourcesAsync.html#getRateLimitStatus-java.lang.String...-">getRateLimitStatus</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;resources)</code>
  161. <div class="block">Returns the current rate limits for methods belonging to the specified resource families.<br>
  162. Each 1.1 API resource belongs to a "resource family" which is indicated in its method documentation.</div>
  163. </td>
  164. </tr>
  165. <tr id="i5" class="rowColor">
  166. <td class="colFirst"><code>void</code></td>
  167. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/HelpResourcesAsync.html#getTermsOfService--">getTermsOfService</a></span>()</code>
  168. <div class="block">Returns Twitter's' Terms of Service.</div>
  169. </td>
  170. </tr>
  171. </table>
  172. </li>
  173. </ul>
  174. </li>
  175. </ul>
  176. </div>
  177. <div class="details">
  178. <ul class="blockList">
  179. <li class="blockList">
  180. <!-- ============ METHOD DETAIL ========== -->
  181. <ul class="blockList">
  182. <li class="blockList"><a name="method.detail">
  183. <!-- -->
  184. </a>
  185. <h3>Method Detail</h3>
  186. <a name="getAPIConfiguration--">
  187. <!-- -->
  188. </a>
  189. <ul class="blockList">
  190. <li class="blockList">
  191. <h4>getAPIConfiguration</h4>
  192. <pre>void&nbsp;getAPIConfiguration()</pre>
  193. <div class="block">Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.<br>
  194. It is recommended applications request this endpoint when they are loaded, but no more than once a day.</div>
  195. <dl>
  196. <dt><span class="simpleTagLabel">Since:</span></dt>
  197. <dd>Twitter4J 2.2.3</dd>
  198. <dt><span class="seeLabel">See Also:</span></dt>
  199. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/help/configuration">GET help/configuration | Twitter Developers</a></dd>
  200. </dl>
  201. </li>
  202. </ul>
  203. <a name="getLanguages--">
  204. <!-- -->
  205. </a>
  206. <ul class="blockList">
  207. <li class="blockList">
  208. <h4>getLanguages</h4>
  209. <pre>void&nbsp;getLanguages()</pre>
  210. <div class="block">Returns the list of languages supported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to use if you include lang with any of your requests.</div>
  211. <dl>
  212. <dt><span class="simpleTagLabel">Since:</span></dt>
  213. <dd>Twitter4J 2.2.3</dd>
  214. <dt><span class="seeLabel">See Also:</span></dt>
  215. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/help/languages">GET help/languages | Twitter Developers</a></dd>
  216. </dl>
  217. </li>
  218. </ul>
  219. <a name="getPrivacyPolicy--">
  220. <!-- -->
  221. </a>
  222. <ul class="blockList">
  223. <li class="blockList">
  224. <h4>getPrivacyPolicy</h4>
  225. <pre>void&nbsp;getPrivacyPolicy()</pre>
  226. <div class="block">Returns Twitter's Privacy Policy.
  227. <br>This method calls https://api.twitter.com/1.1/help/privacy.json</div>
  228. <dl>
  229. <dt><span class="simpleTagLabel">Since:</span></dt>
  230. <dd>Twitter4J 2.1.7</dd>
  231. <dt><span class="seeLabel">See Also:</span></dt>
  232. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/help/privacy">GET help/privacy | Twitter Developers</a></dd>
  233. </dl>
  234. </li>
  235. </ul>
  236. <a name="getTermsOfService--">
  237. <!-- -->
  238. </a>
  239. <ul class="blockList">
  240. <li class="blockList">
  241. <h4>getTermsOfService</h4>
  242. <pre>void&nbsp;getTermsOfService()</pre>
  243. <div class="block">Returns Twitter's' Terms of Service.
  244. <br>This method calls https://api.twitter.com/1.1/help/tos.json</div>
  245. <dl>
  246. <dt><span class="simpleTagLabel">Since:</span></dt>
  247. <dd>Twitter4J 2.1.7</dd>
  248. <dt><span class="seeLabel">See Also:</span></dt>
  249. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/help/tos">GET help/tos | Twitter Developers</a></dd>
  250. </dl>
  251. </li>
  252. </ul>
  253. <a name="getRateLimitStatus--">
  254. <!-- -->
  255. </a>
  256. <ul class="blockList">
  257. <li class="blockList">
  258. <h4>getRateLimitStatus</h4>
  259. <pre>void&nbsp;getRateLimitStatus()</pre>
  260. <div class="block">Returns the current rate limits for methods belonging to the specified resource families.<br>
  261. Each 1.1 API resource belongs to a "resource family" which is indicated in its method documentation. You can typically determine a method's resource family from the first component of the path after the resource version.<br>
  262. This method responds with a map of methods belonging to the families specified by the resources parameter, the current remaining uses for each of those resources within the current rate limiting window, and its expiration time in epoch time. It also includes a rate_limit_context field that indicates the current access token context.<br>
  263. You may also issue requests to this method without any parameters to receive a map of all rate limited GET methods. If your application only uses a few of methods, please explicitly provide a resources parameter with the specified resource families you work with.<br>
  264. Read more about REST API Rate Limiting in v1.1 and review the limits.<br>
  265. <br>This method calls https://api.twitter.com/1.1/application/rate_limit_status.json</div>
  266. <dl>
  267. <dt><span class="simpleTagLabel">Since:</span></dt>
  268. <dd>Twitter4J 3.0.0</dd>
  269. <dt><span class="seeLabel">See Also:</span></dt>
  270. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/application/rate_limit_status">GET application/rate_limit_status</a></dd>
  271. </dl>
  272. </li>
  273. </ul>
  274. <a name="getRateLimitStatus-java.lang.String...-">
  275. <!-- -->
  276. </a>
  277. <ul class="blockListLast">
  278. <li class="blockList">
  279. <h4>getRateLimitStatus</h4>
  280. <pre>void&nbsp;getRateLimitStatus(<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;resources)</pre>
  281. <div class="block">Returns the current rate limits for methods belonging to the specified resource families.<br>
  282. Each 1.1 API resource belongs to a "resource family" which is indicated in its method documentation. You can typically determine a method's resource family from the first component of the path after the resource version.<br>
  283. This method responds with a map of methods belonging to the families specified by the resources parameter, the current remaining uses for each of those resources within the current rate limiting window, and its expiration time in epoch time. It also includes a rate_limit_context field that indicates the current access token context.<br>
  284. You may also issue requests to this method without any parameters to receive a map of all rate limited GET methods. If your application only uses a few of methods, please explicitly provide a resources parameter with the specified resource families you work with.<br>
  285. Read more about REST API Rate Limiting in v1.1 and review the limits.<br>
  286. As of Nov 4th 2012, supported resource names are as follows:
  287. &quot;trends&quot;,&quot;application&quot;,&quot;users&quot;,&quot;saved_searches&quot;,&quot;geo&quot;,&quot;direct_messages&quot;,&quot;blocks&quot;,&quot;favorites&quot;,&quot;statuses&quot;,&quot;followers&quot;,&quot;help&quot;,&quot;friends&quot;,&quot;search&quot;,&quot;friendships&quot;,&quot;account&quot;,&quot;lists&quot;
  288. <br>This method calls https://api.twitter.com/1.1/application/rate_limit_status.json</div>
  289. <dl>
  290. <dt><span class="paramLabel">Parameters:</span></dt>
  291. <dd><code>resources</code> - resources</dd>
  292. <dt><span class="simpleTagLabel">Since:</span></dt>
  293. <dd>Twitter4J 3.0.0</dd>
  294. <dt><span class="seeLabel">See Also:</span></dt>
  295. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/application/rate_limit_status">GET application/rate_limit_status</a></dd>
  296. </dl>
  297. </li>
  298. </ul>
  299. </li>
  300. </ul>
  301. </li>
  302. </ul>
  303. </div>
  304. </div>
  305. <!-- ========= END OF CLASS DATA ========= -->
  306. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  307. <div class="bottomNav"><a name="navbar.bottom">
  308. <!-- -->
  309. </a>
  310. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  311. <a name="navbar.bottom.firstrow">
  312. <!-- -->
  313. </a>
  314. <ul class="navList" title="Navigation">
  315. <li><a href="../../overview-summary.html">Overview</a></li>
  316. <li><a href="package-summary.html">Package</a></li>
  317. <li class="navBarCell1Rev">Class</li>
  318. <li><a href="class-use/HelpResourcesAsync.html">Use</a></li>
  319. <li><a href="package-tree.html">Tree</a></li>
  320. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  321. <li><a href="../../index-all.html">Index</a></li>
  322. <li><a href="../../help-doc.html">Help</a></li>
  323. </ul>
  324. </div>
  325. <div class="subNav">
  326. <ul class="navList">
  327. <li><a href="../../twitter4j/api/FriendsFollowersResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  328. <li><a href="../../twitter4j/api/ListsResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  329. </ul>
  330. <ul class="navList">
  331. <li><a href="../../index.html?twitter4j/api/HelpResourcesAsync.html" target="_top">Frames</a></li>
  332. <li><a href="HelpResourcesAsync.html" target="_top">No&nbsp;Frames</a></li>
  333. </ul>
  334. <ul class="navList" id="allclasses_navbar_bottom">
  335. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  336. </ul>
  337. <div>
  338. <script type="text/javascript"><!--
  339. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  340. if(window==top) {
  341. allClassesLink.style.display = "block";
  342. }
  343. else {
  344. allClassesLink.style.display = "none";
  345. }
  346. //-->
  347. </script>
  348. </div>
  349. <div>
  350. <ul class="subNavList">
  351. <li>Summary:&nbsp;</li>
  352. <li>Nested&nbsp;|&nbsp;</li>
  353. <li>Field&nbsp;|&nbsp;</li>
  354. <li>Constr&nbsp;|&nbsp;</li>
  355. <li><a href="#method.summary">Method</a></li>
  356. </ul>
  357. <ul class="subNavList">
  358. <li>Detail:&nbsp;</li>
  359. <li>Field&nbsp;|&nbsp;</li>
  360. <li>Constr&nbsp;|&nbsp;</li>
  361. <li><a href="#method.detail">Method</a></li>
  362. </ul>
  363. </div>
  364. <a name="skip.navbar.bottom">
  365. <!-- -->
  366. </a></div>
  367. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  368. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  369. </body>
  370. </html>