TweetsResourcesAsync.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  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>TweetsResourcesAsync (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="TweetsResourcesAsync (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,"i6":6,"i7":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/TweetsResourcesAsync.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/TrendsResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../../twitter4j/api/UsersResourcesAsync.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/TweetsResourcesAsync.html" target="_top">Frames</a></li>
  58. <li><a href="TweetsResourcesAsync.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 TweetsResourcesAsync" class="title">Interface TweetsResourcesAsync</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">TweetsResourcesAsync</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/TweetsResourcesAsync.html#destroyStatus-long-">destroyStatus</a></span>(long&nbsp;statusId)</code>
  135. <div class="block">Destroys the status specified by the required ID parameter.<br>
  136. Usage note: The authenticating user must be the author of the specified status.</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/TweetsResourcesAsync.html#getOEmbed-twitter4j.OEmbedRequest-">getOEmbed</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/OEmbedRequest.html?is-external=true" title="class or interface in twitter4j">OEmbedRequest</a>&nbsp;req)</code>
  142. <div class="block">Returns information allowing the creation of an embedded representation of a Tweet on third party sites.</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/TweetsResourcesAsync.html#getRetweets-long-">getRetweets</a></span>(long&nbsp;statusId)</code>
  148. <div class="block">Returns up to 100 of the first retweets of a given tweet.</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/TweetsResourcesAsync.html#lookup-long...-">lookup</a></span>(long...&nbsp;ids)</code>
  154. <div class="block">Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by comma-separated values passed to the id parameter.</div>
  155. </td>
  156. </tr>
  157. <tr id="i4" class="altColor">
  158. <td class="colFirst"><code>void</code></td>
  159. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/TweetsResourcesAsync.html#retweetStatus-long-">retweetStatus</a></span>(long&nbsp;statusId)</code>
  160. <div class="block">Retweets a tweet.</div>
  161. </td>
  162. </tr>
  163. <tr id="i5" class="rowColor">
  164. <td class="colFirst"><code>void</code></td>
  165. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/TweetsResourcesAsync.html#showStatus-long-">showStatus</a></span>(long&nbsp;id)</code>
  166. <div class="block">Returns a single status, specified by the id parameter below.</div>
  167. </td>
  168. </tr>
  169. <tr id="i6" class="altColor">
  170. <td class="colFirst"><code>void</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/TweetsResourcesAsync.html#updateStatus-twitter4j.StatusUpdate-">updateStatus</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/StatusUpdate.html?is-external=true" title="class or interface in twitter4j">StatusUpdate</a>&nbsp;status)</code>
  172. <div class="block">Updates the authenticating user's status.</div>
  173. </td>
  174. </tr>
  175. <tr id="i7" class="rowColor">
  176. <td class="colFirst"><code>void</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/TweetsResourcesAsync.html#updateStatus-java.lang.String-">updateStatus</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;status)</code>
  178. <div class="block">Updates the authenticating user's status.</div>
  179. </td>
  180. </tr>
  181. </table>
  182. </li>
  183. </ul>
  184. </li>
  185. </ul>
  186. </div>
  187. <div class="details">
  188. <ul class="blockList">
  189. <li class="blockList">
  190. <!-- ============ METHOD DETAIL ========== -->
  191. <ul class="blockList">
  192. <li class="blockList"><a name="method.detail">
  193. <!-- -->
  194. </a>
  195. <h3>Method Detail</h3>
  196. <a name="getRetweets-long-">
  197. <!-- -->
  198. </a>
  199. <ul class="blockList">
  200. <li class="blockList">
  201. <h4>getRetweets</h4>
  202. <pre>void&nbsp;getRetweets(long&nbsp;statusId)</pre>
  203. <div class="block">Returns up to 100 of the first retweets of a given tweet.
  204. <br>This method calls https://api.twitter.com/1.1/statuses/retweets</div>
  205. <dl>
  206. <dt><span class="paramLabel">Parameters:</span></dt>
  207. <dd><code>statusId</code> - The numerical ID of the tweet you want the retweets of.</dd>
  208. <dt><span class="simpleTagLabel">Since:</span></dt>
  209. <dd>Twitter4J 2.1.0</dd>
  210. <dt><span class="seeLabel">See Also:</span></dt>
  211. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/statuses/retweets/:id">Tweets Resources › statuses/retweets/:id</a></dd>
  212. </dl>
  213. </li>
  214. </ul>
  215. <a name="showStatus-long-">
  216. <!-- -->
  217. </a>
  218. <ul class="blockList">
  219. <li class="blockList">
  220. <h4>showStatus</h4>
  221. <pre>void&nbsp;showStatus(long&nbsp;id)</pre>
  222. <div class="block">Returns a single status, specified by the id parameter below. The status's author will be returned inline.
  223. <br>This method calls https://api.twitter.com/1.1/statuses/show</div>
  224. <dl>
  225. <dt><span class="paramLabel">Parameters:</span></dt>
  226. <dd><code>id</code> - int</dd>
  227. <dt><span class="simpleTagLabel">Since:</span></dt>
  228. <dd>Twitter4J 2.0.1</dd>
  229. <dt><span class="seeLabel">See Also:</span></dt>
  230. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/statuses/show/:id">GET statuses/show/:id | Twitter Developers</a></dd>
  231. </dl>
  232. </li>
  233. </ul>
  234. <a name="destroyStatus-long-">
  235. <!-- -->
  236. </a>
  237. <ul class="blockList">
  238. <li class="blockList">
  239. <h4>destroyStatus</h4>
  240. <pre>void&nbsp;destroyStatus(long&nbsp;statusId)</pre>
  241. <div class="block">Destroys the status specified by the required ID parameter.<br>
  242. Usage note: The authenticating user must be the author of the specified status.
  243. <br>This method calls https://api.twitter.com/1.1/statuses/destroy</div>
  244. <dl>
  245. <dt><span class="paramLabel">Parameters:</span></dt>
  246. <dd><code>statusId</code> - String</dd>
  247. <dt><span class="simpleTagLabel">Since:</span></dt>
  248. <dd>1.1.2</dd>
  249. <dt><span class="seeLabel">See Also:</span></dt>
  250. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/statuses/destroy/:id">POST statuses/destroy/:id | Twitter Developers</a></dd>
  251. </dl>
  252. </li>
  253. </ul>
  254. <a name="updateStatus-java.lang.String-">
  255. <!-- -->
  256. </a>
  257. <ul class="blockList">
  258. <li class="blockList">
  259. <h4>updateStatus</h4>
  260. <pre>void&nbsp;updateStatus(<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;status)</pre>
  261. <div class="block">Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
  262. <br>This method calls https://api.twitter.com/1.1/statuses/update</div>
  263. <dl>
  264. <dt><span class="paramLabel">Parameters:</span></dt>
  265. <dd><code>status</code> - String</dd>
  266. <dt><span class="simpleTagLabel">Since:</span></dt>
  267. <dd>Twitter4J 2.0.1</dd>
  268. <dt><span class="seeLabel">See Also:</span></dt>
  269. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/statuses/update">POST statuses/update | Twitter Developers</a></dd>
  270. </dl>
  271. </li>
  272. </ul>
  273. <a name="updateStatus-twitter4j.StatusUpdate-">
  274. <!-- -->
  275. </a>
  276. <ul class="blockList">
  277. <li class="blockList">
  278. <h4>updateStatus</h4>
  279. <pre>void&nbsp;updateStatus(<a href="http://twitter4j.org/apidocs/twitter4j/StatusUpdate.html?is-external=true" title="class or interface in twitter4j">StatusUpdate</a>&nbsp;status)</pre>
  280. <div class="block">Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
  281. <br>Statuses over 280 characters will be forcibly truncated.
  282. <br>This method calls https://api.twitter.com/1.1/statuses/update</div>
  283. <dl>
  284. <dt><span class="paramLabel">Parameters:</span></dt>
  285. <dd><code>status</code> - the latest status to be updated.</dd>
  286. <dt><span class="simpleTagLabel">Since:</span></dt>
  287. <dd>Twitter4J 2.1.1</dd>
  288. <dt><span class="seeLabel">See Also:</span></dt>
  289. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/statuses/update">POST statuses/update | Twitter Developers</a></dd>
  290. </dl>
  291. </li>
  292. </ul>
  293. <a name="retweetStatus-long-">
  294. <!-- -->
  295. </a>
  296. <ul class="blockList">
  297. <li class="blockList">
  298. <h4>retweetStatus</h4>
  299. <pre>void&nbsp;retweetStatus(long&nbsp;statusId)</pre>
  300. <div class="block">Retweets a tweet. Returns the original tweet with retweet details embedded.
  301. <br>This method calls https://api.twitter.com/1.1/statuses/retweet</div>
  302. <dl>
  303. <dt><span class="paramLabel">Parameters:</span></dt>
  304. <dd><code>statusId</code> - The ID of the status to retweet.</dd>
  305. <dt><span class="simpleTagLabel">Since:</span></dt>
  306. <dd>Twitter4J 2.0.10</dd>
  307. <dt><span class="seeLabel">See Also:</span></dt>
  308. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/statuses/retweet/:id">POST statuses/retweet/:id | Twitter Developers</a></dd>
  309. </dl>
  310. </li>
  311. </ul>
  312. <a name="getOEmbed-twitter4j.OEmbedRequest-">
  313. <!-- -->
  314. </a>
  315. <ul class="blockList">
  316. <li class="blockList">
  317. <h4>getOEmbed</h4>
  318. <pre>void&nbsp;getOEmbed(<a href="http://twitter4j.org/apidocs/twitter4j/OEmbedRequest.html?is-external=true" title="class or interface in twitter4j">OEmbedRequest</a>&nbsp;req)</pre>
  319. <div class="block">Returns information allowing the creation of an embedded representation of a Tweet on third party sites. See the <a href="http://oembed.com/">oEmbed</a> specification for information about the response format.
  320. While this endpoint allows a bit of customization for the final appearance of the embedded Tweet, be aware that the appearance of the rendered Tweet may change over time to be consistent with Twitter's <a href="https://dev.twitter.com/terms/display-requirements">Display Requirements</a>. Do not rely on any class or id parameters to stay constant in the returned markup.
  321. <br>This method calls https://api.twitter.com/1.1/statuses/oembed.json</div>
  322. <dl>
  323. <dt><span class="paramLabel">Parameters:</span></dt>
  324. <dd><code>req</code> - request</dd>
  325. <dt><span class="simpleTagLabel">Since:</span></dt>
  326. <dd>Twitter4J 3.0.2</dd>
  327. <dt><span class="seeLabel">See Also:</span></dt>
  328. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/statuses/oembed">GET statuses/oembed | Twitter Developers</a></dd>
  329. </dl>
  330. </li>
  331. </ul>
  332. <a name="lookup-long...-">
  333. <!-- -->
  334. </a>
  335. <ul class="blockListLast">
  336. <li class="blockList">
  337. <h4>lookup</h4>
  338. <pre>void&nbsp;lookup(long...&nbsp;ids)</pre>
  339. <div class="block">Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by comma-separated values passed to the id parameter.
  340. This method is especially useful to get the details (hydrate) a collection of Tweet IDs.
  341. <br>This method calls https://api.twitter.com/1.1/statuses/lookup.json</div>
  342. <dl>
  343. <dt><span class="paramLabel">Parameters:</span></dt>
  344. <dd><code>ids</code> - array of the ids to lookup</dd>
  345. <dt><span class="simpleTagLabel">Since:</span></dt>
  346. <dd>Twitter4J 4.0.2</dd>
  347. <dt><span class="seeLabel">See Also:</span></dt>
  348. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/statuses/lookup">GET statuses/lookup</a></dd>
  349. </dl>
  350. </li>
  351. </ul>
  352. </li>
  353. </ul>
  354. </li>
  355. </ul>
  356. </div>
  357. </div>
  358. <!-- ========= END OF CLASS DATA ========= -->
  359. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  360. <div class="bottomNav"><a name="navbar.bottom">
  361. <!-- -->
  362. </a>
  363. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  364. <a name="navbar.bottom.firstrow">
  365. <!-- -->
  366. </a>
  367. <ul class="navList" title="Navigation">
  368. <li><a href="../../overview-summary.html">Overview</a></li>
  369. <li><a href="package-summary.html">Package</a></li>
  370. <li class="navBarCell1Rev">Class</li>
  371. <li><a href="class-use/TweetsResourcesAsync.html">Use</a></li>
  372. <li><a href="package-tree.html">Tree</a></li>
  373. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  374. <li><a href="../../index-all.html">Index</a></li>
  375. <li><a href="../../help-doc.html">Help</a></li>
  376. </ul>
  377. </div>
  378. <div class="subNav">
  379. <ul class="navList">
  380. <li><a href="../../twitter4j/api/TrendsResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  381. <li><a href="../../twitter4j/api/UsersResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  382. </ul>
  383. <ul class="navList">
  384. <li><a href="../../index.html?twitter4j/api/TweetsResourcesAsync.html" target="_top">Frames</a></li>
  385. <li><a href="TweetsResourcesAsync.html" target="_top">No&nbsp;Frames</a></li>
  386. </ul>
  387. <ul class="navList" id="allclasses_navbar_bottom">
  388. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  389. </ul>
  390. <div>
  391. <script type="text/javascript"><!--
  392. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  393. if(window==top) {
  394. allClassesLink.style.display = "block";
  395. }
  396. else {
  397. allClassesLink.style.display = "none";
  398. }
  399. //-->
  400. </script>
  401. </div>
  402. <div>
  403. <ul class="subNavList">
  404. <li>Summary:&nbsp;</li>
  405. <li>Nested&nbsp;|&nbsp;</li>
  406. <li>Field&nbsp;|&nbsp;</li>
  407. <li>Constr&nbsp;|&nbsp;</li>
  408. <li><a href="#method.summary">Method</a></li>
  409. </ul>
  410. <ul class="subNavList">
  411. <li>Detail:&nbsp;</li>
  412. <li>Field&nbsp;|&nbsp;</li>
  413. <li>Constr&nbsp;|&nbsp;</li>
  414. <li><a href="#method.detail">Method</a></li>
  415. </ul>
  416. </div>
  417. <a name="skip.navbar.bottom">
  418. <!-- -->
  419. </a></div>
  420. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  421. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  422. </body>
  423. </html>