DirectMessagesResourcesAsync.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  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>DirectMessagesResourcesAsync (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="DirectMessagesResourcesAsync (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/DirectMessagesResourcesAsync.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>Prev&nbsp;Class</li>
  54. <li><a href="../../twitter4j/api/FavoritesResourcesAsync.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/DirectMessagesResourcesAsync.html" target="_top">Frames</a></li>
  58. <li><a href="DirectMessagesResourcesAsync.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 DirectMessagesResourcesAsync" class="title">Interface DirectMessagesResourcesAsync</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">DirectMessagesResourcesAsync</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/DirectMessagesResourcesAsync.html#destroyDirectMessage-long-">destroyDirectMessage</a></span>(long&nbsp;id)</code>
  135. <div class="block">Destroys the direct message specified in the required ID parameter.</div>
  136. </td>
  137. </tr>
  138. <tr id="i1" class="rowColor">
  139. <td class="colFirst"><code>void</code></td>
  140. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/DirectMessagesResourcesAsync.html#getDirectMessages--">getDirectMessages</a></span>()</code>
  141. <div class="block">Returns a list of the direct messages sent to the authenticating user.</div>
  142. </td>
  143. </tr>
  144. <tr id="i2" class="altColor">
  145. <td class="colFirst"><code>void</code></td>
  146. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/DirectMessagesResourcesAsync.html#getDirectMessages-twitter4j.Paging-">getDirectMessages</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/Paging.html?is-external=true" title="class or interface in twitter4j">Paging</a>&nbsp;paging)</code>
  147. <div class="block">Returns a list of the direct messages sent to the authenticating user.</div>
  148. </td>
  149. </tr>
  150. <tr id="i3" class="rowColor">
  151. <td class="colFirst"><code>void</code></td>
  152. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/DirectMessagesResourcesAsync.html#getSentDirectMessages--">getSentDirectMessages</a></span>()</code>
  153. <div class="block">Returns a list of the direct messages sent by the authenticating user.</div>
  154. </td>
  155. </tr>
  156. <tr id="i4" class="altColor">
  157. <td class="colFirst"><code>void</code></td>
  158. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/DirectMessagesResourcesAsync.html#getSentDirectMessages-twitter4j.Paging-">getSentDirectMessages</a></span>(<a href="http://twitter4j.org/apidocs/twitter4j/Paging.html?is-external=true" title="class or interface in twitter4j">Paging</a>&nbsp;paging)</code>
  159. <div class="block">Returns a list of the direct messages sent by the authenticating user.</div>
  160. </td>
  161. </tr>
  162. <tr id="i5" class="rowColor">
  163. <td class="colFirst"><code>void</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/DirectMessagesResourcesAsync.html#sendDirectMessage-long-java.lang.String-">sendDirectMessage</a></span>(long&nbsp;userId,
  165. <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;text)</code>
  166. <div class="block">Sends a new direct message to the specified user from the authenticating user.</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/DirectMessagesResourcesAsync.html#sendDirectMessage-java.lang.String-java.lang.String-">sendDirectMessage</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;screenName,
  172. <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;text)</code>
  173. <div class="block">Sends a new direct message to the specified user from the authenticating user.</div>
  174. </td>
  175. </tr>
  176. <tr id="i7" class="rowColor">
  177. <td class="colFirst"><code>void</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/DirectMessagesResourcesAsync.html#showDirectMessage-long-">showDirectMessage</a></span>(long&nbsp;id)</code>
  179. <div class="block">Returns a single direct message, specified by an id parameter.</div>
  180. </td>
  181. </tr>
  182. </table>
  183. </li>
  184. </ul>
  185. </li>
  186. </ul>
  187. </div>
  188. <div class="details">
  189. <ul class="blockList">
  190. <li class="blockList">
  191. <!-- ============ METHOD DETAIL ========== -->
  192. <ul class="blockList">
  193. <li class="blockList"><a name="method.detail">
  194. <!-- -->
  195. </a>
  196. <h3>Method Detail</h3>
  197. <a name="getDirectMessages--">
  198. <!-- -->
  199. </a>
  200. <ul class="blockList">
  201. <li class="blockList">
  202. <h4>getDirectMessages</h4>
  203. <pre>void&nbsp;getDirectMessages()</pre>
  204. <div class="block">Returns a list of the direct messages sent to the authenticating user.
  205. <br>This method calls https://api.twitter.com/1.1/direct_messages</div>
  206. <dl>
  207. <dt><span class="seeLabel">See Also:</span></dt>
  208. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/direct_messages">GET direct_messages | Twitter Developers</a></dd>
  209. </dl>
  210. </li>
  211. </ul>
  212. <a name="getDirectMessages-twitter4j.Paging-">
  213. <!-- -->
  214. </a>
  215. <ul class="blockList">
  216. <li class="blockList">
  217. <h4>getDirectMessages</h4>
  218. <pre>void&nbsp;getDirectMessages(<a href="http://twitter4j.org/apidocs/twitter4j/Paging.html?is-external=true" title="class or interface in twitter4j">Paging</a>&nbsp;paging)</pre>
  219. <div class="block">Returns a list of the direct messages sent to the authenticating user.
  220. <br>This method calls https://api.twitter.com/1.1/direct_messages</div>
  221. <dl>
  222. <dt><span class="paramLabel">Parameters:</span></dt>
  223. <dd><code>paging</code> - controls pagination</dd>
  224. <dt><span class="simpleTagLabel">Since:</span></dt>
  225. <dd>Twitter4J 2.0.1</dd>
  226. <dt><span class="seeLabel">See Also:</span></dt>
  227. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/direct_messages">GET direct_messages | Twitter Developers</a></dd>
  228. </dl>
  229. </li>
  230. </ul>
  231. <a name="getSentDirectMessages--">
  232. <!-- -->
  233. </a>
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <h4>getSentDirectMessages</h4>
  237. <pre>void&nbsp;getSentDirectMessages()</pre>
  238. <div class="block">Returns a list of the direct messages sent by the authenticating user.
  239. <br>This method calls https://api.twitter.com/1.1/direct_messages/sent</div>
  240. <dl>
  241. <dt><span class="seeLabel">See Also:</span></dt>
  242. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/direct_messages/sent">GET direct_messages/sent | Twitter Developers</a></dd>
  243. </dl>
  244. </li>
  245. </ul>
  246. <a name="getSentDirectMessages-twitter4j.Paging-">
  247. <!-- -->
  248. </a>
  249. <ul class="blockList">
  250. <li class="blockList">
  251. <h4>getSentDirectMessages</h4>
  252. <pre>void&nbsp;getSentDirectMessages(<a href="http://twitter4j.org/apidocs/twitter4j/Paging.html?is-external=true" title="class or interface in twitter4j">Paging</a>&nbsp;paging)</pre>
  253. <div class="block">Returns a list of the direct messages sent by the authenticating user.
  254. <br>This method calls https://api.twitter.com/1.1/direct_messages/sent</div>
  255. <dl>
  256. <dt><span class="paramLabel">Parameters:</span></dt>
  257. <dd><code>paging</code> - controls pagination</dd>
  258. <dt><span class="simpleTagLabel">Since:</span></dt>
  259. <dd>Twitter4J 2.0.1</dd>
  260. <dt><span class="seeLabel">See Also:</span></dt>
  261. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/direct_messages/sent">GET direct_messages/sent | Twitter Developers</a></dd>
  262. </dl>
  263. </li>
  264. </ul>
  265. <a name="showDirectMessage-long-">
  266. <!-- -->
  267. </a>
  268. <ul class="blockList">
  269. <li class="blockList">
  270. <h4>showDirectMessage</h4>
  271. <pre>void&nbsp;showDirectMessage(long&nbsp;id)</pre>
  272. <div class="block">Returns a single direct message, specified by an id parameter.
  273. <br>This method has not been finalized and the interface is subject to change in incompatible ways.
  274. <br>This method calls https://api.twitter.com/1.1/direct_messages/show/:id.json</div>
  275. <dl>
  276. <dt><span class="paramLabel">Parameters:</span></dt>
  277. <dd><code>id</code> - message id</dd>
  278. <dt><span class="simpleTagLabel">Since:</span></dt>
  279. <dd>Twitter4J 2.1.9</dd>
  280. <dt><span class="seeLabel">See Also:</span></dt>
  281. <dd><a href="http://groups.google.com/group/twitter-api-announce/msg/34909da7c399169e">#newtwitter and the API - Twitter API Announcements | Google Group</a></dd>
  282. </dl>
  283. </li>
  284. </ul>
  285. <a name="destroyDirectMessage-long-">
  286. <!-- -->
  287. </a>
  288. <ul class="blockList">
  289. <li class="blockList">
  290. <h4>destroyDirectMessage</h4>
  291. <pre>void&nbsp;destroyDirectMessage(long&nbsp;id)</pre>
  292. <div class="block">Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.
  293. <br>This method calls https://api.twitter.com/1.1/direct_messages/destroy</div>
  294. <dl>
  295. <dt><span class="paramLabel">Parameters:</span></dt>
  296. <dd><code>id</code> - int</dd>
  297. <dt><span class="simpleTagLabel">Since:</span></dt>
  298. <dd>Twitter4J 2.0.1</dd>
  299. <dt><span class="seeLabel">See Also:</span></dt>
  300. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/direct_messages/destroy/:id">POST direct_messages/destroy/:id | Twitter Developers</a></dd>
  301. </dl>
  302. </li>
  303. </ul>
  304. <a name="sendDirectMessage-long-java.lang.String-">
  305. <!-- -->
  306. </a>
  307. <ul class="blockList">
  308. <li class="blockList">
  309. <h4>sendDirectMessage</h4>
  310. <pre>void&nbsp;sendDirectMessage(long&nbsp;userId,
  311. <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;text)</pre>
  312. <div class="block">Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters below.
  313. The text will be trimed if the length of the text is exceeding 140 characters.
  314. <br>This method calls https://api.twitter.com/1.1/direct_messages/new</div>
  315. <dl>
  316. <dt><span class="paramLabel">Parameters:</span></dt>
  317. <dd><code>userId</code> - the screen name of the user to whom send the direct message</dd>
  318. <dd><code>text</code> - The text of your direct message.</dd>
  319. <dt><span class="simpleTagLabel">Since:</span></dt>
  320. <dd>Twitter4j 2.1.0</dd>
  321. <dt><span class="seeLabel">See Also:</span></dt>
  322. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/direct_messages/new">POST direct_messages/new | Twitter Developers</a></dd>
  323. </dl>
  324. </li>
  325. </ul>
  326. <a name="sendDirectMessage-java.lang.String-java.lang.String-">
  327. <!-- -->
  328. </a>
  329. <ul class="blockListLast">
  330. <li class="blockList">
  331. <h4>sendDirectMessage</h4>
  332. <pre>void&nbsp;sendDirectMessage(<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;screenName,
  333. <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;text)</pre>
  334. <div class="block">Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters below.
  335. The text will be trimed if the length of the text is exceeding 140 characters.
  336. <br>This method calls https://api.twitter.com/1.1/direct_messages/new</div>
  337. <dl>
  338. <dt><span class="paramLabel">Parameters:</span></dt>
  339. <dd><code>screenName</code> - the screen name of the user to whom send the direct message</dd>
  340. <dd><code>text</code> - The text of your direct message.</dd>
  341. <dt><span class="seeLabel">See Also:</span></dt>
  342. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/direct_messages/new">POST direct_messages/new | Twitter Developers</a></dd>
  343. </dl>
  344. </li>
  345. </ul>
  346. </li>
  347. </ul>
  348. </li>
  349. </ul>
  350. </div>
  351. </div>
  352. <!-- ========= END OF CLASS DATA ========= -->
  353. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  354. <div class="bottomNav"><a name="navbar.bottom">
  355. <!-- -->
  356. </a>
  357. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  358. <a name="navbar.bottom.firstrow">
  359. <!-- -->
  360. </a>
  361. <ul class="navList" title="Navigation">
  362. <li><a href="../../overview-summary.html">Overview</a></li>
  363. <li><a href="package-summary.html">Package</a></li>
  364. <li class="navBarCell1Rev">Class</li>
  365. <li><a href="class-use/DirectMessagesResourcesAsync.html">Use</a></li>
  366. <li><a href="package-tree.html">Tree</a></li>
  367. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  368. <li><a href="../../index-all.html">Index</a></li>
  369. <li><a href="../../help-doc.html">Help</a></li>
  370. </ul>
  371. </div>
  372. <div class="subNav">
  373. <ul class="navList">
  374. <li>Prev&nbsp;Class</li>
  375. <li><a href="../../twitter4j/api/FavoritesResourcesAsync.html" title="interface in twitter4j.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  376. </ul>
  377. <ul class="navList">
  378. <li><a href="../../index.html?twitter4j/api/DirectMessagesResourcesAsync.html" target="_top">Frames</a></li>
  379. <li><a href="DirectMessagesResourcesAsync.html" target="_top">No&nbsp;Frames</a></li>
  380. </ul>
  381. <ul class="navList" id="allclasses_navbar_bottom">
  382. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  383. </ul>
  384. <div>
  385. <script type="text/javascript"><!--
  386. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  387. if(window==top) {
  388. allClassesLink.style.display = "block";
  389. }
  390. else {
  391. allClassesLink.style.display = "none";
  392. }
  393. //-->
  394. </script>
  395. </div>
  396. <div>
  397. <ul class="subNavList">
  398. <li>Summary:&nbsp;</li>
  399. <li>Nested&nbsp;|&nbsp;</li>
  400. <li>Field&nbsp;|&nbsp;</li>
  401. <li>Constr&nbsp;|&nbsp;</li>
  402. <li><a href="#method.summary">Method</a></li>
  403. </ul>
  404. <ul class="subNavList">
  405. <li>Detail:&nbsp;</li>
  406. <li>Field&nbsp;|&nbsp;</li>
  407. <li>Constr&nbsp;|&nbsp;</li>
  408. <li><a href="#method.detail">Method</a></li>
  409. </ul>
  410. </div>
  411. <a name="skip.navbar.bottom">
  412. <!-- -->
  413. </a></div>
  414. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  415. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  416. </body>
  417. </html>